From f2e9d01aa47be6e6843b345439d022a3b6d969f4 Mon Sep 17 00:00:00 2001 From: Pranav Sharma Date: Mon, 19 Dec 2022 17:30:38 +0000 Subject: [PATCH] Squashed 'third_party/googleapis/' changes from 6954c4da0..cc3837ae3 cc3837ae3 feat: update public API to include annotation support 9d1290ea4 feat: Add support for specifying stack type for clusters. This will allow clusters to be created as dual stack or toggled between IPV4 and dual stack 02dcec304 feat: support async write mode for WriteUserEvent API feat: support collect and import GA4 event format with prebuilt whistle rule feat: support exact searchable and retrievable in catalog attribute config feat: deprecate retrievable_fields in product attribute feat: support diversity type in serving config feat: allow set feed id in merchant center link feat: support data output to GCS docs: keep the API doc up-to-date with recent changes 1945f7cf5 chore: Update Ruby microgenerator to 0.18.1 for REGAPIC support 0dbe50f76 feat: support async write mode for WriteUserEvent API feat: support collect GA4 event format with prebuilt whistle rule feat: support exact searchable and retrievable in catalog attribute config feat: deprecate retrievable_fields in product attribute feat: support diversity type in serving config docs: keep the API doc up-to-date with recent changes 4b8e2f4c0 chore: regenerate API index ea5238289 docs: fix minor docstring formatting 047c8981d chore: regenerate API index 4e4e58c44 feat: support async write mode for WriteUserEvent API feat: support collect and import GA4 event format with prebuilt whistle rule feat: support exact searchable and retrievable in catalog attribute config feat: deprecate retrievable_fields in product attribute feat: support diversity type in serving config feat: allow set feed id in merchant center link feat: support batch remove catalog attribute config feat: support attribute suggestion in autocomplete feat: support data output to GCS feat: expose the local inventory data in product data retrieval feat: return personal product labels in search response docs: keep the API doc up-to-date with recent changes 483c1eec5 feat: Add support for specifying stack type for clusters. This will allow clusters to be created as dual stack or toggled between IPV4 and dual stack ce114168c chore(bazel): update PHP generator to v1.6.3 eeb9d2b93 chore(python): fix warehouse-package-name for resourcemanager/v3 88f1497c7 chore(docs): update environment field deprecated comment fix: remove unsupported HTTP bindings for IAMPolicy RPCs 8f5577498 feat: add InstancePolicy.boot_disk fix: ServiceAccount.scopes is no longer deprecated fix: removed unused endpoints for IAM methods 7b94a24da feat: Updated dependencies on underlying clients 3dce9ff16 feat: added sharding_config field in DocumentOutputConfig.GcsOutputConfig in document_io.proto feat: added process_options field in ProcessRequest in document_processor_service.proto feat: added sample_document_uris field in ProcessorType in processor_type.proto 5f39f4653 feat: added sharding_config field in DocumentOutputConfig.GcsOutputConfig in document_io.proto feat: added process_options field in ProcessRequest in document_processor_service.proto feat: added sample_document_uris field in ProcessorType in processor_type.proto d9dc42bf2 docs: fix minor docstring formatting 45c90e286 docs: fix minor docstring formatting f36c65081 feat: Add the google.rpc.context.AuditContext and google.rpc.http message to the open source f68e8e84b docs: updated comment for ComputeRoutesRequest and ComputeRouteMatrixRequest fe20b1260 feat: add user_name field to the finding access 83b2bafa7 feat: add estimated number of rows to CreateReadSession response f40f54b68 docs: updated comment for Route.route_token docs: updated comment for RouteTravelMode aa397e87f chore: regenerate API index 3fbdb9369 feat: Updated Client Libraries for Cloud Scheduler 1d8a76dde chore: regenerate API index 59a66eb31 feat: add Configurable Analysis, Bulk Upload, Bulk Analyze, Delete Issue Apis 0ff0b240c feat: added sharding_config field in DocumentOutputConfig.GcsOutputConfig in document_io.proto 46a1452f5 feat: added sharding_config field in DocumentOutputConfig.GcsOutputConfig in document_io.proto bf4359caa chore: Update gapic-generator-python to v1.7.1 f3d6f41ed feat: Python support for longrunning operations proto 3b88f6688 chore: regenerate API index 28449ecb3 feat: added node groups API protos e8356fefc feat: added field BuildStatus.error_message docs: minor update in comments f6b823fc1 feat: Updated dependencies on underlying clients f7f499371 chore: reformatted the protos e69c47f43 feat: Add support for granular repricing configurations via SkuGroups in Cloud Channel Repricing APIs e00487e20 chore: regenerate API index ea40abcc1 chore: rename service YAML file to include version d73a41615 chore: regenerate API index 4bb7c3ee4 chore: renaming service yaml files to include version 1f68a8388 fix: add missing protos for v1 version fbc4aae44 feat: Add generate_mocks=True for visionai cc_grpc_library aee01fa59 feat: add service_account to UploadModelRequest in aiplatform v1beta1 model_service.proto 9df383800 feat: add service_account to UploadModelRequest in aiplatform v1 model_service.proto a5b266a9e chore(go): correct go_gapic_library transport values 44fdfc162 chore(bazel): update rules_gapic to v0.19.2 042fe76ce chore: regenerate API index 54ef816b4 feat: add Vertex AI Vision v1 API feat: update Vertex AI Vision v1alpha1 API BREAKING CHANGE: introduce breaking change to v1alpha1 library 3c9f9e8ab chore: regenerate API index c9560d8f8 feat: add account_verification field to Assessment for MFA 89cc78ad8 chore: regenerate API index a1b5429ee feat: add LRS API c232fcb8f chore: regenerate API index 385f34abf feat: Update Compute Engine API to revision 20221126 (#757) 02e385025 docs: fix minor docstring formatting 2592f50ec docs: Document that PREMISE_PROXIMITY is a valid value for an address granularity b88d338d3 feat: Updated dependencies on underlying clients d7687dcb4 build: remove obsolete field in client.proto 51b5fc6e3 chore: regenerate API index 380b2f072 feat: add LRS API 5eb235dbd chore: regenerate API index 93c3e0eb6 feat: publishing TPU v2 API fix!: fix incorrect resource annotations for TPU v2alpha1 API 0bf62f483 chore: regenerate API index c9b244b4f feat: Added new fields to facilitate debugging * Added new field to Speech response proto, to give more information to indicate whether, or not, Biasing was applied (eg. did Biasing application timed out). * Added request_id to Speech response protos. fea43879f fix(deps): Require google-api-core >=1.34.0, >=2.11.0 314e135cb chore: regenerate API index 268ee4d4b feat: add SearchDataItems RPC in aiplatform version v1 and v1beta1 dataset_service.proto 83d92bdcb chore(bazel): update gapic-generator-php to v1.6.2 db00616cf chore: regenerate API index 6aff6786b feat: add kernel_rootkit field to finding's list of attributes docs: miscellaneous style improvements 758f0d121 chore: Enable requesting numeric enums in "transport=rest" responses for services supporting this (Java, Go, Python, PHP, TypeScript, C#, and Ruby), even if they do not yet turn on REST transport 45694d2ba docs: Fix formatting for subnetwork field pattern 83c3605af docs: fix minor docstring formatting e365b4c0a chore(deps): Update gapic-generator-java to 2.11.0 d13915803 feat: Introduce an `optional_indices` field to make it possible to conditionally populate a list element in a list literal 0392d2212 chore: regenerate API index 4c253358b feat: Added new fields to facilitate debugging * Added new field to Speech response proto, to give more information to indicate whether, or not, Biasing was applied (eg. did Biasing application timed out). * Added request_id to Speech response protos. fcf821165 docs: Fix formatting for subnetwork field pattern 82a7568a8 docs: Corrected typos and spellings 7431bacf8 chore(python): fix warehouse-package-name for grafeas v1 49b0464b5 chore: regenerate API index 34eb8f166 feat: added LoadSnapshot, SaveSnapshot RPCs feat: added fields maintenance_window, workloads_config, environment_size, master_authorized_networks_config, recovery_config to EnvironmentConfig feat: added field scheduler_count to SoftwareConfig feat: added field enable_ip_masq_agent to NodeConfig feat: added fields cloud_composer_network_ipv4_cidr_block, cloud_composer_network_ipv4_reserved_range, enable_privately_used_public_ips, cloud_composer_connection_subnetwork, networking_config to PrivateEnvironmentConfig 6884ca40e docs: fix minor docstring formatting ac614c70c chore(python): fix warehouse-package-name for dialogflow/cx v3 and v3beta1 721bb3a6f chore: regenerate API index 24fc77bd4 feat: add bigquery datapolicies v1 API f0c519fb3 chore(python): fix warehouse-package-name for clouderrorreporting v1beta1 572774c0b feat: add metadata_artifact to Dataset in aiplatform v1beta1 dataset.proto feat: add offline_storage_ttl_days to EntityType in aiplatform v1beta1 entity_type.proto feat: add online_storage_ttl_days to Featurestore in aiplatform v1beta1 featurestore.proto feat: add source_uris to ImportFeatureValuesOperationMetadata in aiplatform v1beta1 featurestore_service.proto c7efca557 chore: regenerate API index 693430f45 feat: add metadata_artifact to Dataset in aiplatform v1 dataset.proto feat: add WriteFeatureValues rpc to FeaturestoreOnlineServingService in aiplatform v1 featurestore_online_service.proto 1051d7d7f chore: regenerate API index e8bd0c402 docs: minor updates in comments dc4d31995 chore(python): fix warehouse-package-name for orgpolicy v2 805081687 chore(python): fix warehouse-package-name for binaryauthorization v1/v1beta1 16db2fb7f docs: fix minor docstring formatting 87461c0ce chore: regenerate API index e69ce26ca feat: Add support for keyword_view, product_group_view for GA launch b70649595 docs: fix minor docstring formatting 6485d9c71 feat: add a FastSocket API 5b64b2c08 chore(python): fix warehouse-package-name for google/monitoring/dashboard/v1 6defef87d chore(python): fix warehouse-package-name for networkconnectivity v1 5686f7b6d docs: fix minor docstring formatting 96ed22a4c chore(python): fix warehouse-package-name for phishingprotection v1beta1 39bcdf411 feat: add a FastSocket API 5e43841dc chore(python): fix warehouse-package-name for oslogin v1 d81001b3a chore: regenerate API index a0b755842 chore(python): fix warehouse-package-name for google/monitoring/metricsscope/v1 d1c447b6c chore: regenerate API index 791374cc5 feat: added federation API feat: added EncryptionConfig field feat: added NetworkConfig field feat: added DatabaseType field feat: added TelemetryConfiguration field cfe506852 chore(python): fix warehouse-package-name for dataqna v1alpha dc9658d1a chore(python): fix warehouse-package-name for metastore v1/v1beta/v1alpha 341e5119f chore: regenerate API index f3f035a2f feat: Remove obsolete export subscription statuses field from API b997fe3df feat: added event log proto file 70b1212ab chore(ruby): Configure Bazel rules for VMware Engine client 9247e23c0 docs: Small change for documentation 4713c109a feat: add SHA-2 import methods fea19470f chore(python): fix warehouse-package-name for containeranalysis v1 0cbcc5936 docs: Small change for documentation 95cc6e007 chore: regenerate API index 8f95a5f2d feat: added cx_current_page field to AutomatedAgentReply docs: clarified docs for Sentiment b6b751420 docs: fix typo in docstring 9afb89b5d docs: fix minor docstring formatting 9de27c9c5 feat: add polling timeouts config for RevertInstance operation 59b13628b chore: regenerate API index d91c6d8a2 feat: Update Compute Engine API to revision 20221101 (#751) b0432a10a feat: Update Compute Engine API to revision 20221101 (#751) 8bd04efa9 build: set mixins to "none" b6c488107 build: add LRO mixin to datacatalog db1cc1139 feat: Adds named reservation to InstancePolicy 488a4bdee feat: Adds named reservation to InstancePolicy e35c0d389 docs: Clarified Agent Assist max retention is 30 days 813e2fa43 feat: added cx_current_page field to AutomatedAgentReply docs: clarified docs for Sentiment 766deed25 chore: regenerate API index 81696624e feat: Adding namespaces for libraries generation 43c8e80a3 docs: minor update to comments 01ab88069 build: use rules_gapic v0.19.1 c40ef67da chore(bazel): update gapic-generator-php to v1.6.1 e7950299c docs: Clarified Agent Assist max retention is 30 days 1d962cc5b chore: regenerate API index a186468db feat: add PreprocessingConfig.deinterlace docs: minor documentation changes 0184330e5 feat: add CloudShellErrorCode.ENVIRONMENT_UNAVAILABLE enum value 2c4f2039d chore: regenerate API index 71673d86f feat: added Location API methods docs: updated comments 72f57e834 chore: regenerate API index 1d21a8686 feat: added UpdateRuntime, UpgradeRuntime, DiagnoseRuntime, DiagnoseInstance to v1 API feat: add Instance.reservation_affinity, nic_type, can_ip_forward to v1beta1 API feat: add IsInstanceUpgradeableResponse.upgrade_image to v1beta1 API feat: added Location and IAM methods fix: deprecate AcceleratorType.NVIDIA_TESLA_K80 8f503d729 chore: regenerate API index 7f891be94 feat: maintenance schedules 29518815b docs: fix minor docstring formatting ef8d236c7 chore: regenerate API index 9e4c5821e feat: Issuer switch API logging proto for documentation e155a8e76 chore: Update gapic-generator-python to v1.6.2 0f0eb8ba2 docs: fix minor docstring formatting f7375bc65 feat: Add current state of export subscriptions to API 43bf96fa4 feat: add missing_value_interpretations to AppendRowsRequest d1e4539c5 feat: added field_mask field in DocumentOutputConfig.GcsOutputConfig in document_io.proto 809780201 feat: Add OsConfig patch_job_log proto for Cloud Platform documentation dde2e5c02 feat: add support for additional HMAC algorithms 8995a8817 feat: added Sku.geo_taxonomy fix: more oauth scopes 452324bf6 feat: add compact placement feature for node pools bd9aa78b3 feat: added google.api.Service.publishing and client libraries settings feat: added google.api.JwtLocation.cookie feat: new fields in enum google.api.ErrorReason fix: deprecate google.api.Endpoint.aliases fix: deprecate google.api.BackendRule.min_deadline docs: minor updates to comments 5e5d500bc chore: regenerate API index 236055995 feat: added CreateSshPublicKey RPC 376ff1e06 chore: regenerate API index c2f6dac41 feat: add Pipeline.secret_environment, Action.secret_environment, VirtualMachine.reservation f10c285cf chore: regenerate API index 6b780a3cb feat: added TrainProcessorVersion, EvaluateProcessorVersion, GetEvaluation, and ListEvaluations v1beta3 APIs feat: added evaluation.proto feat: added document_schema field in ProcessorVersion processor.proto feat: added image_quality_scores field in Document.Page in document.proto feat: added font_family field in Document.Style in document.proto b4dea4af8 feat: add service_account to batch_prediction_job in aiplatform v1 batch_prediction_job.proto 7349e1cd0 feat: Add files field to finding's list of attributes 08f275f5c chore: Update gapic-generator-python to v1.6.1 a3f905143 chore(python): Update build rules for google/apps/script/type 9140e5546 feat: ExcludeByHotword added as an ExclusionRule type, NEW_ZEALAND added as a LocationCategory value 675e60c36 chore(python): Add build rules in BUILD.bazel for google/apps/script/type 80395240f chore: regenerate API index ecd578187 feat: add API client for Drive Labels v2 and v2beta 11fb07f0f chore: regenerate API index 5be5981f5 feat: new APIs added to reflect updates to the filestore service da380c77b chore: Update to gapic-generator-python 1.6.0 2a470e279 chore(bazel): update gapic-generator-php to v1.6.0 91b1a9b68 docs: fix minor docstring formatting cac4b1eea feat: add deal_code field to message Offer 17fb30e8c feat: add instance_config to batch_prediction_job in aiplatform v1beta1 batch_prediction_job.proto 52880d1e5 chore: regenerate API index f19c628a8 feat: publish Google Cloud's Cloud Knowledge Graph (CKG) API 6e1a5a066 docs: fix minor docstring formatting 9df6fcaf9 feat!: remove deprecated fields `highrise` and `multi_family` docs: minor documentation updates 150b4079b feat: Update dependency on versioned libraries 0ce375d9d feat: Update dependency on versioned libraries 67b2d7c2f chore: regenerate API index f31ec7d4d feat: added AccessPolicy.scopes, EgressTo.external_resources, and IAM methods d992d61ca fix(build): correct artifact name for npm 065d4532c chore(python): Add build rules in BUILD.bazel for google/geo/type 398c9f9fc feat: added font_family to document.proto feat: added ImageQualityScores message to document.proto feat: added PropertyMetadata and EntityTypeMetadata to document_schema.proto 1da37b9ae chore: regenerate API index 174adf59e feat: Adding V1 version of the Vmware Engine API dbfdaa989 docs: marking keyword_searchable_job_custom_attributes on the company object as deprecated 737555f00 docs: marking keyword_searchable_job_custom_attributes on the company object as deprecated db1fc8a59 chore(python): prepare for the release of google/cloud/contentwarehouse/v1 86c013bec chore: regenerate API index 54f1157f5 build!: Remove the v1beta1 client as the v1beta1 service is deprecated. Please use the v1 client instead BREAKING CHANGE: Remove the v1beta1 client as the v1beta1 service is deprecated. Please use the v1 client instead 2cba3a6f8 chore(storage): disable REGAPIC transport in storage v2 18d0ce3fe chore: regenerate API index 460f858c3 chore: Update C# Bazel generator to v1.4.9 a6efcc9b7 docs: documentation updates chore: cleanup; annotations updates; adding missing imports c3ec9bc89 chore(python): prepare for the release of google/maps/addressvalidation/v1 0dc990f1a chore: regenerate API index 4733d7473 feat: Add CMEK support to Eventarc client library 079ef843a feat: Introduce the event publishing using JSON representation of CloudEvents 153e9592b feat: Adds gRPC probe support to Cloud Run v2 API client libraries 30e2c3b92 feat: add APIs for GKE Control Plane Logs e4a656df3 feat: add APIs for GKE Control Plane Logs e19d527b2 chore: regenerate API index 3149e8ca8 chore(googleads)!: remove protos for v9, which has sunset 9691f5134 feat: add annotation_labels to ImportDataConfig in aiplatform v1 dataset.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1 training_pipeline.proto af14709a8 feat: add NVIDIA_A100_80GB to AcceleratorType in aiplatform v1beta1 accelerator_type.proto feat: add annotation_labels to ImportDataConfig in aiplatform v1beta1 dataset.proto feat: add total_deployed_model_count and total_endpoint_count to QueryDeployedModelsResponse in aiplatform v1beta1 deployment_resource_pool_service.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1beta1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1beta1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1beta1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1beta1 training_pipeline.proto a5f5928e7 docs: remove stale header guidance for AppendRows 013b7e1de chore: Set `transport` parameter expclicitly for php, nodejs and remaining java gapic rules def2561df build: add viewport proto to Nodejs package to compile library edd034e1e chore: regenerate API index a9a137b74 feat: Adds Cloud Run Jobs v2 API client libraries 69fc6c5b8 chore: include generated samples dir for all google apis 807125e79 chore: Set `rest_numeric_enums = False` for all gapic rules explicitly 210fcc0ff chore: Remove GAX-v3 support from C# generation 77bdd3dd2 docs: updated comment for Route.route_token d3fb85b3b chore: regenerate API index 016f3a2c5 feat: add policy based routing" will work a94d5d453 chore: Update autogenerated Ruby samples to include snippet methods 4c122f83f docs: Update documentation to reflect new Cloud Log messages for Fleet Engine 5ffa37352 chore: regenerate API index 27dd49e0c feat: add Eco Routes feature to ComputeRoutes feat: add Route Token feature to ComputeRoutes feat: add Fuel Consumption feature to ComputeRoutes 63cd62a6f docs: Clarify interactive logging TTL behavior 13301267d chore: regenerate API index 65e115d3d feat: Initial launch of SA360 reporting API b819b9552 feat: Integration of Cloud Build with Artifact Registry 61a5ff5e7 chore: regenerate API index 8eb249a19 chore: update to gapic-generator-python 1.5.0 7706bf123 chore: regenerate API index 5a90f45ba feat: add PHP, Ruby, C# library rules for the Cloud EKG API 3494d9be4 chore(ruby): Update Ruby generator to 0.17.1 bc84ad52e feat: Add allow_failure, exit_code, and allow_exit_code to BuildStep message 8be2b4bad chore(bazel): update Go generator to v0.33.3 f88ca8688 chore: regenerate API index 47842aa22 feat(googleads): Protos and build files for Google Ads API v12 d0a9cd5a7 feat: Add support for Media CDN 51fd0bf25 feat: allow recommendation users to set user labels in the request feat: add more long running operation path bindings 3d5923997 chore: regenerate API index 1742ec30e feat: Added support for PromQL queries 88a4618f7 docs: Documentation cleanup * Correct SearchVehicles docs * Add back ticks 92f5908a0 chore(ruby): Configure Dataform client library build rules 032f62dc0 chore: regenerate API index 3772bf365 feat: Added StreamingAnalyzeContent API feat: Added obfuscated_external_user_id to Participant feat: Can directly set Cloud Speech model on the SpeechToTextConfig 7967f22ba docs: Add the PrivateConnection event log bb964feba fix: bring back LRO mixin ca62355cd docs: fix minor docstring formatting beb34b405 chore: regenerate API index 4daa45369 feat: add Vertex AI Vision API 8886baccc chore(deps): Update gapic-generator-java to 2.10.1 and gax-java to 2.19.4 71715c56e chore: Update the google-cloud-channel-v1 dependency to 0.13 to ensure the CloudChannelReportsService is present 64926d52f feat: Can directly set Cloud Speech model on the SpeechToTextConfig 62443cf09 docs: Clarified TTL as time-to-live docs: Removed pre-GA disclaimer from Interaction Logging (has been GA for awhile) 13d5b3f3f chore: regenerate API index abacd4078 feat: Add name in method signature for update methods docs: Updated some documentation cb8c91471 feat: Update Compute Engine API to revision 20221011 (#736) 923a4b9a6 feat: tweak polling timeouts for filestore 5f681586f feat: Provide easier access to IAM via the standard IAMPolicy client class 6d38b260c feat: Provide easier access to IAM via the standard IAMPolicy client class 922f1f33b feat: Update transaction.proto to include different lock modes 6511fde55 chore: regenerate API index b3195f88b feat: initial generation of APIs 87d221a75 docs: add comment about max number of restrictions in filter queries 1871952ee chore: regenerate API index 62e82e76c feat(kms): enable generation of Locations mixin d6f71e315 chore: regenerate API index 0c78b0c2e feat: Add CloudChannelReportsService to CloudChannel API e981f84f8 docs: Refine GPU drivers installation proto description docs: Refine comments for deprecated proto fields docs: Update the API comments about the device_name 87b471315 chore: regenerate API index 94efa5001 feat: Adding project/folder level parents to notification configs in SCC b037bb3b4 feat: Enable install_gpu_drivers flag in v1 proto docs: Refine GPU drivers installation proto description docs: Refine comments for deprecated proto fields docs: Update the API comments about the device_name ecd0d08d8 chore: regenerate API index 778762cee feat: Adds Startup and Liveness probes to Cloud Run v2 API client libraries 9fba835b5 feat: Add SOCIAL_ENGINEERING_EXTENDED_COVERAGE threat type 9700deb55 feat!: rename fields errors_config to error_config e4d17a6d6 chore(python): Prepare google/cloud/security/publicca/v1beta1 BUILD.bazel for release 4d78f32ab docs!: mark PanelInfo.panel_id as required 7090dbed5 feat: add new field for exception audit log link feat: add support of new compliance regime for regions and new partner T systems docs: fix some typos in documentation 75d3f22e8 chore: regenerate API index cbd4501e0 feat: add RetrieveLegacySecretKey method feat: add annotation reasons REFUND, REFUND_FRAUD, TRANSACTION_ACCEPTED, TRANSACTION_DECLINED and SOCIAL_SPAM fc5be6f85 feat: Add PolicyViolation to the AuditLog proto, this will only be present when access is denied due to Organization Policy. It describes why access is denied feat: Add FirstPartyAppMetadata to the BigQueryAuditMetadata proto, it contains metadata about requests originating from Google apps, such as Google Sheets feat: Added new events to BigQueryAuditMetadata such as UnlinkDataset and RowAccessPolicyCreation docs: Updated multiple comments b37db6016 feat: Added cass_processed flag to indicate if UspsData is CASS processed feat: Deprecated highrise and multi_family field docs: Updated documentation for language_code and CASS certification cb6fbe878 feat: Update result_set.proto to return undeclared parameters in ExecuteSql API 4a3979503 feat: launch GKE Cost Allocations configuration to the v1 GKE API df8b96730 feat: vulnerability scanning exposed to public c522b5290 chore(deps): Upgrade gax-java to 2.19.2 59b73bd6f feat: add `subject_to_thresholding` field to `ResponseMetadata` type feat: add `tokens_per_project_per_hour` field to `PropertyQuota` type c73994e66 chore: regenerate API index 2af652ae3 feat: add EvaluateTimeseries method to the Timeseries Insights API 959d789be feat: remove proto ReadEfficiencyStats feat: remove field RequestStats.read_efficiency_stats feat: rename proto AllReadStats to FullReadStatsView feat: rename field RequestStats.all_read_stats to full_read_stats_view feat: rename proto ReadIteratorStats to ReadIterationStats feat: remove enum value ReadRowsRequest.RequestStatsView.REQUEST_STATS_EFFICIENCY feat: remove field ReadIterationStats.deletes_seen 767dc4505 chore: rename warm_pool_enabled to fast_startup_enabled 7b5a467b9 feat: add a new searchable field kmsKeys fix: deprecate searchable field kmsKey 99e424a07 chore: regenerate API index daca92352 fix: Removed some unnecessary documentation 052985c2c feat!: BREAKING CHANGE: temporally remove the version fields feat: add a field in cluster to describe whether the machine is disabled. fix: mark VPC project and service account as optional fields and add details for service account format 3cc6cb36d chore(ruby): Configure build rule for speech v2 client 5e8b7729f chore(ruby): Configure Ruby clients for analyticshub 8bd89cd4f feat: include conversation dataset name to be created with dataset creation metadata docs: clarify SuggestionFeature enums which are specific to chat agents ef8a54291 chore(python): Prepare google/cloud/gsuiteaddons/v1 BUILD.bazel for release 82c0f26da chore: regenerate API index fe486dded feat: added support for Private Trust to Certificate Manager API docs: See https://cloud.google.com/certificate-manager/docs/deploy-google-managed-cas 8cb255f53 docs: clarified gcs_bucket field of the SecuritySettings message f653ae0f8 docs: correct limit of required_attributes dbff0ecc2 chore: regenerate API index 0cad78c95 feat: add apis for AssuredWorkload monitoring feature and to restrict allowed resources a724450af chore(bazel): update protobuf to v3.21.7 9e3a1dd59 feat: Add support for notebook tasks 3fde7ab75 build: enable Speech v2 client library generation d02b26b0d chore: regenerate API index 82bf6749a feat: add datastore aggregation query APIs 57e38f027 feat: add new analysis status and cvss version fields 22d2bdaee docs: clarified gcs_bucket field of the SecuritySettings message 57062cd9a fix: deprecate extra field to avoid confusion ef86d8ec8 chore: regenerate API index 6deca9867 feat: Add Agent Assist Summarization API (https://cloud.google.com/agent-assist/docs/summarization) docs: clarify SuggestionFeature enums which are specific to chat agents git-subtree-dir: third_party/googleapis git-subtree-split: cc3837ae30818a91caf893b70244b5245d089f49 --- WORKSPACE | 61 +- api-index-v1.json | 20031 ++- google/actions/sdk/v2/BUILD.bazel | 2 + google/ads/admob/v1/BUILD.bazel | 16 +- google/ads/googleads/{v9 => v12}/BUILD.bazel | 80 +- .../googleads/{v9 => v12}/common/BUILD.bazel | 2 +- .../{v9 => v12}/common/ad_asset.proto | 31 +- .../{v9 => v12}/common/ad_type_infos.proto | 260 +- .../{v9 => v12}/common/asset_policy.proto | 25 +- .../v12/common/asset_set_types.proto | 180 + .../googleads/v12/common/asset_types.proto | 1023 + .../googleads/v12/common/asset_usage.proto | 39 + .../ads/googleads/v12/common/audiences.proto | 173 + .../{v9 => v12}/common/bidding.proto | 49 +- .../{v9 => v12}/common/click_location.proto | 16 +- .../{v9 => v12}/common/criteria.proto | 209 +- .../criterion_category_availability.proto | 31 +- .../{v9 => v12}/common/custom_parameter.proto | 16 +- .../{v9 => v12}/common/customizer_value.proto | 19 +- .../googleads/{v9 => v12}/common/dates.proto | 23 +- .../explorer_auto_optimizer_setting.proto | 16 +- .../{v9 => v12}/common/extensions.proto | 49 +- .../{v9 => v12}/common/feed_common.proto | 16 +- .../feed_item_set_filter_type_infos.proto | 19 +- .../{v9 => v12}/common/final_app_url.proto | 19 +- .../{v9 => v12}/common/frequency_cap.proto | 35 +- .../common/keyword_plan_common.proto | 49 +- .../common/matching_function.proto | 23 +- .../googleads/v12/common/metric_goal.proto | 42 + .../{v9 => v12}/common/metrics.proto | 171 +- .../common/offline_user_data.proto | 69 +- .../googleads/{v9 => v12}/common/policy.proto | 45 +- .../{v9 => v12}/common/policy_summary.proto | 25 +- .../common/real_time_bidding_setting.proto | 16 +- .../{v9 => v12}/common/segments.proto | 185 +- .../{v9 => v12}/common/simulation.proto | 20 +- .../{v9 => v12}/common/tag_snippet.proto | 25 +- .../common/targeting_setting.proto | 19 +- .../{v9 => v12}/common/text_label.proto | 16 +- .../{v9 => v12}/common/url_collection.proto | 16 +- .../{v9 => v12}/common/user_lists.proto | 119 +- .../googleads/{v9 => v12}/common/value.proto | 16 +- .../googleads/{v9 => v12}/enums/BUILD.bazel | 0 .../enums/access_invitation_status.proto | 16 +- .../{v9 => v12}/enums/access_reason.proto | 16 +- .../{v9 => v12}/enums/access_role.proto | 16 +- .../account_budget_proposal_status.proto | 18 +- .../enums/account_budget_proposal_type.proto | 16 +- .../enums/account_budget_status.proto | 16 +- .../enums/account_link_status.proto | 16 +- .../ad_customizer_placeholder_field.proto | 16 +- .../enums/ad_destination_type.proto | 16 +- .../enums/ad_group_ad_rotation_mode.proto | 16 +- .../enums/ad_group_ad_status.proto | 16 +- .../ad_group_criterion_approval_status.proto | 16 +- .../enums/ad_group_criterion_status.proto | 16 +- .../{v9 => v12}/enums/ad_group_status.proto | 16 +- .../{v9 => v12}/enums/ad_group_type.proto | 16 +- .../{v9 => v12}/enums/ad_network_type.proto | 16 +- .../ad_serving_optimization_status.proto | 16 +- .../{v9 => v12}/enums/ad_strength.proto | 16 +- .../googleads/{v9 => v12}/enums/ad_type.proto | 31 +- .../enums/advertising_channel_sub_type.proto | 23 +- .../enums/advertising_channel_type.proto | 22 +- ...iate_location_feed_relationship_type.proto | 16 +- ...affiliate_location_placeholder_field.proto | 16 +- .../{v9 => v12}/enums/age_range_type.proto | 19 +- .../enums/app_campaign_app_store.proto | 16 +- ..._campaign_bidding_strategy_goal_type.proto | 24 +- .../enums/app_payment_model_type.proto | 16 +- .../enums/app_placeholder_field.proto | 16 +- .../{v9 => v12}/enums/app_store.proto | 16 +- .../enums/app_url_operating_system_type.proto | 16 +- .../{v9 => v12}/enums/asset_field_type.proto | 19 +- .../enums/asset_group_status.proto | 16 +- .../{v9 => v12}/enums/asset_link_status.proto | 16 +- .../enums/asset_performance_label.proto | 16 +- .../enums/asset_set_asset_status.proto | 16 +- .../enums/asset_set_link_status.proto | 18 +- .../{v9 => v12}/enums/asset_set_status.proto | 16 +- .../googleads/v12/enums/asset_set_type.proto | 86 + .../enums/asset_source.proto} | 40 +- .../{v9 => v12}/enums/asset_type.proto | 43 +- .../v12/enums/async_action_status.proto | 57 + .../{v9 => v12}/enums/attribution_model.proto | 16 +- .../enums/audience_insights_dimension.proto | 78 + .../googleads/v12/enums/audience_status.proto | 49 + .../{v9 => v12}/enums/batch_job_status.proto | 16 +- .../enums/bid_modifier_source.proto | 16 +- .../{v9 => v12}/enums/bidding_source.proto | 16 +- .../enums/bidding_strategy_status.proto | 16 +- .../bidding_strategy_system_status.proto | 139 + .../enums/bidding_strategy_type.proto | 20 +- .../enums/billing_setup_status.proto | 16 +- .../enums/brand_safety_suitability.proto | 16 +- .../budget_campaign_association_status.proto | 16 +- .../enums/budget_delivery_method.proto | 16 +- .../{v9 => v12}/enums/budget_period.proto | 16 +- .../{v9 => v12}/enums/budget_status.proto | 16 +- .../{v9 => v12}/enums/budget_type.proto | 23 +- .../call_conversion_reporting_state.proto | 16 +- .../enums/call_placeholder_field.proto | 16 +- .../enums/call_to_action_type.proto | 16 +- .../call_tracking_display_location.proto | 16 +- .../{v9 => v12}/enums/call_type.proto | 16 +- .../enums/callout_placeholder_field.proto | 16 +- .../enums/campaign_criterion_status.proto | 16 +- .../enums/campaign_draft_status.proto | 16 +- .../enums/campaign_experiment_type.proto | 16 +- .../v12/enums/campaign_group_status.proto | 48 + .../v12/enums/campaign_primary_status.proto | 75 + .../campaign_primary_status_reason.proto | 147 + .../enums/campaign_serving_status.proto | 16 +- .../enums/campaign_shared_set_status.proto | 16 +- .../{v9 => v12}/enums/campaign_status.proto | 16 +- .../v12/enums/chain_relationship_type.proto | 48 + .../enums/change_client_type.proto | 16 +- .../enums/change_event_resource_type.proto | 25 +- .../enums/change_status_operation.proto | 16 +- .../enums/change_status_resource_type.proto | 16 +- .../{v9 => v12}/enums/click_type.proto | 19 +- .../enums/combined_audience_status.proto | 16 +- .../enums/content_label_type.proto | 16 +- .../enums/conversion_action_category.proto | 32 +- .../conversion_action_counting_type.proto | 16 +- .../enums/conversion_action_status.proto | 16 +- .../enums/conversion_action_type.proto | 41 +- .../enums/conversion_adjustment_type.proto | 16 +- .../conversion_attribution_event_type.proto | 16 +- .../conversion_custom_variable_status.proto | 16 +- .../enums/conversion_environment_enum.proto | 47 + .../enums/conversion_lag_bucket.proto | 16 +- .../conversion_or_adjustment_lag_bucket.proto | 16 +- .../{v9 => v12}/enums/conversion_origin.proto | 22 +- .../conversion_tracking_status_enum.proto | 56 + ...version_value_rule_primary_dimension.proto | 16 +- .../conversion_value_rule_set_status.proto | 16 +- .../enums/conversion_value_rule_status.proto | 16 +- ...n_category_channel_availability_mode.proto | 16 +- ...on_category_locale_availability_mode.proto | 16 +- .../criterion_system_serving_status.proto | 16 +- .../{v9 => v12}/enums/criterion_type.proto | 25 +- .../enums/custom_audience_member_type.proto | 16 +- .../enums/custom_audience_status.proto | 16 +- .../enums/custom_audience_type.proto | 16 +- .../enums/custom_conversion_goal_status.proto | 16 +- .../enums/custom_interest_member_type.proto | 16 +- .../enums/custom_interest_status.proto | 16 +- .../enums/custom_interest_type.proto | 16 +- .../enums/custom_placeholder_field.proto | 16 +- .../customer_match_upload_key_type.proto | 16 +- ...onversion_eligibility_failure_reason.proto | 16 +- .../googleads/v12/enums/customer_status.proto | 56 + .../enums/customizer_attribute_status.proto | 16 +- .../enums/customizer_attribute_type.proto | 16 +- .../enums/customizer_value_status.proto | 16 +- .../enums/data_driven_model_status.proto | 16 +- .../{v9 => v12}/enums/day_of_week.proto | 20 +- .../googleads/{v9 => v12}/enums/device.proto | 16 +- .../enums/display_ad_format_setting.proto | 20 +- .../enums/display_upload_product_type.proto | 16 +- .../{v9 => v12}/enums/distance_bucket.proto | 20 +- .../enums/dsa_page_feed_criterion_field.proto | 16 +- .../enums/education_placeholder_field.proto | 20 +- .../v12/enums/experiment_metric.proto | 81 + .../enums/experiment_metric_direction.proto | 59 + .../v12/enums/experiment_status.proto | 65 + .../googleads/v12/enums/experiment_type.proto | 72 + .../enums/extension_setting_device.proto | 16 +- .../{v9 => v12}/enums/extension_type.proto | 16 +- .../enums/external_conversion_source.proto | 19 +- .../enums/feed_attribute_type.proto | 16 +- .../feed_item_quality_approval_status.proto | 16 +- ...feed_item_quality_disapproval_reason.proto | 16 +- .../enums/feed_item_set_status.proto | 16 +- .../feed_item_set_string_filter_type.proto | 16 +- .../{v9 => v12}/enums/feed_item_status.proto | 16 +- .../enums/feed_item_target_device.proto | 16 +- .../enums/feed_item_target_status.proto | 16 +- .../enums/feed_item_target_type.proto | 16 +- .../enums/feed_item_validation_status.proto | 16 +- .../{v9 => v12}/enums/feed_link_status.proto | 16 +- .../enums/feed_mapping_criterion_type.proto | 16 +- .../enums/feed_mapping_status.proto | 16 +- .../{v9 => v12}/enums/feed_origin.proto | 16 +- .../{v9 => v12}/enums/feed_status.proto | 16 +- .../enums/flight_placeholder_field.proto | 16 +- .../enums/frequency_cap_event_type.proto | 18 +- .../enums/frequency_cap_level.proto | 16 +- .../enums/frequency_cap_time_unit.proto | 18 +- .../{v9 => v12}/enums/gender_type.proto | 18 +- .../enums/geo_target_constant_status.proto | 16 +- .../enums/geo_targeting_restriction.proto | 16 +- .../enums/geo_targeting_type.proto | 16 +- .../{v9 => v12}/enums/goal_config_level.proto | 16 +- .../enums/google_ads_field_category.proto | 16 +- .../enums/google_ads_field_data_type.proto | 16 +- .../enums/google_voice_call_status.proto | 16 +- .../enums/hotel_date_selection_type.proto | 16 +- .../enums/hotel_placeholder_field.proto | 16 +- .../enums/hotel_price_bucket.proto | 16 +- .../{v9 => v12}/enums/hotel_rate_type.proto | 22 +- .../enums/hotel_reconciliation_status.proto | 16 +- .../enums/image_placeholder_field.proto | 16 +- .../{v9 => v12}/enums/income_range_type.proto | 18 +- .../enums/interaction_event_type.proto | 18 +- .../{v9 => v12}/enums/interaction_type.proto | 16 +- .../{v9 => v12}/enums/invoice_type.proto | 16 +- .../enums/job_placeholder_field.proto | 20 +- .../enums/keyword_match_type.proto | 16 +- .../keyword_plan_aggregate_metric_type.proto | 16 +- .../keyword_plan_competition_level.proto | 16 +- .../keyword_plan_concept_group_type.proto | 16 +- .../keyword_plan_forecast_interval.proto | 16 +- .../keyword_plan_keyword_annotation.proto | 16 +- .../enums/keyword_plan_network.proto | 16 +- .../{v9 => v12}/enums/label_status.proto | 16 +- .../enums/lead_form_call_to_action_type.proto | 16 +- .../enums/lead_form_desired_intent.proto | 20 +- .../lead_form_field_user_input_type.proto | 236 +- ...form_post_submit_call_to_action_type.proto | 16 +- .../legacy_app_install_ad_app_store.proto | 16 +- .../enums/linked_account_type.proto | 24 +- ..._group_filter_bidding_category_level.proto | 16 +- ..._group_filter_custom_attribute_index.proto | 16 +- ...listing_group_filter_product_channel.proto | 16 +- ...sting_group_filter_product_condition.proto | 16 +- ...ting_group_filter_product_type_level.proto | 16 +- .../listing_group_filter_type_enum.proto | 16 +- .../enums/listing_group_filter_vertical.proto | 16 +- .../enums/listing_group_type.proto | 16 +- .../enums/local_placeholder_field.proto | 20 +- ..._extension_targeting_criterion_field.proto | 16 +- .../enums/location_group_radius_units.proto | 18 +- .../v12/enums/location_ownership_type.proto | 48 + .../enums/location_placeholder_field.proto | 16 +- .../enums/location_source_type.proto | 16 +- .../enums/location_string_filter_type.proto | 45 + .../enums/manager_link_status.proto | 16 +- .../matching_function_context_type.proto | 16 +- .../enums/matching_function_operator.proto | 16 +- .../{v9 => v12}/enums/media_type.proto | 16 +- .../enums/merchant_center_link_status.proto | 16 +- .../enums/message_placeholder_field.proto | 16 +- .../{v9 => v12}/enums/mime_type.proto | 16 +- .../{v9 => v12}/enums/minute_of_hour.proto | 18 +- .../{v9 => v12}/enums/mobile_app_vendor.proto | 16 +- .../enums/mobile_device_type.proto | 16 +- .../{v9 => v12}/enums/month_of_year.proto | 20 +- .../enums/negative_geo_target_type.proto | 16 +- ...offline_user_data_job_failure_reason.proto | 28 +- ...fline_user_data_job_match_rate_range.proto | 18 +- .../enums/offline_user_data_job_status.proto | 16 +- .../enums/offline_user_data_job_type.proto | 16 +- ...erating_system_version_operator_type.proto | 16 +- .../enums/optimization_goal_type.proto | 16 +- .../enums/parental_status_type.proto | 18 +- .../{v9 => v12}/enums/payment_mode.proto | 20 +- .../performance_max_upgrade_status.proto | 55 + .../{v9 => v12}/enums/placeholder_type.proto | 18 +- .../{v9 => v12}/enums/placement_type.proto | 26 +- .../enums/policy_approval_status.proto | 16 +- .../enums/policy_review_status.proto | 16 +- .../enums/policy_topic_entry_type.proto | 16 +- ...idence_destination_mismatch_url_type.proto | 16 +- ...dence_destination_not_working_device.proto | 16 +- ...stination_not_working_dns_error_type.proto | 16 +- .../enums/positive_geo_target_type.proto | 16 +- .../enums/preferred_content_type.proto | 16 +- .../price_extension_price_qualifier.proto | 16 +- .../enums/price_extension_price_unit.proto | 16 +- .../enums/price_extension_type.proto | 16 +- .../enums/price_placeholder_field.proto | 40 +- .../product_bidding_category_level.proto | 16 +- .../product_bidding_category_status.proto | 16 +- .../{v9 => v12}/enums/product_channel.proto | 16 +- .../enums/product_channel_exclusivity.proto | 16 +- .../{v9 => v12}/enums/product_condition.proto | 16 +- .../product_custom_attribute_index.proto | 16 +- .../enums/product_type_level.proto | 16 +- ...romotion_extension_discount_modifier.proto | 16 +- .../enums/promotion_extension_occasion.proto | 18 +- .../enums/promotion_placeholder_field.proto | 18 +- .../enums/proximity_radius_units.proto | 18 +- .../enums/quality_score_bucket.proto | 16 +- .../enums/reach_plan_age_range.proto | 16 +- .../enums/reach_plan_network.proto | 16 +- .../enums/real_estate_placeholder_field.proto | 20 +- .../enums/recommendation_type.proto | 48 +- .../enums/resource_change_operation.proto | 16 +- .../enums/resource_limit_type.proto | 86 +- .../enums/response_content_type.proto | 16 +- .../search_engine_results_page_type.proto | 16 +- .../enums/search_term_match_type.proto | 16 +- .../enums/search_term_targeting_status.proto | 16 +- .../enums/seasonality_event_scope.proto | 18 +- .../enums/seasonality_event_status.proto | 16 +- .../enums/served_asset_field_type.proto | 16 +- .../{v9 => v12}/enums/shared_set_status.proto | 16 +- .../{v9 => v12}/enums/shared_set_type.proto | 16 +- .../simulation_modification_method.proto | 16 +- .../{v9 => v12}/enums/simulation_type.proto | 16 +- .../enums/sitelink_placeholder_field.proto | 16 +- .../enums/sk_ad_network_ad_event_type.proto | 52 + .../sk_ad_network_attribution_credit.proto | 53 + .../v12/enums/sk_ad_network_user_type.proto | 52 + .../googleads/{v9 => v12}/enums/slot.proto | 16 +- .../enums/spending_limit_type.proto | 16 +- ...structured_snippet_placeholder_field.proto | 16 +- .../enums/summary_row_setting.proto | 16 +- .../enums/system_managed_entity_source.proto | 16 +- ...arget_cpa_opt_in_recommendation_goal.proto | 16 +- .../target_impression_share_location.proto | 16 +- .../enums/targeting_dimension.proto | 24 +- .../{v9 => v12}/enums/time_type.proto | 16 +- .../enums/tracking_code_page_format.proto | 16 +- .../enums/tracking_code_type.proto | 16 +- .../enums/travel_placeholder_field.proto | 20 +- .../enums/user_identifier_source.proto | 16 +- .../enums/user_interest_taxonomy_type.proto | 16 +- .../enums/user_list_access_status.proto | 16 +- .../enums/user_list_closing_reason.proto | 16 +- .../user_list_combined_rule_operator.proto | 16 +- .../user_list_crm_data_source_type.proto | 16 +- .../user_list_date_rule_item_operator.proto | 16 +- .../user_list_flexible_rule_operator.proto | 46 + .../user_list_logical_rule_operator.proto | 16 +- .../enums/user_list_membership_status.proto | 16 +- .../user_list_number_rule_item_operator.proto | 16 +- .../user_list_prepopulation_status.proto | 16 +- .../enums/user_list_rule_type.proto | 16 +- .../enums/user_list_size_range.proto | 16 +- .../user_list_string_rule_item_operator.proto | 16 +- .../{v9 => v12}/enums/user_list_type.proto | 16 +- .../enums/value_rule_device_type.proto | 16 +- .../value_rule_geo_location_match_type.proto | 16 +- .../enums/value_rule_operation.proto | 16 +- .../value_rule_set_attachment_type.proto | 16 +- .../enums/value_rule_set_dimension.proto | 19 +- .../vanity_pharma_display_url_mode.proto | 16 +- .../enums/vanity_pharma_text.proto | 16 +- .../{v9 => v12}/enums/video_thumbnail.proto | 16 +- .../enums/webpage_condition_operand.proto | 16 +- .../enums/webpage_condition_operator.proto | 16 +- .../googleads/{v9 => v12}/errors/BUILD.bazel | 4 +- .../errors/access_invitation_error.proto | 20 +- .../account_budget_proposal_error.proto | 20 +- .../errors/account_link_error.proto | 19 +- .../errors/ad_customizer_error.proto | 16 +- .../{v9 => v12}/errors/ad_error.proto | 38 +- .../errors/ad_group_ad_error.proto | 16 +- .../errors/ad_group_bid_modifier_error.proto | 16 +- .../ad_group_criterion_customizer_error.proto | 16 +- .../errors/ad_group_criterion_error.proto | 20 +- .../errors/ad_group_customizer_error.proto | 16 +- .../{v9 => v12}/errors/ad_group_error.proto | 16 +- .../errors/ad_group_feed_error.proto | 16 +- .../errors/ad_parameter_error.proto | 16 +- .../{v9 => v12}/errors/ad_sharing_error.proto | 16 +- .../{v9 => v12}/errors/adx_error.proto | 16 +- .../{v9 => v12}/errors/asset_error.proto | 38 +- .../errors/asset_group_asset_error.proto | 16 +- .../errors/asset_group_error.proto | 16 +- ...set_group_listing_group_filter_error.proto | 16 +- .../{v9 => v12}/errors/asset_link_error.proto | 37 +- .../errors/asset_set_asset_error.proto | 21 +- .../v12/errors/asset_set_error.proto | 70 + .../errors/asset_set_link_error.proto | 16 +- .../googleads/v12/errors/audience_error.proto | 68 + .../v12/errors/audience_insights_error.proto | 46 + .../errors/authentication_error.proto | 32 +- .../errors/authorization_error.proto | 21 +- .../{v9 => v12}/errors/batch_job_error.proto | 16 +- .../{v9 => v12}/errors/bidding_error.proto | 27 +- .../errors/bidding_strategy_error.proto | 16 +- .../errors/billing_setup_error.proto | 19 +- .../errors/campaign_budget_error.proto | 16 +- .../campaign_conversion_goal_error.proto} | 32 +- .../errors/campaign_criterion_error.proto | 35 +- .../errors/campaign_customizer_error.proto | 16 +- .../errors/campaign_draft_error.proto | 16 +- .../{v9 => v12}/errors/campaign_error.proto | 28 +- .../errors/campaign_experiment_error.proto | 16 +- .../errors/campaign_feed_error.proto | 19 +- .../errors/campaign_shared_set_error.proto | 16 +- .../errors/change_event_error.proto | 16 +- .../errors/change_status_error.proto | 16 +- .../errors/collection_size_error.proto | 16 +- .../{v9 => v12}/errors/context_error.proto | 16 +- .../errors/conversion_action_error.proto | 16 +- .../conversion_adjustment_upload_error.proto | 36 +- .../conversion_custom_variable_error.proto | 20 +- ...onversion_goal_campaign_config_error.proto | 53 + .../errors/conversion_upload_error.proto | 57 +- .../errors/conversion_value_rule_error.proto | 18 +- .../conversion_value_rule_set_error.proto | 34 +- .../errors/country_code_error.proto | 16 +- .../{v9 => v12}/errors/criterion_error.proto | 60 +- .../errors/currency_code_error.proto | 16 +- .../errors/custom_audience_error.proto | 16 +- .../errors/custom_conversion_goal_error.proto | 22 +- .../errors/custom_interest_error.proto | 16 +- .../errors/customer_client_link_error.proto | 16 +- .../errors/customer_customizer_error.proto | 16 +- .../{v9 => v12}/errors/customer_error.proto | 16 +- .../errors/customer_feed_error.proto | 16 +- .../errors/customer_manager_link_error.proto | 16 +- .../errors/customer_user_access_error.proto | 16 +- .../errors/customizer_attribute_error.proto | 16 +- .../{v9 => v12}/errors/database_error.proto | 20 +- .../{v9 => v12}/errors/date_error.proto | 16 +- .../{v9 => v12}/errors/date_range_error.proto | 16 +- .../{v9 => v12}/errors/distinct_error.proto | 16 +- .../{v9 => v12}/errors/enum_error.proto | 16 +- .../googleads/{v9 => v12}/errors/errors.proto | 327 +- .../v12/errors/experiment_arm_error.proto | 86 + .../v12/errors/experiment_error.proto | 120 + .../errors/extension_feed_item_error.proto | 28 +- .../errors/extension_setting_error.proto | 28 +- .../feed_attribute_reference_error.proto | 16 +- .../{v9 => v12}/errors/feed_error.proto | 16 +- .../{v9 => v12}/errors/feed_item_error.proto | 19 +- .../errors/feed_item_set_error.proto | 16 +- .../errors/feed_item_set_link_error.proto | 16 +- .../errors/feed_item_target_error.proto | 16 +- .../errors/feed_item_validation_error.proto | 22 +- .../errors/feed_mapping_error.proto | 19 +- .../{v9 => v12}/errors/field_error.proto | 19 +- .../{v9 => v12}/errors/field_mask_error.proto | 16 +- .../{v9 => v12}/errors/function_error.proto | 16 +- .../errors/function_parsing_error.proto | 16 +- ...geo_target_constant_suggestion_error.proto | 16 +- .../{v9 => v12}/errors/header_error.proto | 16 +- .../{v9 => v12}/errors/id_error.proto | 22 +- .../{v9 => v12}/errors/image_error.proto | 16 +- .../{v9 => v12}/errors/internal_error.proto | 16 +- .../{v9 => v12}/errors/invoice_error.proto | 16 +- .../errors/keyword_plan_ad_group_error.proto | 16 +- .../keyword_plan_ad_group_keyword_error.proto | 16 +- .../errors/keyword_plan_campaign_error.proto | 16 +- .../keyword_plan_campaign_keyword_error.proto | 16 +- .../errors/keyword_plan_error.proto | 16 +- .../errors/keyword_plan_idea_error.proto | 16 +- .../{v9 => v12}/errors/label_error.proto | 16 +- .../errors/language_code_error.proto | 16 +- .../errors/list_operation_error.proto | 16 +- .../errors/manager_link_error.proto | 16 +- .../errors/media_bundle_error.proto | 16 +- .../{v9 => v12}/errors/media_file_error.proto | 16 +- .../errors/media_upload_error.proto | 18 +- .../errors/merchant_center_error.proto | 16 +- .../{v9 => v12}/errors/multiplier_error.proto | 23 +- .../{v9 => v12}/errors/mutate_error.proto | 16 +- .../errors/new_resource_creation_error.proto | 16 +- .../errors/not_allowlisted_error.proto | 16 +- .../{v9 => v12}/errors/not_empty_error.proto | 16 +- .../{v9 => v12}/errors/null_error.proto | 16 +- .../errors/offline_user_data_job_error.proto | 37 +- .../operation_access_denied_error.proto | 16 +- .../{v9 => v12}/errors/operator_error.proto | 16 +- .../errors/partial_failure_error.proto | 16 +- .../errors/payments_account_error.proto | 16 +- .../errors/policy_finding_error.proto | 16 +- .../policy_validation_parameter_error.proto | 16 +- .../errors/policy_violation_error.proto | 16 +- .../{v9 => v12}/errors/query_error.proto | 22 +- .../{v9 => v12}/errors/quota_error.proto | 16 +- .../{v9 => v12}/errors/range_error.proto | 16 +- .../{v9 => v12}/errors/reach_plan_error.proto | 16 +- .../errors/recommendation_error.proto | 28 +- .../errors/region_code_error.proto | 16 +- .../{v9 => v12}/errors/request_error.proto | 16 +- .../errors/resource_access_denied_error.proto | 16 +- .../resource_count_limit_exceeded_error.proto | 16 +- .../{v9 => v12}/errors/setting_error.proto | 21 +- .../errors/shared_criterion_error.proto | 16 +- .../{v9 => v12}/errors/shared_set_error.proto | 16 +- .../{v9 => v12}/errors/size_limit_error.proto | 20 +- .../v12/errors/smart_campaign_error.proto | 64 + .../errors/string_format_error.proto | 16 +- .../errors/string_length_error.proto | 16 +- ...third_party_app_analytics_link_error.proto | 16 +- .../{v9 => v12}/errors/time_zone_error.proto | 16 +- .../{v9 => v12}/errors/url_field_error.proto | 41 +- .../{v9 => v12}/errors/user_data_error.proto | 19 +- .../{v9 => v12}/errors/user_list_error.proto | 18 +- .../youtube_video_registration_error.proto | 20 +- google/ads/googleads/v12/googleads_gapic.yaml | 26 + .../v12/googleads_grpc_service_config.json | 330 + google/ads/googleads/v12/googleads_v12.yaml | 817 + .../{v9 => v12}/resources/BUILD.bazel | 6 +- .../accessible_bidding_strategy.proto | 45 +- .../resources/account_budget.proto | 71 +- .../resources/account_budget_proposal.proto | 57 +- .../{v9 => v12}/resources/account_link.proto | 59 +- .../googleads/{v9 => v12}/resources/ad.proto | 98 +- .../{v9 => v12}/resources/ad_group.proto | 87 +- .../{v9 => v12}/resources/ad_group_ad.proto | 37 +- .../ad_group_ad_asset_combination_view.proto | 64 + .../resources/ad_group_ad_asset_view.proto | 42 +- .../resources/ad_group_ad_label.proto | 15 +- .../resources/ad_group_asset.proto | 27 +- .../v12/resources/ad_group_asset_set.proto | 71 + .../resources/ad_group_audience_view.proto | 15 +- .../resources/ad_group_bid_modifier.proto | 37 +- .../resources/ad_group_criterion.proto | 98 +- .../ad_group_criterion_customizer.proto | 23 +- .../resources/ad_group_criterion_label.proto | 15 +- .../ad_group_criterion_simulation.proto | 29 +- .../resources/ad_group_customizer.proto | 23 +- .../ad_group_extension_setting.proto | 23 +- .../{v9 => v12}/resources/ad_group_feed.proto | 27 +- .../resources/ad_group_label.proto | 15 +- .../resources/ad_group_simulation.proto | 33 +- .../{v9 => v12}/resources/ad_parameter.proto | 17 +- .../resources/ad_schedule_view.proto | 15 +- .../resources/age_range_view.proto | 15 +- .../ads/googleads/v12/resources/asset.proto | 186 + .../resources/asset_field_type_view.proto | 19 +- .../{v9 => v12}/resources/asset_group.proto | 31 +- .../resources/asset_group_asset.proto | 35 +- .../asset_group_listing_group_filter.proto | 53 +- .../asset_group_product_group_view.proto | 31 +- .../v12/resources/asset_group_signal.proto | 63 + .../{v9 => v12}/resources/asset_set.proto | 49 +- .../resources/asset_set_asset.proto | 19 +- .../v12/resources/asset_set_type_view.proto | 57 + .../googleads/v12/resources/audience.proto | 76 + .../{v9 => v12}/resources/batch_job.proto | 19 +- .../resources/bidding_data_exclusion.proto | 31 +- .../bidding_seasonality_adjustment.proto | 31 +- .../resources/bidding_strategy.proto | 48 +- .../bidding_strategy_simulation.proto | 29 +- .../{v9 => v12}/resources/billing_setup.proto | 35 +- .../{v9 => v12}/resources/call_view.proto | 27 +- .../{v9 => v12}/resources/campaign.proto | 281 +- .../resources/campaign_asset.proto | 27 +- .../resources/campaign_asset_set.proto | 19 +- .../resources/campaign_audience_view.proto | 15 +- .../resources/campaign_bid_modifier.proto | 19 +- .../resources/campaign_budget.proto | 38 +- .../resources/campaign_conversion_goal.proto | 23 +- .../resources/campaign_criterion.proto | 85 +- .../campaign_criterion_simulation.proto | 27 +- .../resources/campaign_customizer.proto | 23 +- .../resources/campaign_draft.proto | 19 +- .../campaign_extension_setting.proto | 23 +- .../{v9 => v12}/resources/campaign_feed.proto | 27 +- .../v12/resources/campaign_group.proto | 68 + .../resources/campaign_label.proto | 15 +- .../resources/campaign_shared_set.proto | 19 +- .../resources/campaign_simulation.proto | 59 +- .../resources/carrier_constant.proto | 19 +- .../{v9 => v12}/resources/change_event.proto | 79 +- .../{v9 => v12}/resources/change_status.proto | 29 +- .../{v9 => v12}/resources/click_view.proto | 25 +- .../resources/combined_audience.proto | 19 +- .../resources/conversion_action.proto | 68 +- .../conversion_custom_variable.proto | 19 +- .../conversion_goal_campaign_config.proto | 19 +- .../resources/conversion_value_rule.proto | 33 +- .../resources/conversion_value_rule_set.proto | 33 +- .../resources/currency_constant.proto | 20 +- .../resources/custom_audience.proto | 27 +- .../resources/custom_conversion_goal.proto | 19 +- .../resources/custom_interest.proto | 27 +- .../{v9 => v12}/resources/customer.proto | 61 +- .../resources/customer_asset.proto | 27 +- .../v12/resources/customer_asset_set.proto | 71 + .../resources/customer_client.proto | 23 +- .../resources/customer_client_link.proto | 19 +- .../resources/customer_conversion_goal.proto | 23 +- .../resources/customer_customizer.proto | 23 +- .../customer_extension_setting.proto | 23 +- .../{v9 => v12}/resources/customer_feed.proto | 27 +- .../resources/customer_label.proto | 15 +- .../resources/customer_manager_link.proto | 19 +- .../customer_negative_criterion.proto | 33 +- .../resources/customer_user_access.proto | 19 +- .../customer_user_access_invitation.proto | 23 +- .../resources/customizer_attribute.proto | 23 +- .../resources/detail_placement_view.proto | 30 +- .../resources/detailed_demographic.proto | 23 +- .../resources/display_keyword_view.proto | 15 +- .../{v9 => v12}/resources/distance_view.proto | 19 +- .../resources/domain_category.proto | 24 +- .../dynamic_search_ads_search_term_view.proto | 15 +- .../expanded_landing_page_view.proto | 15 +- .../googleads/v12/resources/experiment.proto | 106 + .../v12/resources/experiment_arm.proto | 84 + .../resources/extension_feed_item.proto | 59 +- .../{v9 => v12}/resources/feed.proto | 31 +- .../{v9 => v12}/resources/feed_item.proto | 80 +- .../{v9 => v12}/resources/feed_item_set.proto | 25 +- .../resources/feed_item_set_link.proto | 15 +- .../resources/feed_item_target.proto | 33 +- .../v12/resources/feed_mapping.proto | 188 + .../resources/feed_placeholder_view.proto | 19 +- .../{v9 => v12}/resources/gender_view.proto | 15 +- .../resources/geo_target_constant.proto | 19 +- .../resources/geographic_view.proto | 19 +- .../resources/google_ads_field.proto | 23 +- .../resources/group_placement_view.proto | 26 +- .../resources/hotel_group_view.proto | 15 +- .../resources/hotel_performance_view.proto | 15 +- .../resources/hotel_reconciliation.proto | 29 +- .../resources/income_range_view.proto | 15 +- .../{v9 => v12}/resources/invoice.proto | 117 +- .../{v9 => v12}/resources/keyword_plan.proto | 26 +- .../resources/keyword_plan_ad_group.proto | 15 +- .../keyword_plan_ad_group_keyword.proto | 28 +- .../resources/keyword_plan_campaign.proto | 19 +- .../keyword_plan_campaign_keyword.proto | 19 +- .../resources/keyword_theme_constant.proto | 15 +- .../{v9 => v12}/resources/keyword_view.proto | 15 +- .../{v9 => v12}/resources/label.proto | 25 +- .../resources/landing_page_view.proto | 15 +- .../resources/language_constant.proto | 21 +- .../resources/lead_form_submission_data.proto | 118 + .../{v9 => v12}/resources/life_event.proto | 21 +- .../{v9 => v12}/resources/location_view.proto | 15 +- .../resources/managed_placement_view.proto | 15 +- .../{v9 => v12}/resources/media_file.proto | 25 +- .../resources/merchant_center_link.proto | 19 +- .../mobile_app_category_constant.proto | 15 +- .../resources/mobile_device_constant.proto | 19 +- .../resources/offline_user_data_job.proto | 43 +- .../operating_system_version_constant.proto | 19 +- .../paid_organic_search_term_view.proto | 15 +- .../resources/parental_status_view.proto | 15 +- .../resources/payments_account.proto | 19 +- .../v12/resources/per_store_view.proto | 55 + .../product_bidding_category_constant.proto | 23 +- .../resources/product_group_view.proto | 15 +- .../resources/recommendation.proto | 246 +- .../resources/remarketing_action.proto | 19 +- .../resources/search_term_view.proto | 19 +- .../resources/shared_criterion.proto | 33 +- .../{v9 => v12}/resources/shared_set.proto | 23 +- .../resources/shopping_performance_view.proto | 15 +- .../smart_campaign_search_term_view.proto | 15 +- .../resources/smart_campaign_setting.proto | 55 +- .../third_party_app_analytics_link.proto | 15 +- .../resources/topic_constant.proto | 15 +- .../{v9 => v12}/resources/topic_view.proto | 15 +- .../{v9 => v12}/resources/user_interest.proto | 23 +- .../{v9 => v12}/resources/user_list.proto | 57 +- .../resources/user_location_view.proto | 15 +- .../{v9 => v12}/resources/video.proto | 15 +- .../{v9 => v12}/resources/webpage_view.proto | 15 +- .../{v9 => v12}/services/BUILD.bazel | 8 +- .../account_budget_proposal_service.proto | 65 +- .../services/account_link_service.proto | 75 +- .../services/ad_group_ad_label_service.proto | 64 +- .../services/ad_group_ad_service.proto | 73 +- .../services/ad_group_asset_service.proto | 69 +- .../services/ad_group_asset_set_service.proto | 117 + .../ad_group_bid_modifier_service.proto | 69 +- ...d_group_criterion_customizer_service.proto | 41 +- .../ad_group_criterion_label_service.proto | 62 +- .../services/ad_group_criterion_service.proto | 75 +- .../ad_group_customizer_service.proto | 41 +- .../ad_group_extension_setting_service.proto | 70 +- .../services/ad_group_feed_service.proto | 69 +- .../services/ad_group_label_service.proto | 61 +- .../services/ad_group_service.proto | 69 +- .../services/ad_parameter_service.proto | 69 +- .../{v9 => v12}/services/ad_service.proto | 46 +- .../services/asset_group_asset_service.proto | 59 +- ...t_group_listing_group_filter_service.proto | 39 +- .../services/asset_group_service.proto | 55 +- .../services/asset_group_signal_service.proto | 117 + .../{v9 => v12}/services/asset_service.proto | 65 +- .../services/asset_set_asset_service.proto | 41 +- .../services/asset_set_service.proto | 43 +- .../services/audience_insights_service.proto | 484 + .../v12/services/audience_service.proto | 118 + .../services/batch_job_service.proto | 87 +- .../bidding_data_exclusion_service.proto | 62 +- ...dding_seasonality_adjustment_service.proto | 62 +- .../services/bidding_strategy_service.proto | 69 +- .../services/billing_setup_service.proto | 56 +- .../services/campaign_asset_service.proto | 69 +- .../services/campaign_asset_set_service.proto | 41 +- .../campaign_bid_modifier_service.proto | 69 +- .../services/campaign_budget_service.proto | 69 +- .../campaign_conversion_goal_service.proto | 27 +- .../services/campaign_criterion_service.proto | 69 +- .../campaign_customizer_service.proto | 41 +- .../services/campaign_draft_service.proto | 88 +- .../campaign_extension_setting_service.proto | 70 +- .../services/campaign_feed_service.proto | 69 +- .../v12/services/campaign_group_service.proto | 129 + .../services/campaign_label_service.proto | 61 +- .../services/campaign_service.proto | 69 +- .../campaign_shared_set_service.proto | 67 +- .../services/conversion_action_service.proto | 71 +- ...conversion_adjustment_upload_service.proto | 43 +- .../conversion_custom_variable_service.proto | 68 +- ...version_goal_campaign_config_service.proto | 31 +- .../services/conversion_upload_service.proto | 78 +- .../conversion_value_rule_service.proto | 64 +- .../conversion_value_rule_set_service.proto | 64 +- .../services/custom_audience_service.proto | 59 +- .../custom_conversion_goal_service.proto | 39 +- .../services/custom_interest_service.proto | 55 +- .../services/customer_asset_service.proto | 69 +- .../services/customer_asset_set_service.proto | 117 + .../customer_client_link_service.proto | 55 +- .../customer_conversion_goal_service.proto | 27 +- .../customer_customizer_service.proto | 41 +- .../customer_extension_setting_service.proto | 70 +- .../services/customer_feed_service.proto | 69 +- .../services/customer_label_service.proto | 61 +- .../customer_manager_link_service.proto | 65 +- .../customer_negative_criterion_service.proto | 68 +- .../services/customer_service.proto | 82 +- ...tomer_user_access_invitation_service.proto | 56 +- .../customer_user_access_service.proto | 58 +- .../customizer_attribute_service.proto | 41 +- .../v12/services/experiment_arm_service.proto | 134 + .../v12/services/experiment_service.proto | 390 + .../extension_feed_item_service.proto | 69 +- .../services/feed_item_service.proto | 69 +- .../services/feed_item_set_link_service.proto | 61 +- .../services/feed_item_set_service.proto | 63 +- .../services/feed_item_target_service.proto | 67 +- .../services/feed_mapping_service.proto | 67 +- .../{v9 => v12}/services/feed_service.proto | 69 +- .../geo_target_constant_service.proto | 55 +- .../services/google_ads_field_service.proto | 30 +- .../services/google_ads_service.proto | 864 +- .../services/invoice_service.proto | 26 +- ...eyword_plan_ad_group_keyword_service.proto | 60 +- .../keyword_plan_ad_group_service.proto | 59 +- ...eyword_plan_campaign_keyword_service.proto | 60 +- .../keyword_plan_campaign_service.proto | 59 +- .../services/keyword_plan_idea_service.proto | 353 + .../services/keyword_plan_service.proto | 93 +- .../keyword_theme_constant_service.proto | 47 +- .../{v9 => v12}/services/label_service.proto | 69 +- .../services/media_file_service.proto | 63 +- .../merchant_center_link_service.proto | 44 +- .../offline_user_data_job_service.proto | 77 +- .../services/payments_account_service.proto | 22 +- .../services/reach_plan_service.proto | 312 +- .../services/recommendation_service.proto | 149 +- .../services/remarketing_action_service.proto | 59 +- .../services/shared_criterion_service.proto | 67 +- .../services/shared_set_service.proto | 69 +- .../smart_campaign_setting_service.proto | 53 +- .../smart_campaign_suggest_service.proto | 78 +- ...ird_party_app_analytics_link_service.proto | 47 +- .../services/user_data_service.proto | 39 +- .../services/user_list_service.proto | 63 +- .../ads/googleads/v9/common/asset_types.proto | 502 - .../v9/enums/campaign_experiment_status.proto | 77 - ...mpaign_experiment_traffic_split_type.proto | 53 - .../v9/enums/reach_plan_ad_length.proto | 53 - google/ads/googleads/v9/googleads_gapic.yaml | 26 - .../v9/googleads_grpc_service_config.json | 474 - google/ads/googleads/v9/googleads_v9.yaml | 1514 - google/ads/googleads/v9/resources/asset.proto | 156 - .../v9/resources/campaign_experiment.proto | 121 - .../googleads/v9/resources/feed_mapping.proto | 189 - .../accessible_bidding_strategy_service.proto | 58 - .../v9/services/account_budget_service.proto | 70 - .../ad_group_ad_asset_view_service.proto | 67 - .../ad_group_audience_view_service.proto | 67 - ...d_group_criterion_simulation_service.proto | 68 - .../ad_group_simulation_service.proto | 67 - .../services/ad_schedule_view_service.proto | 67 - .../v9/services/age_range_view_service.proto | 67 - .../asset_field_type_view_service.proto | 59 - .../bidding_strategy_simulation_service.proto | 60 - .../campaign_audience_view_service.proto | 67 - ...ampaign_criterion_simulation_service.proto | 68 - .../campaign_experiment_service.proto | 382 - .../campaign_simulation_service.proto | 60 - .../services/carrier_constant_service.proto | 67 - .../v9/services/change_status_service.proto | 67 - .../v9/services/click_view_service.proto | 67 - .../services/combined_audience_service.proto | 69 - .../services/currency_constant_service.proto | 65 - .../v9/services/customer_client_service.proto | 67 - .../detail_placement_view_service.proto | 67 - .../detailed_demographic_service.proto | 59 - .../display_keyword_view_service.proto | 67 - .../v9/services/distance_view_service.proto | 67 - .../v9/services/domain_category_service.proto | 68 - ..._search_ads_search_term_view_service.proto | 68 - .../expanded_landing_page_view_service.proto | 68 - .../feed_placeholder_view_service.proto | 67 - .../v9/services/gender_view_service.proto | 67 - .../v9/services/geographic_view_service.proto | 67 - .../group_placement_view_service.proto | 67 - .../services/hotel_group_view_service.proto | 67 - .../hotel_performance_view_service.proto | 67 - .../services/income_range_view_service.proto | 67 - .../services/keyword_plan_idea_service.proto | 181 - .../v9/services/keyword_view_service.proto | 67 - .../services/landing_page_view_service.proto | 67 - .../services/language_constant_service.proto | 67 - .../v9/services/life_event_service.proto | 59 - .../v9/services/location_view_service.proto | 67 - .../managed_placement_view_service.proto | 67 - ...mobile_app_category_constant_service.proto | 66 - .../mobile_device_constant_service.proto | 67 - ...ting_system_version_constant_service.proto | 68 - ...aid_organic_search_term_view_service.proto | 68 - .../parental_status_view_service.proto | 67 - ...ct_bidding_category_constant_service.proto | 68 - .../services/product_group_view_service.proto | 67 - .../services/search_term_view_service.proto | 67 - .../shopping_performance_view_service.proto | 68 - ...rt_campaign_search_term_view_service.proto | 68 - .../v9/services/topic_constant_service.proto | 67 - .../v9/services/topic_view_service.proto | 67 - .../v9/services/user_interest_service.proto | 67 - .../services/user_location_view_service.proto | 67 - .../googleads/v9/services/video_service.proto | 67 - .../v9/services/webpage_view_service.proto | 59 - google/ads/searchads360/v0/BUILD.bazel | 122 + google/ads/searchads360/v0/common/BUILD.bazel | 101 + .../ads/searchads360/v0/common/bidding.proto | 203 + .../ads/searchads360/v0/common/criteria.proto | 143 + .../v0/common/custom_parameter.proto | 38 + .../v0/common/frequency_cap.proto | 34 + .../ads/searchads360/v0/common/metrics.proto | 354 + .../v0/common/real_time_bidding_setting.proto | 35 + .../ads/searchads360/v0/common/segments.proto | 73 + google/ads/searchads360/v0/common/value.proto | 49 + google/ads/searchads360/v0/enums/BUILD.bazel | 95 + .../v0/enums/account_status.proto | 57 + .../searchads360/v0/enums/account_type.proto | 66 + .../v0/enums/ad_group_ad_rotation_mode.proto | 51 + .../ad_group_criterion_engine_status.proto | 104 + .../v0/enums/ad_group_criterion_status.proto | 53 + .../v0/enums/ad_group_status.proto | 53 + .../searchads360/v0/enums/ad_group_type.proto | 98 + .../ad_serving_optimization_status.proto | 62 + .../enums/advertising_channel_sub_type.proto | 99 + .../v0/enums/advertising_channel_type.proto | 77 + .../v0/enums/age_range_type.proto | 64 + .../v0/enums/asset_field_type.proto | 118 + .../v0/enums/attribution_model.proto | 70 + .../v0/enums/bidding_strategy_status.proto | 50 + .../bidding_strategy_system_status.proto | 139 + .../v0/enums/bidding_strategy_type.proto | 121 + .../v0/enums/budget_delivery_method.proto | 51 + .../searchads360/v0/enums/budget_period.proto | 53 + .../v0/enums/campaign_serving_status.proto | 59 + .../v0/enums/campaign_status.proto | 51 + .../v0/enums/conversion_action_category.proto | 117 + .../v0/enums/conversion_action_status.proto | 52 + .../v0/enums/conversion_action_type.proto | 173 + .../conversion_tracking_status_enum.proto | 56 + .../v0/enums/criterion_type.proto | 147 + .../v0/enums/custom_column_value_type.proto | 54 + .../v0/enums/customer_status.proto | 56 + .../v0/enums/data_driven_model_status.proto | 60 + .../searchads360/v0/enums/day_of_week.proto | 63 + google/ads/searchads360/v0/enums/device.proto | 57 + .../searchads360/v0/enums/gender_type.proto | 51 + .../v0/enums/interaction_event_type.proto | 60 + .../v0/enums/keyword_match_type.proto | 51 + .../v0/enums/listing_group_type.proto | 50 + .../enums/location_group_radius_units.proto | 51 + .../v0/enums/manager_link_status.proto | 57 + .../v0/enums/negative_geo_target_type.proto | 50 + .../v0/enums/optimization_goal_type.proto | 56 + .../v0/enums/positive_geo_target_type.proto | 56 + .../v0/enums/quality_score_bucket.proto | 51 + .../enums/search_ads360_field_category.proto | 59 + .../enums/search_ads360_field_data_type.proto | 100 + .../v0/enums/summary_row_setting.proto | 52 + .../target_impression_share_location.proto | 53 + .../v0/enums/webpage_condition_operand.proto | 57 + .../v0/enums/webpage_condition_operator.proto | 49 + .../ads/searchads360/v0/resources/BUILD.bazel | 103 + .../searchads360/v0/resources/ad_group.proto | 79 + .../v0/resources/ad_group_bid_modifier.proto | 55 + .../v0/resources/ad_group_criterion.proto | 139 + .../v0/resources/bidding_strategy.proto | 146 + .../searchads360/v0/resources/campaign.proto | 363 + .../v0/resources/campaign_budget.proto | 66 + .../v0/resources/campaign_criterion.proto | 90 + .../v0/resources/conversion_action.proto | 164 + .../v0/resources/custom_column.proto | 80 + .../searchads360/v0/resources/customer.proto | 158 + .../v0/resources/customer_client.proto | 104 + .../v0/resources/customer_manager_link.proto | 64 + .../v0/resources/keyword_view.proto | 50 + .../v0/resources/product_group_view.proto | 50 + .../v0/resources/search_ads360_field.proto | 107 + .../v0/searchads360_grpc_service_config.json | 27 + .../ads/searchads360/v0/searchads360_v0.yaml | 56 + .../ads/searchads360/v0/services/BUILD.bazel | 111 + .../v0/services/custom_column_service.proto | 79 + .../search_ads360_field_service.proto | 115 + .../v0/services/search_ads360_service.proto | 254 + google/analytics/admin/v1alpha/BUILD.bazel | 9 + google/analytics/admin/v1beta/BUILD.bazel | 9 + google/analytics/data/v1alpha/BUILD.bazel | 133 +- google/analytics/data/v1beta/BUILD.bazel | 42 +- .../data/v1beta/analytics_data_api.proto | 28 +- .../analytics_data_grpc_service_config.json | 10 +- google/analytics/data/v1beta/data.proto | 60 +- google/api/BUILD.bazel | 8 +- google/api/apikeys/v2/BUILD.bazel | 13 +- google/api/auth.proto | 12 +- google/api/backend.proto | 5 +- google/api/client.proto | 250 + google/api/control.proto | 14 +- google/api/documentation.proto | 26 +- google/api/endpoint.proto | 23 +- google/api/error_reason.proto | 138 + google/api/expr/v1alpha1/syntax.proto | 8 + google/api/launch_stage.proto | 6 +- google/api/metric.proto | 34 +- google/api/monitored_resource.proto | 11 +- google/api/quota.proto | 12 +- google/api/service.proto | 48 +- google/api/serviceconfig.yaml | 1 + google/api/servicecontrol/v1/BUILD.bazel | 133 +- google/api/servicecontrol/v2/BUILD.bazel | 133 +- google/api/servicemanagement/v1/BUILD.bazel | 137 +- google/api/serviceusage/v1/BUILD.bazel | 121 +- google/api/serviceusage/v1beta1/BUILD.bazel | 124 +- google/api/visibility.proto | 20 +- google/appengine/logging/v1/BUILD.bazel | 1 + google/appengine/v1/BUILD.bazel | 137 +- google/apps/alertcenter/v1beta1/BUILD.bazel | 122 +- google/apps/drive/activity/v2/BUILD.bazel | 16 +- google/apps/drive/labels/v2/BUILD.bazel | 393 + google/apps/drive/labels/v2/common.proto | 151 + .../apps/drive/labels/v2/drivelabels_v2.yaml | 17 + .../drivelabels_v2_grpc_service_config.json | 16 + .../apps/drive/labels/v2/error_details.proto | 138 + .../drive/labels/v2/exception_detail.proto | 117 + google/apps/drive/labels/v2/field.proto | 382 + google/apps/drive/labels/v2/label.proto | 224 + .../drive/labels/v2/label_permission.proto | 55 + .../apps/drive/labels/v2/label_service.proto | 57 + google/apps/drive/labels/v2/requests.proto | 117 + google/apps/drive/labels/v2beta/BUILD.bazel | 398 + google/apps/drive/labels/v2beta/common.proto | 151 + .../labels/v2beta/drivelabels_v2beta.yaml | 15 + ...rivelabels_v2beta_grpc_service_config.json | 37 + .../drive/labels/v2beta/error_details.proto | 138 + .../labels/v2beta/exception_detail.proto | 117 + google/apps/drive/labels/v2beta/field.proto | 391 + google/apps/drive/labels/v2beta/label.proto | 224 + .../drive/labels/v2beta/label_limits.proto | 155 + .../apps/drive/labels/v2beta/label_lock.proto | 87 + .../labels/v2beta/label_permission.proto | 95 + .../drive/labels/v2beta/label_service.proto | 274 + .../apps/drive/labels/v2beta/requests.proto | 809 + .../labels/v2beta/user_capabilities.proto | 50 + google/apps/market/v2/BUILD.bazel | 122 +- google/apps/script/type/BUILD.bazel | 47 +- google/apps/script/type/calendar/BUILD.bazel | 41 +- google/apps/script/type/docs/BUILD.bazel | 41 +- google/apps/script/type/drive/BUILD.bazel | 40 +- google/apps/script/type/gmail/BUILD.bazel | 41 +- google/apps/script/type/sheets/BUILD.bazel | 41 +- google/apps/script/type/slides/BUILD.bazel | 41 +- google/area120/tables/v1alpha1/BUILD.bazel | 122 +- google/bigtable/admin/v2/BUILD.bazel | 140 +- google/bigtable/v2/BUILD.bazel | 133 +- google/bigtable/v2/bigtable.proto | 108 +- google/bigtable/v2/request_stats.proto | 56 +- google/chromeos/moblab/v1beta1/BUILD.bazel | 126 +- google/chromeos/uidetection/v1/BUILD.bazel | 133 +- google/cloud/accessapproval/v1/BUILD.bazel | 9 + google/cloud/aiplatform/v1/BUILD.bazel | 15 +- google/cloud/aiplatform/v1/aiplatform_v1.yaml | 10 +- .../cloud/aiplatform/v1/annotation_spec.proto | 2 +- google/cloud/aiplatform/v1/artifact.proto | 1 + .../aiplatform/v1/batch_prediction_job.proto | 11 +- google/cloud/aiplatform/v1/context.proto | 1 + google/cloud/aiplatform/v1/custom_job.proto | 2 +- .../aiplatform/v1/data_labeling_job.proto | 2 +- google/cloud/aiplatform/v1/dataset.proto | 20 +- .../cloud/aiplatform/v1/dataset_service.proto | 136 + google/cloud/aiplatform/v1/endpoint.proto | 2 +- google/cloud/aiplatform/v1/execution.proto | 1 + google/cloud/aiplatform/v1/featurestore.proto | 6 +- .../v1/featurestore_online_service.proto | 49 + .../aiplatform/v1/featurestore_service.proto | 10 +- .../v1/hyperparameter_tuning_job.proto | 2 +- google/cloud/aiplatform/v1/index.proto | 2 +- .../cloud/aiplatform/v1/index_endpoint.proto | 2 +- google/cloud/aiplatform/v1/job_service.proto | 2 +- .../aiplatform/v1/metadata_service.proto | 13 +- google/cloud/aiplatform/v1/model.proto | 11 +- .../v1/model_deployment_monitoring_job.proto | 2 +- .../cloud/aiplatform/v1/model_service.proto | 9 + google/cloud/aiplatform/v1/operation.proto | 2 +- google/cloud/aiplatform/v1/pipeline_job.proto | 21 +- .../v1/schema/predict/instance/BUILD.bazel | 1 + .../v1/schema/predict/params/BUILD.bazel | 1 + .../v1/schema/predict/prediction/BUILD.bazel | 1 + .../schema/trainingjob/definition/BUILD.bazel | 1 + .../cloud/aiplatform/v1/specialist_pool.proto | 2 +- google/cloud/aiplatform/v1/tensorboard.proto | 2 +- .../aiplatform/v1/tensorboard_service.proto | 8 +- .../aiplatform/v1/training_pipeline.proto | 3 + .../aiplatform/v1/user_action_reference.proto | 4 +- google/cloud/aiplatform/v1beta1/BUILD.bazel | 15 +- .../aiplatform/v1beta1/accelerator_type.proto | 3 + .../v1beta1/aiplatform_v1beta1.yaml | 10 + .../aiplatform/v1beta1/annotation_spec.proto | 2 +- .../cloud/aiplatform/v1beta1/artifact.proto | 1 + .../v1beta1/batch_prediction_job.proto | 93 +- google/cloud/aiplatform/v1beta1/context.proto | 1 + .../cloud/aiplatform/v1beta1/custom_job.proto | 2 +- .../v1beta1/data_labeling_job.proto | 2 +- google/cloud/aiplatform/v1beta1/dataset.proto | 20 +- .../aiplatform/v1beta1/dataset_service.proto | 136 + .../v1beta1/deployment_resource_pool.proto | 2 +- .../deployment_resource_pool_service.proto | 17 +- .../cloud/aiplatform/v1beta1/endpoint.proto | 4 +- .../aiplatform/v1beta1/entity_type.proto | 7 + .../cloud/aiplatform/v1beta1/execution.proto | 1 + .../aiplatform/v1beta1/featurestore.proto | 15 +- .../v1beta1/featurestore_service.proto | 17 +- .../v1beta1/hyperparameter_tuning_job.proto | 2 +- google/cloud/aiplatform/v1beta1/index.proto | 2 +- .../aiplatform/v1beta1/index_endpoint.proto | 2 +- .../aiplatform/v1beta1/job_service.proto | 2 +- .../aiplatform/v1beta1/metadata_service.proto | 13 +- google/cloud/aiplatform/v1beta1/model.proto | 11 +- .../model_deployment_monitoring_job.proto | 2 +- .../aiplatform/v1beta1/model_service.proto | 9 + .../cloud/aiplatform/v1beta1/operation.proto | 2 +- .../aiplatform/v1beta1/pipeline_job.proto | 21 +- .../schema/predict/instance/BUILD.bazel | 1 + .../v1beta1/schema/predict/params/BUILD.bazel | 1 + .../schema/predict/prediction/BUILD.bazel | 1 + .../schema/trainingjob/definition/BUILD.bazel | 1 + .../aiplatform/v1beta1/specialist_pool.proto | 2 +- .../aiplatform/v1beta1/tensorboard.proto | 2 +- .../v1beta1/tensorboard_service.proto | 8 +- .../v1beta1/training_pipeline.proto | 3 + .../v1beta1/user_action_reference.proto | 4 +- google/cloud/apigateway/v1/BUILD.bazel | 13 +- google/cloud/apigeeconnect/v1/BUILD.bazel | 9 + google/cloud/apigeeregistry/v1/BUILD.bazel | 13 +- google/cloud/asset/v1/BUILD.bazel | 13 +- google/cloud/asset/v1/asset_service.proto | 496 +- google/cloud/asset/v1/assets.proto | 152 +- google/cloud/asset/v1p1beta1/BUILD.bazel | 9 + google/cloud/asset/v1p2beta1/BUILD.bazel | 12 +- google/cloud/asset/v1p5beta1/BUILD.bazel | 8 + google/cloud/asset/v1p7beta1/BUILD.bazel | 125 +- google/cloud/assuredworkloads/v1/BUILD.bazel | 15 +- .../v1/assuredworkloads.proto | 546 +- .../v1/assuredworkloads_v1.yaml | 1 + .../assuredworkloads/v1beta1/BUILD.bazel | 13 +- google/cloud/audit/BUILD.bazel | 39 +- google/cloud/audit/audit_log.proto | 92 +- .../cloud/audit/bigquery_audit_metadata.proto | 691 +- google/cloud/automl/v1/BUILD.bazel | 13 +- google/cloud/automl/v1beta1/BUILD.bazel | 13 +- google/cloud/backupdr/logging/v1/BUILD.bazel | 177 + .../cloud/backupdr/logging/v1/eventlog.proto | 62 + google/cloud/baremetalsolution/v2/BUILD.bazel | 13 +- google/cloud/batch/v1/BUILD.bazel | 13 +- google/cloud/batch/v1/batch.proto | 5 +- google/cloud/batch/v1/batch_v1.yaml | 16 +- google/cloud/batch/v1/job.proto | 30 +- google/cloud/batch/v1/task.proto | 7 +- google/cloud/batch/v1/volume.proto | 42 +- google/cloud/batch/v1alpha/BUILD.bazel | 13 +- google/cloud/batch/v1alpha/batch.proto | 5 +- google/cloud/batch/v1alpha/batch_v1alpha.yaml | 16 +- google/cloud/batch/v1alpha/job.proto | 44 +- google/cloud/batch/v1alpha/task.proto | 7 +- google/cloud/batch/v1alpha/volume.proto | 46 +- .../beyondcorp/appconnections/v1/BUILD.bazel | 15 +- .../v1/app_connections_service.proto | 4 +- .../beyondcorp/appconnectors/v1/BUILD.bazel | 15 +- .../v1/app_connectors_service.proto | 4 +- .../beyondcorp/appgateways/v1/BUILD.bazel | 15 +- .../appgateways/v1/app_gateways_service.proto | 4 +- .../clientconnectorservices/v1/BUILD.bazel | 16 +- .../client_connector_services_service.proto | 4 +- .../beyondcorp/clientgateways/v1/BUILD.bazel | 15 +- .../v1/client_gateways_service.proto | 4 +- .../cloud/bigquery/analyticshub/BUILD.bazel | 39 + .../bigquery/analyticshub/v1/BUILD.bazel | 19 +- .../cloud/bigquery/connection/v1/BUILD.bazel | 9 + .../bigquery/connection/v1beta1/BUILD.bazel | 9 + .../bigquery/dataexchange/v1beta1/BUILD.bazel | 9 + .../bigquery/datapolicies/v1/BUILD.bazel | 391 + .../v1/bigquerydatapolicy_v1.yaml | 23 + .../datapolicies_v1_grpc_service_config.json | 50 + .../bigquery/datapolicies/v1/datapolicy.proto | 320 + .../bigquery/datapolicies/v1beta1/BUILD.bazel | 11 +- .../bigquery/datatransfer/v1/BUILD.bazel | 9 + .../v1/bigquerydatatransfer_v1.yaml | 1 + .../datatransfer/v1/datatransfer.proto | 144 +- .../bigquery/datatransfer/v1/transfer.proto | 6 +- google/cloud/bigquery/logging/v1/BUILD.bazel | 1 + .../cloud/bigquery/migration/v2/BUILD.bazel | 11 +- .../bigquery/migration/v2alpha/BUILD.bazel | 9 + .../cloud/bigquery/reservation/v1/BUILD.bazel | 9 + .../v1beta1/bigqueryreservation_gapic.yaml | 16 - ...gqueryreservation_grpc_service_config.json | 100 - .../v1beta1/bigqueryreservation_v1beta1.yaml | 30 - .../reservation/v1beta1/reservation.proto | 915 - google/cloud/bigquery/storage/v1/BUILD.bazel | 128 +- .../cloud/bigquery/storage/v1/storage.proto | 76 +- google/cloud/bigquery/storage/v1/stream.proto | 48 +- google/cloud/bigquery/storage/v1/table.proto | 3 +- .../bigquery/storage/v1beta1/BUILD.bazel | 137 +- .../bigquery/storage/v1beta2/BUILD.bazel | 11 + google/cloud/bigquery/v2/BUILD.bazel | 9 +- google/cloud/billing/budgets/v1/BUILD.bazel | 9 + .../cloud/billing/budgets/v1beta1/BUILD.bazel | 12 + google/cloud/billing/v1/BUILD.bazel | 38 +- google/cloud/billing/v1/cloud_billing.proto | 65 +- google/cloud/billing/v1/cloud_catalog.proto | 68 +- google/cloud/billing/v1/cloudbilling.yaml | 28 - google/cloud/billing/v1/cloudbilling_v1.yaml | 54 + .../cloud/binaryauthorization/v1/BUILD.bazel | 12 + .../binaryauthorization/v1beta1/BUILD.bazel | 12 + .../cloud/certificatemanager/v1/BUILD.bazel | 18 +- .../v1/certificate_issuance_config.proto | 200 + .../v1/certificate_manager.proto | 331 +- ...ertificatemanager_grpc_service_config.json | 4 + google/cloud/channel/BUILD.bazel | 2 +- google/cloud/channel/v1/BUILD.bazel | 16 +- .../channel/v1/channel_partner_links.proto | 25 +- google/cloud/channel/v1/cloudchannel_v1.yaml | 6 + google/cloud/channel/v1/common.proto | 2 +- google/cloud/channel/v1/customers.proto | 14 +- google/cloud/channel/v1/entitlements.proto | 68 +- google/cloud/channel/v1/offers.proto | 12 +- google/cloud/channel/v1/operations.proto | 5 +- google/cloud/channel/v1/products.proto | 2 +- google/cloud/channel/v1/reports_service.proto | 444 + google/cloud/channel/v1/repricing.proto | 89 +- google/cloud/channel/v1/service.proto | 806 +- .../cloud/channel/v1/subscriber_event.proto | 10 +- .../logging/v1/clouddms_platform_logs.proto | 120 +- google/cloud/clouddms/v1/BUILD.bazel | 16 +- .../consumer/procurement/v1alpha1/BUILD.bazel | 13 +- google/cloud/common/BUILD.bazel | 1 + google/cloud/compute/v1/compute.proto | 905 +- google/cloud/compute/v1/compute.v1.json | 121432 ++++++++------- google/cloud/compute/v1/compute_gapic.yaml | 16 +- .../v1/compute_grpc_service_config.json | 27 + google/cloud/connectors/v1/BUILD.bazel | 13 +- .../contactcenterinsights/v1/BUILD.bazel | 13 +- .../v1/contact_center_insights.proto | 169 + .../v1/contactcenterinsights_v1.yaml | 7 + .../contactcenterinsights/v1/resources.proto | 64 + google/cloud/contentwarehouse/v1/BUILD.bazel | 48 +- .../cloud/contentwarehouse/v1/document.proto | 12 - .../contentwarehouse/v1/document_schema.proto | 16 +- .../v1/document_schema_service.proto | 14 +- .../v1/document_service.proto | 8 +- .../v1/document_service_request.proto | 9 +- .../cloud/contentwarehouse/v1/filters.proto | 1 - .../contentwarehouse/v1/rule_engine.proto | 160 - .../contentwarehouse/v1/ruleset_service.proto | 12 +- .../v1/ruleset_service_request.proto | 37 - .../v1/synonymset_service.proto | 2 +- google/cloud/datacatalog/v1/BUILD.bazel | 12 +- google/cloud/datacatalog/v1/bigquery.proto | 1 + google/cloud/datacatalog/v1/datacatalog.proto | 34 +- .../cloud/datacatalog/v1/datacatalog_v1.yaml | 2 + google/cloud/datacatalog/v1/usage.proto | 5 +- google/cloud/datacatalog/v1beta1/BUILD.bazel | 10 + google/cloud/dataform/BUILD.bazel | 38 + google/cloud/dataform/v1alpha2/BUILD.bazel | 11 +- google/cloud/dataform/v1beta1/BUILD.bazel | 18 +- google/cloud/datafusion/v1/BUILD.bazel | 13 +- google/cloud/datafusion/v1beta1/BUILD.bazel | 13 +- google/cloud/datalabeling/v1beta1/BUILD.bazel | 16 +- google/cloud/dataplex/v1/BUILD.bazel | 19 +- google/cloud/dataplex/v1/analyze.proto | 84 +- google/cloud/dataplex/v1/content.proto | 31 +- google/cloud/dataplex/v1/logs.proto | 20 +- google/cloud/dataplex/v1/metadata.proto | 167 +- google/cloud/dataplex/v1/resources.proto | 218 +- google/cloud/dataplex/v1/service.proto | 256 +- google/cloud/dataplex/v1/tasks.proto | 120 +- google/cloud/dataproc/BUILD.bazel | 2 +- google/cloud/dataproc/v1/BUILD.bazel | 16 +- google/cloud/dataproc/v1/clusters.proto | 304 +- google/cloud/dataproc/v1/dataproc_v1.yaml | 6 + google/cloud/dataproc/v1/jobs.proto | 93 +- google/cloud/dataproc/v1/node_groups.proto | 174 + google/cloud/dataproc/v1/operations.proto | 54 +- google/cloud/dataqna/v1alpha/BUILD.bazel | 14 +- google/cloud/datastream/v1/BUILD.bazel | 13 +- google/cloud/datastream/v1alpha1/BUILD.bazel | 13 +- google/cloud/deploy/v1/BUILD.bazel | 20 +- google/cloud/dialogflow/cx/v3/BUILD.bazel | 37 +- .../dialogflow/cx/v3/advanced_settings.proto | 1 + .../dialogflow/cx/v3/security_settings.proto | 23 +- .../cloud/dialogflow/cx/v3beta1/BUILD.bazel | 36 +- .../cx/v3beta1/advanced_settings.proto | 1 + .../cx/v3beta1/security_settings.proto | 19 +- google/cloud/dialogflow/v2/BUILD.bazel | 16 +- google/cloud/dialogflow/v2/audio_config.proto | 70 + .../dialogflow/v2/conversation_dataset.proto | 7 +- .../dialogflow/v2/conversation_profile.proto | 6 +- .../v2/dialogflow_grpc_service_config.json | 3 + google/cloud/dialogflow/v2/dialogflow_v2.yaml | 2 + google/cloud/dialogflow/v2/participant.proto | 226 + google/cloud/dialogflow/v2/session.proto | 4 +- google/cloud/dialogflow/v2beta1/BUILD.bazel | 16 +- .../dialogflow/v2beta1/audio_config.proto | 58 +- .../dialogflow/v2beta1/conversation.proto | 81 + .../dialogflow_grpc_service_config.json | 12 + .../dialogflow/v2beta1/participant.proto | 12 +- google/cloud/dialogflow/v2beta1/session.proto | 4 +- .../cloud/discoveryengine/v1beta/BUILD.bazel | 18 +- .../v1beta/discoveryengine_v1beta.yaml | 5 +- .../v1beta/import_config.proto | 8 +- .../v1beta/recommendation_service.proto | 19 + .../discoveryengine/v1beta/user_event.proto | 12 +- google/cloud/documentai/v1/BUILD.bazel | 19 +- google/cloud/documentai/v1/barcode.proto | 56 +- google/cloud/documentai/v1/document.proto | 281 +- google/cloud/documentai/v1/document_io.proto | 23 +- .../v1/document_processor_service.proto | 128 +- .../cloud/documentai/v1/document_schema.proto | 9 +- google/cloud/documentai/v1/processor.proto | 28 +- .../cloud/documentai/v1/processor_type.proto | 7 +- google/cloud/documentai/v1beta1/BUILD.bazel | 16 +- google/cloud/documentai/v1beta2/BUILD.bazel | 16 +- google/cloud/documentai/v1beta3/BUILD.bazel | 14 +- google/cloud/documentai/v1beta3/barcode.proto | 56 +- .../cloud/documentai/v1beta3/document.proto | 293 +- .../documentai/v1beta3/document_io.proto | 30 +- .../v1beta3/document_processor_service.proto | 342 +- .../documentai/v1beta3/document_schema.proto | 9 +- .../v1beta3/documentai_v1beta3.yaml | 4 + .../cloud/documentai/v1beta3/evaluation.proto | 164 + .../cloud/documentai/v1beta3/processor.proto | 28 +- .../documentai/v1beta3/processor_type.proto | 7 +- google/cloud/domains/v1/BUILD.bazel | 13 +- google/cloud/domains/v1alpha2/BUILD.bazel | 13 +- google/cloud/domains/v1beta1/BUILD.bazel | 13 +- google/cloud/edgecontainer/v1/BUILD.bazel | 13 +- .../v1/edgecontainer_grpc_service_config.json | 1 + google/cloud/edgecontainer/v1/resources.proto | 28 +- .../enterpriseknowledgegraph/v1/BUILD.bazel | 130 + .../v1/job_state.proto | 3 + .../v1/operation_metadata.proto | 3 + .../enterpriseknowledgegraph/v1/service.proto | 216 +- google/cloud/essentialcontacts/v1/BUILD.bazel | 9 + .../cloud/eventarc/publishing/v1/BUILD.bazel | 148 +- .../eventarc/publishing/v1/publisher.proto | 36 +- google/cloud/eventarc/v1/BUILD.bazel | 26 +- google/cloud/eventarc/v1/channel.proto | 43 +- .../eventarc/v1/channel_connection.proto | 6 +- google/cloud/eventarc/v1/eventarc.proto | 56 +- google/cloud/eventarc/v1/eventarc_v1.yaml | 9 + .../eventarc/v1/google_channel_config.proto | 65 + google/cloud/eventarc/v1/trigger.proto | 28 +- .../v1beta1/file_grpc_service_config.json | 48 + google/cloud/filestore/v1/BUILD.bazel | 13 +- google/cloud/filestore/v1beta1/BUILD.bazel | 13 +- .../v1beta1/cloud_filestore_service.proto | 528 +- .../cloud/filestore/v1beta1/file_gapic.yaml | 59 +- .../cloud/filestore/v1beta1/file_v1beta1.yaml | 2 + google/cloud/functions/v1/BUILD.bazel | 13 +- google/cloud/functions/v2/BUILD.bazel | 13 +- google/cloud/functions/v2alpha/BUILD.bazel | 137 +- google/cloud/functions/v2beta/BUILD.bazel | 137 +- google/cloud/gaming/v1/BUILD.bazel | 13 +- google/cloud/gaming/v1beta/BUILD.bazel | 13 +- google/cloud/gkebackup/v1/BUILD.bazel | 13 +- .../gkeconnect/gateway/v1beta1/BUILD.bazel | 12 + google/cloud/gkehub/v1/BUILD.bazel | 13 +- .../gkehub/v1/configmanagement/BUILD.bazel | 1 + .../gkehub/v1/multiclusteringress/BUILD.bazel | 1 + google/cloud/gkehub/v1alpha/BUILD.bazel | 13 +- .../v1alpha/cloudauditlogging/BUILD.bazel | 1 + .../v1alpha/configmanagement/BUILD.bazel | 1 + .../cloud/gkehub/v1alpha/metering/BUILD.bazel | 1 + .../v1alpha/multiclusteringress/BUILD.bazel | 1 + .../gkehub/v1alpha/servicemesh/BUILD.bazel | 1 + google/cloud/gkehub/v1alpha2/BUILD.bazel | 13 +- google/cloud/gkehub/v1beta/BUILD.bazel | 13 +- .../v1beta/configmanagement/BUILD.bazel | 1 + .../cloud/gkehub/v1beta/metering/BUILD.bazel | 1 + .../v1beta/multiclusteringress/BUILD.bazel | 1 + google/cloud/gkehub/v1beta1/BUILD.bazel | 13 +- google/cloud/gkemulticloud/v1/BUILD.bazel | 17 +- google/cloud/gsuiteaddons/v1/BUILD.bazel | 30 +- google/cloud/iap/v1/BUILD.bazel | 9 + google/cloud/iap/v1beta1/BUILD.bazel | 9 + google/cloud/identitytoolkit/v2/BUILD.bazel | 9 + .../v2/account_management_service.proto | 5 +- .../v2/authentication_service.proto | 4 +- .../cloud/identitytoolkit/v2/mfa_info.proto | 2 +- google/cloud/ids/v1/BUILD.bazel | 13 +- google/cloud/iot/v1/BUILD.bazel | 9 + google/cloud/kms/v1/BUILD.bazel | 15 +- google/cloud/kms/v1/cloudkms_v1.yaml | 6 + google/cloud/kms/v1/ekm_service.proto | 27 +- google/cloud/kms/v1/resources.proto | 45 +- google/cloud/kms/v1/service.proto | 87 +- google/cloud/language/v1/BUILD.bazel | 16 +- google/cloud/language/v1beta2/BUILD.bazel | 11 +- google/cloud/lifesciences/v2beta/BUILD.bazel | 48 +- .../v2beta/lifesciences_v2beta.yaml | 2 + .../cloud/lifesciences/v2beta/workflows.proto | 28 +- google/cloud/location/BUILD.bazel | 2 + google/cloud/managedidentities/v1/BUILD.bazel | 17 +- .../managedidentities/v1beta1/BUILD.bazel | 17 +- .../mediatranslation/v1beta1/BUILD.bazel | 10 + google/cloud/memcache/v1/BUILD.bazel | 43 +- google/cloud/memcache/v1/cloud_memcache.proto | 225 +- .../v1/memcache_grpc_service_config.json | 8 + google/cloud/memcache/v1/memcache_v1.yaml | 62 +- google/cloud/memcache/v1beta2/BUILD.bazel | 60 +- .../memcache/v1beta2/cloud_memcache.proto | 176 +- .../v1beta2/memcache_grpc_service_config.json | 4 + .../memcache/v1beta2/memcache_v1beta2.yaml | 35 +- google/cloud/metastore/BUILD.bazel | 2 +- google/cloud/metastore/v1/BUILD.bazel | 19 +- google/cloud/metastore/v1/metastore.proto | 132 +- .../metastore/v1/metastore_federation.proto | 361 + google/cloud/metastore/v1/metastore_v1.yaml | 16 + google/cloud/metastore/v1alpha/BUILD.bazel | 19 +- .../cloud/metastore/v1alpha/metastore.proto | 445 +- .../v1alpha/metastore_federation.proto | 364 + .../metastore/v1alpha/metastore_v1alpha.yaml | 15 + google/cloud/metastore/v1beta/BUILD.bazel | 20 +- google/cloud/metastore/v1beta/metastore.proto | 241 +- .../v1beta/metastore_federation.proto | 364 + .../metastore/v1beta/metastore_v1beta.yaml | 33 + google/cloud/networkconnectivity/BUILD.bazel | 2 +- .../cloud/networkconnectivity/v1/BUILD.bazel | 21 +- .../cloud/networkconnectivity/v1/common.proto | 9 + google/cloud/networkconnectivity/v1/hub.proto | 266 +- .../v1/networkconnectivity_v1.yaml | 29 +- ...rkconnectivity_v1_grpc_service_config.json | 7 +- .../v1/policy_based_routing.proto | 338 + .../networkconnectivity/v1alpha1/BUILD.bazel | 16 +- google/cloud/networkmanagement/v1/BUILD.bazel | 13 +- .../networkmanagement/v1beta1/BUILD.bazel | 13 +- google/cloud/networksecurity/v1/BUILD.bazel | 128 +- .../cloud/networksecurity/v1beta1/BUILD.bazel | 15 +- google/cloud/networkservices/v1/BUILD.bazel | 15 +- .../cloud/networkservices/v1beta1/BUILD.bazel | 13 +- google/cloud/notebooks/v1/BUILD.bazel | 40 +- .../notebooks/v1/diagnostic_config.proto | 60 + .../cloud/notebooks/v1/managed_service.proto | 102 + .../v1/notebooks_grpc_service_config.json | 5 +- google/cloud/notebooks/v1/notebooks_v1.yaml | 3 + google/cloud/notebooks/v1/runtime.proto | 28 +- google/cloud/notebooks/v1/service.proto | 29 + google/cloud/notebooks/v1beta1/BUILD.bazel | 59 +- .../cloud/notebooks/v1beta1/environment.proto | 8 +- google/cloud/notebooks/v1beta1/instance.proto | 156 +- .../notebooks/v1beta1/notebooks_v1beta1.yaml | 29 +- google/cloud/notebooks/v1beta1/service.proto | 86 +- google/cloud/optimization/v1/BUILD.bazel | 13 +- .../cloud/optimization/v1/fleet_routing.proto | 305 +- .../airflow/service/v1/BUILD.bazel | 13 +- .../airflow/service/v1/composer_v1.yaml | 3 + .../airflow/service/v1/environments.proto | 459 +- .../airflow/service/v1/image_versions.proto | 4 +- .../airflow/service/v1/operations.proto | 8 +- .../airflow/service/v1beta1/BUILD.bazel | 13 +- .../service/v1beta1/composer_v1beta1.yaml | 5 + .../service/v1beta1/environments.proto | 427 +- .../service/v1beta1/image_versions.proto | 4 +- .../airflow/service/v1beta1/operations.proto | 8 +- google/cloud/orgpolicy/v2/BUILD.bazel | 12 + .../osconfig/agentendpoint/v1/BUILD.bazel | 9 + .../osconfig/agentendpoint/v1beta/BUILD.bazel | 9 + google/cloud/osconfig/logging/BUILD.bazel | 177 + .../osconfig/logging/patch_job_log.proto | 126 + google/cloud/osconfig/v1/BUILD.bazel | 13 +- google/cloud/osconfig/v1alpha/BUILD.bazel | 13 +- google/cloud/osconfig/v1beta/BUILD.bazel | 9 + google/cloud/oslogin/common/BUILD.bazel | 2 + google/cloud/oslogin/common/common.proto | 5 +- google/cloud/oslogin/v1/BUILD.bazel | 12 + google/cloud/oslogin/v1/oslogin.proto | 33 +- google/cloud/oslogin/v1/oslogin_v1.yaml | 7 + google/cloud/oslogin/v1beta/BUILD.bazel | 9 + google/cloud/oslogin/v1beta/oslogin.proto | 86 +- .../cloud/oslogin/v1beta/oslogin_v1beta.yaml | 7 + .../issuerswitch/v1/BUILD.bazel | 24 +- .../issuerswitch/v1/common_fields.proto | 414 +- .../issuerswitch/v1/issuerswitch_v1.yaml | 3 +- .../paymentgateway/issuerswitch/v1/logs.proto | 89 + .../issuerswitch/v1/transactions.proto | 585 +- .../phishingprotection/v1beta1/BUILD.bazel | 12 + .../cloud/policytroubleshooter/v1/BUILD.bazel | 9 + .../cloud/privatecatalog/v1beta1/BUILD.bazel | 13 +- google/cloud/pubsublite/v1/BUILD.bazel | 12 +- google/cloud/pubsublite/v1/admin.proto | 2 +- google/cloud/pubsublite/v1/common.proto | 29 +- google/cloud/pubsublite/v1/cursor.proto | 2 +- google/cloud/pubsublite/v1/publisher.proto | 5 +- google/cloud/pubsublite/v1/subscriber.proto | 5 +- google/cloud/pubsublite/v1/topic_stats.proto | 4 +- .../cloud/recaptchaenterprise/v1/BUILD.bazel | 12 + .../v1/recaptchaenterprise.proto | 289 +- .../v1/recaptchaenterprise_v1.yaml | 9 + .../recaptchaenterprise/v1beta1/BUILD.bazel | 9 + .../recommendationengine/v1beta1/BUILD.bazel | 14 +- .../v1beta1/catalog_service.proto | 2 +- google/cloud/recommender/v1/BUILD.bazel | 9 + google/cloud/recommender/v1beta1/BUILD.bazel | 9 + google/cloud/redis/v1/BUILD.bazel | 13 +- google/cloud/redis/v1beta1/BUILD.bazel | 13 +- google/cloud/resourcemanager/v3/BUILD.bazel | 16 +- google/cloud/resourcesettings/v1/BUILD.bazel | 9 + google/cloud/retail/logging/error_log.proto | 6 +- google/cloud/retail/v2/BUILD.bazel | 15 +- google/cloud/retail/v2/catalog.proto | 64 +- google/cloud/retail/v2/catalog_service.proto | 2 +- google/cloud/retail/v2/common.proto | 8 +- .../cloud/retail/v2/completion_service.proto | 12 +- google/cloud/retail/v2/control.proto | 5 +- .../cloud/retail/v2/prediction_service.proto | 16 +- google/cloud/retail/v2/product.proto | 34 +- google/cloud/retail/v2/product_service.proto | 86 +- google/cloud/retail/v2/retail_v2.yaml | 4 + google/cloud/retail/v2/search_service.proto | 27 +- google/cloud/retail/v2/serving_config.proto | 47 +- .../retail/v2/serving_config_service.proto | 10 +- google/cloud/retail/v2/user_event.proto | 2 +- .../cloud/retail/v2/user_event_service.proto | 53 +- google/cloud/retail/v2alpha/BUILD.bazel | 16 +- google/cloud/retail/v2alpha/catalog.proto | 89 +- .../retail/v2alpha/catalog_service.proto | 51 +- google/cloud/retail/v2alpha/common.proto | 15 +- .../retail/v2alpha/completion_service.proto | 33 +- google/cloud/retail/v2alpha/control.proto | 40 +- .../retail/v2alpha/control_service.proto | 7 +- .../cloud/retail/v2alpha/export_config.proto | 18 +- .../cloud/retail/v2alpha/import_config.proto | 69 +- google/cloud/retail/v2alpha/model.proto | 95 +- .../cloud/retail/v2alpha/model_service.proto | 47 +- .../retail/v2alpha/prediction_service.proto | 26 +- google/cloud/retail/v2alpha/product.proto | 40 +- .../retail/v2alpha/product_service.proto | 71 +- .../cloud/retail/v2alpha/retail_v2alpha.yaml | 5 + .../cloud/retail/v2alpha/search_service.proto | 55 +- .../cloud/retail/v2alpha/serving_config.proto | 68 +- .../v2alpha/serving_config_service.proto | 10 +- google/cloud/retail/v2alpha/user_event.proto | 2 +- .../retail/v2alpha/user_event_service.proto | 57 +- google/cloud/retail/v2beta/BUILD.bazel | 16 +- google/cloud/retail/v2beta/catalog.proto | 67 +- .../cloud/retail/v2beta/catalog_service.proto | 15 +- google/cloud/retail/v2beta/common.proto | 3 +- .../retail/v2beta/completion_service.proto | 6 +- google/cloud/retail/v2beta/control.proto | 4 +- .../cloud/retail/v2beta/export_config.proto | 14 +- google/cloud/retail/v2beta/model.proto | 3 +- .../retail/v2beta/prediction_service.proto | 15 +- google/cloud/retail/v2beta/product.proto | 25 +- .../v2beta/retail_grpc_service_config.json | 11 + google/cloud/retail/v2beta/retail_v2beta.yaml | 10 + .../cloud/retail/v2beta/search_service.proto | 4 +- .../retail/v2beta/user_event_service.proto | 20 + google/cloud/run/BUILD.bazel | 2 +- google/cloud/run/v2/BUILD.bazel | 32 +- google/cloud/run/v2/condition.proto | 5 +- google/cloud/run/v2/execution.proto | 256 + google/cloud/run/v2/execution_template.proto | 54 + google/cloud/run/v2/job.proto | 405 + google/cloud/run/v2/k8s.min.proto | 113 +- google/cloud/run/v2/revision.proto | 4 +- google/cloud/run/v2/run_v2.yaml | 54 + google/cloud/run/v2/service.proto | 23 +- google/cloud/run/v2/task.proto | 256 + google/cloud/run/v2/task_template.proto | 68 + google/cloud/run/v2/vendor_settings.proto | 3 +- google/cloud/scheduler/v1/BUILD.bazel | 35 +- google/cloud/scheduler/v1beta1/BUILD.bazel | 57 +- .../scheduler/v1beta1/cloudscheduler.proto | 114 +- .../v1beta1/cloudscheduler_v1beta1.yaml | 26 + google/cloud/scheduler/v1beta1/job.proto | 100 +- google/cloud/scheduler/v1beta1/target.proto | 112 +- google/cloud/secretmanager/v1/BUILD.bazel | 9 + google/cloud/secretmanager/v1/resources.proto | 333 +- google/cloud/secrets/v1beta1/BUILD.bazel | 9 + .../cloud/security/privateca/v1/BUILD.bazel | 13 +- .../security/privateca/v1beta1/BUILD.bazel | 13 +- .../security/publicca/v1beta1/BUILD.bazel | 21 +- .../settings/v1beta1/BUILD.bazel | 125 +- google/cloud/securitycenter/v1/BUILD.bazel | 14 +- google/cloud/securitycenter/v1/access.proto | 13 +- .../securitycenter/v1/external_system.proto | 9 +- google/cloud/securitycenter/v1/finding.proto | 10 +- .../securitycenter/v1/kernel_rootkit.proto | 62 + .../securitycenter/v1/mitre_attack.proto | 3 + .../v1/notification_config.proto | 6 +- .../v1/securitycenter_service.proto | 315 +- .../cloud/securitycenter/v1beta1/BUILD.bazel | 13 +- .../securitycenter/v1p1beta1/BUILD.bazel | 13 +- google/cloud/servicedirectory/v1/BUILD.bazel | 9 + .../servicedirectory/v1beta1/BUILD.bazel | 9 + google/cloud/shell/v1/BUILD.bazel | 13 +- google/cloud/shell/v1/cloudshell.proto | 6 +- google/cloud/shell/v1/cloudshell_v1.yaml | 12 +- google/cloud/speech/v1/BUILD.bazel | 13 +- google/cloud/speech/v1/cloud_speech.proto | 35 +- google/cloud/speech/v1/speech_v1.yaml | 1 + google/cloud/speech/v1p1beta1/BUILD.bazel | 13 +- .../cloud/speech/v1p1beta1/cloud_speech.proto | 35 +- .../speech/v1p1beta1/speech_v1p1beta1.yaml | 1 + google/cloud/speech/v2/BUILD.bazel | 353 + google/cloud/sql/v1/BUILD.bazel | 7 + google/cloud/sql/v1beta4/BUILD.bazel | 7 + google/cloud/storageinsights/v1/BUILD.bazel | 397 + .../storageinsights/v1/storageinsights.proto | 477 + .../storageinsights_grpc_service_config.json | 26 + .../v1/storageinsights_v1.yaml | 66 + google/cloud/talent/v4/BUILD.bazel | 13 +- google/cloud/talent/v4/company.proto | 5 +- google/cloud/talent/v4/job_service.proto | 4 +- google/cloud/talent/v4beta1/BUILD.bazel | 13 +- google/cloud/talent/v4beta1/company.proto | 5 +- google/cloud/talent/v4beta1/job_service.proto | 4 +- google/cloud/tasks/v2/BUILD.bazel | 9 + google/cloud/tasks/v2beta2/BUILD.bazel | 9 + google/cloud/tasks/v2beta3/BUILD.bazel | 9 + google/cloud/texttospeech/BUILD.bazel | 2 +- google/cloud/texttospeech/v1/BUILD.bazel | 22 + google/cloud/texttospeech/v1/cloud_tts.proto | 28 +- .../cloud/texttospeech/v1/cloud_tts_lrs.proto | 90 + .../v1/texttospeech_grpc_service_config.json | 9 + .../texttospeech/v1/texttospeech_v1.yaml | 10 + google/cloud/texttospeech/v1beta1/BUILD.bazel | 40 +- .../texttospeech/v1beta1/cloud_tts.proto | 38 +- .../texttospeech/v1beta1/cloud_tts_lrs.proto | 90 + .../texttospeech_grpc_service_config.json | 9 + .../v1beta1/texttospeech_v1beta1.yaml | 10 + .../cloud/timeseriesinsights/v1/BUILD.bazel | 13 +- .../v1/timeseries_insights.proto | 415 +- google/cloud/tpu/v1/BUILD.bazel | 33 +- google/cloud/tpu/v1/cloud_tpu.proto | 11 +- google/cloud/tpu/v1/tpu_v1.yaml | 2 + .../v1beta1 => tpu/v2}/BUILD.bazel | 258 +- google/cloud/tpu/v2/cloud_tpu.proto | 795 + .../cloud/tpu/v2/tpu_grpc_service_config.json | 8 + google/cloud/tpu/v2/tpu_v2.yaml | 90 + google/cloud/tpu/v2alpha1/BUILD.bazel | 60 +- google/cloud/tpu/v2alpha1/cloud_tpu.proto | 467 +- .../v2alpha1/{tpu.yaml => tpu_v2alpha1.yaml} | 10 +- google/cloud/translate/v3/BUILD.bazel | 13 +- .../translate/v3/translation_service.proto | 2 +- google/cloud/translate/v3beta1/BUILD.bazel | 13 +- .../v3beta1/translation_service.proto | 2 +- .../cloudscheduler_grpc_service_config.json | 55 + google/cloud/video/livestream/v1/BUILD.bazel | 13 +- google/cloud/video/stitcher/v1/BUILD.bazel | 14 +- google/cloud/video/stitcher/v1/cdn_keys.proto | 12 + google/cloud/video/transcoder/v1/BUILD.bazel | 9 + .../cloud/video/transcoder/v1/resources.proto | 107 + .../video/transcoder/v1/transcoder_v1.yaml | 4 +- google/cloud/videointelligence/v1/BUILD.bazel | 13 +- .../videointelligence/v1beta2/BUILD.bazel | 13 +- .../videointelligence/v1p1beta1/BUILD.bazel | 13 +- .../videointelligence/v1p2beta1/BUILD.bazel | 13 +- .../videointelligence/v1p3beta1/BUILD.bazel | 14 +- google/cloud/vision/v1/BUILD.bazel | 13 +- google/cloud/vision/v1p1beta1/BUILD.bazel | 9 + google/cloud/vision/v1p2beta1/BUILD.bazel | 13 +- google/cloud/vision/v1p3beta1/BUILD.bazel | 13 +- google/cloud/vision/v1p4beta1/BUILD.bazel | 13 +- google/cloud/visionai/v1/BUILD.bazel | 428 + google/cloud/visionai/v1/annotations.proto | 659 + google/cloud/visionai/v1/common.proto | 114 + google/cloud/visionai/v1/lva.proto | 115 + google/cloud/visionai/v1/lva_resources.proto | 65 + google/cloud/visionai/v1/lva_service.proto | 227 + google/cloud/visionai/v1/platform.proto | 2222 + .../visionai/v1/streaming_resources.proto | 173 + .../cloud/visionai/v1/streaming_service.proto | 411 + .../cloud/visionai/v1/streams_resources.proto | 189 + .../cloud/visionai/v1/streams_service.proto | 913 + .../v1/visionai_grpc_service_config.json | 206 + google/cloud/visionai/v1/visionai_v1.yaml | 145 + google/cloud/visionai/v1/warehouse.proto | 1653 + google/cloud/visionai/v1alpha1/BUILD.bazel | 426 + .../cloud/visionai/v1alpha1/annotations.proto | 659 + google/cloud/visionai/v1alpha1/common.proto | 114 + google/cloud/visionai/v1alpha1/lva.proto | 115 + .../visionai/v1alpha1/lva_resources.proto | 65 + .../cloud/visionai/v1alpha1/lva_service.proto | 227 + google/cloud/visionai/v1alpha1/platform.proto | 2222 + .../v1alpha1/streaming_resources.proto | 173 + .../visionai/v1alpha1/streaming_service.proto | 411 + .../visionai/v1alpha1/streams_resources.proto | 189 + .../visionai/v1alpha1/streams_service.proto | 872 + .../visionai_grpc_service_config.json | 203 + .../visionai/v1alpha1/visionai_v1alpha1.yaml | 190 + .../cloud/visionai/v1alpha1/warehouse.proto | 1653 + google/cloud/vmmigration/v1/BUILD.bazel | 13 +- google/cloud/vmwareengine/BUILD.bazel | 39 + google/cloud/vmwareengine/v1/BUILD.bazel | 401 + .../cloud/vmwareengine/v1/vmwareengine.proto | 2194 + .../v1/vmwareengine_grpc_service_config.json | 82 + .../vmwareengine/v1/vmwareengine_v1.yaml | 117 + google/cloud/vpcaccess/v1/BUILD.bazel | 13 +- google/cloud/webrisk/v1/BUILD.bazel | 35 +- google/cloud/webrisk/v1/webrisk.proto | 89 +- .../v1/webrisk_grpc_service_config.json | 2 +- google/cloud/webrisk/v1beta1/BUILD.bazel | 55 +- .../cloud/websecurityscanner/v1/BUILD.bazel | 9 + .../websecurityscanner/v1alpha/BUILD.bazel | 9 + .../websecurityscanner/v1beta/BUILD.bazel | 9 + .../cloud/workflows/executions/v1/BUILD.bazel | 11 +- .../workflows/executions/v1beta/BUILD.bazel | 9 + google/cloud/workflows/v1/BUILD.bazel | 13 +- google/cloud/workflows/v1beta/BUILD.bazel | 13 +- google/container/v1/BUILD.bazel | 136 +- google/container/v1/cluster_service.proto | 181 +- google/container/v1/container_v1.yaml | 3 + google/container/v1beta1/BUILD.bazel | 136 +- .../container/v1beta1/cluster_service.proto | 119 +- .../container/v1beta1/container_v1beta1.yaml | 3 + google/dataflow/v1beta3/BUILD.bazel | 133 +- google/datastore/admin/v1/BUILD.bazel | 137 +- google/datastore/v1/BUILD.bazel | 42 +- google/datastore/v1/aggregation_result.proto | 61 + google/datastore/v1/datastore.proto | 48 + google/datastore/v1/query.proto | 87 + .../devtools/artifactregistry/v1/BUILD.bazel | 137 +- .../artifactregistry/v1beta2/BUILD.bazel | 126 +- google/devtools/build/v1/BUILD.bazel | 132 +- google/devtools/build/v1/build_events.proto | 5 +- google/devtools/build/v1/build_status.proto | 7 +- .../build/v1/publish_build_event.proto | 35 +- google/devtools/cloudbuild/v1/BUILD.bazel | 45 +- .../devtools/cloudbuild/v1/cloudbuild.proto | 111 + google/devtools/clouddebugger/v2/BUILD.bazel | 131 +- .../clouderrorreporting/v1beta1/BUILD.bazel | 123 +- google/devtools/cloudprofiler/v2/BUILD.bazel | 133 +- google/devtools/cloudtrace/v1/BUILD.bazel | 133 +- google/devtools/cloudtrace/v2/BUILD.bazel | 133 +- .../devtools/containeranalysis/v1/BUILD.bazel | 134 +- .../containeranalysis/v1beta1/BUILD.bazel | 4 + .../remoteworkers/v1test2/BUILD.bazel | 122 +- google/devtools/source/v1/BUILD.bazel | 99 +- google/devtools/testing/v1/BUILD.bazel | 99 +- google/example/library/v1/BUILD.bazel | 21 +- google/firestore/admin/v1/BUILD.bazel | 20 +- google/firestore/bundle/BUILD.bazel | 1 + google/firestore/v1/BUILD.bazel | 20 +- google/firestore/v1beta1/BUILD.bazel | 122 +- google/geo/type/BUILD.bazel | 24 +- google/home/enterprise/sdm/v1/BUILD.bazel | 122 +- google/home/graph/v1/BUILD.bazel | 120 +- google/iam/admin/v1/BUILD.bazel | 15 +- google/iam/credentials/v1/BUILD.bazel | 133 +- google/iam/v1/BUILD.bazel | 88 +- google/iam/v1/logging/BUILD.bazel | 1 + google/iam/v1beta/BUILD.bazel | 130 +- google/iam/v2/BUILD.bazel | 20 +- google/iam/v2beta/BUILD.bazel | 15 +- .../accesscontextmanager/v1/BUILD.bazel | 33 +- .../v1/access_context_manager.proto | 300 +- .../v1/access_level.proto | 2 +- .../v1/access_policy.proto | 18 +- .../v1/accesscontextmanager_v1.yaml | 1 + .../v1/gcp_user_access_binding.proto | 2 +- .../v1/service_perimeter.proto | 166 +- google/logging/v2/BUILD.bazel | 138 +- google/longrunning/BUILD.bazel | 39 + google/maps/addressvalidation/v1/BUILD.bazel | 24 +- .../maps/addressvalidation/v1/address.proto | 19 +- .../v1/address_validation_service.proto | 36 +- .../v1/addressvalidation_v1.yaml | 5 +- .../maps/addressvalidation/v1/geocode.proto | 7 +- .../maps/addressvalidation/v1/metadata.proto | 10 +- .../maps/addressvalidation/v1/usps_data.proto | 26 +- .../maps/fleetengine/delivery/v1/BUILD.bazel | 120 +- .../delivery/v1/delivery_api.proto | 5 + google/maps/fleetengine/v1/BUILD.bazel | 123 +- google/maps/fleetengine/v1/trip_api.proto | 15 +- google/maps/fleetengine/v1/trips.proto | 144 +- google/maps/fleetengine/v1/vehicle_api.proto | 115 +- .../mapsplatformdatasets/v1alpha/BUILD.bazel | 9 + google/maps/playablelocations/v3/BUILD.bazel | 108 +- google/maps/regionlookup/v1alpha/BUILD.bazel | 133 +- google/maps/roads/v1op/BUILD.bazel | 131 +- google/maps/routes/v1/BUILD.bazel | 101 +- google/maps/routespreferred/v1/BUILD.bazel | 46 +- google/maps/routing/v2/BUILD.bazel | 10 + google/maps/routing/v2/route.proto | 19 + google/maps/routing/v2/route_label.proto | 46 + .../maps/routing/v2/route_travel_mode.proto | 4 + google/maps/routing/v2/routes_service.proto | 78 +- .../routing/v2/vehicle_emission_type.proto | 3 + google/monitoring/dashboard/v1/BUILD.bazel | 142 +- google/monitoring/dashboard/v1/metrics.proto | 5 +- .../monitoring/dashboard/v1/monitoring.yaml | 8 +- .../monitoring/dashboard/v1/scorecard.proto | 9 +- .../dashboard/v1/table_display_options.proto | 9 +- google/monitoring/metricsscope/v1/BUILD.bazel | 142 +- google/monitoring/v3/BUILD.bazel | 138 +- google/partner/aistreams/v1alpha1/BUILD.bazel | 138 +- google/privacy/dlp/v2/BUILD.bazel | 133 +- google/privacy/dlp/v2/dlp.proto | 40 +- google/privacy/dlp/v2/storage.proto | 2 +- google/pubsub/v1/BUILD.bazel | 12 +- google/rpc/code.proto | 14 +- google/rpc/context/attribute_context.proto | 11 +- google/rpc/context/audit_context.proto | 49 + google/rpc/error_details.proto | 146 +- google/rpc/http.proto | 64 + google/rpc/status.proto | 8 +- google/spanner/admin/database/v1/BUILD.bazel | 137 +- google/spanner/admin/instance/v1/BUILD.bazel | 137 +- google/spanner/v1/BUILD.bazel | 133 +- google/spanner/v1/result_set.proto | 12 + google/spanner/v1/transaction.proto | 49 +- google/storage/v2/BUILD.bazel | 126 +- google/storage/v2/storage.proto | 416 +- google/storagetransfer/v1/BUILD.bazel | 137 +- google/streetview/publish/v1/BUILD.bazel | 20 +- grafeas/v1/BUILD.bazel | 23 +- grafeas/v1/cvss.proto | 7 + grafeas/v1/discovery.proto | 18 +- grafeas/v1/swagger/grafeas.swagger.json | 44 +- grafeas/v1/vulnerability.proto | 10 + 1735 files changed, 151228 insertions(+), 100285 deletions(-) rename google/ads/googleads/{v9 => v12}/BUILD.bazel (71%) rename google/ads/googleads/{v9 => v12}/common/BUILD.bazel (98%) rename google/ads/googleads/{v9 => v12}/common/ad_asset.proto (65%) rename google/ads/googleads/{v9 => v12}/common/ad_type_infos.proto (76%) rename google/ads/googleads/{v9 => v12}/common/asset_policy.proto (60%) create mode 100644 google/ads/googleads/v12/common/asset_set_types.proto create mode 100644 google/ads/googleads/v12/common/asset_types.proto create mode 100644 google/ads/googleads/v12/common/asset_usage.proto create mode 100644 google/ads/googleads/v12/common/audiences.proto rename google/ads/googleads/{v9 => v12}/common/bidding.proto (83%) rename google/ads/googleads/{v9 => v12}/common/click_location.proto (78%) rename google/ads/googleads/{v9 => v12}/common/criteria.proto (69%) rename google/ads/googleads/{v9 => v12}/common/criterion_category_availability.proto (69%) rename google/ads/googleads/{v9 => v12}/common/custom_parameter.proto (74%) rename google/ads/googleads/{v9 => v12}/common/customizer_value.proto (70%) rename google/ads/googleads/{v9 => v12}/common/dates.proto (70%) rename google/ads/googleads/{v9 => v12}/common/explorer_auto_optimizer_setting.proto (74%) rename google/ads/googleads/{v9 => v12}/common/extensions.proto (86%) rename google/ads/googleads/{v9 => v12}/common/feed_common.proto (73%) rename google/ads/googleads/{v9 => v12}/common/feed_item_set_filter_type_infos.proto (76%) rename google/ads/googleads/{v9 => v12}/common/final_app_url.proto (72%) rename google/ads/googleads/{v9 => v12}/common/frequency_cap.proto (56%) rename google/ads/googleads/{v9 => v12}/common/keyword_plan_common.proto (70%) rename google/ads/googleads/{v9 => v12}/common/matching_function.proto (84%) create mode 100644 google/ads/googleads/v12/common/metric_goal.proto rename google/ads/googleads/{v9 => v12}/common/metrics.proto (78%) rename google/ads/googleads/{v9 => v12}/common/offline_user_data.proto (80%) rename google/ads/googleads/{v9 => v12}/common/policy.proto (81%) rename google/ads/googleads/{v9 => v12}/common/policy_summary.proto (59%) rename google/ads/googleads/{v9 => v12}/common/real_time_bidding_setting.proto (73%) rename google/ads/googleads/{v9 => v12}/common/segments.proto (54%) rename google/ads/googleads/{v9 => v12}/common/simulation.proto (95%) rename google/ads/googleads/{v9 => v12}/common/tag_snippet.proto (64%) rename google/ads/googleads/{v9 => v12}/common/targeting_setting.proto (83%) rename google/ads/googleads/{v9 => v12}/common/text_label.proto (76%) rename google/ads/googleads/{v9 => v12}/common/url_collection.proto (76%) rename google/ads/googleads/{v9 => v12}/common/user_lists.proto (71%) rename google/ads/googleads/{v9 => v12}/common/value.proto (74%) rename google/ads/googleads/{v9 => v12}/enums/BUILD.bazel (100%) rename google/ads/googleads/{v9 => v12}/enums/access_invitation_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/access_reason.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/access_role.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/account_budget_proposal_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/account_budget_proposal_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/account_budget_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/account_link_status.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/ad_customizer_placeholder_field.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/ad_destination_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_ad_rotation_mode.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_ad_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_criterion_approval_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_criterion_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/ad_group_type.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/ad_network_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_serving_optimization_status.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/ad_strength.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/ad_type.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/advertising_channel_sub_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/advertising_channel_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/affiliate_location_feed_relationship_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/affiliate_location_placeholder_field.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/age_range_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/app_campaign_app_store.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/app_campaign_bidding_strategy_goal_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/app_payment_model_type.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/app_placeholder_field.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/app_store.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/app_url_operating_system_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/asset_field_type.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/asset_group_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/asset_link_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/asset_performance_label.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/asset_set_asset_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/asset_set_link_status.proto (74%) rename google/ads/googleads/{v9 => v12}/enums/asset_set_status.proto (77%) create mode 100644 google/ads/googleads/v12/enums/asset_set_type.proto rename google/ads/googleads/{v9/enums/asset_set_type.proto => v12/enums/asset_source.proto} (51%) rename google/ads/googleads/{v9 => v12}/enums/asset_type.proto (68%) create mode 100644 google/ads/googleads/v12/enums/async_action_status.proto rename google/ads/googleads/{v9 => v12}/enums/attribution_model.proto (86%) create mode 100644 google/ads/googleads/v12/enums/audience_insights_dimension.proto create mode 100644 google/ads/googleads/v12/enums/audience_status.proto rename google/ads/googleads/{v9 => v12}/enums/batch_job_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/bid_modifier_source.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/bidding_source.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/bidding_strategy_status.proto (77%) create mode 100644 google/ads/googleads/v12/enums/bidding_strategy_system_status.proto rename google/ads/googleads/{v9 => v12}/enums/bidding_strategy_type.proto (89%) rename google/ads/googleads/{v9 => v12}/enums/billing_setup_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/brand_safety_suitability.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/budget_campaign_association_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/budget_delivery_method.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/budget_period.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/budget_status.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/budget_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/call_conversion_reporting_state.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/call_placeholder_field.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/call_to_action_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/call_tracking_display_location.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/call_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/callout_placeholder_field.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/campaign_criterion_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/campaign_draft_status.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/campaign_experiment_type.proto (81%) create mode 100644 google/ads/googleads/v12/enums/campaign_group_status.proto create mode 100644 google/ads/googleads/v12/enums/campaign_primary_status.proto create mode 100644 google/ads/googleads/v12/enums/campaign_primary_status_reason.proto rename google/ads/googleads/{v9 => v12}/enums/campaign_serving_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/campaign_shared_set_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/campaign_status.proto (78%) create mode 100644 google/ads/googleads/v12/enums/chain_relationship_type.proto rename google/ads/googleads/{v9 => v12}/enums/change_client_type.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/change_event_resource_type.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/change_status_operation.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/change_status_resource_type.proto (86%) rename google/ads/googleads/{v9 => v12}/enums/click_type.proto (90%) rename google/ads/googleads/{v9 => v12}/enums/combined_audience_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/content_label_type.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/conversion_action_category.proto (74%) rename google/ads/googleads/{v9 => v12}/enums/conversion_action_counting_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/conversion_action_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/conversion_action_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/conversion_adjustment_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/conversion_attribution_event_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/conversion_custom_variable_status.proto (81%) create mode 100644 google/ads/googleads/v12/enums/conversion_environment_enum.proto rename google/ads/googleads/{v9 => v12}/enums/conversion_lag_bucket.proto (90%) rename google/ads/googleads/{v9 => v12}/enums/conversion_or_adjustment_lag_bucket.proto (95%) rename google/ads/googleads/{v9 => v12}/enums/conversion_origin.proto (74%) create mode 100644 google/ads/googleads/v12/enums/conversion_tracking_status_enum.proto rename google/ads/googleads/{v9 => v12}/enums/conversion_value_rule_primary_dimension.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/conversion_value_rule_set_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/conversion_value_rule_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/criterion_category_channel_availability_mode.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/criterion_category_locale_availability_mode.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/criterion_system_serving_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/criterion_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/custom_audience_member_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/custom_audience_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/custom_audience_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/custom_conversion_goal_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/custom_interest_member_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/custom_interest_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/custom_interest_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/custom_placeholder_field.proto (91%) rename google/ads/googleads/{v9 => v12}/enums/customer_match_upload_key_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/customer_pay_per_conversion_eligibility_failure_reason.proto (84%) create mode 100644 google/ads/googleads/v12/enums/customer_status.proto rename google/ads/googleads/{v9 => v12}/enums/customizer_attribute_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/customizer_attribute_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/customizer_value_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/data_driven_model_status.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/day_of_week.proto (71%) rename google/ads/googleads/{v9 => v12}/enums/device.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/display_ad_format_setting.proto (72%) rename google/ads/googleads/{v9 => v12}/enums/display_upload_product_type.proto (90%) rename google/ads/googleads/{v9 => v12}/enums/distance_bucket.proto (84%) rename google/ads/googleads/{v9 => v12}/enums/dsa_page_feed_criterion_field.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/education_placeholder_field.proto (87%) create mode 100644 google/ads/googleads/v12/enums/experiment_metric.proto create mode 100644 google/ads/googleads/v12/enums/experiment_metric_direction.proto create mode 100644 google/ads/googleads/v12/enums/experiment_status.proto create mode 100644 google/ads/googleads/v12/enums/experiment_type.proto rename google/ads/googleads/{v9 => v12}/enums/extension_setting_device.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/extension_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/external_conversion_source.proto (92%) rename google/ads/googleads/{v9 => v12}/enums/feed_attribute_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_quality_approval_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_quality_disapproval_reason.proto (89%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_set_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_set_string_filter_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_status.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_target_device.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_target_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_target_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/feed_item_validation_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/feed_link_status.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/feed_mapping_criterion_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/feed_mapping_status.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/feed_origin.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/feed_status.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/flight_placeholder_field.proto (91%) rename google/ads/googleads/{v9 => v12}/enums/frequency_cap_event_type.proto (73%) rename google/ads/googleads/{v9 => v12}/enums/frequency_cap_level.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/frequency_cap_time_unit.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/gender_type.proto (73%) rename google/ads/googleads/{v9 => v12}/enums/geo_target_constant_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/geo_targeting_restriction.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/geo_targeting_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/goal_config_level.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/google_ads_field_category.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/google_ads_field_data_type.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/google_voice_call_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/hotel_date_selection_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/hotel_placeholder_field.proto (91%) rename google/ads/googleads/{v9 => v12}/enums/hotel_price_bucket.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/hotel_rate_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/hotel_reconciliation_status.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/image_placeholder_field.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/income_range_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/interaction_event_type.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/interaction_type.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/invoice_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/job_placeholder_field.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/keyword_match_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_aggregate_metric_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_competition_level.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_concept_group_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_forecast_interval.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_keyword_annotation.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/keyword_plan_network.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/label_status.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/lead_form_call_to_action_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/lead_form_desired_intent.proto (69%) rename google/ads/googleads/{v9 => v12}/enums/lead_form_field_user_input_type.proto (54%) rename google/ads/googleads/{v9 => v12}/enums/lead_form_post_submit_call_to_action_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/legacy_app_install_ad_app_store.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/linked_account_type.proto (69%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_bidding_category_level.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_custom_attribute_index.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_product_channel.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_product_condition.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_product_type_level.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_type_enum.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_filter_vertical.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/listing_group_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/local_placeholder_field.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/location_extension_targeting_criterion_field.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/location_group_radius_units.proto (73%) create mode 100644 google/ads/googleads/v12/enums/location_ownership_type.proto rename google/ads/googleads/{v9 => v12}/enums/location_placeholder_field.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/location_source_type.proto (78%) create mode 100644 google/ads/googleads/v12/enums/location_string_filter_type.proto rename google/ads/googleads/{v9 => v12}/enums/manager_link_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/matching_function_context_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/matching_function_operator.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/media_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/merchant_center_link_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/message_placeholder_field.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/mime_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/minute_of_hour.proto (74%) rename google/ads/googleads/{v9 => v12}/enums/mobile_app_vendor.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/mobile_device_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/month_of_year.proto (73%) rename google/ads/googleads/{v9 => v12}/enums/negative_geo_target_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/offline_user_data_job_failure_reason.proto (61%) rename google/ads/googleads/{v9 => v12}/enums/offline_user_data_job_match_rate_range.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/offline_user_data_job_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/offline_user_data_job_type.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/operating_system_version_operator_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/optimization_goal_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/parental_status_type.proto (74%) rename google/ads/googleads/{v9 => v12}/enums/payment_mode.proto (81%) create mode 100644 google/ads/googleads/v12/enums/performance_max_upgrade_status.proto rename google/ads/googleads/{v9 => v12}/enums/placeholder_type.proto (89%) rename google/ads/googleads/{v9 => v12}/enums/placement_type.proto (64%) rename google/ads/googleads/{v9 => v12}/enums/policy_approval_status.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/policy_review_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/policy_topic_entry_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/policy_topic_evidence_destination_mismatch_url_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/policy_topic_evidence_destination_not_working_device.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/positive_geo_target_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/preferred_content_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/price_extension_price_qualifier.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/price_extension_price_unit.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/price_extension_type.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/price_placeholder_field.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/product_bidding_category_level.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/product_bidding_category_status.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/product_channel.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/product_channel_exclusivity.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/product_condition.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/product_custom_attribute_index.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/product_type_level.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/promotion_extension_discount_modifier.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/promotion_extension_occasion.proto (86%) rename google/ads/googleads/{v9 => v12}/enums/promotion_placeholder_field.proto (85%) rename google/ads/googleads/{v9 => v12}/enums/proximity_radius_units.proto (73%) rename google/ads/googleads/{v9 => v12}/enums/quality_score_bucket.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/reach_plan_age_range.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/reach_plan_network.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/real_estate_placeholder_field.proto (87%) rename google/ads/googleads/{v9 => v12}/enums/recommendation_type.proto (67%) rename google/ads/googleads/{v9 => v12}/enums/resource_change_operation.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/resource_limit_type.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/response_content_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/search_engine_results_page_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/search_term_match_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/search_term_targeting_status.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/seasonality_event_scope.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/seasonality_event_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/served_asset_field_type.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/shared_set_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/shared_set_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/simulation_modification_method.proto (83%) rename google/ads/googleads/{v9 => v12}/enums/simulation_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/sitelink_placeholder_field.proto (83%) create mode 100644 google/ads/googleads/v12/enums/sk_ad_network_ad_event_type.proto create mode 100644 google/ads/googleads/v12/enums/sk_ad_network_attribution_credit.proto create mode 100644 google/ads/googleads/v12/enums/sk_ad_network_user_type.proto rename google/ads/googleads/{v9 => v12}/enums/slot.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/spending_limit_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/structured_snippet_placeholder_field.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/summary_row_setting.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/system_managed_entity_source.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/target_cpa_opt_in_recommendation_goal.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/target_impression_share_location.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/targeting_dimension.proto (73%) rename google/ads/googleads/{v9 => v12}/enums/time_type.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/tracking_code_page_format.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/tracking_code_type.proto (82%) rename google/ads/googleads/{v9 => v12}/enums/travel_placeholder_field.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/user_identifier_source.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/user_interest_taxonomy_type.proto (80%) rename google/ads/googleads/{v9 => v12}/enums/user_list_access_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/user_list_closing_reason.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/user_list_combined_rule_operator.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/user_list_crm_data_source_type.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/user_list_date_rule_item_operator.proto (77%) create mode 100644 google/ads/googleads/v12/enums/user_list_flexible_rule_operator.proto rename google/ads/googleads/{v9 => v12}/enums/user_list_logical_rule_operator.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/user_list_membership_status.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/user_list_number_rule_item_operator.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/user_list_prepopulation_status.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/user_list_rule_type.proto (75%) rename google/ads/googleads/{v9 => v12}/enums/user_list_size_range.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/user_list_string_rule_item_operator.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/user_list_type.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/value_rule_device_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/value_rule_geo_location_match_type.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/value_rule_operation.proto (79%) rename google/ads/googleads/{v9 => v12}/enums/value_rule_set_attachment_type.proto (77%) rename google/ads/googleads/{v9 => v12}/enums/value_rule_set_dimension.proto (76%) rename google/ads/googleads/{v9 => v12}/enums/vanity_pharma_display_url_mode.proto (78%) rename google/ads/googleads/{v9 => v12}/enums/vanity_pharma_text.proto (88%) rename google/ads/googleads/{v9 => v12}/enums/video_thumbnail.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/webpage_condition_operand.proto (81%) rename google/ads/googleads/{v9 => v12}/enums/webpage_condition_operator.proto (78%) rename google/ads/googleads/{v9 => v12}/errors/BUILD.bazel (96%) rename google/ads/googleads/{v9 => v12}/errors/access_invitation_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/account_budget_proposal_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/account_link_error.proto (72%) rename google/ads/googleads/{v9 => v12}/errors/ad_customizer_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/ad_error.proto (94%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_ad_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_bid_modifier_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_criterion_customizer_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_criterion_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_customizer_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_error.proto (88%) rename google/ads/googleads/{v9 => v12}/errors/ad_group_feed_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/ad_parameter_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/ad_sharing_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/adx_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/asset_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/asset_group_asset_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/asset_group_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/asset_group_listing_group_filter_error.proto (87%) rename google/ads/googleads/{v9 => v12}/errors/asset_link_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/asset_set_asset_error.proto (72%) create mode 100644 google/ads/googleads/v12/errors/asset_set_error.proto rename google/ads/googleads/{v9 => v12}/errors/asset_set_link_error.proto (82%) create mode 100644 google/ads/googleads/v12/errors/audience_error.proto create mode 100644 google/ads/googleads/v12/errors/audience_insights_error.proto rename google/ads/googleads/{v9 => v12}/errors/authentication_error.proto (78%) rename google/ads/googleads/{v9 => v12}/errors/authorization_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/batch_job_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/bidding_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/bidding_strategy_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/billing_setup_error.proto (88%) rename google/ads/googleads/{v9 => v12}/errors/campaign_budget_error.proto (89%) rename google/ads/googleads/{v9/errors/asset_set_error.proto => v12/errors/campaign_conversion_goal_error.proto} (50%) rename google/ads/googleads/{v9 => v12}/errors/campaign_criterion_error.proto (73%) rename google/ads/googleads/{v9 => v12}/errors/campaign_customizer_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/campaign_draft_error.proto (86%) rename google/ads/googleads/{v9 => v12}/errors/campaign_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/campaign_experiment_error.proto (87%) rename google/ads/googleads/{v9 => v12}/errors/campaign_feed_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/campaign_shared_set_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/change_event_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/change_status_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/collection_size_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/context_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/conversion_action_error.proto (87%) rename google/ads/googleads/{v9 => v12}/errors/conversion_adjustment_upload_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/conversion_custom_variable_error.proto (75%) create mode 100644 google/ads/googleads/v12/errors/conversion_goal_campaign_config_error.proto rename google/ads/googleads/{v9 => v12}/errors/conversion_upload_error.proto (81%) rename google/ads/googleads/{v9 => v12}/errors/conversion_value_rule_error.proto (87%) rename google/ads/googleads/{v9 => v12}/errors/conversion_value_rule_set_error.proto (72%) rename google/ads/googleads/{v9 => v12}/errors/country_code_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/criterion_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/currency_code_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/custom_audience_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/custom_conversion_goal_error.proto (74%) rename google/ads/googleads/{v9 => v12}/errors/custom_interest_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/customer_client_link_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/customer_customizer_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/customer_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/customer_feed_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/customer_manager_link_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/customer_user_access_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/customizer_attribute_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/database_error.proto (74%) rename google/ads/googleads/{v9 => v12}/errors/date_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/date_range_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/distinct_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/enum_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/errors.proto (66%) create mode 100644 google/ads/googleads/v12/errors/experiment_arm_error.proto create mode 100644 google/ads/googleads/v12/errors/experiment_error.proto rename google/ads/googleads/{v9 => v12}/errors/extension_feed_item_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/extension_setting_error.proto (92%) rename google/ads/googleads/{v9 => v12}/errors/feed_attribute_reference_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/feed_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/feed_item_error.proto (82%) rename google/ads/googleads/{v9 => v12}/errors/feed_item_set_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/feed_item_set_link_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/feed_item_target_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/feed_item_validation_error.proto (95%) rename google/ads/googleads/{v9 => v12}/errors/feed_mapping_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/field_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/field_mask_error.proto (81%) rename google/ads/googleads/{v9 => v12}/errors/function_error.proto (86%) rename google/ads/googleads/{v9 => v12}/errors/function_parsing_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/geo_target_constant_suggestion_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/header_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/id_error.proto (66%) rename google/ads/googleads/{v9 => v12}/errors/image_error.proto (91%) rename google/ads/googleads/{v9 => v12}/errors/internal_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/invoice_error.proto (81%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_ad_group_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_ad_group_keyword_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_campaign_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_campaign_keyword_error.proto (78%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_error.proto (87%) rename google/ads/googleads/{v9 => v12}/errors/keyword_plan_idea_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/label_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/language_code_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/list_operation_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/manager_link_error.proto (88%) rename google/ads/googleads/{v9 => v12}/errors/media_bundle_error.proto (88%) rename google/ads/googleads/{v9 => v12}/errors/media_file_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/media_upload_error.proto (91%) rename google/ads/googleads/{v9 => v12}/errors/merchant_center_error.proto (78%) rename google/ads/googleads/{v9 => v12}/errors/multiplier_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/mutate_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/new_resource_creation_error.proto (80%) rename google/ads/googleads/{v9 => v12}/errors/not_allowlisted_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/not_empty_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/null_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/offline_user_data_job_error.proto (84%) rename google/ads/googleads/{v9 => v12}/errors/operation_access_denied_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/operator_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/partial_failure_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/payments_account_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/policy_finding_error.proto (78%) rename google/ads/googleads/{v9 => v12}/errors/policy_validation_parameter_error.proto (81%) rename google/ads/googleads/{v9 => v12}/errors/policy_violation_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/query_error.proto (92%) rename google/ads/googleads/{v9 => v12}/errors/quota_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/range_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/reach_plan_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/recommendation_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/region_code_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/request_error.proto (90%) rename google/ads/googleads/{v9 => v12}/errors/resource_access_denied_error.proto (76%) rename google/ads/googleads/{v9 => v12}/errors/resource_count_limit_exceeded_error.proto (90%) rename google/ads/googleads/{v9 => v12}/errors/setting_error.proto (83%) rename google/ads/googleads/{v9 => v12}/errors/shared_criterion_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/shared_set_error.proto (79%) rename google/ads/googleads/{v9 => v12}/errors/size_limit_error.proto (72%) create mode 100644 google/ads/googleads/v12/errors/smart_campaign_error.proto rename google/ads/googleads/{v9 => v12}/errors/string_format_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/string_length_error.proto (77%) rename google/ads/googleads/{v9 => v12}/errors/third_party_app_analytics_link_error.proto (81%) rename google/ads/googleads/{v9 => v12}/errors/time_zone_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/url_field_error.proto (85%) rename google/ads/googleads/{v9 => v12}/errors/user_data_error.proto (75%) rename google/ads/googleads/{v9 => v12}/errors/user_list_error.proto (89%) rename google/ads/googleads/{v9 => v12}/errors/youtube_video_registration_error.proto (71%) create mode 100644 google/ads/googleads/v12/googleads_gapic.yaml create mode 100755 google/ads/googleads/v12/googleads_grpc_service_config.json create mode 100644 google/ads/googleads/v12/googleads_v12.yaml rename google/ads/googleads/{v9 => v12}/resources/BUILD.bazel (94%) rename google/ads/googleads/{v9 => v12}/resources/accessible_bidding_strategy.proto (86%) rename google/ads/googleads/{v9 => v12}/resources/account_budget.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/account_budget_proposal.proto (72%) rename google/ads/googleads/{v9 => v12}/resources/account_link.proto (66%) rename google/ads/googleads/{v9 => v12}/resources/ad.proto (57%) rename google/ads/googleads/{v9 => v12}/resources/ad_group.proto (60%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_ad.proto (67%) create mode 100644 google/ads/googleads/v12/resources/ad_group_ad_asset_combination_view.proto rename google/ads/googleads/{v9 => v12}/resources/ad_group_ad_asset_view.proto (66%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_ad_label.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_asset.proto (71%) create mode 100644 google/ads/googleads/v12/resources/ad_group_asset_set.proto rename google/ads/googleads/{v9 => v12}/resources/ad_group_audience_view.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_bid_modifier.proto (68%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_criterion.proto (64%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_criterion_customizer.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_criterion_label.proto (84%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_criterion_simulation.proto (73%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_customizer.proto (75%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_extension_setting.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_feed.proto (71%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_label.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/ad_group_simulation.proto (67%) rename google/ads/googleads/{v9 => v12}/resources/ad_parameter.proto (87%) rename google/ads/googleads/{v9 => v12}/resources/ad_schedule_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/age_range_view.proto (78%) create mode 100644 google/ads/googleads/v12/resources/asset.proto rename google/ads/googleads/{v9 => v12}/resources/asset_field_type_view.proto (74%) rename google/ads/googleads/{v9 => v12}/resources/asset_group.proto (71%) rename google/ads/googleads/{v9 => v12}/resources/asset_group_asset.proto (67%) rename google/ads/googleads/{v9 => v12}/resources/asset_group_listing_group_filter.proto (72%) rename google/ads/googleads/{v9 => v12}/resources/asset_group_product_group_view.proto (64%) create mode 100644 google/ads/googleads/v12/resources/asset_group_signal.proto rename google/ads/googleads/{v9 => v12}/resources/asset_set.proto (53%) rename google/ads/googleads/{v9 => v12}/resources/asset_set_asset.proto (77%) create mode 100644 google/ads/googleads/v12/resources/asset_set_type_view.proto create mode 100644 google/ads/googleads/v12/resources/audience.proto rename google/ads/googleads/{v9 => v12}/resources/batch_job.proto (86%) rename google/ads/googleads/{v9 => v12}/resources/bidding_data_exclusion.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/bidding_seasonality_adjustment.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/bidding_strategy.proto (71%) rename google/ads/googleads/{v9 => v12}/resources/bidding_strategy_simulation.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/billing_setup.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/call_view.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/campaign.proto (55%) rename google/ads/googleads/{v9 => v12}/resources/campaign_asset.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/campaign_asset_set.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/campaign_audience_view.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/campaign_bid_modifier.proto (80%) rename google/ads/googleads/{v9 => v12}/resources/campaign_budget.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/campaign_conversion_goal.proto (74%) rename google/ads/googleads/{v9 => v12}/resources/campaign_criterion.proto (50%) rename google/ads/googleads/{v9 => v12}/resources/campaign_criterion_simulation.proto (73%) rename google/ads/googleads/{v9 => v12}/resources/campaign_customizer.proto (75%) rename google/ads/googleads/{v9 => v12}/resources/campaign_draft.proto (84%) rename google/ads/googleads/{v9 => v12}/resources/campaign_extension_setting.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/campaign_feed.proto (72%) create mode 100644 google/ads/googleads/v12/resources/campaign_group.proto rename google/ads/googleads/{v9 => v12}/resources/campaign_label.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/campaign_shared_set.proto (80%) rename google/ads/googleads/{v9 => v12}/resources/campaign_simulation.proto (58%) rename google/ads/googleads/{v9 => v12}/resources/carrier_constant.proto (80%) rename google/ads/googleads/{v9 => v12}/resources/change_event.proto (71%) rename google/ads/googleads/{v9 => v12}/resources/change_status.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/click_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/combined_audience.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/conversion_action.proto (70%) rename google/ads/googleads/{v9 => v12}/resources/conversion_custom_variable.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/conversion_goal_campaign_config.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/conversion_value_rule.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/conversion_value_rule_set.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/currency_constant.proto (80%) rename google/ads/googleads/{v9 => v12}/resources/custom_audience.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/custom_conversion_goal.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/custom_interest.proto (75%) rename google/ads/googleads/{v9 => v12}/resources/customer.proto (67%) rename google/ads/googleads/{v9 => v12}/resources/customer_asset.proto (68%) create mode 100644 google/ads/googleads/v12/resources/customer_asset_set.proto rename google/ads/googleads/{v9 => v12}/resources/customer_client.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/customer_client_link.proto (80%) rename google/ads/googleads/{v9 => v12}/resources/customer_conversion_goal.proto (72%) rename google/ads/googleads/{v9 => v12}/resources/customer_customizer.proto (72%) rename google/ads/googleads/{v9 => v12}/resources/customer_extension_setting.proto (74%) rename google/ads/googleads/{v9 => v12}/resources/customer_feed.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/customer_label.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/customer_manager_link.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/customer_negative_criterion.proto (60%) rename google/ads/googleads/{v9 => v12}/resources/customer_user_access.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/customer_user_access_invitation.proto (74%) rename google/ads/googleads/{v9 => v12}/resources/customizer_attribute.proto (73%) rename google/ads/googleads/{v9 => v12}/resources/detail_placement_view.proto (70%) rename google/ads/googleads/{v9 => v12}/resources/detailed_demographic.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/display_keyword_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/distance_view.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/domain_category.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/dynamic_search_ads_search_term_view.proto (88%) rename google/ads/googleads/{v9 => v12}/resources/expanded_landing_page_view.proto (81%) create mode 100644 google/ads/googleads/v12/resources/experiment.proto create mode 100644 google/ads/googleads/v12/resources/experiment_arm.proto rename google/ads/googleads/{v9 => v12}/resources/extension_feed_item.proto (64%) rename google/ads/googleads/{v9 => v12}/resources/feed.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/feed_item.proto (68%) rename google/ads/googleads/{v9 => v12}/resources/feed_item_set.proto (74%) rename google/ads/googleads/{v9 => v12}/resources/feed_item_set_link.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/feed_item_target.proto (70%) create mode 100644 google/ads/googleads/v12/resources/feed_mapping.proto rename google/ads/googleads/{v9 => v12}/resources/feed_placeholder_view.proto (72%) rename google/ads/googleads/{v9 => v12}/resources/gender_view.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/geo_target_constant.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/geographic_view.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/google_ads_field.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/group_placement_view.proto (71%) rename google/ads/googleads/{v9 => v12}/resources/hotel_group_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/hotel_performance_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/hotel_reconciliation.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/income_range_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/invoice.proto (61%) rename google/ads/googleads/{v9 => v12}/resources/keyword_plan.proto (75%) rename google/ads/googleads/{v9 => v12}/resources/keyword_plan_ad_group.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/keyword_plan_ad_group_keyword.proto (73%) rename google/ads/googleads/{v9 => v12}/resources/keyword_plan_campaign.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/keyword_plan_campaign_keyword.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/keyword_theme_constant.proto (84%) rename google/ads/googleads/{v9 => v12}/resources/keyword_view.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/label.proto (69%) rename google/ads/googleads/{v9 => v12}/resources/landing_page_view.proto (81%) rename google/ads/googleads/{v9 => v12}/resources/language_constant.proto (76%) create mode 100644 google/ads/googleads/v12/resources/lead_form_submission_data.proto rename google/ads/googleads/{v9 => v12}/resources/life_event.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/location_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/managed_placement_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/media_file.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/merchant_center_link.proto (77%) rename google/ads/googleads/{v9 => v12}/resources/mobile_app_category_constant.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/mobile_device_constant.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/offline_user_data_job.proto (60%) rename google/ads/googleads/{v9 => v12}/resources/operating_system_version_constant.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/paid_organic_search_term_view.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/parental_status_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/payments_account.proto (84%) create mode 100644 google/ads/googleads/v12/resources/per_store_view.proto rename google/ads/googleads/{v9 => v12}/resources/product_bidding_category_constant.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/product_group_view.proto (79%) rename google/ads/googleads/{v9 => v12}/resources/recommendation.proto (62%) rename google/ads/googleads/{v9 => v12}/resources/remarketing_action.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/search_term_view.proto (76%) rename google/ads/googleads/{v9 => v12}/resources/shared_criterion.proto (63%) rename google/ads/googleads/{v9 => v12}/resources/shared_set.proto (75%) rename google/ads/googleads/{v9 => v12}/resources/shopping_performance_view.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/smart_campaign_search_term_view.proto (83%) rename google/ads/googleads/{v9 => v12}/resources/smart_campaign_setting.proto (57%) rename google/ads/googleads/{v9 => v12}/resources/third_party_app_analytics_link.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/topic_constant.proto (85%) rename google/ads/googleads/{v9 => v12}/resources/topic_view.proto (78%) rename google/ads/googleads/{v9 => v12}/resources/user_interest.proto (73%) rename google/ads/googleads/{v9 => v12}/resources/user_list.proto (70%) rename google/ads/googleads/{v9 => v12}/resources/user_location_view.proto (84%) rename google/ads/googleads/{v9 => v12}/resources/video.proto (82%) rename google/ads/googleads/{v9 => v12}/resources/webpage_view.proto (78%) rename google/ads/googleads/{v9 => v12}/services/BUILD.bazel (94%) rename google/ads/googleads/{v9 => v12}/services/account_budget_proposal_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/account_link_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/ad_group_ad_label_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/ad_group_ad_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/ad_group_asset_service.proto (67%) create mode 100644 google/ads/googleads/v12/services/ad_group_asset_set_service.proto rename google/ads/googleads/{v9 => v12}/services/ad_group_bid_modifier_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/ad_group_criterion_customizer_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/ad_group_criterion_label_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/ad_group_criterion_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/ad_group_customizer_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/ad_group_extension_setting_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/ad_group_feed_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/ad_group_label_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/ad_group_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/ad_parameter_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/ad_service.proto (78%) rename google/ads/googleads/{v9 => v12}/services/asset_group_asset_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/asset_group_listing_group_filter_service.proto (73%) rename google/ads/googleads/{v9 => v12}/services/asset_group_service.proto (67%) create mode 100644 google/ads/googleads/v12/services/asset_group_signal_service.proto rename google/ads/googleads/{v9 => v12}/services/asset_service.proto (71%) rename google/ads/googleads/{v9 => v12}/services/asset_set_asset_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/asset_set_service.proto (72%) create mode 100644 google/ads/googleads/v12/services/audience_insights_service.proto create mode 100644 google/ads/googleads/v12/services/audience_service.proto rename google/ads/googleads/{v9 => v12}/services/batch_job_service.proto (77%) rename google/ads/googleads/{v9 => v12}/services/bidding_data_exclusion_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/bidding_seasonality_adjustment_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/bidding_strategy_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/billing_setup_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/campaign_asset_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/campaign_asset_set_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/campaign_bid_modifier_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/campaign_budget_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/campaign_conversion_goal_service.proto (76%) rename google/ads/googleads/{v9 => v12}/services/campaign_criterion_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/campaign_customizer_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/campaign_draft_service.proto (75%) rename google/ads/googleads/{v9 => v12}/services/campaign_extension_setting_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/campaign_feed_service.proto (68%) create mode 100644 google/ads/googleads/v12/services/campaign_group_service.proto rename google/ads/googleads/{v9 => v12}/services/campaign_label_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/campaign_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/campaign_shared_set_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/conversion_action_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/conversion_adjustment_upload_service.proto (84%) rename google/ads/googleads/{v9 => v12}/services/conversion_custom_variable_service.proto (64%) rename google/ads/googleads/{v9 => v12}/services/conversion_goal_campaign_config_service.proto (75%) rename google/ads/googleads/{v9 => v12}/services/conversion_upload_service.proto (80%) rename google/ads/googleads/{v9 => v12}/services/conversion_value_rule_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/conversion_value_rule_set_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/custom_audience_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/custom_conversion_goal_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/custom_interest_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/customer_asset_service.proto (67%) create mode 100644 google/ads/googleads/v12/services/customer_asset_set_service.proto rename google/ads/googleads/{v9 => v12}/services/customer_client_link_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/customer_conversion_goal_service.proto (76%) rename google/ads/googleads/{v9 => v12}/services/customer_customizer_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/customer_extension_setting_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/customer_feed_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/customer_label_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/customer_manager_link_service.proto (72%) rename google/ads/googleads/{v9 => v12}/services/customer_negative_criterion_service.proto (64%) rename google/ads/googleads/{v9 => v12}/services/customer_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/customer_user_access_invitation_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/customer_user_access_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/customizer_attribute_service.proto (73%) create mode 100644 google/ads/googleads/v12/services/experiment_arm_service.proto create mode 100644 google/ads/googleads/v12/services/experiment_service.proto rename google/ads/googleads/{v9 => v12}/services/extension_feed_item_service.proto (68%) rename google/ads/googleads/{v9 => v12}/services/feed_item_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/feed_item_set_link_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/feed_item_set_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/feed_item_target_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/feed_mapping_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/feed_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/geo_target_constant_service.proto (65%) rename google/ads/googleads/{v9 => v12}/services/google_ads_field_service.proto (80%) rename google/ads/googleads/{v9 => v12}/services/google_ads_service.proto (53%) rename google/ads/googleads/{v9 => v12}/services/invoice_service.proto (77%) rename google/ads/googleads/{v9 => v12}/services/keyword_plan_ad_group_keyword_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/keyword_plan_ad_group_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/keyword_plan_campaign_keyword_service.proto (70%) rename google/ads/googleads/{v9 => v12}/services/keyword_plan_campaign_service.proto (69%) create mode 100644 google/ads/googleads/v12/services/keyword_plan_idea_service.proto rename google/ads/googleads/{v9 => v12}/services/keyword_plan_service.proto (81%) rename google/ads/googleads/{v9 => v12}/services/keyword_theme_constant_service.proto (58%) rename google/ads/googleads/{v9 => v12}/services/label_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/media_file_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/merchant_center_link_service.proto (75%) rename google/ads/googleads/{v9 => v12}/services/offline_user_data_job_service.proto (71%) rename google/ads/googleads/{v9 => v12}/services/payments_account_service.proto (77%) rename google/ads/googleads/{v9 => v12}/services/reach_plan_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/recommendation_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/remarketing_action_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/shared_criterion_service.proto (67%) rename google/ads/googleads/{v9 => v12}/services/shared_set_service.proto (69%) rename google/ads/googleads/{v9 => v12}/services/smart_campaign_setting_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/smart_campaign_suggest_service.proto (74%) rename google/ads/googleads/{v9 => v12}/services/third_party_app_analytics_link_service.proto (55%) rename google/ads/googleads/{v9 => v12}/services/user_data_service.proto (66%) rename google/ads/googleads/{v9 => v12}/services/user_list_service.proto (70%) delete mode 100644 google/ads/googleads/v9/common/asset_types.proto delete mode 100644 google/ads/googleads/v9/enums/campaign_experiment_status.proto delete mode 100644 google/ads/googleads/v9/enums/campaign_experiment_traffic_split_type.proto delete mode 100644 google/ads/googleads/v9/enums/reach_plan_ad_length.proto delete mode 100644 google/ads/googleads/v9/googleads_gapic.yaml delete mode 100755 google/ads/googleads/v9/googleads_grpc_service_config.json delete mode 100644 google/ads/googleads/v9/googleads_v9.yaml delete mode 100644 google/ads/googleads/v9/resources/asset.proto delete mode 100644 google/ads/googleads/v9/resources/campaign_experiment.proto delete mode 100644 google/ads/googleads/v9/resources/feed_mapping.proto delete mode 100644 google/ads/googleads/v9/services/accessible_bidding_strategy_service.proto delete mode 100644 google/ads/googleads/v9/services/account_budget_service.proto delete mode 100644 google/ads/googleads/v9/services/ad_group_ad_asset_view_service.proto delete mode 100644 google/ads/googleads/v9/services/ad_group_audience_view_service.proto delete mode 100644 google/ads/googleads/v9/services/ad_group_criterion_simulation_service.proto delete mode 100644 google/ads/googleads/v9/services/ad_group_simulation_service.proto delete mode 100644 google/ads/googleads/v9/services/ad_schedule_view_service.proto delete mode 100644 google/ads/googleads/v9/services/age_range_view_service.proto delete mode 100644 google/ads/googleads/v9/services/asset_field_type_view_service.proto delete mode 100644 google/ads/googleads/v9/services/bidding_strategy_simulation_service.proto delete mode 100644 google/ads/googleads/v9/services/campaign_audience_view_service.proto delete mode 100644 google/ads/googleads/v9/services/campaign_criterion_simulation_service.proto delete mode 100644 google/ads/googleads/v9/services/campaign_experiment_service.proto delete mode 100644 google/ads/googleads/v9/services/campaign_simulation_service.proto delete mode 100644 google/ads/googleads/v9/services/carrier_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/change_status_service.proto delete mode 100644 google/ads/googleads/v9/services/click_view_service.proto delete mode 100644 google/ads/googleads/v9/services/combined_audience_service.proto delete mode 100644 google/ads/googleads/v9/services/currency_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/customer_client_service.proto delete mode 100644 google/ads/googleads/v9/services/detail_placement_view_service.proto delete mode 100644 google/ads/googleads/v9/services/detailed_demographic_service.proto delete mode 100644 google/ads/googleads/v9/services/display_keyword_view_service.proto delete mode 100644 google/ads/googleads/v9/services/distance_view_service.proto delete mode 100644 google/ads/googleads/v9/services/domain_category_service.proto delete mode 100644 google/ads/googleads/v9/services/dynamic_search_ads_search_term_view_service.proto delete mode 100644 google/ads/googleads/v9/services/expanded_landing_page_view_service.proto delete mode 100644 google/ads/googleads/v9/services/feed_placeholder_view_service.proto delete mode 100644 google/ads/googleads/v9/services/gender_view_service.proto delete mode 100644 google/ads/googleads/v9/services/geographic_view_service.proto delete mode 100644 google/ads/googleads/v9/services/group_placement_view_service.proto delete mode 100644 google/ads/googleads/v9/services/hotel_group_view_service.proto delete mode 100644 google/ads/googleads/v9/services/hotel_performance_view_service.proto delete mode 100644 google/ads/googleads/v9/services/income_range_view_service.proto delete mode 100644 google/ads/googleads/v9/services/keyword_plan_idea_service.proto delete mode 100644 google/ads/googleads/v9/services/keyword_view_service.proto delete mode 100644 google/ads/googleads/v9/services/landing_page_view_service.proto delete mode 100644 google/ads/googleads/v9/services/language_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/life_event_service.proto delete mode 100644 google/ads/googleads/v9/services/location_view_service.proto delete mode 100644 google/ads/googleads/v9/services/managed_placement_view_service.proto delete mode 100644 google/ads/googleads/v9/services/mobile_app_category_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/mobile_device_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/operating_system_version_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/paid_organic_search_term_view_service.proto delete mode 100644 google/ads/googleads/v9/services/parental_status_view_service.proto delete mode 100644 google/ads/googleads/v9/services/product_bidding_category_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/product_group_view_service.proto delete mode 100644 google/ads/googleads/v9/services/search_term_view_service.proto delete mode 100644 google/ads/googleads/v9/services/shopping_performance_view_service.proto delete mode 100644 google/ads/googleads/v9/services/smart_campaign_search_term_view_service.proto delete mode 100644 google/ads/googleads/v9/services/topic_constant_service.proto delete mode 100644 google/ads/googleads/v9/services/topic_view_service.proto delete mode 100644 google/ads/googleads/v9/services/user_interest_service.proto delete mode 100644 google/ads/googleads/v9/services/user_location_view_service.proto delete mode 100644 google/ads/googleads/v9/services/video_service.proto delete mode 100644 google/ads/googleads/v9/services/webpage_view_service.proto create mode 100644 google/ads/searchads360/v0/BUILD.bazel create mode 100644 google/ads/searchads360/v0/common/BUILD.bazel create mode 100644 google/ads/searchads360/v0/common/bidding.proto create mode 100644 google/ads/searchads360/v0/common/criteria.proto create mode 100644 google/ads/searchads360/v0/common/custom_parameter.proto create mode 100644 google/ads/searchads360/v0/common/frequency_cap.proto create mode 100644 google/ads/searchads360/v0/common/metrics.proto create mode 100644 google/ads/searchads360/v0/common/real_time_bidding_setting.proto create mode 100644 google/ads/searchads360/v0/common/segments.proto create mode 100644 google/ads/searchads360/v0/common/value.proto create mode 100644 google/ads/searchads360/v0/enums/BUILD.bazel create mode 100644 google/ads/searchads360/v0/enums/account_status.proto create mode 100644 google/ads/searchads360/v0/enums/account_type.proto create mode 100644 google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto create mode 100644 google/ads/searchads360/v0/enums/ad_group_criterion_engine_status.proto create mode 100644 google/ads/searchads360/v0/enums/ad_group_criterion_status.proto create mode 100644 google/ads/searchads360/v0/enums/ad_group_status.proto create mode 100644 google/ads/searchads360/v0/enums/ad_group_type.proto create mode 100644 google/ads/searchads360/v0/enums/ad_serving_optimization_status.proto create mode 100644 google/ads/searchads360/v0/enums/advertising_channel_sub_type.proto create mode 100644 google/ads/searchads360/v0/enums/advertising_channel_type.proto create mode 100644 google/ads/searchads360/v0/enums/age_range_type.proto create mode 100644 google/ads/searchads360/v0/enums/asset_field_type.proto create mode 100644 google/ads/searchads360/v0/enums/attribution_model.proto create mode 100644 google/ads/searchads360/v0/enums/bidding_strategy_status.proto create mode 100644 google/ads/searchads360/v0/enums/bidding_strategy_system_status.proto create mode 100644 google/ads/searchads360/v0/enums/bidding_strategy_type.proto create mode 100644 google/ads/searchads360/v0/enums/budget_delivery_method.proto create mode 100644 google/ads/searchads360/v0/enums/budget_period.proto create mode 100644 google/ads/searchads360/v0/enums/campaign_serving_status.proto create mode 100644 google/ads/searchads360/v0/enums/campaign_status.proto create mode 100644 google/ads/searchads360/v0/enums/conversion_action_category.proto create mode 100644 google/ads/searchads360/v0/enums/conversion_action_status.proto create mode 100644 google/ads/searchads360/v0/enums/conversion_action_type.proto create mode 100644 google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto create mode 100644 google/ads/searchads360/v0/enums/criterion_type.proto create mode 100644 google/ads/searchads360/v0/enums/custom_column_value_type.proto create mode 100644 google/ads/searchads360/v0/enums/customer_status.proto create mode 100644 google/ads/searchads360/v0/enums/data_driven_model_status.proto create mode 100644 google/ads/searchads360/v0/enums/day_of_week.proto create mode 100644 google/ads/searchads360/v0/enums/device.proto create mode 100644 google/ads/searchads360/v0/enums/gender_type.proto create mode 100644 google/ads/searchads360/v0/enums/interaction_event_type.proto create mode 100644 google/ads/searchads360/v0/enums/keyword_match_type.proto create mode 100644 google/ads/searchads360/v0/enums/listing_group_type.proto create mode 100644 google/ads/searchads360/v0/enums/location_group_radius_units.proto create mode 100644 google/ads/searchads360/v0/enums/manager_link_status.proto create mode 100644 google/ads/searchads360/v0/enums/negative_geo_target_type.proto create mode 100644 google/ads/searchads360/v0/enums/optimization_goal_type.proto create mode 100644 google/ads/searchads360/v0/enums/positive_geo_target_type.proto create mode 100644 google/ads/searchads360/v0/enums/quality_score_bucket.proto create mode 100644 google/ads/searchads360/v0/enums/search_ads360_field_category.proto create mode 100644 google/ads/searchads360/v0/enums/search_ads360_field_data_type.proto create mode 100644 google/ads/searchads360/v0/enums/summary_row_setting.proto create mode 100644 google/ads/searchads360/v0/enums/target_impression_share_location.proto create mode 100644 google/ads/searchads360/v0/enums/webpage_condition_operand.proto create mode 100644 google/ads/searchads360/v0/enums/webpage_condition_operator.proto create mode 100644 google/ads/searchads360/v0/resources/BUILD.bazel create mode 100644 google/ads/searchads360/v0/resources/ad_group.proto create mode 100644 google/ads/searchads360/v0/resources/ad_group_bid_modifier.proto create mode 100644 google/ads/searchads360/v0/resources/ad_group_criterion.proto create mode 100644 google/ads/searchads360/v0/resources/bidding_strategy.proto create mode 100644 google/ads/searchads360/v0/resources/campaign.proto create mode 100644 google/ads/searchads360/v0/resources/campaign_budget.proto create mode 100644 google/ads/searchads360/v0/resources/campaign_criterion.proto create mode 100644 google/ads/searchads360/v0/resources/conversion_action.proto create mode 100644 google/ads/searchads360/v0/resources/custom_column.proto create mode 100644 google/ads/searchads360/v0/resources/customer.proto create mode 100644 google/ads/searchads360/v0/resources/customer_client.proto create mode 100644 google/ads/searchads360/v0/resources/customer_manager_link.proto create mode 100644 google/ads/searchads360/v0/resources/keyword_view.proto create mode 100644 google/ads/searchads360/v0/resources/product_group_view.proto create mode 100644 google/ads/searchads360/v0/resources/search_ads360_field.proto create mode 100644 google/ads/searchads360/v0/searchads360_grpc_service_config.json create mode 100644 google/ads/searchads360/v0/searchads360_v0.yaml create mode 100644 google/ads/searchads360/v0/services/BUILD.bazel create mode 100644 google/ads/searchads360/v0/services/custom_column_service.proto create mode 100644 google/ads/searchads360/v0/services/search_ads360_field_service.proto create mode 100644 google/ads/searchads360/v0/services/search_ads360_service.proto create mode 100644 google/apps/drive/labels/v2/BUILD.bazel create mode 100644 google/apps/drive/labels/v2/common.proto create mode 100644 google/apps/drive/labels/v2/drivelabels_v2.yaml create mode 100644 google/apps/drive/labels/v2/drivelabels_v2_grpc_service_config.json create mode 100644 google/apps/drive/labels/v2/error_details.proto create mode 100644 google/apps/drive/labels/v2/exception_detail.proto create mode 100644 google/apps/drive/labels/v2/field.proto create mode 100644 google/apps/drive/labels/v2/label.proto create mode 100644 google/apps/drive/labels/v2/label_permission.proto create mode 100644 google/apps/drive/labels/v2/label_service.proto create mode 100644 google/apps/drive/labels/v2/requests.proto create mode 100644 google/apps/drive/labels/v2beta/BUILD.bazel create mode 100644 google/apps/drive/labels/v2beta/common.proto create mode 100644 google/apps/drive/labels/v2beta/drivelabels_v2beta.yaml create mode 100644 google/apps/drive/labels/v2beta/drivelabels_v2beta_grpc_service_config.json create mode 100644 google/apps/drive/labels/v2beta/error_details.proto create mode 100644 google/apps/drive/labels/v2beta/exception_detail.proto create mode 100644 google/apps/drive/labels/v2beta/field.proto create mode 100644 google/apps/drive/labels/v2beta/label.proto create mode 100644 google/apps/drive/labels/v2beta/label_limits.proto create mode 100644 google/apps/drive/labels/v2beta/label_lock.proto create mode 100644 google/apps/drive/labels/v2beta/label_permission.proto create mode 100644 google/apps/drive/labels/v2beta/label_service.proto create mode 100644 google/apps/drive/labels/v2beta/requests.proto create mode 100644 google/apps/drive/labels/v2beta/user_capabilities.proto create mode 100644 google/cloud/backupdr/logging/v1/BUILD.bazel create mode 100644 google/cloud/backupdr/logging/v1/eventlog.proto create mode 100644 google/cloud/bigquery/analyticshub/BUILD.bazel create mode 100644 google/cloud/bigquery/datapolicies/v1/BUILD.bazel create mode 100644 google/cloud/bigquery/datapolicies/v1/bigquerydatapolicy_v1.yaml create mode 100644 google/cloud/bigquery/datapolicies/v1/datapolicies_v1_grpc_service_config.json create mode 100644 google/cloud/bigquery/datapolicies/v1/datapolicy.proto delete mode 100644 google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_gapic.yaml delete mode 100755 google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_grpc_service_config.json delete mode 100644 google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_v1beta1.yaml delete mode 100644 google/cloud/bigquery/reservation/v1beta1/reservation.proto delete mode 100644 google/cloud/billing/v1/cloudbilling.yaml create mode 100644 google/cloud/billing/v1/cloudbilling_v1.yaml create mode 100644 google/cloud/certificatemanager/v1/certificate_issuance_config.proto create mode 100644 google/cloud/channel/v1/reports_service.proto create mode 100644 google/cloud/dataproc/v1/node_groups.proto create mode 100644 google/cloud/documentai/v1beta3/evaluation.proto create mode 100644 google/cloud/eventarc/v1/google_channel_config.proto create mode 100644 google/cloud/filer/v1beta1/file_grpc_service_config.json create mode 100644 google/cloud/metastore/v1/metastore_federation.proto create mode 100644 google/cloud/metastore/v1alpha/metastore_federation.proto create mode 100644 google/cloud/metastore/v1beta/metastore_federation.proto create mode 100644 google/cloud/networkconnectivity/v1/policy_based_routing.proto create mode 100644 google/cloud/notebooks/v1/diagnostic_config.proto create mode 100644 google/cloud/osconfig/logging/BUILD.bazel create mode 100644 google/cloud/osconfig/logging/patch_job_log.proto create mode 100644 google/cloud/paymentgateway/issuerswitch/v1/logs.proto create mode 100644 google/cloud/run/v2/execution.proto create mode 100644 google/cloud/run/v2/execution_template.proto create mode 100644 google/cloud/run/v2/job.proto create mode 100644 google/cloud/run/v2/task.proto create mode 100644 google/cloud/run/v2/task_template.proto create mode 100644 google/cloud/securitycenter/v1/kernel_rootkit.proto create mode 100644 google/cloud/storageinsights/v1/BUILD.bazel create mode 100644 google/cloud/storageinsights/v1/storageinsights.proto create mode 100644 google/cloud/storageinsights/v1/storageinsights_grpc_service_config.json create mode 100644 google/cloud/storageinsights/v1/storageinsights_v1.yaml create mode 100644 google/cloud/texttospeech/v1/cloud_tts_lrs.proto create mode 100644 google/cloud/texttospeech/v1beta1/cloud_tts_lrs.proto rename google/cloud/{bigquery/reservation/v1beta1 => tpu/v2}/BUILD.bazel (51%) create mode 100644 google/cloud/tpu/v2/cloud_tpu.proto create mode 100644 google/cloud/tpu/v2/tpu_grpc_service_config.json create mode 100644 google/cloud/tpu/v2/tpu_v2.yaml rename google/cloud/tpu/v2alpha1/{tpu.yaml => tpu_v2alpha1.yaml} (86%) create mode 100644 google/cloud/v1beta1/cloudscheduler_grpc_service_config.json create mode 100644 google/cloud/visionai/v1/BUILD.bazel create mode 100644 google/cloud/visionai/v1/annotations.proto create mode 100644 google/cloud/visionai/v1/common.proto create mode 100644 google/cloud/visionai/v1/lva.proto create mode 100644 google/cloud/visionai/v1/lva_resources.proto create mode 100644 google/cloud/visionai/v1/lva_service.proto create mode 100644 google/cloud/visionai/v1/platform.proto create mode 100644 google/cloud/visionai/v1/streaming_resources.proto create mode 100644 google/cloud/visionai/v1/streaming_service.proto create mode 100644 google/cloud/visionai/v1/streams_resources.proto create mode 100644 google/cloud/visionai/v1/streams_service.proto create mode 100644 google/cloud/visionai/v1/visionai_grpc_service_config.json create mode 100644 google/cloud/visionai/v1/visionai_v1.yaml create mode 100644 google/cloud/visionai/v1/warehouse.proto create mode 100644 google/cloud/visionai/v1alpha1/BUILD.bazel create mode 100644 google/cloud/visionai/v1alpha1/annotations.proto create mode 100644 google/cloud/visionai/v1alpha1/common.proto create mode 100644 google/cloud/visionai/v1alpha1/lva.proto create mode 100644 google/cloud/visionai/v1alpha1/lva_resources.proto create mode 100644 google/cloud/visionai/v1alpha1/lva_service.proto create mode 100644 google/cloud/visionai/v1alpha1/platform.proto create mode 100644 google/cloud/visionai/v1alpha1/streaming_resources.proto create mode 100644 google/cloud/visionai/v1alpha1/streaming_service.proto create mode 100644 google/cloud/visionai/v1alpha1/streams_resources.proto create mode 100644 google/cloud/visionai/v1alpha1/streams_service.proto create mode 100644 google/cloud/visionai/v1alpha1/visionai_grpc_service_config.json create mode 100644 google/cloud/visionai/v1alpha1/visionai_v1alpha1.yaml create mode 100644 google/cloud/visionai/v1alpha1/warehouse.proto create mode 100644 google/cloud/vmwareengine/BUILD.bazel create mode 100644 google/cloud/vmwareengine/v1/BUILD.bazel create mode 100644 google/cloud/vmwareengine/v1/vmwareengine.proto create mode 100644 google/cloud/vmwareengine/v1/vmwareengine_grpc_service_config.json create mode 100644 google/cloud/vmwareengine/v1/vmwareengine_v1.yaml create mode 100644 google/datastore/v1/aggregation_result.proto create mode 100644 google/maps/routing/v2/route_label.proto create mode 100644 google/rpc/context/audit_context.proto create mode 100644 google/rpc/http.proto diff --git a/WORKSPACE b/WORKSPACE index 17e6d4f03..d3121d874 100644 --- a/WORKSPACE +++ b/WORKSPACE @@ -60,9 +60,9 @@ rules_pkg_dependencies() http_archive( name = "com_google_protobuf", - sha256 = "c29d8b4b79389463c546f98b15aa4391d4ed7ec459340c47bffe15db63eb9126", - strip_prefix = "protobuf-3.21.3", - urls = ["https://github.com/protocolbuffers/protobuf/archive/v3.21.3.tar.gz"], + sha256 = "ce2fbea3c78147a41b2a922485d283137845303e5e1b6cbd7ece94b96ade7031", + strip_prefix = "protobuf-3.21.7", + urls = ["https://github.com/protocolbuffers/protobuf/archive/v3.21.7.tar.gz"], ) load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps") @@ -111,9 +111,9 @@ 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.17.0" +_rules_gapic_version = "0.19.2" -_rules_gapic_sha256 = "3fd8b13f0b801c5efc1bb24cf08c33ddc61793ba48818154058c2c533dfc11c5" +_rules_gapic_sha256 = "8eff349ac8c3e306db603c8e00ac6d30c59138bb65cabf0f69bf79d23905eec4" http_archive( name = "rules_gapic", @@ -138,7 +138,18 @@ http_archive( ], ) -_gapic_generator_go_version = "0.32.1" +# 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") + +go_repository( + name = "com_google_cloud_go_longrunning", + importpath = "cloud.google.com/go/longrunning", + sum = "h1:y50CXG4j0+qvEukslYFBCrzaXX0qpFbBzc3PchSu/LE=", + version = "v0.1.1", +) + +_gapic_generator_go_version = "0.33.5" http_archive( name = "com_googleapis_gapic_generator_go", @@ -244,7 +255,7 @@ maven_install( ], ) -_gax_java_version = "2.19.0" +_gax_java_version = "2.19.4" http_archive( name = "com_google_api_gax_java", @@ -269,7 +280,7 @@ 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.10.0" +_gapic_generator_java_version = "2.11.0" http_archive( name = "gapic_generator_java", @@ -292,7 +303,7 @@ load("@rules_python//python:pip.bzl", "pip_install") pip_install() -_gapic_generator_python_version = "1.4.4" +_gapic_generator_python_version = "1.7.1" http_archive( name = "gapic_generator_python", @@ -347,7 +358,7 @@ yarn_install( ############################################################################## # PHP micro-generator -_gapic_generator_php_version = "1.5.0" +_gapic_generator_php_version = "1.6.3" http_archive( name = "gapic_generator_php", @@ -388,9 +399,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.8" +_gapic_generator_csharp_version = "1.4.9" -_gapic_generator_csharp_sha256 = "1c155829aabb32a1e94fb9c4fe70054d683b1142fe7853c01f3adc3d5b184a6e" +_gapic_generator_csharp_sha256 = "b3641de24520ca9efa34146c447f89055fc4f803275501947d0fb7b1fa7aad49" http_archive( name = "gapic_generator_csharp", @@ -403,35 +414,13 @@ load("@gapic_generator_csharp//:repositories.bzl", "gapic_generator_csharp_repos gapic_generator_csharp_repositories() -# Version of C# generator targeting GAX v3. This is present so that teams that -# do not want to move immediately to GAX v4 when it comes out (e.g. Ads) are -# able to stick with the GAX-v3-based generator. - -_gapic_generator_csharp_gax_v3_version = "1.3.20" - -_gapic_generator_csharp_gax_v3_sha256 = "20cacae7641c51eda434adb1279716030def82c2617f4d3507ba56478ff879f9" - -http_archive( - name = "gapic_generator_csharp_gax_v3", - repo_mapping = { - "@gapic_generator_restore": "@gapic_generator_restore_gax_v3", - }, - sha256 = _gapic_generator_csharp_gax_v3_sha256, - strip_prefix = "gapic-generator-csharp-%s" % _gapic_generator_csharp_gax_v3_version, - urls = ["https://github.com/googleapis/gapic-generator-csharp/archive/refs/tags/v%s.tar.gz" % _gapic_generator_csharp_gax_v3_version], -) - -load("@gapic_generator_csharp_gax_v3//:repositories.bzl", gapic_generator_csharp_repositories_gax_v3 = "gapic_generator_csharp_repositories") - -gapic_generator_csharp_repositories_gax_v3(gapic_generator_suffix = "_gax_v3") - ############################################################################## # Ruby ############################################################################## -_gapic_generator_ruby_version = "v0.16.1" +_gapic_generator_ruby_version = "v0.18.1" -_gapic_generator_ruby_sha256 = "b99c5a7cdbbdc0c7dc4314c5327f164e3a0c7ff3eb896096a3fa86098cba8fd6" +_gapic_generator_ruby_sha256 = "510337661a2668583748cae9b55282ee0b359bed96858abdc3f4924f3dc1c3b3" http_archive( name = "gapic_generator_ruby", diff --git a/api-index-v1.json b/api-index-v1.json index d26ad7ec8..69cdbeaa0 100644 --- a/api-index-v1.json +++ b/api-index-v1.json @@ -208,7 +208,8 @@ "serviceConfigApiNames": [ "google.actions.sdk.v2.ActionsSdk", "google.actions.sdk.v2.ActionsTesting" - ] + ], + "nameInServiceConfig": "actions.googleapis.com" }, { "id": "google.ads.googleads.v10", @@ -2555,7 +2556,8 @@ "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", @@ -4953,22 +4955,23 @@ "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.v9", - "directory": "google/ads/googleads/v9", - "version": "v9", - "majorVersion": "v9", + "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/v9/common", - "google/ads/googleads/v9/enums", - "google/ads/googleads/v9/errors", - "google/ads/googleads/v9/resources", - "google/ads/googleads/v9/services", + "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", @@ -4977,118 +4980,73 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Ads.GoogleAds.V9.Common": 32, - "Google.Ads.GoogleAds.V9.Enums": 281, - "Google.Ads.GoogleAds.V9.Errors": 135, - "Google.Ads.GoogleAds.V9.Resources": 149, - "Google.Ads.GoogleAds.V9.Services": 152 + "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/v9/common;common": 32, - "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums": 281, - "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors": 135, - "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources": 149, - "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services": 152 + "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": 749 + "true": 742 } }, "java_package": { "valueCounts": { - "com.google.ads.googleads.v9.common": 32, - "com.google.ads.googleads.v9.enums": 281, - "com.google.ads.googleads.v9.errors": 135, - "com.google.ads.googleads.v9.resources": 149, - "com.google.ads.googleads.v9.services": 152 + "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": 749 + "GAA": 742 } }, "php_namespace": { "valueCounts": { - "Google\\Ads\\GoogleAds\\V9\\Common": 32, - "Google\\Ads\\GoogleAds\\V9\\Enums": 281, - "Google\\Ads\\GoogleAds\\V9\\Errors": 135, - "Google\\Ads\\GoogleAds\\V9\\Resources": 149, - "Google\\Ads\\GoogleAds\\V9\\Services": 152 + "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::V9::Common": 32, - "Google::Ads::GoogleAds::V9::Enums": 281, - "Google::Ads::GoogleAds::V9::Errors": 135, - "Google::Ads::GoogleAds::V9::Resources": 149, - "Google::Ads::GoogleAds::V9::Services": 152 + "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": "AccessibleBiddingStrategyService", - "fullName": "google.ads.googleads.v9.services.AccessibleBiddingStrategyService", - "methods": [ - { - "shortName": "GetAccessibleBiddingStrategy", - "fullName": "google.ads.googleads.v9.services.AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/accessibleBiddingStrategies/*}" - } - ] - } - ] - }, { "shortName": "AccountBudgetProposalService", - "fullName": "google.ads.googleads.v9.services.AccountBudgetProposalService", + "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService", "methods": [ - { - "shortName": "GetAccountBudgetProposal", - "fullName": "google.ads.googleads.v9.services.AccountBudgetProposalService.GetAccountBudgetProposal", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/accountBudgetProposals/*}" - } - ] - }, { "shortName": "MutateAccountBudgetProposal", - "fullName": "google.ads.googleads.v9.services.AccountBudgetProposalService.MutateAccountBudgetProposal", + "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/accountBudgetProposals:mutate" - } - ] - } - ] - }, - { - "shortName": "AccountBudgetService", - "fullName": "google.ads.googleads.v9.services.AccountBudgetService", - "methods": [ - { - "shortName": "GetAccountBudget", - "fullName": "google.ads.googleads.v9.services.AccountBudgetService.GetAccountBudget", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/accountBudgets/*}" + "path": "/v12/customers/{customer_id=*}/accountBudgetProposals:mutate" } ] } @@ -5096,55 +5054,27 @@ }, { "shortName": "AccountLinkService", - "fullName": "google.ads.googleads.v9.services.AccountLinkService", + "fullName": "google.ads.googleads.v12.services.AccountLinkService", "methods": [ { "shortName": "CreateAccountLink", - "fullName": "google.ads.googleads.v9.services.AccountLinkService.CreateAccountLink", + "fullName": "google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/accountLinks:create" - } - ] - }, - { - "shortName": "GetAccountLink", - "fullName": "google.ads.googleads.v9.services.AccountLinkService.GetAccountLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/accountLinks/*}" + "path": "/v12/customers/{customer_id=*}/accountLinks:create" } ] }, { "shortName": "MutateAccountLink", - "fullName": "google.ads.googleads.v9.services.AccountLinkService.MutateAccountLink", + "fullName": "google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/accountLinks:mutate" - } - ] - } - ] - }, - { - "shortName": "AdGroupAdAssetViewService", - "fullName": "google.ads.googleads.v9.services.AdGroupAdAssetViewService", - "methods": [ - { - "shortName": "GetAdGroupAdAssetView", - "fullName": "google.ads.googleads.v9.services.AdGroupAdAssetViewService.GetAdGroupAdAssetView", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupAdAssetViews/*}" + "path": "/v12/customers/{customer_id=*}/accountLinks:mutate" } ] } @@ -5152,27 +5082,16 @@ }, { "shortName": "AdGroupAdLabelService", - "fullName": "google.ads.googleads.v9.services.AdGroupAdLabelService", + "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService", "methods": [ - { - "shortName": "GetAdGroupAdLabel", - "fullName": "google.ads.googleads.v9.services.AdGroupAdLabelService.GetAdGroupAdLabel", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupAdLabels/*}" - } - ] - }, { "shortName": "MutateAdGroupAdLabels", - "fullName": "google.ads.googleads.v9.services.AdGroupAdLabelService.MutateAdGroupAdLabels", + "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService.MutateAdGroupAdLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupAdLabels:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupAdLabels:mutate" } ] } @@ -5180,27 +5099,16 @@ }, { "shortName": "AdGroupAdService", - "fullName": "google.ads.googleads.v9.services.AdGroupAdService", + "fullName": "google.ads.googleads.v12.services.AdGroupAdService", "methods": [ - { - "shortName": "GetAdGroupAd", - "fullName": "google.ads.googleads.v9.services.AdGroupAdService.GetAdGroupAd", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupAds/*}" - } - ] - }, { "shortName": "MutateAdGroupAds", - "fullName": "google.ads.googleads.v9.services.AdGroupAdService.MutateAdGroupAds", + "fullName": "google.ads.googleads.v12.services.AdGroupAdService.MutateAdGroupAds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupAds:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupAds:mutate" } ] } @@ -5208,44 +5116,33 @@ }, { "shortName": "AdGroupAssetService", - "fullName": "google.ads.googleads.v9.services.AdGroupAssetService", + "fullName": "google.ads.googleads.v12.services.AdGroupAssetService", "methods": [ - { - "shortName": "GetAdGroupAsset", - "fullName": "google.ads.googleads.v9.services.AdGroupAssetService.GetAdGroupAsset", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupAssets/*}" - } - ] - }, { "shortName": "MutateAdGroupAssets", - "fullName": "google.ads.googleads.v9.services.AdGroupAssetService.MutateAdGroupAssets", + "fullName": "google.ads.googleads.v12.services.AdGroupAssetService.MutateAdGroupAssets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupAssets:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupAssets:mutate" } ] } ] }, { - "shortName": "AdGroupAudienceViewService", - "fullName": "google.ads.googleads.v9.services.AdGroupAudienceViewService", + "shortName": "AdGroupAssetSetService", + "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService", "methods": [ { - "shortName": "GetAdGroupAudienceView", - "fullName": "google.ads.googleads.v9.services.AdGroupAudienceViewService.GetAdGroupAudienceView", + "shortName": "MutateAdGroupAssetSets", + "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService.MutateAdGroupAssetSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupAudienceViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/adGroupAssetSets:mutate" } ] } @@ -5253,27 +5150,16 @@ }, { "shortName": "AdGroupBidModifierService", - "fullName": "google.ads.googleads.v9.services.AdGroupBidModifierService", + "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService", "methods": [ - { - "shortName": "GetAdGroupBidModifier", - "fullName": "google.ads.googleads.v9.services.AdGroupBidModifierService.GetAdGroupBidModifier", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupBidModifiers/*}" - } - ] - }, { "shortName": "MutateAdGroupBidModifiers", - "fullName": "google.ads.googleads.v9.services.AdGroupBidModifierService.MutateAdGroupBidModifiers", + "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupBidModifiers:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupBidModifiers:mutate" } ] } @@ -5281,16 +5167,16 @@ }, { "shortName": "AdGroupCriterionCustomizerService", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionCustomizerService", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService", "methods": [ { "shortName": "MutateAdGroupCriterionCustomizers", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate" + "path": "/v12/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate" } ] } @@ -5298,27 +5184,16 @@ }, { "shortName": "AdGroupCriterionLabelService", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionLabelService", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService", "methods": [ - { - "shortName": "GetAdGroupCriterionLabel", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupCriterionLabels/*}" - } - ] - }, { "shortName": "MutateAdGroupCriterionLabels", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupCriterionLabels:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupCriterionLabels:mutate" } ] } @@ -5326,44 +5201,16 @@ }, { "shortName": "AdGroupCriterionService", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionService", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService", "methods": [ - { - "shortName": "GetAdGroupCriterion", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionService.GetAdGroupCriterion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupCriteria/*}" - } - ] - }, { "shortName": "MutateAdGroupCriteria", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionService.MutateAdGroupCriteria", + "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupCriteria:mutate" - } - ] - } - ] - }, - { - "shortName": "AdGroupCriterionSimulationService", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionSimulationService", - "methods": [ - { - "shortName": "GetAdGroupCriterionSimulation", - "fullName": "google.ads.googleads.v9.services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupCriterionSimulations/*}" + "path": "/v12/customers/{customer_id=*}/adGroupCriteria:mutate" } ] } @@ -5371,16 +5218,16 @@ }, { "shortName": "AdGroupCustomizerService", - "fullName": "google.ads.googleads.v9.services.AdGroupCustomizerService", + "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService", "methods": [ { "shortName": "MutateAdGroupCustomizers", - "fullName": "google.ads.googleads.v9.services.AdGroupCustomizerService.MutateAdGroupCustomizers", + "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupCustomizers:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupCustomizers:mutate" } ] } @@ -5388,27 +5235,16 @@ }, { "shortName": "AdGroupExtensionSettingService", - "fullName": "google.ads.googleads.v9.services.AdGroupExtensionSettingService", + "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService", "methods": [ - { - "shortName": "GetAdGroupExtensionSetting", - "fullName": "google.ads.googleads.v9.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupExtensionSettings/*}" - } - ] - }, { "shortName": "MutateAdGroupExtensionSettings", - "fullName": "google.ads.googleads.v9.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings", + "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupExtensionSettings:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupExtensionSettings:mutate" } ] } @@ -5416,27 +5252,16 @@ }, { "shortName": "AdGroupFeedService", - "fullName": "google.ads.googleads.v9.services.AdGroupFeedService", + "fullName": "google.ads.googleads.v12.services.AdGroupFeedService", "methods": [ - { - "shortName": "GetAdGroupFeed", - "fullName": "google.ads.googleads.v9.services.AdGroupFeedService.GetAdGroupFeed", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupFeeds/*}" - } - ] - }, { "shortName": "MutateAdGroupFeeds", - "fullName": "google.ads.googleads.v9.services.AdGroupFeedService.MutateAdGroupFeeds", + "fullName": "google.ads.googleads.v12.services.AdGroupFeedService.MutateAdGroupFeeds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupFeeds:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupFeeds:mutate" } ] } @@ -5444,27 +5269,16 @@ }, { "shortName": "AdGroupLabelService", - "fullName": "google.ads.googleads.v9.services.AdGroupLabelService", + "fullName": "google.ads.googleads.v12.services.AdGroupLabelService", "methods": [ - { - "shortName": "GetAdGroupLabel", - "fullName": "google.ads.googleads.v9.services.AdGroupLabelService.GetAdGroupLabel", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupLabels/*}" - } - ] - }, { "shortName": "MutateAdGroupLabels", - "fullName": "google.ads.googleads.v9.services.AdGroupLabelService.MutateAdGroupLabels", + "fullName": "google.ads.googleads.v12.services.AdGroupLabelService.MutateAdGroupLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroupLabels:mutate" + "path": "/v12/customers/{customer_id=*}/adGroupLabels:mutate" } ] } @@ -5472,286 +5286,247 @@ }, { "shortName": "AdGroupService", - "fullName": "google.ads.googleads.v9.services.AdGroupService", + "fullName": "google.ads.googleads.v12.services.AdGroupService", "methods": [ - { - "shortName": "GetAdGroup", - "fullName": "google.ads.googleads.v9.services.AdGroupService.GetAdGroup", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroups/*}" - } - ] - }, { "shortName": "MutateAdGroups", - "fullName": "google.ads.googleads.v9.services.AdGroupService.MutateAdGroups", + "fullName": "google.ads.googleads.v12.services.AdGroupService.MutateAdGroups", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adGroups:mutate" + "path": "/v12/customers/{customer_id=*}/adGroups:mutate" } ] } ] }, { - "shortName": "AdGroupSimulationService", - "fullName": "google.ads.googleads.v9.services.AdGroupSimulationService", + "shortName": "AdParameterService", + "fullName": "google.ads.googleads.v12.services.AdParameterService", "methods": [ { - "shortName": "GetAdGroupSimulation", - "fullName": "google.ads.googleads.v9.services.AdGroupSimulationService.GetAdGroupSimulation", + "shortName": "MutateAdParameters", + "fullName": "google.ads.googleads.v12.services.AdParameterService.MutateAdParameters", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adGroupSimulations/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/adParameters:mutate" } ] } ] }, { - "shortName": "AdParameterService", - "fullName": "google.ads.googleads.v9.services.AdParameterService", + "shortName": "AdService", + "fullName": "google.ads.googleads.v12.services.AdService", "methods": [ { - "shortName": "GetAdParameter", - "fullName": "google.ads.googleads.v9.services.AdParameterService.GetAdParameter", + "shortName": "GetAd", + "fullName": "google.ads.googleads.v12.services.AdService.GetAd", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adParameters/*}" + "path": "/v12/{resource_name=customers/*/ads/*}" } ] }, { - "shortName": "MutateAdParameters", - "fullName": "google.ads.googleads.v9.services.AdParameterService.MutateAdParameters", + "shortName": "MutateAds", + "fullName": "google.ads.googleads.v12.services.AdService.MutateAds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/adParameters:mutate" + "path": "/v12/customers/{customer_id=*}/ads:mutate" } ] } ] }, { - "shortName": "AdScheduleViewService", - "fullName": "google.ads.googleads.v9.services.AdScheduleViewService", + "shortName": "AssetGroupAssetService", + "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService", "methods": [ { - "shortName": "GetAdScheduleView", - "fullName": "google.ads.googleads.v9.services.AdScheduleViewService.GetAdScheduleView", + "shortName": "MutateAssetGroupAssets", + "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/adScheduleViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/assetGroupAssets:mutate" } ] } ] }, { - "shortName": "AdService", - "fullName": "google.ads.googleads.v9.services.AdService", + "shortName": "AssetGroupListingGroupFilterService", + "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService", "methods": [ { - "shortName": "GetAd", - "fullName": "google.ads.googleads.v9.services.AdService.GetAd", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/ads/*}" - } - ] - }, - { - "shortName": "MutateAds", - "fullName": "google.ads.googleads.v9.services.AdService.MutateAds", + "shortName": "MutateAssetGroupListingGroupFilters", + "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/ads:mutate" + "path": "/v12/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate" } ] } ] }, { - "shortName": "AgeRangeViewService", - "fullName": "google.ads.googleads.v9.services.AgeRangeViewService", + "shortName": "AssetGroupService", + "fullName": "google.ads.googleads.v12.services.AssetGroupService", "methods": [ { - "shortName": "GetAgeRangeView", - "fullName": "google.ads.googleads.v9.services.AgeRangeViewService.GetAgeRangeView", + "shortName": "MutateAssetGroups", + "fullName": "google.ads.googleads.v12.services.AssetGroupService.MutateAssetGroups", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/ageRangeViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/assetGroups:mutate" } ] } ] }, { - "shortName": "AssetFieldTypeViewService", - "fullName": "google.ads.googleads.v9.services.AssetFieldTypeViewService", + "shortName": "AssetGroupSignalService", + "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService", "methods": [ { - "shortName": "GetAssetFieldTypeView", - "fullName": "google.ads.googleads.v9.services.AssetFieldTypeViewService.GetAssetFieldTypeView", + "shortName": "MutateAssetGroupSignals", + "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/assetFieldTypeViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/assetGroupSignals:mutate" } ] } ] }, { - "shortName": "AssetGroupAssetService", - "fullName": "google.ads.googleads.v9.services.AssetGroupAssetService", + "shortName": "AssetService", + "fullName": "google.ads.googleads.v12.services.AssetService", "methods": [ { - "shortName": "GetAssetGroupAsset", - "fullName": "google.ads.googleads.v9.services.AssetGroupAssetService.GetAssetGroupAsset", + "shortName": "MutateAssets", + "fullName": "google.ads.googleads.v12.services.AssetService.MutateAssets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/assetGroupAssets/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/assets:mutate" } ] - }, + } + ] + }, + { + "shortName": "AssetSetAssetService", + "fullName": "google.ads.googleads.v12.services.AssetSetAssetService", + "methods": [ { - "shortName": "MutateAssetGroupAssets", - "fullName": "google.ads.googleads.v9.services.AssetGroupAssetService.MutateAssetGroupAssets", + "shortName": "MutateAssetSetAssets", + "fullName": "google.ads.googleads.v12.services.AssetSetAssetService.MutateAssetSetAssets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assetGroupAssets:mutate" + "path": "/v12/customers/{customer_id=*}/assetSetAssets:mutate" } ] } ] }, { - "shortName": "AssetGroupListingGroupFilterService", - "fullName": "google.ads.googleads.v9.services.AssetGroupListingGroupFilterService", + "shortName": "AssetSetService", + "fullName": "google.ads.googleads.v12.services.AssetSetService", "methods": [ { - "shortName": "MutateAssetGroupListingGroupFilters", - "fullName": "google.ads.googleads.v9.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters", + "shortName": "MutateAssetSets", + "fullName": "google.ads.googleads.v12.services.AssetSetService.MutateAssetSets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate" + "path": "/v12/customers/{customer_id=*}/assetSets:mutate" } ] } ] }, { - "shortName": "AssetGroupService", - "fullName": "google.ads.googleads.v9.services.AssetGroupService", + "shortName": "AudienceInsightsService", + "fullName": "google.ads.googleads.v12.services.AudienceInsightsService", "methods": [ { - "shortName": "GetAssetGroup", - "fullName": "google.ads.googleads.v9.services.AssetGroupService.GetAssetGroup", + "shortName": "GenerateAudienceCompositionInsights", + "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateAudienceCompositionInsights", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/assetGroups/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}:generateAudienceCompositionInsights" } ] }, { - "shortName": "MutateAssetGroups", - "fullName": "google.ads.googleads.v9.services.AssetGroupService.MutateAssetGroups", + "shortName": "GenerateInsightsFinderReport", + "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateInsightsFinderReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assetGroups:mutate" - } - ] - } - ] - }, - { - "shortName": "AssetService", - "fullName": "google.ads.googleads.v9.services.AssetService", - "methods": [ - { - "shortName": "GetAsset", - "fullName": "google.ads.googleads.v9.services.AssetService.GetAsset", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/assets/*}" + "path": "/v12/customers/{customer_id=*}:generateInsightsFinderReport" } ] }, { - "shortName": "MutateAssets", - "fullName": "google.ads.googleads.v9.services.AssetService.MutateAssets", + "shortName": "ListAudienceInsightsAttributes", + "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListAudienceInsightsAttributes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assets:mutate" + "path": "/v12/customers/{customer_id=*}:searchAudienceInsightsAttributes" } ] - } - ] - }, - { - "shortName": "AssetSetAssetService", - "fullName": "google.ads.googleads.v9.services.AssetSetAssetService", - "methods": [ + }, { - "shortName": "MutateAssetSetAssets", - "fullName": "google.ads.googleads.v9.services.AssetSetAssetService.MutateAssetSetAssets", + "shortName": "ListInsightsEligibleDates", + "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListInsightsEligibleDates", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assetSetAssets:mutate" + "path": "/v12/audienceInsights:listInsightsEligibleDates" } ] } ] }, { - "shortName": "AssetSetService", - "fullName": "google.ads.googleads.v9.services.AssetSetService", + "shortName": "AudienceService", + "fullName": "google.ads.googleads.v12.services.AudienceService", "methods": [ { - "shortName": "MutateAssetSets", - "fullName": "google.ads.googleads.v9.services.AssetSetService.MutateAssetSets", + "shortName": "MutateAudiences", + "fullName": "google.ads.googleads.v12.services.AudienceService.MutateAudiences", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/assetSets:mutate" + "path": "/v12/customers/{customer_id=*}/audiences:mutate" } ] } @@ -5759,60 +5534,49 @@ }, { "shortName": "BatchJobService", - "fullName": "google.ads.googleads.v9.services.BatchJobService", + "fullName": "google.ads.googleads.v12.services.BatchJobService", "methods": [ { "shortName": "AddBatchJobOperations", - "fullName": "google.ads.googleads.v9.services.BatchJobService.AddBatchJobOperations", + "fullName": "google.ads.googleads.v12.services.BatchJobService.AddBatchJobOperations", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{resource_name=customers/*/batchJobs/*}:addOperations" - } - ] - }, - { - "shortName": "GetBatchJob", - "fullName": "google.ads.googleads.v9.services.BatchJobService.GetBatchJob", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/batchJobs/*}" + "path": "/v12/{resource_name=customers/*/batchJobs/*}:addOperations" } ] }, { "shortName": "ListBatchJobResults", - "fullName": "google.ads.googleads.v9.services.BatchJobService.ListBatchJobResults", + "fullName": "google.ads.googleads.v12.services.BatchJobService.ListBatchJobResults", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/batchJobs/*}:listResults" + "path": "/v12/{resource_name=customers/*/batchJobs/*}:listResults" } ] }, { "shortName": "MutateBatchJob", - "fullName": "google.ads.googleads.v9.services.BatchJobService.MutateBatchJob", + "fullName": "google.ads.googleads.v12.services.BatchJobService.MutateBatchJob", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/batchJobs:mutate" + "path": "/v12/customers/{customer_id=*}/batchJobs:mutate" } ] }, { "shortName": "RunBatchJob", - "fullName": "google.ads.googleads.v9.services.BatchJobService.RunBatchJob", + "fullName": "google.ads.googleads.v12.services.BatchJobService.RunBatchJob", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{resource_name=customers/*/batchJobs/*}:run" + "path": "/v12/{resource_name=customers/*/batchJobs/*}:run" } ] } @@ -5820,27 +5584,16 @@ }, { "shortName": "BiddingDataExclusionService", - "fullName": "google.ads.googleads.v9.services.BiddingDataExclusionService", + "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService", "methods": [ - { - "shortName": "GetBiddingDataExclusion", - "fullName": "google.ads.googleads.v9.services.BiddingDataExclusionService.GetBiddingDataExclusion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/biddingDataExclusions/*}" - } - ] - }, { "shortName": "MutateBiddingDataExclusions", - "fullName": "google.ads.googleads.v9.services.BiddingDataExclusionService.MutateBiddingDataExclusions", + "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService.MutateBiddingDataExclusions", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/biddingDataExclusions:mutate" + "path": "/v12/customers/{customer_id=*}/biddingDataExclusions:mutate" } ] } @@ -5848,27 +5601,16 @@ }, { "shortName": "BiddingSeasonalityAdjustmentService", - "fullName": "google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService", + "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService", "methods": [ - { - "shortName": "GetBiddingSeasonalityAdjustment", - "fullName": "google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/biddingSeasonalityAdjustments/*}" - } - ] - }, { "shortName": "MutateBiddingSeasonalityAdjustments", - "fullName": "google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments", + "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate" + "path": "/v12/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate" } ] } @@ -5876,44 +5618,16 @@ }, { "shortName": "BiddingStrategyService", - "fullName": "google.ads.googleads.v9.services.BiddingStrategyService", + "fullName": "google.ads.googleads.v12.services.BiddingStrategyService", "methods": [ - { - "shortName": "GetBiddingStrategy", - "fullName": "google.ads.googleads.v9.services.BiddingStrategyService.GetBiddingStrategy", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/biddingStrategies/*}" - } - ] - }, { "shortName": "MutateBiddingStrategies", - "fullName": "google.ads.googleads.v9.services.BiddingStrategyService.MutateBiddingStrategies", + "fullName": "google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/biddingStrategies:mutate" - } - ] - } - ] - }, - { - "shortName": "BiddingStrategySimulationService", - "fullName": "google.ads.googleads.v9.services.BiddingStrategySimulationService", - "methods": [ - { - "shortName": "GetBiddingStrategySimulation", - "fullName": "google.ads.googleads.v9.services.BiddingStrategySimulationService.GetBiddingStrategySimulation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/biddingStrategySimulations/*}" + "path": "/v12/customers/{customer_id=*}/biddingStrategies:mutate" } ] } @@ -5921,27 +5635,16 @@ }, { "shortName": "BillingSetupService", - "fullName": "google.ads.googleads.v9.services.BillingSetupService", + "fullName": "google.ads.googleads.v12.services.BillingSetupService", "methods": [ - { - "shortName": "GetBillingSetup", - "fullName": "google.ads.googleads.v9.services.BillingSetupService.GetBillingSetup", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/billingSetups/*}" - } - ] - }, { "shortName": "MutateBillingSetup", - "fullName": "google.ads.googleads.v9.services.BillingSetupService.MutateBillingSetup", + "fullName": "google.ads.googleads.v12.services.BillingSetupService.MutateBillingSetup", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/billingSetups:mutate" + "path": "/v12/customers/{customer_id=*}/billingSetups:mutate" } ] } @@ -5949,27 +5652,16 @@ }, { "shortName": "CampaignAssetService", - "fullName": "google.ads.googleads.v9.services.CampaignAssetService", + "fullName": "google.ads.googleads.v12.services.CampaignAssetService", "methods": [ - { - "shortName": "GetCampaignAsset", - "fullName": "google.ads.googleads.v9.services.CampaignAssetService.GetCampaignAsset", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignAssets/*}" - } - ] - }, { "shortName": "MutateCampaignAssets", - "fullName": "google.ads.googleads.v9.services.CampaignAssetService.MutateCampaignAssets", + "fullName": "google.ads.googleads.v12.services.CampaignAssetService.MutateCampaignAssets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignAssets:mutate" + "path": "/v12/customers/{customer_id=*}/campaignAssets:mutate" } ] } @@ -5977,33 +5669,16 @@ }, { "shortName": "CampaignAssetSetService", - "fullName": "google.ads.googleads.v9.services.CampaignAssetSetService", + "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService", "methods": [ { "shortName": "MutateCampaignAssetSets", - "fullName": "google.ads.googleads.v9.services.CampaignAssetSetService.MutateCampaignAssetSets", + "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignAssetSets:mutate" - } - ] - } - ] - }, - { - "shortName": "CampaignAudienceViewService", - "fullName": "google.ads.googleads.v9.services.CampaignAudienceViewService", - "methods": [ - { - "shortName": "GetCampaignAudienceView", - "fullName": "google.ads.googleads.v9.services.CampaignAudienceViewService.GetCampaignAudienceView", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignAudienceViews/*}" + "path": "/v12/customers/{customer_id=*}/campaignAssetSets:mutate" } ] } @@ -6011,27 +5686,16 @@ }, { "shortName": "CampaignBidModifierService", - "fullName": "google.ads.googleads.v9.services.CampaignBidModifierService", + "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService", "methods": [ - { - "shortName": "GetCampaignBidModifier", - "fullName": "google.ads.googleads.v9.services.CampaignBidModifierService.GetCampaignBidModifier", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignBidModifiers/*}" - } - ] - }, { "shortName": "MutateCampaignBidModifiers", - "fullName": "google.ads.googleads.v9.services.CampaignBidModifierService.MutateCampaignBidModifiers", + "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignBidModifiers:mutate" + "path": "/v12/customers/{customer_id=*}/campaignBidModifiers:mutate" } ] } @@ -6039,27 +5703,16 @@ }, { "shortName": "CampaignBudgetService", - "fullName": "google.ads.googleads.v9.services.CampaignBudgetService", + "fullName": "google.ads.googleads.v12.services.CampaignBudgetService", "methods": [ - { - "shortName": "GetCampaignBudget", - "fullName": "google.ads.googleads.v9.services.CampaignBudgetService.GetCampaignBudget", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignBudgets/*}" - } - ] - }, { "shortName": "MutateCampaignBudgets", - "fullName": "google.ads.googleads.v9.services.CampaignBudgetService.MutateCampaignBudgets", + "fullName": "google.ads.googleads.v12.services.CampaignBudgetService.MutateCampaignBudgets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignBudgets:mutate" + "path": "/v12/customers/{customer_id=*}/campaignBudgets:mutate" } ] } @@ -6067,16 +5720,16 @@ }, { "shortName": "CampaignConversionGoalService", - "fullName": "google.ads.googleads.v9.services.CampaignConversionGoalService", + "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService", "methods": [ { "shortName": "MutateCampaignConversionGoals", - "fullName": "google.ads.googleads.v9.services.CampaignConversionGoalService.MutateCampaignConversionGoals", + "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignConversionGoals:mutate" + "path": "/v12/customers/{customer_id=*}/campaignConversionGoals:mutate" } ] } @@ -6084,44 +5737,16 @@ }, { "shortName": "CampaignCriterionService", - "fullName": "google.ads.googleads.v9.services.CampaignCriterionService", + "fullName": "google.ads.googleads.v12.services.CampaignCriterionService", "methods": [ - { - "shortName": "GetCampaignCriterion", - "fullName": "google.ads.googleads.v9.services.CampaignCriterionService.GetCampaignCriterion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignCriteria/*}" - } - ] - }, { "shortName": "MutateCampaignCriteria", - "fullName": "google.ads.googleads.v9.services.CampaignCriterionService.MutateCampaignCriteria", + "fullName": "google.ads.googleads.v12.services.CampaignCriterionService.MutateCampaignCriteria", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignCriteria:mutate" - } - ] - } - ] - }, - { - "shortName": "CampaignCriterionSimulationService", - "fullName": "google.ads.googleads.v9.services.CampaignCriterionSimulationService", - "methods": [ - { - "shortName": "GetCampaignCriterionSimulation", - "fullName": "google.ads.googleads.v9.services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignCriterionSimulations/*}" + "path": "/v12/customers/{customer_id=*}/campaignCriteria:mutate" } ] } @@ -6129,16 +5754,16 @@ }, { "shortName": "CampaignCustomizerService", - "fullName": "google.ads.googleads.v9.services.CampaignCustomizerService", + "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService", "methods": [ { "shortName": "MutateCampaignCustomizers", - "fullName": "google.ads.googleads.v9.services.CampaignCustomizerService.MutateCampaignCustomizers", + "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignCustomizers:mutate" + "path": "/v12/customers/{customer_id=*}/campaignCustomizers:mutate" } ] } @@ -6146,3729 +5771,3218 @@ }, { "shortName": "CampaignDraftService", - "fullName": "google.ads.googleads.v9.services.CampaignDraftService", + "fullName": "google.ads.googleads.v12.services.CampaignDraftService", "methods": [ - { - "shortName": "GetCampaignDraft", - "fullName": "google.ads.googleads.v9.services.CampaignDraftService.GetCampaignDraft", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignDrafts/*}" - } - ] - }, { "shortName": "ListCampaignDraftAsyncErrors", - "fullName": "google.ads.googleads.v9.services.CampaignDraftService.ListCampaignDraftAsyncErrors", + "fullName": "google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors" + "path": "/v12/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors" } ] }, { "shortName": "MutateCampaignDrafts", - "fullName": "google.ads.googleads.v9.services.CampaignDraftService.MutateCampaignDrafts", + "fullName": "google.ads.googleads.v12.services.CampaignDraftService.MutateCampaignDrafts", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignDrafts:mutate" + "path": "/v12/customers/{customer_id=*}/campaignDrafts:mutate" } ] }, { "shortName": "PromoteCampaignDraft", - "fullName": "google.ads.googleads.v9.services.CampaignDraftService.PromoteCampaignDraft", + "fullName": "google.ads.googleads.v12.services.CampaignDraftService.PromoteCampaignDraft", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{campaign_draft=customers/*/campaignDrafts/*}:promote" + "path": "/v12/{campaign_draft=customers/*/campaignDrafts/*}:promote" } ] } ] }, { - "shortName": "CampaignExperimentService", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService", + "shortName": "CampaignExtensionSettingService", + "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService", "methods": [ { - "shortName": "CreateCampaignExperiment", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.CreateCampaignExperiment", + "shortName": "MutateCampaignExtensionSettings", + "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/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.v9.services.CampaignExperimentService.EndCampaignExperiment", + "shortName": "MutateCampaignFeeds", + "fullName": "google.ads.googleads.v12.services.CampaignFeedService.MutateCampaignFeeds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{campaign_experiment=customers/*/campaignExperiments/*}:end" - } - ] - }, - { - "shortName": "GetCampaignExperiment", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.GetCampaignExperiment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignExperiments/*}" + "path": "/v12/customers/{customer_id=*}/campaignFeeds:mutate" } ] - }, + } + ] + }, + { + "shortName": "CampaignGroupService", + "fullName": "google.ads.googleads.v12.services.CampaignGroupService", + "methods": [ { - "shortName": "GraduateCampaignExperiment", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.GraduateCampaignExperiment", + "shortName": "MutateCampaignGroups", + "fullName": "google.ads.googleads.v12.services.CampaignGroupService.MutateCampaignGroups", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{campaign_experiment=customers/*/campaignExperiments/*}:graduate" - } - ] - }, - { - "shortName": "ListCampaignExperimentAsyncErrors", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors" + "path": "/v12/customers/{customer_id=*}/campaignGroups:mutate" } ] - }, + } + ] + }, + { + "shortName": "CampaignLabelService", + "fullName": "google.ads.googleads.v12.services.CampaignLabelService", + "methods": [ { - "shortName": "MutateCampaignExperiments", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.MutateCampaignExperiments", + "shortName": "MutateCampaignLabels", + "fullName": "google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignExperiments:mutate" + "path": "/v12/customers/{customer_id=*}/campaignLabels:mutate" } ] - }, + } + ] + }, + { + "shortName": "CampaignService", + "fullName": "google.ads.googleads.v12.services.CampaignService", + "methods": [ { - "shortName": "PromoteCampaignExperiment", - "fullName": "google.ads.googleads.v9.services.CampaignExperimentService.PromoteCampaignExperiment", + "shortName": "MutateCampaigns", + "fullName": "google.ads.googleads.v12.services.CampaignService.MutateCampaigns", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{campaign_experiment=customers/*/campaignExperiments/*}:promote" + "path": "/v12/customers/{customer_id=*}/campaigns:mutate" } ] } ] }, { - "shortName": "CampaignExtensionSettingService", - "fullName": "google.ads.googleads.v9.services.CampaignExtensionSettingService", + "shortName": "CampaignSharedSetService", + "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService", "methods": [ { - "shortName": "GetCampaignExtensionSetting", - "fullName": "google.ads.googleads.v9.services.CampaignExtensionSettingService.GetCampaignExtensionSetting", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignExtensionSettings/*}" - } - ] - }, - { - "shortName": "MutateCampaignExtensionSettings", - "fullName": "google.ads.googleads.v9.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings", + "shortName": "MutateCampaignSharedSets", + "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignExtensionSettings:mutate" + "path": "/v12/customers/{customer_id=*}/campaignSharedSets:mutate" } ] } ] }, { - "shortName": "CampaignFeedService", - "fullName": "google.ads.googleads.v9.services.CampaignFeedService", + "shortName": "ConversionActionService", + "fullName": "google.ads.googleads.v12.services.ConversionActionService", "methods": [ { - "shortName": "GetCampaignFeed", - "fullName": "google.ads.googleads.v9.services.CampaignFeedService.GetCampaignFeed", + "shortName": "MutateConversionActions", + "fullName": "google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignFeeds/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/conversionActions:mutate" } ] - }, + } + ] + }, + { + "shortName": "ConversionAdjustmentUploadService", + "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService", + "methods": [ { - "shortName": "MutateCampaignFeeds", - "fullName": "google.ads.googleads.v9.services.CampaignFeedService.MutateCampaignFeeds", + "shortName": "UploadConversionAdjustments", + "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignFeeds:mutate" + "path": "/v12/customers/{customer_id=*}:uploadConversionAdjustments" } ] } ] }, { - "shortName": "CampaignLabelService", - "fullName": "google.ads.googleads.v9.services.CampaignLabelService", + "shortName": "ConversionCustomVariableService", + "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService", "methods": [ { - "shortName": "GetCampaignLabel", - "fullName": "google.ads.googleads.v9.services.CampaignLabelService.GetCampaignLabel", + "shortName": "MutateConversionCustomVariables", + "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignLabels/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/conversionCustomVariables:mutate" } ] - }, + } + ] + }, + { + "shortName": "ConversionGoalCampaignConfigService", + "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService", + "methods": [ { - "shortName": "MutateCampaignLabels", - "fullName": "google.ads.googleads.v9.services.CampaignLabelService.MutateCampaignLabels", + "shortName": "MutateConversionGoalCampaignConfigs", + "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignLabels:mutate" + "path": "/v12/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate" } ] } ] }, { - "shortName": "CampaignService", - "fullName": "google.ads.googleads.v9.services.CampaignService", + "shortName": "ConversionUploadService", + "fullName": "google.ads.googleads.v12.services.ConversionUploadService", "methods": [ { - "shortName": "GetCampaign", - "fullName": "google.ads.googleads.v9.services.CampaignService.GetCampaign", + "shortName": "UploadCallConversions", + "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaigns/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}:uploadCallConversions" } ] }, { - "shortName": "MutateCampaigns", - "fullName": "google.ads.googleads.v9.services.CampaignService.MutateCampaigns", + "shortName": "UploadClickConversions", + "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaigns:mutate" + "path": "/v12/customers/{customer_id=*}:uploadClickConversions" } ] } ] }, { - "shortName": "CampaignSharedSetService", - "fullName": "google.ads.googleads.v9.services.CampaignSharedSetService", + "shortName": "ConversionValueRuleService", + "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService", "methods": [ { - "shortName": "GetCampaignSharedSet", - "fullName": "google.ads.googleads.v9.services.CampaignSharedSetService.GetCampaignSharedSet", + "shortName": "MutateConversionValueRules", + "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignSharedSets/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/conversionValueRules:mutate" } ] - }, + } + ] + }, + { + "shortName": "ConversionValueRuleSetService", + "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService", + "methods": [ { - "shortName": "MutateCampaignSharedSets", - "fullName": "google.ads.googleads.v9.services.CampaignSharedSetService.MutateCampaignSharedSets", + "shortName": "MutateConversionValueRuleSets", + "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/campaignSharedSets:mutate" + "path": "/v12/customers/{customer_id=*}/conversionValueRuleSets:mutate" } ] } ] }, { - "shortName": "CampaignSimulationService", - "fullName": "google.ads.googleads.v9.services.CampaignSimulationService", + "shortName": "CustomAudienceService", + "fullName": "google.ads.googleads.v12.services.CustomAudienceService", "methods": [ { - "shortName": "GetCampaignSimulation", - "fullName": "google.ads.googleads.v9.services.CampaignSimulationService.GetCampaignSimulation", + "shortName": "MutateCustomAudiences", + "fullName": "google.ads.googleads.v12.services.CustomAudienceService.MutateCustomAudiences", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/campaignSimulations/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customAudiences:mutate" } ] } ] }, { - "shortName": "CarrierConstantService", - "fullName": "google.ads.googleads.v9.services.CarrierConstantService", + "shortName": "CustomConversionGoalService", + "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService", "methods": [ { - "shortName": "GetCarrierConstant", - "fullName": "google.ads.googleads.v9.services.CarrierConstantService.GetCarrierConstant", + "shortName": "MutateCustomConversionGoals", + "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=carrierConstants/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customConversionGoals:mutate" } ] } ] }, { - "shortName": "ChangeStatusService", - "fullName": "google.ads.googleads.v9.services.ChangeStatusService", + "shortName": "CustomInterestService", + "fullName": "google.ads.googleads.v12.services.CustomInterestService", "methods": [ { - "shortName": "GetChangeStatus", - "fullName": "google.ads.googleads.v9.services.ChangeStatusService.GetChangeStatus", + "shortName": "MutateCustomInterests", + "fullName": "google.ads.googleads.v12.services.CustomInterestService.MutateCustomInterests", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/changeStatus/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customInterests:mutate" } ] } ] }, { - "shortName": "ClickViewService", - "fullName": "google.ads.googleads.v9.services.ClickViewService", + "shortName": "CustomerAssetService", + "fullName": "google.ads.googleads.v12.services.CustomerAssetService", "methods": [ { - "shortName": "GetClickView", - "fullName": "google.ads.googleads.v9.services.ClickViewService.GetClickView", + "shortName": "MutateCustomerAssets", + "fullName": "google.ads.googleads.v12.services.CustomerAssetService.MutateCustomerAssets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/clickViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerAssets:mutate" } ] } ] }, { - "shortName": "CombinedAudienceService", - "fullName": "google.ads.googleads.v9.services.CombinedAudienceService", + "shortName": "CustomerAssetSetService", + "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService", "methods": [ { - "shortName": "GetCombinedAudience", - "fullName": "google.ads.googleads.v9.services.CombinedAudienceService.GetCombinedAudience", + "shortName": "MutateCustomerAssetSets", + "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService.MutateCustomerAssetSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/combinedAudiences/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerAssetSets:mutate" } ] } ] }, { - "shortName": "ConversionActionService", - "fullName": "google.ads.googleads.v9.services.ConversionActionService", + "shortName": "CustomerClientLinkService", + "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService", "methods": [ { - "shortName": "GetConversionAction", - "fullName": "google.ads.googleads.v9.services.ConversionActionService.GetConversionAction", + "shortName": "MutateCustomerClientLink", + "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService.MutateCustomerClientLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/conversionActions/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerClientLinks:mutate" } ] - }, + } + ] + }, + { + "shortName": "CustomerConversionGoalService", + "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService", + "methods": [ { - "shortName": "MutateConversionActions", - "fullName": "google.ads.googleads.v9.services.ConversionActionService.MutateConversionActions", + "shortName": "MutateCustomerConversionGoals", + "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/conversionActions:mutate" + "path": "/v12/customers/{customer_id=*}/customerConversionGoals:mutate" } ] } ] }, { - "shortName": "ConversionAdjustmentUploadService", - "fullName": "google.ads.googleads.v9.services.ConversionAdjustmentUploadService", + "shortName": "CustomerCustomizerService", + "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService", "methods": [ { - "shortName": "UploadConversionAdjustments", - "fullName": "google.ads.googleads.v9.services.ConversionAdjustmentUploadService.UploadConversionAdjustments", + "shortName": "MutateCustomerCustomizers", + "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:uploadConversionAdjustments" + "path": "/v12/customers/{customer_id=*}/CustomerCustomizers:mutate" } ] } ] }, { - "shortName": "ConversionCustomVariableService", - "fullName": "google.ads.googleads.v9.services.ConversionCustomVariableService", + "shortName": "CustomerExtensionSettingService", + "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService", "methods": [ { - "shortName": "GetConversionCustomVariable", - "fullName": "google.ads.googleads.v9.services.ConversionCustomVariableService.GetConversionCustomVariable", + "shortName": "MutateCustomerExtensionSettings", + "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/conversionCustomVariables/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerExtensionSettings:mutate" } ] - }, + } + ] + }, + { + "shortName": "CustomerFeedService", + "fullName": "google.ads.googleads.v12.services.CustomerFeedService", + "methods": [ { - "shortName": "MutateConversionCustomVariables", - "fullName": "google.ads.googleads.v9.services.ConversionCustomVariableService.MutateConversionCustomVariables", + "shortName": "MutateCustomerFeeds", + "fullName": "google.ads.googleads.v12.services.CustomerFeedService.MutateCustomerFeeds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/conversionCustomVariables:mutate" + "path": "/v12/customers/{customer_id=*}/customerFeeds:mutate" } ] } ] }, { - "shortName": "ConversionGoalCampaignConfigService", - "fullName": "google.ads.googleads.v9.services.ConversionGoalCampaignConfigService", + "shortName": "CustomerLabelService", + "fullName": "google.ads.googleads.v12.services.CustomerLabelService", "methods": [ { - "shortName": "MutateConversionGoalCampaignConfigs", - "fullName": "google.ads.googleads.v9.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs", + "shortName": "MutateCustomerLabels", + "fullName": "google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate" + "path": "/v12/customers/{customer_id=*}/customerLabels:mutate" } ] } ] }, { - "shortName": "ConversionUploadService", - "fullName": "google.ads.googleads.v9.services.ConversionUploadService", + "shortName": "CustomerManagerLinkService", + "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService", "methods": [ { - "shortName": "UploadCallConversions", - "fullName": "google.ads.googleads.v9.services.ConversionUploadService.UploadCallConversions", + "shortName": "MoveManagerLink", + "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MoveManagerLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:uploadCallConversions" + "path": "/v12/customers/{customer_id=*}/customerManagerLinks:moveManagerLink" } ] }, { - "shortName": "UploadClickConversions", - "fullName": "google.ads.googleads.v9.services.ConversionUploadService.UploadClickConversions", + "shortName": "MutateCustomerManagerLink", + "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:uploadClickConversions" + "path": "/v12/customers/{customer_id=*}/customerManagerLinks:mutate" } ] } ] }, { - "shortName": "ConversionValueRuleService", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleService", + "shortName": "CustomerNegativeCriterionService", + "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService", "methods": [ { - "shortName": "GetConversionValueRule", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleService.GetConversionValueRule", + "shortName": "MutateCustomerNegativeCriteria", + "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/conversionValueRules/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerNegativeCriteria:mutate" } ] - }, + } + ] + }, + { + "shortName": "CustomerService", + "fullName": "google.ads.googleads.v12.services.CustomerService", + "methods": [ { - "shortName": "MutateConversionValueRules", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleService.MutateConversionValueRules", + "shortName": "CreateCustomerClient", + "fullName": "google.ads.googleads.v12.services.CustomerService.CreateCustomerClient", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/conversionValueRules:mutate" + "path": "/v12/customers/{customer_id=*}:createCustomerClient" } ] - } - ] - }, - { - "shortName": "ConversionValueRuleSetService", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleSetService", - "methods": [ + }, { - "shortName": "GetConversionValueRuleSet", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleSetService.GetConversionValueRuleSet", + "shortName": "ListAccessibleCustomers", + "fullName": "google.ads.googleads.v12.services.CustomerService.ListAccessibleCustomers", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/conversionValueRuleSets/*}" + "path": "/v12/customers:listAccessibleCustomers" } ] }, { - "shortName": "MutateConversionValueRuleSets", - "fullName": "google.ads.googleads.v9.services.ConversionValueRuleSetService.MutateConversionValueRuleSets", + "shortName": "MutateCustomer", + "fullName": "google.ads.googleads.v12.services.CustomerService.MutateCustomer", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/conversionValueRuleSets:mutate" + "path": "/v12/customers/{customer_id=*}:mutate" } ] } ] }, { - "shortName": "CurrencyConstantService", - "fullName": "google.ads.googleads.v9.services.CurrencyConstantService", + "shortName": "CustomerUserAccessInvitationService", + "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService", "methods": [ { - "shortName": "GetCurrencyConstant", - "fullName": "google.ads.googleads.v9.services.CurrencyConstantService.GetCurrencyConstant", + "shortName": "MutateCustomerUserAccessInvitation", + "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=currencyConstants/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerUserAccessInvitations:mutate" } ] } ] }, { - "shortName": "CustomAudienceService", - "fullName": "google.ads.googleads.v9.services.CustomAudienceService", + "shortName": "CustomerUserAccessService", + "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService", "methods": [ { - "shortName": "GetCustomAudience", - "fullName": "google.ads.googleads.v9.services.CustomAudienceService.GetCustomAudience", + "shortName": "MutateCustomerUserAccess", + "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customAudiences/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/customerUserAccesses:mutate" } ] - }, + } + ] + }, + { + "shortName": "CustomizerAttributeService", + "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService", + "methods": [ { - "shortName": "MutateCustomAudiences", - "fullName": "google.ads.googleads.v9.services.CustomAudienceService.MutateCustomAudiences", + "shortName": "MutateCustomizerAttributes", + "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customAudiences:mutate" + "path": "/v12/customers/{customer_id=*}/customizerAttributes:mutate" } ] } ] }, { - "shortName": "CustomConversionGoalService", - "fullName": "google.ads.googleads.v9.services.CustomConversionGoalService", + "shortName": "ExperimentArmService", + "fullName": "google.ads.googleads.v12.services.ExperimentArmService", "methods": [ { - "shortName": "MutateCustomConversionGoals", - "fullName": "google.ads.googleads.v9.services.CustomConversionGoalService.MutateCustomConversionGoals", + "shortName": "MutateExperimentArms", + "fullName": "google.ads.googleads.v12.services.ExperimentArmService.MutateExperimentArms", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customConversionGoals:mutate" + "path": "/v12/customers/{customer_id=*}/experimentArms:mutate" } ] } ] }, { - "shortName": "CustomInterestService", - "fullName": "google.ads.googleads.v9.services.CustomInterestService", + "shortName": "ExperimentService", + "fullName": "google.ads.googleads.v12.services.ExperimentService", "methods": [ { - "shortName": "GetCustomInterest", - "fullName": "google.ads.googleads.v9.services.CustomInterestService.GetCustomInterest", + "shortName": "EndExperiment", + "fullName": "google.ads.googleads.v12.services.ExperimentService.EndExperiment", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customInterests/*}" + "httpMethod": "POST", + "path": "/v12/{experiment=customers/*/experiments/*}:endExperiment" } ] }, { - "shortName": "MutateCustomInterests", - "fullName": "google.ads.googleads.v9.services.CustomInterestService.MutateCustomInterests", + "shortName": "GraduateExperiment", + "fullName": "google.ads.googleads.v12.services.ExperimentService.GraduateExperiment", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customInterests:mutate" + "path": "/v12/{experiment=customers/*/experiments/*}:graduateExperiment" } ] - } - ] - }, - { - "shortName": "CustomerAssetService", - "fullName": "google.ads.googleads.v9.services.CustomerAssetService", - "methods": [ + }, { - "shortName": "GetCustomerAsset", - "fullName": "google.ads.googleads.v9.services.CustomerAssetService.GetCustomerAsset", + "shortName": "ListExperimentAsyncErrors", + "fullName": "google.ads.googleads.v12.services.ExperimentService.ListExperimentAsyncErrors", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerAssets/*}" + "path": "/v12/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors" } ] }, { - "shortName": "MutateCustomerAssets", - "fullName": "google.ads.googleads.v9.services.CustomerAssetService.MutateCustomerAssets", + "shortName": "MutateExperiments", + "fullName": "google.ads.googleads.v12.services.ExperimentService.MutateExperiments", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerAssets:mutate" + "path": "/v12/customers/{customer_id=*}/experiments:mutate" } ] - } - ] - }, - { - "shortName": "CustomerClientLinkService", - "fullName": "google.ads.googleads.v9.services.CustomerClientLinkService", - "methods": [ + }, { - "shortName": "GetCustomerClientLink", - "fullName": "google.ads.googleads.v9.services.CustomerClientLinkService.GetCustomerClientLink", + "shortName": "PromoteExperiment", + "fullName": "google.ads.googleads.v12.services.ExperimentService.PromoteExperiment", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerClientLinks/*}" + "httpMethod": "POST", + "path": "/v12/{resource_name=customers/*/experiments/*}:promoteExperiment" } ] }, { - "shortName": "MutateCustomerClientLink", - "fullName": "google.ads.googleads.v9.services.CustomerClientLinkService.MutateCustomerClientLink", + "shortName": "ScheduleExperiment", + "fullName": "google.ads.googleads.v12.services.ExperimentService.ScheduleExperiment", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerClientLinks:mutate" + "path": "/v12/{resource_name=customers/*/experiments/*}:scheduleExperiment" } ] } ] }, { - "shortName": "CustomerClientService", - "fullName": "google.ads.googleads.v9.services.CustomerClientService", + "shortName": "ExtensionFeedItemService", + "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService", "methods": [ { - "shortName": "GetCustomerClient", - "fullName": "google.ads.googleads.v9.services.CustomerClientService.GetCustomerClient", + "shortName": "MutateExtensionFeedItems", + "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerClients/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/extensionFeedItems:mutate" } ] } ] }, { - "shortName": "CustomerConversionGoalService", - "fullName": "google.ads.googleads.v9.services.CustomerConversionGoalService", + "shortName": "FeedItemService", + "fullName": "google.ads.googleads.v12.services.FeedItemService", "methods": [ { - "shortName": "MutateCustomerConversionGoals", - "fullName": "google.ads.googleads.v9.services.CustomerConversionGoalService.MutateCustomerConversionGoals", + "shortName": "MutateFeedItems", + "fullName": "google.ads.googleads.v12.services.FeedItemService.MutateFeedItems", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerConversionGoals:mutate" + "path": "/v12/customers/{customer_id=*}/feedItems:mutate" } ] } ] }, { - "shortName": "CustomerCustomizerService", - "fullName": "google.ads.googleads.v9.services.CustomerCustomizerService", + "shortName": "FeedItemSetLinkService", + "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService", "methods": [ { - "shortName": "MutateCustomerCustomizers", - "fullName": "google.ads.googleads.v9.services.CustomerCustomizerService.MutateCustomerCustomizers", + "shortName": "MutateFeedItemSetLinks", + "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/CustomerCustomizers:mutate" + "path": "/v12/customers/{customer_id=*}/feedItemSetLinks:mutate" } ] } ] }, { - "shortName": "CustomerExtensionSettingService", - "fullName": "google.ads.googleads.v9.services.CustomerExtensionSettingService", + "shortName": "FeedItemSetService", + "fullName": "google.ads.googleads.v12.services.FeedItemSetService", "methods": [ { - "shortName": "GetCustomerExtensionSetting", - "fullName": "google.ads.googleads.v9.services.CustomerExtensionSettingService.GetCustomerExtensionSetting", + "shortName": "MutateFeedItemSets", + "fullName": "google.ads.googleads.v12.services.FeedItemSetService.MutateFeedItemSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerExtensionSettings/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/feedItemSets:mutate" } ] - }, + } + ] + }, + { + "shortName": "FeedItemTargetService", + "fullName": "google.ads.googleads.v12.services.FeedItemTargetService", + "methods": [ { - "shortName": "MutateCustomerExtensionSettings", - "fullName": "google.ads.googleads.v9.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings", + "shortName": "MutateFeedItemTargets", + "fullName": "google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerExtensionSettings:mutate" + "path": "/v12/customers/{customer_id=*}/feedItemTargets:mutate" } ] } ] }, { - "shortName": "CustomerFeedService", - "fullName": "google.ads.googleads.v9.services.CustomerFeedService", + "shortName": "FeedMappingService", + "fullName": "google.ads.googleads.v12.services.FeedMappingService", "methods": [ { - "shortName": "GetCustomerFeed", - "fullName": "google.ads.googleads.v9.services.CustomerFeedService.GetCustomerFeed", + "shortName": "MutateFeedMappings", + "fullName": "google.ads.googleads.v12.services.FeedMappingService.MutateFeedMappings", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerFeeds/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/feedMappings:mutate" } ] - }, + } + ] + }, + { + "shortName": "FeedService", + "fullName": "google.ads.googleads.v12.services.FeedService", + "methods": [ { - "shortName": "MutateCustomerFeeds", - "fullName": "google.ads.googleads.v9.services.CustomerFeedService.MutateCustomerFeeds", + "shortName": "MutateFeeds", + "fullName": "google.ads.googleads.v12.services.FeedService.MutateFeeds", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerFeeds:mutate" + "path": "/v12/customers/{customer_id=*}/feeds:mutate" } ] } ] }, { - "shortName": "CustomerLabelService", - "fullName": "google.ads.googleads.v9.services.CustomerLabelService", + "shortName": "GeoTargetConstantService", + "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService", + "methods": [ + { + "shortName": "SuggestGeoTargetConstants", + "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v12/geoTargetConstants:suggest" + } + ] + } + ] + }, + { + "shortName": "GoogleAdsFieldService", + "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService", "methods": [ { - "shortName": "GetCustomerLabel", - "fullName": "google.ads.googleads.v9.services.CustomerLabelService.GetCustomerLabel", + "shortName": "GetGoogleAdsField", + "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerLabels/*}" + "path": "/v12/{resource_name=googleAdsFields/*}" } ] }, { - "shortName": "MutateCustomerLabels", - "fullName": "google.ads.googleads.v9.services.CustomerLabelService.MutateCustomerLabels", + "shortName": "SearchGoogleAdsFields", + "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerLabels:mutate" + "path": "/v12/googleAdsFields:search" } ] } ] }, { - "shortName": "CustomerManagerLinkService", - "fullName": "google.ads.googleads.v9.services.CustomerManagerLinkService", + "shortName": "GoogleAdsService", + "fullName": "google.ads.googleads.v12.services.GoogleAdsService", "methods": [ { - "shortName": "GetCustomerManagerLink", - "fullName": "google.ads.googleads.v9.services.CustomerManagerLinkService.GetCustomerManagerLink", + "shortName": "Mutate", + "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Mutate", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerManagerLinks/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/googleAds:mutate" } ] }, { - "shortName": "MoveManagerLink", - "fullName": "google.ads.googleads.v9.services.CustomerManagerLinkService.MoveManagerLink", + "shortName": "Search", + "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Search", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerManagerLinks:moveManagerLink" + "path": "/v12/customers/{customer_id=*}/googleAds:search" } ] }, { - "shortName": "MutateCustomerManagerLink", - "fullName": "google.ads.googleads.v9.services.CustomerManagerLinkService.MutateCustomerManagerLink", - "mode": "UNARY", + "shortName": "SearchStream", + "fullName": "google.ads.googleads.v12.services.GoogleAdsService.SearchStream", + "mode": "SERVER_STREAMING", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerManagerLinks:mutate" + "path": "/v12/customers/{customer_id=*}/googleAds:searchStream" } ] } ] }, { - "shortName": "CustomerNegativeCriterionService", - "fullName": "google.ads.googleads.v9.services.CustomerNegativeCriterionService", + "shortName": "InvoiceService", + "fullName": "google.ads.googleads.v12.services.InvoiceService", "methods": [ { - "shortName": "GetCustomerNegativeCriterion", - "fullName": "google.ads.googleads.v9.services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion", + "shortName": "ListInvoices", + "fullName": "google.ads.googleads.v12.services.InvoiceService.ListInvoices", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerNegativeCriteria/*}" + "path": "/v12/customers/{customer_id=*}/invoices" } ] - }, + } + ] + }, + { + "shortName": "KeywordPlanAdGroupKeywordService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService", + "methods": [ { - "shortName": "MutateCustomerNegativeCriteria", - "fullName": "google.ads.googleads.v9.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria", + "shortName": "MutateKeywordPlanAdGroupKeywords", + "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerNegativeCriteria:mutate" + "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate" } ] } ] }, { - "shortName": "CustomerService", - "fullName": "google.ads.googleads.v9.services.CustomerService", + "shortName": "KeywordPlanAdGroupService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService", "methods": [ { - "shortName": "CreateCustomerClient", - "fullName": "google.ads.googleads.v9.services.CustomerService.CreateCustomerClient", + "shortName": "MutateKeywordPlanAdGroups", + "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:createCustomerClient" + "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroups:mutate" } ] - }, + } + ] + }, + { + "shortName": "KeywordPlanCampaignKeywordService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService", + "methods": [ { - "shortName": "GetCustomer", - "fullName": "google.ads.googleads.v9.services.CustomerService.GetCustomer", + "shortName": "MutateKeywordPlanCampaignKeywords", + "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate" } ] - }, + } + ] + }, + { + "shortName": "KeywordPlanCampaignService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService", + "methods": [ { - "shortName": "ListAccessibleCustomers", - "fullName": "google.ads.googleads.v9.services.CustomerService.ListAccessibleCustomers", + "shortName": "MutateKeywordPlanCampaigns", + "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/customers:listAccessibleCustomers" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/keywordPlanCampaigns:mutate" } ] - }, + } + ] + }, + { + "shortName": "KeywordPlanIdeaService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService", + "methods": [ { - "shortName": "MutateCustomer", - "fullName": "google.ads.googleads.v9.services.CustomerService.MutateCustomer", + "shortName": "GenerateAdGroupThemes", + "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateAdGroupThemes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:mutate" + "path": "/v12/customers/{customer_id=*}:generateAdGroupThemes" } ] - } - ] - }, - { - "shortName": "CustomerUserAccessInvitationService", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessInvitationService", - "methods": [ + }, { - "shortName": "GetCustomerUserAccessInvitation", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessInvitationService.GetCustomerUserAccessInvitation", + "shortName": "GenerateKeywordHistoricalMetrics", + "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerUserAccessInvitations/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}:generateKeywordHistoricalMetrics" } ] }, { - "shortName": "MutateCustomerUserAccessInvitation", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation", + "shortName": "GenerateKeywordIdeas", + "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordIdeas", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerUserAccessInvitations:mutate" + "path": "/v12/customers/{customer_id=*}:generateKeywordIdeas" } ] } ] }, { - "shortName": "CustomerUserAccessService", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessService", + "shortName": "KeywordPlanService", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService", "methods": [ { - "shortName": "GetCustomerUserAccess", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessService.GetCustomerUserAccess", + "shortName": "GenerateForecastCurve", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastCurve", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/customerUserAccesses/*}" + "httpMethod": "POST", + "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve" } ] }, { - "shortName": "MutateCustomerUserAccess", - "fullName": "google.ads.googleads.v9.services.CustomerUserAccessService.MutateCustomerUserAccess", + "shortName": "GenerateForecastMetrics", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastMetrics", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customerUserAccesses:mutate" + "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics" } ] - } - ] - }, - { - "shortName": "CustomizerAttributeService", - "fullName": "google.ads.googleads.v9.services.CustomizerAttributeService", - "methods": [ + }, { - "shortName": "MutateCustomizerAttributes", - "fullName": "google.ads.googleads.v9.services.CustomizerAttributeService.MutateCustomizerAttributes", + "shortName": "GenerateForecastTimeSeries", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastTimeSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/customizerAttributes:mutate" + "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries" } ] - } - ] - }, - { - "shortName": "DetailPlacementViewService", - "fullName": "google.ads.googleads.v9.services.DetailPlacementViewService", - "methods": [ + }, { - "shortName": "GetDetailPlacementView", - "fullName": "google.ads.googleads.v9.services.DetailPlacementViewService.GetDetailPlacementView", + "shortName": "GenerateHistoricalMetrics", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateHistoricalMetrics", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/detailPlacementViews/*}" + "httpMethod": "POST", + "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics" } ] - } - ] - }, - { - "shortName": "DetailedDemographicService", - "fullName": "google.ads.googleads.v9.services.DetailedDemographicService", - "methods": [ + }, { - "shortName": "GetDetailedDemographic", - "fullName": "google.ads.googleads.v9.services.DetailedDemographicService.GetDetailedDemographic", + "shortName": "MutateKeywordPlans", + "fullName": "google.ads.googleads.v12.services.KeywordPlanService.MutateKeywordPlans", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/detailedDemographics/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/keywordPlans:mutate" } ] } ] }, { - "shortName": "DisplayKeywordViewService", - "fullName": "google.ads.googleads.v9.services.DisplayKeywordViewService", + "shortName": "KeywordThemeConstantService", + "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService", "methods": [ { - "shortName": "GetDisplayKeywordView", - "fullName": "google.ads.googleads.v9.services.DisplayKeywordViewService.GetDisplayKeywordView", + "shortName": "SuggestKeywordThemeConstants", + "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/displayKeywordViews/*}" + "httpMethod": "POST", + "path": "/v12/keywordThemeConstants:suggest" } ] } ] }, { - "shortName": "DistanceViewService", - "fullName": "google.ads.googleads.v9.services.DistanceViewService", + "shortName": "LabelService", + "fullName": "google.ads.googleads.v12.services.LabelService", "methods": [ { - "shortName": "GetDistanceView", - "fullName": "google.ads.googleads.v9.services.DistanceViewService.GetDistanceView", + "shortName": "MutateLabels", + "fullName": "google.ads.googleads.v12.services.LabelService.MutateLabels", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/distanceViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/labels:mutate" } ] } ] }, { - "shortName": "DomainCategoryService", - "fullName": "google.ads.googleads.v9.services.DomainCategoryService", + "shortName": "MediaFileService", + "fullName": "google.ads.googleads.v12.services.MediaFileService", "methods": [ { - "shortName": "GetDomainCategory", - "fullName": "google.ads.googleads.v9.services.DomainCategoryService.GetDomainCategory", + "shortName": "MutateMediaFiles", + "fullName": "google.ads.googleads.v12.services.MediaFileService.MutateMediaFiles", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/domainCategories/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/mediaFiles:mutate" } ] } ] }, { - "shortName": "DynamicSearchAdsSearchTermViewService", - "fullName": "google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService", + "shortName": "MerchantCenterLinkService", + "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService", "methods": [ { - "shortName": "GetDynamicSearchAdsSearchTermView", - "fullName": "google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView", + "shortName": "GetMerchantCenterLink", + "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.GetMerchantCenterLink", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/dynamicSearchAdsSearchTermViews/*}" + "path": "/v12/{resource_name=customers/*/merchantCenterLinks/*}" } ] - } - ] - }, - { - "shortName": "ExpandedLandingPageViewService", - "fullName": "google.ads.googleads.v9.services.ExpandedLandingPageViewService", - "methods": [ + }, { - "shortName": "GetExpandedLandingPageView", - "fullName": "google.ads.googleads.v9.services.ExpandedLandingPageViewService.GetExpandedLandingPageView", + "shortName": "ListMerchantCenterLinks", + "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.ListMerchantCenterLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/expandedLandingPageViews/*}" + "path": "/v12/customers/{customer_id=*}/merchantCenterLinks" + } + ] + }, + { + "shortName": "MutateMerchantCenterLink", + "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.MutateMerchantCenterLink", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/merchantCenterLinks:mutate" } ] } ] }, { - "shortName": "ExtensionFeedItemService", - "fullName": "google.ads.googleads.v9.services.ExtensionFeedItemService", + "shortName": "OfflineUserDataJobService", + "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService", "methods": [ { - "shortName": "GetExtensionFeedItem", - "fullName": "google.ads.googleads.v9.services.ExtensionFeedItemService.GetExtensionFeedItem", + "shortName": "AddOfflineUserDataJobOperations", + "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/extensionFeedItems/*}" + "httpMethod": "POST", + "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations" } ] }, { - "shortName": "MutateExtensionFeedItems", - "fullName": "google.ads.googleads.v9.services.ExtensionFeedItemService.MutateExtensionFeedItems", + "shortName": "CreateOfflineUserDataJob", + "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.CreateOfflineUserDataJob", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/extensionFeedItems:mutate" - } - ] - } - ] - }, - { - "shortName": "FeedItemService", - "fullName": "google.ads.googleads.v9.services.FeedItemService", - "methods": [ - { - "shortName": "GetFeedItem", - "fullName": "google.ads.googleads.v9.services.FeedItemService.GetFeedItem", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedItems/*}" + "path": "/v12/customers/{customer_id=*}/offlineUserDataJobs:create" } ] }, { - "shortName": "MutateFeedItems", - "fullName": "google.ads.googleads.v9.services.FeedItemService.MutateFeedItems", + "shortName": "RunOfflineUserDataJob", + "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.RunOfflineUserDataJob", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feedItems:mutate" + "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:run" } ] } ] }, { - "shortName": "FeedItemSetLinkService", - "fullName": "google.ads.googleads.v9.services.FeedItemSetLinkService", + "shortName": "PaymentsAccountService", + "fullName": "google.ads.googleads.v12.services.PaymentsAccountService", "methods": [ { - "shortName": "GetFeedItemSetLink", - "fullName": "google.ads.googleads.v9.services.FeedItemSetLinkService.GetFeedItemSetLink", + "shortName": "ListPaymentsAccounts", + "fullName": "google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedItemSetLinks/*}" - } - ] - }, - { - "shortName": "MutateFeedItemSetLinks", - "fullName": "google.ads.googleads.v9.services.FeedItemSetLinkService.MutateFeedItemSetLinks", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feedItemSetLinks:mutate" + "path": "/v12/customers/{customer_id=*}/paymentsAccounts" } ] } ] }, { - "shortName": "FeedItemSetService", - "fullName": "google.ads.googleads.v9.services.FeedItemSetService", + "shortName": "ReachPlanService", + "fullName": "google.ads.googleads.v12.services.ReachPlanService", "methods": [ { - "shortName": "GetFeedItemSet", - "fullName": "google.ads.googleads.v9.services.FeedItemSetService.GetFeedItemSet", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedItemSets/*}" - } - ] - }, - { - "shortName": "MutateFeedItemSets", - "fullName": "google.ads.googleads.v9.services.FeedItemSetService.MutateFeedItemSets", + "shortName": "GenerateReachForecast", + "fullName": "google.ads.googleads.v12.services.ReachPlanService.GenerateReachForecast", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feedItemSets:mutate" - } - ] - } - ] - }, - { - "shortName": "FeedItemTargetService", - "fullName": "google.ads.googleads.v9.services.FeedItemTargetService", - "methods": [ - { - "shortName": "GetFeedItemTarget", - "fullName": "google.ads.googleads.v9.services.FeedItemTargetService.GetFeedItemTarget", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedItemTargets/*}" + "path": "/v12/customers/{customer_id=*}:generateReachForecast" } ] }, { - "shortName": "MutateFeedItemTargets", - "fullName": "google.ads.googleads.v9.services.FeedItemTargetService.MutateFeedItemTargets", + "shortName": "ListPlannableLocations", + "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableLocations", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feedItemTargets:mutate" - } - ] - } - ] - }, - { - "shortName": "FeedMappingService", - "fullName": "google.ads.googleads.v9.services.FeedMappingService", - "methods": [ - { - "shortName": "GetFeedMapping", - "fullName": "google.ads.googleads.v9.services.FeedMappingService.GetFeedMapping", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedMappings/*}" + "path": "/v12:listPlannableLocations" } ] }, { - "shortName": "MutateFeedMappings", - "fullName": "google.ads.googleads.v9.services.FeedMappingService.MutateFeedMappings", + "shortName": "ListPlannableProducts", + "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableProducts", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feedMappings:mutate" - } - ] - } - ] - }, - { - "shortName": "FeedPlaceholderViewService", - "fullName": "google.ads.googleads.v9.services.FeedPlaceholderViewService", - "methods": [ - { - "shortName": "GetFeedPlaceholderView", - "fullName": "google.ads.googleads.v9.services.FeedPlaceholderViewService.GetFeedPlaceholderView", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feedPlaceholderViews/*}" + "path": "/v12:listPlannableProducts" } ] } ] }, { - "shortName": "FeedService", - "fullName": "google.ads.googleads.v9.services.FeedService", + "shortName": "RecommendationService", + "fullName": "google.ads.googleads.v12.services.RecommendationService", "methods": [ { - "shortName": "GetFeed", - "fullName": "google.ads.googleads.v9.services.FeedService.GetFeed", + "shortName": "ApplyRecommendation", + "fullName": "google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/feeds/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/recommendations:apply" } ] }, { - "shortName": "MutateFeeds", - "fullName": "google.ads.googleads.v9.services.FeedService.MutateFeeds", + "shortName": "DismissRecommendation", + "fullName": "google.ads.googleads.v12.services.RecommendationService.DismissRecommendation", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/feeds:mutate" + "path": "/v12/customers/{customer_id=*}/recommendations:dismiss" } ] } ] }, { - "shortName": "GenderViewService", - "fullName": "google.ads.googleads.v9.services.GenderViewService", + "shortName": "RemarketingActionService", + "fullName": "google.ads.googleads.v12.services.RemarketingActionService", "methods": [ { - "shortName": "GetGenderView", - "fullName": "google.ads.googleads.v9.services.GenderViewService.GetGenderView", + "shortName": "MutateRemarketingActions", + "fullName": "google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/genderViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/remarketingActions:mutate" } ] } ] }, { - "shortName": "GeoTargetConstantService", - "fullName": "google.ads.googleads.v9.services.GeoTargetConstantService", + "shortName": "SharedCriterionService", + "fullName": "google.ads.googleads.v12.services.SharedCriterionService", "methods": [ { - "shortName": "GetGeoTargetConstant", - "fullName": "google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=geoTargetConstants/*}" - } - ] - }, - { - "shortName": "SuggestGeoTargetConstants", - "fullName": "google.ads.googleads.v9.services.GeoTargetConstantService.SuggestGeoTargetConstants", + "shortName": "MutateSharedCriteria", + "fullName": "google.ads.googleads.v12.services.SharedCriterionService.MutateSharedCriteria", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/geoTargetConstants:suggest" + "path": "/v12/customers/{customer_id=*}/sharedCriteria:mutate" } ] } ] }, { - "shortName": "GeographicViewService", - "fullName": "google.ads.googleads.v9.services.GeographicViewService", + "shortName": "SharedSetService", + "fullName": "google.ads.googleads.v12.services.SharedSetService", "methods": [ { - "shortName": "GetGeographicView", - "fullName": "google.ads.googleads.v9.services.GeographicViewService.GetGeographicView", + "shortName": "MutateSharedSets", + "fullName": "google.ads.googleads.v12.services.SharedSetService.MutateSharedSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/geographicViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/sharedSets:mutate" } ] } ] }, { - "shortName": "GoogleAdsFieldService", - "fullName": "google.ads.googleads.v9.services.GoogleAdsFieldService", + "shortName": "SmartCampaignSettingService", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService", "methods": [ { - "shortName": "GetGoogleAdsField", - "fullName": "google.ads.googleads.v9.services.GoogleAdsFieldService.GetGoogleAdsField", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v9/{resource_name=googleAdsFields/*}" - } - ] - }, - { - "shortName": "SearchGoogleAdsFields", - "fullName": "google.ads.googleads.v9.services.GoogleAdsFieldService.SearchGoogleAdsFields", + "shortName": "MutateSmartCampaignSettings", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService.MutateSmartCampaignSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/googleAdsFields:search" + "path": "/v12/customers/{customer_id=*}/smartCampaignSettings:mutate" } ] } ] }, { - "shortName": "GoogleAdsService", - "fullName": "google.ads.googleads.v9.services.GoogleAdsService", + "shortName": "SmartCampaignSuggestService", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService", "methods": [ { - "shortName": "Mutate", - "fullName": "google.ads.googleads.v9.services.GoogleAdsService.Mutate", + "shortName": "SuggestKeywordThemes", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestKeywordThemes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/googleAds:mutate" + "path": "/v12/customers/{customer_id=*}:suggestKeywordThemes" } ] }, { - "shortName": "Search", - "fullName": "google.ads.googleads.v9.services.GoogleAdsService.Search", + "shortName": "SuggestSmartCampaignAd", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignAd", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/googleAds:search" + "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignAd" } ] }, { - "shortName": "SearchStream", - "fullName": "google.ads.googleads.v9.services.GoogleAdsService.SearchStream", - "mode": "SERVER_STREAMING", + "shortName": "SuggestSmartCampaignBudgetOptions", + "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions", + "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/googleAds:searchStream" + "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions" } ] } ] }, { - "shortName": "GroupPlacementViewService", - "fullName": "google.ads.googleads.v9.services.GroupPlacementViewService", + "shortName": "ThirdPartyAppAnalyticsLinkService", + "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService", "methods": [ { - "shortName": "GetGroupPlacementView", - "fullName": "google.ads.googleads.v9.services.GroupPlacementViewService.GetGroupPlacementView", + "shortName": "RegenerateShareableLinkId", + "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/groupPlacementViews/*}" + "httpMethod": "POST", + "path": "/v12/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId" } ] } ] }, { - "shortName": "HotelGroupViewService", - "fullName": "google.ads.googleads.v9.services.HotelGroupViewService", + "shortName": "UserDataService", + "fullName": "google.ads.googleads.v12.services.UserDataService", "methods": [ { - "shortName": "GetHotelGroupView", - "fullName": "google.ads.googleads.v9.services.HotelGroupViewService.GetHotelGroupView", + "shortName": "UploadUserData", + "fullName": "google.ads.googleads.v12.services.UserDataService.UploadUserData", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/hotelGroupViews/*}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}:uploadUserData" } ] } ] }, { - "shortName": "HotelPerformanceViewService", - "fullName": "google.ads.googleads.v9.services.HotelPerformanceViewService", + "shortName": "UserListService", + "fullName": "google.ads.googleads.v12.services.UserListService", "methods": [ { - "shortName": "GetHotelPerformanceView", - "fullName": "google.ads.googleads.v9.services.HotelPerformanceViewService.GetHotelPerformanceView", + "shortName": "MutateUserLists", + "fullName": "google.ads.googleads.v12.services.UserListService.MutateUserLists", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/hotelPerformanceView}" + "httpMethod": "POST", + "path": "/v12/customers/{customer_id=*}/userLists:mutate" } ] } ] + } + ], + "configFile": "googleads_v12.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" + ], + "nameInServiceConfig": "googleads.googleapis.com" + }, + { + "id": "google.ads.searchads360.v0", + "directory": "google/ads/searchads360/v0", + "version": "v0", + "majorVersion": "v0", + "hostName": "searchads360.googleapis.com", + "title": "Search Ads 360 Reporting API", + "description": "The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.", + "importDirectories": [ + "google/ads/searchads360/v0/common", + "google/ads/searchads360/v0/enums", + "google/ads/searchads360/v0/resources", + "google/api", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Ads.SearchAds360.V0.Common": 8, + "Google.Ads.SearchAds360.V0.Enums": 46, + "Google.Ads.SearchAds360.V0.Resources": 15, + "Google.Ads.SearchAds360.V0.Services": 3 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common": 8, + "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums": 46, + "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources": 15, + "google.golang.org/genproto/googleapis/ads/searchads360/v0/services;services": 3 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 72 + } + }, + "java_package": { + "valueCounts": { + "com.google.ads.searchads360.v0.common": 8, + "com.google.ads.searchads360.v0.enums": 46, + "com.google.ads.searchads360.v0.resources": 15, + "com.google.ads.searchads360.v0.services": 3 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GASA360": 72 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Ads\\SearchAds360\\V0\\Common": 8, + "Google\\Ads\\SearchAds360\\V0\\Enums": 46, + "Google\\Ads\\SearchAds360\\V0\\Resources": 15, + "Google\\Ads\\SearchAds360\\V0\\Services": 3 + } }, + "ruby_package": { + "valueCounts": { + "Google::Ads::SearchAds360::V0::Common": 8, + "Google::Ads::SearchAds360::V0::Enums": 46, + "Google::Ads::SearchAds360::V0::Resources": 15, + "Google::Ads::SearchAds360::V0::Services": 3 + } + } + }, + "services": [ { - "shortName": "IncomeRangeViewService", - "fullName": "google.ads.googleads.v9.services.IncomeRangeViewService", + "shortName": "CustomColumnService", + "fullName": "google.ads.searchads360.v0.services.CustomColumnService", "methods": [ { - "shortName": "GetIncomeRangeView", - "fullName": "google.ads.googleads.v9.services.IncomeRangeViewService.GetIncomeRangeView", + "shortName": "GetCustomColumn", + "fullName": "google.ads.searchads360.v0.services.CustomColumnService.GetCustomColumn", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/incomeRangeViews/*}" + "path": "/v0/{resource_name=customers/*/customColumns/*}" } ] - } - ] - }, - { - "shortName": "InvoiceService", - "fullName": "google.ads.googleads.v9.services.InvoiceService", - "methods": [ + }, { - "shortName": "ListInvoices", - "fullName": "google.ads.googleads.v9.services.InvoiceService.ListInvoices", + "shortName": "ListCustomColumns", + "fullName": "google.ads.searchads360.v0.services.CustomColumnService.ListCustomColumns", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/customers/{customer_id=*}/invoices" + "path": "/v0/customers/{customer_id=*}/customColumns" } ] } ] }, { - "shortName": "KeywordPlanAdGroupKeywordService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService", + "shortName": "SearchAds360FieldService", + "fullName": "google.ads.searchads360.v0.services.SearchAds360FieldService", "methods": [ { - "shortName": "GetKeywordPlanAdGroupKeyword", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword", + "shortName": "GetSearchAds360Field", + "fullName": "google.ads.searchads360.v0.services.SearchAds360FieldService.GetSearchAds360Field", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordPlanAdGroupKeywords/*}" + "path": "/v0/{resource_name=searchAds360Fields/*}" } ] }, { - "shortName": "MutateKeywordPlanAdGroupKeywords", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords", + "shortName": "SearchSearchAds360Fields", + "fullName": "google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate" + "path": "/v0/searchAds360Fields:search" } ] } ] }, { - "shortName": "KeywordPlanAdGroupService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupService", + "shortName": "SearchAds360Service", + "fullName": "google.ads.searchads360.v0.services.SearchAds360Service", "methods": [ { - "shortName": "GetKeywordPlanAdGroup", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup", + "shortName": "Search", + "fullName": "google.ads.searchads360.v0.services.SearchAds360Service.Search", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordPlanAdGroups/*}" + "httpMethod": "POST", + "path": "/v0/customers/{customer_id=*}/searchAds360:search" } ] }, { - "shortName": "MutateKeywordPlanAdGroups", - "fullName": "google.ads.googleads.v9.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups", - "mode": "UNARY", + "shortName": "SearchStream", + "fullName": "google.ads.searchads360.v0.services.SearchAds360Service.SearchStream", + "mode": "SERVER_STREAMING", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/keywordPlanAdGroups:mutate" + "path": "/v0/customers/{customer_id=*}/searchAds360:searchStream" } ] } ] + } + ], + "configFile": "searchads360_v0.yaml", + "serviceConfigApiNames": [ + "google.ads.searchads360.v0.services.CustomColumnService", + "google.ads.searchads360.v0.services.SearchAds360FieldService", + "google.ads.searchads360.v0.services.SearchAds360Service" + ], + "nameInServiceConfig": "searchads360.googleapis.com" + }, + { + "id": "google.analytics.admin.v1alpha", + "directory": "google/analytics/admin/v1alpha", + "version": "v1alpha", + "majorVersion": "v1", + "hostName": "analyticsadmin.googleapis.com", + "title": "Google Analytics Admin API", + "description": "", + "importDirectories": [ + "google/analytics/admin/v1alpha", + "google/api", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin": 4 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 4 + } }, + "java_package": { + "valueCounts": { + "com.google.analytics.admin.v1alpha": 4 + } + } + }, + "services": [ { - "shortName": "KeywordPlanCampaignKeywordService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService", + "shortName": "AnalyticsAdminService", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService", "methods": [ { - "shortName": "GetKeywordPlanCampaignKeyword", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword", + "shortName": "AcknowledgeUserDataCollection", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.AcknowledgeUserDataCollection", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordPlanCampaignKeywords/*}" + "httpMethod": "POST", + "path": "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection" } ] }, { - "shortName": "MutateKeywordPlanCampaignKeywords", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords", + "shortName": "ApproveDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ApproveDisplayVideo360AdvertiserLinkProposal", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate" + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve" } ] - } - ] - }, - { - "shortName": "KeywordPlanCampaignService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignService", - "methods": [ + }, { - "shortName": "GetKeywordPlanCampaign", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignService.GetKeywordPlanCampaign", + "shortName": "ArchiveAudience", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveAudience", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordPlanCampaigns/*}" + "httpMethod": "POST", + "path": "/v1alpha/{name=properties/*/audiences/*}:archive" } ] }, { - "shortName": "MutateKeywordPlanCampaigns", - "fullName": "google.ads.googleads.v9.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns", + "shortName": "ArchiveCustomDimension", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/keywordPlanCampaigns:mutate" + "path": "/v1alpha/{name=properties/*/customDimensions/*}:archive" } ] - } - ] - }, - { - "shortName": "KeywordPlanIdeaService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanIdeaService", - "methods": [ + }, { - "shortName": "GenerateKeywordIdeas", - "fullName": "google.ads.googleads.v9.services.KeywordPlanIdeaService.GenerateKeywordIdeas", + "shortName": "ArchiveCustomMetric", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:generateKeywordIdeas" + "path": "/v1alpha/{name=properties/*/customMetrics/*}:archive" } ] - } - ] - }, - { - "shortName": "KeywordPlanService", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService", - "methods": [ + }, { - "shortName": "GenerateForecastCurve", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastCurve", + "shortName": "AuditUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.AuditUserLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve" + "path": "/v1alpha/{parent=accounts/*}/userLinks:audit" + }, + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/userLinks:audit" } ] }, { - "shortName": "GenerateForecastMetrics", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastMetrics", + "shortName": "BatchCreateUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics" + "path": "/v1alpha/{parent=accounts/*}/userLinks:batchCreate" + }, + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/userLinks:batchCreate" } ] }, { - "shortName": "GenerateForecastTimeSeries", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastTimeSeries", + "shortName": "BatchDeleteUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries" + "path": "/v1alpha/{parent=accounts/*}/userLinks:batchDelete" + }, + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/userLinks:batchDelete" } ] }, { - "shortName": "GenerateHistoricalMetrics", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.GenerateHistoricalMetrics", + "shortName": "BatchGetUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics" + "httpMethod": "GET", + "path": "/v1alpha/{parent=accounts/*}/userLinks:batchGet" + }, + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/userLinks:batchGet" } ] }, { - "shortName": "GetKeywordPlan", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.GetKeywordPlan", + "shortName": "BatchUpdateUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordPlans/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate" + }, + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/userLinks:batchUpdate" } ] }, { - "shortName": "MutateKeywordPlans", - "fullName": "google.ads.googleads.v9.services.KeywordPlanService.MutateKeywordPlans", + "shortName": "CancelDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CancelDisplayVideo360AdvertiserLinkProposal", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/keywordPlans:mutate" + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel" } ] - } - ] - }, - { - "shortName": "KeywordThemeConstantService", - "fullName": "google.ads.googleads.v9.services.KeywordThemeConstantService", - "methods": [ + }, { - "shortName": "GetKeywordThemeConstant", - "fullName": "google.ads.googleads.v9.services.KeywordThemeConstantService.GetKeywordThemeConstant", + "shortName": "CreateAudience", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateAudience", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=keywordThemeConstants/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/audiences" } ] }, { - "shortName": "SuggestKeywordThemeConstants", - "fullName": "google.ads.googleads.v9.services.KeywordThemeConstantService.SuggestKeywordThemeConstants", + "shortName": "CreateConversionEvent", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateConversionEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/keywordThemeConstants:suggest" + "path": "/v1alpha/{parent=properties/*}/conversionEvents" } ] - } - ] - }, - { - "shortName": "KeywordViewService", - "fullName": "google.ads.googleads.v9.services.KeywordViewService", - "methods": [ + }, { - "shortName": "GetKeywordView", - "fullName": "google.ads.googleads.v9.services.KeywordViewService.GetKeywordView", + "shortName": "CreateCustomDimension", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateCustomDimension", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/keywordViews/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/customDimensions" } ] - } - ] - }, - { - "shortName": "LabelService", - "fullName": "google.ads.googleads.v9.services.LabelService", - "methods": [ + }, { - "shortName": "GetLabel", - "fullName": "google.ads.googleads.v9.services.LabelService.GetLabel", + "shortName": "CreateCustomMetric", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateCustomMetric", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/labels/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/customMetrics" } ] }, { - "shortName": "MutateLabels", - "fullName": "google.ads.googleads.v9.services.LabelService.MutateLabels", + "shortName": "CreateDataStream", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDataStream", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/labels:mutate" + "path": "/v1alpha/{parent=properties/*}/dataStreams" } ] - } - ] - }, - { - "shortName": "LandingPageViewService", - "fullName": "google.ads.googleads.v9.services.LandingPageViewService", - "methods": [ + }, { - "shortName": "GetLandingPageView", - "fullName": "google.ads.googleads.v9.services.LandingPageViewService.GetLandingPageView", + "shortName": "CreateDisplayVideo360AdvertiserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDisplayVideo360AdvertiserLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/landingPageViews/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" } ] - } - ] - }, - { - "shortName": "LanguageConstantService", - "fullName": "google.ads.googleads.v9.services.LanguageConstantService", - "methods": [ + }, { - "shortName": "GetLanguageConstant", - "fullName": "google.ads.googleads.v9.services.LanguageConstantService.GetLanguageConstant", + "shortName": "CreateDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDisplayVideo360AdvertiserLinkProposal", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=languageConstants/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" } ] - } - ] - }, - { - "shortName": "LifeEventService", - "fullName": "google.ads.googleads.v9.services.LifeEventService", - "methods": [ + }, { - "shortName": "GetLifeEvent", - "fullName": "google.ads.googleads.v9.services.LifeEventService.GetLifeEvent", + "shortName": "CreateFirebaseLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateFirebaseLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/lifeEvents/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/firebaseLinks" } ] - } - ] - }, - { - "shortName": "LocationViewService", - "fullName": "google.ads.googleads.v9.services.LocationViewService", - "methods": [ + }, { - "shortName": "GetLocationView", - "fullName": "google.ads.googleads.v9.services.LocationViewService.GetLocationView", + "shortName": "CreateGoogleAdsLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateGoogleAdsLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/locationViews/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/googleAdsLinks" } ] - } - ] - }, - { - "shortName": "ManagedPlacementViewService", - "fullName": "google.ads.googleads.v9.services.ManagedPlacementViewService", - "methods": [ + }, { - "shortName": "GetManagedPlacementView", - "fullName": "google.ads.googleads.v9.services.ManagedPlacementViewService.GetManagedPlacementView", + "shortName": "CreateMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/managedPlacementViews/*}" + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" } ] - } - ] - }, - { - "shortName": "MediaFileService", - "fullName": "google.ads.googleads.v9.services.MediaFileService", - "methods": [ + }, { - "shortName": "GetMediaFile", - "fullName": "google.ads.googleads.v9.services.MediaFileService.GetMediaFile", + "shortName": "CreateProperty", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateProperty", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/mediaFiles/*}" + "httpMethod": "POST", + "path": "/v1alpha/properties" } ] }, { - "shortName": "MutateMediaFiles", - "fullName": "google.ads.googleads.v9.services.MediaFileService.MutateMediaFiles", + "shortName": "CreateUserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/mediaFiles:mutate" + "path": "/v1alpha/{parent=accounts/*}/userLinks" + }, + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=properties/*}/userLinks" } ] - } - ] - }, - { - "shortName": "MerchantCenterLinkService", - "fullName": "google.ads.googleads.v9.services.MerchantCenterLinkService", - "methods": [ + }, { - "shortName": "GetMerchantCenterLink", - "fullName": "google.ads.googleads.v9.services.MerchantCenterLinkService.GetMerchantCenterLink", + "shortName": "DeleteAccount", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteAccount", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/merchantCenterLinks/*}" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=accounts/*}" } ] }, { - "shortName": "ListMerchantCenterLinks", - "fullName": "google.ads.googleads.v9.services.MerchantCenterLinkService.ListMerchantCenterLinks", + "shortName": "DeleteConversionEvent", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteConversionEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/customers/{customer_id=*}/merchantCenterLinks" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/conversionEvents/*}" } ] }, { - "shortName": "MutateMerchantCenterLink", - "fullName": "google.ads.googleads.v9.services.MerchantCenterLinkService.MutateMerchantCenterLink", + "shortName": "DeleteDataStream", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDataStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/merchantCenterLinks:mutate" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/dataStreams/*}" } ] - } - ] - }, - { - "shortName": "MobileAppCategoryConstantService", - "fullName": "google.ads.googleads.v9.services.MobileAppCategoryConstantService", - "methods": [ + }, { - "shortName": "GetMobileAppCategoryConstant", - "fullName": "google.ads.googleads.v9.services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant", + "shortName": "DeleteDisplayVideo360AdvertiserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDisplayVideo360AdvertiserLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=mobileAppCategoryConstants/*}" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" } ] - } - ] - }, - { - "shortName": "MobileDeviceConstantService", - "fullName": "google.ads.googleads.v9.services.MobileDeviceConstantService", - "methods": [ + }, { - "shortName": "GetMobileDeviceConstant", - "fullName": "google.ads.googleads.v9.services.MobileDeviceConstantService.GetMobileDeviceConstant", + "shortName": "DeleteDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDisplayVideo360AdvertiserLinkProposal", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=mobileDeviceConstants/*}" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" } ] - } - ] - }, - { - "shortName": "OfflineUserDataJobService", - "fullName": "google.ads.googleads.v9.services.OfflineUserDataJobService", - "methods": [ + }, { - "shortName": "AddOfflineUserDataJobOperations", - "fullName": "google.ads.googleads.v9.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations", + "shortName": "DeleteFirebaseLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteFirebaseLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/firebaseLinks/*}" } ] }, { - "shortName": "CreateOfflineUserDataJob", - "fullName": "google.ads.googleads.v9.services.OfflineUserDataJobService.CreateOfflineUserDataJob", + "shortName": "DeleteGoogleAdsLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteGoogleAdsLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/offlineUserDataJobs:create" + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/googleAdsLinks/*}" } ] }, { - "shortName": "GetOfflineUserDataJob", - "fullName": "google.ads.googleads.v9.services.OfflineUserDataJobService.GetOfflineUserDataJob", - "mode": "UNARY", + "shortName": "DeleteMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteMeasurementProtocolSecret", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + } + ] + }, + { + "shortName": "DeleteProperty", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteProperty", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*}" + } + ] + }, + { + "shortName": "DeleteUserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1alpha/{name=accounts/*/userLinks/*}" + }, + { + "httpMethod": "DELETE", + "path": "/v1alpha/{name=properties/*/userLinks/*}" + } + ] + }, + { + "shortName": "GetAccount", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount", + "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/offlineUserDataJobs/*}" + "path": "/v1alpha/{name=accounts/*}" } ] }, { - "shortName": "RunOfflineUserDataJob", - "fullName": "google.ads.googleads.v9.services.OfflineUserDataJobService.RunOfflineUserDataJob", + "shortName": "GetAttributionSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAttributionSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/{resource_name=customers/*/offlineUserDataJobs/*}:run" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/attributionSettings}" } ] - } - ] - }, - { - "shortName": "OperatingSystemVersionConstantService", - "fullName": "google.ads.googleads.v9.services.OperatingSystemVersionConstantService", - "methods": [ + }, { - "shortName": "GetOperatingSystemVersionConstant", - "fullName": "google.ads.googleads.v9.services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant", + "shortName": "GetAudience", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAudience", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=operatingSystemVersionConstants/*}" + "path": "/v1alpha/{name=properties/*/audiences/*}" } ] - } - ] - }, - { - "shortName": "PaidOrganicSearchTermViewService", - "fullName": "google.ads.googleads.v9.services.PaidOrganicSearchTermViewService", - "methods": [ + }, { - "shortName": "GetPaidOrganicSearchTermView", - "fullName": "google.ads.googleads.v9.services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView", + "shortName": "GetConversionEvent", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/paidOrganicSearchTermViews/*}" + "path": "/v1alpha/{name=properties/*/conversionEvents/*}" } ] - } - ] - }, - { - "shortName": "ParentalStatusViewService", - "fullName": "google.ads.googleads.v9.services.ParentalStatusViewService", - "methods": [ + }, { - "shortName": "GetParentalStatusView", - "fullName": "google.ads.googleads.v9.services.ParentalStatusViewService.GetParentalStatusView", + "shortName": "GetCustomDimension", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/parentalStatusViews/*}" + "path": "/v1alpha/{name=properties/*/customDimensions/*}" } ] - } - ] - }, - { - "shortName": "PaymentsAccountService", - "fullName": "google.ads.googleads.v9.services.PaymentsAccountService", - "methods": [ + }, { - "shortName": "ListPaymentsAccounts", - "fullName": "google.ads.googleads.v9.services.PaymentsAccountService.ListPaymentsAccounts", + "shortName": "GetCustomMetric", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/customers/{customer_id=*}/paymentsAccounts" + "path": "/v1alpha/{name=properties/*/customMetrics/*}" } ] - } - ] - }, - { - "shortName": "ProductBiddingCategoryConstantService", - "fullName": "google.ads.googleads.v9.services.ProductBiddingCategoryConstantService", - "methods": [ + }, { - "shortName": "GetProductBiddingCategoryConstant", - "fullName": "google.ads.googleads.v9.services.ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant", + "shortName": "GetDataRetentionSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataRetentionSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=productBiddingCategoryConstants/*}" + "path": "/v1alpha/{name=properties/*/dataRetentionSettings}" } ] - } - ] - }, - { - "shortName": "ProductGroupViewService", - "fullName": "google.ads.googleads.v9.services.ProductGroupViewService", - "methods": [ + }, { - "shortName": "GetProductGroupView", - "fullName": "google.ads.googleads.v9.services.ProductGroupViewService.GetProductGroupView", + "shortName": "GetDataSharingSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataSharingSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/productGroupViews/*}" + "path": "/v1alpha/{name=accounts/*/dataSharingSettings}" } ] - } - ] - }, - { - "shortName": "ReachPlanService", - "fullName": "google.ads.googleads.v9.services.ReachPlanService", - "methods": [ + }, { - "shortName": "GenerateProductMixIdeas", - "fullName": "google.ads.googleads.v9.services.ReachPlanService.GenerateProductMixIdeas", + "shortName": "GetDataStream", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:generateProductMixIdeas" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/dataStreams/*}" } ] }, { - "shortName": "GenerateReachForecast", - "fullName": "google.ads.googleads.v9.services.ReachPlanService.GenerateReachForecast", + "shortName": "GetDisplayVideo360AdvertiserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:generateReachForecast" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" } ] }, { - "shortName": "ListPlannableLocations", - "fullName": "google.ads.googleads.v9.services.ReachPlanService.ListPlannableLocations", + "shortName": "GetDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9:listPlannableLocations" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" } ] }, { - "shortName": "ListPlannableProducts", - "fullName": "google.ads.googleads.v9.services.ReachPlanService.ListPlannableProducts", + "shortName": "GetGlobalSiteTag", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9:listPlannableProducts" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}" } ] - } - ] - }, - { - "shortName": "RecommendationService", - "fullName": "google.ads.googleads.v9.services.RecommendationService", - "methods": [ + }, { - "shortName": "ApplyRecommendation", - "fullName": "google.ads.googleads.v9.services.RecommendationService.ApplyRecommendation", + "shortName": "GetGoogleSignalsSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetGoogleSignalsSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/recommendations:apply" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/googleSignalsSettings}" } ] }, { - "shortName": "DismissRecommendation", - "fullName": "google.ads.googleads.v9.services.RecommendationService.DismissRecommendation", + "shortName": "GetMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/recommendations:dismiss" + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" } ] }, { - "shortName": "GetRecommendation", - "fullName": "google.ads.googleads.v9.services.RecommendationService.GetRecommendation", + "shortName": "GetProperty", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetProperty", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/recommendations/*}" + "path": "/v1alpha/{name=properties/*}" } ] - } - ] - }, - { - "shortName": "RemarketingActionService", - "fullName": "google.ads.googleads.v9.services.RemarketingActionService", - "methods": [ + }, { - "shortName": "GetRemarketingAction", - "fullName": "google.ads.googleads.v9.services.RemarketingActionService.GetRemarketingAction", + "shortName": "GetUserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/remarketingActions/*}" + "path": "/v1alpha/{name=accounts/*/userLinks/*}" + }, + { + "httpMethod": "GET", + "path": "/v1alpha/{name=properties/*/userLinks/*}" } ] }, { - "shortName": "MutateRemarketingActions", - "fullName": "google.ads.googleads.v9.services.RemarketingActionService.MutateRemarketingActions", + "shortName": "ListAccountSummaries", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/remarketingActions:mutate" + "httpMethod": "GET", + "path": "/v1alpha/accountSummaries" } ] - } - ] - }, - { - "shortName": "SearchTermViewService", - "fullName": "google.ads.googleads.v9.services.SearchTermViewService", - "methods": [ + }, { - "shortName": "GetSearchTermView", - "fullName": "google.ads.googleads.v9.services.SearchTermViewService.GetSearchTermView", + "shortName": "ListAccounts", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccounts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/searchTermViews/*}" + "path": "/v1alpha/accounts" } ] - } - ] - }, - { - "shortName": "SharedCriterionService", - "fullName": "google.ads.googleads.v9.services.SharedCriterionService", - "methods": [ + }, { - "shortName": "GetSharedCriterion", - "fullName": "google.ads.googleads.v9.services.SharedCriterionService.GetSharedCriterion", + "shortName": "ListAudiences", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAudiences", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/sharedCriteria/*}" + "path": "/v1alpha/{parent=properties/*}/audiences" } ] }, { - "shortName": "MutateSharedCriteria", - "fullName": "google.ads.googleads.v9.services.SharedCriterionService.MutateSharedCriteria", + "shortName": "ListConversionEvents", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/sharedCriteria:mutate" + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/conversionEvents" } ] - } - ] - }, - { - "shortName": "SharedSetService", - "fullName": "google.ads.googleads.v9.services.SharedSetService", - "methods": [ + }, { - "shortName": "GetSharedSet", - "fullName": "google.ads.googleads.v9.services.SharedSetService.GetSharedSet", + "shortName": "ListCustomDimensions", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomDimensions", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/sharedSets/*}" + "path": "/v1alpha/{parent=properties/*}/customDimensions" } ] }, { - "shortName": "MutateSharedSets", - "fullName": "google.ads.googleads.v9.services.SharedSetService.MutateSharedSets", + "shortName": "ListCustomMetrics", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomMetrics", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/sharedSets:mutate" + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/customMetrics" } ] - } - ] - }, - { - "shortName": "ShoppingPerformanceViewService", - "fullName": "google.ads.googleads.v9.services.ShoppingPerformanceViewService", - "methods": [ + }, { - "shortName": "GetShoppingPerformanceView", - "fullName": "google.ads.googleads.v9.services.ShoppingPerformanceViewService.GetShoppingPerformanceView", + "shortName": "ListDataStreams", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDataStreams", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/shoppingPerformanceView}" + "path": "/v1alpha/{parent=properties/*}/dataStreams" } ] - } - ] - }, - { - "shortName": "SmartCampaignSearchTermViewService", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSearchTermViewService", - "methods": [ + }, { - "shortName": "GetSmartCampaignSearchTermView", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView", + "shortName": "ListDisplayVideo360AdvertiserLinkProposals", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinkProposals", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/smartCampaignSearchTermViews/*}" + "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" } ] - } - ] - }, - { - "shortName": "SmartCampaignSettingService", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSettingService", - "methods": [ + }, { - "shortName": "GetSmartCampaignSetting", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSettingService.GetSmartCampaignSetting", + "shortName": "ListDisplayVideo360AdvertiserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/smartCampaignSettings/*}" + "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" } ] }, { - "shortName": "MutateSmartCampaignSettings", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSettingService.MutateSmartCampaignSettings", + "shortName": "ListFirebaseLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/smartCampaignSettings:mutate" + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/firebaseLinks" } ] - } - ] - }, - { - "shortName": "SmartCampaignSuggestService", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSuggestService", - "methods": [ + }, { - "shortName": "SuggestKeywordThemes", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestKeywordThemes", + "shortName": "ListGoogleAdsLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListGoogleAdsLinks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/googleAdsLinks" + } + ] + }, + { + "shortName": "ListMeasurementProtocolSecrets", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListMeasurementProtocolSecrets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" + } + ] + }, + { + "shortName": "ListProperties", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListProperties", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/properties" + } + ] + }, + { + "shortName": "ListUserLinks", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=accounts/*}/userLinks" + }, + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=properties/*}/userLinks" + } + ] + }, + { + "shortName": "ProvisionAccountTicket", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ProvisionAccountTicket", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:suggestKeywordThemes" + "path": "/v1alpha/accounts:provisionAccountTicket" } ] }, { - "shortName": "SuggestSmartCampaignAd", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestSmartCampaignAd", + "shortName": "RunAccessReport", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.RunAccessReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:suggestSmartCampaignAd" + "path": "/v1alpha/{entity=properties/*}:runAccessReport" } ] }, { - "shortName": "SuggestSmartCampaignBudgetOptions", - "fullName": "google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions", + "shortName": "SearchChangeHistoryEvents", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.SearchChangeHistoryEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions" + "path": "/v1alpha/{account=accounts/*}:searchChangeHistoryEvents" } ] - } - ] - }, - { - "shortName": "ThirdPartyAppAnalyticsLinkService", - "fullName": "google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService", - "methods": [ + }, { - "shortName": "GetThirdPartyAppAnalyticsLink", - "fullName": "google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink", + "shortName": "UpdateAccount", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAccount", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{account.name=accounts/*}" } ] }, { - "shortName": "RegenerateShareableLinkId", - "fullName": "google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId", + "shortName": "UpdateAttributionSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAttributionSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId" + "httpMethod": "PATCH", + "path": "/v1alpha/{attribution_settings.name=properties/*/attributionSettings}" } ] - } - ] - }, - { - "shortName": "TopicConstantService", - "fullName": "google.ads.googleads.v9.services.TopicConstantService", - "methods": [ + }, { - "shortName": "GetTopicConstant", - "fullName": "google.ads.googleads.v9.services.TopicConstantService.GetTopicConstant", + "shortName": "UpdateAudience", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAudience", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=topicConstants/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{audience.name=properties/*/audiences/*}" } ] - } - ] - }, - { - "shortName": "TopicViewService", - "fullName": "google.ads.googleads.v9.services.TopicViewService", - "methods": [ + }, { - "shortName": "GetTopicView", - "fullName": "google.ads.googleads.v9.services.TopicViewService.GetTopicView", + "shortName": "UpdateCustomDimension", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateCustomDimension", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/topicViews/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{custom_dimension.name=properties/*/customDimensions/*}" } ] - } - ] - }, - { - "shortName": "UserDataService", - "fullName": "google.ads.googleads.v9.services.UserDataService", - "methods": [ + }, { - "shortName": "UploadUserData", - "fullName": "google.ads.googleads.v9.services.UserDataService.UploadUserData", + "shortName": "UpdateCustomMetric", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateCustomMetric", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}:uploadUserData" + "httpMethod": "PATCH", + "path": "/v1alpha/{custom_metric.name=properties/*/customMetrics/*}" } ] - } - ] - }, - { - "shortName": "UserInterestService", - "fullName": "google.ads.googleads.v9.services.UserInterestService", - "methods": [ + }, { - "shortName": "GetUserInterest", - "fullName": "google.ads.googleads.v9.services.UserInterestService.GetUserInterest", + "shortName": "UpdateDataRetentionSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDataRetentionSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/userInterests/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{data_retention_settings.name=properties/*/dataRetentionSettings}" } ] - } - ] - }, - { - "shortName": "UserListService", - "fullName": "google.ads.googleads.v9.services.UserListService", - "methods": [ + }, { - "shortName": "GetUserList", - "fullName": "google.ads.googleads.v9.services.UserListService.GetUserList", + "shortName": "UpdateDataStream", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDataStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/userLists/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{data_stream.name=properties/*/dataStreams/*}" } ] }, { - "shortName": "MutateUserLists", - "fullName": "google.ads.googleads.v9.services.UserListService.MutateUserLists", + "shortName": "UpdateDisplayVideo360AdvertiserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDisplayVideo360AdvertiserLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v9/customers/{customer_id=*}/userLists:mutate" + "httpMethod": "PATCH", + "path": "/v1alpha/{display_video_360_advertiser_link.name=properties/*/displayVideo360AdvertiserLinks/*}" } ] - } - ] - }, - { - "shortName": "UserLocationViewService", - "fullName": "google.ads.googleads.v9.services.UserLocationViewService", - "methods": [ + }, { - "shortName": "GetUserLocationView", - "fullName": "google.ads.googleads.v9.services.UserLocationViewService.GetUserLocationView", + "shortName": "UpdateGoogleAdsLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateGoogleAdsLink", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/userLocationViews/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{google_ads_link.name=properties/*/googleAdsLinks/*}" } ] - } - ] - }, - { - "shortName": "VideoService", - "fullName": "google.ads.googleads.v9.services.VideoService", - "methods": [ + }, { - "shortName": "GetVideo", - "fullName": "google.ads.googleads.v9.services.VideoService.GetVideo", + "shortName": "UpdateGoogleSignalsSettings", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateGoogleSignalsSettings", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/videos/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{google_signals_settings.name=properties/*/googleSignalsSettings}" } ] - } - ] - }, - { - "shortName": "WebpageViewService", - "fullName": "google.ads.googleads.v9.services.WebpageViewService", - "methods": [ + }, { - "shortName": "GetWebpageView", - "fullName": "google.ads.googleads.v9.services.WebpageViewService.GetWebpageView", + "shortName": "UpdateMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v9/{resource_name=customers/*/webpageViews/*}" + "httpMethod": "PATCH", + "path": "/v1alpha/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + } + ] + }, + { + "shortName": "UpdateProperty", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateProperty", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha/{property.name=properties/*}" + } + ] + }, + { + "shortName": "UpdateUserLink", + "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha/{user_link.name=accounts/*/userLinks/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1alpha/{user_link.name=properties/*/userLinks/*}" } ] } ] } ], - "configFile": "googleads_v9.yaml", + "configFile": "analyticsadmin_v1alpha.yaml", "serviceConfigApiNames": [ - "google.ads.googleads.v9.services.AccessibleBiddingStrategyService", - "google.ads.googleads.v9.services.AccountBudgetProposalService", - "google.ads.googleads.v9.services.AccountBudgetService", - "google.ads.googleads.v9.services.AccountLinkService", - "google.ads.googleads.v9.services.AdGroupAdAssetViewService", - "google.ads.googleads.v9.services.AdGroupAdLabelService", - "google.ads.googleads.v9.services.AdGroupAdService", - "google.ads.googleads.v9.services.AdGroupAssetService", - "google.ads.googleads.v9.services.AdGroupAudienceViewService", - "google.ads.googleads.v9.services.AdGroupBidModifierService", - "google.ads.googleads.v9.services.AdGroupCriterionCustomizerService", - "google.ads.googleads.v9.services.AdGroupCriterionLabelService", - "google.ads.googleads.v9.services.AdGroupCriterionService", - "google.ads.googleads.v9.services.AdGroupCriterionSimulationService", - "google.ads.googleads.v9.services.AdGroupCustomizerService", - "google.ads.googleads.v9.services.AdGroupExtensionSettingService", - "google.ads.googleads.v9.services.AdGroupFeedService", - "google.ads.googleads.v9.services.AdGroupLabelService", - "google.ads.googleads.v9.services.AdGroupService", - "google.ads.googleads.v9.services.AdGroupSimulationService", - "google.ads.googleads.v9.services.AdParameterService", - "google.ads.googleads.v9.services.AdScheduleViewService", - "google.ads.googleads.v9.services.AdService", - "google.ads.googleads.v9.services.AgeRangeViewService", - "google.ads.googleads.v9.services.AssetFieldTypeViewService", - "google.ads.googleads.v9.services.AssetGroupAssetService", - "google.ads.googleads.v9.services.AssetGroupListingGroupFilterService", - "google.ads.googleads.v9.services.AssetGroupService", - "google.ads.googleads.v9.services.AssetService", - "google.ads.googleads.v9.services.AssetSetAssetService", - "google.ads.googleads.v9.services.AssetSetService", - "google.ads.googleads.v9.services.BatchJobService", - "google.ads.googleads.v9.services.BiddingDataExclusionService", - "google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService", - "google.ads.googleads.v9.services.BiddingStrategyService", - "google.ads.googleads.v9.services.BiddingStrategySimulationService", - "google.ads.googleads.v9.services.BillingSetupService", - "google.ads.googleads.v9.services.CampaignAssetService", - "google.ads.googleads.v9.services.CampaignAssetSetService", - "google.ads.googleads.v9.services.CampaignAudienceViewService", - "google.ads.googleads.v9.services.CampaignBidModifierService", - "google.ads.googleads.v9.services.CampaignBudgetService", - "google.ads.googleads.v9.services.CampaignConversionGoalService", - "google.ads.googleads.v9.services.CampaignCriterionService", - "google.ads.googleads.v9.services.CampaignCriterionSimulationService", - "google.ads.googleads.v9.services.CampaignCustomizerService", - "google.ads.googleads.v9.services.CampaignDraftService", - "google.ads.googleads.v9.services.CampaignExperimentService", - "google.ads.googleads.v9.services.CampaignExtensionSettingService", - "google.ads.googleads.v9.services.CampaignFeedService", - "google.ads.googleads.v9.services.CampaignLabelService", - "google.ads.googleads.v9.services.CampaignService", - "google.ads.googleads.v9.services.CampaignSharedSetService", - "google.ads.googleads.v9.services.CampaignSimulationService", - "google.ads.googleads.v9.services.CarrierConstantService", - "google.ads.googleads.v9.services.ChangeStatusService", - "google.ads.googleads.v9.services.ClickViewService", - "google.ads.googleads.v9.services.CombinedAudienceService", - "google.ads.googleads.v9.services.ConversionActionService", - "google.ads.googleads.v9.services.ConversionAdjustmentUploadService", - "google.ads.googleads.v9.services.ConversionCustomVariableService", - "google.ads.googleads.v9.services.ConversionGoalCampaignConfigService", - "google.ads.googleads.v9.services.ConversionUploadService", - "google.ads.googleads.v9.services.ConversionValueRuleService", - "google.ads.googleads.v9.services.ConversionValueRuleSetService", - "google.ads.googleads.v9.services.CurrencyConstantService", - "google.ads.googleads.v9.services.CustomAudienceService", - "google.ads.googleads.v9.services.CustomConversionGoalService", - "google.ads.googleads.v9.services.CustomInterestService", - "google.ads.googleads.v9.services.CustomerAssetService", - "google.ads.googleads.v9.services.CustomerClientLinkService", - "google.ads.googleads.v9.services.CustomerClientService", - "google.ads.googleads.v9.services.CustomerConversionGoalService", - "google.ads.googleads.v9.services.CustomerCustomizerService", - "google.ads.googleads.v9.services.CustomerExtensionSettingService", - "google.ads.googleads.v9.services.CustomerFeedService", - "google.ads.googleads.v9.services.CustomerLabelService", - "google.ads.googleads.v9.services.CustomerManagerLinkService", - "google.ads.googleads.v9.services.CustomerNegativeCriterionService", - "google.ads.googleads.v9.services.CustomerService", - "google.ads.googleads.v9.services.CustomerUserAccessInvitationService", - "google.ads.googleads.v9.services.CustomerUserAccessService", - "google.ads.googleads.v9.services.CustomizerAttributeService", - "google.ads.googleads.v9.services.DetailPlacementViewService", - "google.ads.googleads.v9.services.DetailedDemographicService", - "google.ads.googleads.v9.services.DisplayKeywordViewService", - "google.ads.googleads.v9.services.DistanceViewService", - "google.ads.googleads.v9.services.DomainCategoryService", - "google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService", - "google.ads.googleads.v9.services.ExpandedLandingPageViewService", - "google.ads.googleads.v9.services.ExtensionFeedItemService", - "google.ads.googleads.v9.services.FeedItemService", - "google.ads.googleads.v9.services.FeedItemSetLinkService", - "google.ads.googleads.v9.services.FeedItemSetService", - "google.ads.googleads.v9.services.FeedItemTargetService", - "google.ads.googleads.v9.services.FeedMappingService", - "google.ads.googleads.v9.services.FeedPlaceholderViewService", - "google.ads.googleads.v9.services.FeedService", - "google.ads.googleads.v9.services.GenderViewService", - "google.ads.googleads.v9.services.GeoTargetConstantService", - "google.ads.googleads.v9.services.GeographicViewService", - "google.ads.googleads.v9.services.GoogleAdsFieldService", - "google.ads.googleads.v9.services.GoogleAdsService", - "google.ads.googleads.v9.services.GroupPlacementViewService", - "google.ads.googleads.v9.services.HotelGroupViewService", - "google.ads.googleads.v9.services.HotelPerformanceViewService", - "google.ads.googleads.v9.services.IncomeRangeViewService", - "google.ads.googleads.v9.services.InvoiceService", - "google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService", - "google.ads.googleads.v9.services.KeywordPlanAdGroupService", - "google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService", - "google.ads.googleads.v9.services.KeywordPlanCampaignService", - "google.ads.googleads.v9.services.KeywordPlanIdeaService", - "google.ads.googleads.v9.services.KeywordPlanService", - "google.ads.googleads.v9.services.KeywordThemeConstantService", - "google.ads.googleads.v9.services.KeywordViewService", - "google.ads.googleads.v9.services.LabelService", - "google.ads.googleads.v9.services.LandingPageViewService", - "google.ads.googleads.v9.services.LanguageConstantService", - "google.ads.googleads.v9.services.LifeEventService", - "google.ads.googleads.v9.services.LocationViewService", - "google.ads.googleads.v9.services.ManagedPlacementViewService", - "google.ads.googleads.v9.services.MediaFileService", - "google.ads.googleads.v9.services.MerchantCenterLinkService", - "google.ads.googleads.v9.services.MobileAppCategoryConstantService", - "google.ads.googleads.v9.services.MobileDeviceConstantService", - "google.ads.googleads.v9.services.OfflineUserDataJobService", - "google.ads.googleads.v9.services.OperatingSystemVersionConstantService", - "google.ads.googleads.v9.services.PaidOrganicSearchTermViewService", - "google.ads.googleads.v9.services.ParentalStatusViewService", - "google.ads.googleads.v9.services.PaymentsAccountService", - "google.ads.googleads.v9.services.ProductBiddingCategoryConstantService", - "google.ads.googleads.v9.services.ProductGroupViewService", - "google.ads.googleads.v9.services.ReachPlanService", - "google.ads.googleads.v9.services.RecommendationService", - "google.ads.googleads.v9.services.RemarketingActionService", - "google.ads.googleads.v9.services.SearchTermViewService", - "google.ads.googleads.v9.services.SharedCriterionService", - "google.ads.googleads.v9.services.SharedSetService", - "google.ads.googleads.v9.services.ShoppingPerformanceViewService", - "google.ads.googleads.v9.services.SmartCampaignSearchTermViewService", - "google.ads.googleads.v9.services.SmartCampaignSettingService", - "google.ads.googleads.v9.services.SmartCampaignSuggestService", - "google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService", - "google.ads.googleads.v9.services.TopicConstantService", - "google.ads.googleads.v9.services.TopicViewService", - "google.ads.googleads.v9.services.UserDataService", - "google.ads.googleads.v9.services.UserInterestService", - "google.ads.googleads.v9.services.UserListService", - "google.ads.googleads.v9.services.UserLocationViewService", - "google.ads.googleads.v9.services.VideoService", - "google.ads.googleads.v9.services.WebpageViewService" - ] + "google.analytics.admin.v1alpha.AnalyticsAdminService" + ], + "nameInServiceConfig": "analyticsadmin.googleapis.com" }, { - "id": "google.analytics.admin.v1alpha", - "directory": "google/analytics/admin/v1alpha", - "version": "v1alpha", + "id": "google.analytics.admin.v1beta", + "directory": "google/analytics/admin/v1beta", + "version": "v1beta", "majorVersion": "v1", "hostName": "analyticsadmin.googleapis.com", "title": "Google Analytics Admin API", "description": "", "importDirectories": [ - "google/analytics/admin/v1alpha", + "google/analytics/admin/v1beta", "google/api", "google/protobuf" ], "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin": 4 + "google.golang.org/genproto/googleapis/analytics/admin/v1beta;admin": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 4 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.analytics.admin.v1alpha": 4 + "com.google.analytics.admin.v1beta": 2 } } }, "services": [ { "shortName": "AnalyticsAdminService", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService", "methods": [ { "shortName": "AcknowledgeUserDataCollection", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.AcknowledgeUserDataCollection", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.AcknowledgeUserDataCollection", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection" + "path": "/v1beta/{property=properties/*}:acknowledgeUserDataCollection" } ] }, { - "shortName": "ApproveDisplayVideo360AdvertiserLinkProposal", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ApproveDisplayVideo360AdvertiserLinkProposal", + "shortName": "ArchiveCustomDimension", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve" + "path": "/v1beta/{name=properties/*/customDimensions/*}:archive" } ] }, { - "shortName": "ArchiveAudience", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveAudience", + "shortName": "ArchiveCustomMetric", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{name=properties/*/audiences/*}:archive" + "path": "/v1beta/{name=properties/*/customMetrics/*}:archive" } ] }, { - "shortName": "ArchiveCustomDimension", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveCustomDimension", + "shortName": "CreateConversionEvent", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateConversionEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{name=properties/*/customDimensions/*}:archive" + "path": "/v1beta/{parent=properties/*}/conversionEvents" } ] }, { - "shortName": "ArchiveCustomMetric", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ArchiveCustomMetric", + "shortName": "CreateCustomDimension", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{name=properties/*/customMetrics/*}:archive" + "path": "/v1beta/{parent=properties/*}/customDimensions" } ] }, { - "shortName": "AuditUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.AuditUserLinks", + "shortName": "CreateCustomMetric", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=accounts/*}/userLinks:audit" - }, - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/userLinks:audit" - } - ] - }, - { - "shortName": "BatchCreateUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=accounts/*}/userLinks:batchCreate" - }, - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/userLinks:batchCreate" - } - ] - }, - { - "shortName": "BatchDeleteUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=accounts/*}/userLinks:batchDelete" - }, - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/userLinks:batchDelete" - } - ] - }, - { - "shortName": "BatchGetUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{parent=accounts/*}/userLinks:batchGet" - }, - { - "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/userLinks:batchGet" - } - ] - }, - { - "shortName": "BatchUpdateUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate" - }, - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/userLinks:batchUpdate" - } - ] - }, - { - "shortName": "CancelDisplayVideo360AdvertiserLinkProposal", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CancelDisplayVideo360AdvertiserLinkProposal", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel" - } - ] - }, - { - "shortName": "CreateAudience", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateAudience", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/audiences" - } - ] - }, - { - "shortName": "CreateConversionEvent", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateConversionEvent", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/conversionEvents" - } - ] - }, - { - "shortName": "CreateCustomDimension", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateCustomDimension", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/customDimensions" - } - ] - }, - { - "shortName": "CreateCustomMetric", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateCustomMetric", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/customMetrics" + "path": "/v1beta/{parent=properties/*}/customMetrics" } ] }, { "shortName": "CreateDataStream", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDataStream", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/dataStreams" - } - ] - }, - { - "shortName": "CreateDisplayVideo360AdvertiserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDisplayVideo360AdvertiserLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" - } - ] - }, - { - "shortName": "CreateDisplayVideo360AdvertiserLinkProposal", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateDataStream", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" + "path": "/v1beta/{parent=properties/*}/dataStreams" } ] }, { "shortName": "CreateFirebaseLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateFirebaseLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateFirebaseLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/firebaseLinks" + "path": "/v1beta/{parent=properties/*}/firebaseLinks" } ] }, { "shortName": "CreateGoogleAdsLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateGoogleAdsLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateGoogleAdsLink", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/googleAdsLinks" + "path": "/v1beta/{parent=properties/*}/googleAdsLinks" } ] }, { "shortName": "CreateMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" + "path": "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" } ] }, { "shortName": "CreateProperty", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateProperty", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/properties" - } - ] - }, - { - "shortName": "CreateUserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateProperty", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{parent=accounts/*}/userLinks" - }, - { - "httpMethod": "POST", - "path": "/v1alpha/{parent=properties/*}/userLinks" + "path": "/v1beta/properties" } ] }, { "shortName": "DeleteAccount", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteAccount", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteAccount", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=accounts/*}" + "path": "/v1beta/{name=accounts/*}" } ] }, { "shortName": "DeleteConversionEvent", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteConversionEvent", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteConversionEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/conversionEvents/*}" + "path": "/v1beta/{name=properties/*/conversionEvents/*}" } ] }, { "shortName": "DeleteDataStream", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDataStream", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/dataStreams/*}" - } - ] - }, - { - "shortName": "DeleteDisplayVideo360AdvertiserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDisplayVideo360AdvertiserLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" - } - ] - }, - { - "shortName": "DeleteDisplayVideo360AdvertiserLinkProposal", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteDisplayVideo360AdvertiserLinkProposal", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteDataStream", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" + "path": "/v1beta/{name=properties/*/dataStreams/*}" } ] }, { "shortName": "DeleteFirebaseLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteFirebaseLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteFirebaseLink", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/firebaseLinks/*}" + "path": "/v1beta/{name=properties/*/firebaseLinks/*}" } ] }, { "shortName": "DeleteGoogleAdsLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteGoogleAdsLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteGoogleAdsLink", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/googleAdsLinks/*}" + "path": "/v1beta/{name=properties/*/googleAdsLinks/*}" } ] }, { "shortName": "DeleteMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + "path": "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" } ] }, { "shortName": "DeleteProperty", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteProperty", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*}" - } - ] - }, - { - "shortName": "DeleteUserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteProperty", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1alpha/{name=accounts/*/userLinks/*}" - }, - { - "httpMethod": "DELETE", - "path": "/v1alpha/{name=properties/*/userLinks/*}" + "path": "/v1beta/{name=properties/*}" } ] }, { "shortName": "GetAccount", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=accounts/*}" - } - ] - }, - { - "shortName": "GetAttributionSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAttributionSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/attributionSettings}" - } - ] - }, - { - "shortName": "GetAudience", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAudience", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetAccount", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/audiences/*}" + "path": "/v1beta/{name=accounts/*}" } ] }, { "shortName": "GetConversionEvent", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetConversionEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/conversionEvents/*}" + "path": "/v1beta/{name=properties/*/conversionEvents/*}" } ] }, { "shortName": "GetCustomDimension", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomDimension", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/customDimensions/*}" + "path": "/v1beta/{name=properties/*/customDimensions/*}" } ] }, { "shortName": "GetCustomMetric", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomMetric", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/customMetrics/*}" + "path": "/v1beta/{name=properties/*/customMetrics/*}" } ] }, { "shortName": "GetDataRetentionSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataRetentionSettings", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataRetentionSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/dataRetentionSettings}" + "path": "/v1beta/{name=properties/*/dataRetentionSettings}" } ] }, { "shortName": "GetDataSharingSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataSharingSettings", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataSharingSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=accounts/*/dataSharingSettings}" + "path": "/v1beta/{name=accounts/*/dataSharingSettings}" } ] }, { "shortName": "GetDataStream", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataStream", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/dataStreams/*}" - } - ] - }, - { - "shortName": "GetDisplayVideo360AdvertiserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" - } - ] - }, - { - "shortName": "GetDisplayVideo360AdvertiserLinkProposal", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" - } - ] - }, - { - "shortName": "GetGlobalSiteTag", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}" - } - ] - }, - { - "shortName": "GetGoogleSignalsSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetGoogleSignalsSettings", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataStream", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/googleSignalsSettings}" + "path": "/v1beta/{name=properties/*/dataStreams/*}" } ] }, { "shortName": "GetMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + "path": "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" } ] }, { "shortName": "GetProperty", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetProperty", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*}" - } - ] - }, - { - "shortName": "GetUserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetProperty", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{name=accounts/*/userLinks/*}" - }, - { - "httpMethod": "GET", - "path": "/v1alpha/{name=properties/*/userLinks/*}" + "path": "/v1beta/{name=properties/*}" } ] }, { "shortName": "ListAccountSummaries", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListAccountSummaries", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/accountSummaries" + "path": "/v1beta/accountSummaries" } ] }, { "shortName": "ListAccounts", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccounts", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/accounts" - } - ] - }, - { - "shortName": "ListAudiences", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAudiences", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListAccounts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/audiences" + "path": "/v1beta/accounts" } ] }, { "shortName": "ListConversionEvents", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListConversionEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/conversionEvents" + "path": "/v1beta/{parent=properties/*}/conversionEvents" } ] }, { "shortName": "ListCustomDimensions", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomDimensions", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomDimensions", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/customDimensions" + "path": "/v1beta/{parent=properties/*}/customDimensions" } ] }, { "shortName": "ListCustomMetrics", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomMetrics", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomMetrics", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/customMetrics" + "path": "/v1beta/{parent=properties/*}/customMetrics" } ] }, { "shortName": "ListDataStreams", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDataStreams", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/dataStreams" - } - ] - }, - { - "shortName": "ListDisplayVideo360AdvertiserLinkProposals", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinkProposals", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" - } - ] - }, - { - "shortName": "ListDisplayVideo360AdvertiserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinks", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListDataStreams", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" + "path": "/v1beta/{parent=properties/*}/dataStreams" } ] }, { "shortName": "ListFirebaseLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListFirebaseLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/firebaseLinks" + "path": "/v1beta/{parent=properties/*}/firebaseLinks" } ] }, { "shortName": "ListGoogleAdsLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListGoogleAdsLinks", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListGoogleAdsLinks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/googleAdsLinks" + "path": "/v1beta/{parent=properties/*}/googleAdsLinks" } ] }, { "shortName": "ListMeasurementProtocolSecrets", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListMeasurementProtocolSecrets", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListMeasurementProtocolSecrets", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" + "path": "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" } ] }, { "shortName": "ListProperties", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListProperties", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1alpha/properties" - } - ] - }, - { - "shortName": "ListUserLinks", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListProperties", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1alpha/{parent=accounts/*}/userLinks" - }, - { - "httpMethod": "GET", - "path": "/v1alpha/{parent=properties/*}/userLinks" + "path": "/v1beta/properties" } ] }, { "shortName": "ProvisionAccountTicket", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ProvisionAccountTicket", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/accounts:provisionAccountTicket" - } - ] - }, - { - "shortName": "RunAccessReport", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.RunAccessReport", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ProvisionAccountTicket", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{entity=properties/*}:runAccessReport" + "path": "/v1beta/accounts:provisionAccountTicket" } ] }, { "shortName": "SearchChangeHistoryEvents", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.SearchChangeHistoryEvents", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.SearchChangeHistoryEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1alpha/{account=accounts/*}:searchChangeHistoryEvents" + "path": "/v1beta/{account=accounts/*}:searchChangeHistoryEvents" } ] }, { "shortName": "UpdateAccount", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAccount", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateAccount", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{account.name=accounts/*}" + "path": "/v1beta/{account.name=accounts/*}" } ] }, { - "shortName": "UpdateAttributionSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAttributionSettings", + "shortName": "UpdateCustomDimension", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomDimension", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{attribution_settings.name=properties/*/attributionSettings}" + "path": "/v1beta/{custom_dimension.name=properties/*/customDimensions/*}" } ] }, { - "shortName": "UpdateAudience", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAudience", + "shortName": "UpdateCustomMetric", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomMetric", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{audience.name=properties/*/audiences/*}" + "path": "/v1beta/{custom_metric.name=properties/*/customMetrics/*}" } ] }, { - "shortName": "UpdateCustomDimension", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateCustomDimension", + "shortName": "UpdateDataRetentionSettings", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataRetentionSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{custom_dimension.name=properties/*/customDimensions/*}" + "path": "/v1beta/{data_retention_settings.name=properties/*/dataRetentionSettings}" } ] }, { - "shortName": "UpdateCustomMetric", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateCustomMetric", + "shortName": "UpdateDataStream", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataStream", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{custom_metric.name=properties/*/customMetrics/*}" + "path": "/v1beta/{data_stream.name=properties/*/dataStreams/*}" } ] }, { - "shortName": "UpdateDataRetentionSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDataRetentionSettings", + "shortName": "UpdateGoogleAdsLink", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateGoogleAdsLink", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{data_retention_settings.name=properties/*/dataRetentionSettings}" + "path": "/v1beta/{google_ads_link.name=properties/*/googleAdsLinks/*}" } ] }, { - "shortName": "UpdateDataStream", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDataStream", + "shortName": "UpdateMeasurementProtocolSecret", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateMeasurementProtocolSecret", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{data_stream.name=properties/*/dataStreams/*}" + "path": "/v1beta/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" } ] }, { - "shortName": "UpdateDisplayVideo360AdvertiserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateDisplayVideo360AdvertiserLink", + "shortName": "UpdateProperty", + "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateProperty", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1alpha/{display_video_360_advertiser_link.name=properties/*/displayVideo360AdvertiserLinks/*}" - } - ] - }, - { - "shortName": "UpdateGoogleAdsLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateGoogleAdsLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1alpha/{google_ads_link.name=properties/*/googleAdsLinks/*}" - } - ] - }, - { - "shortName": "UpdateGoogleSignalsSettings", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateGoogleSignalsSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1alpha/{google_signals_settings.name=properties/*/googleSignalsSettings}" - } - ] - }, - { - "shortName": "UpdateMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateMeasurementProtocolSecret", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1alpha/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - } - ] - }, - { - "shortName": "UpdateProperty", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateProperty", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1alpha/{property.name=properties/*}" - } - ] - }, - { - "shortName": "UpdateUserLink", - "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1alpha/{user_link.name=accounts/*/userLinks/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1alpha/{user_link.name=properties/*/userLinks/*}" + "path": "/v1beta/{property.name=properties/*}" } ] } @@ -9877,26 +8991,27 @@ ], "configFile": "analyticsadmin.yaml", "serviceConfigApiNames": [ - "google.analytics.admin.v1alpha.AnalyticsAdminService" - ] + "google.analytics.admin.v1beta.AnalyticsAdminService" + ], + "nameInServiceConfig": "analyticsadmin.googleapis.com" }, { - "id": "google.analytics.admin.v1beta", - "directory": "google/analytics/admin/v1beta", - "version": "v1beta", + "id": "google.analytics.data.v1alpha", + "directory": "google/analytics/data/v1alpha", + "version": "v1alpha", "majorVersion": "v1", - "hostName": "analyticsadmin.googleapis.com", - "title": "Google Analytics Admin API", - "description": "", + "hostName": "analyticsdata.googleapis.com", + "title": "Google Analytics Data API", + "description": "Accesses report data in Google Analytics.", "importDirectories": [ - "google/analytics/admin/v1beta", + "google/analytics/data/v1alpha", "google/api", "google/protobuf" ], "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/analytics/admin/v1beta;admin": 2 + "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data": 2 } }, "java_multiple_files": { @@ -9906,557 +9021,743 @@ }, "java_package": { "valueCounts": { - "com.google.analytics.admin.v1beta": 2 + "com.google.analytics.data.v1alpha": 2 } } }, "services": [ { - "shortName": "AnalyticsAdminService", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService", + "shortName": "AlphaAnalyticsData", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData", "methods": [ { - "shortName": "AcknowledgeUserDataCollection", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.AcknowledgeUserDataCollection", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:acknowledgeUserDataCollection" - } - ] - }, - { - "shortName": "ArchiveCustomDimension", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomDimension", + "shortName": "RunFunnelReport", + "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{name=properties/*/customDimensions/*}:archive" + "path": "/v1alpha/{property=properties/*}:runFunnelReport" } ] - }, + } + ] + } + ], + "configFile": "analyticsdata_v1alpha.yaml", + "serviceConfigApiNames": [ + "google.analytics.data.v1alpha.AlphaAnalyticsData" + ], + "nameInServiceConfig": "analyticsdata.googleapis.com" + }, + { + "id": "google.analytics.data.v1beta", + "directory": "google/analytics/data/v1beta", + "version": "v1beta", + "majorVersion": "v1", + "hostName": "analyticsdata.googleapis.com", + "title": "Google Analytics Data API", + "description": "Accesses report data in Google Analytics.", + "importDirectories": [ + "google/analytics/data/v1beta", + "google/api" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/analytics/data/v1beta;data": 2 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 2 + } + }, + "java_package": { + "valueCounts": { + "com.google.analytics.data.v1beta": 2 + } + } + }, + "services": [ + { + "shortName": "BetaAnalyticsData", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData", + "methods": [ { - "shortName": "ArchiveCustomMetric", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ArchiveCustomMetric", + "shortName": "BatchRunPivotReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReports", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{name=properties/*/customMetrics/*}:archive" + "path": "/v1beta/{property=properties/*}:batchRunPivotReports" } ] }, { - "shortName": "CreateConversionEvent", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateConversionEvent", + "shortName": "BatchRunReports", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReports", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/conversionEvents" + "path": "/v1beta/{property=properties/*}:batchRunReports" } ] }, { - "shortName": "CreateCustomDimension", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomDimension", + "shortName": "CheckCompatibility", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibility", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/customDimensions" + "path": "/v1beta/{property=properties/*}:checkCompatibility" } ] }, { - "shortName": "CreateCustomMetric", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateCustomMetric", + "shortName": "GetMetadata", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.GetMetadata", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/customMetrics" + "httpMethod": "GET", + "path": "/v1beta/{name=properties/*/metadata}" } ] }, { - "shortName": "CreateDataStream", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateDataStream", + "shortName": "RunPivotReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/dataStreams" + "path": "/v1beta/{property=properties/*}:runPivotReport" } ] }, { - "shortName": "CreateFirebaseLink", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateFirebaseLink", + "shortName": "RunRealtimeReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/firebaseLinks" + "path": "/v1beta/{property=properties/*}:runRealtimeReport" } ] }, { - "shortName": "CreateGoogleAdsLink", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateGoogleAdsLink", + "shortName": "RunReport", + "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunReport", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*}/googleAdsLinks" + "path": "/v1beta/{property=properties/*}:runReport" } ] - }, + } + ] + } + ], + "configFile": "analyticsdata_v1beta.yaml", + "serviceConfigApiNames": [ + "google.analytics.data.v1beta.BetaAnalyticsData" + ], + "nameInServiceConfig": "analyticsdata.googleapis.com" + }, + { + "id": "google.api.apikeys.v2", + "directory": "google/api/apikeys/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "apikeys.googleapis.com", + "title": "API Keys API", + "description": "Manages the API keys associated with developer projects.", + "importDirectories": [ + "google/api", + "google/api/apikeys/v2", + "google/longrunning", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ApiKeys.V2": 2 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/api/apikeys/v2;apikeys": 2 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 2 + } + }, + "java_package": { + "valueCounts": { + "com.google.api.apikeys.v2": 2 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ApiKeys\\V2": 2 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ApiKeys::V2": 2 + } + } + }, + "services": [ + { + "shortName": "ApiKeys", + "fullName": "google.api.apikeys.v2.ApiKeys", + "methods": [ { - "shortName": "CreateMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateMeasurementProtocolSecret", + "shortName": "CreateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.CreateKey", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" + "path": "/v2/{parent=projects/*/locations/*}/keys" } ] }, { - "shortName": "CreateProperty", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.CreateProperty", + "shortName": "DeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.DeleteKey", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta/properties" + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/keys/*}" } ] }, { - "shortName": "DeleteAccount", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteAccount", + "shortName": "GetKey", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKey", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=accounts/*}" + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/keys/*}" } ] }, { - "shortName": "DeleteConversionEvent", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteConversionEvent", + "shortName": "GetKeyString", + "fullName": "google.api.apikeys.v2.ApiKeys.GetKeyString", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*/conversionEvents/*}" + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/keys/*}/keyString" } ] }, { - "shortName": "DeleteDataStream", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteDataStream", + "shortName": "ListKeys", + "fullName": "google.api.apikeys.v2.ApiKeys.ListKeys", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*/dataStreams/*}" + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/keys" } ] }, { - "shortName": "DeleteFirebaseLink", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteFirebaseLink", + "shortName": "LookupKey", + "fullName": "google.api.apikeys.v2.ApiKeys.LookupKey", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*/firebaseLinks/*}" + "httpMethod": "GET", + "path": "/v2/keys:lookupKey" } ] }, { - "shortName": "DeleteGoogleAdsLink", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteGoogleAdsLink", + "shortName": "UndeleteKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UndeleteKey", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*/googleAdsLinks/*}" + "httpMethod": "POST", + "path": "/v2/{name=projects/*/locations/*/keys/*}:undelete" } ] }, { - "shortName": "DeleteMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteMeasurementProtocolSecret", + "shortName": "UpdateKey", + "fullName": "google.api.apikeys.v2.ApiKeys.UpdateKey", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + "httpMethod": "PATCH", + "path": "/v2/{key.name=projects/*/locations/*/keys/*}" } ] - }, + } + ] + } + ], + "configFile": "apikeys_v2.yaml", + "serviceConfigApiNames": [ + "google.api.apikeys.v2.ApiKeys", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "apikeys.googleapis.com" + }, + { + "id": "google.api.servicecontrol.v1", + "directory": "google/api/servicecontrol/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "servicecontrol.googleapis.com", + "title": "Service Control API", + "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", + "importDirectories": [ + "google/api", + "google/api/servicecontrol/v1", + "google/logging/type", + "google/protobuf", + "google/rpc" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "": 2, + "true": 6 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceControl.V1": 8 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/api/servicecontrol/v1;servicecontrol": 8 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 8 + } + }, + "java_package": { + "valueCounts": { + "com.google.api.servicecontrol.v1": 8 + } + }, + "objc_class_prefix": { + "valueCounts": { + "": 7, + "GASC": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ServiceControl\\V1": 8 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ServiceControl::V1": 8 + } + } + }, + "services": [ + { + "shortName": "QuotaController", + "fullName": "google.api.servicecontrol.v1.QuotaController", + "methods": [ { - "shortName": "DeleteProperty", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.DeleteProperty", + "shortName": "AllocateQuota", + "fullName": "google.api.servicecontrol.v1.QuotaController.AllocateQuota", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta/{name=properties/*}" + "httpMethod": "POST", + "path": "/v1/services/{service_name}:allocateQuota" } ] - }, + } + ] + }, + { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v1.ServiceController", + "methods": [ { - "shortName": "GetAccount", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetAccount", + "shortName": "Check", + "fullName": "google.api.servicecontrol.v1.ServiceController.Check", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=accounts/*}" + "httpMethod": "POST", + "path": "/v1/services/{service_name}:check" } ] }, { - "shortName": "GetConversionEvent", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetConversionEvent", + "shortName": "Report", + "fullName": "google.api.servicecontrol.v1.ServiceController.Report", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/conversionEvents/*}" + "httpMethod": "POST", + "path": "/v1/services/{service_name}:report" } ] - }, + } + ] + } + ], + "configFile": "servicecontrol.yaml", + "serviceConfigApiNames": [ + "google.api.servicecontrol.v1.QuotaController", + "google.api.servicecontrol.v1.ServiceController" + ], + "nameInServiceConfig": "servicecontrol.googleapis.com" + }, + { + "id": "google.api.servicecontrol.v2", + "directory": "google/api/servicecontrol/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "servicecontrol.googleapis.com", + "title": "Service Control API", + "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", + "importDirectories": [ + "google/api", + "google/rpc", + "google/rpc/context" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 1 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceControl.V2": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/api/servicecontrol/v2;servicecontrol": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.api.servicecontrol.v2": 1 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GASC": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ServiceControl\\V2": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ServiceControl::V2": 1 + } + } + }, + "services": [ + { + "shortName": "ServiceController", + "fullName": "google.api.servicecontrol.v2.ServiceController", + "methods": [ { - "shortName": "GetCustomDimension", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomDimension", + "shortName": "Check", + "fullName": "google.api.servicecontrol.v2.ServiceController.Check", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/customDimensions/*}" + "httpMethod": "POST", + "path": "/v2/services/{service_name}:check" } ] }, { - "shortName": "GetCustomMetric", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomMetric", + "shortName": "Report", + "fullName": "google.api.servicecontrol.v2.ServiceController.Report", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/customMetrics/*}" + "httpMethod": "POST", + "path": "/v2/services/{service_name}:report" } ] - }, - { - "shortName": "GetDataRetentionSettings", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataRetentionSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/dataRetentionSettings}" - } - ] - }, - { - "shortName": "GetDataSharingSettings", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataSharingSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta/{name=accounts/*/dataSharingSettings}" - } - ] - }, - { - "shortName": "GetDataStream", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetDataStream", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/dataStreams/*}" - } - ] - }, + } + ] + } + ], + "configFile": "servicecontrol.yaml", + "serviceConfigApiNames": [ + "google.api.servicecontrol.v2.ServiceController" + ], + "nameInServiceConfig": "servicecontrol.googleapis.com" + }, + { + "id": "google.api.servicemanagement.v1", + "directory": "google/api/servicemanagement/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "servicemanagement.googleapis.com", + "title": "Service Management API", + "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.", + "importDirectories": [ + "google/api", + "google/api/servicemanagement/v1", + "google/longrunning", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceManagement.V1": 2 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/api/servicemanagement/v1;servicemanagement": 2 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 2 + } + }, + "java_package": { + "valueCounts": { + "com.google.api.servicemanagement.v1": 2 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GASM": 2 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ServiceManagement\\V1": 2 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ServiceManagement::V1": 2 + } + } + }, + "services": [ + { + "shortName": "ServiceManager", + "fullName": "google.api.servicemanagement.v1.ServiceManager", + "methods": [ { - "shortName": "GetMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetMeasurementProtocolSecret", + "shortName": "CreateService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateService", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" + "httpMethod": "POST", + "path": "/v1/services" } ] }, { - "shortName": "GetProperty", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.GetProperty", + "shortName": "CreateServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*}" + "httpMethod": "POST", + "path": "/v1/services/{service_name}/configs" } ] }, { - "shortName": "ListAccountSummaries", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListAccountSummaries", + "shortName": "CreateServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/accountSummaries" + "httpMethod": "POST", + "path": "/v1/services/{service_name}/rollouts" } ] }, { - "shortName": "ListAccounts", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListAccounts", + "shortName": "DeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.DeleteService", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/accounts" + "httpMethod": "DELETE", + "path": "/v1/services/{service_name}" } ] }, { - "shortName": "ListConversionEvents", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListConversionEvents", + "shortName": "GenerateConfigReport", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GenerateConfigReport", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/conversionEvents" + "httpMethod": "POST", + "path": "/v1/services:generateConfigReport" } ] }, { - "shortName": "ListCustomDimensions", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomDimensions", + "shortName": "GetService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetService", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/customDimensions" + "path": "/v1/services/{service_name}" } ] }, { - "shortName": "ListCustomMetrics", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomMetrics", + "shortName": "GetServiceConfig", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/customMetrics" - } - ] - }, - { - "shortName": "ListDataStreams", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListDataStreams", - "mode": "UNARY", - "bindings": [ + "path": "/v1/services/{service_name}/configs/{config_id}" + }, { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/dataStreams" + "path": "/v1/services/{service_name}/config" } ] }, { - "shortName": "ListFirebaseLinks", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListFirebaseLinks", + "shortName": "GetServiceRollout", + "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceRollout", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/firebaseLinks" + "path": "/v1/services/{service_name}/rollouts/{rollout_id}" } ] }, { - "shortName": "ListGoogleAdsLinks", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListGoogleAdsLinks", + "shortName": "ListServiceConfigs", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceConfigs", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*}/googleAdsLinks" + "path": "/v1/services/{service_name}/configs" } ] }, { - "shortName": "ListMeasurementProtocolSecrets", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListMeasurementProtocolSecrets", + "shortName": "ListServiceRollouts", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceRollouts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" + "path": "/v1/services/{service_name}/rollouts" } ] }, { - "shortName": "ListProperties", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ListProperties", + "shortName": "ListServices", + "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServices", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta/properties" + "path": "/v1/services" } ] }, { - "shortName": "ProvisionAccountTicket", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.ProvisionAccountTicket", + "shortName": "SubmitConfigSource", + "fullName": "google.api.servicemanagement.v1.ServiceManager.SubmitConfigSource", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/accounts:provisionAccountTicket" + "path": "/v1/services/{service_name}/configs:submit" } ] }, { - "shortName": "SearchChangeHistoryEvents", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.SearchChangeHistoryEvents", + "shortName": "UndeleteService", + "fullName": "google.api.servicemanagement.v1.ServiceManager.UndeleteService", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{account=accounts/*}:searchChangeHistoryEvents" - } - ] - }, - { - "shortName": "UpdateAccount", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateAccount", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{account.name=accounts/*}" - } - ] - }, - { - "shortName": "UpdateCustomDimension", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomDimension", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{custom_dimension.name=properties/*/customDimensions/*}" - } - ] - }, - { - "shortName": "UpdateCustomMetric", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateCustomMetric", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{custom_metric.name=properties/*/customMetrics/*}" - } - ] - }, - { - "shortName": "UpdateDataRetentionSettings", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataRetentionSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{data_retention_settings.name=properties/*/dataRetentionSettings}" - } - ] - }, - { - "shortName": "UpdateDataStream", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateDataStream", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{data_stream.name=properties/*/dataStreams/*}" - } - ] - }, - { - "shortName": "UpdateGoogleAdsLink", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateGoogleAdsLink", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{google_ads_link.name=properties/*/googleAdsLinks/*}" - } - ] - }, - { - "shortName": "UpdateMeasurementProtocolSecret", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateMeasurementProtocolSecret", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - } - ] - }, - { - "shortName": "UpdateProperty", - "fullName": "google.analytics.admin.v1beta.AnalyticsAdminService.UpdateProperty", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta/{property.name=properties/*}" + "path": "/v1/services/{service_name}:undelete" } ] } ] } ], - "configFile": "analyticsadmin.yaml", + "configFile": "servicemanagement_v1.yaml", "serviceConfigApiNames": [ - "google.analytics.admin.v1beta.AnalyticsAdminService" - ] + "google.api.servicemanagement.v1.ServiceManager" + ], + "nameInServiceConfig": "servicemanagement.googleapis.com" }, { - "id": "google.analytics.data.v1alpha", - "directory": "google/analytics/data/v1alpha", - "version": "v1alpha", + "id": "google.api.serviceusage.v1", + "directory": "google/api/serviceusage/v1", + "version": "v1", "majorVersion": "v1", - "hostName": "analyticsdata.googleapis.com", - "title": "Google Analytics Data API", - "description": "Accesses report data in Google Analytics.", + "hostName": "serviceusage.googleapis.com", + "title": "Service Usage API", + "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "importDirectories": [ - "google/analytics/data/v1alpha", "google/api", + "google/api/serviceusage/v1", + "google/longrunning", "google/protobuf" ], "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceUsage.V1": 2 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data": 2 + "google.golang.org/genproto/googleapis/api/serviceusage/v1;serviceusage": 2 } }, "java_multiple_files": { @@ -10466,176 +9767,123 @@ }, "java_package": { "valueCounts": { - "com.google.analytics.data.v1alpha": 2 - } - } - }, - "services": [ - { - "shortName": "AlphaAnalyticsData", - "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData", - "methods": [ - { - "shortName": "RunFunnelReport", - "fullName": "google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1alpha/{property=properties/*}:runFunnelReport" - } - ] - } - ] - } - ], - "configFile": "analyticsdata_v1alpha.yaml", - "serviceConfigApiNames": [ - "google.analytics.data.v1alpha.AlphaAnalyticsData" - ] - }, - { - "id": "google.analytics.data.v1beta", - "directory": "google/analytics/data/v1beta", - "version": "v1beta", - "majorVersion": "v1", - "hostName": "analyticsdata.googleapis.com", - "title": "Google Analytics Data API", - "description": "Accesses report data in Google Analytics.", - "importDirectories": [ - "google/analytics/data/v1beta", - "google/api" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/analytics/data/v1beta;data": 2 + "com.google.api.serviceusage.v1": 2 } }, - "java_multiple_files": { + "php_namespace": { "valueCounts": { - "true": 2 + "Google\\Cloud\\ServiceUsage\\V1": 2 } }, - "java_package": { + "ruby_package": { "valueCounts": { - "com.google.analytics.data.v1beta": 2 + "Google::Cloud::ServiceUsage::V1": 2 } } }, "services": [ { - "shortName": "BetaAnalyticsData", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData", + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1.ServiceUsage", "methods": [ { - "shortName": "BatchRunPivotReports", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReports", + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchEnableServices", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:batchRunPivotReports" + "path": "/v1/{parent=*/*}/services:batchEnable" } ] }, { - "shortName": "BatchRunReports", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReports", + "shortName": "BatchGetServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchGetServices", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:batchRunReports" + "httpMethod": "GET", + "path": "/v1/{parent=*/*}/services:batchGet" } ] }, { - "shortName": "CheckCompatibility", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibility", + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.DisableService", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:checkCompatibility" - } - ] - }, - { - "shortName": "GetMetadata", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.GetMetadata", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta/{name=properties/*/metadata}" + "path": "/v1/{name=*/*/services/*}:disable" } ] }, { - "shortName": "RunPivotReport", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReport", + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.EnableService", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:runPivotReport" + "path": "/v1/{name=*/*/services/*}:enable" } ] }, { - "shortName": "RunRealtimeReport", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReport", + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1.ServiceUsage.GetService", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:runRealtimeReport" + "httpMethod": "GET", + "path": "/v1/{name=*/*/services/*}" } ] }, { - "shortName": "RunReport", - "fullName": "google.analytics.data.v1beta.BetaAnalyticsData.RunReport", + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1.ServiceUsage.ListServices", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta/{property=properties/*}:runReport" + "httpMethod": "GET", + "path": "/v1/{parent=*/*}/services" } ] } ] } ], - "configFile": "analyticsdata_v1beta.yaml", + "configFile": "serviceusage_v1.yaml", "serviceConfigApiNames": [ - "google.analytics.data.v1beta.BetaAnalyticsData" - ] + "google.api.serviceusage.v1.ServiceUsage" + ], + "nameInServiceConfig": "serviceusage.googleapis.com" }, { - "id": "google.api.apikeys.v2", - "directory": "google/api/apikeys/v2", - "version": "v2", - "majorVersion": "v2", - "hostName": "apikeys.googleapis.com", - "title": "API Keys API", - "description": "Manages the API keys associated with developer projects.", + "id": "google.api.serviceusage.v1beta1", + "directory": "google/api/serviceusage/v1beta1", + "version": "v1beta1", + "majorVersion": "v1", + "hostName": "serviceusage.googleapis.com", + "title": "Service Usage API", + "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "importDirectories": [ "google/api", - "google/api/apikeys/v2", + "google/api/serviceusage/v1beta1", "google/longrunning", "google/protobuf" ], "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.ApiKeys.V2": 2 + "Google.Api.ServiceUsage.V1Beta1": 2 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/api/apikeys/v2;apikeys": 2 + "google.golang.org/genproto/googleapis/api/serviceusage/v1beta1;serviceusage": 2 } }, "java_multiple_files": { @@ -10645,1663 +9893,1331 @@ }, "java_package": { "valueCounts": { - "com.google.api.apikeys.v2": 2 + "com.google.api.serviceusage.v1beta1": 2 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\ApiKeys\\V2": 2 + "Google\\Api\\ServiceUsage\\V1beta1": 2 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::ApiKeys::V2": 2 + "Google::Api::ServiceUsage::V1beta1": 2 } } }, "services": [ { - "shortName": "ApiKeys", - "fullName": "google.api.apikeys.v2.ApiKeys", + "shortName": "ServiceUsage", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage", "methods": [ { - "shortName": "CreateKey", - "fullName": "google.api.apikeys.v2.ApiKeys.CreateKey", + "shortName": "BatchEnableServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.BatchEnableServices", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*}/keys" + "path": "/v1beta1/{parent=*/*}/services:batchEnable" } ] }, { - "shortName": "DeleteKey", - "fullName": "google.api.apikeys.v2.ApiKeys.DeleteKey", + "shortName": "CreateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateAdminOverride", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/keys/*}" + "httpMethod": "POST", + "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/adminOverrides" } ] }, { - "shortName": "GetKey", - "fullName": "google.api.apikeys.v2.ApiKeys.GetKey", + "shortName": "CreateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateConsumerOverride", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/keys/*}" + "httpMethod": "POST", + "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/consumerOverrides" } ] }, { - "shortName": "GetKeyString", - "fullName": "google.api.apikeys.v2.ApiKeys.GetKeyString", + "shortName": "DeleteAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteAdminOverride", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/keys/*}/keyString" + "httpMethod": "DELETE", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/adminOverrides/*}" } ] }, { - "shortName": "ListKeys", - "fullName": "google.api.apikeys.v2.ApiKeys.ListKeys", + "shortName": "DeleteConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteConsumerOverride", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*}/keys" + "httpMethod": "DELETE", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/consumerOverrides/*}" } ] }, { - "shortName": "LookupKey", - "fullName": "google.api.apikeys.v2.ApiKeys.LookupKey", + "shortName": "DisableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DisableService", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2/keys:lookupKey" + "httpMethod": "POST", + "path": "/v1beta1/{name=*/*/services/*}:disable" } ] }, { - "shortName": "UndeleteKey", - "fullName": "google.api.apikeys.v2.ApiKeys.UndeleteKey", + "shortName": "EnableService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.EnableService", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/keys/*}:undelete" + "path": "/v1beta1/{name=*/*/services/*}:enable" } ] }, { - "shortName": "UpdateKey", - "fullName": "google.api.apikeys.v2.ApiKeys.UpdateKey", + "shortName": "GenerateServiceIdentity", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GenerateServiceIdentity", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2/{key.name=projects/*/locations/*/keys/*}" + "httpMethod": "POST", + "path": "/v1beta1/{parent=*/*/services/*}:generateServiceIdentity" } ] - } - ] - } - ], - "configFile": "apikeys_v2.yaml", - "serviceConfigApiNames": [ - "google.api.apikeys.v2.ApiKeys", - "google.longrunning.Operations" - ] - }, - { - "id": "google.api.servicecontrol.v1", - "directory": "google/api/servicecontrol/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "servicecontrol.googleapis.com", - "title": "Service Control API", - "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", - "importDirectories": [ - "google/api", - "google/api/servicecontrol/v1", - "google/logging/type", - "google/protobuf", - "google/rpc" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "": 2, - "true": 6 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.ServiceControl.V1": 8 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/api/servicecontrol/v1;servicecontrol": 8 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 8 - } - }, - "java_package": { - "valueCounts": { - "com.google.api.servicecontrol.v1": 8 - } - }, - "objc_class_prefix": { - "valueCounts": { - "": 7, - "GASC": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\ServiceControl\\V1": 8 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::ServiceControl::V1": 8 - } - } - }, - "services": [ - { - "shortName": "QuotaController", - "fullName": "google.api.servicecontrol.v1.QuotaController", - "methods": [ + }, { - "shortName": "AllocateQuota", - "fullName": "google.api.servicecontrol.v1.QuotaController.AllocateQuota", + "shortName": "GetConsumerQuotaLimit", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaLimit", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}:allocateQuota" + "httpMethod": "GET", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*}" } ] - } - ] - }, - { - "shortName": "ServiceController", - "fullName": "google.api.servicecontrol.v1.ServiceController", - "methods": [ + }, { - "shortName": "Check", - "fullName": "google.api.servicecontrol.v1.ServiceController.Check", + "shortName": "GetConsumerQuotaMetric", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaMetric", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}:check" + "httpMethod": "GET", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*}" } ] }, { - "shortName": "Report", - "fullName": "google.api.servicecontrol.v1.ServiceController.Report", + "shortName": "GetService", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetService", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}:report" + "httpMethod": "GET", + "path": "/v1beta1/{name=*/*/services/*}" } ] - } - ] - } - ], - "configFile": "servicecontrol.yaml", - "serviceConfigApiNames": [ - "google.api.servicecontrol.v1.QuotaController", - "google.api.servicecontrol.v1.ServiceController" - ] - }, - { - "id": "google.api.servicecontrol.v2", - "directory": "google/api/servicecontrol/v2", - "version": "v2", - "majorVersion": "v2", - "hostName": "servicecontrol.googleapis.com", - "title": "Service Control API", - "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", - "importDirectories": [ - "google/api", - "google/rpc", - "google/rpc/context" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 1 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.ServiceControl.V2": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/api/servicecontrol/v2;servicecontrol": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.api.servicecontrol.v2": 1 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GASC": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\ServiceControl\\V2": 1 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::ServiceControl::V2": 1 - } - } - }, - "services": [ - { - "shortName": "ServiceController", - "fullName": "google.api.servicecontrol.v2.ServiceController", - "methods": [ + }, { - "shortName": "Check", - "fullName": "google.api.servicecontrol.v2.ServiceController.Check", + "shortName": "ImportAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportAdminOverrides", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/services/{service_name}:check" + "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics:importAdminOverrides" } ] }, { - "shortName": "Report", - "fullName": "google.api.servicecontrol.v2.ServiceController.Report", + "shortName": "ImportConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportConsumerOverrides", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/services/{service_name}:report" + "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics:importConsumerOverrides" + } + ] + }, + { + "shortName": "ListAdminOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListAdminOverrides", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/adminOverrides" + } + ] + }, + { + "shortName": "ListConsumerOverrides", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerOverrides", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/consumerOverrides" + } + ] + }, + { + "shortName": "ListConsumerQuotaMetrics", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerQuotaMetrics", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics" + } + ] + }, + { + "shortName": "ListServices", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListServices", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=*/*}/services" + } + ] + }, + { + "shortName": "UpdateAdminOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateAdminOverride", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/adminOverrides/*}" + } + ] + }, + { + "shortName": "UpdateConsumerOverride", + "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateConsumerOverride", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/consumerOverrides/*}" } ] } ] } ], - "configFile": "servicecontrol.yaml", + "configFile": "serviceusage_v1beta1.yaml", "serviceConfigApiNames": [ - "google.api.servicecontrol.v2.ServiceController" - ] + "google.api.serviceusage.v1beta1.ServiceUsage" + ], + "nameInServiceConfig": "serviceusage.googleapis.com" }, { - "id": "google.api.servicemanagement.v1", - "directory": "google/api/servicemanagement/v1", + "id": "google.appengine.v1", + "directory": "google/appengine/v1", "version": "v1", "majorVersion": "v1", - "hostName": "servicemanagement.googleapis.com", - "title": "Service Management API", - "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.", + "hostName": "appengine.googleapis.com", + "title": "App Engine Admin API", + "description": "Provisions and manages developers' App Engine applications.", "importDirectories": [ "google/api", - "google/api/servicemanagement/v1", + "google/appengine/v1", "google/longrunning", "google/protobuf" ], "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.ServiceManagement.V1": 2 + "Google.Cloud.AppEngine.V1": 16 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/api/servicemanagement/v1;servicemanagement": 2 + "google.golang.org/genproto/googleapis/appengine/v1;appengine": 16 } }, "java_multiple_files": { "valueCounts": { - "true": 2 + "true": 16 } }, "java_package": { "valueCounts": { - "com.google.api.servicemanagement.v1": 2 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GASM": 2 + "com.google.appengine.v1": 15, + "com.google.appengine.v1.firewall": 1 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\ServiceManagement\\V1": 2 + "Google\\Cloud\\AppEngine\\V1": 16 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::ServiceManagement::V1": 2 + "Google::Cloud::AppEngine::V1": 16 } } }, "services": [ { - "shortName": "ServiceManager", - "fullName": "google.api.servicemanagement.v1.ServiceManager", + "shortName": "Applications", + "fullName": "google.appengine.v1.Applications", "methods": [ { - "shortName": "CreateService", - "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateService", + "shortName": "CreateApplication", + "fullName": "google.appengine.v1.Applications.CreateApplication", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/services" + "path": "/v1/apps" } ] }, { - "shortName": "CreateServiceConfig", - "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceConfig", + "shortName": "GetApplication", + "fullName": "google.appengine.v1.Applications.GetApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}/configs" + "httpMethod": "GET", + "path": "/v1/{name=apps/*}" } ] }, { - "shortName": "CreateServiceRollout", - "fullName": "google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout", + "shortName": "RepairApplication", + "fullName": "google.appengine.v1.Applications.RepairApplication", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/services/{service_name}/rollouts" + "path": "/v1/{name=apps/*}:repair" } ] }, { - "shortName": "DeleteService", - "fullName": "google.api.servicemanagement.v1.ServiceManager.DeleteService", + "shortName": "UpdateApplication", + "fullName": "google.appengine.v1.Applications.UpdateApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/services/{service_name}" + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*}" } ] - }, + } + ] + }, + { + "shortName": "AuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates", + "methods": [ { - "shortName": "GenerateConfigReport", - "fullName": "google.api.servicemanagement.v1.ServiceManager.GenerateConfigReport", + "shortName": "CreateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.CreateAuthorizedCertificate", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/services:generateConfigReport" + "path": "/v1/{parent=apps/*}/authorizedCertificates" } ] }, { - "shortName": "GetService", - "fullName": "google.api.servicemanagement.v1.ServiceManager.GetService", + "shortName": "DeleteAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.DeleteAuthorizedCertificate", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/services/{service_name}" + "httpMethod": "DELETE", + "path": "/v1/{name=apps/*/authorizedCertificates/*}" } ] }, { - "shortName": "GetServiceConfig", - "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceConfig", + "shortName": "GetAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.GetAuthorizedCertificate", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/services/{service_name}/configs/{config_id}" - }, - { - "httpMethod": "GET", - "path": "/v1/services/{service_name}/config" + "path": "/v1/{name=apps/*/authorizedCertificates/*}" } ] }, { - "shortName": "GetServiceRollout", - "fullName": "google.api.servicemanagement.v1.ServiceManager.GetServiceRollout", + "shortName": "ListAuthorizedCertificates", + "fullName": "google.appengine.v1.AuthorizedCertificates.ListAuthorizedCertificates", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/services/{service_name}/rollouts/{rollout_id}" + "path": "/v1/{parent=apps/*}/authorizedCertificates" } ] }, { - "shortName": "ListServiceConfigs", - "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceConfigs", + "shortName": "UpdateAuthorizedCertificate", + "fullName": "google.appengine.v1.AuthorizedCertificates.UpdateAuthorizedCertificate", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*/authorizedCertificates/*}" + } + ] + } + ] + }, + { + "shortName": "AuthorizedDomains", + "fullName": "google.appengine.v1.AuthorizedDomains", + "methods": [ + { + "shortName": "ListAuthorizedDomains", + "fullName": "google.appengine.v1.AuthorizedDomains.ListAuthorizedDomains", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/services/{service_name}/configs" + "path": "/v1/{parent=apps/*}/authorizedDomains" + } + ] + } + ] + }, + { + "shortName": "DomainMappings", + "fullName": "google.appengine.v1.DomainMappings", + "methods": [ + { + "shortName": "CreateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.CreateDomainMapping", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=apps/*}/domainMappings" } ] }, { - "shortName": "ListServiceRollouts", - "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServiceRollouts", + "shortName": "DeleteDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.DeleteDomainMapping", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/services/{service_name}/rollouts" + "httpMethod": "DELETE", + "path": "/v1/{name=apps/*/domainMappings/*}" } ] }, { - "shortName": "ListServices", - "fullName": "google.api.servicemanagement.v1.ServiceManager.ListServices", + "shortName": "GetDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.GetDomainMapping", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/services" + "path": "/v1/{name=apps/*/domainMappings/*}" } ] }, { - "shortName": "SubmitConfigSource", - "fullName": "google.api.servicemanagement.v1.ServiceManager.SubmitConfigSource", + "shortName": "ListDomainMappings", + "fullName": "google.appengine.v1.DomainMappings.ListDomainMappings", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}/configs:submit" + "httpMethod": "GET", + "path": "/v1/{parent=apps/*}/domainMappings" } ] }, { - "shortName": "UndeleteService", - "fullName": "google.api.servicemanagement.v1.ServiceManager.UndeleteService", + "shortName": "UpdateDomainMapping", + "fullName": "google.appengine.v1.DomainMappings.UpdateDomainMapping", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/services/{service_name}:undelete" + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*/domainMappings/*}" } ] } ] - } - ], - "configFile": "servicemanagement_v1.yaml", - "serviceConfigApiNames": [ - "google.api.servicemanagement.v1.ServiceManager" - ] - }, - { - "id": "google.api.serviceusage.v1", - "directory": "google/api/serviceusage/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "serviceusage.googleapis.com", - "title": "Service Usage API", - "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", - "importDirectories": [ - "google/api", - "google/api/serviceusage/v1", - "google/longrunning", - "google/protobuf" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.ServiceUsage.V1": 2 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/api/serviceusage/v1;serviceusage": 2 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 2 - } - }, - "java_package": { - "valueCounts": { - "com.google.api.serviceusage.v1": 2 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\ServiceUsage\\V1": 2 - } }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::ServiceUsage::V1": 2 - } - } - }, - "services": [ { - "shortName": "ServiceUsage", - "fullName": "google.api.serviceusage.v1.ServiceUsage", + "shortName": "Firewall", + "fullName": "google.appengine.v1.Firewall", "methods": [ { - "shortName": "BatchEnableServices", - "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchEnableServices", + "shortName": "BatchUpdateIngressRules", + "fullName": "google.appengine.v1.Firewall.BatchUpdateIngressRules", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=*/*}/services:batchEnable" + "path": "/v1/{name=apps/*/firewall/ingressRules}:batchUpdate" } ] }, { - "shortName": "BatchGetServices", - "fullName": "google.api.serviceusage.v1.ServiceUsage.BatchGetServices", + "shortName": "CreateIngressRule", + "fullName": "google.appengine.v1.Firewall.CreateIngressRule", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=*/*}/services:batchGet" + "httpMethod": "POST", + "path": "/v1/{parent=apps/*}/firewall/ingressRules" } ] }, { - "shortName": "DisableService", - "fullName": "google.api.serviceusage.v1.ServiceUsage.DisableService", + "shortName": "DeleteIngressRule", + "fullName": "google.appengine.v1.Firewall.DeleteIngressRule", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=*/*/services/*}:disable" + "httpMethod": "DELETE", + "path": "/v1/{name=apps/*/firewall/ingressRules/*}" } ] }, { - "shortName": "EnableService", - "fullName": "google.api.serviceusage.v1.ServiceUsage.EnableService", + "shortName": "GetIngressRule", + "fullName": "google.appengine.v1.Firewall.GetIngressRule", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=*/*/services/*}:enable" - } + "httpMethod": "GET", + "path": "/v1/{name=apps/*/firewall/ingressRules/*}" + } ] }, { - "shortName": "GetService", - "fullName": "google.api.serviceusage.v1.ServiceUsage.GetService", + "shortName": "ListIngressRules", + "fullName": "google.appengine.v1.Firewall.ListIngressRules", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=*/*/services/*}" + "path": "/v1/{parent=apps/*}/firewall/ingressRules" } ] }, { - "shortName": "ListServices", - "fullName": "google.api.serviceusage.v1.ServiceUsage.ListServices", + "shortName": "UpdateIngressRule", + "fullName": "google.appengine.v1.Firewall.UpdateIngressRule", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=*/*}/services" + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*/firewall/ingressRules/*}" } ] } ] - } - ], - "configFile": "serviceusage_v1.yaml", - "serviceConfigApiNames": [ - "google.api.serviceusage.v1.ServiceUsage" - ] - }, - { - "id": "google.api.serviceusage.v1beta1", - "directory": "google/api/serviceusage/v1beta1", - "version": "v1beta1", - "majorVersion": "v1", - "hostName": "serviceusage.googleapis.com", - "title": "Service Usage API", - "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", - "importDirectories": [ - "google/api", - "google/api/serviceusage/v1beta1", - "google/longrunning", - "google/protobuf" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Api.ServiceUsage.V1Beta1": 2 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/api/serviceusage/v1beta1;serviceusage": 2 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 2 - } - }, - "java_package": { - "valueCounts": { - "com.google.api.serviceusage.v1beta1": 2 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Api\\ServiceUsage\\V1beta1": 2 - } }, - "ruby_package": { - "valueCounts": { - "Google::Api::ServiceUsage::V1beta1": 2 - } - } - }, - "services": [ { - "shortName": "ServiceUsage", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage", + "shortName": "Instances", + "fullName": "google.appengine.v1.Instances", "methods": [ { - "shortName": "BatchEnableServices", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.BatchEnableServices", + "shortName": "DebugInstance", + "fullName": "google.appengine.v1.Instances.DebugInstance", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*}/services:batchEnable" + "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}:debug" } ] }, { - "shortName": "CreateAdminOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateAdminOverride", + "shortName": "DeleteInstance", + "fullName": "google.appengine.v1.Instances.DeleteInstance", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/adminOverrides" + "httpMethod": "DELETE", + "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}" } ] }, { - "shortName": "CreateConsumerOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.CreateConsumerOverride", + "shortName": "GetInstance", + "fullName": "google.appengine.v1.Instances.GetInstance", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/consumerOverrides" + "httpMethod": "GET", + "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}" } ] }, { - "shortName": "DeleteAdminOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteAdminOverride", + "shortName": "ListInstances", + "fullName": "google.appengine.v1.Instances.ListInstances", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=apps/*/services/*/versions/*}/instances" + } + ] + } + ] + }, + { + "shortName": "Services", + "fullName": "google.appengine.v1.Services", + "methods": [ + { + "shortName": "DeleteService", + "fullName": "google.appengine.v1.Services.DeleteService", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/adminOverrides/*}" + "path": "/v1/{name=apps/*/services/*}" } ] }, { - "shortName": "DeleteConsumerOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DeleteConsumerOverride", + "shortName": "GetService", + "fullName": "google.appengine.v1.Services.GetService", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/consumerOverrides/*}" + "httpMethod": "GET", + "path": "/v1/{name=apps/*/services/*}" } ] }, { - "shortName": "DisableService", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.DisableService", + "shortName": "ListServices", + "fullName": "google.appengine.v1.Services.ListServices", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{name=*/*/services/*}:disable" + "httpMethod": "GET", + "path": "/v1/{parent=apps/*}/services" } ] }, { - "shortName": "EnableService", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.EnableService", + "shortName": "UpdateService", + "fullName": "google.appengine.v1.Services.UpdateService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*/services/*}" + } + ] + } + ] + }, + { + "shortName": "Versions", + "fullName": "google.appengine.v1.Versions", + "methods": [ + { + "shortName": "CreateVersion", + "fullName": "google.appengine.v1.Versions.CreateVersion", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{name=*/*/services/*}:enable" + "path": "/v1/{parent=apps/*/services/*}/versions" } ] }, { - "shortName": "GenerateServiceIdentity", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GenerateServiceIdentity", + "shortName": "DeleteVersion", + "fullName": "google.appengine.v1.Versions.DeleteVersion", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*/services/*}:generateServiceIdentity" + "httpMethod": "DELETE", + "path": "/v1/{name=apps/*/services/*/versions/*}" } ] }, { - "shortName": "GetConsumerQuotaLimit", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaLimit", + "shortName": "GetVersion", + "fullName": "google.appengine.v1.Versions.GetVersion", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*}" + "path": "/v1/{name=apps/*/services/*/versions/*}" } ] }, { - "shortName": "GetConsumerQuotaMetric", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetConsumerQuotaMetric", + "shortName": "ListVersions", + "fullName": "google.appengine.v1.Versions.ListVersions", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*}" + "path": "/v1/{parent=apps/*/services/*}/versions" } ] }, { - "shortName": "GetService", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.GetService", + "shortName": "UpdateVersion", + "fullName": "google.appengine.v1.Versions.UpdateVersion", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{name=*/*/services/*}" + "httpMethod": "PATCH", + "path": "/v1/{name=apps/*/services/*/versions/*}" + } + ] + } + ] + } + ], + "configFile": "appengine_v1.yaml", + "serviceConfigApiNames": [ + "google.appengine.v1.Applications", + "google.appengine.v1.AuthorizedCertificates", + "google.appengine.v1.AuthorizedDomains", + "google.appengine.v1.DomainMappings", + "google.appengine.v1.Firewall", + "google.appengine.v1.Instances", + "google.appengine.v1.Services", + "google.appengine.v1.Versions" + ], + "nameInServiceConfig": "appengine.googleapis.com" + }, + { + "id": "google.apps.alertcenter.v1beta1", + "directory": "google/apps/alertcenter/v1beta1", + "version": "v1beta1", + "majorVersion": "v1", + "hostName": "alertcenter.googleapis.com", + "title": "Google Workspace Alert Center API", + "description": "Manages alerts on issues affecting your domain.", + "importDirectories": [ + "google/api", + "google/protobuf", + "google/rpc" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Apps.AlertCenter.V1Beta1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/apps/alertcenter/v1beta1;alertcenter": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.apps.alertcenter.v1beta1": 1 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GAIC": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Apps\\AlertCenter\\V1beta1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Apps::AlertCenter::V1beta1": 1 + } + } + }, + "services": [ + { + "shortName": "AlertCenterService", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService", + "methods": [ + { + "shortName": "BatchDeleteAlerts", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.BatchDeleteAlerts", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/alerts:batchDelete" } ] }, { - "shortName": "ImportAdminOverrides", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportAdminOverrides", + "shortName": "BatchUndeleteAlerts", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.BatchUndeleteAlerts", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics:importAdminOverrides" + "path": "/v1beta1/alerts:batchUndelete" } ] }, { - "shortName": "ImportConsumerOverrides", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ImportConsumerOverrides", + "shortName": "CreateAlertFeedback", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.CreateAlertFeedback", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics:importConsumerOverrides" + "path": "/v1beta1/alerts/{alert_id}/feedback" } ] }, { - "shortName": "ListAdminOverrides", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListAdminOverrides", + "shortName": "DeleteAlert", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.DeleteAlert", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/alerts/{alert_id}" + } + ] + }, + { + "shortName": "GetAlert", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetAlert", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/adminOverrides" + "path": "/v1beta1/alerts/{alert_id}" } ] }, { - "shortName": "ListConsumerOverrides", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerOverrides", + "shortName": "GetAlertMetadata", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetAlertMetadata", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=*/*/services/*/consumerQuotaMetrics/*/limits/*}/consumerOverrides" + "path": "/v1beta1/alerts/{alert_id}/metadata" } ] }, { - "shortName": "ListConsumerQuotaMetrics", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListConsumerQuotaMetrics", + "shortName": "GetSettings", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=*/*/services/*}/consumerQuotaMetrics" + "path": "/v1beta1/settings" } ] }, { - "shortName": "ListServices", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.ListServices", + "shortName": "ListAlertFeedback", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.ListAlertFeedback", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=*/*}/services" + "path": "/v1beta1/alerts/{alert_id}/feedback" } ] }, { - "shortName": "UpdateAdminOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateAdminOverride", + "shortName": "ListAlerts", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.ListAlerts", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/adminOverrides/*}" + "httpMethod": "GET", + "path": "/v1beta1/alerts" } ] }, { - "shortName": "UpdateConsumerOverride", - "fullName": "google.api.serviceusage.v1beta1.ServiceUsage.UpdateConsumerOverride", + "shortName": "UndeleteAlert", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.UndeleteAlert", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/alerts/{alert_id}:undelete" + } + ] + }, + { + "shortName": "UpdateSettings", + "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.UpdateSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1beta1/{name=*/*/services/*/consumerQuotaMetrics/*/limits/*/consumerOverrides/*}" + "path": "/v1beta1/settings" } ] } ] } ], - "configFile": "serviceusage_v1beta1.yaml", + "configFile": "alertcenter.yaml", "serviceConfigApiNames": [ - "google.api.serviceusage.v1beta1.ServiceUsage" - ] + "google.apps.alertcenter.v1beta1.AlertCenterService" + ], + "nameInServiceConfig": "alertcenter.googleapis.com" }, { - "id": "google.appengine.v1", - "directory": "google/appengine/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "appengine.googleapis.com", - "title": "App Engine Admin API", - "description": "Provisions and manages developers' App Engine applications.", + "id": "google.apps.drive.activity.v2", + "directory": "google/apps/drive/activity/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "driveactivity.googleapis.com", + "title": "Drive Activity API", + "description": "Provides a historical view of activity in Google Drive.", "importDirectories": [ "google/api", - "google/appengine/v1", - "google/longrunning", + "google/apps/drive/activity/v2", "google/protobuf" ], "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.AppEngine.V1": 16 + "Google.Apps.Drive.Activity.V2": 7 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/appengine/v1;appengine": 16 + "google.golang.org/genproto/googleapis/apps/drive/activity/v2;activity": 7 } }, "java_multiple_files": { "valueCounts": { - "true": 16 + "true": 7 } }, "java_package": { "valueCounts": { - "com.google.appengine.v1": 15, - "com.google.appengine.v1.firewall": 1 + "com.google.apps.drive.activity.v2": 7 } }, - "php_namespace": { + "objc_class_prefix": { "valueCounts": { - "Google\\Cloud\\AppEngine\\V1": 16 + "GADA": 7 } }, - "ruby_package": { + "php_namespace": { "valueCounts": { - "Google::Cloud::AppEngine::V1": 16 + "Google\\Apps\\Drive\\Activity\\V2": 7 } } }, "services": [ { - "shortName": "Applications", - "fullName": "google.appengine.v1.Applications", + "shortName": "DriveActivityService", + "fullName": "google.apps.drive.activity.v2.DriveActivityService", "methods": [ { - "shortName": "CreateApplication", - "fullName": "google.appengine.v1.Applications.CreateApplication", + "shortName": "QueryDriveActivity", + "fullName": "google.apps.drive.activity.v2.DriveActivityService.QueryDriveActivity", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/apps" + "path": "/v2/activity:query" } ] - }, + } + ] + } + ], + "configFile": "driveactivity_v2.yaml", + "serviceConfigApiNames": [ + "google.apps.drive.activity.v2.DriveActivityService" + ], + "nameInServiceConfig": "driveactivity.googleapis.com" + }, + { + "id": "google.apps.drive.labels.v2", + "directory": "google/apps/drive/labels/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "drivelabels.googleapis.com", + "title": "Drive Labels API", + "description": "An API for managing Drive Labels", + "importDirectories": [ + "google/api", + "google/apps/drive/labels/v2", + "google/protobuf", + "google/type" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels": 8 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 8 + } + }, + "java_package": { + "valueCounts": { + "com.google.apps.drive.labels.v2": 8 + } + }, + "objc_class_prefix": { + "valueCounts": { + "": 2, + "DLBL": 6 + } + } + }, + "services": [ + { + "shortName": "LabelService", + "fullName": "google.apps.drive.labels.v2.LabelService", + "methods": [ { - "shortName": "GetApplication", - "fullName": "google.appengine.v1.Applications.GetApplication", + "shortName": "GetLabel", + "fullName": "google.apps.drive.labels.v2.LabelService.GetLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=apps/*}" - } - ] - }, - { - "shortName": "RepairApplication", - "fullName": "google.appengine.v1.Applications.RepairApplication", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1/{name=apps/*}:repair" + "path": "/v2/{name=labels/*}" } ] }, { - "shortName": "UpdateApplication", - "fullName": "google.appengine.v1.Applications.UpdateApplication", + "shortName": "ListLabels", + "fullName": "google.apps.drive.labels.v2.LabelService.ListLabels", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*}" + "httpMethod": "GET", + "path": "/v2/labels" } ] } ] + } + ], + "configFile": "drivelabels_v2.yaml", + "serviceConfigApiNames": [ + "google.apps.drive.labels.v2.LabelService" + ], + "nameInServiceConfig": "drivelabels.googleapis.com" + }, + { + "id": "google.apps.drive.labels.v2beta", + "directory": "google/apps/drive/labels/v2beta", + "version": "v2beta", + "majorVersion": "v2", + "hostName": "drivelabels.googleapis.com", + "title": "Drive Labels API", + "description": "An API for managing Drive Labels", + "importDirectories": [ + "google/api", + "google/apps/drive/labels/v2beta", + "google/protobuf", + "google/type" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels": 11 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 11 + } + }, + "java_package": { + "valueCounts": { + "com.google.apps.drive.labels.v2beta": 11 + } }, + "objc_class_prefix": { + "valueCounts": { + "": 2, + "DLBL": 9 + } + } + }, + "services": [ { - "shortName": "AuthorizedCertificates", - "fullName": "google.appengine.v1.AuthorizedCertificates", + "shortName": "LabelService", + "fullName": "google.apps.drive.labels.v2beta.LabelService", "methods": [ { - "shortName": "CreateAuthorizedCertificate", - "fullName": "google.appengine.v1.AuthorizedCertificates.CreateAuthorizedCertificate", + "shortName": "BatchDeleteLabelPermissions", + "fullName": "google.apps.drive.labels.v2beta.LabelService.BatchDeleteLabelPermissions", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=apps/*}/authorizedCertificates" + "path": "/v2beta/{parent=labels/*}/permissions:batchDelete" + }, + { + "httpMethod": "POST", + "path": "/v2beta/{parent=labels/*/revisions/*}/permissions:batchDelete" } ] }, { - "shortName": "DeleteAuthorizedCertificate", - "fullName": "google.appengine.v1.AuthorizedCertificates.DeleteAuthorizedCertificate", + "shortName": "BatchUpdateLabelPermissions", + "fullName": "google.apps.drive.labels.v2beta.LabelService.BatchUpdateLabelPermissions", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/authorizedCertificates/*}" + "httpMethod": "POST", + "path": "/v2beta/{parent=labels/*}/permissions:batchUpdate" + }, + { + "httpMethod": "POST", + "path": "/v2beta/{parent=labels/*/revisions/*}/permissions:batchUpdate" } ] }, { - "shortName": "GetAuthorizedCertificate", - "fullName": "google.appengine.v1.AuthorizedCertificates.GetAuthorizedCertificate", + "shortName": "CreateLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.CreateLabel", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=apps/*/authorizedCertificates/*}" + "httpMethod": "POST", + "path": "/v2beta/labels" } ] }, { - "shortName": "ListAuthorizedCertificates", - "fullName": "google.appengine.v1.AuthorizedCertificates.ListAuthorizedCertificates", + "shortName": "CreateLabelPermission", + "fullName": "google.apps.drive.labels.v2beta.LabelService.CreateLabelPermission", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=apps/*}/authorizedCertificates" + "httpMethod": "POST", + "path": "/v2beta/{parent=labels/*}/permissions" + }, + { + "httpMethod": "POST", + "path": "/v2beta/{parent=labels/*/revisions/*}/permissions" } ] }, { - "shortName": "UpdateAuthorizedCertificate", - "fullName": "google.appengine.v1.AuthorizedCertificates.UpdateAuthorizedCertificate", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*/authorizedCertificates/*}" - } - ] - } - ] - }, - { - "shortName": "AuthorizedDomains", - "fullName": "google.appengine.v1.AuthorizedDomains", - "methods": [ - { - "shortName": "ListAuthorizedDomains", - "fullName": "google.appengine.v1.AuthorizedDomains.ListAuthorizedDomains", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1/{parent=apps/*}/authorizedDomains" - } - ] - } - ] - }, - { - "shortName": "DomainMappings", - "fullName": "google.appengine.v1.DomainMappings", - "methods": [ - { - "shortName": "CreateDomainMapping", - "fullName": "google.appengine.v1.DomainMappings.CreateDomainMapping", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1/{parent=apps/*}/domainMappings" - } - ] - }, - { - "shortName": "DeleteDomainMapping", - "fullName": "google.appengine.v1.DomainMappings.DeleteDomainMapping", + "shortName": "DeleteLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.DeleteLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/domainMappings/*}" + "path": "/v2beta/{name=labels/*}" } ] }, { - "shortName": "GetDomainMapping", - "fullName": "google.appengine.v1.DomainMappings.GetDomainMapping", + "shortName": "DeleteLabelPermission", + "fullName": "google.apps.drive.labels.v2beta.LabelService.DeleteLabelPermission", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=apps/*/domainMappings/*}" - } - ] - }, - { - "shortName": "ListDomainMappings", - "fullName": "google.appengine.v1.DomainMappings.ListDomainMappings", - "mode": "UNARY", - "bindings": [ + "httpMethod": "DELETE", + "path": "/v2beta/{name=labels/*/permissions/*}" + }, { - "httpMethod": "GET", - "path": "/v1/{parent=apps/*}/domainMappings" + "httpMethod": "DELETE", + "path": "/v2beta/{name=labels/*/revisions/*/permissions/*}" } ] }, { - "shortName": "UpdateDomainMapping", - "fullName": "google.appengine.v1.DomainMappings.UpdateDomainMapping", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*/domainMappings/*}" - } - ] - } - ] - }, - { - "shortName": "Firewall", - "fullName": "google.appengine.v1.Firewall", - "methods": [ - { - "shortName": "BatchUpdateIngressRules", - "fullName": "google.appengine.v1.Firewall.BatchUpdateIngressRules", + "shortName": "DeltaUpdateLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.DeltaUpdateLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{name=apps/*/firewall/ingressRules}:batchUpdate" + "path": "/v2beta/{name=labels/*}:delta" } ] }, { - "shortName": "CreateIngressRule", - "fullName": "google.appengine.v1.Firewall.CreateIngressRule", + "shortName": "DisableLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.DisableLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=apps/*}/firewall/ingressRules" + "path": "/v2beta/{name=labels/*}:disable" } ] }, { - "shortName": "DeleteIngressRule", - "fullName": "google.appengine.v1.Firewall.DeleteIngressRule", + "shortName": "EnableLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.EnableLabel", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/firewall/ingressRules/*}" + "httpMethod": "POST", + "path": "/v2beta/{name=labels/*}:enable" } ] }, { - "shortName": "GetIngressRule", - "fullName": "google.appengine.v1.Firewall.GetIngressRule", + "shortName": "GetLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.GetLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=apps/*/firewall/ingressRules/*}" + "path": "/v2beta/{name=labels/*}" } ] }, { - "shortName": "ListIngressRules", - "fullName": "google.appengine.v1.Firewall.ListIngressRules", + "shortName": "GetLabelLimits", + "fullName": "google.apps.drive.labels.v2beta.LabelService.GetLabelLimits", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=apps/*}/firewall/ingressRules" - } - ] - }, - { - "shortName": "UpdateIngressRule", - "fullName": "google.appengine.v1.Firewall.UpdateIngressRule", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*/firewall/ingressRules/*}" - } - ] - } - ] - }, - { - "shortName": "Instances", - "fullName": "google.appengine.v1.Instances", - "methods": [ - { - "shortName": "DebugInstance", - "fullName": "google.appengine.v1.Instances.DebugInstance", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}:debug" - } - ] - }, - { - "shortName": "DeleteInstance", - "fullName": "google.appengine.v1.Instances.DeleteInstance", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}" + "path": "/v2beta/limits/label" } ] }, { - "shortName": "GetInstance", - "fullName": "google.appengine.v1.Instances.GetInstance", + "shortName": "GetUserCapabilities", + "fullName": "google.apps.drive.labels.v2beta.LabelService.GetUserCapabilities", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=apps/*/services/*/versions/*/instances/*}" + "path": "/v2beta/{name=users/*/capabilities}" } ] }, { - "shortName": "ListInstances", - "fullName": "google.appengine.v1.Instances.ListInstances", + "shortName": "ListLabelLocks", + "fullName": "google.apps.drive.labels.v2beta.LabelService.ListLabelLocks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=apps/*/services/*/versions/*}/instances" - } - ] - } - ] - }, - { - "shortName": "Services", - "fullName": "google.appengine.v1.Services", - "methods": [ - { - "shortName": "DeleteService", - "fullName": "google.appengine.v1.Services.DeleteService", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/services/*}" - } - ] - }, - { - "shortName": "GetService", - "fullName": "google.appengine.v1.Services.GetService", - "mode": "UNARY", - "bindings": [ + "path": "/v2beta/{parent=labels/*}/locks" + }, { "httpMethod": "GET", - "path": "/v1/{name=apps/*/services/*}" + "path": "/v2beta/{parent=labels/*/revisions/*}/locks" } ] }, { - "shortName": "ListServices", - "fullName": "google.appengine.v1.Services.ListServices", + "shortName": "ListLabelPermissions", + "fullName": "google.apps.drive.labels.v2beta.LabelService.ListLabelPermissions", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=apps/*}/services" - } - ] - }, - { - "shortName": "UpdateService", - "fullName": "google.appengine.v1.Services.UpdateService", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*/services/*}" - } - ] - } - ] - }, - { - "shortName": "Versions", - "fullName": "google.appengine.v1.Versions", - "methods": [ - { - "shortName": "CreateVersion", - "fullName": "google.appengine.v1.Versions.CreateVersion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1/{parent=apps/*/services/*}/versions" - } - ] - }, - { - "shortName": "DeleteVersion", - "fullName": "google.appengine.v1.Versions.DeleteVersion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1/{name=apps/*/services/*/versions/*}" - } - ] - }, - { - "shortName": "GetVersion", - "fullName": "google.appengine.v1.Versions.GetVersion", - "mode": "UNARY", - "bindings": [ + "path": "/v2beta/{parent=labels/*}/permissions" + }, { "httpMethod": "GET", - "path": "/v1/{name=apps/*/services/*/versions/*}" + "path": "/v2beta/{parent=labels/*/revisions/*}/permissions" } ] }, { - "shortName": "ListVersions", - "fullName": "google.appengine.v1.Versions.ListVersions", + "shortName": "ListLabels", + "fullName": "google.apps.drive.labels.v2beta.LabelService.ListLabels", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=apps/*/services/*}/versions" - } - ] - }, - { - "shortName": "UpdateVersion", - "fullName": "google.appengine.v1.Versions.UpdateVersion", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/{name=apps/*/services/*/versions/*}" - } - ] - } - ] - } - ], - "configFile": "appengine_v1.yaml", - "serviceConfigApiNames": [ - "google.appengine.v1.Applications", - "google.appengine.v1.AuthorizedCertificates", - "google.appengine.v1.AuthorizedDomains", - "google.appengine.v1.DomainMappings", - "google.appengine.v1.Firewall", - "google.appengine.v1.Instances", - "google.appengine.v1.Services", - "google.appengine.v1.Versions" - ] - }, - { - "id": "google.apps.alertcenter.v1beta1", - "directory": "google/apps/alertcenter/v1beta1", - "version": "v1beta1", - "majorVersion": "v1", - "hostName": "alertcenter.googleapis.com", - "title": "Google Workspace Alert Center API", - "description": "Manages alerts on issues affecting your domain.", - "importDirectories": [ - "google/api", - "google/protobuf", - "google/rpc" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Apps.AlertCenter.V1Beta1": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/apps/alertcenter/v1beta1;alertcenter": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.apps.alertcenter.v1beta1": 1 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GAIC": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Apps\\AlertCenter\\V1beta1": 1 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Apps::AlertCenter::V1beta1": 1 - } - } - }, - "services": [ - { - "shortName": "AlertCenterService", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService", - "methods": [ - { - "shortName": "BatchDeleteAlerts", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.BatchDeleteAlerts", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/alerts:batchDelete" + "path": "/v2beta/labels" } ] }, { - "shortName": "BatchUndeleteAlerts", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.BatchUndeleteAlerts", + "shortName": "PublishLabel", + "fullName": "google.apps.drive.labels.v2beta.LabelService.PublishLabel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/alerts:batchUndelete" + "path": "/v2beta/{name=labels/*}:publish" } ] }, { - "shortName": "CreateAlertFeedback", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.CreateAlertFeedback", + "shortName": "UpdateLabelCopyMode", + "fullName": "google.apps.drive.labels.v2beta.LabelService.UpdateLabelCopyMode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/alerts/{alert_id}/feedback" - } - ] - }, - { - "shortName": "DeleteAlert", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.DeleteAlert", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1beta1/alerts/{alert_id}" - } - ] - }, - { - "shortName": "GetAlert", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetAlert", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/alerts/{alert_id}" - } - ] - }, - { - "shortName": "GetAlertMetadata", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetAlertMetadata", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/alerts/{alert_id}/metadata" + "path": "/v2beta/{name=labels/*}:updateLabelCopyMode" } ] }, { - "shortName": "GetSettings", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.GetSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/settings" - } - ] - }, - { - "shortName": "ListAlertFeedback", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.ListAlertFeedback", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/alerts/{alert_id}/feedback" - } - ] - }, - { - "shortName": "ListAlerts", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.ListAlerts", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/alerts" - } - ] - }, - { - "shortName": "UndeleteAlert", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.UndeleteAlert", + "shortName": "UpdateLabelPermission", + "fullName": "google.apps.drive.labels.v2beta.LabelService.UpdateLabelPermission", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/alerts/{alert_id}:undelete" - } - ] - }, - { - "shortName": "UpdateSettings", - "fullName": "google.apps.alertcenter.v1beta1.AlertCenterService.UpdateSettings", - "mode": "UNARY", - "bindings": [ + "httpMethod": "PATCH", + "path": "/v2beta/{parent=labels/*}/permissions" + }, { "httpMethod": "PATCH", - "path": "/v1beta1/settings" + "path": "/v2beta/{parent=labels/*/revisions/*}/permissions" } ] } ] } ], - "configFile": "alertcenter.yaml", + "configFile": "drivelabels_v2beta.yaml", "serviceConfigApiNames": [ - "google.apps.alertcenter.v1beta1.AlertCenterService" - ] - }, - { - "id": "google.apps.drive.activity.v2", - "directory": "google/apps/drive/activity/v2", - "version": "v2", - "majorVersion": "v2", - "hostName": "driveactivity.googleapis.com", - "title": "Drive Activity API", - "description": "Provides a historical view of activity in Google Drive.", - "importDirectories": [ - "google/api", - "google/apps/drive/activity/v2", - "google/protobuf" + "google.apps.drive.labels.v2beta.LabelService" ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Apps.Drive.Activity.V2": 7 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/apps/drive/activity/v2;activity": 7 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 7 - } - }, - "java_package": { - "valueCounts": { - "com.google.apps.drive.activity.v2": 7 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GADA": 7 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Apps\\Drive\\Activity\\V2": 7 - } - } - }, - "services": [ - { - "shortName": "DriveActivityService", - "fullName": "google.apps.drive.activity.v2.DriveActivityService", - "methods": [ - { - "shortName": "QueryDriveActivity", - "fullName": "google.apps.drive.activity.v2.DriveActivityService.QueryDriveActivity", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v2/activity:query" - } - ] - } - ] - } - ], - "configFile": "driveactivity_v2.yaml", - "serviceConfigApiNames": [ - "google.apps.drive.activity.v2.DriveActivityService" - ] + "nameInServiceConfig": "drivelabels.googleapis.com" }, { "id": "google.apps.market.v2", @@ -12395,7 +11311,8 @@ "ccc.hosted.marketplace.v2.CustomerLicenseService", "ccc.hosted.marketplace.v2.LicenseNotificationService", "ccc.hosted.marketplace.v2.UserLicenseService" - ] + ], + "nameInServiceConfig": "appsmarket.googleapis.com" }, { "id": "google.area120.tables.v1alpha1", @@ -12569,7 +11486,8 @@ "configFile": "area120tables_v1alpha1.yaml", "serviceConfigApiNames": [ "google.area120.tables.v1alpha1.TablesService" - ] + ], + "nameInServiceConfig": "area120tables.googleapis.com" }, { "id": "google.bigtable.admin.v2", @@ -13144,7 +12062,8 @@ "serviceConfigApiNames": [ "google.bigtable.admin.v2.BigtableInstanceAdmin", "google.bigtable.admin.v2.BigtableTableAdmin" - ] + ], + "nameInServiceConfig": "bigtableadmin.googleapis.com" }, { "id": "google.bigtable.v2", @@ -13280,7 +12199,8 @@ "configFile": "bigtable_v2.yaml", "serviceConfigApiNames": [ "google.bigtable.v2.Bigtable" - ] + ], + "nameInServiceConfig": "bigtable.googleapis.com" }, { "id": "google.chromeos.moblab.v1beta1", @@ -13390,7 +12310,8 @@ "configFile": "chromeosmoblab_v1beta1.yaml", "serviceConfigApiNames": [ "google.chromeos.moblab.v1beta1.BuildService" - ] + ], + "nameInServiceConfig": "chromeosmoblab.googleapis.com" }, { "id": "google.chromeos.uidetection.v1", @@ -13442,7 +12363,8 @@ "configFile": "chromeosuidetection_v1.yaml", "serviceConfigApiNames": [ "google.chromeos.uidetection.v1.UiDetectionService" - ] + ], + "nameInServiceConfig": "chromeosuidetection.googleapis.com" }, { "id": "google.cloud.accessapproval.v1", @@ -13670,7 +12592,8 @@ "configFile": "accessapproval_v1.yaml", "serviceConfigApiNames": [ "google.cloud.accessapproval.v1.AccessApproval" - ] + ], + "nameInServiceConfig": "accessapproval.googleapis.com" }, { "id": "google.cloud.aiplatform.v1", @@ -13856,6 +12779,17 @@ } ] }, + { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + } + ] + }, { "shortName": "UpdateDataset", "fullName": "google.cloud.aiplatform.v1.DatasetService.UpdateDataset", @@ -13977,6 +12911,17 @@ "path": "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:streamingReadFeatureValues" } ] + }, + { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues" + } + ] } ] }, @@ -15976,7 +14921,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "aiplatform.googleapis.com" }, { "id": "google.cloud.aiplatform.v1beta1", @@ -16169,6 +15115,17 @@ } ] }, + { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + } + ] + }, { "shortName": "UpdateDataset", "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset", @@ -18384,7 +17341,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "aiplatform.googleapis.com" }, { "id": "google.cloud.apigateway.v1", @@ -18608,7 +17566,8 @@ "configFile": "apigateway_v1.yaml", "serviceConfigApiNames": [ "google.cloud.apigateway.v1.ApiGatewayService" - ] + ], + "nameInServiceConfig": "apigateway.googleapis.com" }, { "id": "google.cloud.apigeeconnect.v1", @@ -18689,7 +17648,8 @@ "serviceConfigApiNames": [ "google.cloud.apigeeconnect.v1.ConnectionService", "google.cloud.apigeeconnect.v1.Tether" - ] + ], + "nameInServiceConfig": "apigeeconnect.googleapis.com" }, { "id": "google.cloud.apigeeregistry.v1", @@ -19272,7 +18232,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "apigeeregistry.googleapis.com" }, { "id": "google.cloud.asset.v1", @@ -19559,7 +18520,8 @@ "serviceConfigApiNames": [ "google.cloud.asset.v1.AssetService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudasset.googleapis.com" }, { "id": "google.cloud.asset.v1p1beta1", @@ -19640,7 +18602,8 @@ "configFile": "cloudasset_v1p1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.asset.v1p1beta1.AssetService" - ] + ], + "nameInServiceConfig": "cloudasset.googleapis.com" }, { "id": "google.cloud.asset.v1p2beta1", @@ -19756,7 +18719,8 @@ "configFile": "cloudasset_v1p2beta1.yaml", "serviceConfigApiNames": [ "google.cloud.asset.v1p2beta1.AssetService" - ] + ], + "nameInServiceConfig": "cloudasset.googleapis.com" }, { "id": "google.cloud.asset.v1p5beta1", @@ -19830,7 +18794,8 @@ "configFile": "cloudasset_v1p5beta1.yaml", "serviceConfigApiNames": [ "google.cloud.asset.v1p5beta1.AssetService" - ] + ], + "nameInServiceConfig": "cloudasset.googleapis.com" }, { "id": "google.cloud.asset.v1p7beta1", @@ -19905,7 +18870,8 @@ "configFile": "cloudasset_v1p7beta1.yaml", "serviceConfigApiNames": [ "google.cloud.asset.v1p7beta1.AssetService" - ] + ], + "nameInServiceConfig": "cloudasset.googleapis.com" }, { "id": "google.cloud.assuredworkloads.v1", @@ -19957,6 +18923,11 @@ "shortName": "AssuredWorkloadsService", "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService", "methods": [ + { + "shortName": "AcknowledgeViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.AcknowledgeViolation", + "mode": "UNARY" + }, { "shortName": "CreateWorkload", "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.CreateWorkload", @@ -19979,6 +18950,11 @@ } ] }, + { + "shortName": "GetViolation", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetViolation", + "mode": "UNARY" + }, { "shortName": "GetWorkload", "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.GetWorkload", @@ -19990,6 +18966,11 @@ } ] }, + { + "shortName": "ListViolations", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListViolations", + "mode": "UNARY" + }, { "shortName": "ListWorkloads", "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.ListWorkloads", @@ -20001,6 +18982,17 @@ } ] }, + { + "shortName": "RestrictAllowedResources", + "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.RestrictAllowedResources", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=organizations/*/locations/*/workloads/*}:restrictAllowedResources" + } + ] + }, { "shortName": "UpdateWorkload", "fullName": "google.cloud.assuredworkloads.v1.AssuredWorkloadsService.UpdateWorkload", @@ -20017,8 +19009,10 @@ ], "configFile": "assuredworkloads_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.assuredworkloads.v1.AssuredWorkloadsService" - ] + "google.cloud.assuredworkloads.v1.AssuredWorkloadsService", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "assuredworkloads.googleapis.com" }, { "id": "google.cloud.assuredworkloads.v1beta1", @@ -20131,7 +19125,8 @@ "serviceConfigApiNames": [ "google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "assuredworkloads.googleapis.com" }, { "id": "google.cloud.automl.v1", @@ -20418,7 +19413,8 @@ "serviceConfigApiNames": [ "google.cloud.automl.v1.AutoMl", "google.cloud.automl.v1.PredictionService" - ] + ], + "nameInServiceConfig": "automl.googleapis.com" }, { "id": "google.cloud.automl.v1beta1", @@ -20767,7 +19763,8 @@ "serviceConfigApiNames": [ "google.cloud.automl.v1beta1.AutoMl", "google.cloud.automl.v1beta1.PredictionService" - ] + ], + "nameInServiceConfig": "automl.googleapis.com" }, { "id": "google.cloud.baremetalsolution.v2", @@ -21049,7 +20046,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "baremetalsolution.googleapis.com" }, { "id": "google.cloud.batch.v1", @@ -21182,7 +20180,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "batch.googleapis.com" }, { "id": "google.cloud.batch.v1alpha", @@ -21315,7 +20314,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "batch.googleapis.com" }, { "id": "google.cloud.beyondcorp.appconnections.v1", @@ -21442,7 +20442,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "beyondcorp.googleapis.com" }, { "id": "google.cloud.beyondcorp.appconnectors.v1", @@ -21570,7 +20571,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "beyondcorp.googleapis.com" }, { "id": "google.cloud.beyondcorp.appgateways.v1", @@ -21675,7 +20677,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "beyondcorp.googleapis.com" }, { "id": "google.cloud.beyondcorp.clientconnectorservices.v1", @@ -21791,7 +20794,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "beyondcorp.googleapis.com" }, { "id": "google.cloud.beyondcorp.clientgateways.v1", @@ -21896,7 +20900,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "beyondcorp.googleapis.com" }, { "id": "google.cloud.bigquery.analyticshub.v1", @@ -22131,7 +21136,8 @@ "configFile": "analyticshub_v1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" - ] + ], + "nameInServiceConfig": "analyticshub.googleapis.com" }, { "id": "google.cloud.bigquery.connection.v1", @@ -22272,7 +21278,8 @@ "configFile": "bigqueryconnection_v1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.connection.v1.ConnectionService" - ] + ], + "nameInServiceConfig": "bigqueryconnection.googleapis.com" }, { "id": "google.cloud.bigquery.connection.v1beta1", @@ -22419,7 +21426,8 @@ "configFile": "bigqueryconnection_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.connection.v1beta1.ConnectionService" - ] + ], + "nameInServiceConfig": "bigqueryconnection.googleapis.com" }, { "id": "google.cloud.bigquery.dataexchange.v1beta1", @@ -22655,7 +21663,166 @@ "serviceConfigApiNames": [ "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService", "google.cloud.location.Locations" - ] + ], + "nameInServiceConfig": "analyticshub.googleapis.com" + }, + { + "id": "google.cloud.bigquery.datapolicies.v1", + "directory": "google/cloud/bigquery/datapolicies/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "bigquerydatapolicy.googleapis.com", + "title": "BigQuery Data Policy API", + "description": "Allows users to manage BigQuery data policies.", + "importDirectories": [ + "google/api", + "google/iam/v1", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.BigQuery.DataPolicies.V1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1;datapolicies": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.bigquery.datapolicies.v1": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\BigQuery\\DataPolicies\\V1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::Bigquery::DataPolicies::V1": 1 + } + } + }, + "services": [ + { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "methods": [ + { + "shortName": "CreateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.CreateDataPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/dataPolicies" + } + ] + }, + { + "shortName": "DeleteDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.DeleteDataPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/dataPolicies/*}" + } + ] + }, + { + "shortName": "GetDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetDataPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/dataPolicies/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/dataPolicies/*}:getIamPolicy" + } + ] + }, + { + "shortName": "ListDataPolicies", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.ListDataPolicies", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/dataPolicies" + } + ] + }, + { + "shortName": "RenameDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.RenameDataPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/dataPolicies/*}:rename" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/dataPolicies/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/dataPolicies/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.UpdateDataPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{data_policy.name=projects/*/locations/*/dataPolicies/*}" + } + ] + } + ] + } + ], + "configFile": "bigquerydatapolicy_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + ], + "nameInServiceConfig": "bigquerydatapolicy.googleapis.com" }, { "id": "google.cloud.bigquery.datapolicies.v1beta1", @@ -22801,7 +21968,8 @@ "configFile": "bigquerydatapolicy_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" - ] + ], + "nameInServiceConfig": "bigquerydatapolicy.googleapis.com" }, { "id": "google.cloud.bigquery.datatransfer.v1", @@ -23090,8 +22258,10 @@ ], "configFile": "bigquerydatatransfer_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.bigquery.datatransfer.v1.DataTransferService" - ] + "google.cloud.bigquery.datatransfer.v1.DataTransferService", + "google.cloud.location.Locations" + ], + "nameInServiceConfig": "bigquerydatatransfer.googleapis.com" }, { "id": "google.cloud.bigquery.migration.v2", @@ -23222,7 +22392,8 @@ "configFile": "bigquerymigration_v2.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.migration.v2.MigrationService" - ] + ], + "nameInServiceConfig": "bigquerymigration.googleapis.com" }, { "id": "google.cloud.bigquery.migration.v2alpha", @@ -23371,7 +22542,8 @@ "serviceConfigApiNames": [ "google.cloud.bigquery.migration.v2alpha.MigrationService", "google.cloud.bigquery.migration.v2alpha.SqlTranslationService" - ] + ], + "nameInServiceConfig": "bigquerymigration.googleapis.com" }, { "id": "google.cloud.bigquery.reservation.v1", @@ -23655,264 +22827,8 @@ "configFile": "bigqueryreservation_v1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.reservation.v1.ReservationService" - ] - }, - { - "id": "google.cloud.bigquery.reservation.v1beta1", - "directory": "google/cloud/bigquery/reservation/v1beta1", - "version": "v1beta1", - "majorVersion": "v1", - "hostName": "bigqueryreservation.googleapis.com", - "title": "BigQuery Reservation API", - "description": "A service to modify your BigQuery flat-rate reservations.", - "importDirectories": [ - "google/api", - "google/protobuf", - "google/rpc" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1beta1;reservation": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.bigquery.reservation.v1beta1": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\BigQuery\\Reservation\\V1beta1": 1 - } - } - }, - "services": [ - { - "shortName": "ReservationService", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "methods": [ - { - "shortName": "CreateAssignment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateAssignment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*/reservations/*}/assignments" - } - ] - }, - { - "shortName": "CreateCapacityCommitment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateCapacityCommitment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments" - } - ] - }, - { - "shortName": "CreateReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*}/reservations" - } - ] - }, - { - "shortName": "DeleteAssignment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteAssignment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/reservations/*/assignments/*}" - } - ] - }, - { - "shortName": "DeleteCapacityCommitment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteCapacityCommitment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}" - } - ] - }, - { - "shortName": "DeleteReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/reservations/*}" - } - ] - }, - { - "shortName": "GetBiReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.GetBiReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/biReservation}" - } - ] - }, - { - "shortName": "GetCapacityCommitment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.GetCapacityCommitment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}" - } - ] - }, - { - "shortName": "GetReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.GetReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/reservations/*}" - } - ] - }, - { - "shortName": "ListAssignments", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.ListAssignments", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*/reservations/*}/assignments" - } - ] - }, - { - "shortName": "ListCapacityCommitments", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.ListCapacityCommitments", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments" - } - ] - }, - { - "shortName": "ListReservations", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.ListReservations", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*}/reservations" - } - ] - }, - { - "shortName": "MergeCapacityCommitments", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.MergeCapacityCommitments", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments:merge" - } - ] - }, - { - "shortName": "MoveAssignment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.MoveAssignment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" - } - ] - }, - { - "shortName": "SearchAssignments", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.SearchAssignments", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*}:searchAssignments" - } - ] - }, - { - "shortName": "SplitCapacityCommitment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.SplitCapacityCommitment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}:split" - } - ] - }, - { - "shortName": "UpdateBiReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.UpdateBiReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta1/{reservation.name=projects/*/locations/*/biReservation}" - } - ] - }, - { - "shortName": "UpdateCapacityCommitment", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.UpdateCapacityCommitment", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" - } - ] - }, - { - "shortName": "UpdateReservation", - "fullName": "google.cloud.bigquery.reservation.v1beta1.ReservationService.UpdateReservation", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1beta1/{reservation.name=projects/*/locations/*/reservations/*}" - } - ] - } - ] - } ], - "configFile": "bigqueryreservation_v1beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.bigquery.reservation.v1beta1.ReservationService" - ] + "nameInServiceConfig": "bigqueryreservation.googleapis.com" }, { "id": "google.cloud.bigquery.storage.v1", @@ -24072,7 +22988,8 @@ "serviceConfigApiNames": [ "google.cloud.bigquery.storage.v1.BigQueryRead", "google.cloud.bigquery.storage.v1.BigQueryWrite" - ] + ], + "nameInServiceConfig": "bigquerystorage.googleapis.com" }, { "id": "google.cloud.bigquery.storage.v1beta1", @@ -24169,7 +23086,8 @@ "configFile": "bigquerystorage_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.storage.v1beta1.BigQueryStorage" - ] + ], + "nameInServiceConfig": "bigquerystorage.googleapis.com" }, { "id": "google.cloud.bigquery.storage.v1beta2", @@ -24319,7 +23237,8 @@ "serviceConfigApiNames": [ "google.cloud.bigquery.storage.v1beta2.BigQueryRead", "google.cloud.bigquery.storage.v1beta2.BigQueryWrite" - ] + ], + "nameInServiceConfig": "bigquerystorage.googleapis.com" }, { "id": "google.cloud.bigquery.v2", @@ -24401,7 +23320,8 @@ "configFile": "bigquery_v2.yaml", "serviceConfigApiNames": [ "google.cloud.bigquery.v2.ModelService" - ] + ], + "nameInServiceConfig": "bigquery.googleapis.com" }, { "id": "google.cloud.billing.budgets.v1", @@ -24500,7 +23420,8 @@ "configFile": "billingbudgets.yaml", "serviceConfigApiNames": [ "google.cloud.billing.budgets.v1.BudgetService" - ] + ], + "nameInServiceConfig": "billingbudgets.googleapis.com" }, { "id": "google.cloud.billing.budgets.v1beta1", @@ -24599,7 +23520,8 @@ "configFile": "billingbudgets.yaml", "serviceConfigApiNames": [ "google.cloud.billing.budgets.v1beta1.BudgetService" - ] + ], + "nameInServiceConfig": "billingbudgets.googleapis.com" }, { "id": "google.cloud.billing.v1", @@ -24790,11 +23712,12 @@ ] } ], - "configFile": "cloudbilling.yaml", + "configFile": "cloudbilling_v1.yaml", "serviceConfigApiNames": [ "google.cloud.billing.v1.CloudBilling", "google.cloud.billing.v1.CloudCatalog" - ] + ], + "nameInServiceConfig": "cloudbilling.googleapis.com" }, { "id": "google.cloud.binaryauthorization.v1", @@ -24971,7 +23894,8 @@ "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1", "google.cloud.binaryauthorization.v1.SystemPolicyV1", "google.cloud.binaryauthorization.v1.ValidationHelperV1" - ] + ], + "nameInServiceConfig": "binaryauthorization.googleapis.com" }, { "id": "google.cloud.binaryauthorization.v1beta1", @@ -25129,7 +24053,8 @@ "serviceConfigApiNames": [ "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1", "google.cloud.binaryauthorization.v1beta1.SystemPolicyV1Beta1" - ] + ], + "nameInServiceConfig": "binaryauthorization.googleapis.com" }, { "id": "google.cloud.certificatemanager.v1", @@ -25141,38 +24066,39 @@ "description": "", "importDirectories": [ "google/api", + "google/cloud/certificatemanager/v1", "google/longrunning", "google/protobuf" ], "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.CertificateManager.V1": 1 + "Google.Cloud.CertificateManager.V1": 2 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1;certificatemanager": 1 + "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1;certificatemanager": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.cloud.certificatemanager.v1": 1 + "com.google.cloud.certificatemanager.v1": 2 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\CertificateManager\\V1": 1 + "Google\\Cloud\\CertificateManager\\V1": 2 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::CertificateManager::V1": 1 + "Google::Cloud::CertificateManager::V1": 2 } } }, @@ -25192,6 +24118,17 @@ } ] }, + { + "shortName": "CreateCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateIssuanceConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs" + } + ] + }, { "shortName": "CreateCertificateMap", "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateMap", @@ -25236,6 +24173,17 @@ } ] }, + { + "shortName": "DeleteCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateIssuanceConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}" + } + ] + }, { "shortName": "DeleteCertificateMap", "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateMap", @@ -25280,6 +24228,17 @@ } ] }, + { + "shortName": "GetCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateIssuanceConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}" + } + ] + }, { "shortName": "GetCertificateMap", "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateMap", @@ -25313,6 +24272,17 @@ } ] }, + { + "shortName": "ListCertificateIssuanceConfigs", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateIssuanceConfigs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs" + } + ] + }, { "shortName": "ListCertificateMapEntries", "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateMapEntries", @@ -25409,7 +24379,8 @@ "google.cloud.certificatemanager.v1.CertificateManager", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "certificatemanager.googleapis.com" }, { "id": "google.cloud.channel.v1", @@ -25429,21 +24400,60 @@ "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/channel/v1;channel": 10 + "google.golang.org/genproto/googleapis/cloud/channel/v1;channel": 11 } }, "java_multiple_files": { "valueCounts": { - "true": 10 + "true": 11 } }, "java_package": { "valueCounts": { - "com.google.cloud.channel.v1": 10 + "com.google.cloud.channel.v1": 11 } } }, "services": [ + { + "shortName": "CloudChannelReportsService", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService", + "methods": [ + { + "shortName": "FetchReportResults", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{report_job=accounts/*/reportJobs/*}:fetchReportResults" + } + ] + }, + { + "shortName": "ListReports", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.ListReports", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=accounts/*}/reports" + } + ] + }, + { + "shortName": "RunReportJob", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.RunReportJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=accounts/*/reports/*}:run" + } + ] + } + ] + }, { "shortName": "CloudChannelService", "fullName": "google.cloud.channel.v1.CloudChannelService", @@ -25972,9 +24982,11 @@ ], "configFile": "cloudchannel_v1.yaml", "serviceConfigApiNames": [ + "google.cloud.channel.v1.CloudChannelReportsService", "google.cloud.channel.v1.CloudChannelService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudchannel.googleapis.com" }, { "id": "google.cloud.clouddms.v1", @@ -26221,7 +25233,8 @@ "configFile": "datamigration_v1.yaml", "serviceConfigApiNames": [ "google.cloud.clouddms.v1.DataMigrationService" - ] + ], + "nameInServiceConfig": "datamigration.googleapis.com" }, { "id": "google.cloud.commerce.consumer.procurement.v1alpha1", @@ -26299,7 +25312,8 @@ "serviceConfigApiNames": [ "google.cloud.commerce.consumer.procurement.v1alpha1.ConsumerProcurementService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudcommerceconsumerprocurement.googleapis.com" }, { "id": "google.cloud.compute.v1", @@ -29392,6 +28406,100 @@ } ] }, + { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments", + "methods": [ + { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkAttachments.AggregatedList", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/compute/v1/projects/{project}/aggregated/networkAttachments" + } + ] + }, + { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Delete", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{network_attachment}" + } + ] + }, + { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Get", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{network_attachment}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy" + } + ] + }, + { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Insert", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments" + } + ] + }, + { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkAttachments.List", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkAttachments.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions" + } + ] + } + ] + }, { "shortName": "NetworkEdgeSecurityServices", "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices", @@ -33727,6 +32835,17 @@ "shortName": "TargetTcpProxies", "fullName": "google.cloud.compute.v1.TargetTcpProxies", "methods": [ + { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.AggregatedList", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/compute/v1/projects/{project}/aggregated/targetTcpProxies" + } + ] + }, { "shortName": "Delete", "fullName": "google.cloud.compute.v1.TargetTcpProxies.Delete", @@ -34299,7 +33418,8 @@ "google.cloud.compute.v1.VpnTunnels", "google.cloud.compute.v1.ZoneOperations", "google.cloud.compute.v1.Zones" - ] + ], + "nameInServiceConfig": "compute.googleapis.com" }, { "id": "google.cloud.compute.v1small", @@ -34429,7 +33549,8 @@ "serviceConfigApiNames": [ "google.cloud.compute.v1small.Addresses", "google.cloud.compute.v1small.RegionOperations" - ] + ], + "nameInServiceConfig": "compute.googleapis.com" }, { "id": "google.cloud.connectors.v1", @@ -34642,7 +33763,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "connectors.googleapis.com" }, { "id": "google.cloud.contactcenterinsights.v1", @@ -34696,6 +33818,17 @@ "shortName": "ContactCenterInsights", "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights", "methods": [ + { + "shortName": "BulkAnalyzeConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.BulkAnalyzeConversations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/conversations:bulkAnalyze" + } + ] + }, { "shortName": "CalculateIssueModelStats", "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CalculateIssueModelStats", @@ -34795,6 +33928,17 @@ } ] }, + { + "shortName": "DeleteIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssue", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/issueModels/*/issues/*}" + } + ] + }, { "shortName": "DeleteIssueModel", "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssueModel", @@ -34927,6 +34071,17 @@ } ] }, + { + "shortName": "IngestConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.IngestConversations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/conversations:ingest" + } + ] + }, { "shortName": "ListAnalyses", "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListAnalyses", @@ -35077,7 +34232,8 @@ "serviceConfigApiNames": [ "google.cloud.contactcenterinsights.v1.ContactCenterInsights", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "contactcenterinsights.googleapis.com" }, { "id": "google.cloud.contentwarehouse.v1", @@ -35375,17 +34531,6 @@ } ] }, - { - "shortName": "ProcessAsyncRuleSets", - "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.ProcessAsyncRuleSets", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v1/{location=projects/*/locations/*}:processAsyncRuleSets" - } - ] - }, { "shortName": "UpdateRuleSet", "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.UpdateRuleSet", @@ -35469,7 +34614,8 @@ "google.cloud.contentwarehouse.v1.RuleSetService", "google.cloud.contentwarehouse.v1.SynonymSetService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "contentwarehouse.googleapis.com" }, { "id": "google.cloud.datacatalog.v1", @@ -36122,8 +35268,11 @@ "serviceConfigApiNames": [ "google.cloud.datacatalog.v1.DataCatalog", "google.cloud.datacatalog.v1.PolicyTagManager", - "google.cloud.datacatalog.v1.PolicyTagManagerSerialization" - ] + "google.cloud.datacatalog.v1.PolicyTagManagerSerialization", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "datacatalog.googleapis.com" }, { "id": "google.cloud.datacatalog.v1beta1", @@ -36711,7 +35860,8 @@ "google.cloud.datacatalog.v1beta1.DataCatalog", "google.cloud.datacatalog.v1beta1.PolicyTagManager", "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization" - ] + ], + "nameInServiceConfig": "datacatalog.googleapis.com" }, { "id": "google.cloud.dataform.v1alpha2", @@ -37167,7 +36317,8 @@ "google.cloud.dataform.v1alpha2.Dataform", "google.cloud.location.Locations", "google.iam.v1.IAMPolicy" - ] + ], + "nameInServiceConfig": "dataform.googleapis.com" }, { "id": "google.cloud.dataform.v1beta1", @@ -37623,7 +36774,8 @@ "google.cloud.dataform.v1beta1.Dataform", "google.cloud.location.Locations", "google.iam.v1.IAMPolicy" - ] + ], + "nameInServiceConfig": "dataform.googleapis.com" }, { "id": "google.cloud.datafusion.v1", @@ -37758,7 +36910,8 @@ "configFile": "datafusion_v1.yaml", "serviceConfigApiNames": [ "google.cloud.datafusion.v1.DataFusion" - ] + ], + "nameInServiceConfig": "datafusion.googleapis.com" }, { "id": "google.cloud.datafusion.v1beta1", @@ -37961,7 +37114,8 @@ "configFile": "datafusion_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.datafusion.v1beta1.DataFusion" - ] + ], + "nameInServiceConfig": "datafusion.googleapis.com" }, { "id": "google.cloud.datalabeling.v1beta1", @@ -38395,7 +37549,8 @@ "configFile": "datalabeling_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.datalabeling.v1beta1.DataLabelingService" - ] + ], + "nameInServiceConfig": "datalabeling.googleapis.com" }, { "id": "google.cloud.dataplex.v1", @@ -39028,7 +38183,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "dataplex.googleapis.com" }, { "id": "google.cloud.dataproc.v1", @@ -39047,17 +38203,17 @@ "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc": 7 + "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc": 8 } }, "java_multiple_files": { "valueCounts": { - "true": 7 + "true": 8 } }, "java_package": { "valueCounts": { - "com.google.cloud.dataproc.v1": 7 + "com.google.cloud.dataproc.v1": 8 } } }, @@ -39370,6 +38526,45 @@ } ] }, + { + "shortName": "NodeGroupController", + "fullName": "google.cloud.dataproc.v1.NodeGroupController", + "methods": [ + { + "shortName": "CreateNodeGroup", + "fullName": "google.cloud.dataproc.v1.NodeGroupController.CreateNodeGroup", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/regions/*/clusters/*}/nodeGroups" + } + ] + }, + { + "shortName": "GetNodeGroup", + "fullName": "google.cloud.dataproc.v1.NodeGroupController.GetNodeGroup", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}" + } + ] + }, + { + "shortName": "ResizeNodeGroup", + "fullName": "google.cloud.dataproc.v1.NodeGroupController.ResizeNodeGroup", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}:resize" + } + ] + } + ] + }, { "shortName": "WorkflowTemplateService", "fullName": "google.cloud.dataproc.v1.WorkflowTemplateService", @@ -39488,8 +38683,10 @@ "google.cloud.dataproc.v1.BatchController", "google.cloud.dataproc.v1.ClusterController", "google.cloud.dataproc.v1.JobController", + "google.cloud.dataproc.v1.NodeGroupController", "google.cloud.dataproc.v1.WorkflowTemplateService" - ] + ], + "nameInServiceConfig": "dataproc.googleapis.com" }, { "id": "google.cloud.dataqna.v1alpha", @@ -39621,7 +38818,8 @@ "serviceConfigApiNames": [ "google.cloud.dataqna.v1alpha.AutoSuggestionService", "google.cloud.dataqna.v1alpha.QuestionService" - ] + ], + "nameInServiceConfig": "dataqna.googleapis.com" }, { "id": "google.cloud.datastream.v1", @@ -39958,7 +39156,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "datastream.googleapis.com" }, { "id": "google.cloud.datastream.v1alpha1", @@ -40248,7 +39447,8 @@ "configFile": "datastream_v1alpha1.yaml", "serviceConfigApiNames": [ "google.cloud.datastream.v1alpha1.Datastream" - ] + ], + "nameInServiceConfig": "datastream.googleapis.com" }, { "id": "google.cloud.deploy.v1", @@ -40538,7 +39738,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "clouddeploy.googleapis.com" }, { "id": "google.cloud.dialogflow.cx.v3", @@ -41804,7 +41005,8 @@ "google.cloud.dialogflow.cx.v3.Webhooks", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "dialogflow.googleapis.com" }, { "id": "google.cloud.dialogflow.cx.v3beta1", @@ -43070,7 +42272,8 @@ "google.cloud.dialogflow.cx.v3beta1.Webhooks", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "dialogflow.googleapis.com" }, { "id": "google.cloud.dialogflow.v2", @@ -44566,6 +43769,11 @@ } ] }, + { + "shortName": "StreamingAnalyzeContent", + "fullName": "google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent", + "mode": "BIDIRECTIONAL_STREAMING" + }, { "shortName": "SuggestArticles", "fullName": "google.cloud.dialogflow.v2.Participants.SuggestArticles", @@ -44886,7 +44094,8 @@ "google.cloud.dialogflow.v2.Versions", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "dialogflow.googleapis.com" }, { "id": "google.cloud.dialogflow.v2beta1", @@ -45477,6 +44686,21 @@ "path": "/v2beta1/{parent=projects/*/locations/*/conversations/*}/messages" } ] + }, + { + "shortName": "SuggestConversationSummary", + "fullName": "google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2beta1/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummary" + }, + { + "httpMethod": "POST", + "path": "/v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:suggestConversationSummary" + } + ] } ] }, @@ -46532,7 +45756,8 @@ "google.cloud.dialogflow.v2beta1.Versions", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "dialogflow.googleapis.com" }, { "id": "google.cloud.discoveryengine.v1beta", @@ -46723,7 +45948,8 @@ "google.cloud.discoveryengine.v1beta.RecommendationService", "google.cloud.discoveryengine.v1beta.UserEventService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "discoveryengine.googleapis.com" }, { "id": "google.cloud.documentai.v1", @@ -46981,7 +46207,8 @@ "google.cloud.documentai.v1.DocumentProcessorService", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "documentai.googleapis.com" }, { "id": "google.cloud.documentai.v1beta2", @@ -47072,7 +46299,8 @@ "configFile": "documentai_v1beta2.yaml", "serviceConfigApiNames": [ "google.cloud.documentai.v1beta2.DocumentUnderstandingService" - ] + ], + "nameInServiceConfig": "documentai.googleapis.com" }, { "id": "google.cloud.documentai.v1beta3", @@ -47093,32 +46321,32 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.DocumentAI.V1Beta3": 9 + "Google.Cloud.DocumentAI.V1Beta3": 10 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3;documentai": 9 + "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3;documentai": 10 } }, "java_multiple_files": { "valueCounts": { - "true": 9 + "true": 10 } }, "java_package": { "valueCounts": { - "com.google.cloud.documentai.v1beta3": 9 + "com.google.cloud.documentai.v1beta3": 10 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\DocumentAI\\V1beta3": 9 + "Google\\Cloud\\DocumentAI\\V1beta3": 10 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::DocumentAI::V1beta3": 9 + "Google::Cloud::DocumentAI::V1beta3": 10 } } }, @@ -47208,6 +46436,17 @@ } ] }, + { + "shortName": "EvaluateProcessorVersion", + "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.EvaluateProcessorVersion", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta3/{processor_version=projects/*/locations/*/processors/*/processorVersions/*}:evaluateProcessorVersion" + } + ] + }, { "shortName": "FetchProcessorTypes", "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes", @@ -47219,6 +46458,17 @@ } ] }, + { + "shortName": "GetEvaluation", + "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.GetEvaluation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*/evaluations/*}" + } + ] + }, { "shortName": "GetProcessor", "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessor", @@ -47241,6 +46491,17 @@ } ] }, + { + "shortName": "ListEvaluations", + "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.ListEvaluations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta3/{parent=projects/*/locations/*/processors/*/processorVersions/*}/evaluations" + } + ] + }, { "shortName": "ListProcessorTypes", "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes", @@ -47311,6 +46572,17 @@ } ] }, + { + "shortName": "TrainProcessorVersion", + "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.TrainProcessorVersion", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta3/{parent=projects/*/locations/*/processors/*}/processorVersions:train" + } + ] + }, { "shortName": "UndeployProcessorVersion", "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.UndeployProcessorVersion", @@ -47330,7 +46602,8 @@ "google.cloud.documentai.v1beta3.DocumentProcessorService", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "documentai.googleapis.com" }, { "id": "google.cloud.domains.v1", @@ -47539,7 +46812,8 @@ "configFile": "domains_v1.yaml", "serviceConfigApiNames": [ "google.cloud.domains.v1.Domains" - ] + ], + "nameInServiceConfig": "domains.googleapis.com" }, { "id": "google.cloud.domains.v1alpha2", @@ -47748,7 +47022,8 @@ "configFile": "domains_v1alpha2.yaml", "serviceConfigApiNames": [ "google.cloud.domains.v1alpha2.Domains" - ] + ], + "nameInServiceConfig": "domains.googleapis.com" }, { "id": "google.cloud.domains.v1beta1", @@ -47957,7 +47232,8 @@ "configFile": "domains_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.domains.v1beta1.Domains" - ] + ], + "nameInServiceConfig": "domains.googleapis.com" }, { "id": "google.cloud.edgecontainer.v1", @@ -48191,7 +47467,8 @@ "google.cloud.edgecontainer.v1.EdgeContainer", "google.cloud.location.Locations", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "edgecontainer.googleapis.com" }, { "id": "google.cloud.enterpriseknowledgegraph.v1", @@ -48208,6 +47485,11 @@ "google/rpc" ], "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.EnterpriseKnowledgeGraph.V1": 3 + } + }, "go_package": { "valueCounts": { "google.golang.org/genproto/googleapis/cloud/enterpriseknowledgegraph/v1;enterpriseknowledgegraph": 3 @@ -48222,6 +47504,16 @@ "valueCounts": { "com.google.cloud.enterpriseknowledgegraph.v1": 3 } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\EnterpriseKnowledgeGraph\\V1": 3 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::EnterpriseKnowledgeGraph::V1": 3 + } } }, "services": [ @@ -48283,6 +47575,50 @@ "path": "/v1/{parent=projects/*/locations/*}/entityReconciliationJobs" } ] + }, + { + "shortName": "Lookup", + "fullName": "google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Lookup", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/cloudKnowledgeGraphEntities:Lookup" + } + ] + }, + { + "shortName": "LookupPublicKg", + "fullName": "google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.LookupPublicKg", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/publicKnowledgeGraphEntities:Lookup" + } + ] + }, + { + "shortName": "Search", + "fullName": "google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/cloudKnowledgeGraphEntities:Search" + } + ] + }, + { + "shortName": "SearchPublicKg", + "fullName": "google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.SearchPublicKg", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/publicKnowledgeGraphEntities:Search" + } + ] } ] } @@ -48291,7 +47627,8 @@ "serviceConfigApiNames": [ "google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "enterpriseknowledgegraph.googleapis.com" }, { "id": "google.cloud.essentialcontacts.v1", @@ -48482,7 +47819,8 @@ "configFile": "essentialcontacts_v1.yaml", "serviceConfigApiNames": [ "google.cloud.essentialcontacts.v1.EssentialContactsService" - ] + ], + "nameInServiceConfig": "essentialcontacts.googleapis.com" }, { "id": "google.cloud.eventarc.publishing.v1", @@ -48561,7 +47899,8 @@ "configFile": "eventarcpublishing_v1.yaml", "serviceConfigApiNames": [ "google.cloud.eventarc.publishing.v1.Publisher" - ] + ], + "nameInServiceConfig": "eventarcpublishing.googleapis.com" }, { "id": "google.cloud.eventarc.v1", @@ -48570,45 +47909,46 @@ "majorVersion": "v1", "hostName": "eventarc.googleapis.com", "title": "Eventarc API", - "description": "", + "description": "Build event-driven applications on Google Cloud Platform.", "importDirectories": [ "google/api", "google/cloud/eventarc/v1", "google/longrunning", - "google/protobuf" + "google/protobuf", + "google/rpc" ], "options": { "csharp_namespace": { "valueCounts": { "": 2, - "Google.Cloud.Eventarc.V1": 3 + "Google.Cloud.Eventarc.V1": 4 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/eventarc/v1;eventarc": 5 + "google.golang.org/genproto/googleapis/cloud/eventarc/v1;eventarc": 6 } }, "java_multiple_files": { "valueCounts": { - "true": 5 + "true": 6 } }, "java_package": { "valueCounts": { - "com.google.cloud.eventarc.v1": 5 + "com.google.cloud.eventarc.v1": 6 } }, "php_namespace": { "valueCounts": { "": 2, - "Google\\Cloud\\Eventarc\\V1": 3 + "Google\\Cloud\\Eventarc\\V1": 4 } }, "ruby_package": { "valueCounts": { "": 2, - "Google::Cloud::Eventarc::V1": 3 + "Google::Cloud::Eventarc::V1": 4 } } }, @@ -48705,6 +48045,17 @@ } ] }, + { + "shortName": "GetGoogleChannelConfig", + "fullName": "google.cloud.eventarc.v1.Eventarc.GetGoogleChannelConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/googleChannelConfig}" + } + ] + }, { "shortName": "GetProvider", "fullName": "google.cloud.eventarc.v1.Eventarc.GetProvider", @@ -48782,6 +48133,17 @@ } ] }, + { + "shortName": "UpdateGoogleChannelConfig", + "fullName": "google.cloud.eventarc.v1.Eventarc.UpdateGoogleChannelConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{google_channel_config.name=projects/*/locations/*/googleChannelConfig}" + } + ] + }, { "shortName": "UpdateTrigger", "fullName": "google.cloud.eventarc.v1.Eventarc.UpdateTrigger", @@ -48798,8 +48160,12 @@ ], "configFile": "eventarc_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.eventarc.v1.Eventarc" - ] + "google.cloud.eventarc.v1.Eventarc", + "google.cloud.location.Locations", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "eventarc.googleapis.com" }, { "id": "google.cloud.filestore.v1", @@ -48974,7 +48340,8 @@ "configFile": "file_v1.yaml", "serviceConfigApiNames": [ "google.cloud.filestore.v1.CloudFilestoreManager" - ] + ], + "nameInServiceConfig": "file.googleapis.com" }, { "id": "google.cloud.filestore.v1beta1", @@ -48986,6 +48353,7 @@ "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "importDirectories": [ "google/api", + "google/cloud/common", "google/longrunning", "google/protobuf" ], @@ -49043,6 +48411,28 @@ } ] }, + { + "shortName": "CreateShare", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.CreateShare", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*/instances/*}/shares" + } + ] + }, + { + "shortName": "CreateSnapshot", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.CreateSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*/instances/*}/snapshots" + } + ] + }, { "shortName": "DeleteBackup", "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.DeleteBackup", @@ -49065,6 +48455,28 @@ } ] }, + { + "shortName": "DeleteShare", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.DeleteShare", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/{name=projects/*/locations/*/instances/*/shares/*}" + } + ] + }, + { + "shortName": "DeleteSnapshot", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.DeleteSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/{name=projects/*/locations/*/instances/*/snapshots/*}" + } + ] + }, { "shortName": "GetBackup", "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.GetBackup", @@ -49087,6 +48499,28 @@ } ] }, + { + "shortName": "GetShare", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.GetShare", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=projects/*/locations/*/instances/*/shares/*}" + } + ] + }, + { + "shortName": "GetSnapshot", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.GetSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=projects/*/locations/*/instances/*/snapshots/*}" + } + ] + }, { "shortName": "ListBackups", "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.ListBackups", @@ -49109,6 +48543,28 @@ } ] }, + { + "shortName": "ListShares", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.ListShares", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=projects/*/locations/*/instances/*}/shares" + } + ] + }, + { + "shortName": "ListSnapshots", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.ListSnapshots", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=projects/*/locations/*/instances/*}/snapshots" + } + ] + }, { "shortName": "RestoreInstance", "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.RestoreInstance", @@ -49120,6 +48576,17 @@ } ] }, + { + "shortName": "RevertInstance", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.RevertInstance", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{name=projects/*/locations/*/instances/*}:revert" + } + ] + }, { "shortName": "UpdateBackup", "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.UpdateBackup", @@ -49141,14 +48608,39 @@ "path": "/v1beta1/{instance.name=projects/*/locations/*/instances/*}" } ] + }, + { + "shortName": "UpdateShare", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.UpdateShare", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{share.name=projects/*/locations/*/instances/*/shares/*}" + } + ] + }, + { + "shortName": "UpdateSnapshot", + "fullName": "google.cloud.filestore.v1beta1.CloudFilestoreManager.UpdateSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{snapshot.name=projects/*/locations/*/instances/*/snapshots/*}" + } + ] } ] } ], "configFile": "file_v1beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.filestore.v1beta1.CloudFilestoreManager" - ] + "google.cloud.filestore.v1beta1.CloudFilestoreManager", + "google.cloud.location.Locations", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "file.googleapis.com" }, { "id": "google.cloud.functions.v1", @@ -49319,7 +48811,8 @@ "configFile": "cloudfunctions_v1.yaml", "serviceConfigApiNames": [ "google.cloud.functions.v1.CloudFunctionsService" - ] + ], + "nameInServiceConfig": "cloudfunctions.googleapis.com" }, { "id": "google.cloud.functions.v2", @@ -49458,7 +48951,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudfunctions.googleapis.com" }, { "id": "google.cloud.functions.v2alpha", @@ -49597,7 +49091,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudfunctions.googleapis.com" }, { "id": "google.cloud.functions.v2beta", @@ -49736,7 +49231,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "cloudfunctions.googleapis.com" }, { "id": "google.cloud.gaming.v1", @@ -50098,7 +49594,8 @@ "google.cloud.gaming.v1.GameServerConfigsService", "google.cloud.gaming.v1.GameServerDeploymentsService", "google.cloud.gaming.v1.RealmsService" - ] + ], + "nameInServiceConfig": "gameservices.googleapis.com" }, { "id": "google.cloud.gaming.v1beta", @@ -50466,7 +49963,8 @@ "google.cloud.gaming.v1beta.GameServerConfigsService", "google.cloud.gaming.v1beta.GameServerDeploymentsService", "google.cloud.gaming.v1beta.RealmsService" - ] + ], + "nameInServiceConfig": "gameservices.googleapis.com" }, { "id": "google.cloud.gkebackup.v1", @@ -50789,7 +50287,8 @@ "configFile": "gkebackup_v1.yaml", "serviceConfigApiNames": [ "google.cloud.gkebackup.v1.BackupForGKE" - ] + ], + "nameInServiceConfig": "gkebackup.googleapis.com" }, { "id": "google.cloud.gkeconnect.gateway.v1", @@ -50843,7 +50342,8 @@ "configFile": "connectgateway_v1.yaml", "serviceConfigApiNames": [ "google.cloud.gkeconnect.gateway.v1.GatewayService" - ] + ], + "nameInServiceConfig": "connectgateway.googleapis.com" }, { "id": "google.cloud.gkeconnect.gateway.v1alpha1", @@ -50897,7 +50397,8 @@ "configFile": "connectgateway_v1alpha1.yaml", "serviceConfigApiNames": [ "google.cloud.gkeconnect.gateway.v1alpha1.GatewayService" - ] + ], + "nameInServiceConfig": "connectgateway.googleapis.com" }, { "id": "google.cloud.gkeconnect.gateway.v1beta1", @@ -51008,7 +50509,8 @@ "configFile": "connectgateway_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.gkeconnect.gateway.v1beta1.GatewayService" - ] + ], + "nameInServiceConfig": "connectgateway.googleapis.com" }, { "id": "google.cloud.gkehub.v1", @@ -51200,7 +50702,8 @@ "configFile": "gkehub_v1.yaml", "serviceConfigApiNames": [ "google.cloud.gkehub.v1.GkeHub" - ] + ], + "nameInServiceConfig": "gkehub.googleapis.com" }, { "id": "google.cloud.gkehub.v1alpha", @@ -51344,7 +50847,8 @@ "configFile": "gkehub_v1alpha.yaml", "serviceConfigApiNames": [ "google.cloud.gkehub.v1alpha.GkeHub" - ] + ], + "nameInServiceConfig": "gkehub.googleapis.com" }, { "id": "google.cloud.gkehub.v1alpha2", @@ -51479,7 +50983,8 @@ "configFile": "gkehub_v1alpha2.yaml", "serviceConfigApiNames": [ "google.cloud.gkehub.v1alpha2.GkeHub" - ] + ], + "nameInServiceConfig": "gkehub.googleapis.com" }, { "id": "google.cloud.gkehub.v1beta", @@ -51611,7 +51116,8 @@ "configFile": "gkehub_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.gkehub.v1beta.GkeHub" - ] + ], + "nameInServiceConfig": "gkehub.googleapis.com" }, { "id": "google.cloud.gkehub.v1beta1", @@ -51761,7 +51267,8 @@ "google.cloud.location.Locations", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "gkehub.googleapis.com" }, { "id": "google.cloud.gkemulticloud.v1", @@ -52135,7 +51642,8 @@ "serviceConfigApiNames": [ "google.cloud.gkemulticloud.v1.AwsClusters", "google.cloud.gkemulticloud.v1.AzureClusters" - ] + ], + "nameInServiceConfig": "gkemulticloud.googleapis.com" }, { "id": "google.cloud.gsuiteaddons.v1", @@ -52298,7 +51806,8 @@ "configFile": "gsuiteaddons_v1.yaml", "serviceConfigApiNames": [ "google.cloud.gsuiteaddons.v1.GSuiteAddOns" - ] + ], + "nameInServiceConfig": "gsuiteaddons.googleapis.com" }, { "id": "google.cloud.iap.v1", @@ -52561,7 +52070,8 @@ "serviceConfigApiNames": [ "google.cloud.iap.v1.IdentityAwareProxyAdminService", "google.cloud.iap.v1.IdentityAwareProxyOAuthService" - ] + ], + "nameInServiceConfig": "iap.googleapis.com" }, { "id": "google.cloud.iap.v1beta1", @@ -52636,7 +52146,8 @@ "configFile": "iap_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.iap.v1beta1.IdentityAwareProxyAdminV1Beta1" - ] + ], + "nameInServiceConfig": "iap.googleapis.com" }, { "id": "google.cloud.identitytoolkit.v2", @@ -52756,7 +52267,8 @@ "serviceConfigApiNames": [ "google.cloud.identitytoolkit.v2.AccountManagementService", "google.cloud.identitytoolkit.v2.AuthenticationService" - ] + ], + "nameInServiceConfig": "identitytoolkit.googleapis.com" }, { "id": "google.cloud.ids.v1", @@ -52848,7 +52360,8 @@ "configFile": "ids_v1.yaml", "serviceConfigApiNames": [ "google.cloud.ids.v1.IDS" - ] + ], + "nameInServiceConfig": "ids.googleapis.com" }, { "id": "google.cloud.iot.v1", @@ -53155,7 +52668,8 @@ "configFile": "cloudiot_v1.yaml", "serviceConfigApiNames": [ "google.cloud.iot.v1.DeviceManager" - ] + ], + "nameInServiceConfig": "cloudiot.googleapis.com" }, { "id": "google.cloud.kms.v1", @@ -53550,8 +53064,10 @@ "serviceConfigApiNames": [ "google.cloud.kms.v1.EkmService", "google.cloud.kms.v1.KeyManagementService", + "google.cloud.location.Locations", "google.iam.v1.IAMPolicy" - ] + ], + "nameInServiceConfig": "cloudkms.googleapis.com" }, { "id": "google.cloud.language.v1", @@ -53658,7 +53174,8 @@ "configFile": "language_v1.yaml", "serviceConfigApiNames": [ "google.cloud.language.v1.LanguageService" - ] + ], + "nameInServiceConfig": "language.googleapis.com" }, { "id": "google.cloud.language.v1beta2", @@ -53765,7 +53282,8 @@ "configFile": "language_v1beta2.yaml", "serviceConfigApiNames": [ "google.cloud.language.v1beta2.LanguageService" - ] + ], + "nameInServiceConfig": "language.googleapis.com" }, { "id": "google.cloud.lifesciences.v2beta", @@ -53839,8 +53357,11 @@ ], "configFile": "lifesciences_v2beta.yaml", "serviceConfigApiNames": [ - "google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta" - ] + "google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta", + "google.cloud.location.Locations", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "lifesciences.googleapis.com" }, { "id": "google.cloud.managedidentities.v1", @@ -54015,7 +53536,8 @@ "configFile": "managedidentities_v1.yaml", "serviceConfigApiNames": [ "google.cloud.managedidentities.v1.ManagedIdentitiesService" - ] + ], + "nameInServiceConfig": "managedidentities.googleapis.com" }, { "id": "google.cloud.managedidentities.v1beta1", @@ -54190,7 +53712,8 @@ "configFile": "managedidentities_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.managedidentities.v1beta1.ManagedIdentitiesService" - ] + ], + "nameInServiceConfig": "managedidentities.googleapis.com" }, { "id": "google.cloud.mediatranslation.v1alpha1", @@ -54237,7 +53760,8 @@ "configFile": "mediatranslation_v1alpha1.yaml", "serviceConfigApiNames": [ "google.cloud.mediatranslation.v1alpha1.SpeechTranslationService" - ] + ], + "nameInServiceConfig": "mediatranslation.googleapis.com" }, { "id": "google.cloud.mediatranslation.v1beta1", @@ -54304,7 +53828,8 @@ "configFile": "mediatranslation_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.mediatranslation.v1beta1.SpeechTranslationService" - ] + ], + "nameInServiceConfig": "mediatranslation.googleapis.com" }, { "id": "google.cloud.memcache.v1", @@ -54317,7 +53842,8 @@ "importDirectories": [ "google/api", "google/longrunning", - "google/protobuf" + "google/protobuf", + "google/type" ], "options": { "go_package": { @@ -54396,6 +53922,17 @@ } ] }, + { + "shortName": "RescheduleMaintenance", + "fullName": "google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenance", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{instance=projects/*/locations/*/instances/*}:rescheduleMaintenance" + } + ] + }, { "shortName": "UpdateInstance", "fullName": "google.cloud.memcache.v1.CloudMemcache.UpdateInstance", @@ -54423,8 +53960,11 @@ ], "configFile": "memcache_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.memcache.v1.CloudMemcache" - ] + "google.cloud.location.Locations", + "google.cloud.memcache.v1.CloudMemcache", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "memcache.googleapis.com" }, { "id": "google.cloud.memcache.v1beta2", @@ -54437,7 +53977,8 @@ "importDirectories": [ "google/api", "google/longrunning", - "google/protobuf" + "google/protobuf", + "google/type" ], "options": { "go_package": { @@ -54527,6 +54068,17 @@ } ] }, + { + "shortName": "RescheduleMaintenance", + "fullName": "google.cloud.memcache.v1beta2.CloudMemcache.RescheduleMaintenance", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta2/{instance=projects/*/locations/*/instances/*}:rescheduleMaintenance" + } + ] + }, { "shortName": "UpdateInstance", "fullName": "google.cloud.memcache.v1beta2.CloudMemcache.UpdateInstance", @@ -54554,8 +54106,11 @@ ], "configFile": "memcache_v1beta2.yaml", "serviceConfigApiNames": [ - "google.cloud.memcache.v1beta2.CloudMemcache" - ] + "google.cloud.location.Locations", + "google.cloud.memcache.v1beta2.CloudMemcache", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "memcache.googleapis.com" }, { "id": "google.cloud.metastore.v1", @@ -54574,17 +54129,23 @@ "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/metastore/v1;metastore": 1 + "google.golang.org/genproto/googleapis/cloud/metastore/v1;metastore": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.cloud.metastore.v1": 1 + "com.google.cloud.metastore.v1": 2 + } + }, + "php_namespace": { + "valueCounts": { + "": 1, + "Google\\Cloud\\Metastore\\V1": 1 } } }, @@ -54759,12 +54320,78 @@ ] } ] + }, + { + "shortName": "DataprocMetastoreFederation", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation", + "methods": [ + { + "shortName": "CreateFederation", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation.CreateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "DeleteFederation", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation.DeleteFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "GetFederation", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation.GetFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "ListFederations", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation.ListFederations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "UpdateFederation", + "fullName": "google.cloud.metastore.v1.DataprocMetastoreFederation.UpdateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{federation.name=projects/*/locations/*/federations/*}" + } + ] + } + ] } ], "configFile": "metastore_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.metastore.v1.DataprocMetastore" - ] + "google.cloud.location.Locations", + "google.cloud.metastore.v1.DataprocMetastore", + "google.cloud.metastore.v1.DataprocMetastoreFederation", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "metastore.googleapis.com" }, { "id": "google.cloud.metastore.v1alpha", @@ -54783,21 +54410,22 @@ "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/metastore/v1alpha;metastore": 1 + "google.golang.org/genproto/googleapis/cloud/metastore/v1alpha;metastore": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.cloud.metastore.v1alpha": 1 + "com.google.cloud.metastore.v1alpha": 2 } }, "php_namespace": { "valueCounts": { + "": 1, "Google\\Cloud\\Metastore\\V1alpha": 1 } } @@ -54973,12 +54601,78 @@ ] } ] + }, + { + "shortName": "DataprocMetastoreFederation", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation", + "methods": [ + { + "shortName": "CreateFederation", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation.CreateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1alpha/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "DeleteFederation", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation.DeleteFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1alpha/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "GetFederation", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation.GetFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "ListFederations", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation.ListFederations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "UpdateFederation", + "fullName": "google.cloud.metastore.v1alpha.DataprocMetastoreFederation.UpdateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha/{federation.name=projects/*/locations/*/federations/*}" + } + ] + } + ] } ], "configFile": "metastore_v1alpha.yaml", "serviceConfigApiNames": [ - "google.cloud.metastore.v1alpha.DataprocMetastore" - ] + "google.cloud.location.Locations", + "google.cloud.metastore.v1alpha.DataprocMetastore", + "google.cloud.metastore.v1alpha.DataprocMetastoreFederation", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "metastore.googleapis.com" }, { "id": "google.cloud.metastore.v1beta", @@ -54997,21 +54691,22 @@ "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/metastore/v1beta;metastore": 1 + "google.golang.org/genproto/googleapis/cloud/metastore/v1beta;metastore": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.cloud.metastore.v1beta": 1 + "com.google.cloud.metastore.v1beta": 2 } }, "php_namespace": { "valueCounts": { + "": 1, "Google\\Cloud\\Metastore\\V1beta": 1 } } @@ -55187,12 +54882,78 @@ ] } ] + }, + { + "shortName": "DataprocMetastoreFederation", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation", + "methods": [ + { + "shortName": "CreateFederation", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation.CreateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "DeleteFederation", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation.DeleteFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "GetFederation", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation.GetFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta/{name=projects/*/locations/*/federations/*}" + } + ] + }, + { + "shortName": "ListFederations", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation.ListFederations", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta/{parent=projects/*/locations/*}/federations" + } + ] + }, + { + "shortName": "UpdateFederation", + "fullName": "google.cloud.metastore.v1beta.DataprocMetastoreFederation.UpdateFederation", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta/{federation.name=projects/*/locations/*/federations/*}" + } + ] + } + ] } ], "configFile": "metastore_v1beta.yaml", "serviceConfigApiNames": [ - "google.cloud.metastore.v1beta.DataprocMetastore" - ] + "google.cloud.location.Locations", + "google.cloud.metastore.v1beta.DataprocMetastore", + "google.cloud.metastore.v1beta.DataprocMetastoreFederation", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "metastore.googleapis.com" }, { "id": "google.cloud.networkconnectivity.v1", @@ -55201,7 +54962,7 @@ "majorVersion": "v1", "hostName": "networkconnectivity.googleapis.com", "title": "Network Connectivity API", - "description": "The Network Connectivity API provides access to Network Connectivity Center.", + "description": "This API enables connectivity with and between Google Cloud resources.", "importDirectories": [ "google/api", "google/longrunning", @@ -55210,32 +54971,32 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.NetworkConnectivity.V1": 2 + "Google.Cloud.NetworkConnectivity.V1": 3 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1;networkconnectivity": 2 + "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1;networkconnectivity": 3 } }, "java_multiple_files": { "valueCounts": { - "true": 2 + "true": 3 } }, "java_package": { "valueCounts": { - "com.google.cloud.networkconnectivity.v1": 2 + "com.google.cloud.networkconnectivity.v1": 3 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\NetworkConnectivity\\V1": 2 + "Google\\Cloud\\NetworkConnectivity\\V1": 3 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::NetworkConnectivity::V1": 2 + "Google::Cloud::NetworkConnectivity::V1": 3 } } }, @@ -55355,12 +55116,67 @@ ] } ] + }, + { + "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.networkconnectivity.v1.HubService" - ] + "google.cloud.location.Locations", + "google.cloud.networkconnectivity.v1.HubService", + "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "networkconnectivity.googleapis.com" }, { "id": "google.cloud.networkconnectivity.v1alpha1", @@ -55528,7 +55344,8 @@ "configFile": "networkconnectivity_v1alpha1.yaml", "serviceConfigApiNames": [ "google.cloud.networkconnectivity.v1alpha1.HubService" - ] + ], + "nameInServiceConfig": "networkconnectivity.googleapis.com" }, { "id": "google.cloud.networkmanagement.v1", @@ -55654,7 +55471,8 @@ "configFile": "networkmanagement_v1.yaml", "serviceConfigApiNames": [ "google.cloud.networkmanagement.v1.ReachabilityService" - ] + ], + "nameInServiceConfig": "networkmanagement.googleapis.com" }, { "id": "google.cloud.networkmanagement.v1beta1", @@ -55780,7 +55598,8 @@ "configFile": "networkmanagement_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.networkmanagement.v1beta1.ReachabilityService" - ] + ], + "nameInServiceConfig": "networkmanagement.googleapis.com" }, { "id": "google.cloud.networksecurity.v1", @@ -56007,7 +55826,8 @@ "google.cloud.networksecurity.v1.NetworkSecurity", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "networksecurity.googleapis.com" }, { "id": "google.cloud.networksecurity.v1beta1", @@ -56234,7 +56054,8 @@ "google.cloud.networksecurity.v1beta1.NetworkSecurity", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "networksecurity.googleapis.com" }, { "id": "google.cloud.networkservices.v1", @@ -56725,7 +56546,8 @@ "google.cloud.networkservices.v1.NetworkServices", "google.iam.v1.IAMPolicy", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "networkservices.googleapis.com" }, { "id": "google.cloud.networkservices.v1beta1", @@ -56839,7 +56661,8 @@ "configFile": "networkservices_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.networkservices.v1beta1.NetworkServices" - ] + ], + "nameInServiceConfig": "networkservices.googleapis.com" }, { "id": "google.cloud.notebooks.v1", @@ -56858,34 +56681,34 @@ "options": { "csharp_namespace": { "valueCounts": { - "": 3, + "": 4, "Google.Cloud.Notebooks.V1": 6 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks": 9 + "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks": 10 } }, "java_multiple_files": { "valueCounts": { - "true": 9 + "true": 10 } }, "java_package": { "valueCounts": { - "com.google.cloud.notebooks.v1": 9 + "com.google.cloud.notebooks.v1": 10 } }, "php_namespace": { "valueCounts": { - "": 3, + "": 4, "Google\\Cloud\\Notebooks\\V1": 6 } }, "ruby_package": { "valueCounts": { - "": 3, + "": 4, "Google::Cloud::Notebooks::V1": 6 } } @@ -56917,6 +56740,17 @@ } ] }, + { + "shortName": "DiagnoseRuntime", + "fullName": "google.cloud.notebooks.v1.ManagedNotebookService.DiagnoseRuntime", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/runtimes/*}:diagnose" + } + ] + }, { "shortName": "GetRuntime", "fullName": "google.cloud.notebooks.v1.ManagedNotebookService.GetRuntime", @@ -57004,6 +56838,28 @@ "path": "/v1/{name=projects/*/locations/*/runtimes/*}:switch" } ] + }, + { + "shortName": "UpdateRuntime", + "fullName": "google.cloud.notebooks.v1.ManagedNotebookService.UpdateRuntime", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{runtime.name=projects/*/locations/*/runtimes/*}" + } + ] + }, + { + "shortName": "UpgradeRuntime", + "fullName": "google.cloud.notebooks.v1.ManagedNotebookService.UpgradeRuntime", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/runtimes/*}:upgrade" + } + ] } ] }, @@ -57099,6 +56955,17 @@ } ] }, + { + "shortName": "DiagnoseInstance", + "fullName": "google.cloud.notebooks.v1.NotebookService.DiagnoseInstance", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/instances/*}:diagnose" + } + ] + }, { "shortName": "GetEnvironment", "fullName": "google.cloud.notebooks.v1.NotebookService.GetEnvironment", @@ -57379,9 +57246,13 @@ ], "configFile": "notebooks_v1.yaml", "serviceConfigApiNames": [ + "google.cloud.location.Locations", "google.cloud.notebooks.v1.ManagedNotebookService", - "google.cloud.notebooks.v1.NotebookService" - ] + "google.cloud.notebooks.v1.NotebookService", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "notebooks.googleapis.com" }, { "id": "google.cloud.notebooks.v1beta1", @@ -57390,7 +57261,7 @@ "majorVersion": "v1", "hostName": "notebooks.googleapis.com", "title": "Notebooks API", - "description": "AI Platform Notebooks API is used to manage notebook resources in Google Cloud.", + "description": "Notebooks API is used to manage notebook resources in Google Cloud.", "importDirectories": [ "google/api", "google/cloud/notebooks/v1beta1", @@ -57648,8 +57519,12 @@ ], "configFile": "notebooks_v1beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.notebooks.v1beta1.NotebookService" - ] + "google.cloud.location.Locations", + "google.cloud.notebooks.v1beta1.NotebookService", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "notebooks.googleapis.com" }, { "id": "google.cloud.optimization.v1", @@ -57724,7 +57599,8 @@ "configFile": "cloudoptimization_v1.yaml", "serviceConfigApiNames": [ "google.cloud.optimization.v1.FleetRouting" - ] + ], + "nameInServiceConfig": "cloudoptimization.googleapis.com" }, { "id": "google.cloud.orchestration.airflow.service.v1", @@ -57806,6 +57682,28 @@ } ] }, + { + "shortName": "LoadSnapshot", + "fullName": "google.cloud.orchestration.airflow.service.v1.Environments.LoadSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{environment=projects/*/locations/*/environments/*}:loadSnapshot" + } + ] + }, + { + "shortName": "SaveSnapshot", + "fullName": "google.cloud.orchestration.airflow.service.v1.Environments.SaveSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{environment=projects/*/locations/*/environments/*}:saveSnapshot" + } + ] + }, { "shortName": "UpdateEnvironment", "fullName": "google.cloud.orchestration.airflow.service.v1.Environments.UpdateEnvironment", @@ -57840,8 +57738,10 @@ "configFile": "composer_v1.yaml", "serviceConfigApiNames": [ "google.cloud.orchestration.airflow.service.v1.Environments", - "google.cloud.orchestration.airflow.service.v1.ImageVersions" - ] + "google.cloud.orchestration.airflow.service.v1.ImageVersions", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "composer.googleapis.com" }, { "id": "google.cloud.orchestration.airflow.service.v1beta1", @@ -57934,6 +57834,17 @@ } ] }, + { + "shortName": "LoadSnapshot", + "fullName": "google.cloud.orchestration.airflow.service.v1beta1.Environments.LoadSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{environment=projects/*/locations/*/environments/*}:loadSnapshot" + } + ] + }, { "shortName": "RestartWebServer", "fullName": "google.cloud.orchestration.airflow.service.v1beta1.Environments.RestartWebServer", @@ -57945,6 +57856,17 @@ } ] }, + { + "shortName": "SaveSnapshot", + "fullName": "google.cloud.orchestration.airflow.service.v1beta1.Environments.SaveSnapshot", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{environment=projects/*/locations/*/environments/*}:saveSnapshot" + } + ] + }, { "shortName": "UpdateEnvironment", "fullName": "google.cloud.orchestration.airflow.service.v1beta1.Environments.UpdateEnvironment", @@ -57979,8 +57901,10 @@ "configFile": "composer_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.orchestration.airflow.service.v1beta1.Environments", - "google.cloud.orchestration.airflow.service.v1beta1.ImageVersions" - ] + "google.cloud.orchestration.airflow.service.v1beta1.ImageVersions", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "composer.googleapis.com" }, { "id": "google.cloud.orgpolicy.v2", @@ -58172,7 +58096,8 @@ "configFile": "orgpolicy_v2.yaml", "serviceConfigApiNames": [ "google.cloud.orgpolicy.v2.OrgPolicy" - ] + ], + "nameInServiceConfig": "orgpolicy.googleapis.com" }, { "id": "google.cloud.osconfig.agentendpoint.v1", @@ -58247,7 +58172,8 @@ "configFile": "osconfig_v1.yaml", "serviceConfigApiNames": [ "google.cloud.osconfig.agentendpoint.v1.AgentEndpointService" - ] + ], + "nameInServiceConfig": "osconfig.googleapis.com" }, { "id": "google.cloud.osconfig.agentendpoint.v1beta", @@ -58325,7 +58251,8 @@ "configFile": "osconfig_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService" - ] + ], + "nameInServiceConfig": "osconfig.googleapis.com" }, { "id": "google.cloud.osconfig.v1", @@ -58657,7 +58584,8 @@ "serviceConfigApiNames": [ "google.cloud.osconfig.v1.OsConfigService", "google.cloud.osconfig.v1.OsConfigZonalService" - ] + ], + "nameInServiceConfig": "osconfig.googleapis.com" }, { "id": "google.cloud.osconfig.v1alpha", @@ -58871,7 +58799,8 @@ "configFile": "osconfig_v1alpha.yaml", "serviceConfigApiNames": [ "google.cloud.osconfig.v1alpha.OsConfigZonalService" - ] + ], + "nameInServiceConfig": "osconfig.googleapis.com" }, { "id": "google.cloud.osconfig.v1beta", @@ -59108,7 +59037,8 @@ "configFile": "osconfig_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.osconfig.v1beta.OsConfigService" - ] + ], + "nameInServiceConfig": "osconfig.googleapis.com" }, { "id": "google.cloud.oslogin.v1", @@ -59160,6 +59090,17 @@ "shortName": "OsLoginService", "fullName": "google.cloud.oslogin.v1.OsLoginService", "methods": [ + { + "shortName": "CreateSshPublicKey", + "fullName": "google.cloud.oslogin.v1.OsLoginService.CreateSshPublicKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=users/*}/sshPublicKeys" + } + ] + }, { "shortName": "DeletePosixAccount", "fullName": "google.cloud.oslogin.v1.OsLoginService.DeletePosixAccount", @@ -59232,7 +59173,8 @@ "configFile": "oslogin_v1.yaml", "serviceConfigApiNames": [ "google.cloud.oslogin.v1.OsLoginService" - ] + ], + "nameInServiceConfig": "oslogin.googleapis.com" }, { "id": "google.cloud.oslogin.v1beta", @@ -59284,6 +59226,17 @@ "shortName": "OsLoginService", "fullName": "google.cloud.oslogin.v1beta.OsLoginService", "methods": [ + { + "shortName": "CreateSshPublicKey", + "fullName": "google.cloud.oslogin.v1beta.OsLoginService.CreateSshPublicKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta/{parent=users/*}/sshPublicKeys" + } + ] + }, { "shortName": "DeletePosixAccount", "fullName": "google.cloud.oslogin.v1beta.OsLoginService.DeletePosixAccount", @@ -59356,7 +59309,8 @@ "configFile": "oslogin_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.oslogin.v1beta.OsLoginService" - ] + ], + "nameInServiceConfig": "oslogin.googleapis.com" }, { "id": "google.cloud.paymentgateway.issuerswitch.v1", @@ -59364,11 +59318,12 @@ "version": "v1", "majorVersion": "v1", "hostName": "issuerswitch.googleapis.com", - "title": "Cloud Issuer Switch Service API", + "title": "Issuer switch API", "description": "", "importDirectories": [ "google/api", "google/cloud/paymentgateway/issuerswitch/v1", + "google/logging/type", "google/longrunning", "google/protobuf", "google/type" @@ -59376,32 +59331,32 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.PaymentGateway.IssuerSwitch.V1": 4 + "Google.Cloud.PaymentGateway.IssuerSwitch.V1": 5 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/paymentgateway/issuerswitch/v1;issuerswitch": 4 + "google.golang.org/genproto/googleapis/cloud/paymentgateway/issuerswitch/v1;issuerswitch": 5 } }, "java_multiple_files": { "valueCounts": { - "true": 4 + "true": 5 } }, "java_package": { "valueCounts": { - "com.google.cloud.paymentgateway.issuerswitch.v1": 4 + "com.google.cloud.paymentgateway.issuerswitch.v1": 5 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\PaymentGateway\\IssuerSwitch\\V1": 4 + "Google\\Cloud\\PaymentGateway\\IssuerSwitch\\V1": 5 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::PaymentGateway::IssuerSwitch::V1": 4 + "Google::Cloud::PaymentGateway::IssuerSwitch::V1": 5 } } }, @@ -59618,7 +59573,8 @@ "google.cloud.paymentgateway.issuerswitch.v1.IssuerSwitchRules", "google.cloud.paymentgateway.issuerswitch.v1.IssuerSwitchTransactions", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "issuerswitch.googleapis.com" }, { "id": "google.cloud.phishingprotection.v1beta1", @@ -59690,7 +59646,8 @@ "configFile": "phishingprotection_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.phishingprotection.v1beta1.PhishingProtectionServiceV1Beta1" - ] + ], + "nameInServiceConfig": "phishingprotection.googleapis.com" }, { "id": "google.cloud.policytroubleshooter.v1", @@ -59768,7 +59725,8 @@ "configFile": "policytroubleshooter_v1.yaml", "serviceConfigApiNames": [ "google.cloud.policytroubleshooter.v1.IamChecker" - ] + ], + "nameInServiceConfig": "policytroubleshooter.googleapis.com" }, { "id": "google.cloud.privatecatalog.v1beta1", @@ -59883,7 +59841,8 @@ "configFile": "cloudprivatecatalog_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.privatecatalog.v1beta1.PrivateCatalog" - ] + ], + "nameInServiceConfig": "cloudprivatecatalog.googleapis.com" }, { "id": "google.cloud.pubsublite.v1", @@ -59897,8 +59856,7 @@ "google/api", "google/cloud/pubsublite/v1", "google/longrunning", - "google/protobuf", - "google/rpc" + "google/protobuf" ], "options": { "cc_enable_arenas": { @@ -60269,7 +60227,8 @@ "google.cloud.pubsublite.v1.SubscriberService", "google.cloud.pubsublite.v1.TopicStatsService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "pubsublite.googleapis.com" }, { "id": "google.cloud.recaptchaenterprise.v1", @@ -60278,7 +60237,7 @@ "majorVersion": "v1", "hostName": "recaptchaenterprise.googleapis.com", "title": "reCAPTCHA Enterprise API", - "description": "", + "description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.", "importDirectories": [ "google/api", "google/protobuf" @@ -60435,6 +60394,17 @@ } ] }, + { + "shortName": "RetrieveLegacySecretKey", + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{key=projects/*/keys/*}:retrieveLegacySecretKey" + } + ] + }, { "shortName": "SearchRelatedAccountGroupMemberships", "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMemberships", @@ -60463,7 +60433,8 @@ "configFile": "recaptchaenterprise_v1.yaml", "serviceConfigApiNames": [ "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService" - ] + ], + "nameInServiceConfig": "recaptchaenterprise.googleapis.com" }, { "id": "google.cloud.recaptchaenterprise.v1beta1", @@ -60547,7 +60518,8 @@ "configFile": "recaptchaenterprise_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1" - ] + ], + "nameInServiceConfig": "recaptchaenterprise.googleapis.com" }, { "id": "google.cloud.recommendationengine.v1beta1", @@ -60798,7 +60770,8 @@ "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", "google.cloud.recommendationengine.v1beta1.PredictionService", "google.cloud.recommendationengine.v1beta1.UserEventService" - ] + ], + "nameInServiceConfig": "recommendationengine.googleapis.com" }, { "id": "google.cloud.recommender.logging.v1", @@ -60829,7 +60802,8 @@ } } }, - "configFile": "recommender.yaml" + "configFile": "recommender.yaml", + "nameInServiceConfig": "recommender.googleapis.com" }, { "id": "google.cloud.recommender.logging.v1beta1", @@ -60860,7 +60834,8 @@ } } }, - "configFile": "recommender.yaml" + "configFile": "recommender.yaml", + "nameInServiceConfig": "recommender.googleapis.com" }, { "id": "google.cloud.recommender.v1", @@ -61158,7 +61133,8 @@ "configFile": "recommender_v1.yaml", "serviceConfigApiNames": [ "google.cloud.recommender.v1.Recommender" - ] + ], + "nameInServiceConfig": "recommender.googleapis.com" }, { "id": "google.cloud.recommender.v1beta1", @@ -61456,7 +61432,8 @@ "configFile": "recommender_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.recommender.v1beta1.Recommender" - ] + ], + "nameInServiceConfig": "recommender.googleapis.com" }, { "id": "google.cloud.redis.v1", @@ -61621,7 +61598,8 @@ "configFile": "redis_v1.yaml", "serviceConfigApiNames": [ "google.cloud.redis.v1.CloudRedis" - ] + ], + "nameInServiceConfig": "redis.googleapis.com" }, { "id": "google.cloud.redis.v1beta1", @@ -61786,7 +61764,8 @@ "configFile": "redis_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.redis.v1beta1.CloudRedis" - ] + ], + "nameInServiceConfig": "redis.googleapis.com" }, { "id": "google.cloud.resourcemanager.v2", @@ -61961,7 +61940,8 @@ "configFile": "cloudresourcemanager_v2.yaml", "serviceConfigApiNames": [ "google.cloud.resourcemanager.v2.Folders" - ] + ], + "nameInServiceConfig": "cloudresourcemanager.googleapis.com" }, { "id": "google.cloud.resourcemanager.v3", @@ -62561,7 +62541,8 @@ "google.cloud.resourcemanager.v3.TagBindings", "google.cloud.resourcemanager.v3.TagKeys", "google.cloud.resourcemanager.v3.TagValues" - ] + ], + "nameInServiceConfig": "cloudresourcemanager.googleapis.com" }, { "id": "google.cloud.resourcesettings.v1", @@ -62679,7 +62660,8 @@ "configFile": "resourcesettings_v1.yaml", "serviceConfigApiNames": [ "google.cloud.resourcesettings.v1.ResourceSettingsService" - ] + ], + "nameInServiceConfig": "resourcesettings.googleapis.com" }, { "id": "google.cloud.retail.v2", @@ -63277,7 +63259,8 @@ "google.cloud.retail.v2.ServingConfigService", "google.cloud.retail.v2.UserEventService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "retail.googleapis.com" }, { "id": "google.cloud.retail.v2alpha", @@ -63348,6 +63331,17 @@ } ] }, + { + "shortName": "BatchRemoveCatalogAttributes", + "fullName": "google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2alpha/{attributes_config=projects/*/locations/*/catalogs/*/attributesConfig}:batchRemoveCatalogAttributes" + } + ] + }, { "shortName": "GetAttributesConfig", "fullName": "google.cloud.retail.v2alpha.CatalogService.GetAttributesConfig", @@ -63970,7 +63964,8 @@ "google.cloud.retail.v2alpha.ServingConfigService", "google.cloud.retail.v2alpha.UserEventService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "retail.googleapis.com" }, { "id": "google.cloud.retail.v2beta", @@ -64663,7 +64658,8 @@ "google.cloud.retail.v2beta.ServingConfigService", "google.cloud.retail.v2beta.UserEventService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "retail.googleapis.com" }, { "id": "google.cloud.run.v2", @@ -64672,32 +64668,177 @@ "majorVersion": "v2", "hostName": "run.googleapis.com", "title": "Cloud Run Admin API", - "description": "", + "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "importDirectories": [ "google/api", "google/cloud/run/v2", "google/iam/v1", "google/longrunning", - "google/protobuf" + "google/protobuf", + "google/rpc" ], "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/run/v2;run": 7 + "google.golang.org/genproto/googleapis/cloud/run/v2;run": 12 } }, "java_multiple_files": { "valueCounts": { - "true": 7 + "true": 12 } }, "java_package": { "valueCounts": { - "com.google.cloud.run.v2": 7 + "com.google.cloud.run.v2": 12 } } }, "services": [ + { + "shortName": "Executions", + "fullName": "google.cloud.run.v2.Executions", + "methods": [ + { + "shortName": "DeleteExecution", + "fullName": "google.cloud.run.v2.Executions.DeleteExecution", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/jobs/*/executions/*}" + } + ] + }, + { + "shortName": "GetExecution", + "fullName": "google.cloud.run.v2.Executions.GetExecution", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/jobs/*/executions/*}" + } + ] + }, + { + "shortName": "ListExecutions", + "fullName": "google.cloud.run.v2.Executions.ListExecutions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*/jobs/*}/executions" + } + ] + } + ] + }, + { + "shortName": "Jobs", + "fullName": "google.cloud.run.v2.Jobs", + "methods": [ + { + "shortName": "CreateJob", + "fullName": "google.cloud.run.v2.Jobs.CreateJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{parent=projects/*/locations/*}/jobs" + } + ] + }, + { + "shortName": "DeleteJob", + "fullName": "google.cloud.run.v2.Jobs.DeleteJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/jobs/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.run.v2.Jobs.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{resource=projects/*/locations/*/jobs/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetJob", + "fullName": "google.cloud.run.v2.Jobs.GetJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/jobs/*}" + } + ] + }, + { + "shortName": "ListJobs", + "fullName": "google.cloud.run.v2.Jobs.ListJobs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/jobs" + } + ] + }, + { + "shortName": "RunJob", + "fullName": "google.cloud.run.v2.Jobs.RunJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{name=projects/*/locations/*/jobs/*}:run" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.run.v2.Jobs.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{resource=projects/*/locations/*/jobs/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.run.v2.Jobs.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{resource=projects/*/locations/*/jobs/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateJob", + "fullName": "google.cloud.run.v2.Jobs.UpdateJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v2/{job.name=projects/*/locations/*/jobs/*}" + } + ] + } + ] + }, { "shortName": "Revisions", "fullName": "google.cloud.run.v2.Revisions", @@ -64830,13 +64971,47 @@ ] } ] + }, + { + "shortName": "Tasks", + "fullName": "google.cloud.run.v2.Tasks", + "methods": [ + { + "shortName": "GetTask", + "fullName": "google.cloud.run.v2.Tasks.GetTask", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/jobs/*/executions/*/tasks/*}" + } + ] + }, + { + "shortName": "ListTasks", + "fullName": "google.cloud.run.v2.Tasks.ListTasks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*/jobs/*/executions/*}/tasks" + } + ] + } + ] } ], "configFile": "run_v2.yaml", "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.run.v2.Executions", + "google.cloud.run.v2.Jobs", "google.cloud.run.v2.Revisions", - "google.cloud.run.v2.Services" - ] + "google.cloud.run.v2.Services", + "google.cloud.run.v2.Tasks", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "run.googleapis.com" }, { "id": "google.cloud.scheduler.v1", @@ -64974,7 +65149,8 @@ "configFile": "cloudscheduler_v1.yaml", "serviceConfigApiNames": [ "google.cloud.scheduler.v1.CloudScheduler" - ] + ], + "nameInServiceConfig": "cloudscheduler.googleapis.com" }, { "id": "google.cloud.scheduler.v1beta1", @@ -65111,8 +65287,10 @@ ], "configFile": "cloudscheduler_v1beta1.yaml", "serviceConfigApiNames": [ + "google.cloud.location.Locations", "google.cloud.scheduler.v1beta1.CloudScheduler" - ] + ], + "nameInServiceConfig": "cloudscheduler.googleapis.com" }, { "id": "google.cloud.secretmanager.v1", @@ -65346,7 +65524,8 @@ "configFile": "secretmanager_v1.yaml", "serviceConfigApiNames": [ "google.cloud.secretmanager.v1.SecretManagerService" - ] + ], + "nameInServiceConfig": "secretmanager.googleapis.com" }, { "id": "google.cloud.secrets.v1beta1", @@ -65580,7 +65759,8 @@ "configFile": "secretmanager_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.secrets.v1beta1.SecretManagerService" - ] + ], + "nameInServiceConfig": "secretmanager.googleapis.com" }, { "id": "google.cloud.security.privateca.v1", @@ -65966,7 +66146,8 @@ "google.cloud.location.Locations", "google.cloud.security.privateca.v1.CertificateAuthorityService", "google.iam.v1.IAMPolicy" - ] + ], + "nameInServiceConfig": "privateca.googleapis.com" }, { "id": "google.cloud.security.privateca.v1beta1", @@ -66250,7 +66431,8 @@ "configFile": "privateca_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.security.privateca.v1beta1.CertificateAuthorityService" - ] + ], + "nameInServiceConfig": "privateca.googleapis.com" }, { "id": "google.cloud.security.publicca.v1beta1", @@ -66323,7 +66505,8 @@ "configFile": "publicca_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.security.publicca.v1beta1.PublicCertificateAuthorityService" - ] + ], + "nameInServiceConfig": "publicca.googleapis.com" }, { "id": "google.cloud.securitycenter.settings.v1beta1", @@ -66689,7 +66872,8 @@ "configFile": "securitycenter_settings.yaml", "serviceConfigApiNames": [ "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService" - ] + ], + "nameInServiceConfig": "securitycenter.googleapis.com" }, { "id": "google.cloud.securitycenter.v1", @@ -66709,32 +66893,32 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.SecurityCenter.V1": 29 + "Google.Cloud.SecurityCenter.V1": 30 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter": 29 + "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter": 30 } }, "java_multiple_files": { "valueCounts": { - "true": 29 + "true": 30 } }, "java_package": { "valueCounts": { - "com.google.cloud.securitycenter.v1": 29 + "com.google.cloud.securitycenter.v1": 30 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\SecurityCenter\\V1": 29 + "Google\\Cloud\\SecurityCenter\\V1": 30 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::SecurityCenter::V1": 29 + "Google::Cloud::SecurityCenter::V1": 30 } } }, @@ -66819,6 +67003,14 @@ { "httpMethod": "POST", "path": "/v1/{parent=organizations/*}/notificationConfigs" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=folders/*}/notificationConfigs" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/notificationConfigs" } ] }, @@ -66872,8095 +67064,10696 @@ ] }, { - "shortName": "DeleteNotificationConfig", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.DeleteNotificationConfig", + "shortName": "DeleteNotificationConfig", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.DeleteNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=organizations/*/notificationConfigs/*}" + }, + { + "httpMethod": "DELETE", + "path": "/v1/{name=folders/*/notificationConfigs/*}" + }, + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "GetBigQueryExport", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetBigQueryExport", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=organizations/*/bigQueryExports/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=folders/*/bigQueryExports/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/bigQueryExports/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=organizations/*/sources/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetMuteConfig", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetMuteConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=organizations/*/muteConfigs/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=folders/*/muteConfigs/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/muteConfigs/*}" + } + ] + }, + { + "shortName": "GetNotificationConfig", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=organizations/*/notificationConfigs/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=folders/*/notificationConfigs/*}" + }, + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "GetOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "GetSource", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=organizations/*/sources/*}" + } + ] + }, + { + "shortName": "GroupAssets", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GroupAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=organizations/*}/assets:group" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=folders/*}/assets:group" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/assets:group" + } + ] + }, + { + "shortName": "GroupFindings", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GroupFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=organizations/*/sources/*}/findings:group" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=folders/*/sources/*}/findings:group" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/sources/*}/findings:group" + } + ] + }, + { + "shortName": "ListAssets", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*}/assets" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*}/assets" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/assets" + } + ] + }, + { + "shortName": "ListBigQueryExports", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListBigQueryExports", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*}/bigQueryExports" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*}/bigQueryExports" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/bigQueryExports" + } + ] + }, + { + "shortName": "ListFindings", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*/sources/*}/findings" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*/sources/*}/findings" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/sources/*}/findings" + } + ] + }, + { + "shortName": "ListMuteConfigs", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListMuteConfigs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*}/muteConfigs" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*}/muteConfigs" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/muteConfigs" + } + ] + }, + { + "shortName": "ListNotificationConfigs", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListNotificationConfigs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*}/notificationConfigs" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*}/notificationConfigs" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/notificationConfigs" + } + ] + }, + { + "shortName": "ListSources", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListSources", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=organizations/*}/sources" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=folders/*}/sources" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/sources" + } + ] + }, + { + "shortName": "RunAssetDiscovery", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.RunAssetDiscovery", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=organizations/*}/assets:runDiscovery" + } + ] + }, + { + "shortName": "SetFindingState", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetFindingState", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=organizations/*/sources/*/findings/*}:setState" + }, + { + "httpMethod": "POST", + "path": "/v1/{name=folders/*/sources/*/findings/*}:setState" + }, + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/sources/*/findings/*}:setState" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=organizations/*/sources/*}:setIamPolicy" + } + ] + }, + { + "shortName": "SetMute", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetMute", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=organizations/*/sources/*/findings/*}:setMute" + }, + { + "httpMethod": "POST", + "path": "/v1/{name=folders/*/sources/*/findings/*}:setMute" + }, + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/sources/*/findings/*}:setMute" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=organizations/*/sources/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateBigQueryExport", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateBigQueryExport", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{big_query_export.name=organizations/*/bigQueryExports/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{big_query_export.name=folders/*/bigQueryExports/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{big_query_export.name=projects/*/bigQueryExports/*}" + } + ] + }, + { + "shortName": "UpdateExternalSystem", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateExternalSystem", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{external_system.name=organizations/*/sources/*/findings/*/externalSystems/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{external_system.name=folders/*/sources/*/findings/*/externalSystems/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{external_system.name=projects/*/sources/*/findings/*/externalSystems/*}" + } + ] + }, + { + "shortName": "UpdateFinding", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateFinding", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{finding.name=organizations/*/sources/*/findings/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{finding.name=folders/*/sources/*/findings/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{finding.name=projects/*/sources/*/findings/*}" + } + ] + }, + { + "shortName": "UpdateMuteConfig", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateMuteConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{mute_config.name=organizations/*/muteConfigs/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{mute_config.name=folders/*/muteConfigs/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{mute_config.name=projects/*/muteConfigs/*}" + } + ] + }, + { + "shortName": "UpdateNotificationConfig", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{notification_config.name=organizations/*/notificationConfigs/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{notification_config.name=folders/*/notificationConfigs/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{notification_config.name=projects/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "UpdateOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{organization_settings.name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "UpdateSecurityMarks", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateSecurityMarks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=organizations/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=folders/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=projects/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=folders/*/sources/*/findings/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1/{security_marks.name=projects/*/sources/*/findings/*/securityMarks}" + } + ] + }, + { + "shortName": "UpdateSource", + "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{source.name=organizations/*/sources/*}" + } + ] + } + ] + } + ], + "configFile": "securitycenter_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.securitycenter.v1.SecurityCenter", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "securitycenter.googleapis.com" + }, + { + "id": "google.cloud.securitycenter.v1beta1", + "directory": "google/cloud/securitycenter/v1beta1", + "version": "v1beta1", + "majorVersion": "v1", + "hostName": "securitycenter.googleapis.com", + "title": "Security Command Center API", + "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", + "importDirectories": [ + "google/api", + "google/cloud/securitycenter/v1beta1", + "google/iam/v1", + "google/longrunning", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/securitycenter/v1beta1;securitycenter": 7 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 7 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.securitycenter.v1beta1": 7 + } + } + }, + "services": [ + { + "shortName": "SecurityCenter", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter", + "methods": [ + { + "shortName": "CreateFinding", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.CreateFinding", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=organizations/*/sources/*}/findings" + } + ] + }, + { + "shortName": "CreateSource", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.CreateSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=organizations/*}/sources" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=organizations/*/sources/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "GetSource", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=organizations/*/sources/*}" + } + ] + }, + { + "shortName": "GroupAssets", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GroupAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=organizations/*}/assets:group" + } + ] + }, + { + "shortName": "GroupFindings", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GroupFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=organizations/*/sources/*}/findings:group" + } + ] + }, + { + "shortName": "ListAssets", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=organizations/*}/assets" + } + ] + }, + { + "shortName": "ListFindings", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=organizations/*/sources/*}/findings" + } + ] + }, + { + "shortName": "ListSources", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListSources", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=organizations/*}/sources" + } + ] + }, + { + "shortName": "RunAssetDiscovery", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.RunAssetDiscovery", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=organizations/*}/assets:runDiscovery" + } + ] + }, + { + "shortName": "SetFindingState", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.SetFindingState", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{name=organizations/*/sources/*/findings/*}:setState" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=organizations/*/sources/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=organizations/*/sources/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateFinding", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateFinding", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{finding.name=organizations/*/sources/*/findings/*}" + } + ] + }, + { + "shortName": "UpdateOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{organization_settings.name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "UpdateSecurityMarks", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateSecurityMarks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{security_marks.name=organizations/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1beta1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" + } + ] + }, + { + "shortName": "UpdateSource", + "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{source.name=organizations/*/sources/*}" + } + ] + } + ] + } + ], + "configFile": "securitycenter_v1beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.securitycenter.v1beta1.SecurityCenter" + ], + "nameInServiceConfig": "securitycenter.googleapis.com" + }, + { + "id": "google.cloud.securitycenter.v1p1beta1", + "directory": "google/cloud/securitycenter/v1p1beta1", + "version": "v1p1beta1", + "majorVersion": "v1", + "hostName": "securitycenter.googleapis.com", + "title": "Security Command Center API", + "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", + "importDirectories": [ + "google/api", + "google/cloud/securitycenter/v1p1beta1", + "google/iam/v1", + "google/longrunning", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.SecurityCenter.V1P1Beta1": 11 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/securitycenter/v1p1beta1;securitycenter": 11 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 11 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.securitycenter.v1p1beta1": 11 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\SecurityCenter\\V1p1beta1": 11 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::SecurityCenter::V1p1Beta1": 1, + "Google::Cloud::SecurityCenter::V1p1beta1": 10 + } + } + }, + "services": [ + { + "shortName": "SecurityCenter", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter", + "methods": [ + { + "shortName": "CreateFinding", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateFinding", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings" + } + ] + }, + { + "shortName": "CreateNotificationConfig", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*}/notificationConfigs" + } + ] + }, + { + "shortName": "CreateSource", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*}/sources" + } + ] + }, + { + "shortName": "DeleteNotificationConfig", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.DeleteNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1p1beta1/{name=organizations/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{resource=organizations/*/sources/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetNotificationConfig", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{name=organizations/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "GetOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "GetSource", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{name=organizations/*/sources/*}" + } + ] + }, + { + "shortName": "GroupAssets", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GroupAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*}/assets:group" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=folders/*}/assets:group" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=projects/*}/assets:group" + } + ] + }, + { + "shortName": "GroupFindings", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GroupFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings:group" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=folders/*/sources/*}/findings:group" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=projects/*/sources/*}/findings:group" + } + ] + }, + { + "shortName": "ListAssets", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListAssets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=organizations/*}/assets" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=folders/*}/assets" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=projects/*}/assets" + } + ] + }, + { + "shortName": "ListFindings", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListFindings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=folders/*/sources/*}/findings" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=projects/*/sources/*}/findings" + } + ] + }, + { + "shortName": "ListNotificationConfigs", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListNotificationConfigs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=organizations/*}/notificationConfigs" + } + ] + }, + { + "shortName": "ListSources", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListSources", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=organizations/*}/sources" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=folders/*}/sources" + }, + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=projects/*}/sources" + } + ] + }, + { + "shortName": "RunAssetDiscovery", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.RunAssetDiscovery", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=organizations/*}/assets:runDiscovery" + } + ] + }, + { + "shortName": "SetFindingState", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.SetFindingState", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{name=organizations/*/sources/*/findings/*}:setState" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{name=folders/*/sources/*/findings/*}:setState" + }, + { + "httpMethod": "POST", + "path": "/v1p1beta1/{name=projects/*/sources/*/findings/*}:setState" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{resource=organizations/*/sources/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{resource=organizations/*/sources/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateFinding", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateFinding", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{finding.name=organizations/*/sources/*/findings/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{finding.name=folders/*/sources/*/findings/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{finding.name=projects/*/sources/*/findings/*}" + } + ] + }, + { + "shortName": "UpdateNotificationConfig", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateNotificationConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{notification_config.name=organizations/*/notificationConfigs/*}" + } + ] + }, + { + "shortName": "UpdateOrganizationSettings", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateOrganizationSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{organization_settings.name=organizations/*/organizationSettings}" + } + ] + }, + { + "shortName": "UpdateSecurityMarks", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateSecurityMarks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=organizations/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=folders/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=projects/*/assets/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=folders/*/sources/*/findings/*/securityMarks}" + }, + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{security_marks.name=projects/*/sources/*/findings/*/securityMarks}" + } + ] + }, + { + "shortName": "UpdateSource", + "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateSource", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{source.name=organizations/*/sources/*}" + } + ] + } + ] + } + ], + "configFile": "securitycenter_v1p1beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.securitycenter.v1p1beta1.SecurityCenter" + ], + "nameInServiceConfig": "securitycenter.googleapis.com" + }, + { + "id": "google.cloud.servicedirectory.v1", + "directory": "google/cloud/servicedirectory/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "servicedirectory.googleapis.com", + "title": "Service Directory API", + "description": "Service Directory is a platform for discovering, publishing, and connecting services.", + "importDirectories": [ + "google/api", + "google/cloud/servicedirectory/v1", + "google/iam/v1", + "google/protobuf" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 5 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceDirectory.V1": 5 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1;servicedirectory": 5 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 5 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.servicedirectory.v1": 5 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ServiceDirectory\\V1": 5 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ServiceDirectory::V1": 5 + } + } + }, + "services": [ + { + "shortName": "LookupService", + "fullName": "google.cloud.servicedirectory.v1.LookupService", + "methods": [ + { + "shortName": "ResolveService", + "fullName": "google.cloud.servicedirectory.v1.LookupService.ResolveService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}:resolve" + } + ] + } + ] + }, + { + "shortName": "RegistrationService", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService", + "methods": [ + { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + } + ] + }, + { + "shortName": "CreateNamespace", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/namespaces" + } + ] + }, + { + "shortName": "CreateService", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/namespaces/*}/services" + } + ] + }, + { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "DeleteNamespace", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "DeleteService", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + }, + { + "shortName": "GetEndpoint", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:getIamPolicy" + }, + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetNamespace", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "GetService", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + }, + { + "shortName": "ListEndpoints", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + } + ] + }, + { + "shortName": "ListNamespaces", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListNamespaces", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/namespaces" + } + ] + }, + { + "shortName": "ListServices", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListServices", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/namespaces/*}/services" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:setIamPolicy" + }, + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:testIamPermissions" + }, + { + "httpMethod": "POST", + "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{endpoint.name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "UpdateNamespace", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{namespace.name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "UpdateService", + "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{service.name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + } + ] + } + ], + "configFile": "servicedirectory_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.servicedirectory.v1.LookupService", + "google.cloud.servicedirectory.v1.RegistrationService" + ], + "nameInServiceConfig": "servicedirectory.googleapis.com" + }, + { + "id": "google.cloud.servicedirectory.v1beta1", + "directory": "google/cloud/servicedirectory/v1beta1", + "version": "v1beta1", + "majorVersion": "v1", + "hostName": "servicedirectory.googleapis.com", + "title": "Service Directory API", + "description": "Service Directory is a platform for discovering, publishing, and connecting services.", + "importDirectories": [ + "google/api", + "google/cloud/servicedirectory/v1beta1", + "google/iam/v1", + "google/protobuf" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 5 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.ServiceDirectory.V1Beta1": 5 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1beta1;servicedirectory": 5 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 5 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.servicedirectory.v1beta1": 5 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\ServiceDirectory\\V1beta1": 5 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::ServiceDirectory::V1beta1": 5 + } + } + }, + "services": [ + { + "shortName": "LookupService", + "fullName": "google.cloud.servicedirectory.v1beta1.LookupService", + "methods": [ + { + "shortName": "ResolveService", + "fullName": "google.cloud.servicedirectory.v1beta1.LookupService.ResolveService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}:resolve" + } + ] + } + ] + }, + { + "shortName": "RegistrationService", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService", + "methods": [ + { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + } + ] + }, + { + "shortName": "CreateNamespace", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*}/namespaces" + } + ] + }, + { + "shortName": "CreateService", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*}/services" + } + ] + }, + { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "DeleteNamespace", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "DeleteService", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + }, + { + "shortName": "GetEndpoint", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:getIamPolicy" + }, + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:getIamPolicy" + } + ] + }, + { + "shortName": "GetNamespace", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "GetService", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + }, + { + "shortName": "ListEndpoints", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + } + ] + }, + { + "shortName": "ListNamespaces", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=projects/*/locations/*}/namespaces" + } + ] + }, + { + "shortName": "ListServices", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*}/services" + } + ] + }, + { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:setIamPolicy" + }, + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:testIamPermissions" + }, + { + "httpMethod": "POST", + "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:testIamPermissions" + } + ] + }, + { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateEndpoint", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{endpoint.name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + } + ] + }, + { + "shortName": "UpdateNamespace", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateNamespace", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{namespace.name=projects/*/locations/*/namespaces/*}" + } + ] + }, + { + "shortName": "UpdateService", + "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateService", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1beta1/{service.name=projects/*/locations/*/namespaces/*/services/*}" + } + ] + } + ] + } + ], + "configFile": "servicedirectory_v1beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.servicedirectory.v1beta1.LookupService", + "google.cloud.servicedirectory.v1beta1.RegistrationService" + ], + "nameInServiceConfig": "servicedirectory.googleapis.com" + }, + { + "id": "google.cloud.shell.v1", + "directory": "google/cloud/shell/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "cloudshell.googleapis.com", + "title": "Cloud Shell API", + "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/shell/v1;shell": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.shell.v1": 1 + } + } + }, + "services": [ + { + "shortName": "CloudShellService", + "fullName": "google.cloud.shell.v1.CloudShellService", + "methods": [ + { + "shortName": "AddPublicKey", + "fullName": "google.cloud.shell.v1.CloudShellService.AddPublicKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{environment=users/*/environments/*}:addPublicKey" + } + ] + }, + { + "shortName": "AuthorizeEnvironment", + "fullName": "google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=users/*/environments/*}:authorize" + } + ] + }, + { + "shortName": "GetEnvironment", + "fullName": "google.cloud.shell.v1.CloudShellService.GetEnvironment", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=users/*/environments/*}" + } + ] + }, + { + "shortName": "RemovePublicKey", + "fullName": "google.cloud.shell.v1.CloudShellService.RemovePublicKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{environment=users/*/environments/*}:removePublicKey" + } + ] + }, + { + "shortName": "StartEnvironment", + "fullName": "google.cloud.shell.v1.CloudShellService.StartEnvironment", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=users/*/environments/*}:start" + } + ] + } + ] + } + ], + "configFile": "cloudshell_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.shell.v1.CloudShellService", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "cloudshell.googleapis.com" + }, + { + "id": "google.cloud.speech.v1", + "directory": "google/cloud/speech/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "speech.googleapis.com", + "title": "Cloud Speech-to-Text API", + "description": "Converts audio to text by applying powerful neural network models.", + "importDirectories": [ + "google/api", + "google/cloud/speech/v1", + "google/longrunning", + "google/protobuf", + "google/rpc" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 3 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/speech/v1;speech": 3 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 3 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.speech.v1": 3 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GCS": 3 + } + } + }, + "services": [ + { + "shortName": "Adaptation", + "fullName": "google.cloud.speech.v1.Adaptation", + "methods": [ + { + "shortName": "CreateCustomClass", + "fullName": "google.cloud.speech.v1.Adaptation.CreateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "CreatePhraseSet", + "fullName": "google.cloud.speech.v1.Adaptation.CreatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "DeleteCustomClass", + "fullName": "google.cloud.speech.v1.Adaptation.DeleteCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "DeletePhraseSet", + "fullName": "google.cloud.speech.v1.Adaptation.DeletePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "GetCustomClass", + "fullName": "google.cloud.speech.v1.Adaptation.GetCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "GetPhraseSet", + "fullName": "google.cloud.speech.v1.Adaptation.GetPhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "ListCustomClasses", + "fullName": "google.cloud.speech.v1.Adaptation.ListCustomClasses", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "ListPhraseSet", + "fullName": "google.cloud.speech.v1.Adaptation.ListPhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "UpdateCustomClass", + "fullName": "google.cloud.speech.v1.Adaptation.UpdateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{custom_class.name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "UpdatePhraseSet", + "fullName": "google.cloud.speech.v1.Adaptation.UpdatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + } + ] + } + ] + }, + { + "shortName": "Speech", + "fullName": "google.cloud.speech.v1.Speech", + "methods": [ + { + "shortName": "LongRunningRecognize", + "fullName": "google.cloud.speech.v1.Speech.LongRunningRecognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/speech:longrunningrecognize" + } + ] + }, + { + "shortName": "Recognize", + "fullName": "google.cloud.speech.v1.Speech.Recognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/speech:recognize" + } + ] + }, + { + "shortName": "StreamingRecognize", + "fullName": "google.cloud.speech.v1.Speech.StreamingRecognize", + "mode": "BIDIRECTIONAL_STREAMING" + } + ] + } + ], + "configFile": "speech_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.speech.v1.Adaptation", + "google.cloud.speech.v1.Speech", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "speech.googleapis.com" + }, + { + "id": "google.cloud.speech.v1p1beta1", + "directory": "google/cloud/speech/v1p1beta1", + "version": "v1p1beta1", + "majorVersion": "v1", + "hostName": "speech.googleapis.com", + "title": "Cloud Speech-to-Text API", + "description": "Converts audio to text by applying powerful neural network models.", + "importDirectories": [ + "google/api", + "google/cloud/speech/v1p1beta1", + "google/longrunning", + "google/protobuf", + "google/rpc" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 3 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1;speech": 3 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 3 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.speech.v1p1beta1": 3 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GCS": 3 + } + } + }, + "services": [ + { + "shortName": "Adaptation", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "methods": [ + { + "shortName": "CreateCustomClass", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "CreatePhraseSet", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "DeleteCustomClass", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeleteCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "DeletePhraseSet", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeletePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "GetCustomClass", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "GetPhraseSet", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetPhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "ListCustomClasses", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListCustomClasses", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "ListPhraseSet", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListPhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "UpdateCustomClass", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{custom_class.name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "UpdatePhraseSet", + "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1p1beta1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + } + ] + } + ] + }, + { + "shortName": "Speech", + "fullName": "google.cloud.speech.v1p1beta1.Speech", + "methods": [ + { + "shortName": "LongRunningRecognize", + "fullName": "google.cloud.speech.v1p1beta1.Speech.LongRunningRecognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/speech:longrunningrecognize" + } + ] + }, + { + "shortName": "Recognize", + "fullName": "google.cloud.speech.v1p1beta1.Speech.Recognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p1beta1/speech:recognize" + } + ] + }, + { + "shortName": "StreamingRecognize", + "fullName": "google.cloud.speech.v1p1beta1.Speech.StreamingRecognize", + "mode": "BIDIRECTIONAL_STREAMING" + } + ] + } + ], + "configFile": "speech_v1p1beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.speech.v1p1beta1.Adaptation", + "google.cloud.speech.v1p1beta1.Speech", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "speech.googleapis.com" + }, + { + "id": "google.cloud.speech.v2", + "directory": "google/cloud/speech/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "speech.googleapis.com", + "title": "Cloud Speech-to-Text API", + "description": "Converts audio to text by applying powerful neural network models.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf", + "google/rpc" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/speech/v2;speech": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.speech.v2": 1 + } + } + }, + "services": [ + { + "shortName": "Speech", + "fullName": "google.cloud.speech.v2.Speech", + "methods": [ + { + "shortName": "BatchRecognize", + "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{recognizer=projects/*/locations/*/recognizers/*}:batchRecognize" + } + ] + }, + { + "shortName": "CreateCustomClass", + "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "CreatePhraseSet", + "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "CreateRecognizer", + "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{parent=projects/*/locations/*}/recognizers" + } + ] + }, + { + "shortName": "DeleteCustomClass", + "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "DeletePhraseSet", + "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "DeleteRecognizer", + "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/recognizers/*}" + } + ] + }, + { + "shortName": "GetConfig", + "fullName": "google.cloud.speech.v2.Speech.GetConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/config}" + } + ] + }, + { + "shortName": "GetCustomClass", + "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "GetPhraseSet", + "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "GetRecognizer", + "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/recognizers/*}" + } + ] + }, + { + "shortName": "ListCustomClasses", + "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/customClasses" + } + ] + }, + { + "shortName": "ListPhraseSets", + "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/phraseSets" + } + ] + }, + { + "shortName": "ListRecognizers", + "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/recognizers" + } + ] + }, + { + "shortName": "Recognize", + "fullName": "google.cloud.speech.v2.Speech.Recognize", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{recognizer=projects/*/locations/*/recognizers/*}:recognize" + } + ] + }, + { + "shortName": "StreamingRecognize", + "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "UndeleteCustomClass", + "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{name=projects/*/locations/*/customClasses/*}:undelete" + } + ] + }, + { + "shortName": "UndeletePhraseSet", + "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{name=projects/*/locations/*/phraseSets/*}:undelete" + } + ] + }, + { + "shortName": "UndeleteRecognizer", + "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v2/{name=projects/*/locations/*/recognizers/*}:undelete" + } + ] + }, + { + "shortName": "UpdateConfig", + "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v2/{config.name=projects/*/locations/*/config}" + } + ] + }, + { + "shortName": "UpdateCustomClass", + "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v2/{custom_class.name=projects/*/locations/*/customClasses/*}" + } + ] + }, + { + "shortName": "UpdatePhraseSet", + "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v2/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + } + ] + }, + { + "shortName": "UpdateRecognizer", + "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v2/{recognizer.name=projects/*/locations/*/recognizers/*}" + } + ] + } + ] + } + ], + "configFile": "speech_v2.yaml", + "serviceConfigApiNames": [ + "google.cloud.speech.v2.Speech", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "speech.googleapis.com" + }, + { + "id": "google.cloud.sql.v1", + "directory": "google/cloud/sql/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "sqladmin.googleapis.com", + "title": "Cloud SQL Admin API", + "description": "API for Cloud SQL database instance management", + "importDirectories": [ + "google/api", + "google/cloud/sql/v1", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/sql/v1;sql": 11 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 11 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.sql.v1": 11 + } + } + }, + "services": [ + { + "shortName": "SqlBackupRunsService", + "fullName": "google.cloud.sql.v1.SqlBackupRunsService", + "methods": [ + { + "shortName": "Delete", + "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Delete", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1/{name=organizations/*/notificationConfigs/*}" + "path": "/v1/projects/{project}/instances/{instance}/backupRuns/{id}" } ] }, { - "shortName": "GetBigQueryExport", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetBigQueryExport", + "shortName": "Get", + "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Get", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=organizations/*/bigQueryExports/*}" - }, - { - "httpMethod": "GET", - "path": "/v1/{name=folders/*/bigQueryExports/*}" - }, - { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/bigQueryExports/*}" + "path": "/v1/projects/{project}/instances/{instance}/backupRuns/{id}" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetIamPolicy", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=organizations/*/sources/*}:getIamPolicy" + "path": "/v1/projects/{project}/instances/{instance}/backupRuns" } ] }, { - "shortName": "GetMuteConfig", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetMuteConfig", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlBackupRunsService.List", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=organizations/*/muteConfigs/*}" - }, - { - "httpMethod": "GET", - "path": "/v1/{name=folders/*/muteConfigs/*}" - }, - { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/muteConfigs/*}" + "path": "/v1/projects/{project}/instances/{instance}/backupRuns" } ] - }, + } + ] + }, + { + "shortName": "SqlConnectService", + "fullName": "google.cloud.sql.v1.SqlConnectService", + "methods": [ { - "shortName": "GetNotificationConfig", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetNotificationConfig", + "shortName": "GenerateEphemeralCert", + "fullName": "google.cloud.sql.v1.SqlConnectService.GenerateEphemeralCert", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=organizations/*/notificationConfigs/*}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}:generateEphemeralCert" } ] }, { - "shortName": "GetOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetOrganizationSettings", + "shortName": "GetConnectSettings", + "fullName": "google.cloud.sql.v1.SqlConnectService.GetConnectSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=organizations/*/organizationSettings}" + "path": "/v1/projects/{project}/instances/{instance}/connectSettings" } ] - }, + } + ] + }, + { + "shortName": "SqlDatabasesService", + "fullName": "google.cloud.sql.v1.SqlDatabasesService", + "methods": [ { - "shortName": "GetSource", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GetSource", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=organizations/*/sources/*}" + "httpMethod": "DELETE", + "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "GroupAssets", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GroupAssets", + "shortName": "Get", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.Get", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=organizations/*}/assets:group" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=folders/*}/assets:group" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/assets:group" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "GroupFindings", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.GroupFindings", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=organizations/*/sources/*}/findings:group" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=folders/*/sources/*}/findings:group" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/sources/*}/findings:group" + "path": "/v1/projects/{project}/instances/{instance}/databases" } ] }, { - "shortName": "ListAssets", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListAssets", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.List", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=organizations/*}/assets" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=folders/*}/assets" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*}/assets" + "path": "/v1/projects/{project}/instances/{instance}/databases" } ] }, { - "shortName": "ListBigQueryExports", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListBigQueryExports", + "shortName": "Patch", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.Patch", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=organizations/*}/bigQueryExports" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=folders/*}/bigQueryExports" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*}/bigQueryExports" + "httpMethod": "PATCH", + "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "ListFindings", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListFindings", + "shortName": "Update", + "fullName": "google.cloud.sql.v1.SqlDatabasesService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=organizations/*/sources/*}/findings" - }, + "httpMethod": "PUT", + "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" + } + ] + } + ] + }, + { + "shortName": "SqlFlagsService", + "fullName": "google.cloud.sql.v1.SqlFlagsService", + "methods": [ + { + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlFlagsService.List", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=folders/*/sources/*}/findings" - }, + "path": "/v1/flags" + } + ] + } + ] + }, + { + "shortName": "SqlInstanceNamesService", + "fullName": "google.cloud.sql.v1.SqlInstanceNamesService" + }, + { + "shortName": "SqlInstancesService", + "fullName": "google.cloud.sql.v1.SqlInstancesService", + "methods": [ + { + "shortName": "AddServerCa", + "fullName": "google.cloud.sql.v1.SqlInstancesService.AddServerCa", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/sources/*}/findings" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/addServerCa" } ] }, { - "shortName": "ListMuteConfigs", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListMuteConfigs", + "shortName": "Clone", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Clone", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=organizations/*}/muteConfigs" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=folders/*}/muteConfigs" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*}/muteConfigs" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/clone" } ] }, { - "shortName": "ListNotificationConfigs", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListNotificationConfigs", + "shortName": "CreateEphemeral", + "fullName": "google.cloud.sql.v1.SqlInstancesService.CreateEphemeral", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=organizations/*}/notificationConfigs" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/createEphemeral" } ] }, { - "shortName": "ListSources", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.ListSources", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=organizations/*}/sources" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=folders/*}/sources" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*}/sources" + "httpMethod": "DELETE", + "path": "/v1/projects/{project}/instances/{instance}" } ] }, { - "shortName": "RunAssetDiscovery", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.RunAssetDiscovery", + "shortName": "DemoteMaster", + "fullName": "google.cloud.sql.v1.SqlInstancesService.DemoteMaster", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=organizations/*}/assets:runDiscovery" + "path": "/v1/projects/{project}/instances/{instance}/demoteMaster" } ] }, { - "shortName": "SetFindingState", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetFindingState", + "shortName": "Export", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Export", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{name=organizations/*/sources/*/findings/*}:setState" - }, - { - "httpMethod": "POST", - "path": "/v1/{name=folders/*/sources/*/findings/*}:setState" - }, - { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/sources/*/findings/*}:setState" + "path": "/v1/projects/{project}/instances/{instance}/export" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetIamPolicy", + "shortName": "Failover", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Failover", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=organizations/*/sources/*}:setIamPolicy" + "path": "/v1/projects/{project}/instances/{instance}/failover" } ] }, { - "shortName": "SetMute", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.SetMute", + "shortName": "Get", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Get", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=organizations/*/sources/*/findings/*}:setMute" - }, - { - "httpMethod": "POST", - "path": "/v1/{name=folders/*/sources/*/findings/*}:setMute" - }, + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}" + } + ] + }, + { + "shortName": "Import", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Import", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1/{name=projects/*/sources/*/findings/*}:setMute" + "path": "/v1/projects/{project}/instances/{instance}/import" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.TestIamPermissions", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=organizations/*/sources/*}:testIamPermissions" + "path": "/v1/projects/{project}/instances" } ] }, { - "shortName": "UpdateBigQueryExport", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateBigQueryExport", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlInstancesService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{big_query_export.name=organizations/*/bigQueryExports/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{big_query_export.name=folders/*/bigQueryExports/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{big_query_export.name=projects/*/bigQueryExports/*}" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances" } ] }, { - "shortName": "UpdateExternalSystem", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateExternalSystem", + "shortName": "ListServerCas", + "fullName": "google.cloud.sql.v1.SqlInstancesService.ListServerCas", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{external_system.name=organizations/*/sources/*/findings/*/externalSystems/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{external_system.name=folders/*/sources/*/findings/*/externalSystems/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{external_system.name=projects/*/sources/*/findings/*/externalSystems/*}" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}/listServerCas" } ] }, { - "shortName": "UpdateFinding", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateFinding", + "shortName": "Patch", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Patch", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1/{finding.name=organizations/*/sources/*/findings/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{finding.name=folders/*/sources/*/findings/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{finding.name=projects/*/sources/*/findings/*}" + "path": "/v1/projects/{project}/instances/{instance}" } ] }, { - "shortName": "UpdateMuteConfig", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateMuteConfig", + "shortName": "PromoteReplica", + "fullName": "google.cloud.sql.v1.SqlInstancesService.PromoteReplica", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{mute_config.name=organizations/*/muteConfigs/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{mute_config.name=folders/*/muteConfigs/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{mute_config.name=projects/*/muteConfigs/*}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/promoteReplica" } ] }, { - "shortName": "UpdateNotificationConfig", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateNotificationConfig", + "shortName": "RescheduleMaintenance", + "fullName": "google.cloud.sql.v1.SqlInstancesService.RescheduleMaintenance", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{notification_config.name=organizations/*/notificationConfigs/*}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/rescheduleMaintenance" } ] }, { - "shortName": "UpdateOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateOrganizationSettings", + "shortName": "ResetSslConfig", + "fullName": "google.cloud.sql.v1.SqlInstancesService.ResetSslConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{organization_settings.name=organizations/*/organizationSettings}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/resetSslConfig" } ] }, { - "shortName": "UpdateSecurityMarks", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateSecurityMarks", + "shortName": "Restart", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Restart", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=organizations/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=folders/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=projects/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=folders/*/sources/*/findings/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1/{security_marks.name=projects/*/sources/*/findings/*/securityMarks}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/restart" } ] }, { - "shortName": "UpdateSource", - "fullName": "google.cloud.securitycenter.v1.SecurityCenter.UpdateSource", + "shortName": "RestoreBackup", + "fullName": "google.cloud.sql.v1.SqlInstancesService.RestoreBackup", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{source.name=organizations/*/sources/*}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/restoreBackup" } ] - } - ] - } - ], - "configFile": "securitycenter_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.securitycenter.v1.SecurityCenter", - "google.longrunning.Operations" - ] - }, - { - "id": "google.cloud.securitycenter.v1beta1", - "directory": "google/cloud/securitycenter/v1beta1", - "version": "v1beta1", - "majorVersion": "v1", - "hostName": "securitycenter.googleapis.com", - "title": "Security Command Center API", - "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", - "importDirectories": [ - "google/api", - "google/cloud/securitycenter/v1beta1", - "google/iam/v1", - "google/longrunning", - "google/protobuf" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/securitycenter/v1beta1;securitycenter": 7 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 7 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.securitycenter.v1beta1": 7 - } - } - }, - "services": [ - { - "shortName": "SecurityCenter", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter", - "methods": [ + }, { - "shortName": "CreateFinding", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.CreateFinding", + "shortName": "RotateServerCa", + "fullName": "google.cloud.sql.v1.SqlInstancesService.RotateServerCa", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=organizations/*/sources/*}/findings" + "path": "/v1/projects/{project}/instances/{instance}/rotateServerCa" } ] }, { - "shortName": "CreateSource", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.CreateSource", + "shortName": "StartExternalSync", + "fullName": "google.cloud.sql.v1.SqlInstancesService.StartExternalSync", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=organizations/*}/sources" + "path": "/v1/projects/{project}/instances/{instance}/startExternalSync" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetIamPolicy", + "shortName": "StartReplica", + "fullName": "google.cloud.sql.v1.SqlInstancesService.StartReplica", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{resource=organizations/*/sources/*}:getIamPolicy" + "path": "/v1/projects/{project}/instances/{instance}/startReplica" } ] }, { - "shortName": "GetOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetOrganizationSettings", + "shortName": "StopReplica", + "fullName": "google.cloud.sql.v1.SqlInstancesService.StopReplica", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{name=organizations/*/organizationSettings}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/stopReplica" } ] }, { - "shortName": "GetSource", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GetSource", + "shortName": "TruncateLog", + "fullName": "google.cloud.sql.v1.SqlInstancesService.TruncateLog", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{name=organizations/*/sources/*}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/truncateLog" } ] }, { - "shortName": "GroupAssets", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GroupAssets", + "shortName": "Update", + "fullName": "google.cloud.sql.v1.SqlInstancesService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=organizations/*}/assets:group" + "httpMethod": "PUT", + "path": "/v1/projects/{project}/instances/{instance}" } ] }, { - "shortName": "GroupFindings", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.GroupFindings", + "shortName": "VerifyExternalSyncSettings", + "fullName": "google.cloud.sql.v1.SqlInstancesService.VerifyExternalSyncSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{parent=organizations/*/sources/*}/findings:group" + "path": "/v1/projects/{project}/instances/{instance}/verifyExternalSyncSettings" } ] - }, + } + ] + }, + { + "shortName": "SqlOperationsService", + "fullName": "google.cloud.sql.v1.SqlOperationsService", + "methods": [ { - "shortName": "ListAssets", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListAssets", + "shortName": "Get", + "fullName": "google.cloud.sql.v1.SqlOperationsService.Get", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=organizations/*}/assets" + "path": "/v1/projects/{project}/operations/{operation}" } ] }, - { - "shortName": "ListFindings", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListFindings", + { + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlOperationsService.List", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=organizations/*/sources/*}/findings" + "path": "/v1/projects/{project}/operations" } ] - }, + } + ] + }, + { + "shortName": "SqlSslCertsService", + "fullName": "google.cloud.sql.v1.SqlSslCertsService", + "methods": [ { - "shortName": "ListSources", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.ListSources", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1.SqlSslCertsService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{parent=organizations/*}/sources" + "httpMethod": "DELETE", + "path": "/v1/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" } ] }, { - "shortName": "RunAssetDiscovery", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.RunAssetDiscovery", + "shortName": "Get", + "fullName": "google.cloud.sql.v1.SqlSslCertsService.Get", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=organizations/*}/assets:runDiscovery" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" } ] }, { - "shortName": "SetFindingState", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.SetFindingState", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1.SqlSslCertsService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{name=organizations/*/sources/*/findings/*}:setState" + "path": "/v1/projects/{project}/instances/{instance}/sslCerts" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.SetIamPolicy", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlSslCertsService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{resource=organizations/*/sources/*}:setIamPolicy" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}/sslCerts" } ] - }, + } + ] + }, + { + "shortName": "SqlTiersService", + "fullName": "google.cloud.sql.v1.SqlTiersService", + "methods": [ { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.TestIamPermissions", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlTiersService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{resource=organizations/*/sources/*}:testIamPermissions" + "httpMethod": "GET", + "path": "/v1/projects/{project}/tiers" } ] - }, + } + ] + }, + { + "shortName": "SqlUsersService", + "fullName": "google.cloud.sql.v1.SqlUsersService", + "methods": [ { - "shortName": "UpdateFinding", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateFinding", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1.SqlUsersService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{finding.name=organizations/*/sources/*/findings/*}" + "httpMethod": "DELETE", + "path": "/v1/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateOrganizationSettings", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1.SqlUsersService.Insert", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{organization_settings.name=organizations/*/organizationSettings}" + "httpMethod": "POST", + "path": "/v1/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateSecurityMarks", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateSecurityMarks", + "shortName": "List", + "fullName": "google.cloud.sql.v1.SqlUsersService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{security_marks.name=organizations/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1beta1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" + "httpMethod": "GET", + "path": "/v1/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateSource", - "fullName": "google.cloud.securitycenter.v1beta1.SecurityCenter.UpdateSource", + "shortName": "Update", + "fullName": "google.cloud.sql.v1.SqlUsersService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{source.name=organizations/*/sources/*}" + "httpMethod": "PUT", + "path": "/v1/projects/{project}/instances/{instance}/users" } ] } ] } ], - "configFile": "securitycenter_v1beta1.yaml", + "configFile": "sqladmin_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.securitycenter.v1beta1.SecurityCenter" - ] + "google.cloud.sql.v1.SqlBackupRunsService", + "google.cloud.sql.v1.SqlConnectService", + "google.cloud.sql.v1.SqlDatabasesService", + "google.cloud.sql.v1.SqlFlagsService", + "google.cloud.sql.v1.SqlInstanceNamesService", + "google.cloud.sql.v1.SqlInstancesService", + "google.cloud.sql.v1.SqlOperationsService", + "google.cloud.sql.v1.SqlSslCertsService", + "google.cloud.sql.v1.SqlTiersService", + "google.cloud.sql.v1.SqlUsersService" + ], + "nameInServiceConfig": "sqladmin.googleapis.com" }, { - "id": "google.cloud.securitycenter.v1p1beta1", - "directory": "google/cloud/securitycenter/v1p1beta1", - "version": "v1p1beta1", + "id": "google.cloud.sql.v1beta4", + "directory": "google/cloud/sql/v1beta4", + "version": "v1beta4", "majorVersion": "v1", - "hostName": "securitycenter.googleapis.com", - "title": "Security Command Center API", - "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", + "hostName": "sqladmin.googleapis.com", + "title": "Cloud SQL Admin API", + "description": "API for Cloud SQL database instance management", "importDirectories": [ "google/api", - "google/cloud/securitycenter/v1p1beta1", - "google/iam/v1", - "google/longrunning", + "google/cloud/sql/v1beta4", "google/protobuf" ], "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.SecurityCenter.V1P1Beta1": 11 - } - }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/securitycenter/v1p1beta1;securitycenter": 11 + "google.golang.org/genproto/googleapis/cloud/sql/v1beta4;sql": 5 } }, "java_multiple_files": { "valueCounts": { - "true": 11 + "true": 5 } }, "java_package": { "valueCounts": { - "com.google.cloud.securitycenter.v1p1beta1": 11 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\SecurityCenter\\V1p1beta1": 11 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::SecurityCenter::V1p1Beta1": 1, - "Google::Cloud::SecurityCenter::V1p1beta1": 10 + "com.google.cloud.sql.v1beta4": 5 } } }, "services": [ { - "shortName": "SecurityCenter", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter", + "shortName": "SqlBackupRunsService", + "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService", "methods": [ { - "shortName": "CreateFinding", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateFinding", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings" + "httpMethod": "DELETE", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}" } ] }, { - "shortName": "CreateNotificationConfig", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateNotificationConfig", + "shortName": "Get", + "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Get", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*}/notificationConfigs" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}" } ] }, { - "shortName": "CreateSource", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.CreateSource", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*}/sources" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns" } ] }, { - "shortName": "DeleteNotificationConfig", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.DeleteNotificationConfig", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1p1beta1/{name=organizations/*/notificationConfigs/*}" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns" } ] - }, + } + ] + }, + { + "shortName": "SqlConnectService", + "fullName": "google.cloud.sql.v1beta4.SqlConnectService", + "methods": [ { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetIamPolicy", + "shortName": "GenerateEphemeralCert", + "fullName": "google.cloud.sql.v1beta4.SqlConnectService.GenerateEphemeralCert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{resource=organizations/*/sources/*}:getIamPolicy" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}:generateEphemeralCert" } ] }, { - "shortName": "GetNotificationConfig", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetNotificationConfig", + "shortName": "GetConnectSettings", + "fullName": "google.cloud.sql.v1beta4.SqlConnectService.GetConnectSettings", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p1beta1/{name=organizations/*/notificationConfigs/*}" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/connectSettings" } ] - }, + } + ] + }, + { + "shortName": "SqlDatabasesService", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService", + "methods": [ { - "shortName": "GetOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetOrganizationSettings", + "shortName": "Delete", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Delete", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{name=organizations/*/organizationSettings}" + "httpMethod": "DELETE", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "GetSource", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GetSource", + "shortName": "Get", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Get", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p1beta1/{name=organizations/*/sources/*}" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "GroupAssets", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GroupAssets", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*}/assets:group" - }, - { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=folders/*}/assets:group" - }, - { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=projects/*}/assets:group" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases" } ] }, { - "shortName": "GroupFindings", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.GroupFindings", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings:group" - }, - { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=folders/*/sources/*}/findings:group" - }, - { - "httpMethod": "POST", - "path": "/v1p1beta1/{parent=projects/*/sources/*}/findings:group" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases" } ] }, { - "shortName": "ListAssets", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListAssets", + "shortName": "Patch", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Patch", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=organizations/*}/assets" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=folders/*}/assets" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=projects/*}/assets" + "httpMethod": "PATCH", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" } ] }, { - "shortName": "ListFindings", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListFindings", + "shortName": "Update", + "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=organizations/*/sources/*}/findings" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=folders/*/sources/*}/findings" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=projects/*/sources/*}/findings" + "httpMethod": "PUT", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" } ] - }, + } + ] + }, + { + "shortName": "SqlFlagsService", + "fullName": "google.cloud.sql.v1beta4.SqlFlagsService", + "methods": [ { - "shortName": "ListNotificationConfigs", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListNotificationConfigs", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlFlagsService.List", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p1beta1/{parent=organizations/*}/notificationConfigs" + "path": "/sql/v1beta4/flags" } ] - }, + } + ] + }, + { + "shortName": "SqlInstancesService", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService", + "methods": [ { - "shortName": "ListSources", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.ListSources", + "shortName": "AddServerCa", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.AddServerCa", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=organizations/*}/sources" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=folders/*}/sources" - }, - { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=projects/*}/sources" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/addServerCa" } ] }, { - "shortName": "RunAssetDiscovery", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.RunAssetDiscovery", + "shortName": "Clone", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Clone", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{parent=organizations/*}/assets:runDiscovery" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/clone" } ] }, { - "shortName": "SetFindingState", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.SetFindingState", + "shortName": "CreateEphemeral", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.CreateEphemeral", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{name=organizations/*/sources/*/findings/*}:setState" - }, + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral" + } + ] + }, + { + "shortName": "Delete", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Delete", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "POST", - "path": "/v1p1beta1/{name=folders/*/sources/*/findings/*}:setState" - }, + "httpMethod": "DELETE", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}" + } + ] + }, + { + "shortName": "DemoteMaster", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.DemoteMaster", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{name=projects/*/sources/*/findings/*}:setState" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.SetIamPolicy", + "shortName": "Export", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Export", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{resource=organizations/*/sources/*}:setIamPolicy" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/export" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.TestIamPermissions", + "shortName": "Failover", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Failover", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{resource=organizations/*/sources/*}:testIamPermissions" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/failover" } ] }, { - "shortName": "UpdateFinding", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateFinding", + "shortName": "Get", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Get", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{finding.name=organizations/*/sources/*/findings/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{finding.name=folders/*/sources/*/findings/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{finding.name=projects/*/sources/*/findings/*}" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}" } ] }, { - "shortName": "UpdateNotificationConfig", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateNotificationConfig", + "shortName": "Import", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Import", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{notification_config.name=organizations/*/notificationConfigs/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/import" } ] }, { - "shortName": "UpdateOrganizationSettings", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateOrganizationSettings", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Insert", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{organization_settings.name=organizations/*/organizationSettings}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances" } ] }, { - "shortName": "UpdateSecurityMarks", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateSecurityMarks", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=organizations/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=folders/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=projects/*/assets/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=folders/*/sources/*/findings/*/securityMarks}" - }, - { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{security_marks.name=projects/*/sources/*/findings/*/securityMarks}" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances" } ] }, { - "shortName": "UpdateSource", - "fullName": "google.cloud.securitycenter.v1p1beta1.SecurityCenter.UpdateSource", + "shortName": "ListServerCas", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.ListServerCas", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{source.name=organizations/*/sources/*}" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/listServerCas" } - ] - } - ] - } - ], - "configFile": "securitycenter_v1p1beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.securitycenter.v1p1beta1.SecurityCenter" - ] - }, - { - "id": "google.cloud.servicedirectory.v1", - "directory": "google/cloud/servicedirectory/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "servicedirectory.googleapis.com", - "title": "Service Directory API", - "description": "Service Directory is a platform for discovering, publishing, and connecting services.", - "importDirectories": [ - "google/api", - "google/cloud/servicedirectory/v1", - "google/iam/v1", - "google/protobuf" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 5 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.ServiceDirectory.V1": 5 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1;servicedirectory": 5 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 5 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.servicedirectory.v1": 5 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\ServiceDirectory\\V1": 5 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::ServiceDirectory::V1": 5 - } - } - }, - "services": [ - { - "shortName": "LookupService", - "fullName": "google.cloud.servicedirectory.v1.LookupService", - "methods": [ + ] + }, { - "shortName": "ResolveService", - "fullName": "google.cloud.servicedirectory.v1.LookupService.ResolveService", + "shortName": "Patch", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Patch", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}:resolve" + "httpMethod": "PATCH", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}" } ] - } - ] - }, - { - "shortName": "RegistrationService", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService", - "methods": [ + }, { - "shortName": "CreateEndpoint", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateEndpoint", + "shortName": "PromoteReplica", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.PromoteReplica", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica" } ] }, { - "shortName": "CreateNamespace", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateNamespace", + "shortName": "RescheduleMaintenance", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RescheduleMaintenance", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/namespaces" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance" } ] }, { - "shortName": "CreateService", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.CreateService", + "shortName": "ResetSslConfig", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.ResetSslConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*/namespaces/*}/services" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig" } ] }, { - "shortName": "DeleteEndpoint", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteEndpoint", + "shortName": "Restart", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Restart", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/restart" } ] }, { - "shortName": "DeleteNamespace", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteNamespace", + "shortName": "RestoreBackup", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RestoreBackup", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/namespaces/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup" } ] }, { - "shortName": "DeleteService", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.DeleteService", + "shortName": "RotateServerCa", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RotateServerCa", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa" } ] }, { - "shortName": "GetEndpoint", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetEndpoint", + "shortName": "StartExternalSync", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StartExternalSync", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetIamPolicy", + "shortName": "StartReplica", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StartReplica", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:getIamPolicy" - }, + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/startReplica" + } + ] + }, + { + "shortName": "StopReplica", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StopReplica", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:getIamPolicy" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/stopReplica" } ] }, { - "shortName": "GetNamespace", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetNamespace", + "shortName": "TruncateLog", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.TruncateLog", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/namespaces/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/truncateLog" } ] }, { - "shortName": "GetService", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.GetService", + "shortName": "Update", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/namespaces/*/services/*}" + "httpMethod": "PUT", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}" } ] }, { - "shortName": "ListEndpoints", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints", + "shortName": "VerifyExternalSyncSettings", + "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.VerifyExternalSyncSettings", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings" + } + ] + } + ] + }, + { + "shortName": "SqlOperationsService", + "fullName": "google.cloud.sql.v1beta4.SqlOperationsService", + "methods": [ + { + "shortName": "Get", + "fullName": "google.cloud.sql.v1beta4.SqlOperationsService.Get", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + "path": "/sql/v1beta4/projects/{project}/operations/{operation}" } ] }, { - "shortName": "ListNamespaces", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListNamespaces", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlOperationsService.List", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/namespaces" + "path": "/sql/v1beta4/projects/{project}/operations" + } + ] + } + ] + }, + { + "shortName": "SqlSslCertsService", + "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService", + "methods": [ + { + "shortName": "Delete", + "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Delete", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" } ] }, { - "shortName": "ListServices", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.ListServices", + "shortName": "Get", + "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Get", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/namespaces/*}/services" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.SetIamPolicy", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Insert", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:setIamPolicy" - }, - { - "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:setIamPolicy" + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.TestIamPermissions", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*}:testIamPermissions" - }, + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts" + } + ] + } + ] + }, + { + "shortName": "SqlTiersService", + "fullName": "google.cloud.sql.v1beta4.SqlTiersService", + "methods": [ + { + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlTiersService.List", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{resource=projects/*/locations/*/namespaces/*/services/*}:testIamPermissions" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/tiers" + } + ] + } + ] + }, + { + "shortName": "SqlUsersService", + "fullName": "google.cloud.sql.v1beta4.SqlUsersService", + "methods": [ + { + "shortName": "Delete", + "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Delete", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateEndpoint", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateEndpoint", + "shortName": "Insert", + "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Insert", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{endpoint.name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "POST", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateNamespace", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateNamespace", + "shortName": "List", + "fullName": "google.cloud.sql.v1beta4.SqlUsersService.List", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{namespace.name=projects/*/locations/*/namespaces/*}" + "httpMethod": "GET", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" } ] }, { - "shortName": "UpdateService", - "fullName": "google.cloud.servicedirectory.v1.RegistrationService.UpdateService", + "shortName": "Update", + "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Update", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{service.name=projects/*/locations/*/namespaces/*/services/*}" + "httpMethod": "PUT", + "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" } ] } ] } ], - "configFile": "servicedirectory_v1.yaml", + "configFile": "sqladmin_v1beta4.yaml", "serviceConfigApiNames": [ - "google.cloud.servicedirectory.v1.LookupService", - "google.cloud.servicedirectory.v1.RegistrationService" - ] + "google.cloud.sql.v1beta4.SqlBackupRunsService", + "google.cloud.sql.v1beta4.SqlConnectService", + "google.cloud.sql.v1beta4.SqlDatabasesService", + "google.cloud.sql.v1beta4.SqlFlagsService", + "google.cloud.sql.v1beta4.SqlInstancesService", + "google.cloud.sql.v1beta4.SqlOperationsService", + "google.cloud.sql.v1beta4.SqlSslCertsService", + "google.cloud.sql.v1beta4.SqlTiersService", + "google.cloud.sql.v1beta4.SqlUsersService" + ], + "nameInServiceConfig": "sqladmin.googleapis.com" }, { - "id": "google.cloud.servicedirectory.v1beta1", - "directory": "google/cloud/servicedirectory/v1beta1", - "version": "v1beta1", + "id": "google.cloud.storageinsights.v1", + "directory": "google/cloud/storageinsights/v1", + "version": "v1", "majorVersion": "v1", - "hostName": "servicedirectory.googleapis.com", - "title": "Service Directory API", - "description": "Service Directory is a platform for discovering, publishing, and connecting services.", + "hostName": "storageinsights.googleapis.com", + "title": "Storage Insights API", + "description": "", "importDirectories": [ "google/api", - "google/cloud/servicedirectory/v1beta1", - "google/iam/v1", - "google/protobuf" + "google/protobuf", + "google/rpc", + "google/type" ], "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 5 - } - }, "csharp_namespace": { "valueCounts": { - "Google.Cloud.ServiceDirectory.V1Beta1": 5 + "Google.Cloud.StorageInsights.V1": 1 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1beta1;servicedirectory": 5 + "google.golang.org/genproto/googleapis/cloud/storageinsights/v1;storageinsights": 1 } }, "java_multiple_files": { "valueCounts": { - "true": 5 + "true": 1 } }, "java_package": { "valueCounts": { - "com.google.cloud.servicedirectory.v1beta1": 5 + "com.google.cloud.storageinsights.v1": 1 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\ServiceDirectory\\V1beta1": 5 + "Google\\Cloud\\StorageInsights\\V1": 1 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::ServiceDirectory::V1beta1": 5 + "Google::Cloud::StorageInsights::V1": 1 } } }, "services": [ { - "shortName": "LookupService", - "fullName": "google.cloud.servicedirectory.v1beta1.LookupService", + "shortName": "StorageInsights", + "fullName": "google.cloud.storageinsights.v1.StorageInsights", "methods": [ { - "shortName": "ResolveService", - "fullName": "google.cloud.servicedirectory.v1beta1.LookupService.ResolveService", + "shortName": "CreateReportConfig", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.CreateReportConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}:resolve" + "path": "/v1/{parent=projects/*/locations/*}/reportConfigs" } ] - } - ] - }, - { - "shortName": "RegistrationService", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService", - "methods": [ + }, { - "shortName": "CreateEndpoint", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateEndpoint", + "shortName": "DeleteReportConfig", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.DeleteReportConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/reportConfigs/*}" } ] }, { - "shortName": "CreateNamespace", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateNamespace", + "shortName": "GetReportConfig", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.GetReportConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*}/namespaces" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/reportConfigs/*}" } ] }, { - "shortName": "CreateService", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.CreateService", + "shortName": "GetReportDetail", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.GetReportDetail", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*}/services" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/reportConfigs/*/reportDetails/*}" } ] }, { - "shortName": "DeleteEndpoint", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteEndpoint", + "shortName": "ListReportConfigs", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.ListReportConfigs", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/reportConfigs" } ] }, { - "shortName": "DeleteNamespace", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteNamespace", + "shortName": "ListReportDetails", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.ListReportDetails", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/reportConfigs/*}/reportDetails" } ] }, { - "shortName": "DeleteService", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteService", + "shortName": "UpdateReportConfig", + "fullName": "google.cloud.storageinsights.v1.StorageInsights.UpdateReportConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}" + "httpMethod": "PATCH", + "path": "/v1/{report_config.name=projects/*/locations/*/reportConfigs/*}" } ] - }, + } + ] + } + ], + "configFile": "storageinsights_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.storageinsights.v1.StorageInsights", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "storageinsights.googleapis.com" + }, + { + "id": "google.cloud.talent.v4", + "directory": "google/cloud/talent/v4", + "version": "v4", + "majorVersion": "v4", + "hostName": "jobs.googleapis.com", + "title": "Cloud Talent Solution API", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", + "importDirectories": [ + "google/api", + "google/cloud/talent/v4", + "google/longrunning", + "google/protobuf", + "google/rpc", + "google/type" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/talent/v4;talent": 12 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 12 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.talent.v4": 12 + } + }, + "objc_class_prefix": { + "valueCounts": { + "CTS": 12 + } + } + }, + "services": [ + { + "shortName": "CompanyService", + "fullName": "google.cloud.talent.v4.CompanyService", + "methods": [ { - "shortName": "GetEndpoint", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetEndpoint", + "shortName": "CreateCompany", + "fullName": "google.cloud.talent.v4.CompanyService.CreateCompany", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "POST", + "path": "/v4/{parent=projects/*/tenants/*}/companies" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetIamPolicy", + "shortName": "DeleteCompany", + "fullName": "google.cloud.talent.v4.CompanyService.DeleteCompany", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:getIamPolicy" - }, - { - "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:getIamPolicy" + "httpMethod": "DELETE", + "path": "/v4/{name=projects/*/tenants/*/companies/*}" } ] }, { - "shortName": "GetNamespace", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetNamespace", + "shortName": "GetCompany", + "fullName": "google.cloud.talent.v4.CompanyService.GetCompany", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*}" + "path": "/v4/{name=projects/*/tenants/*/companies/*}" } ] }, { - "shortName": "GetService", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.GetService", + "shortName": "ListCompanies", + "fullName": "google.cloud.talent.v4.CompanyService.ListCompanies", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{name=projects/*/locations/*/namespaces/*/services/*}" + "path": "/v4/{parent=projects/*/tenants/*}/companies" } ] }, { - "shortName": "ListEndpoints", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints", + "shortName": "UpdateCompany", + "fullName": "google.cloud.talent.v4.CompanyService.UpdateCompany", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*/services/*}/endpoints" + "httpMethod": "PATCH", + "path": "/v4/{company.name=projects/*/tenants/*/companies/*}" } ] - }, + } + ] + }, + { + "shortName": "Completion", + "fullName": "google.cloud.talent.v4.Completion", + "methods": [ { - "shortName": "ListNamespaces", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces", + "shortName": "CompleteQuery", + "fullName": "google.cloud.talent.v4.Completion.CompleteQuery", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*}/namespaces" + "path": "/v4/{tenant=projects/*/tenants/*}:completeQuery" } ] - }, + } + ] + }, + { + "shortName": "EventService", + "fullName": "google.cloud.talent.v4.EventService", + "methods": [ { - "shortName": "ListServices", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices", + "shortName": "CreateClientEvent", + "fullName": "google.cloud.talent.v4.EventService.CreateClientEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/{parent=projects/*/locations/*/namespaces/*}/services" + "httpMethod": "POST", + "path": "/v4/{parent=projects/*/tenants/*}/clientEvents" } ] - }, + } + ] + }, + { + "shortName": "JobService", + "fullName": "google.cloud.talent.v4.JobService", + "methods": [ { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.SetIamPolicy", + "shortName": "BatchCreateJobs", + "fullName": "google.cloud.talent.v4.JobService.BatchCreateJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:setIamPolicy" - }, + "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchCreate" + } + ] + }, + { + "shortName": "BatchDeleteJobs", + "fullName": "google.cloud.talent.v4.JobService.BatchDeleteJobs", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:setIamPolicy" + "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchDelete" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.TestIamPermissions", + "shortName": "BatchUpdateJobs", + "fullName": "google.cloud.talent.v4.JobService.BatchUpdateJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*}:testIamPermissions" - }, + "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchUpdate" + } + ] + }, + { + "shortName": "CreateJob", + "fullName": "google.cloud.talent.v4.JobService.CreateJob", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/{resource=projects/*/locations/*/namespaces/*/services/*}:testIamPermissions" + "path": "/v4/{parent=projects/*/tenants/*}/jobs" + } + ] + }, + { + "shortName": "DeleteJob", + "fullName": "google.cloud.talent.v4.JobService.DeleteJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v4/{name=projects/*/tenants/*/jobs/*}" + } + ] + }, + { + "shortName": "GetJob", + "fullName": "google.cloud.talent.v4.JobService.GetJob", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v4/{name=projects/*/tenants/*/jobs/*}" + } + ] + }, + { + "shortName": "ListJobs", + "fullName": "google.cloud.talent.v4.JobService.ListJobs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v4/{parent=projects/*/tenants/*}/jobs" } ] }, { - "shortName": "UpdateEndpoint", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateEndpoint", + "shortName": "SearchJobs", + "fullName": "google.cloud.talent.v4.JobService.SearchJobs", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{endpoint.name=projects/*/locations/*/namespaces/*/services/*/endpoints/*}" + "httpMethod": "POST", + "path": "/v4/{parent=projects/*/tenants/*}/jobs:search" } ] }, { - "shortName": "UpdateNamespace", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateNamespace", + "shortName": "SearchJobsForAlert", + "fullName": "google.cloud.talent.v4.JobService.SearchJobsForAlert", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1beta1/{namespace.name=projects/*/locations/*/namespaces/*}" + "httpMethod": "POST", + "path": "/v4/{parent=projects/*/tenants/*}/jobs:searchForAlert" } ] }, { - "shortName": "UpdateService", - "fullName": "google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateService", + "shortName": "UpdateJob", + "fullName": "google.cloud.talent.v4.JobService.UpdateJob", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1beta1/{service.name=projects/*/locations/*/namespaces/*/services/*}" + "path": "/v4/{job.name=projects/*/tenants/*/jobs/*}" } ] } ] - } - ], - "configFile": "servicedirectory_v1beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.servicedirectory.v1beta1.LookupService", - "google.cloud.servicedirectory.v1beta1.RegistrationService" - ] - }, - { - "id": "google.cloud.shell.v1", - "directory": "google/cloud/shell/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "cloudshell.googleapis.com", - "title": "Cloud Shell API", - "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.", - "importDirectories": [ - "google/api", - "google/longrunning", - "google/protobuf" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/shell/v1;shell": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } }, - "java_package": { - "valueCounts": { - "com.google.cloud.shell.v1": 1 - } - } - }, - "services": [ { - "shortName": "CloudShellService", - "fullName": "google.cloud.shell.v1.CloudShellService", + "shortName": "TenantService", + "fullName": "google.cloud.talent.v4.TenantService", "methods": [ { - "shortName": "AddPublicKey", - "fullName": "google.cloud.shell.v1.CloudShellService.AddPublicKey", + "shortName": "CreateTenant", + "fullName": "google.cloud.talent.v4.TenantService.CreateTenant", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{environment=users/*/environments/*}:addPublicKey" + "path": "/v4/{parent=projects/*}/tenants" } ] }, { - "shortName": "AuthorizeEnvironment", - "fullName": "google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment", + "shortName": "DeleteTenant", + "fullName": "google.cloud.talent.v4.TenantService.DeleteTenant", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=users/*/environments/*}:authorize" + "httpMethod": "DELETE", + "path": "/v4/{name=projects/*/tenants/*}" } ] }, { - "shortName": "GetEnvironment", - "fullName": "google.cloud.shell.v1.CloudShellService.GetEnvironment", + "shortName": "GetTenant", + "fullName": "google.cloud.talent.v4.TenantService.GetTenant", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=users/*/environments/*}" + "path": "/v4/{name=projects/*/tenants/*}" } ] }, { - "shortName": "RemovePublicKey", - "fullName": "google.cloud.shell.v1.CloudShellService.RemovePublicKey", + "shortName": "ListTenants", + "fullName": "google.cloud.talent.v4.TenantService.ListTenants", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{environment=users/*/environments/*}:removePublicKey" + "httpMethod": "GET", + "path": "/v4/{parent=projects/*}/tenants" } ] }, { - "shortName": "StartEnvironment", - "fullName": "google.cloud.shell.v1.CloudShellService.StartEnvironment", + "shortName": "UpdateTenant", + "fullName": "google.cloud.talent.v4.TenantService.UpdateTenant", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=users/*/environments/*}:start" + "httpMethod": "PATCH", + "path": "/v4/{tenant.name=projects/*/tenants/*}" } ] } ] } ], - "configFile": "cloudshell_v1.yaml", + "configFile": "jobs_v4.yaml", "serviceConfigApiNames": [ - "google.cloud.shell.v1.CloudShellService" - ] + "google.cloud.talent.v4.CompanyService", + "google.cloud.talent.v4.Completion", + "google.cloud.talent.v4.EventService", + "google.cloud.talent.v4.JobService", + "google.cloud.talent.v4.TenantService", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "jobs.googleapis.com" }, { - "id": "google.cloud.speech.v1", - "directory": "google/cloud/speech/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "speech.googleapis.com", - "title": "Cloud Speech-to-Text API", - "description": "Converts audio to text by applying powerful neural network models.", + "id": "google.cloud.talent.v4beta1", + "directory": "google/cloud/talent/v4beta1", + "version": "v4beta1", + "majorVersion": "v4", + "hostName": "jobs.googleapis.com", + "title": "Cloud Talent Solution API", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "importDirectories": [ "google/api", - "google/cloud/speech/v1", + "google/cloud/talent/v4beta1", "google/longrunning", "google/protobuf", - "google/rpc" + "google/rpc", + "google/type" ], "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 3 - } - }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/speech/v1;speech": 3 + "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent": 13 } }, "java_multiple_files": { "valueCounts": { - "true": 3 + "true": 13 } }, "java_package": { "valueCounts": { - "com.google.cloud.speech.v1": 3 + "com.google.cloud.talent.v4beta1": 13 } }, "objc_class_prefix": { "valueCounts": { - "GCS": 3 + "CTS": 13 } } }, "services": [ { - "shortName": "Adaptation", - "fullName": "google.cloud.speech.v1.Adaptation", + "shortName": "CompanyService", + "fullName": "google.cloud.talent.v4beta1.CompanyService", "methods": [ { - "shortName": "CreateCustomClass", - "fullName": "google.cloud.speech.v1.Adaptation.CreateCustomClass", + "shortName": "CreateCompany", + "fullName": "google.cloud.talent.v4beta1.CompanyService.CreateCompany", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/customClasses" - } - ] - }, - { - "shortName": "CreatePhraseSet", - "fullName": "google.cloud.speech.v1.Adaptation.CreatePhraseSet", - "mode": "UNARY", - "bindings": [ + "path": "/v4beta1/{parent=projects/*/tenants/*}/companies" + }, { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/phraseSets" + "path": "/v4beta1/{parent=projects/*}/companies" } ] }, { - "shortName": "DeleteCustomClass", - "fullName": "google.cloud.speech.v1.Adaptation.DeleteCustomClass", + "shortName": "DeleteCompany", + "fullName": "google.cloud.talent.v4beta1.CompanyService.DeleteCompany", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/customClasses/*}" - } - ] - }, - { - "shortName": "DeletePhraseSet", - "fullName": "google.cloud.speech.v1.Adaptation.DeletePhraseSet", - "mode": "UNARY", - "bindings": [ + "path": "/v4beta1/{name=projects/*/tenants/*/companies/*}" + }, { "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/phraseSets/*}" + "path": "/v4beta1/{name=projects/*/companies/*}" } ] }, { - "shortName": "GetCustomClass", - "fullName": "google.cloud.speech.v1.Adaptation.GetCustomClass", + "shortName": "GetCompany", + "fullName": "google.cloud.talent.v4beta1.CompanyService.GetCompany", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/customClasses/*}" - } - ] - }, - { - "shortName": "GetPhraseSet", - "fullName": "google.cloud.speech.v1.Adaptation.GetPhraseSet", - "mode": "UNARY", - "bindings": [ + "path": "/v4beta1/{name=projects/*/tenants/*/companies/*}" + }, { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/phraseSets/*}" + "path": "/v4beta1/{name=projects/*/companies/*}" } ] }, { - "shortName": "ListCustomClasses", - "fullName": "google.cloud.speech.v1.Adaptation.ListCustomClasses", + "shortName": "ListCompanies", + "fullName": "google.cloud.talent.v4beta1.CompanyService.ListCompanies", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/customClasses" - } - ] - }, - { - "shortName": "ListPhraseSet", - "fullName": "google.cloud.speech.v1.Adaptation.ListPhraseSet", - "mode": "UNARY", - "bindings": [ + "path": "/v4beta1/{parent=projects/*/tenants/*}/companies" + }, { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/phraseSets" + "path": "/v4beta1/{parent=projects/*}/companies" } ] }, { - "shortName": "UpdateCustomClass", - "fullName": "google.cloud.speech.v1.Adaptation.UpdateCustomClass", + "shortName": "UpdateCompany", + "fullName": "google.cloud.talent.v4beta1.CompanyService.UpdateCompany", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1/{custom_class.name=projects/*/locations/*/customClasses/*}" - } - ] - }, - { - "shortName": "UpdatePhraseSet", - "fullName": "google.cloud.speech.v1.Adaptation.UpdatePhraseSet", - "mode": "UNARY", - "bindings": [ + "path": "/v4beta1/{company.name=projects/*/tenants/*/companies/*}" + }, { "httpMethod": "PATCH", - "path": "/v1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + "path": "/v4beta1/{company.name=projects/*/companies/*}" } ] } ] }, { - "shortName": "Speech", - "fullName": "google.cloud.speech.v1.Speech", + "shortName": "Completion", + "fullName": "google.cloud.talent.v4beta1.Completion", "methods": [ { - "shortName": "LongRunningRecognize", - "fullName": "google.cloud.speech.v1.Speech.LongRunningRecognize", + "shortName": "CompleteQuery", + "fullName": "google.cloud.talent.v4beta1.Completion.CompleteQuery", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/speech:longrunningrecognize" + "httpMethod": "GET", + "path": "/v4beta1/{parent=projects/*/tenants/*}:complete" + }, + { + "httpMethod": "GET", + "path": "/v4beta1/{parent=projects/*}:complete" } ] - }, + } + ] + }, + { + "shortName": "EventService", + "fullName": "google.cloud.talent.v4beta1.EventService", + "methods": [ { - "shortName": "Recognize", - "fullName": "google.cloud.speech.v1.Speech.Recognize", + "shortName": "CreateClientEvent", + "fullName": "google.cloud.talent.v4beta1.EventService.CreateClientEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/speech:recognize" + "path": "/v4beta1/{parent=projects/*/tenants/*}/clientEvents" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/clientEvents" } ] - }, - { - "shortName": "StreamingRecognize", - "fullName": "google.cloud.speech.v1.Speech.StreamingRecognize", - "mode": "BIDIRECTIONAL_STREAMING" } ] - } - ], - "configFile": "speech_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.speech.v1.Adaptation", - "google.cloud.speech.v1.Speech" - ] - }, - { - "id": "google.cloud.speech.v1p1beta1", - "directory": "google/cloud/speech/v1p1beta1", - "version": "v1p1beta1", - "majorVersion": "v1", - "hostName": "speech.googleapis.com", - "title": "Cloud Speech-to-Text API", - "description": "Converts audio to text by applying powerful neural network models.", - "importDirectories": [ - "google/api", - "google/cloud/speech/v1p1beta1", - "google/longrunning", - "google/protobuf", - "google/rpc" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 3 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1;speech": 3 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 3 - } }, - "java_package": { - "valueCounts": { - "com.google.cloud.speech.v1p1beta1": 3 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GCS": 3 - } - } - }, - "services": [ { - "shortName": "Adaptation", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation", + "shortName": "JobService", + "fullName": "google.cloud.talent.v4beta1.JobService", "methods": [ { - "shortName": "CreateCustomClass", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreateCustomClass", + "shortName": "BatchCreateJobs", + "fullName": "google.cloud.talent.v4beta1.JobService.BatchCreateJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{parent=projects/*/locations/*}/customClasses" + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchCreate" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs:batchCreate" } ] }, { - "shortName": "CreatePhraseSet", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.CreatePhraseSet", + "shortName": "BatchDeleteJobs", + "fullName": "google.cloud.talent.v4beta1.JobService.BatchDeleteJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchDelete" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs:batchDelete" } ] }, { - "shortName": "DeleteCustomClass", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeleteCustomClass", + "shortName": "BatchUpdateJobs", + "fullName": "google.cloud.talent.v4beta1.JobService.BatchUpdateJobs", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchUpdate" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs:batchUpdate" } ] }, { - "shortName": "DeletePhraseSet", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.DeletePhraseSet", + "shortName": "CreateJob", + "fullName": "google.cloud.talent.v4beta1.JobService.CreateJob", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs" } ] }, { - "shortName": "GetCustomClass", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetCustomClass", + "shortName": "DeleteJob", + "fullName": "google.cloud.talent.v4beta1.JobService.DeleteJob", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{name=projects/*/locations/*/customClasses/*}" + "httpMethod": "DELETE", + "path": "/v4beta1/{name=projects/*/tenants/*/jobs/*}" + }, + { + "httpMethod": "DELETE", + "path": "/v4beta1/{name=projects/*/jobs/*}" } ] }, { - "shortName": "GetPhraseSet", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.GetPhraseSet", + "shortName": "GetJob", + "fullName": "google.cloud.talent.v4beta1.JobService.GetJob", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p1beta1/{name=projects/*/locations/*/phraseSets/*}" + "path": "/v4beta1/{name=projects/*/tenants/*/jobs/*}" + }, + { + "httpMethod": "GET", + "path": "/v4beta1/{name=projects/*/jobs/*}" } ] }, { - "shortName": "ListCustomClasses", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListCustomClasses", + "shortName": "ListJobs", + "fullName": "google.cloud.talent.v4beta1.JobService.ListJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p1beta1/{parent=projects/*/locations/*}/customClasses" + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs" + }, + { + "httpMethod": "GET", + "path": "/v4beta1/{parent=projects/*}/jobs" } ] }, { - "shortName": "ListPhraseSet", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.ListPhraseSet", + "shortName": "SearchJobs", + "fullName": "google.cloud.talent.v4beta1.JobService.SearchJobs", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1p1beta1/{parent=projects/*/locations/*}/phraseSets" + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:search" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs:search" } ] }, { - "shortName": "UpdateCustomClass", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdateCustomClass", + "shortName": "SearchJobsForAlert", + "fullName": "google.cloud.talent.v4beta1.JobService.SearchJobsForAlert", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1p1beta1/{custom_class.name=projects/*/locations/*/customClasses/*}" + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:searchForAlert" + }, + { + "httpMethod": "POST", + "path": "/v4beta1/{parent=projects/*}/jobs:searchForAlert" } ] }, { - "shortName": "UpdatePhraseSet", - "fullName": "google.cloud.speech.v1p1beta1.Adaptation.UpdatePhraseSet", + "shortName": "UpdateJob", + "fullName": "google.cloud.talent.v4beta1.JobService.UpdateJob", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1p1beta1/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + "path": "/v4beta1/{job.name=projects/*/tenants/*/jobs/*}" + }, + { + "httpMethod": "PATCH", + "path": "/v4beta1/{job.name=projects/*/jobs/*}" } ] } ] }, { - "shortName": "Speech", - "fullName": "google.cloud.speech.v1p1beta1.Speech", + "shortName": "TenantService", + "fullName": "google.cloud.talent.v4beta1.TenantService", "methods": [ { - "shortName": "LongRunningRecognize", - "fullName": "google.cloud.speech.v1p1beta1.Speech.LongRunningRecognize", + "shortName": "CreateTenant", + "fullName": "google.cloud.talent.v4beta1.TenantService.CreateTenant", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/speech:longrunningrecognize" + "path": "/v4beta1/{parent=projects/*}/tenants" } ] }, { - "shortName": "Recognize", - "fullName": "google.cloud.speech.v1p1beta1.Speech.Recognize", + "shortName": "DeleteTenant", + "fullName": "google.cloud.talent.v4beta1.TenantService.DeleteTenant", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p1beta1/speech:recognize" + "httpMethod": "DELETE", + "path": "/v4beta1/{name=projects/*/tenants/*}" } ] }, { - "shortName": "StreamingRecognize", - "fullName": "google.cloud.speech.v1p1beta1.Speech.StreamingRecognize", - "mode": "BIDIRECTIONAL_STREAMING" + "shortName": "GetTenant", + "fullName": "google.cloud.talent.v4beta1.TenantService.GetTenant", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v4beta1/{name=projects/*/tenants/*}" + } + ] + }, + { + "shortName": "ListTenants", + "fullName": "google.cloud.talent.v4beta1.TenantService.ListTenants", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v4beta1/{parent=projects/*}/tenants" + } + ] + }, + { + "shortName": "UpdateTenant", + "fullName": "google.cloud.talent.v4beta1.TenantService.UpdateTenant", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v4beta1/{tenant.name=projects/*/tenants/*}" + } + ] } ] } ], - "configFile": "speech_v1p1beta1.yaml", + "configFile": "jobs_v4beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.speech.v1p1beta1.Adaptation", - "google.cloud.speech.v1p1beta1.Speech" - ] + "google.cloud.talent.v4beta1.CompanyService", + "google.cloud.talent.v4beta1.Completion", + "google.cloud.talent.v4beta1.EventService", + "google.cloud.talent.v4beta1.JobService", + "google.cloud.talent.v4beta1.TenantService", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "jobs.googleapis.com" }, { - "id": "google.cloud.speech.v2", - "directory": "google/cloud/speech/v2", + "id": "google.cloud.tasks.v2", + "directory": "google/cloud/tasks/v2", "version": "v2", "majorVersion": "v2", - "hostName": "speech.googleapis.com", - "title": "Cloud Speech-to-Text API", - "description": "Converts audio to text by applying powerful neural network models.", + "hostName": "cloudtasks.googleapis.com", + "title": "Cloud Tasks API", + "description": "Manages the execution of large numbers of distributed requests.", "importDirectories": [ "google/api", - "google/longrunning", + "google/cloud/tasks/v2", + "google/iam/v1", "google/protobuf", "google/rpc" ], "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/speech/v2;speech": 1 + "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks": 4 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 4 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.tasks.v2": 4 } }, - "java_package": { + "objc_class_prefix": { "valueCounts": { - "com.google.cloud.speech.v2": 1 + "": 3, + "TASKS": 1 } } }, "services": [ { - "shortName": "Speech", - "fullName": "google.cloud.speech.v2.Speech", + "shortName": "CloudTasks", + "fullName": "google.cloud.tasks.v2.CloudTasks", "methods": [ { - "shortName": "BatchRecognize", - "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v2/{recognizer=projects/*/locations/*/recognizers/*}:batchRecognize" - } - ] - }, - { - "shortName": "CreateCustomClass", - "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*}/customClasses" - } - ] - }, - { - "shortName": "CreatePhraseSet", - "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "shortName": "CreateQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.CreateQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*}/phraseSets" + "path": "/v2/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "CreateRecognizer", - "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "shortName": "CreateTask", + "fullName": "google.cloud.tasks.v2.CloudTasks.CreateTask", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*}/recognizers" - } - ] - }, - { - "shortName": "DeleteCustomClass", - "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/customClasses/*}" + "path": "/v2/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "DeletePhraseSet", - "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "shortName": "DeleteQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.DeleteQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/phraseSets/*}" + "path": "/v2/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "DeleteRecognizer", - "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "shortName": "DeleteTask", + "fullName": "google.cloud.tasks.v2.CloudTasks.DeleteTask", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/recognizers/*}" - } - ] - }, - { - "shortName": "GetConfig", - "fullName": "google.cloud.speech.v2.Speech.GetConfig", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/config}" - } - ] - }, - { - "shortName": "GetCustomClass", - "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/customClasses/*}" + "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" } ] }, { - "shortName": "GetPhraseSet", - "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "shortName": "GetIamPolicy", + "fullName": "google.cloud.tasks.v2.CloudTasks.GetIamPolicy", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/phraseSets/*}" + "httpMethod": "POST", + "path": "/v2/{resource=projects/*/locations/*/queues/*}:getIamPolicy" } ] }, { - "shortName": "GetRecognizer", - "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "shortName": "GetQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.GetQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/recognizers/*}" + "path": "/v2/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "ListCustomClasses", - "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "shortName": "GetTask", + "fullName": "google.cloud.tasks.v2.CloudTasks.GetTask", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*}/customClasses" + "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" } ] }, { - "shortName": "ListPhraseSets", - "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "shortName": "ListQueues", + "fullName": "google.cloud.tasks.v2.CloudTasks.ListQueues", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*}/phraseSets" + "path": "/v2/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "ListRecognizers", - "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "shortName": "ListTasks", + "fullName": "google.cloud.tasks.v2.CloudTasks.ListTasks", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*}/recognizers" + "path": "/v2/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "Recognize", - "fullName": "google.cloud.speech.v2.Speech.Recognize", + "shortName": "PauseQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.PauseQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{recognizer=projects/*/locations/*/recognizers/*}:recognize" + "path": "/v2/{name=projects/*/locations/*/queues/*}:pause" } ] }, { - "shortName": "StreamingRecognize", - "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", - "mode": "BIDIRECTIONAL_STREAMING" - }, - { - "shortName": "UndeleteCustomClass", - "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "shortName": "PurgeQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.PurgeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/customClasses/*}:undelete" + "path": "/v2/{name=projects/*/locations/*/queues/*}:purge" } ] }, { - "shortName": "UndeletePhraseSet", - "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "shortName": "ResumeQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.ResumeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/phraseSets/*}:undelete" + "path": "/v2/{name=projects/*/locations/*/queues/*}:resume" } ] }, { - "shortName": "UndeleteRecognizer", - "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "shortName": "RunTask", + "fullName": "google.cloud.tasks.v2.CloudTasks.RunTask", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/recognizers/*}:undelete" - } - ] - }, - { - "shortName": "UpdateConfig", - "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v2/{config.name=projects/*/locations/*/config}" + "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}:run" } ] }, { - "shortName": "UpdateCustomClass", - "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "shortName": "SetIamPolicy", + "fullName": "google.cloud.tasks.v2.CloudTasks.SetIamPolicy", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2/{custom_class.name=projects/*/locations/*/customClasses/*}" + "httpMethod": "POST", + "path": "/v2/{resource=projects/*/locations/*/queues/*}:setIamPolicy" } ] }, { - "shortName": "UpdatePhraseSet", - "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "shortName": "TestIamPermissions", + "fullName": "google.cloud.tasks.v2.CloudTasks.TestIamPermissions", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2/{phrase_set.name=projects/*/locations/*/phraseSets/*}" + "httpMethod": "POST", + "path": "/v2/{resource=projects/*/locations/*/queues/*}:testIamPermissions" } ] }, { - "shortName": "UpdateRecognizer", - "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "shortName": "UpdateQueue", + "fullName": "google.cloud.tasks.v2.CloudTasks.UpdateQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v2/{recognizer.name=projects/*/locations/*/recognizers/*}" + "path": "/v2/{queue.name=projects/*/locations/*/queues/*}" } ] } ] } ], - "configFile": "speech_v2.yaml", + "configFile": "cloudtasks_v2.yaml", "serviceConfigApiNames": [ - "google.cloud.speech.v2.Speech", - "google.longrunning.Operations" - ] + "google.cloud.tasks.v2.CloudTasks" + ], + "nameInServiceConfig": "cloudtasks.googleapis.com" }, { - "id": "google.cloud.sql.v1", - "directory": "google/cloud/sql/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "sqladmin.googleapis.com", - "title": "Cloud SQL Admin API", - "description": "API for Cloud SQL database instance management", + "id": "google.cloud.tasks.v2beta2", + "directory": "google/cloud/tasks/v2beta2", + "version": "v2beta2", + "majorVersion": "v2", + "hostName": "cloudtasks.googleapis.com", + "title": "Cloud Tasks API", + "description": "Manages the execution of large numbers of distributed requests.", "importDirectories": [ "google/api", - "google/cloud/sql/v1", - "google/protobuf" + "google/cloud/tasks/v2beta2", + "google/iam/v1", + "google/protobuf", + "google/rpc" ], "options": { "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/sql/v1;sql": 11 + "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks": 5 } }, "java_multiple_files": { "valueCounts": { - "true": 11 + "true": 5 } }, "java_package": { "valueCounts": { - "com.google.cloud.sql.v1": 11 + "com.google.cloud.tasks.v2beta2": 5 + } + }, + "objc_class_prefix": { + "valueCounts": { + "": 4, + "TASKS": 1 } } }, "services": [ { - "shortName": "SqlBackupRunsService", - "fullName": "google.cloud.sql.v1.SqlBackupRunsService", + "shortName": "CloudTasks", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks", "methods": [ { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Delete", + "shortName": "AcknowledgeTask", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/projects/{project}/instances/{instance}/backupRuns/{id}" + "httpMethod": "POST", + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:acknowledge" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Get", + "shortName": "CancelLease", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CancelLease", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/backupRuns/{id}" + "httpMethod": "POST", + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:cancelLease" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1.SqlBackupRunsService.Insert", + "shortName": "CreateQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CreateQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/backupRuns" + "path": "/v2beta2/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlBackupRunsService.List", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/backupRuns" - } - ] - } - ] - }, - { - "shortName": "SqlConnectService", - "fullName": "google.cloud.sql.v1.SqlConnectService", - "methods": [ - { - "shortName": "GenerateEphemeralCert", - "fullName": "google.cloud.sql.v1.SqlConnectService.GenerateEphemeralCert", + "shortName": "CreateTask", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CreateTask", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}:generateEphemeralCert" + "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "GetConnectSettings", - "fullName": "google.cloud.sql.v1.SqlConnectService.GetConnectSettings", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/connectSettings" - } - ] - } - ] - }, - { - "shortName": "SqlDatabasesService", - "fullName": "google.cloud.sql.v1.SqlDatabasesService", - "methods": [ - { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.Delete", + "shortName": "DeleteQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.Get", + "shortName": "DeleteTask", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.DeleteTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" + "httpMethod": "DELETE", + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.Insert", + "shortName": "GetIamPolicy", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetIamPolicy", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/databases" + "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.List", + "shortName": "GetQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/databases" - } - ] - }, - { - "shortName": "Patch", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.Patch", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "Update", - "fullName": "google.cloud.sql.v1.SqlDatabasesService.Update", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PUT", - "path": "/v1/projects/{project}/instances/{instance}/databases/{database}" - } - ] - } - ] - }, - { - "shortName": "SqlFlagsService", - "fullName": "google.cloud.sql.v1.SqlFlagsService", - "methods": [ - { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlFlagsService.List", + "shortName": "GetTask", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetTask", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/flags" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}" } ] - } - ] - }, - { - "shortName": "SqlInstanceNamesService", - "fullName": "google.cloud.sql.v1.SqlInstanceNamesService" - }, - { - "shortName": "SqlInstancesService", - "fullName": "google.cloud.sql.v1.SqlInstancesService", - "methods": [ + }, { - "shortName": "AddServerCa", - "fullName": "google.cloud.sql.v1.SqlInstancesService.AddServerCa", + "shortName": "LeaseTasks", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/addServerCa" + "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks:lease" } ] }, { - "shortName": "Clone", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Clone", + "shortName": "ListQueues", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ListQueues", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/clone" + "httpMethod": "GET", + "path": "/v2beta2/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "CreateEphemeral", - "fullName": "google.cloud.sql.v1.SqlInstancesService.CreateEphemeral", + "shortName": "ListTasks", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ListTasks", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/createEphemeral" + "httpMethod": "GET", + "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Delete", + "shortName": "PauseQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.PauseQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:pause" } ] }, { - "shortName": "DemoteMaster", - "fullName": "google.cloud.sql.v1.SqlInstancesService.DemoteMaster", + "shortName": "PurgeQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/demoteMaster" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:purge" } ] }, { - "shortName": "Export", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Export", + "shortName": "RenewLease", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.RenewLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/export" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:renewLease" } ] }, { - "shortName": "Failover", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Failover", + "shortName": "ResumeQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/failover" + "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:resume" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Get", + "shortName": "RunTask", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.RunTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:run" } ] }, { - "shortName": "Import", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Import", + "shortName": "SetIamPolicy", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.SetIamPolicy", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/import" + "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Insert", + "shortName": "TestIamPermissions", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.TestIamPermissions", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances" + "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlInstancesService.List", + "shortName": "UpdateQueue", + "fullName": "google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances" + "httpMethod": "PATCH", + "path": "/v2beta2/{queue.name=projects/*/locations/*/queues/*}" } ] - }, + } + ] + } + ], + "configFile": "cloudtasks_v2beta2.yaml", + "serviceConfigApiNames": [ + "google.cloud.tasks.v2beta2.CloudTasks" + ], + "nameInServiceConfig": "cloudtasks.googleapis.com" + }, + { + "id": "google.cloud.tasks.v2beta3", + "directory": "google/cloud/tasks/v2beta3", + "version": "v2beta3", + "majorVersion": "v2", + "hostName": "cloudtasks.googleapis.com", + "title": "Cloud Tasks API", + "description": "Manages the execution of large numbers of distributed requests.", + "importDirectories": [ + "google/api", + "google/cloud/tasks/v2beta3", + "google/iam/v1", + "google/protobuf", + "google/rpc" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks": 4 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 4 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.tasks.v2beta3": 4 + } + }, + "objc_class_prefix": { + "valueCounts": { + "": 3, + "TASKS": 1 + } + } + }, + "services": [ + { + "shortName": "CloudTasks", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks", + "methods": [ { - "shortName": "ListServerCas", - "fullName": "google.cloud.sql.v1.SqlInstancesService.ListServerCas", + "shortName": "CreateQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.CreateQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/listServerCas" + "httpMethod": "POST", + "path": "/v2beta3/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "Patch", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Patch", + "shortName": "CreateTask", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.CreateTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "PromoteReplica", - "fullName": "google.cloud.sql.v1.SqlInstancesService.PromoteReplica", + "shortName": "DeleteQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/promoteReplica" + "httpMethod": "DELETE", + "path": "/v2beta3/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "RescheduleMaintenance", - "fullName": "google.cloud.sql.v1.SqlInstancesService.RescheduleMaintenance", + "shortName": "DeleteTask", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.DeleteTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/rescheduleMaintenance" + "httpMethod": "DELETE", + "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}" } ] }, { - "shortName": "ResetSslConfig", - "fullName": "google.cloud.sql.v1.SqlInstancesService.ResetSslConfig", + "shortName": "GetIamPolicy", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetIamPolicy", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/resetSslConfig" + "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:getIamPolicy" } ] }, { - "shortName": "Restart", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Restart", + "shortName": "GetQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/restart" + "httpMethod": "GET", + "path": "/v2beta3/{name=projects/*/locations/*/queues/*}" } ] }, { - "shortName": "RestoreBackup", - "fullName": "google.cloud.sql.v1.SqlInstancesService.RestoreBackup", + "shortName": "GetTask", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/restoreBackup" + "httpMethod": "GET", + "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}" } ] }, { - "shortName": "RotateServerCa", - "fullName": "google.cloud.sql.v1.SqlInstancesService.RotateServerCa", + "shortName": "ListQueues", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ListQueues", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/rotateServerCa" + "httpMethod": "GET", + "path": "/v2beta3/{parent=projects/*/locations/*}/queues" } ] }, { - "shortName": "StartExternalSync", - "fullName": "google.cloud.sql.v1.SqlInstancesService.StartExternalSync", + "shortName": "ListTasks", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ListTasks", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/startExternalSync" + "httpMethod": "GET", + "path": "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks" } ] }, { - "shortName": "StartReplica", - "fullName": "google.cloud.sql.v1.SqlInstancesService.StartReplica", + "shortName": "PauseQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.PauseQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/startReplica" + "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:pause" } ] }, { - "shortName": "StopReplica", - "fullName": "google.cloud.sql.v1.SqlInstancesService.StopReplica", + "shortName": "PurgeQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/stopReplica" + "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:purge" } ] }, { - "shortName": "TruncateLog", - "fullName": "google.cloud.sql.v1.SqlInstancesService.TruncateLog", + "shortName": "ResumeQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/truncateLog" + "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:resume" } ] }, { - "shortName": "Update", - "fullName": "google.cloud.sql.v1.SqlInstancesService.Update", + "shortName": "RunTask", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.RunTask", "mode": "UNARY", "bindings": [ { - "httpMethod": "PUT", - "path": "/v1/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}:run" } ] }, { - "shortName": "VerifyExternalSyncSettings", - "fullName": "google.cloud.sql.v1.SqlInstancesService.VerifyExternalSyncSettings", + "shortName": "SetIamPolicy", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.SetIamPolicy", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/verifyExternalSyncSettings" + "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:setIamPolicy" } ] - } - ] - }, - { - "shortName": "SqlOperationsService", - "fullName": "google.cloud.sql.v1.SqlOperationsService", - "methods": [ + }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1.SqlOperationsService.Get", + "shortName": "TestIamPermissions", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.TestIamPermissions", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/operations/{operation}" + "httpMethod": "POST", + "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:testIamPermissions" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlOperationsService.List", + "shortName": "UpdateQueue", + "fullName": "google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/operations" + "httpMethod": "PATCH", + "path": "/v2beta3/{queue.name=projects/*/locations/*/queues/*}" } ] } ] + } + ], + "configFile": "cloudtasks_v2beta3.yaml", + "serviceConfigApiNames": [ + "google.cloud.tasks.v2beta3.CloudTasks" + ], + "nameInServiceConfig": "cloudtasks.googleapis.com" + }, + { + "id": "google.cloud.texttospeech.v1", + "directory": "google/cloud/texttospeech/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "texttospeech.googleapis.com", + "title": "Cloud Text-to-Speech API", + "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", + "importDirectories": [ + "google/api", + "google/cloud/texttospeech/v1", + "google/longrunning", + "google/protobuf" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 2 + } }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.TextToSpeech.V1": 2 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/texttospeech/v1;texttospeech": 2 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 2 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.texttospeech.v1": 2 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\TextToSpeech\\V1": 2 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::TextToSpeech::V1": 2 + } + } + }, + "services": [ { - "shortName": "SqlSslCertsService", - "fullName": "google.cloud.sql.v1.SqlSslCertsService", + "shortName": "TextToSpeech", + "fullName": "google.cloud.texttospeech.v1.TextToSpeech", "methods": [ { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1.SqlSslCertsService.Delete", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v1/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" - } - ] - }, - { - "shortName": "Get", - "fullName": "google.cloud.sql.v1.SqlSslCertsService.Get", + "shortName": "ListVoices", + "fullName": "google.cloud.texttospeech.v1.TextToSpeech.ListVoices", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" + "path": "/v1/voices" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1.SqlSslCertsService.Insert", + "shortName": "SynthesizeSpeech", + "fullName": "google.cloud.texttospeech.v1.TextToSpeech.SynthesizeSpeech", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/sslCerts" - } - ] - }, - { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlSslCertsService.List", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/sslCerts" + "path": "/v1/text:synthesize" } ] } ] }, { - "shortName": "SqlTiersService", - "fullName": "google.cloud.sql.v1.SqlTiersService", + "shortName": "TextToSpeechLongAudioSynthesize", + "fullName": "google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize", "methods": [ { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlTiersService.List", + "shortName": "SynthesizeLongAudio", + "fullName": "google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize.SynthesizeLongAudio", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/projects/{project}/tiers" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/voices/*}:SynthesizeLongAudio" } ] } ] + } + ], + "configFile": "texttospeech_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.texttospeech.v1.TextToSpeech", + "google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "texttospeech.googleapis.com" + }, + { + "id": "google.cloud.texttospeech.v1beta1", + "directory": "google/cloud/texttospeech/v1beta1", + "version": "v1beta1", + "majorVersion": "v1", + "hostName": "texttospeech.googleapis.com", + "title": "Cloud Text-to-Speech API", + "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", + "importDirectories": [ + "google/api", + "google/cloud/texttospeech/v1beta1", + "google/longrunning", + "google/protobuf" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 2 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.TextToSpeech.V1Beta1": 2 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/texttospeech/v1beta1;texttospeech": 2 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 2 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.texttospeech.v1beta1": 2 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\TextToSpeech\\V1beta1": 2 + } }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::TextToSpeech::V1beta1": 2 + } + } + }, + "services": [ { - "shortName": "SqlUsersService", - "fullName": "google.cloud.sql.v1.SqlUsersService", + "shortName": "TextToSpeech", + "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech", "methods": [ { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1.SqlUsersService.Delete", + "shortName": "ListVoices", + "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech.ListVoices", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/projects/{project}/instances/{instance}/users" + "httpMethod": "GET", + "path": "/v1beta1/voices" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1.SqlUsersService.Insert", + "shortName": "SynthesizeSpeech", + "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech.SynthesizeSpeech", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/projects/{project}/instances/{instance}/users" - } - ] - }, - { - "shortName": "List", - "fullName": "google.cloud.sql.v1.SqlUsersService.List", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v1/projects/{project}/instances/{instance}/users" + "path": "/v1beta1/text:synthesize" } ] - }, + } + ] + }, + { + "shortName": "TextToSpeechLongAudioSynthesize", + "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize", + "methods": [ { - "shortName": "Update", - "fullName": "google.cloud.sql.v1.SqlUsersService.Update", + "shortName": "SynthesizeLongAudio", + "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize.SynthesizeLongAudio", "mode": "UNARY", "bindings": [ { - "httpMethod": "PUT", - "path": "/v1/projects/{project}/instances/{instance}/users" + "httpMethod": "POST", + "path": "/v1beta1/{parent=projects/*/locations/*/voices/*}:SynthesizeLongAudio" } ] } ] } ], - "configFile": "sqladmin_v1.yaml", + "configFile": "texttospeech_v1beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.sql.v1.SqlBackupRunsService", - "google.cloud.sql.v1.SqlConnectService", - "google.cloud.sql.v1.SqlDatabasesService", - "google.cloud.sql.v1.SqlFlagsService", - "google.cloud.sql.v1.SqlInstanceNamesService", - "google.cloud.sql.v1.SqlInstancesService", - "google.cloud.sql.v1.SqlOperationsService", - "google.cloud.sql.v1.SqlSslCertsService", - "google.cloud.sql.v1.SqlTiersService", - "google.cloud.sql.v1.SqlUsersService" - ] + "google.cloud.texttospeech.v1beta1.TextToSpeech", + "google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "texttospeech.googleapis.com" }, { - "id": "google.cloud.sql.v1beta4", - "directory": "google/cloud/sql/v1beta4", - "version": "v1beta4", + "id": "google.cloud.timeseriesinsights.v1", + "directory": "google/cloud/timeseriesinsights/v1", + "version": "v1", "majorVersion": "v1", - "hostName": "sqladmin.googleapis.com", - "title": "Cloud SQL Admin API", - "description": "API for Cloud SQL database instance management", + "hostName": "timeseriesinsights.googleapis.com", + "title": "Timeseries Insights API", + "description": "Provides a Timeseries Insights service which operates over time series data. Users can perform time series spike, trend, and anomaly detection. With a straightforward API and easy to understand results, the service makes it simple to gather insights from large amounts of time series data (e.g. monitoring datasets) and integrate these insights in their applications.", "importDirectories": [ "google/api", - "google/cloud/sql/v1beta4", - "google/protobuf" + "google/protobuf", + "google/rpc" ], "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 1 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/sql/v1beta4;sql": 5 + "google.golang.org/genproto/googleapis/cloud/timeseriesinsights/v1;timeseriesinsights": 1 } }, "java_multiple_files": { "valueCounts": { - "true": 5 + "true": 1 } }, "java_package": { "valueCounts": { - "com.google.cloud.sql.v1beta4": 5 + "com.google.cloud.timeseriesinsights.v1": 1 } } }, "services": [ { - "shortName": "SqlBackupRunsService", - "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService", + "shortName": "TimeseriesInsightsController", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController", "methods": [ { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Delete", + "shortName": "AppendEvents", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.AppendEvents", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}" + "httpMethod": "POST", + "path": "/v1/{dataset=projects/*/locations/*/datasets/*}:appendEvents" + }, + { + "httpMethod": "POST", + "path": "/v1/{dataset=projects/*/datasets/*}:appendEvents" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Get", + "shortName": "CreateDataSet", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.CreateDataSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/datasets" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/datasets" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.Insert", + "shortName": "DeleteDataSet", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.DeleteDataSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/datasets/*}" + }, + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/datasets/*}" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlBackupRunsService.List", + "shortName": "EvaluateSlice", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.EvaluateSlice", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns" + "httpMethod": "POST", + "path": "/v1/{dataset=projects/*/locations/*/datasets/*}:evaluateSlice" + }, + { + "httpMethod": "POST", + "path": "/v1/{dataset=projects/*/datasets/*}:evaluateSlice" } ] - } - ] - }, - { - "shortName": "SqlConnectService", - "fullName": "google.cloud.sql.v1beta4.SqlConnectService", - "methods": [ + }, { - "shortName": "GenerateEphemeralCert", - "fullName": "google.cloud.sql.v1beta4.SqlConnectService.GenerateEphemeralCert", + "shortName": "EvaluateTimeseries", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.EvaluateTimeseries", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}:generateEphemeralCert" + "path": "/v1/{parent=projects/*/locations/*}/datasets:evaluateTimeseries" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/datasets:evaluateTimeseries" } ] }, { - "shortName": "GetConnectSettings", - "fullName": "google.cloud.sql.v1beta4.SqlConnectService.GetConnectSettings", + "shortName": "ListDataSets", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.ListDataSets", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/connectSettings" + "path": "/v1/{parent=projects/*/locations/*}/datasets" + }, + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*}/datasets" } ] - } - ] - }, - { - "shortName": "SqlDatabasesService", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService", - "methods": [ + }, { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Delete", + "shortName": "QueryDataSet", + "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.QueryDataSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/datasets/*}:query" + }, + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/datasets/*}:query" } ] - }, + } + ] + } + ], + "configFile": "timeseriesinsights_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController" + ], + "nameInServiceConfig": "timeseriesinsights.googleapis.com" + }, + { + "id": "google.cloud.tpu.v1", + "directory": "google/cloud/tpu/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "tpu.googleapis.com", + "title": "Cloud TPU API", + "description": "TPU API provides customers with access to Google TPU technology.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/tpu/v1;tpu": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.tpu.v1": 1 + } + } + }, + "services": [ + { + "shortName": "Tpu", + "fullName": "google.cloud.tpu.v1.Tpu", + "methods": [ { - "shortName": "Get", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Get", + "shortName": "CreateNode", + "fullName": "google.cloud.tpu.v1.Tpu.CreateNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Insert", + "shortName": "DeleteNode", + "fullName": "google.cloud.tpu.v1.Tpu.DeleteNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.List", + "shortName": "GetAcceleratorType", + "fullName": "google.cloud.tpu.v1.Tpu.GetAcceleratorType", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases" + "path": "/v1/{name=projects/*/locations/*/acceleratorTypes/*}" } ] }, { - "shortName": "Patch", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Patch", + "shortName": "GetNode", + "fullName": "google.cloud.tpu.v1.Tpu.GetNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "Update", - "fullName": "google.cloud.sql.v1beta4.SqlDatabasesService.Update", + "shortName": "GetTensorFlowVersion", + "fullName": "google.cloud.tpu.v1.Tpu.GetTensorFlowVersion", "mode": "UNARY", "bindings": [ - { - "httpMethod": "PUT", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}" + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/tensorflowVersions/*}" } ] - } - ] - }, - { - "shortName": "SqlFlagsService", - "fullName": "google.cloud.sql.v1beta4.SqlFlagsService", - "methods": [ + }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlFlagsService.List", + "shortName": "ListAcceleratorTypes", + "fullName": "google.cloud.tpu.v1.Tpu.ListAcceleratorTypes", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/flags" + "path": "/v1/{parent=projects/*/locations/*}/acceleratorTypes" } ] - } - ] - }, - { - "shortName": "SqlInstancesService", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService", - "methods": [ + }, { - "shortName": "AddServerCa", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.AddServerCa", + "shortName": "ListNodes", + "fullName": "google.cloud.tpu.v1.Tpu.ListNodes", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/addServerCa" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "Clone", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Clone", + "shortName": "ListTensorFlowVersions", + "fullName": "google.cloud.tpu.v1.Tpu.ListTensorFlowVersions", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/clone" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/tensorflowVersions" } ] }, { - "shortName": "CreateEphemeral", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.CreateEphemeral", + "shortName": "ReimageNode", + "fullName": "google.cloud.tpu.v1.Tpu.ReimageNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral" + "path": "/v1/{name=projects/*/locations/*/nodes/*}:reimage" } ] }, { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Delete", + "shortName": "StartNode", + "fullName": "google.cloud.tpu.v1.Tpu.StartNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/nodes/*}:start" } ] }, { - "shortName": "DemoteMaster", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.DemoteMaster", + "shortName": "StopNode", + "fullName": "google.cloud.tpu.v1.Tpu.StopNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster" + "path": "/v1/{name=projects/*/locations/*/nodes/*}:stop" } ] - }, + } + ] + } + ], + "configFile": "tpu_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.tpu.v1.Tpu", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "tpu.googleapis.com" + }, + { + "id": "google.cloud.tpu.v2", + "directory": "google/cloud/tpu/v2", + "version": "v2", + "majorVersion": "v2", + "hostName": "tpu.googleapis.com", + "title": "Cloud TPU API", + "description": "TPU API provides customers with access to Google TPU technology.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/tpu/v2;tpu": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.tpu.v2": 1 + } + } + }, + "services": [ + { + "shortName": "Tpu", + "fullName": "google.cloud.tpu.v2.Tpu", + "methods": [ { - "shortName": "Export", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Export", + "shortName": "CreateNode", + "fullName": "google.cloud.tpu.v2.Tpu.CreateNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/export" + "path": "/v2/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "Failover", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Failover", + "shortName": "DeleteNode", + "fullName": "google.cloud.tpu.v2.Tpu.DeleteNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/failover" + "httpMethod": "DELETE", + "path": "/v2/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Get", + "shortName": "GenerateServiceIdentity", + "fullName": "google.cloud.tpu.v2.Tpu.GenerateServiceIdentity", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}" + "httpMethod": "POST", + "path": "/v2/{parent=projects/*/locations/*}:generateServiceIdentity" } ] }, { - "shortName": "Import", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Import", + "shortName": "GetAcceleratorType", + "fullName": "google.cloud.tpu.v2.Tpu.GetAcceleratorType", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/import" + "httpMethod": "GET", + "path": "/v2/{name=projects/*/locations/*/acceleratorTypes/*}" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Insert", + "shortName": "GetGuestAttributes", + "fullName": "google.cloud.tpu.v2.Tpu.GetGuestAttributes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances" + "path": "/v2/{name=projects/*/locations/*/nodes/*}:getGuestAttributes" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.List", + "shortName": "GetNode", + "fullName": "google.cloud.tpu.v2.Tpu.GetNode", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances" + "path": "/v2/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "ListServerCas", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.ListServerCas", + "shortName": "GetRuntimeVersion", + "fullName": "google.cloud.tpu.v2.Tpu.GetRuntimeVersion", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/listServerCas" + "path": "/v2/{name=projects/*/locations/*/runtimeVersions/*}" } ] }, { - "shortName": "Patch", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Patch", + "shortName": "ListAcceleratorTypes", + "fullName": "google.cloud.tpu.v2.Tpu.ListAcceleratorTypes", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}" + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/acceleratorTypes" } ] }, { - "shortName": "PromoteReplica", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.PromoteReplica", + "shortName": "ListNodes", + "fullName": "google.cloud.tpu.v2.Tpu.ListNodes", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica" + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "RescheduleMaintenance", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RescheduleMaintenance", + "shortName": "ListRuntimeVersions", + "fullName": "google.cloud.tpu.v2.Tpu.ListRuntimeVersions", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance" + "httpMethod": "GET", + "path": "/v2/{parent=projects/*/locations/*}/runtimeVersions" } ] }, { - "shortName": "ResetSslConfig", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.ResetSslConfig", + "shortName": "StartNode", + "fullName": "google.cloud.tpu.v2.Tpu.StartNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig" + "path": "/v2/{name=projects/*/locations/*/nodes/*}:start" } ] }, { - "shortName": "Restart", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Restart", + "shortName": "StopNode", + "fullName": "google.cloud.tpu.v2.Tpu.StopNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/restart" + "path": "/v2/{name=projects/*/locations/*/nodes/*}:stop" } ] }, { - "shortName": "RestoreBackup", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RestoreBackup", + "shortName": "UpdateNode", + "fullName": "google.cloud.tpu.v2.Tpu.UpdateNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup" + "httpMethod": "PATCH", + "path": "/v2/{node.name=projects/*/locations/*/nodes/*}" } ] - }, + } + ] + } + ], + "configFile": "tpu_v2.yaml", + "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.tpu.v2.Tpu", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "tpu.googleapis.com" + }, + { + "id": "google.cloud.tpu.v2alpha1", + "directory": "google/cloud/tpu/v2alpha1", + "version": "v2alpha1", + "majorVersion": "v2", + "hostName": "tpu.googleapis.com", + "title": "Cloud TPU API", + "description": "TPU API provides customers with access to Google TPU technology.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf", + "google/rpc", + "google/type" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/tpu/v2alpha1;tpu": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.tpu.v2alpha1": 1 + } + } + }, + "services": [ + { + "shortName": "Tpu", + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "methods": [ { - "shortName": "RotateServerCa", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.RotateServerCa", + "shortName": "CreateNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa" + "path": "/v2alpha1/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "StartExternalSync", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StartExternalSync", + "shortName": "CreateQueuedResource", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync" + "path": "/v2alpha1/{parent=projects/*/locations/*}/queuedResources" } ] }, { - "shortName": "StartReplica", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StartReplica", + "shortName": "DeleteNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/startReplica" + "httpMethod": "DELETE", + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "StopReplica", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.StopReplica", + "shortName": "DeleteQueuedResource", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/stopReplica" + "httpMethod": "DELETE", + "path": "/v2alpha1/{name=projects/*/locations/*/queuedResources/*}" } ] }, { - "shortName": "TruncateLog", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.TruncateLog", + "shortName": "GenerateServiceIdentity", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/truncateLog" + "path": "/v2alpha1/{parent=projects/*/locations/*}:generateServiceIdentity" } ] }, { - "shortName": "Update", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.Update", + "shortName": "GetAcceleratorType", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType", "mode": "UNARY", "bindings": [ { - "httpMethod": "PUT", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}" + "httpMethod": "GET", + "path": "/v2alpha1/{name=projects/*/locations/*/acceleratorTypes/*}" } ] }, { - "shortName": "VerifyExternalSyncSettings", - "fullName": "google.cloud.sql.v1beta4.SqlInstancesService.VerifyExternalSyncSettings", + "shortName": "GetGuestAttributes", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings" + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:getGuestAttributes" } ] - } - ] - }, - { - "shortName": "SqlOperationsService", - "fullName": "google.cloud.sql.v1beta4.SqlOperationsService", - "methods": [ + }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1beta4.SqlOperationsService.Get", + "shortName": "GetNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetNode", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/operations/{operation}" + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlOperationsService.List", + "shortName": "GetQueuedResource", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/operations" + "path": "/v2alpha1/{name=projects/*/locations/*/queuedResources/*}" } ] - } - ] - }, - { - "shortName": "SqlSslCertsService", - "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService", - "methods": [ + }, { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Delete", + "shortName": "GetRuntimeVersion", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" + "httpMethod": "GET", + "path": "/v2alpha1/{name=projects/*/locations/*/runtimeVersions/*}" } ] }, { - "shortName": "Get", - "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Get", + "shortName": "ListAcceleratorTypes", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1_fingerprint}" + "path": "/v2alpha1/{parent=projects/*/locations/*}/acceleratorTypes" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.Insert", + "shortName": "ListNodes", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListNodes", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts" + "httpMethod": "GET", + "path": "/v2alpha1/{parent=projects/*/locations/*}/nodes" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlSslCertsService.List", + "shortName": "ListQueuedResources", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/sslCerts" + "path": "/v2alpha1/{parent=projects/*/locations/*}/queuedResources" } ] - } - ] - }, - { - "shortName": "SqlTiersService", - "fullName": "google.cloud.sql.v1beta4.SqlTiersService", - "methods": [ + }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlTiersService.List", + "shortName": "ListRuntimeVersions", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/tiers" + "path": "/v2alpha1/{parent=projects/*/locations/*}/runtimeVersions" } ] - } - ] - }, - { - "shortName": "SqlUsersService", - "fullName": "google.cloud.sql.v1beta4.SqlUsersService", - "methods": [ + }, { - "shortName": "Delete", - "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Delete", + "shortName": "SimulateMaintenanceEvent", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" + "httpMethod": "POST", + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:simulateMaintenanceEvent" } ] }, { - "shortName": "Insert", - "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Insert", + "shortName": "StartNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StartNode", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:start" } ] }, { - "shortName": "List", - "fullName": "google.cloud.sql.v1beta4.SqlUsersService.List", + "shortName": "StopNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StopNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" + "httpMethod": "POST", + "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:stop" } ] }, { - "shortName": "Update", - "fullName": "google.cloud.sql.v1beta4.SqlUsersService.Update", + "shortName": "UpdateNode", + "fullName": "google.cloud.tpu.v2alpha1.Tpu.UpdateNode", "mode": "UNARY", "bindings": [ { - "httpMethod": "PUT", - "path": "/sql/v1beta4/projects/{project}/instances/{instance}/users" + "httpMethod": "PATCH", + "path": "/v2alpha1/{node.name=projects/*/locations/*/nodes/*}" } ] } ] } ], - "configFile": "sqladmin_v1beta4.yaml", + "configFile": "tpu_v2alpha1.yaml", "serviceConfigApiNames": [ - "google.cloud.sql.v1beta4.SqlBackupRunsService", - "google.cloud.sql.v1beta4.SqlConnectService", - "google.cloud.sql.v1beta4.SqlDatabasesService", - "google.cloud.sql.v1beta4.SqlFlagsService", - "google.cloud.sql.v1beta4.SqlInstancesService", - "google.cloud.sql.v1beta4.SqlOperationsService", - "google.cloud.sql.v1beta4.SqlSslCertsService", - "google.cloud.sql.v1beta4.SqlTiersService", - "google.cloud.sql.v1beta4.SqlUsersService" - ] + "google.cloud.location.Locations", + "google.cloud.tpu.v2alpha1.Tpu", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "tpu.googleapis.com" }, { - "id": "google.cloud.talent.v4", - "directory": "google/cloud/talent/v4", - "version": "v4", - "majorVersion": "v4", - "hostName": "jobs.googleapis.com", - "title": "Cloud Talent Solution API", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", + "id": "google.cloud.translate.v3", + "directory": "google/cloud/translate/v3", + "version": "v3", + "majorVersion": "v3", + "hostName": "translate.googleapis.com", + "title": "Cloud Translation API", + "description": "Integrates text translation into your website or application.", "importDirectories": [ "google/api", - "google/cloud/talent/v4", "google/longrunning", - "google/protobuf", - "google/rpc", - "google/type" + "google/protobuf" ], "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 1 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.Translate.V3": 1 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/talent/v4;talent": 12 + "google.golang.org/genproto/googleapis/cloud/translate/v3;translate": 1 } }, "java_multiple_files": { "valueCounts": { - "true": 12 + "true": 1 } }, "java_package": { "valueCounts": { - "com.google.cloud.talent.v4": 12 + "com.google.cloud.translate.v3": 1 } }, - "objc_class_prefix": { + "php_namespace": { "valueCounts": { - "CTS": 12 + "Google\\Cloud\\Translate\\V3": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::Translate::V3": 1 } } }, "services": [ - { - "shortName": "CompanyService", - "fullName": "google.cloud.talent.v4.CompanyService", - "methods": [ - { - "shortName": "CreateCompany", - "fullName": "google.cloud.talent.v4.CompanyService.CreateCompany", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/companies" - } - ] - }, - { - "shortName": "DeleteCompany", - "fullName": "google.cloud.talent.v4.CompanyService.DeleteCompany", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "DELETE", - "path": "/v4/{name=projects/*/tenants/*/companies/*}" - } - ] - }, - { - "shortName": "GetCompany", - "fullName": "google.cloud.talent.v4.CompanyService.GetCompany", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v4/{name=projects/*/tenants/*/companies/*}" - } - ] - }, - { - "shortName": "ListCompanies", - "fullName": "google.cloud.talent.v4.CompanyService.ListCompanies", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v4/{parent=projects/*/tenants/*}/companies" - } - ] - }, - { - "shortName": "UpdateCompany", - "fullName": "google.cloud.talent.v4.CompanyService.UpdateCompany", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "PATCH", - "path": "/v4/{company.name=projects/*/tenants/*/companies/*}" - } - ] - } - ] - }, - { - "shortName": "Completion", - "fullName": "google.cloud.talent.v4.Completion", - "methods": [ - { - "shortName": "CompleteQuery", - "fullName": "google.cloud.talent.v4.Completion.CompleteQuery", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "GET", - "path": "/v4/{tenant=projects/*/tenants/*}:completeQuery" - } - ] - } - ] - }, - { - "shortName": "EventService", - "fullName": "google.cloud.talent.v4.EventService", - "methods": [ - { - "shortName": "CreateClientEvent", - "fullName": "google.cloud.talent.v4.EventService.CreateClientEvent", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/clientEvents" - } - ] - } - ] - }, - { - "shortName": "JobService", - "fullName": "google.cloud.talent.v4.JobService", + { + "shortName": "TranslationService", + "fullName": "google.cloud.translation.v3.TranslationService", "methods": [ { - "shortName": "BatchCreateJobs", - "fullName": "google.cloud.talent.v4.JobService.BatchCreateJobs", + "shortName": "BatchTranslateDocument", + "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateDocument", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchCreate" + "path": "/v3/{parent=projects/*/locations/*}:batchTranslateDocument" } ] }, { - "shortName": "BatchDeleteJobs", - "fullName": "google.cloud.talent.v4.JobService.BatchDeleteJobs", + "shortName": "BatchTranslateText", + "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateText", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchDelete" + "path": "/v3/{parent=projects/*/locations/*}:batchTranslateText" } ] }, { - "shortName": "BatchUpdateJobs", - "fullName": "google.cloud.talent.v4.JobService.BatchUpdateJobs", + "shortName": "CreateGlossary", + "fullName": "google.cloud.translation.v3.TranslationService.CreateGlossary", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs:batchUpdate" + "path": "/v3/{parent=projects/*/locations/*}/glossaries" } ] }, { - "shortName": "CreateJob", - "fullName": "google.cloud.talent.v4.JobService.CreateJob", + "shortName": "DeleteGlossary", + "fullName": "google.cloud.translation.v3.TranslationService.DeleteGlossary", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs" + "httpMethod": "DELETE", + "path": "/v3/{name=projects/*/locations/*/glossaries/*}" } ] }, { - "shortName": "DeleteJob", - "fullName": "google.cloud.talent.v4.JobService.DeleteJob", + "shortName": "DetectLanguage", + "fullName": "google.cloud.translation.v3.TranslationService.DetectLanguage", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v4/{name=projects/*/tenants/*/jobs/*}" + "httpMethod": "POST", + "path": "/v3/{parent=projects/*/locations/*}:detectLanguage" + }, + { + "httpMethod": "POST", + "path": "/v3/{parent=projects/*}:detectLanguage" } ] }, { - "shortName": "GetJob", - "fullName": "google.cloud.talent.v4.JobService.GetJob", + "shortName": "GetGlossary", + "fullName": "google.cloud.translation.v3.TranslationService.GetGlossary", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4/{name=projects/*/tenants/*/jobs/*}" + "path": "/v3/{name=projects/*/locations/*/glossaries/*}" } ] }, { - "shortName": "ListJobs", - "fullName": "google.cloud.talent.v4.JobService.ListJobs", + "shortName": "GetSupportedLanguages", + "fullName": "google.cloud.translation.v3.TranslationService.GetSupportedLanguages", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4/{parent=projects/*/tenants/*}/jobs" + "path": "/v3/{parent=projects/*/locations/*}/supportedLanguages" + }, + { + "httpMethod": "GET", + "path": "/v3/{parent=projects/*}/supportedLanguages" } ] }, { - "shortName": "SearchJobs", - "fullName": "google.cloud.talent.v4.JobService.SearchJobs", + "shortName": "ListGlossaries", + "fullName": "google.cloud.translation.v3.TranslationService.ListGlossaries", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs:search" + "httpMethod": "GET", + "path": "/v3/{parent=projects/*/locations/*}/glossaries" } ] }, { - "shortName": "SearchJobsForAlert", - "fullName": "google.cloud.talent.v4.JobService.SearchJobsForAlert", + "shortName": "TranslateDocument", + "fullName": "google.cloud.translation.v3.TranslationService.TranslateDocument", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4/{parent=projects/*/tenants/*}/jobs:searchForAlert" + "path": "/v3/{parent=projects/*/locations/*}:translateDocument" } ] }, { - "shortName": "UpdateJob", - "fullName": "google.cloud.talent.v4.JobService.UpdateJob", + "shortName": "TranslateText", + "fullName": "google.cloud.translation.v3.TranslationService.TranslateText", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v4/{job.name=projects/*/tenants/*/jobs/*}" + "httpMethod": "POST", + "path": "/v3/{parent=projects/*/locations/*}:translateText" + }, + { + "httpMethod": "POST", + "path": "/v3/{parent=projects/*}:translateText" } ] } ] + } + ], + "configFile": "translate_v3.yaml", + "serviceConfigApiNames": [ + "google.cloud.translation.v3.TranslationService" + ], + "nameInServiceConfig": "translate.googleapis.com" + }, + { + "id": "google.cloud.translate.v3beta1", + "directory": "google/cloud/translate/v3beta1", + "version": "v3beta1", + "majorVersion": "v3", + "hostName": "translate.googleapis.com", + "title": "Cloud Translation API", + "description": "Integrates text translation into your website or application.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 1 + } + }, + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.Translate.V3Beta1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/translate/v3beta1;translate": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.translate.v3beta1": 1 + } }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\Translate\\V3beta1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::Translate::V3beta1": 1 + } + } + }, + "services": [ { - "shortName": "TenantService", - "fullName": "google.cloud.talent.v4.TenantService", + "shortName": "TranslationService", + "fullName": "google.cloud.translation.v3beta1.TranslationService", "methods": [ { - "shortName": "CreateTenant", - "fullName": "google.cloud.talent.v4.TenantService.CreateTenant", + "shortName": "BatchTranslateDocument", + "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateDocument", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4/{parent=projects/*}/tenants" + "path": "/v3beta1/{parent=projects/*/locations/*}:batchTranslateDocument" } ] }, { - "shortName": "DeleteTenant", - "fullName": "google.cloud.talent.v4.TenantService.DeleteTenant", + "shortName": "BatchTranslateText", + "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateText", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*/locations/*}:batchTranslateText" + } + ] + }, + { + "shortName": "CreateGlossary", + "fullName": "google.cloud.translation.v3beta1.TranslationService.CreateGlossary", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*/locations/*}/glossaries" + } + ] + }, + { + "shortName": "DeleteGlossary", + "fullName": "google.cloud.translation.v3beta1.TranslationService.DeleteGlossary", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v4/{name=projects/*/tenants/*}" + "path": "/v3beta1/{name=projects/*/locations/*/glossaries/*}" } ] }, { - "shortName": "GetTenant", - "fullName": "google.cloud.talent.v4.TenantService.GetTenant", + "shortName": "DetectLanguage", + "fullName": "google.cloud.translation.v3beta1.TranslationService.DetectLanguage", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*/locations/*}:detectLanguage" + }, + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*}:detectLanguage" + } + ] + }, + { + "shortName": "GetGlossary", + "fullName": "google.cloud.translation.v3beta1.TranslationService.GetGlossary", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4/{name=projects/*/tenants/*}" + "path": "/v3beta1/{name=projects/*/locations/*/glossaries/*}" } ] }, { - "shortName": "ListTenants", - "fullName": "google.cloud.talent.v4.TenantService.ListTenants", + "shortName": "GetSupportedLanguages", + "fullName": "google.cloud.translation.v3beta1.TranslationService.GetSupportedLanguages", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4/{parent=projects/*}/tenants" + "path": "/v3beta1/{parent=projects/*/locations/*}/supportedLanguages" + }, + { + "httpMethod": "GET", + "path": "/v3beta1/{parent=projects/*}/supportedLanguages" } ] }, { - "shortName": "UpdateTenant", - "fullName": "google.cloud.talent.v4.TenantService.UpdateTenant", + "shortName": "ListGlossaries", + "fullName": "google.cloud.translation.v3beta1.TranslationService.ListGlossaries", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v4/{tenant.name=projects/*/tenants/*}" + "httpMethod": "GET", + "path": "/v3beta1/{parent=projects/*/locations/*}/glossaries" + } + ] + }, + { + "shortName": "TranslateDocument", + "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateDocument", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*/locations/*}:translateDocument" + } + ] + }, + { + "shortName": "TranslateText", + "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateText", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*/locations/*}:translateText" + }, + { + "httpMethod": "POST", + "path": "/v3beta1/{parent=projects/*}:translateText" } ] } ] } ], - "configFile": "jobs_v4.yaml", + "configFile": "translate_v3beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.talent.v4.CompanyService", - "google.cloud.talent.v4.Completion", - "google.cloud.talent.v4.EventService", - "google.cloud.talent.v4.JobService", - "google.cloud.talent.v4.TenantService", - "google.longrunning.Operations" - ] + "google.cloud.translation.v3beta1.TranslationService" + ], + "nameInServiceConfig": "translate.googleapis.com" }, { - "id": "google.cloud.talent.v4beta1", - "directory": "google/cloud/talent/v4beta1", - "version": "v4beta1", - "majorVersion": "v4", - "hostName": "jobs.googleapis.com", - "title": "Cloud Talent Solution API", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", + "id": "google.cloud.video.livestream.v1", + "directory": "google/cloud/video/livestream/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "livestream.googleapis.com", + "title": "Live Stream API", + "description": "", "importDirectories": [ "google/api", - "google/cloud/talent/v4beta1", + "google/cloud/video/livestream/v1", "google/longrunning", "google/protobuf", - "google/rpc", - "google/type" + "google/rpc" ], "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.Video.LiveStream.V1": 3 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent": 13 + "google.golang.org/genproto/googleapis/cloud/video/livestream/v1;livestream": 3 } }, "java_multiple_files": { "valueCounts": { - "true": 13 + "true": 3 } }, "java_package": { "valueCounts": { - "com.google.cloud.talent.v4beta1": 13 + "com.google.cloud.video.livestream.v1": 3 } }, - "objc_class_prefix": { + "php_namespace": { "valueCounts": { - "CTS": 13 + "Google\\Cloud\\Video\\LiveStream\\V1": 3 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::Video::LiveStream::V1": 3 } } }, "services": [ { - "shortName": "CompanyService", - "fullName": "google.cloud.talent.v4beta1.CompanyService", + "shortName": "LivestreamService", + "fullName": "google.cloud.video.livestream.v1.LivestreamService", "methods": [ { - "shortName": "CreateCompany", - "fullName": "google.cloud.talent.v4beta1.CompanyService.CreateCompany", + "shortName": "CreateChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateChannel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/companies" - }, + "path": "/v1/{parent=projects/*/locations/*}/channels" + } + ] + }, + { + "shortName": "CreateEvent", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateEvent", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/companies" + "path": "/v1/{parent=projects/*/locations/*/channels/*}/events" } ] }, { - "shortName": "DeleteCompany", - "fullName": "google.cloud.talent.v4beta1.CompanyService.DeleteCompany", + "shortName": "CreateInput", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateInput", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/inputs" + } + ] + }, + { + "shortName": "DeleteChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteChannel", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v4beta1/{name=projects/*/tenants/*/companies/*}" - }, + "path": "/v1/{name=projects/*/locations/*/channels/*}" + } + ] + }, + { + "shortName": "DeleteEvent", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteEvent", + "mode": "UNARY", + "bindings": [ { "httpMethod": "DELETE", - "path": "/v4beta1/{name=projects/*/companies/*}" + "path": "/v1/{name=projects/*/locations/*/channels/*/events/*}" } ] }, { - "shortName": "GetCompany", - "fullName": "google.cloud.talent.v4beta1.CompanyService.GetCompany", + "shortName": "DeleteInput", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteInput", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v4beta1/{name=projects/*/tenants/*/companies/*}" - }, + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/inputs/*}" + } + ] + }, + { + "shortName": "GetChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetChannel", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{name=projects/*/companies/*}" + "path": "/v1/{name=projects/*/locations/*/channels/*}" } ] }, { - "shortName": "ListCompanies", - "fullName": "google.cloud.talent.v4beta1.CompanyService.ListCompanies", + "shortName": "GetEvent", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*/tenants/*}/companies" - }, + "path": "/v1/{name=projects/*/locations/*/channels/*/events/*}" + } + ] + }, + { + "shortName": "GetInput", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetInput", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*}/companies" + "path": "/v1/{name=projects/*/locations/*/inputs/*}" } ] }, { - "shortName": "UpdateCompany", - "fullName": "google.cloud.talent.v4beta1.CompanyService.UpdateCompany", + "shortName": "ListChannels", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListChannels", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v4beta1/{company.name=projects/*/tenants/*/companies/*}" - }, - { - "httpMethod": "PATCH", - "path": "/v4beta1/{company.name=projects/*/companies/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/channels" } ] - } - ] - }, - { - "shortName": "Completion", - "fullName": "google.cloud.talent.v4beta1.Completion", - "methods": [ + }, { - "shortName": "CompleteQuery", - "fullName": "google.cloud.talent.v4beta1.Completion.CompleteQuery", + "shortName": "ListEvents", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*/tenants/*}:complete" - }, + "path": "/v1/{parent=projects/*/locations/*/channels/*}/events" + } + ] + }, + { + "shortName": "ListInputs", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListInputs", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*}:complete" + "path": "/v1/{parent=projects/*/locations/*}/inputs" } ] - } - ] - }, - { - "shortName": "EventService", - "fullName": "google.cloud.talent.v4beta1.EventService", - "methods": [ + }, { - "shortName": "CreateClientEvent", - "fullName": "google.cloud.talent.v4beta1.EventService.CreateClientEvent", + "shortName": "StartChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.StartChannel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/clientEvents" - }, + "path": "/v1/{name=projects/*/locations/*/channels/*}:start" + } + ] + }, + { + "shortName": "StopChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.StopChannel", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/clientEvents" + "path": "/v1/{name=projects/*/locations/*/channels/*}:stop" + } + ] + }, + { + "shortName": "UpdateChannel", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.UpdateChannel", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{channel.name=projects/*/locations/*/channels/*}" + } + ] + }, + { + "shortName": "UpdateInput", + "fullName": "google.cloud.video.livestream.v1.LivestreamService.UpdateInput", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{input.name=projects/*/locations/*/inputs/*}" } ] } ] + } + ], + "configFile": "livestream_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.video.livestream.v1.LivestreamService" + ], + "nameInServiceConfig": "livestream.googleapis.com" + }, + { + "id": "google.cloud.video.stitcher.v1", + "directory": "google/cloud/video/stitcher/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "videostitcher.googleapis.com", + "title": "Video Stitcher API", + "description": "", + "importDirectories": [ + "google/api", + "google/cloud/video/stitcher/v1", + "google/protobuf" + ], + "options": { + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/video/stitcher/v1;stitcher": 8 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 8 + } }, + "java_package": { + "valueCounts": { + "com.google.cloud.video.stitcher.v1": 8 + } + } + }, + "services": [ { - "shortName": "JobService", - "fullName": "google.cloud.talent.v4beta1.JobService", + "shortName": "VideoStitcherService", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService", "methods": [ { - "shortName": "BatchCreateJobs", - "fullName": "google.cloud.talent.v4beta1.JobService.BatchCreateJobs", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchCreate" - }, + "shortName": "CreateCdnKey", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateCdnKey", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs:batchCreate" + "path": "/v1/{parent=projects/*/locations/*}/cdnKeys" } ] }, { - "shortName": "BatchDeleteJobs", - "fullName": "google.cloud.talent.v4beta1.JobService.BatchDeleteJobs", + "shortName": "CreateLiveSession", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateLiveSession", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchDelete" - }, - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs:batchDelete" + "path": "/v1/{parent=projects/*/locations/*}/liveSessions" } ] }, { - "shortName": "BatchUpdateJobs", - "fullName": "google.cloud.talent.v4beta1.JobService.BatchUpdateJobs", + "shortName": "CreateSlate", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateSlate", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:batchUpdate" - }, - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs:batchUpdate" + "path": "/v1/{parent=projects/*/locations/*}/slates" } ] }, { - "shortName": "CreateJob", - "fullName": "google.cloud.talent.v4beta1.JobService.CreateJob", + "shortName": "CreateVodSession", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateVodSession", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs" - }, - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs" + "path": "/v1/{parent=projects/*/locations/*}/vodSessions" } ] }, { - "shortName": "DeleteJob", - "fullName": "google.cloud.talent.v4beta1.JobService.DeleteJob", + "shortName": "DeleteCdnKey", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.DeleteCdnKey", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v4beta1/{name=projects/*/tenants/*/jobs/*}" - }, + "path": "/v1/{name=projects/*/locations/*/cdnKeys/*}" + } + ] + }, + { + "shortName": "DeleteSlate", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.DeleteSlate", + "mode": "UNARY", + "bindings": [ { "httpMethod": "DELETE", - "path": "/v4beta1/{name=projects/*/jobs/*}" + "path": "/v1/{name=projects/*/locations/*/slates/*}" } ] }, { - "shortName": "GetJob", - "fullName": "google.cloud.talent.v4beta1.JobService.GetJob", + "shortName": "GetCdnKey", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetCdnKey", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{name=projects/*/tenants/*/jobs/*}" - }, + "path": "/v1/{name=projects/*/locations/*/cdnKeys/*}" + } + ] + }, + { + "shortName": "GetLiveAdTagDetail", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetLiveAdTagDetail", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{name=projects/*/jobs/*}" + "path": "/v1/{name=projects/*/locations/*/liveSessions/*/liveAdTagDetails/*}" } ] }, { - "shortName": "ListJobs", - "fullName": "google.cloud.talent.v4beta1.JobService.ListJobs", + "shortName": "GetLiveSession", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetLiveSession", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs" - }, + "path": "/v1/{name=projects/*/locations/*/liveSessions/*}" + } + ] + }, + { + "shortName": "GetSlate", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetSlate", + "mode": "UNARY", + "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*}/jobs" + "path": "/v1/{name=projects/*/locations/*/slates/*}" } ] }, { - "shortName": "SearchJobs", - "fullName": "google.cloud.talent.v4beta1.JobService.SearchJobs", + "shortName": "GetVodAdTagDetail", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodAdTagDetail", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:search" - }, - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs:search" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/vodSessions/*/vodAdTagDetails/*}" } ] }, { - "shortName": "SearchJobsForAlert", - "fullName": "google.cloud.talent.v4beta1.JobService.SearchJobsForAlert", + "shortName": "GetVodSession", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodSession", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*/tenants/*}/jobs:searchForAlert" - }, - { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/jobs:searchForAlert" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/vodSessions/*}" } ] }, { - "shortName": "UpdateJob", - "fullName": "google.cloud.talent.v4beta1.JobService.UpdateJob", + "shortName": "GetVodStitchDetail", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodStitchDetail", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v4beta1/{job.name=projects/*/tenants/*/jobs/*}" - }, + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/vodSessions/*/vodStitchDetails/*}" + } + ] + }, + { + "shortName": "ListCdnKeys", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListCdnKeys", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "PATCH", - "path": "/v4beta1/{job.name=projects/*/jobs/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/cdnKeys" } ] - } - ] - }, - { - "shortName": "TenantService", - "fullName": "google.cloud.talent.v4beta1.TenantService", - "methods": [ + }, { - "shortName": "CreateTenant", - "fullName": "google.cloud.talent.v4beta1.TenantService.CreateTenant", + "shortName": "ListLiveAdTagDetails", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListLiveAdTagDetails", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v4beta1/{parent=projects/*}/tenants" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/liveSessions/*}/liveAdTagDetails" } ] }, { - "shortName": "DeleteTenant", - "fullName": "google.cloud.talent.v4beta1.TenantService.DeleteTenant", + "shortName": "ListSlates", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListSlates", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v4beta1/{name=projects/*/tenants/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/slates" } ] }, { - "shortName": "GetTenant", - "fullName": "google.cloud.talent.v4beta1.TenantService.GetTenant", + "shortName": "ListVodAdTagDetails", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListVodAdTagDetails", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{name=projects/*/tenants/*}" + "path": "/v1/{parent=projects/*/locations/*/vodSessions/*}/vodAdTagDetails" } ] }, { - "shortName": "ListTenants", - "fullName": "google.cloud.talent.v4beta1.TenantService.ListTenants", + "shortName": "ListVodStitchDetails", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListVodStitchDetails", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v4beta1/{parent=projects/*}/tenants" + "path": "/v1/{parent=projects/*/locations/*/vodSessions/*}/vodStitchDetails" } ] }, { - "shortName": "UpdateTenant", - "fullName": "google.cloud.talent.v4beta1.TenantService.UpdateTenant", + "shortName": "UpdateCdnKey", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.UpdateCdnKey", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v4beta1/{tenant.name=projects/*/tenants/*}" + "path": "/v1/{cdn_key.name=projects/*/locations/*/cdnKeys/*}" + } + ] + }, + { + "shortName": "UpdateSlate", + "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.UpdateSlate", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{slate.name=projects/*/locations/*/slates/*}" } ] } ] } ], - "configFile": "jobs_v4beta1.yaml", + "configFile": "videostitcher_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.talent.v4beta1.CompanyService", - "google.cloud.talent.v4beta1.Completion", - "google.cloud.talent.v4beta1.EventService", - "google.cloud.talent.v4beta1.JobService", - "google.cloud.talent.v4beta1.TenantService", - "google.longrunning.Operations" - ] + "google.cloud.video.stitcher.v1.VideoStitcherService" + ], + "nameInServiceConfig": "videostitcher.googleapis.com" }, { - "id": "google.cloud.tasks.v2", - "directory": "google/cloud/tasks/v2", - "version": "v2", - "majorVersion": "v2", - "hostName": "cloudtasks.googleapis.com", - "title": "Cloud Tasks API", - "description": "Manages the execution of large numbers of distributed requests.", + "id": "google.cloud.video.transcoder.v1", + "directory": "google/cloud/video/transcoder/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "transcoder.googleapis.com", + "title": "Transcoder API", + "description": "This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview.", "importDirectories": [ "google/api", - "google/cloud/tasks/v2", - "google/iam/v1", + "google/cloud/video/transcoder/v1", "google/protobuf", "google/rpc" ], "options": { + "csharp_namespace": { + "valueCounts": { + "": 1, + "Google.Cloud.Video.Transcoder.V1": 1 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks": 4 + "google.golang.org/genproto/googleapis/cloud/video/transcoder/v1;transcoder": 2 } }, "java_multiple_files": { "valueCounts": { - "true": 4 + "true": 2 } }, "java_package": { "valueCounts": { - "com.google.cloud.tasks.v2": 4 + "com.google.cloud.video.transcoder.v1": 2 } }, - "objc_class_prefix": { + "php_namespace": { "valueCounts": { - "": 3, - "TASKS": 1 + "": 1, + "Google\\Cloud\\Video\\Transcoder\\V1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "": 1, + "Google::Cloud::Video::Transcoder::V1": 1 } } }, "services": [ { - "shortName": "CloudTasks", - "fullName": "google.cloud.tasks.v2.CloudTasks", + "shortName": "TranscoderService", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService", "methods": [ { - "shortName": "CreateQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.CreateQueue", + "shortName": "CreateJob", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.CreateJob", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*}/queues" + "path": "/v1/{parent=projects/*/locations/*}/jobs" } ] }, { - "shortName": "CreateTask", - "fullName": "google.cloud.tasks.v2.CloudTasks.CreateTask", + "shortName": "CreateJobTemplate", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.CreateJobTemplate", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{parent=projects/*/locations/*/queues/*}/tasks" + "path": "/v1/{parent=projects/*/locations/*}/jobTemplates" } ] }, { - "shortName": "DeleteQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.DeleteQueue", + "shortName": "DeleteJob", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.DeleteJob", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/queues/*}" + "path": "/v1/{name=projects/*/locations/*/jobs/*}" } ] }, { - "shortName": "DeleteTask", - "fullName": "google.cloud.tasks.v2.CloudTasks.DeleteTask", + "shortName": "DeleteJobTemplate", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.DeleteJobTemplate", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" - } - ] - }, - { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.tasks.v2.CloudTasks.GetIamPolicy", - "mode": "UNARY", - "bindings": [ - { - "httpMethod": "POST", - "path": "/v2/{resource=projects/*/locations/*/queues/*}:getIamPolicy" + "path": "/v1/{name=projects/*/locations/*/jobTemplates/*}" } ] }, { - "shortName": "GetQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.GetQueue", + "shortName": "GetJob", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.GetJob", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/queues/*}" + "path": "/v1/{name=projects/*/locations/*/jobs/*}" } ] }, { - "shortName": "GetTask", - "fullName": "google.cloud.tasks.v2.CloudTasks.GetTask", + "shortName": "GetJobTemplate", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.GetJobTemplate", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" + "path": "/v1/{name=projects/*/locations/*/jobTemplates/*}" } ] }, { - "shortName": "ListQueues", - "fullName": "google.cloud.tasks.v2.CloudTasks.ListQueues", + "shortName": "ListJobTemplates", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.ListJobTemplates", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*}/queues" + "path": "/v1/{parent=projects/*/locations/*}/jobTemplates" } ] }, { - "shortName": "ListTasks", - "fullName": "google.cloud.tasks.v2.CloudTasks.ListTasks", + "shortName": "ListJobs", + "fullName": "google.cloud.video.transcoder.v1.TranscoderService.ListJobs", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2/{parent=projects/*/locations/*/queues/*}/tasks" + "path": "/v1/{parent=projects/*/locations/*}/jobs" } ] - }, + } + ] + } + ], + "configFile": "transcoder_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.video.transcoder.v1.TranscoderService" + ], + "nameInServiceConfig": "transcoder.googleapis.com" + }, + { + "id": "google.cloud.videointelligence.v1", + "directory": "google/cloud/videointelligence/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "videointelligence.googleapis.com", + "title": "Cloud Video Intelligence API", + "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf", + "google/rpc" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.VideoIntelligence.V1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/videointelligence/v1;videointelligence": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.videointelligence.v1": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\VideoIntelligence\\V1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::VideoIntelligence::V1": 1 + } + } + }, + "services": [ + { + "shortName": "VideoIntelligenceService", + "fullName": "google.cloud.videointelligence.v1.VideoIntelligenceService", + "methods": [ { - "shortName": "PauseQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.PauseQueue", + "shortName": "AnnotateVideo", + "fullName": "google.cloud.videointelligence.v1.VideoIntelligenceService.AnnotateVideo", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/queues/*}:pause" + "path": "/v1/videos:annotate" } ] - }, + } + ] + } + ], + "configFile": "videointelligence_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.videointelligence.v1.VideoIntelligenceService" + ], + "nameInServiceConfig": "videointelligence.googleapis.com" + }, + { + "id": "google.cloud.videointelligence.v1p3beta1", + "directory": "google/cloud/videointelligence/v1p3beta1", + "version": "v1p3beta1", + "majorVersion": "v1", + "hostName": "videointelligence.googleapis.com", + "title": "Cloud Video Intelligence API", + "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf", + "google/rpc" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.VideoIntelligence.V1P3Beta1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/videointelligence/v1p3beta1;videointelligence": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.videointelligence.v1p3beta1": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\VideoIntelligence\\V1p3beta1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::VideoIntelligence::V1p3beta1": 1 + } + } + }, + "services": [ + { + "shortName": "StreamingVideoIntelligenceService", + "fullName": "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService", + "methods": [ { - "shortName": "PurgeQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.PurgeQueue", + "shortName": "StreamingAnnotateVideo", + "fullName": "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService.StreamingAnnotateVideo", + "mode": "BIDIRECTIONAL_STREAMING" + } + ] + }, + { + "shortName": "VideoIntelligenceService", + "fullName": "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService", + "methods": [ + { + "shortName": "AnnotateVideo", + "fullName": "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService.AnnotateVideo", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/queues/*}:purge" + "path": "/v1p3beta1/videos:annotate" } ] - }, + } + ] + } + ], + "configFile": "videointelligence_v1p3beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService", + "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService" + ], + "nameInServiceConfig": "videointelligence.googleapis.com" + }, + { + "id": "google.cloud.vision.v1", + "directory": "google/cloud/vision/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "vision.googleapis.com", + "title": "Cloud Vision API", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", + "importDirectories": [ + "google/api", + "google/cloud/vision/v1", + "google/longrunning", + "google/protobuf", + "google/rpc", + "google/type" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 6 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/vision/v1;vision": 6 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 6 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.vision.v1": 6 + } + }, + "objc_class_prefix": { + "valueCounts": { + "GCVN": 6 + } + } + }, + "services": [ + { + "shortName": "ImageAnnotator", + "fullName": "google.cloud.vision.v1.ImageAnnotator", + "methods": [ { - "shortName": "ResumeQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.ResumeQueue", + "shortName": "AsyncBatchAnnotateFiles", + "fullName": "google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateFiles", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/queues/*}:resume" + "path": "/v1/files:asyncBatchAnnotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/files:asyncBatchAnnotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/files:asyncBatchAnnotate" } ] }, { - "shortName": "RunTask", - "fullName": "google.cloud.tasks.v2.CloudTasks.RunTask", + "shortName": "AsyncBatchAnnotateImages", + "fullName": "google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateImages", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}:run" - } - ] - }, - { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.tasks.v2.CloudTasks.SetIamPolicy", - "mode": "UNARY", - "bindings": [ + "path": "/v1/images:asyncBatchAnnotate" + }, { "httpMethod": "POST", - "path": "/v2/{resource=projects/*/locations/*/queues/*}:setIamPolicy" + "path": "/v1/{parent=projects/*/locations/*}/images:asyncBatchAnnotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/images:asyncBatchAnnotate" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.tasks.v2.CloudTasks.TestIamPermissions", + "shortName": "BatchAnnotateFiles", + "fullName": "google.cloud.vision.v1.ImageAnnotator.BatchAnnotateFiles", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2/{resource=projects/*/locations/*/queues/*}:testIamPermissions" + "path": "/v1/files:annotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/files:annotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/files:annotate" } ] }, { - "shortName": "UpdateQueue", - "fullName": "google.cloud.tasks.v2.CloudTasks.UpdateQueue", + "shortName": "BatchAnnotateImages", + "fullName": "google.cloud.vision.v1.ImageAnnotator.BatchAnnotateImages", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2/{queue.name=projects/*/locations/*/queues/*}" + "httpMethod": "POST", + "path": "/v1/images:annotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/images:annotate" + }, + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*}/images:annotate" } ] } ] - } - ], - "configFile": "cloudtasks_v2.yaml", - "serviceConfigApiNames": [ - "google.cloud.tasks.v2.CloudTasks" - ] - }, - { - "id": "google.cloud.tasks.v2beta2", - "directory": "google/cloud/tasks/v2beta2", - "version": "v2beta2", - "majorVersion": "v2", - "hostName": "cloudtasks.googleapis.com", - "title": "Cloud Tasks API", - "description": "Manages the execution of large numbers of distributed requests.", - "importDirectories": [ - "google/api", - "google/cloud/tasks/v2beta2", - "google/iam/v1", - "google/protobuf", - "google/rpc" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks": 5 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 5 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.tasks.v2beta2": 5 - } }, - "objc_class_prefix": { - "valueCounts": { - "": 4, - "TASKS": 1 - } - } - }, - "services": [ { - "shortName": "CloudTasks", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks", + "shortName": "ProductSearch", + "fullName": "google.cloud.vision.v1.ProductSearch", "methods": [ { - "shortName": "AcknowledgeTask", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask", + "shortName": "AddProductToProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.AddProductToProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:acknowledge" + "path": "/v1/{name=projects/*/locations/*/productSets/*}:addProduct" } ] }, { - "shortName": "CancelLease", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CancelLease", + "shortName": "CreateProduct", + "fullName": "google.cloud.vision.v1.ProductSearch.CreateProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:cancelLease" + "path": "/v1/{parent=projects/*/locations/*}/products" } ] }, { - "shortName": "CreateQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CreateQueue", + "shortName": "CreateProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.CreateProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{parent=projects/*/locations/*}/queues" + "path": "/v1/{parent=projects/*/locations/*}/productSets" } ] }, { - "shortName": "CreateTask", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.CreateTask", + "shortName": "CreateReferenceImage", + "fullName": "google.cloud.vision.v1.ProductSearch.CreateReferenceImage", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" + "path": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages" } ] }, { - "shortName": "DeleteQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue", + "shortName": "DeleteProduct", + "fullName": "google.cloud.vision.v1.ProductSearch.DeleteProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*}" + "path": "/v1/{name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "DeleteTask", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.DeleteTask", + "shortName": "DeleteProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.DeleteProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}" + "path": "/v1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetIamPolicy", + "shortName": "DeleteReferenceImage", + "fullName": "google.cloud.vision.v1.ProductSearch.DeleteReferenceImage", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" } ] }, { - "shortName": "GetQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetQueue", + "shortName": "GetProduct", + "fullName": "google.cloud.vision.v1.ProductSearch.GetProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*}" + "path": "/v1/{name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "GetTask", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.GetTask", + "shortName": "GetProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.GetProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}" + "path": "/v1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "LeaseTasks", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks", + "shortName": "GetReferenceImage", + "fullName": "google.cloud.vision.v1.ProductSearch.GetReferenceImage", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" + } + ] + }, + { + "shortName": "ImportProductSets", + "fullName": "google.cloud.vision.v1.ProductSearch.ImportProductSets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks:lease" + "path": "/v1/{parent=projects/*/locations/*}/productSets:import" } ] }, { - "shortName": "ListQueues", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ListQueues", + "shortName": "ListProductSets", + "fullName": "google.cloud.vision.v1.ProductSearch.ListProductSets", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta2/{parent=projects/*/locations/*}/queues" + "path": "/v1/{parent=projects/*/locations/*}/productSets" } ] }, { - "shortName": "ListTasks", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ListTasks", + "shortName": "ListProducts", + "fullName": "google.cloud.vision.v1.ProductSearch.ListProducts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" + "path": "/v1/{parent=projects/*/locations/*}/products" } ] }, { - "shortName": "PauseQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.PauseQueue", + "shortName": "ListProductsInProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.ListProductsInProductSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:pause" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/productSets/*}/products" } ] }, { - "shortName": "PurgeQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue", + "shortName": "ListReferenceImages", + "fullName": "google.cloud.vision.v1.ProductSearch.ListReferenceImages", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:purge" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages" } ] }, { - "shortName": "RenewLease", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.RenewLease", + "shortName": "PurgeProducts", + "fullName": "google.cloud.vision.v1.ProductSearch.PurgeProducts", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:renewLease" + "path": "/v1/{parent=projects/*/locations/*}/products:purge" } ] }, { - "shortName": "ResumeQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue", + "shortName": "RemoveProductFromProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.RemoveProductFromProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*}:resume" + "path": "/v1/{name=projects/*/locations/*/productSets/*}:removeProduct" } ] }, { - "shortName": "RunTask", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.RunTask", + "shortName": "UpdateProduct", + "fullName": "google.cloud.vision.v1.ProductSearch.UpdateProduct", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:run" + "httpMethod": "PATCH", + "path": "/v1/{product.name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.SetIamPolicy", + "shortName": "UpdateProductSet", + "fullName": "google.cloud.vision.v1.ProductSearch.UpdateProductSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{product_set.name=projects/*/locations/*/productSets/*}" + } + ] + } + ] + } + ], + "configFile": "vision_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.vision.v1.ImageAnnotator", + "google.cloud.vision.v1.ProductSearch" + ], + "nameInServiceConfig": "vision.googleapis.com" + }, + { + "id": "google.cloud.vision.v1p1beta1", + "directory": "google/cloud/vision/v1p1beta1", + "version": "v1p1beta1", + "majorVersion": "v1", + "hostName": "vision.googleapis.com", + "title": "Cloud Vision API", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", + "importDirectories": [ + "google/api", + "google/cloud/vision/v1p1beta1", + "google/rpc", + "google/type" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 4 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/vision/v1p1beta1;vision": 4 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 4 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.vision.v1p1beta1": 4 + } + } + }, + "services": [ + { + "shortName": "ImageAnnotator", + "fullName": "google.cloud.vision.v1p1beta1.ImageAnnotator", + "methods": [ + { + "shortName": "BatchAnnotateImages", + "fullName": "google.cloud.vision.v1p1beta1.ImageAnnotator.BatchAnnotateImages", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy" + "path": "/v1p1beta1/images:annotate" } ] - }, + } + ] + } + ], + "configFile": "vision_v1p1beta1.yaml", + "serviceConfigApiNames": [ + "google.cloud.vision.v1p1beta1.ImageAnnotator" + ], + "nameInServiceConfig": "vision.googleapis.com" + }, + { + "id": "google.cloud.vision.v1p2beta1", + "directory": "google/cloud/vision/v1p2beta1", + "version": "v1p2beta1", + "majorVersion": "v1", + "hostName": "vision.googleapis.com", + "title": "Cloud Vision API", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", + "importDirectories": [ + "google/api", + "google/cloud/vision/v1p2beta1", + "google/longrunning", + "google/protobuf", + "google/rpc", + "google/type" + ], + "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 4 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/vision/v1p2beta1;vision": 4 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 4 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.vision.v1p2beta1": 4 + } + } + }, + "services": [ + { + "shortName": "ImageAnnotator", + "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator", + "methods": [ { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.TestIamPermissions", + "shortName": "AsyncBatchAnnotateFiles", + "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator.AsyncBatchAnnotateFiles", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions" + "path": "/v1p2beta1/files:asyncBatchAnnotate" } ] }, { - "shortName": "UpdateQueue", - "fullName": "google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue", + "shortName": "BatchAnnotateImages", + "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator.BatchAnnotateImages", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2beta2/{queue.name=projects/*/locations/*/queues/*}" + "httpMethod": "POST", + "path": "/v1p2beta1/images:annotate" } ] } ] } ], - "configFile": "cloudtasks_v2beta2.yaml", + "configFile": "vision_v1p2beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.tasks.v2beta2.CloudTasks" - ] + "google.cloud.vision.v1p2beta1.ImageAnnotator" + ], + "nameInServiceConfig": "vision.googleapis.com" }, { - "id": "google.cloud.tasks.v2beta3", - "directory": "google/cloud/tasks/v2beta3", - "version": "v2beta3", - "majorVersion": "v2", - "hostName": "cloudtasks.googleapis.com", - "title": "Cloud Tasks API", - "description": "Manages the execution of large numbers of distributed requests.", + "id": "google.cloud.vision.v1p3beta1", + "directory": "google/cloud/vision/v1p3beta1", + "version": "v1p3beta1", + "majorVersion": "v1", + "hostName": "vision.googleapis.com", + "title": "Cloud Vision API", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "importDirectories": [ "google/api", - "google/cloud/tasks/v2beta3", - "google/iam/v1", + "google/cloud/vision/v1p3beta1", + "google/longrunning", "google/protobuf", - "google/rpc" + "google/rpc", + "google/type" ], "options": { + "cc_enable_arenas": { + "valueCounts": { + "true": 6 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks": 4 + "google.golang.org/genproto/googleapis/cloud/vision/v1p3beta1;vision": 6 } }, "java_multiple_files": { "valueCounts": { - "true": 4 + "true": 6 } }, "java_package": { "valueCounts": { - "com.google.cloud.tasks.v2beta3": 4 + "com.google.cloud.vision.v1p3beta1": 6 } }, "objc_class_prefix": { "valueCounts": { - "": 3, - "TASKS": 1 + "": 4, + "GCVN": 2 } } }, "services": [ { - "shortName": "CloudTasks", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks", + "shortName": "ImageAnnotator", + "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator", "methods": [ { - "shortName": "CreateQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.CreateQueue", + "shortName": "AsyncBatchAnnotateFiles", + "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator.AsyncBatchAnnotateFiles", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta3/{parent=projects/*/locations/*}/queues" + "path": "/v1p3beta1/files:asyncBatchAnnotate" } ] }, { - "shortName": "CreateTask", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.CreateTask", + "shortName": "BatchAnnotateImages", + "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator.BatchAnnotateImages", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks" + "path": "/v1p3beta1/images:annotate" + } + ] + } + ] + }, + { + "shortName": "ProductSearch", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch", + "methods": [ + { + "shortName": "AddProductToProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.AddProductToProductSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:addProduct" } ] }, { - "shortName": "DeleteQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue", + "shortName": "CreateProduct", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateProduct", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p3beta1/{parent=projects/*/locations/*}/products" + } + ] + }, + { + "shortName": "CreateProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateProductSet", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets" + } + ] + }, + { + "shortName": "CreateReferenceImage", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateReferenceImage", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + } + ] + }, + { + "shortName": "DeleteProduct", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*}" + "path": "/v1p3beta1/{name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "DeleteTask", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.DeleteTask", + "shortName": "DeleteProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}" + "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "GetIamPolicy", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetIamPolicy", + "shortName": "DeleteReferenceImage", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteReferenceImage", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:getIamPolicy" + "httpMethod": "DELETE", + "path": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" } ] }, { - "shortName": "GetQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetQueue", + "shortName": "GetProduct", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*}" + "path": "/v1p3beta1/{name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "GetTask", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.GetTask", + "shortName": "GetProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}" + "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "ListQueues", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ListQueues", + "shortName": "GetReferenceImage", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetReferenceImage", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2beta3/{parent=projects/*/locations/*}/queues" + "path": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" } ] }, { - "shortName": "ListTasks", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ListTasks", + "shortName": "ImportProductSets", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ImportProductSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks" + "httpMethod": "POST", + "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets:import" } ] }, { - "shortName": "PauseQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.PauseQueue", + "shortName": "ListProductSets", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProductSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:pause" + "httpMethod": "GET", + "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets" } ] }, { - "shortName": "PurgeQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue", + "shortName": "ListProducts", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProducts", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:purge" + "httpMethod": "GET", + "path": "/v1p3beta1/{parent=projects/*/locations/*}/products" } ] }, { - "shortName": "ResumeQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue", + "shortName": "ListProductsInProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProductsInProductSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*}:resume" + "httpMethod": "GET", + "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}/products" } ] }, { - "shortName": "RunTask", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.RunTask", + "shortName": "ListReferenceImages", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListReferenceImages", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}:run" + "httpMethod": "GET", + "path": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" } ] }, { - "shortName": "SetIamPolicy", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.SetIamPolicy", + "shortName": "RemoveProductFromProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.RemoveProductFromProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:setIamPolicy" + "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" } ] }, { - "shortName": "TestIamPermissions", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.TestIamPermissions", + "shortName": "UpdateProduct", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.UpdateProduct", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2beta3/{resource=projects/*/locations/*/queues/*}:testIamPermissions" + "httpMethod": "PATCH", + "path": "/v1p3beta1/{product.name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "UpdateQueue", - "fullName": "google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue", + "shortName": "UpdateProductSet", + "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.UpdateProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v2beta3/{queue.name=projects/*/locations/*/queues/*}" + "path": "/v1p3beta1/{product_set.name=projects/*/locations/*/productSets/*}" } ] } ] } ], - "configFile": "cloudtasks_v2beta3.yaml", + "configFile": "vision_v1p3beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.tasks.v2beta3.CloudTasks" - ] + "google.cloud.vision.v1p3beta1.ImageAnnotator", + "google.cloud.vision.v1p3beta1.ProductSearch" + ], + "nameInServiceConfig": "vision.googleapis.com" }, { - "id": "google.cloud.texttospeech.v1", - "directory": "google/cloud/texttospeech/v1", - "version": "v1", + "id": "google.cloud.vision.v1p4beta1", + "directory": "google/cloud/vision/v1p4beta1", + "version": "v1p4beta1", "majorVersion": "v1", - "hostName": "texttospeech.googleapis.com", - "title": "Cloud Text-to-Speech API", - "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", + "hostName": "vision.googleapis.com", + "title": "Cloud Vision API", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "importDirectories": [ - "google/api" + "google/api", + "google/cloud/vision/v1p4beta1", + "google/longrunning", + "google/protobuf", + "google/rpc", + "google/type" ], "options": { "cc_enable_arenas": { "valueCounts": { - "true": 1 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.TextToSpeech.V1": 1 + "true": 7 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/texttospeech/v1;texttospeech": 1 + "google.golang.org/genproto/googleapis/cloud/vision/v1p4beta1;vision": 7 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 7 } }, "java_package": { "valueCounts": { - "com.google.cloud.texttospeech.v1": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\TextToSpeech\\V1": 1 + "com.google.cloud.vision.v1p4beta1": 7 } }, - "ruby_package": { + "objc_class_prefix": { "valueCounts": { - "Google::Cloud::TextToSpeech::V1": 1 + "GCVN": 7 } } }, "services": [ { - "shortName": "TextToSpeech", - "fullName": "google.cloud.texttospeech.v1.TextToSpeech", + "shortName": "ImageAnnotator", + "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator", "methods": [ { - "shortName": "ListVoices", - "fullName": "google.cloud.texttospeech.v1.TextToSpeech.ListVoices", + "shortName": "AsyncBatchAnnotateFiles", + "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.AsyncBatchAnnotateFiles", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/voices" + "httpMethod": "POST", + "path": "/v1p4beta1/files:asyncBatchAnnotate" } ] }, { - "shortName": "SynthesizeSpeech", - "fullName": "google.cloud.texttospeech.v1.TextToSpeech.SynthesizeSpeech", + "shortName": "AsyncBatchAnnotateImages", + "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.AsyncBatchAnnotateImages", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/text:synthesize" + "path": "/v1p4beta1/images:asyncBatchAnnotate" } ] - } - ] - } - ], - "configFile": "texttospeech_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.texttospeech.v1.TextToSpeech" - ] - }, - { - "id": "google.cloud.texttospeech.v1beta1", - "directory": "google/cloud/texttospeech/v1beta1", - "version": "v1beta1", - "majorVersion": "v1", - "hostName": "texttospeech.googleapis.com", - "title": "Cloud Text-to-Speech API", - "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", - "importDirectories": [ - "google/api" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 1 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.TextToSpeech.V1Beta1": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/texttospeech/v1beta1;texttospeech": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.texttospeech.v1beta1": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\TextToSpeech\\V1beta1": 1 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::TextToSpeech::V1beta1": 1 - } - } - }, - "services": [ - { - "shortName": "TextToSpeech", - "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech", - "methods": [ + }, { - "shortName": "ListVoices", - "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech.ListVoices", + "shortName": "BatchAnnotateFiles", + "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.BatchAnnotateFiles", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1beta1/voices" + "httpMethod": "POST", + "path": "/v1p4beta1/files:annotate" } ] }, { - "shortName": "SynthesizeSpeech", - "fullName": "google.cloud.texttospeech.v1beta1.TextToSpeech.SynthesizeSpeech", + "shortName": "BatchAnnotateImages", + "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.BatchAnnotateImages", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1beta1/text:synthesize" + "path": "/v1p4beta1/images:annotate" } ] } ] - } - ], - "configFile": "texttospeech_v1beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.texttospeech.v1beta1.TextToSpeech" - ] - }, - { - "id": "google.cloud.timeseriesinsights.v1", - "directory": "google/cloud/timeseriesinsights/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "timeseriesinsights.googleapis.com", - "title": "Timeseries Insights API", - "description": "Provides a Timeseries Insights service which operates over time series data. Users can perform time series spike, trend, and anomaly detection. With a straightforward API and easy to understand results, the service makes it simple to gather insights from large amounts of time series data (e.g. monitoring datasets) and integrate these insights in their applications.", - "importDirectories": [ - "google/api", - "google/protobuf", - "google/rpc" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/timeseriesinsights/v1;timeseriesinsights": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } }, - "java_package": { - "valueCounts": { - "com.google.cloud.timeseriesinsights.v1": 1 - } - } - }, - "services": [ { - "shortName": "TimeseriesInsightsController", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController", + "shortName": "ProductSearch", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch", "methods": [ { - "shortName": "AppendEvents", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.AppendEvents", + "shortName": "AddProductToProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.AddProductToProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{dataset=projects/*/locations/*/datasets/*}:appendEvents" - }, + "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:addProduct" + } + ] + }, + { + "shortName": "CreateProduct", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateProduct", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1/{dataset=projects/*/datasets/*}:appendEvents" + "path": "/v1p4beta1/{parent=projects/*/locations/*}/products" } ] }, { - "shortName": "CreateDataSet", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.CreateDataSet", + "shortName": "CreateProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/datasets" - }, + "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets" + } + ] + }, + { + "shortName": "CreateReferenceImage", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateReferenceImage", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/datasets" + "path": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" } ] }, { - "shortName": "DeleteDataSet", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.DeleteDataSet", + "shortName": "DeleteProduct", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteProduct", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/datasets/*}" - }, - { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/datasets/*}" + "path": "/v1p4beta1/{name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "EvaluateSlice", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.EvaluateSlice", + "shortName": "DeleteProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteProductSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{dataset=projects/*/locations/*/datasets/*}:evaluateSlice" - }, - { - "httpMethod": "POST", - "path": "/v1/{dataset=projects/*/datasets/*}:evaluateSlice" + "httpMethod": "DELETE", + "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "ListDataSets", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.ListDataSets", + "shortName": "DeleteReferenceImage", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteReferenceImage", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/datasets" - }, - { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*}/datasets" + "httpMethod": "DELETE", + "path": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" } ] }, { - "shortName": "QueryDataSet", - "fullName": "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController.QueryDataSet", + "shortName": "GetProduct", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetProduct", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/datasets/*}:query" - }, - { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/datasets/*}:query" + "httpMethod": "GET", + "path": "/v1p4beta1/{name=projects/*/locations/*/products/*}" } ] - } - ] - } - ], - "configFile": "timeseriesinsights_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.location.Locations", - "google.cloud.timeseriesinsights.v1.TimeseriesInsightsController" - ] - }, - { - "id": "google.cloud.tpu.v1", - "directory": "google/cloud/tpu/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "tpu.googleapis.com", - "title": "Cloud TPU API", - "description": "TPU API provides customers with access to Google TPU technology.", - "importDirectories": [ - "google/api", - "google/longrunning", - "google/protobuf" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/tpu/v1;tpu": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.tpu.v1": 1 - } - } - }, - "services": [ - { - "shortName": "Tpu", - "fullName": "google.cloud.tpu.v1.Tpu", - "methods": [ + }, { - "shortName": "CreateNode", - "fullName": "google.cloud.tpu.v1.Tpu.CreateNode", + "shortName": "GetProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetProductSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/nodes" + "httpMethod": "GET", + "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}" } ] }, { - "shortName": "DeleteNode", - "fullName": "google.cloud.tpu.v1.Tpu.DeleteNode", + "shortName": "GetReferenceImage", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetReferenceImage", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/nodes/*}" + "httpMethod": "GET", + "path": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" } ] }, { - "shortName": "GetAcceleratorType", - "fullName": "google.cloud.tpu.v1.Tpu.GetAcceleratorType", + "shortName": "ImportProductSets", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ImportProductSets", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/acceleratorTypes/*}" + "httpMethod": "POST", + "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets:import" } ] }, { - "shortName": "GetNode", - "fullName": "google.cloud.tpu.v1.Tpu.GetNode", + "shortName": "ListProductSets", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProductSets", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/nodes/*}" + "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets" } ] }, { - "shortName": "GetTensorFlowVersion", - "fullName": "google.cloud.tpu.v1.Tpu.GetTensorFlowVersion", + "shortName": "ListProducts", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProducts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/tensorflowVersions/*}" + "path": "/v1p4beta1/{parent=projects/*/locations/*}/products" } ] }, { - "shortName": "ListAcceleratorTypes", - "fullName": "google.cloud.tpu.v1.Tpu.ListAcceleratorTypes", + "shortName": "ListProductsInProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProductsInProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/acceleratorTypes" + "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}/products" } ] }, { - "shortName": "ListNodes", - "fullName": "google.cloud.tpu.v1.Tpu.ListNodes", + "shortName": "ListReferenceImages", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListReferenceImages", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/nodes" + "path": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" } ] }, { - "shortName": "ListTensorFlowVersions", - "fullName": "google.cloud.tpu.v1.Tpu.ListTensorFlowVersions", + "shortName": "PurgeProducts", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.PurgeProducts", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/tensorflowVersions" + "httpMethod": "POST", + "path": "/v1p4beta1/{parent=projects/*/locations/*}/products:purge" } ] }, { - "shortName": "ReimageNode", - "fullName": "google.cloud.tpu.v1.Tpu.ReimageNode", + "shortName": "RemoveProductFromProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.RemoveProductFromProductSet", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/nodes/*}:reimage" + "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" } ] }, { - "shortName": "StartNode", - "fullName": "google.cloud.tpu.v1.Tpu.StartNode", + "shortName": "UpdateProduct", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.UpdateProduct", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/nodes/*}:start" + "httpMethod": "PATCH", + "path": "/v1p4beta1/{product.name=projects/*/locations/*/products/*}" } ] }, { - "shortName": "StopNode", - "fullName": "google.cloud.tpu.v1.Tpu.StopNode", + "shortName": "UpdateProductSet", + "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.UpdateProductSet", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/nodes/*}:stop" + "httpMethod": "PATCH", + "path": "/v1p4beta1/{product_set.name=projects/*/locations/*/productSets/*}" } ] } ] } ], - "configFile": "tpu_v1.yaml", + "configFile": "vision_v1p4beta1.yaml", "serviceConfigApiNames": [ - "google.cloud.tpu.v1.Tpu" - ] + "google.cloud.vision.v1p4beta1.ImageAnnotator", + "google.cloud.vision.v1p4beta1.ProductSearch" + ], + "nameInServiceConfig": "vision.googleapis.com" }, { - "id": "google.cloud.tpu.v2alpha1", - "directory": "google/cloud/tpu/v2alpha1", - "version": "v2alpha1", - "majorVersion": "v2", - "hostName": "tpu.googleapis.com", - "title": "Cloud TPU API", - "description": "TPU API provides customers with access to Google TPU technology.", + "id": "google.cloud.visionai.v1", + "directory": "google/cloud/visionai/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "visionai.googleapis.com", + "title": "Vision AI API", + "description": "", "importDirectories": [ "google/api", + "google/cloud/visionai/v1", "google/longrunning", - "google/protobuf" + "google/protobuf", + "google/rpc", + "google/type" ], "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.VisionAI.V1": 11 + } + }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/tpu/v2alpha1;tpu": 1 + "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai": 11 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 11 } }, "java_package": { "valueCounts": { - "com.google.cloud.tpu.v2alpha1": 1 + "com.google.cloud.visionai.v1": 11 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\VisionAI\\V1": 11 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::VisionAI::V1": 11 } } }, "services": [ { - "shortName": "Tpu", - "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "AppPlatform", + "fullName": "google.cloud.visionai.v1.AppPlatform", "methods": [ { - "shortName": "CreateNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateNode", + "shortName": "AddApplicationStreamInput", + "fullName": "google.cloud.visionai.v1.AppPlatform.AddApplicationStreamInput", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/applications/*}:addStreamInput" + } + ] + }, + { + "shortName": "CreateApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.CreateApplication", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/applications" + } + ] + }, + { + "shortName": "CreateApplicationInstances", + "fullName": "google.cloud.visionai.v1.AppPlatform.CreateApplicationInstances", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/applications/*}:createApplicationInstances" + } + ] + }, + { + "shortName": "CreateDraft", + "fullName": "google.cloud.visionai.v1.AppPlatform.CreateDraft", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/applications/*}/drafts" + } + ] + }, + { + "shortName": "CreateProcessor", + "fullName": "google.cloud.visionai.v1.AppPlatform.CreateProcessor", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/processors" + } + ] + }, + { + "shortName": "DeleteApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.DeleteApplication", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/applications/*}" + } + ] + }, + { + "shortName": "DeleteApplicationInstances", + "fullName": "google.cloud.visionai.v1.AppPlatform.DeleteApplicationInstances", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2alpha1/{parent=projects/*/locations/*}/nodes" + "path": "/v1/{name=projects/*/locations/*/applications/*}:deleteApplicationInstances" } ] }, { - "shortName": "DeleteNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteNode", + "shortName": "DeleteDraft", + "fullName": "google.cloud.visionai.v1.AppPlatform.DeleteDraft", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}" + "path": "/v1/{name=projects/*/locations/*/applications/*/drafts/*}" } ] }, { - "shortName": "GenerateServiceIdentity", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity", + "shortName": "DeleteProcessor", + "fullName": "google.cloud.visionai.v1.AppPlatform.DeleteProcessor", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2alpha1/{parent=projects/*/locations/*}:generateServiceIdentity" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/processors/*}" } ] }, { - "shortName": "GetAcceleratorType", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType", + "shortName": "DeployApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.DeployApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v2alpha1/{name=projects/*/locations/*/acceleratorTypes/*}" + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/applications/*}:deploy" } ] }, { - "shortName": "GetGuestAttributes", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes", + "shortName": "GetApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.GetApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:getGuestAttributes" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/applications/*}" } ] }, { - "shortName": "GetNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetNode", + "shortName": "GetDraft", + "fullName": "google.cloud.visionai.v1.AppPlatform.GetDraft", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}" + "path": "/v1/{name=projects/*/locations/*/applications/*/drafts/*}" } ] }, { - "shortName": "GetRuntimeVersion", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion", + "shortName": "GetInstance", + "fullName": "google.cloud.visionai.v1.AppPlatform.GetInstance", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2alpha1/{name=projects/*/locations/*/runtimeVersions/*}" + "path": "/v1/{name=projects/*/locations/*/applications/*/instances/*}" } ] }, { - "shortName": "ListAcceleratorTypes", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes", + "shortName": "GetProcessor", + "fullName": "google.cloud.visionai.v1.AppPlatform.GetProcessor", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2alpha1/{parent=projects/*/locations/*}/acceleratorTypes" + "path": "/v1/{name=projects/*/locations/*/processors/*}" } ] }, { - "shortName": "ListNodes", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListNodes", + "shortName": "ListApplications", + "fullName": "google.cloud.visionai.v1.AppPlatform.ListApplications", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2alpha1/{parent=projects/*/locations/*}/nodes" + "path": "/v1/{parent=projects/*/locations/*}/applications" } ] }, { - "shortName": "ListRuntimeVersions", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions", + "shortName": "ListDrafts", + "fullName": "google.cloud.visionai.v1.AppPlatform.ListDrafts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v2alpha1/{parent=projects/*/locations/*}/runtimeVersions" + "path": "/v1/{parent=projects/*/locations/*/applications/*}/drafts" } ] }, { - "shortName": "StartNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.StartNode", + "shortName": "ListInstances", + "fullName": "google.cloud.visionai.v1.AppPlatform.ListInstances", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:start" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/applications/*}/instances" } ] }, { - "shortName": "StopNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.StopNode", + "shortName": "ListPrebuiltProcessors", + "fullName": "google.cloud.visionai.v1.AppPlatform.ListPrebuiltProcessors", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v2alpha1/{name=projects/*/locations/*/nodes/*}:stop" + "path": "/v1/{parent=projects/*/locations/*}/processors:prebuilt" } ] }, { - "shortName": "UpdateNode", - "fullName": "google.cloud.tpu.v2alpha1.Tpu.UpdateNode", + "shortName": "ListProcessors", + "fullName": "google.cloud.visionai.v1.AppPlatform.ListProcessors", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v2alpha1/{node.name=projects/*/locations/*/nodes/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/processors" } ] - } - ] - } - ], - "configFile": "tpu.yaml", - "serviceConfigApiNames": [ - "google.cloud.tpu.v2alpha1.Tpu" - ] - }, - { - "id": "google.cloud.translate.v3", - "directory": "google/cloud/translate/v3", - "version": "v3", - "majorVersion": "v3", - "hostName": "translate.googleapis.com", - "title": "Cloud Translation API", - "description": "Integrates text translation into your website or application.", - "importDirectories": [ - "google/api", - "google/longrunning", - "google/protobuf" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 1 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.Translate.V3": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/translate/v3;translate": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.translate.v3": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\Translate\\V3": 1 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::Translate::V3": 1 - } - } - }, - "services": [ - { - "shortName": "TranslationService", - "fullName": "google.cloud.translation.v3.TranslationService", - "methods": [ + }, { - "shortName": "BatchTranslateDocument", - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateDocument", + "shortName": "RemoveApplicationStreamInput", + "fullName": "google.cloud.visionai.v1.AppPlatform.RemoveApplicationStreamInput", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}:batchTranslateDocument" + "path": "/v1/{name=projects/*/locations/*/applications/*}:removeStreamInput" } ] }, { - "shortName": "BatchTranslateText", - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateText", + "shortName": "UndeployApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.UndeployApplication", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}:batchTranslateText" + "path": "/v1/{name=projects/*/locations/*/applications/*}:undeploy" } ] }, { - "shortName": "CreateGlossary", - "fullName": "google.cloud.translation.v3.TranslationService.CreateGlossary", + "shortName": "UpdateApplication", + "fullName": "google.cloud.visionai.v1.AppPlatform.UpdateApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}/glossaries" + "httpMethod": "PATCH", + "path": "/v1/{application.name=projects/*/locations/*/applications/*}" } ] }, { - "shortName": "DeleteGlossary", - "fullName": "google.cloud.translation.v3.TranslationService.DeleteGlossary", + "shortName": "UpdateApplicationInstances", + "fullName": "google.cloud.visionai.v1.AppPlatform.UpdateApplicationInstances", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v3/{name=projects/*/locations/*/glossaries/*}" + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/applications/*}:updateApplicationInstances" } ] }, { - "shortName": "DetectLanguage", - "fullName": "google.cloud.translation.v3.TranslationService.DetectLanguage", + "shortName": "UpdateApplicationStreamInput", + "fullName": "google.cloud.visionai.v1.AppPlatform.UpdateApplicationStreamInput", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}:detectLanguage" - }, - { - "httpMethod": "POST", - "path": "/v3/{parent=projects/*}:detectLanguage" + "path": "/v1/{name=projects/*/locations/*/applications/*}:updateStreamInput" } ] }, { - "shortName": "GetGlossary", - "fullName": "google.cloud.translation.v3.TranslationService.GetGlossary", + "shortName": "UpdateDraft", + "fullName": "google.cloud.visionai.v1.AppPlatform.UpdateDraft", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3/{name=projects/*/locations/*/glossaries/*}" + "httpMethod": "PATCH", + "path": "/v1/{draft.name=projects/*/locations/*/applications/*/drafts/*}" } ] }, { - "shortName": "GetSupportedLanguages", - "fullName": "google.cloud.translation.v3.TranslationService.GetSupportedLanguages", + "shortName": "UpdateProcessor", + "fullName": "google.cloud.visionai.v1.AppPlatform.UpdateProcessor", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3/{parent=projects/*/locations/*}/supportedLanguages" - }, + "httpMethod": "PATCH", + "path": "/v1/{processor.name=projects/*/locations/*/processors/*}" + } + ] + } + ] + }, + { + "shortName": "LiveVideoAnalytics", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics", + "methods": [ + { + "shortName": "CreateAnalysis", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics.CreateAnalysis", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "GET", - "path": "/v3/{parent=projects/*}/supportedLanguages" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/analyses" } ] }, { - "shortName": "ListGlossaries", - "fullName": "google.cloud.translation.v3.TranslationService.ListGlossaries", + "shortName": "DeleteAnalysis", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics.DeleteAnalysis", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3/{parent=projects/*/locations/*}/glossaries" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/clusters/*/analyses/*}" } ] }, { - "shortName": "TranslateDocument", - "fullName": "google.cloud.translation.v3.TranslationService.TranslateDocument", + "shortName": "GetAnalysis", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics.GetAnalysis", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}:translateDocument" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/clusters/*/analyses/*}" } ] }, { - "shortName": "TranslateText", - "fullName": "google.cloud.translation.v3.TranslationService.TranslateText", + "shortName": "ListAnalyses", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics.ListAnalyses", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v3/{parent=projects/*/locations/*}:translateText" - }, + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/analyses" + } + ] + }, + { + "shortName": "UpdateAnalysis", + "fullName": "google.cloud.visionai.v1.LiveVideoAnalytics.UpdateAnalysis", + "mode": "UNARY", + "bindings": [ { - "httpMethod": "POST", - "path": "/v3/{parent=projects/*}:translateText" + "httpMethod": "PATCH", + "path": "/v1/{analysis.name=projects/*/locations/*/clusters/*/analyses/*}" } ] } ] - } - ], - "configFile": "translate_v3.yaml", - "serviceConfigApiNames": [ - "google.cloud.translation.v3.TranslationService" - ] - }, - { - "id": "google.cloud.translate.v3beta1", - "directory": "google/cloud/translate/v3beta1", - "version": "v3beta1", - "majorVersion": "v3", - "hostName": "translate.googleapis.com", - "title": "Cloud Translation API", - "description": "Integrates text translation into your website or application.", - "importDirectories": [ - "google/api", - "google/longrunning", - "google/protobuf" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 1 - } - }, - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.Translate.V3Beta1": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/translate/v3beta1;translate": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.translate.v3beta1": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\Translate\\V3beta1": 1 - } }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::Translate::V3beta1": 1 - } - } - }, - "services": [ { - "shortName": "TranslationService", - "fullName": "google.cloud.translation.v3beta1.TranslationService", + "shortName": "StreamingService", + "fullName": "google.cloud.visionai.v1.StreamingService", "methods": [ { - "shortName": "BatchTranslateDocument", - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateDocument", + "shortName": "AcquireLease", + "fullName": "google.cloud.visionai.v1.StreamingService.AcquireLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}:batchTranslateDocument" + "path": "/v1/{series=projects/*/locations/*/clusters/*/series/*}:acquireLease" } ] }, { - "shortName": "BatchTranslateText", - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateText", + "shortName": "ReceiveEvents", + "fullName": "google.cloud.visionai.v1.StreamingService.ReceiveEvents", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ReceivePackets", + "fullName": "google.cloud.visionai.v1.StreamingService.ReceivePackets", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ReleaseLease", + "fullName": "google.cloud.visionai.v1.StreamingService.ReleaseLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}:batchTranslateText" + "path": "/v1/{series=projects/*/locations/*/clusters/*/series/*}:releaseLease" } ] }, { - "shortName": "CreateGlossary", - "fullName": "google.cloud.translation.v3beta1.TranslationService.CreateGlossary", + "shortName": "RenewLease", + "fullName": "google.cloud.visionai.v1.StreamingService.RenewLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}/glossaries" + "path": "/v1/{series=projects/*/locations/*/clusters/*/series/*}:renewLease" } ] }, { - "shortName": "DeleteGlossary", - "fullName": "google.cloud.translation.v3beta1.TranslationService.DeleteGlossary", + "shortName": "SendPackets", + "fullName": "google.cloud.visionai.v1.StreamingService.SendPackets", + "mode": "BIDIRECTIONAL_STREAMING" + } + ] + }, + { + "shortName": "StreamsService", + "fullName": "google.cloud.visionai.v1.StreamsService", + "methods": [ + { + "shortName": "CreateCluster", + "fullName": "google.cloud.visionai.v1.StreamsService.CreateCluster", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v3beta1/{name=projects/*/locations/*/glossaries/*}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/clusters" } ] }, { - "shortName": "DetectLanguage", - "fullName": "google.cloud.translation.v3beta1.TranslationService.DetectLanguage", + "shortName": "CreateEvent", + "fullName": "google.cloud.visionai.v1.StreamsService.CreateEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}:detectLanguage" - }, - { - "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*}:detectLanguage" + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/events" } ] }, { - "shortName": "GetGlossary", - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetGlossary", + "shortName": "CreateSeries", + "fullName": "google.cloud.visionai.v1.StreamsService.CreateSeries", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3beta1/{name=projects/*/locations/*/glossaries/*}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/series" } ] }, { - "shortName": "GetSupportedLanguages", - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetSupportedLanguages", + "shortName": "CreateStream", + "fullName": "google.cloud.visionai.v1.StreamsService.CreateStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3beta1/{parent=projects/*/locations/*}/supportedLanguages" - }, - { - "httpMethod": "GET", - "path": "/v3beta1/{parent=projects/*}/supportedLanguages" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/streams" } ] }, { - "shortName": "ListGlossaries", - "fullName": "google.cloud.translation.v3beta1.TranslationService.ListGlossaries", + "shortName": "DeleteCluster", + "fullName": "google.cloud.visionai.v1.StreamsService.DeleteCluster", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v3beta1/{parent=projects/*/locations/*}/glossaries" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "TranslateDocument", - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateDocument", + "shortName": "DeleteEvent", + "fullName": "google.cloud.visionai.v1.StreamsService.DeleteEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}:translateDocument" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/clusters/*/events/*}" } ] }, { - "shortName": "TranslateText", - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateText", + "shortName": "DeleteSeries", + "fullName": "google.cloud.visionai.v1.StreamsService.DeleteSeries", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*/locations/*}:translateText" - }, - { - "httpMethod": "POST", - "path": "/v3beta1/{parent=projects/*}:translateText" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/clusters/*/series/*}" } ] - } - ] - } - ], - "configFile": "translate_v3beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.translation.v3beta1.TranslationService" - ] - }, - { - "id": "google.cloud.video.livestream.v1", - "directory": "google/cloud/video/livestream/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "livestream.googleapis.com", - "title": "Live Stream API", - "description": "", - "importDirectories": [ - "google/api", - "google/cloud/video/livestream/v1", - "google/longrunning", - "google/protobuf", - "google/rpc" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.Video.LiveStream.V1": 3 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/video/livestream/v1;livestream": 3 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 3 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.video.livestream.v1": 3 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\Video\\LiveStream\\V1": 3 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::Video::LiveStream::V1": 3 - } - } - }, - "services": [ - { - "shortName": "LivestreamService", - "fullName": "google.cloud.video.livestream.v1.LivestreamService", - "methods": [ + }, { - "shortName": "CreateChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateChannel", + "shortName": "DeleteStream", + "fullName": "google.cloud.visionai.v1.StreamsService.DeleteStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/channels" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/clusters/*/streams/*}" } ] }, { - "shortName": "CreateEvent", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateEvent", + "shortName": "GenerateStreamHlsToken", + "fullName": "google.cloud.visionai.v1.StreamsService.GenerateStreamHlsToken", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*/channels/*}/events" + "path": "/v1/{stream=projects/*/locations/*/clusters/*/streams/*}:generateStreamHlsToken" } ] }, { - "shortName": "CreateInput", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.CreateInput", + "shortName": "GetCluster", + "fullName": "google.cloud.visionai.v1.StreamsService.GetCluster", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/inputs" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "DeleteChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteChannel", + "shortName": "GetEvent", + "fullName": "google.cloud.visionai.v1.StreamsService.GetEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/channels/*}" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/clusters/*/events/*}" } ] }, { - "shortName": "DeleteEvent", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteEvent", + "shortName": "GetSeries", + "fullName": "google.cloud.visionai.v1.StreamsService.GetSeries", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/channels/*/events/*}" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/clusters/*/series/*}" } ] }, { - "shortName": "DeleteInput", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.DeleteInput", + "shortName": "GetStream", + "fullName": "google.cloud.visionai.v1.StreamsService.GetStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/inputs/*}" + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/clusters/*/streams/*}" } ] }, { - "shortName": "GetChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetChannel", + "shortName": "GetStreamThumbnail", + "fullName": "google.cloud.visionai.v1.StreamsService.GetStreamThumbnail", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/channels/*}" + "httpMethod": "POST", + "path": "/v1/{stream=projects/*/locations/*/clusters/*/streams/*}:getThumbnail" } ] }, { - "shortName": "GetEvent", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetEvent", + "shortName": "ListClusters", + "fullName": "google.cloud.visionai.v1.StreamsService.ListClusters", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/channels/*/events/*}" + "path": "/v1/{parent=projects/*/locations/*}/clusters" } ] }, { - "shortName": "GetInput", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.GetInput", + "shortName": "ListEvents", + "fullName": "google.cloud.visionai.v1.StreamsService.ListEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/inputs/*}" + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/events" } ] }, { - "shortName": "ListChannels", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListChannels", + "shortName": "ListSeries", + "fullName": "google.cloud.visionai.v1.StreamsService.ListSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/channels" + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/series" } ] }, { - "shortName": "ListEvents", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListEvents", + "shortName": "ListStreams", + "fullName": "google.cloud.visionai.v1.StreamsService.ListStreams", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/channels/*}/events" + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/streams" } ] }, { - "shortName": "ListInputs", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.ListInputs", + "shortName": "MaterializeChannel", + "fullName": "google.cloud.visionai.v1.StreamsService.MaterializeChannel", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/inputs" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/clusters/*}/channels" } ] }, { - "shortName": "StartChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.StartChannel", + "shortName": "UpdateCluster", + "fullName": "google.cloud.visionai.v1.StreamsService.UpdateCluster", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/channels/*}:start" + "httpMethod": "PATCH", + "path": "/v1/{cluster.name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "StopChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.StopChannel", + "shortName": "UpdateEvent", + "fullName": "google.cloud.visionai.v1.StreamsService.UpdateEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/channels/*}:stop" + "httpMethod": "PATCH", + "path": "/v1/{event.name=projects/*/locations/*/clusters/*/events/*}" } ] }, { - "shortName": "UpdateChannel", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.UpdateChannel", + "shortName": "UpdateSeries", + "fullName": "google.cloud.visionai.v1.StreamsService.UpdateSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1/{channel.name=projects/*/locations/*/channels/*}" + "path": "/v1/{series.name=projects/*/locations/*/clusters/*/series/*}" } ] }, { - "shortName": "UpdateInput", - "fullName": "google.cloud.video.livestream.v1.LivestreamService.UpdateInput", + "shortName": "UpdateStream", + "fullName": "google.cloud.visionai.v1.StreamsService.UpdateStream", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1/{input.name=projects/*/locations/*/inputs/*}" + "path": "/v1/{stream.name=projects/*/locations/*/clusters/*/streams/*}" } ] } ] - } - ], - "configFile": "livestream_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.video.livestream.v1.LivestreamService" - ] - }, - { - "id": "google.cloud.video.stitcher.v1", - "directory": "google/cloud/video/stitcher/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "videostitcher.googleapis.com", - "title": "Video Stitcher API", - "description": "", - "importDirectories": [ - "google/api", - "google/cloud/video/stitcher/v1", - "google/protobuf" - ], - "options": { - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/video/stitcher/v1;stitcher": 8 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 8 - } }, - "java_package": { - "valueCounts": { - "com.google.cloud.video.stitcher.v1": 8 - } - } - }, - "services": [ { - "shortName": "VideoStitcherService", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService", + "shortName": "Warehouse", + "fullName": "google.cloud.visionai.v1.Warehouse", "methods": [ { - "shortName": "CreateCdnKey", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateCdnKey", + "shortName": "ClipAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.ClipAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/cdnKeys" + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*}:clip" } ] }, { - "shortName": "CreateLiveSession", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateLiveSession", + "shortName": "CreateAnnotation", + "fullName": "google.cloud.visionai.v1.Warehouse.CreateAnnotation", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/liveSessions" + "path": "/v1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" } ] }, { - "shortName": "CreateSlate", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateSlate", + "shortName": "CreateAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.CreateAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/slates" + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/assets" } ] }, { - "shortName": "CreateVodSession", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.CreateVodSession", + "shortName": "CreateCorpus", + "fullName": "google.cloud.visionai.v1.Warehouse.CreateCorpus", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/vodSessions" + "path": "/v1/{parent=projects/*/locations/*}/corpora" } ] }, { - "shortName": "DeleteCdnKey", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.DeleteCdnKey", + "shortName": "CreateDataSchema", + "fullName": "google.cloud.visionai.v1.Warehouse.CreateDataSchema", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/cdnKeys/*}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" } ] }, { - "shortName": "DeleteSlate", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.DeleteSlate", + "shortName": "CreateSearchConfig", + "fullName": "google.cloud.visionai.v1.Warehouse.CreateSearchConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/slates/*}" + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" } ] }, { - "shortName": "GetCdnKey", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetCdnKey", + "shortName": "DeleteAnnotation", + "fullName": "google.cloud.visionai.v1.Warehouse.DeleteAnnotation", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/cdnKeys/*}" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "GetLiveAdTagDetail", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetLiveAdTagDetail", + "shortName": "DeleteAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.DeleteAsset", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/liveSessions/*/liveAdTagDetails/*}" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*}" } ] }, { - "shortName": "GetLiveSession", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetLiveSession", + "shortName": "DeleteCorpus", + "fullName": "google.cloud.visionai.v1.Warehouse.DeleteCorpus", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/liveSessions/*}" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/corpora/*}" } ] }, { - "shortName": "GetSlate", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetSlate", + "shortName": "DeleteDataSchema", + "fullName": "google.cloud.visionai.v1.Warehouse.DeleteDataSchema", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/slates/*}" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" } ] }, { - "shortName": "GetVodAdTagDetail", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodAdTagDetail", + "shortName": "DeleteSearchConfig", + "fullName": "google.cloud.visionai.v1.Warehouse.DeleteSearchConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/vodSessions/*/vodAdTagDetails/*}" + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] }, { - "shortName": "GetVodSession", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodSession", + "shortName": "GenerateHlsUri", + "fullName": "google.cloud.visionai.v1.Warehouse.GenerateHlsUri", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/vodSessions/*}" + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*}:generateHlsUri" } ] }, { - "shortName": "GetVodStitchDetail", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.GetVodStitchDetail", + "shortName": "GetAnnotation", + "fullName": "google.cloud.visionai.v1.Warehouse.GetAnnotation", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/vodSessions/*/vodStitchDetails/*}" + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "ListCdnKeys", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListCdnKeys", + "shortName": "GetAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.GetAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/cdnKeys" + "path": "/v1/{name=projects/*/locations/*/corpora/*/assets/*}" } ] }, { - "shortName": "ListLiveAdTagDetails", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListLiveAdTagDetails", + "shortName": "GetCorpus", + "fullName": "google.cloud.visionai.v1.Warehouse.GetCorpus", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/liveSessions/*}/liveAdTagDetails" + "path": "/v1/{name=projects/*/locations/*/corpora/*}" } ] }, { - "shortName": "ListSlates", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListSlates", + "shortName": "GetDataSchema", + "fullName": "google.cloud.visionai.v1.Warehouse.GetDataSchema", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/slates" + "path": "/v1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" } ] }, { - "shortName": "ListVodAdTagDetails", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListVodAdTagDetails", + "shortName": "GetSearchConfig", + "fullName": "google.cloud.visionai.v1.Warehouse.GetSearchConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/vodSessions/*}/vodAdTagDetails" + "path": "/v1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] }, { - "shortName": "ListVodStitchDetails", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.ListVodStitchDetails", + "shortName": "IngestAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.IngestAsset", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ListAnnotations", + "fullName": "google.cloud.visionai.v1.Warehouse.ListAnnotations", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/vodSessions/*}/vodStitchDetails" + "path": "/v1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" } ] }, { - "shortName": "UpdateCdnKey", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.UpdateCdnKey", + "shortName": "ListAssets", + "fullName": "google.cloud.visionai.v1.Warehouse.ListAssets", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{cdn_key.name=projects/*/locations/*/cdnKeys/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/assets" } ] }, { - "shortName": "UpdateSlate", - "fullName": "google.cloud.video.stitcher.v1.VideoStitcherService.UpdateSlate", + "shortName": "ListCorpora", + "fullName": "google.cloud.visionai.v1.Warehouse.ListCorpora", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{slate.name=projects/*/locations/*/slates/*}" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/corpora" } ] - } - ] - } - ], - "configFile": "videostitcher_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.video.stitcher.v1.VideoStitcherService" - ] - }, - { - "id": "google.cloud.video.transcoder.v1", - "directory": "google/cloud/video/transcoder/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "transcoder.googleapis.com", - "title": "Transcoder API", - "description": "This API converts video files into formats suitable for consumer distribution.", - "importDirectories": [ - "google/api", - "google/cloud/video/transcoder/v1", - "google/protobuf", - "google/rpc" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "": 1, - "Google.Cloud.Video.Transcoder.V1": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/video/transcoder/v1;transcoder": 2 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 2 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.video.transcoder.v1": 2 - } - }, - "php_namespace": { - "valueCounts": { - "": 1, - "Google\\Cloud\\Video\\Transcoder\\V1": 1 - } - }, - "ruby_package": { - "valueCounts": { - "": 1, - "Google::Cloud::Video::Transcoder::V1": 1 - } - } - }, - "services": [ - { - "shortName": "TranscoderService", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService", - "methods": [ + }, { - "shortName": "CreateJob", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.CreateJob", + "shortName": "ListDataSchemas", + "fullName": "google.cloud.visionai.v1.Warehouse.ListDataSchemas", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/jobs" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" } ] }, { - "shortName": "CreateJobTemplate", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.CreateJobTemplate", + "shortName": "ListSearchConfigs", + "fullName": "google.cloud.visionai.v1.Warehouse.ListSearchConfigs", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/jobTemplates" + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" } ] }, { - "shortName": "DeleteJob", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.DeleteJob", + "shortName": "SearchAssets", + "fullName": "google.cloud.visionai.v1.Warehouse.SearchAssets", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/jobs/*}" + "httpMethod": "POST", + "path": "/v1/{corpus=projects/*/locations/*/corpora/*}:searchAssets" } ] }, { - "shortName": "DeleteJobTemplate", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.DeleteJobTemplate", + "shortName": "UpdateAnnotation", + "fullName": "google.cloud.visionai.v1.Warehouse.UpdateAnnotation", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/jobTemplates/*}" + "httpMethod": "PATCH", + "path": "/v1/{annotation.name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "GetJob", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.GetJob", + "shortName": "UpdateAsset", + "fullName": "google.cloud.visionai.v1.Warehouse.UpdateAsset", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/jobs/*}" + "httpMethod": "PATCH", + "path": "/v1/{asset.name=projects/*/locations/*/corpora/*/assets/*}" } ] }, { - "shortName": "GetJobTemplate", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.GetJobTemplate", + "shortName": "UpdateCorpus", + "fullName": "google.cloud.visionai.v1.Warehouse.UpdateCorpus", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/jobTemplates/*}" + "httpMethod": "PATCH", + "path": "/v1/{corpus.name=projects/*/locations/*/corpora/*}" } ] }, { - "shortName": "ListJobTemplates", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.ListJobTemplates", + "shortName": "UpdateDataSchema", + "fullName": "google.cloud.visionai.v1.Warehouse.UpdateDataSchema", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/jobTemplates" + "httpMethod": "PATCH", + "path": "/v1/{data_schema.name=projects/*/locations/*/corpora/*/dataSchemas/*}" } ] }, { - "shortName": "ListJobs", - "fullName": "google.cloud.video.transcoder.v1.TranscoderService.ListJobs", + "shortName": "UpdateSearchConfig", + "fullName": "google.cloud.visionai.v1.Warehouse.UpdateSearchConfig", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/jobs" + "httpMethod": "PATCH", + "path": "/v1/{search_config.name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] } ] } ], - "configFile": "transcoder_v1.yaml", + "configFile": "visionai_v1.yaml", "serviceConfigApiNames": [ - "google.cloud.video.transcoder.v1.TranscoderService" - ] + "google.cloud.location.Locations", + "google.cloud.visionai.v1.AppPlatform", + "google.cloud.visionai.v1.LiveVideoAnalytics", + "google.cloud.visionai.v1.StreamingService", + "google.cloud.visionai.v1.StreamsService", + "google.cloud.visionai.v1.Warehouse", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "visionai.googleapis.com" }, { - "id": "google.cloud.videointelligence.v1", - "directory": "google/cloud/videointelligence/v1", - "version": "v1", + "id": "google.cloud.visionai.v1alpha1", + "directory": "google/cloud/visionai/v1alpha1", + "version": "v1alpha1", "majorVersion": "v1", - "hostName": "videointelligence.googleapis.com", - "title": "Cloud Video Intelligence API", - "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", + "hostName": "visionai.googleapis.com", + "title": "Vision AI API", + "description": "", "importDirectories": [ "google/api", + "google/cloud/visionai/v1alpha1", "google/longrunning", "google/protobuf", - "google/rpc" + "google/rpc", + "google/type" ], "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.VideoIntelligence.V1": 1 + "Google.Cloud.VisionAI.V1Alpha1": 11 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/videointelligence/v1;videointelligence": 1 + "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai": 11 } }, "java_multiple_files": { "valueCounts": { - "true": 1 + "true": 11 } }, "java_package": { "valueCounts": { - "com.google.cloud.videointelligence.v1": 1 + "com.google.cloud.visionai.v1alpha1": 11 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\VideoIntelligence\\V1": 1 + "Google\\Cloud\\VisionAI\\V1alpha1": 11 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::VideoIntelligence::V1": 1 + "Google::Cloud::VisionAI::V1alpha1": 11 } } }, "services": [ { - "shortName": "VideoIntelligenceService", - "fullName": "google.cloud.videointelligence.v1.VideoIntelligenceService", + "shortName": "AppPlatform", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform", "methods": [ { - "shortName": "AnnotateVideo", - "fullName": "google.cloud.videointelligence.v1.VideoIntelligenceService.AnnotateVideo", + "shortName": "AddApplicationStreamInput", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.AddApplicationStreamInput", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/videos:annotate" + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:addStreamInput" } ] - } - ] - } - ], - "configFile": "videointelligence_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.videointelligence.v1.VideoIntelligenceService" - ] - }, - { - "id": "google.cloud.videointelligence.v1p3beta1", - "directory": "google/cloud/videointelligence/v1p3beta1", - "version": "v1p3beta1", - "majorVersion": "v1", - "hostName": "videointelligence.googleapis.com", - "title": "Cloud Video Intelligence API", - "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", - "importDirectories": [ - "google/api", - "google/longrunning", - "google/protobuf", - "google/rpc" - ], - "options": { - "csharp_namespace": { - "valueCounts": { - "Google.Cloud.VideoIntelligence.V1P3Beta1": 1 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/videointelligence/v1p3beta1;videointelligence": 1 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 1 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.videointelligence.v1p3beta1": 1 - } - }, - "php_namespace": { - "valueCounts": { - "Google\\Cloud\\VideoIntelligence\\V1p3beta1": 1 - } - }, - "ruby_package": { - "valueCounts": { - "Google::Cloud::VideoIntelligence::V1p3beta1": 1 - } - } - }, - "services": [ - { - "shortName": "StreamingVideoIntelligenceService", - "fullName": "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService", - "methods": [ - { - "shortName": "StreamingAnnotateVideo", - "fullName": "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService.StreamingAnnotateVideo", - "mode": "BIDIRECTIONAL_STREAMING" - } - ] - }, - { - "shortName": "VideoIntelligenceService", - "fullName": "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService", - "methods": [ + }, { - "shortName": "AnnotateVideo", - "fullName": "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService.AnnotateVideo", + "shortName": "CreateApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.CreateApplication", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/videos:annotate" + "path": "/v1alpha1/{parent=projects/*/locations/*}/applications" } ] - } - ] - } - ], - "configFile": "videointelligence_v1p3beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceService", - "google.cloud.videointelligence.v1p3beta1.VideoIntelligenceService" - ] - }, - { - "id": "google.cloud.vision.v1", - "directory": "google/cloud/vision/v1", - "version": "v1", - "majorVersion": "v1", - "hostName": "vision.googleapis.com", - "title": "Cloud Vision API", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "importDirectories": [ - "google/api", - "google/cloud/vision/v1", - "google/longrunning", - "google/protobuf", - "google/rpc", - "google/type" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 6 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/vision/v1;vision": 6 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 6 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.vision.v1": 6 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GCVN": 6 - } - } - }, - "services": [ - { - "shortName": "ImageAnnotator", - "fullName": "google.cloud.vision.v1.ImageAnnotator", - "methods": [ + }, { - "shortName": "AsyncBatchAnnotateFiles", - "fullName": "google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateFiles", + "shortName": "CreateApplicationInstances", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.CreateApplicationInstances", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/files:asyncBatchAnnotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/files:asyncBatchAnnotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/files:asyncBatchAnnotate" + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:createApplicationInstances" } ] }, { - "shortName": "AsyncBatchAnnotateImages", - "fullName": "google.cloud.vision.v1.ImageAnnotator.AsyncBatchAnnotateImages", + "shortName": "CreateDraft", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.CreateDraft", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/images:asyncBatchAnnotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/images:asyncBatchAnnotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/images:asyncBatchAnnotate" + "path": "/v1alpha1/{parent=projects/*/locations/*/applications/*}/drafts" } ] }, { - "shortName": "BatchAnnotateFiles", - "fullName": "google.cloud.vision.v1.ImageAnnotator.BatchAnnotateFiles", + "shortName": "CreateProcessor", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.CreateProcessor", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/files:annotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/files:annotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/files:annotate" + "path": "/v1alpha1/{parent=projects/*/locations/*}/processors" } ] }, { - "shortName": "BatchAnnotateImages", - "fullName": "google.cloud.vision.v1.ImageAnnotator.BatchAnnotateImages", + "shortName": "DeleteApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.DeleteApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/images:annotate" - }, - { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/images:annotate" - }, + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}" + } + ] + }, + { + "shortName": "DeleteApplicationInstances", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.DeleteApplicationInstances", + "mode": "UNARY", + "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*}/images:annotate" + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:deleteApplicationInstances" } ] - } - ] - }, - { - "shortName": "ProductSearch", - "fullName": "google.cloud.vision.v1.ProductSearch", - "methods": [ + }, { - "shortName": "AddProductToProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.AddProductToProductSet", + "shortName": "DeleteDraft", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.DeleteDraft", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/productSets/*}:addProduct" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*/drafts/*}" } ] }, { - "shortName": "CreateProduct", - "fullName": "google.cloud.vision.v1.ProductSearch.CreateProduct", + "shortName": "DeleteProcessor", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.DeleteProcessor", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/products" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/processors/*}" } ] }, { - "shortName": "CreateProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.CreateProductSet", + "shortName": "DeployApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.DeployApplication", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/productSets" + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:deploy" } ] }, { - "shortName": "CreateReferenceImage", - "fullName": "google.cloud.vision.v1.ProductSearch.CreateReferenceImage", + "shortName": "GetApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.GetApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}" } ] }, { - "shortName": "DeleteProduct", - "fullName": "google.cloud.vision.v1.ProductSearch.DeleteProduct", + "shortName": "GetDraft", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.GetDraft", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/products/*}" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*/drafts/*}" } ] }, { - "shortName": "DeleteProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.DeleteProductSet", + "shortName": "GetInstance", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.GetInstance", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/productSets/*}" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*/instances/*}" } ] }, { - "shortName": "DeleteReferenceImage", - "fullName": "google.cloud.vision.v1.ProductSearch.DeleteReferenceImage", + "shortName": "GetProcessor", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.GetProcessor", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/processors/*}" } ] }, { - "shortName": "GetProduct", - "fullName": "google.cloud.vision.v1.ProductSearch.GetProduct", + "shortName": "ListApplications", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.ListApplications", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{parent=projects/*/locations/*}/applications" } ] }, { - "shortName": "GetProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.GetProductSet", + "shortName": "ListDrafts", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.ListDrafts", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{parent=projects/*/locations/*/applications/*}/drafts" } ] }, { - "shortName": "GetReferenceImage", - "fullName": "google.cloud.vision.v1.ProductSearch.GetReferenceImage", + "shortName": "ListInstances", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.ListInstances", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "path": "/v1alpha1/{parent=projects/*/locations/*/applications/*}/instances" } ] }, { - "shortName": "ImportProductSets", - "fullName": "google.cloud.vision.v1.ProductSearch.ImportProductSets", + "shortName": "ListPrebuiltProcessors", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.ListPrebuiltProcessors", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/productSets:import" + "path": "/v1alpha1/{parent=projects/*/locations/*}/processors:prebuilt" } ] }, { - "shortName": "ListProductSets", - "fullName": "google.cloud.vision.v1.ProductSearch.ListProductSets", + "shortName": "ListProcessors", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.ListProcessors", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/productSets" + "path": "/v1alpha1/{parent=projects/*/locations/*}/processors" } ] }, { - "shortName": "ListProducts", - "fullName": "google.cloud.vision.v1.ProductSearch.ListProducts", + "shortName": "RemoveApplicationStreamInput", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.RemoveApplicationStreamInput", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*}/products" + "httpMethod": "POST", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:removeStreamInput" } ] }, { - "shortName": "ListProductsInProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.ListProductsInProductSet", + "shortName": "UndeployApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UndeployApplication", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{name=projects/*/locations/*/productSets/*}/products" + "httpMethod": "POST", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:undeploy" + } + ] + }, + { + "shortName": "UpdateApplication", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UpdateApplication", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{application.name=projects/*/locations/*/applications/*}" + } + ] + }, + { + "shortName": "UpdateApplicationInstances", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UpdateApplicationInstances", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:updateApplicationInstances" + } + ] + }, + { + "shortName": "UpdateApplicationStreamInput", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UpdateApplicationStreamInput", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1alpha1/{name=projects/*/locations/*/applications/*}:updateStreamInput" + } + ] + }, + { + "shortName": "UpdateDraft", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UpdateDraft", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{draft.name=projects/*/locations/*/applications/*/drafts/*}" + } + ] + }, + { + "shortName": "UpdateProcessor", + "fullName": "google.cloud.visionai.v1alpha1.AppPlatform.UpdateProcessor", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{processor.name=projects/*/locations/*/processors/*}" } ] - }, + } + ] + }, + { + "shortName": "LiveVideoAnalytics", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "methods": [ { - "shortName": "ListReferenceImages", - "fullName": "google.cloud.vision.v1.ProductSearch.ListReferenceImages", + "shortName": "CreateAnalysis", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics.CreateAnalysis", "mode": "UNARY", "bindings": [ { - "httpMethod": "GET", - "path": "/v1/{parent=projects/*/locations/*/products/*}/referenceImages" + "httpMethod": "POST", + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/analyses" } ] }, { - "shortName": "PurgeProducts", - "fullName": "google.cloud.vision.v1.ProductSearch.PurgeProducts", + "shortName": "DeleteAnalysis", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics.DeleteAnalysis", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{parent=projects/*/locations/*}/products:purge" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/analyses/*}" } ] }, { - "shortName": "RemoveProductFromProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.RemoveProductFromProductSet", + "shortName": "GetAnalysis", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics.GetAnalysis", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1/{name=projects/*/locations/*/productSets/*}:removeProduct" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/analyses/*}" } ] }, { - "shortName": "UpdateProduct", - "fullName": "google.cloud.vision.v1.ProductSearch.UpdateProduct", + "shortName": "ListAnalyses", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics.ListAnalyses", "mode": "UNARY", "bindings": [ { - "httpMethod": "PATCH", - "path": "/v1/{product.name=projects/*/locations/*/products/*}" + "httpMethod": "GET", + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/analyses" } ] }, { - "shortName": "UpdateProductSet", - "fullName": "google.cloud.vision.v1.ProductSearch.UpdateProductSet", + "shortName": "UpdateAnalysis", + "fullName": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics.UpdateAnalysis", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1/{product_set.name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{analysis.name=projects/*/locations/*/clusters/*/analyses/*}" } ] } ] - } - ], - "configFile": "vision_v1.yaml", - "serviceConfigApiNames": [ - "google.cloud.vision.v1.ImageAnnotator", - "google.cloud.vision.v1.ProductSearch" - ] - }, - { - "id": "google.cloud.vision.v1p1beta1", - "directory": "google/cloud/vision/v1p1beta1", - "version": "v1p1beta1", - "majorVersion": "v1", - "hostName": "vision.googleapis.com", - "title": "Cloud Vision API", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "importDirectories": [ - "google/api", - "google/cloud/vision/v1p1beta1", - "google/rpc", - "google/type" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 4 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/vision/v1p1beta1;vision": 4 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 4 - } }, - "java_package": { - "valueCounts": { - "com.google.cloud.vision.v1p1beta1": 4 - } - } - }, - "services": [ { - "shortName": "ImageAnnotator", - "fullName": "google.cloud.vision.v1p1beta1.ImageAnnotator", + "shortName": "StreamingService", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService", "methods": [ { - "shortName": "BatchAnnotateImages", - "fullName": "google.cloud.vision.v1p1beta1.ImageAnnotator.BatchAnnotateImages", + "shortName": "AcquireLease", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.AcquireLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p1beta1/images:annotate" + "path": "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:acquireLease" } ] - } - ] - } - ], - "configFile": "vision_v1p1beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.vision.v1p1beta1.ImageAnnotator" - ] - }, - { - "id": "google.cloud.vision.v1p2beta1", - "directory": "google/cloud/vision/v1p2beta1", - "version": "v1p2beta1", - "majorVersion": "v1", - "hostName": "vision.googleapis.com", - "title": "Cloud Vision API", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "importDirectories": [ - "google/api", - "google/cloud/vision/v1p2beta1", - "google/longrunning", - "google/protobuf", - "google/rpc", - "google/type" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 4 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/vision/v1p2beta1;vision": 4 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 4 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.vision.v1p2beta1": 4 - } - } - }, - "services": [ - { - "shortName": "ImageAnnotator", - "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator", - "methods": [ + }, { - "shortName": "AsyncBatchAnnotateFiles", - "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator.AsyncBatchAnnotateFiles", + "shortName": "ReceiveEvents", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.ReceiveEvents", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ReceivePackets", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.ReceivePackets", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ReleaseLease", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.ReleaseLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p2beta1/files:asyncBatchAnnotate" + "path": "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:releaseLease" } ] }, { - "shortName": "BatchAnnotateImages", - "fullName": "google.cloud.vision.v1p2beta1.ImageAnnotator.BatchAnnotateImages", + "shortName": "RenewLease", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.RenewLease", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p2beta1/images:annotate" + "path": "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:renewLease" } ] + }, + { + "shortName": "SendPackets", + "fullName": "google.cloud.visionai.v1alpha1.StreamingService.SendPackets", + "mode": "BIDIRECTIONAL_STREAMING" } ] - } - ], - "configFile": "vision_v1p2beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.vision.v1p2beta1.ImageAnnotator" - ] - }, - { - "id": "google.cloud.vision.v1p3beta1", - "directory": "google/cloud/vision/v1p3beta1", - "version": "v1p3beta1", - "majorVersion": "v1", - "hostName": "vision.googleapis.com", - "title": "Cloud Vision API", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "importDirectories": [ - "google/api", - "google/cloud/vision/v1p3beta1", - "google/longrunning", - "google/protobuf", - "google/rpc", - "google/type" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 6 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/vision/v1p3beta1;vision": 6 - } - }, - "java_multiple_files": { - "valueCounts": { - "true": 6 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.vision.v1p3beta1": 6 - } }, - "objc_class_prefix": { - "valueCounts": { - "": 4, - "GCVN": 2 - } - } - }, - "services": [ { - "shortName": "ImageAnnotator", - "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator", + "shortName": "StreamsService", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService", "methods": [ { - "shortName": "AsyncBatchAnnotateFiles", - "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator.AsyncBatchAnnotateFiles", + "shortName": "CreateCluster", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.CreateCluster", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/files:asyncBatchAnnotate" + "path": "/v1alpha1/{parent=projects/*/locations/*}/clusters" } ] }, { - "shortName": "BatchAnnotateImages", - "fullName": "google.cloud.vision.v1p3beta1.ImageAnnotator.BatchAnnotateImages", + "shortName": "CreateEvent", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.CreateEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/images:annotate" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/events" } ] - } - ] - }, - { - "shortName": "ProductSearch", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch", - "methods": [ + }, { - "shortName": "AddProductToProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.AddProductToProductSet", + "shortName": "CreateSeries", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.CreateSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:addProduct" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/series" } ] }, { - "shortName": "CreateProduct", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateProduct", + "shortName": "CreateStream", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.CreateStream", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/{parent=projects/*/locations/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/streams" } ] }, { - "shortName": "CreateProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateProductSet", + "shortName": "DeleteCluster", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.DeleteCluster", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "CreateReferenceImage", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.CreateReferenceImage", + "shortName": "DeleteEvent", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.DeleteEvent", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/events/*}" } ] }, { - "shortName": "DeleteProduct", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteProduct", + "shortName": "DeleteSeries", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.DeleteSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1p3beta1/{name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/series/*}" } ] }, { - "shortName": "DeleteProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteProductSet", + "shortName": "DeleteStream", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.DeleteStream", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/streams/*}" } ] }, { - "shortName": "DeleteReferenceImage", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.DeleteReferenceImage", + "shortName": "GenerateStreamHlsToken", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.GenerateStreamHlsToken", "mode": "UNARY", "bindings": [ { - "httpMethod": "DELETE", - "path": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "httpMethod": "POST", + "path": "/v1alpha1/{stream=projects/*/locations/*/clusters/*/streams/*}:generateStreamHlsToken" } ] }, { - "shortName": "GetProduct", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetProduct", + "shortName": "GetCluster", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.GetCluster", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "GetProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetProductSet", + "shortName": "GetEvent", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.GetEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/events/*}" } ] }, { - "shortName": "GetReferenceImage", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.GetReferenceImage", + "shortName": "GetSeries", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.GetSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/series/*}" } ] }, { - "shortName": "ImportProductSets", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ImportProductSets", + "shortName": "GetStream", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.GetStream", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets:import" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/clusters/*/streams/*}" } ] }, { - "shortName": "ListProductSets", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProductSets", + "shortName": "ListClusters", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.ListClusters", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{parent=projects/*/locations/*}/productSets" + "path": "/v1alpha1/{parent=projects/*/locations/*}/clusters" } ] }, { - "shortName": "ListProducts", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProducts", + "shortName": "ListEvents", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.ListEvents", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{parent=projects/*/locations/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/events" } ] }, { - "shortName": "ListProductsInProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListProductsInProductSet", + "shortName": "ListSeries", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.ListSeries", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/series" } ] }, { - "shortName": "ListReferenceImages", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.ListReferenceImages", + "shortName": "ListStreams", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.ListStreams", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/streams" } ] }, { - "shortName": "RemoveProductFromProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.RemoveProductFromProductSet", + "shortName": "MaterializeChannel", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.MaterializeChannel", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" + "path": "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/channels" } ] }, { - "shortName": "UpdateProduct", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.UpdateProduct", + "shortName": "UpdateCluster", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.UpdateCluster", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1p3beta1/{product.name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{cluster.name=projects/*/locations/*/clusters/*}" } ] }, { - "shortName": "UpdateProductSet", - "fullName": "google.cloud.vision.v1p3beta1.ProductSearch.UpdateProductSet", + "shortName": "UpdateEvent", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.UpdateEvent", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1p3beta1/{product_set.name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{event.name=projects/*/locations/*/clusters/*/events/*}" + } + ] + }, + { + "shortName": "UpdateSeries", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.UpdateSeries", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{series.name=projects/*/locations/*/clusters/*/series/*}" + } + ] + }, + { + "shortName": "UpdateStream", + "fullName": "google.cloud.visionai.v1alpha1.StreamsService.UpdateStream", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{stream.name=projects/*/locations/*/clusters/*/streams/*}" } ] } ] - } - ], - "configFile": "vision_v1p3beta1.yaml", - "serviceConfigApiNames": [ - "google.cloud.vision.v1p3beta1.ImageAnnotator", - "google.cloud.vision.v1p3beta1.ProductSearch" - ] - }, - { - "id": "google.cloud.vision.v1p4beta1", - "directory": "google/cloud/vision/v1p4beta1", - "version": "v1p4beta1", - "majorVersion": "v1", - "hostName": "vision.googleapis.com", - "title": "Cloud Vision API", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "importDirectories": [ - "google/api", - "google/cloud/vision/v1p4beta1", - "google/longrunning", - "google/protobuf", - "google/rpc", - "google/type" - ], - "options": { - "cc_enable_arenas": { - "valueCounts": { - "true": 7 - } - }, - "go_package": { - "valueCounts": { - "google.golang.org/genproto/googleapis/cloud/vision/v1p4beta1;vision": 7 - } }, - "java_multiple_files": { - "valueCounts": { - "true": 7 - } - }, - "java_package": { - "valueCounts": { - "com.google.cloud.vision.v1p4beta1": 7 - } - }, - "objc_class_prefix": { - "valueCounts": { - "GCVN": 7 - } - } - }, - "services": [ { - "shortName": "ImageAnnotator", - "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator", + "shortName": "Warehouse", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse", "methods": [ { - "shortName": "AsyncBatchAnnotateFiles", - "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.AsyncBatchAnnotateFiles", + "shortName": "ClipAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ClipAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/files:asyncBatchAnnotate" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}:clip" } ] }, { - "shortName": "AsyncBatchAnnotateImages", - "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.AsyncBatchAnnotateImages", + "shortName": "CreateAnnotation", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.CreateAnnotation", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/images:asyncBatchAnnotate" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" } ] }, { - "shortName": "BatchAnnotateFiles", - "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.BatchAnnotateFiles", + "shortName": "CreateAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.CreateAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/files:annotate" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/assets" } ] }, { - "shortName": "BatchAnnotateImages", - "fullName": "google.cloud.vision.v1p4beta1.ImageAnnotator.BatchAnnotateImages", + "shortName": "CreateCorpus", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.CreateCorpus", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/images:annotate" + "path": "/v1alpha1/{parent=projects/*/locations/*}/corpora" } ] - } - ] - }, - { - "shortName": "ProductSearch", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch", - "methods": [ + }, { - "shortName": "AddProductToProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.AddProductToProductSet", + "shortName": "CreateDataSchema", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.CreateDataSchema", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:addProduct" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" } ] }, { - "shortName": "CreateProduct", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateProduct", + "shortName": "CreateSearchConfig", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.CreateSearchConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" } ] }, { - "shortName": "CreateProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateProductSet", + "shortName": "DeleteAnnotation", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.DeleteAnnotation", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "CreateReferenceImage", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.CreateReferenceImage", + "shortName": "DeleteAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.DeleteAsset", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + "httpMethod": "DELETE", + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}" } ] }, { - "shortName": "DeleteProduct", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteProduct", + "shortName": "DeleteCorpus", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.DeleteCorpus", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1p4beta1/{name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*}" } ] }, { - "shortName": "DeleteProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteProductSet", + "shortName": "DeleteDataSchema", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.DeleteDataSchema", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" } ] }, { - "shortName": "DeleteReferenceImage", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.DeleteReferenceImage", + "shortName": "DeleteSearchConfig", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.DeleteSearchConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "DELETE", - "path": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] }, { - "shortName": "GetProduct", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetProduct", + "shortName": "GenerateHlsUri", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GenerateHlsUri", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}:generateHlsUri" + } + ] + }, + { + "shortName": "GetAnnotation", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GetAnnotation", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "GetProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetProductSet", + "shortName": "GetAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GetAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}" } ] }, { - "shortName": "GetReferenceImage", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.GetReferenceImage", + "shortName": "GetCorpus", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GetCorpus", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*}" } ] }, { - "shortName": "ImportProductSets", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ImportProductSets", + "shortName": "GetDataSchema", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GetDataSchema", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets:import" + "httpMethod": "GET", + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" } ] }, { - "shortName": "ListProductSets", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProductSets", + "shortName": "GetSearchConfig", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.GetSearchConfig", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/productSets" + "path": "/v1alpha1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] }, { - "shortName": "ListProducts", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProducts", + "shortName": "IngestAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.IngestAsset", + "mode": "BIDIRECTIONAL_STREAMING" + }, + { + "shortName": "ListAnnotations", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ListAnnotations", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" } ] }, { - "shortName": "ListProductsInProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListProductsInProductSet", + "shortName": "ListAssets", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ListAssets", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}/products" + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/assets" } ] }, { - "shortName": "ListReferenceImages", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.ListReferenceImages", + "shortName": "ListCorpora", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ListCorpora", "mode": "UNARY", "bindings": [ { "httpMethod": "GET", - "path": "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages" + "path": "/v1alpha1/{parent=projects/*/locations/*}/corpora" } ] }, { - "shortName": "PurgeProducts", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.PurgeProducts", + "shortName": "ListDataSchemas", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ListDataSchemas", "mode": "UNARY", "bindings": [ { - "httpMethod": "POST", - "path": "/v1p4beta1/{parent=projects/*/locations/*}/products:purge" + "httpMethod": "GET", + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" } ] }, { - "shortName": "RemoveProductFromProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.RemoveProductFromProductSet", + "shortName": "ListSearchConfigs", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.ListSearchConfigs", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" + } + ] + }, + { + "shortName": "SearchAssets", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.SearchAssets", "mode": "UNARY", "bindings": [ { "httpMethod": "POST", - "path": "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:removeProduct" + "path": "/v1alpha1/{corpus=projects/*/locations/*/corpora/*}:searchAssets" } ] }, { - "shortName": "UpdateProduct", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.UpdateProduct", + "shortName": "UpdateAnnotation", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.UpdateAnnotation", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1p4beta1/{product.name=projects/*/locations/*/products/*}" + "path": "/v1alpha1/{annotation.name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" } ] }, { - "shortName": "UpdateProductSet", - "fullName": "google.cloud.vision.v1p4beta1.ProductSearch.UpdateProductSet", + "shortName": "UpdateAsset", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.UpdateAsset", "mode": "UNARY", "bindings": [ { "httpMethod": "PATCH", - "path": "/v1p4beta1/{product_set.name=projects/*/locations/*/productSets/*}" + "path": "/v1alpha1/{asset.name=projects/*/locations/*/corpora/*/assets/*}" + } + ] + }, + { + "shortName": "UpdateCorpus", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.UpdateCorpus", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{corpus.name=projects/*/locations/*/corpora/*}" + } + ] + }, + { + "shortName": "UpdateDataSchema", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.UpdateDataSchema", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{data_schema.name=projects/*/locations/*/corpora/*/dataSchemas/*}" + } + ] + }, + { + "shortName": "UpdateSearchConfig", + "fullName": "google.cloud.visionai.v1alpha1.Warehouse.UpdateSearchConfig", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1alpha1/{search_config.name=projects/*/locations/*/corpora/*/searchConfigs/*}" } ] } ] } ], - "configFile": "vision_v1p4beta1.yaml", + "configFile": "visionai_v1alpha1.yaml", "serviceConfigApiNames": [ - "google.cloud.vision.v1p4beta1.ImageAnnotator", - "google.cloud.vision.v1p4beta1.ProductSearch" - ] + "google.cloud.location.Locations", + "google.cloud.visionai.v1alpha1.AppPlatform", + "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "google.cloud.visionai.v1alpha1.StreamingService", + "google.cloud.visionai.v1alpha1.StreamsService", + "google.cloud.visionai.v1alpha1.Warehouse", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "visionai.googleapis.com" }, { "id": "google.cloud.vmmigration.v1", @@ -75503,7 +78296,411 @@ "configFile": "vmmigration_v1.yaml", "serviceConfigApiNames": [ "google.cloud.vmmigration.v1.VmMigration" - ] + ], + "nameInServiceConfig": "vmmigration.googleapis.com" + }, + { + "id": "google.cloud.vmwareengine.v1", + "directory": "google/cloud/vmwareengine/v1", + "version": "v1", + "majorVersion": "v1", + "hostName": "vmwareengine.googleapis.com", + "title": "VMware Engine API", + "description": "The Google VMware Engine API lets you programmatically manage VMware environments.", + "importDirectories": [ + "google/api", + "google/longrunning", + "google/protobuf" + ], + "options": { + "csharp_namespace": { + "valueCounts": { + "Google.Cloud.VmwareEngine.V1": 1 + } + }, + "go_package": { + "valueCounts": { + "google.golang.org/genproto/googleapis/cloud/vmwareengine/v1;vmwareengine": 1 + } + }, + "java_multiple_files": { + "valueCounts": { + "true": 1 + } + }, + "java_package": { + "valueCounts": { + "com.google.cloud.vmwareengine.v1": 1 + } + }, + "php_namespace": { + "valueCounts": { + "Google\\Cloud\\VmwareEngine\\V1": 1 + } + }, + "ruby_package": { + "valueCounts": { + "Google::Cloud::VmwareEngine::V1": 1 + } + } + }, + "services": [ + { + "shortName": "VmwareEngine", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine", + "methods": [ + { + "shortName": "CreateCluster", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.CreateCluster", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters" + } + ] + }, + { + "shortName": "CreateHcxActivationKey", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.CreateHcxActivationKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys" + } + ] + }, + { + "shortName": "CreateNetworkPolicy", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.CreateNetworkPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/networkPolicies" + } + ] + }, + { + "shortName": "CreatePrivateCloud", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.CreatePrivateCloud", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/privateClouds" + } + ] + }, + { + "shortName": "CreateVmwareEngineNetwork", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.CreateVmwareEngineNetwork", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{parent=projects/*/locations/*}/vmwareEngineNetworks" + } + ] + }, + { + "shortName": "DeleteCluster", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.DeleteCluster", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}" + } + ] + }, + { + "shortName": "DeleteNetworkPolicy", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.DeleteNetworkPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/networkPolicies/*}" + } + ] + }, + { + "shortName": "DeletePrivateCloud", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.DeletePrivateCloud", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*}" + } + ] + }, + { + "shortName": "DeleteVmwareEngineNetwork", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.DeleteVmwareEngineNetwork", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "DELETE", + "path": "/v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}" + } + ] + }, + { + "shortName": "GetCluster", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetCluster", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}" + } + ] + }, + { + "shortName": "GetHcxActivationKey", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetHcxActivationKey", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}" + } + ] + }, + { + "shortName": "GetNetworkPolicy", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetNetworkPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/networkPolicies/*}" + } + ] + }, + { + "shortName": "GetNodeType", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetNodeType", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/nodeTypes/*}" + } + ] + }, + { + "shortName": "GetPrivateCloud", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetPrivateCloud", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*}" + } + ] + }, + { + "shortName": "GetVmwareEngineNetwork", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.GetVmwareEngineNetwork", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}" + } + ] + }, + { + "shortName": "ListClusters", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListClusters", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters" + } + ] + }, + { + "shortName": "ListHcxActivationKeys", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys" + } + ] + }, + { + "shortName": "ListNetworkPolicies", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPolicies", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/networkPolicies" + } + ] + }, + { + "shortName": "ListNodeTypes", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListNodeTypes", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/nodeTypes" + } + ] + }, + { + "shortName": "ListPrivateClouds", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateClouds", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/privateClouds" + } + ] + }, + { + "shortName": "ListSubnets", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListSubnets", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*/privateClouds/*}/subnets" + } + ] + }, + { + "shortName": "ListVmwareEngineNetworks", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ListVmwareEngineNetworks", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{parent=projects/*/locations/*}/vmwareEngineNetworks" + } + ] + }, + { + "shortName": "ResetNsxCredentials", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ResetNsxCredentials", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:resetNsxCredentials" + } + ] + }, + { + "shortName": "ResetVcenterCredentials", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ResetVcenterCredentials", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:resetVcenterCredentials" + } + ] + }, + { + "shortName": "ShowNsxCredentials", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ShowNsxCredentials", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:showNsxCredentials" + } + ] + }, + { + "shortName": "ShowVcenterCredentials", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.ShowVcenterCredentials", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "GET", + "path": "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:showVcenterCredentials" + } + ] + }, + { + "shortName": "UndeletePrivateCloud", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{name=projects/*/locations/*/privateClouds/*}:undelete" + } + ] + }, + { + "shortName": "UpdateCluster", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.UpdateCluster", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{cluster.name=projects/*/locations/*/privateClouds/*/clusters/*}" + } + ] + }, + { + "shortName": "UpdateNetworkPolicy", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.UpdateNetworkPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{network_policy.name=projects/*/locations/*/networkPolicies/*}" + } + ] + }, + { + "shortName": "UpdatePrivateCloud", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.UpdatePrivateCloud", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{private_cloud.name=projects/*/locations/*/privateClouds/*}" + } + ] + }, + { + "shortName": "UpdateVmwareEngineNetwork", + "fullName": "google.cloud.vmwareengine.v1.VmwareEngine.UpdateVmwareEngineNetwork", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "PATCH", + "path": "/v1/{vmware_engine_network.name=projects/*/locations/*/vmwareEngineNetworks/*}" + } + ] + } + ] + } + ], + "configFile": "vmwareengine_v1.yaml", + "serviceConfigApiNames": [ + "google.cloud.location.Locations", + "google.cloud.vmwareengine.v1.VmwareEngine", + "google.iam.v1.IAMPolicy", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "vmwareengine.googleapis.com" }, { "id": "google.cloud.vpcaccess.v1", @@ -75607,7 +78804,8 @@ "google.cloud.location.Locations", "google.cloud.vpcaccess.v1.VpcAccessService", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "vpcaccess.googleapis.com" }, { "id": "google.cloud.webrisk.v1", @@ -75713,7 +78911,8 @@ "configFile": "webrisk_v1.yaml", "serviceConfigApiNames": [ "google.cloud.webrisk.v1.WebRiskService" - ] + ], + "nameInServiceConfig": "webrisk.googleapis.com" }, { "id": "google.cloud.webrisk.v1beta1", @@ -75808,7 +79007,8 @@ "configFile": "webrisk_v1beta1.yaml", "serviceConfigApiNames": [ "google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1" - ] + ], + "nameInServiceConfig": "webrisk.googleapis.com" }, { "id": "google.cloud.websecurityscanner.v1", @@ -76009,7 +79209,8 @@ "configFile": "websecurityscanner_v1.yaml", "serviceConfigApiNames": [ "google.cloud.websecurityscanner.v1.WebSecurityScanner" - ] + ], + "nameInServiceConfig": "websecurityscanner.googleapis.com" }, { "id": "google.cloud.websecurityscanner.v1alpha", @@ -76195,7 +79396,8 @@ "configFile": "websecurityscanner_v1alpha.yaml", "serviceConfigApiNames": [ "google.cloud.websecurityscanner.v1alpha.WebSecurityScanner" - ] + ], + "nameInServiceConfig": "websecurityscanner.googleapis.com" }, { "id": "google.cloud.websecurityscanner.v1beta", @@ -76396,7 +79598,8 @@ "configFile": "websecurityscanner_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.websecurityscanner.v1beta.WebSecurityScanner" - ] + ], + "nameInServiceConfig": "websecurityscanner.googleapis.com" }, { "id": "google.cloud.workflows.executions.v1", @@ -76482,7 +79685,8 @@ "configFile": "workflowexecutions_v1.yaml", "serviceConfigApiNames": [ "google.cloud.workflows.executions.v1.Executions" - ] + ], + "nameInServiceConfig": "workflowexecutions.googleapis.com" }, { "id": "google.cloud.workflows.executions.v1beta", @@ -76568,7 +79772,8 @@ "configFile": "workflowexecutions_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.workflows.executions.v1beta.Executions" - ] + ], + "nameInServiceConfig": "workflowexecutions.googleapis.com" }, { "id": "google.cloud.workflows.v1", @@ -76666,7 +79871,8 @@ "configFile": "workflows_v1.yaml", "serviceConfigApiNames": [ "google.cloud.workflows.v1.Workflows" - ] + ], + "nameInServiceConfig": "workflows.googleapis.com" }, { "id": "google.cloud.workflows.v1beta", @@ -76764,7 +79970,8 @@ "configFile": "workflows_v1beta.yaml", "serviceConfigApiNames": [ "google.cloud.workflows.v1beta.Workflows" - ] + ], + "nameInServiceConfig": "workflows.googleapis.com" }, { "id": "google.container.v1", @@ -77305,7 +80512,8 @@ "configFile": "container_v1.yaml", "serviceConfigApiNames": [ "google.container.v1.ClusterManager" - ] + ], + "nameInServiceConfig": "container.googleapis.com" }, { "id": "google.container.v1beta1", @@ -77858,7 +81066,8 @@ "configFile": "container_v1beta1.yaml", "serviceConfigApiNames": [ "google.container.v1beta1.ClusterManager" - ] + ], + "nameInServiceConfig": "container.googleapis.com" }, { "id": "google.dataflow.v1beta3", @@ -78200,7 +81409,8 @@ "google.dataflow.v1beta3.MetricsV1Beta3", "google.dataflow.v1beta3.SnapshotsV1Beta3", "google.dataflow.v1beta3.TemplatesService" - ] + ], + "nameInServiceConfig": "dataflow.googleapis.com" }, { "id": "google.datastore.admin.v1", @@ -78326,7 +81536,8 @@ "serviceConfigApiNames": [ "google.datastore.admin.v1.DatastoreAdmin", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "datastore.googleapis.com" }, { "id": "google.datastore.v1", @@ -78345,32 +81556,32 @@ "options": { "csharp_namespace": { "valueCounts": { - "Google.Cloud.Datastore.V1": 3 + "Google.Cloud.Datastore.V1": 4 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/datastore/v1;datastore": 3 + "google.golang.org/genproto/googleapis/datastore/v1;datastore": 4 } }, "java_multiple_files": { "valueCounts": { - "true": 3 + "true": 4 } }, "java_package": { "valueCounts": { - "com.google.datastore.v1": 3 + "com.google.datastore.v1": 4 } }, "php_namespace": { "valueCounts": { - "Google\\Cloud\\Datastore\\V1": 3 + "Google\\Cloud\\Datastore\\V1": 4 } }, "ruby_package": { "valueCounts": { - "Google::Cloud::Datastore::V1": 3 + "Google::Cloud::Datastore::V1": 4 } } }, @@ -78445,6 +81656,17 @@ } ] }, + { + "shortName": "RunAggregationQuery", + "fullName": "google.datastore.v1.Datastore.RunAggregationQuery", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/projects/{project_id}:runAggregationQuery" + } + ] + }, { "shortName": "RunQuery", "fullName": "google.datastore.v1.Datastore.RunQuery", @@ -78463,7 +81685,8 @@ "serviceConfigApiNames": [ "google.datastore.v1.Datastore", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "datastore.googleapis.com" }, { "id": "google.devtools.artifactregistry.v1", @@ -78821,7 +82044,8 @@ "configFile": "artifactregistry_v1.yaml", "serviceConfigApiNames": [ "google.devtools.artifactregistry.v1.ArtifactRegistry" - ] + ], + "nameInServiceConfig": "artifactregistry.googleapis.com" }, { "id": "google.devtools.artifactregistry.v1beta2", @@ -79157,7 +82381,8 @@ "configFile": "artifactregistry_v1beta2.yaml", "serviceConfigApiNames": [ "google.devtools.artifactregistry.v1beta2.ArtifactRegistry" - ] + ], + "nameInServiceConfig": "artifactregistry.googleapis.com" }, { "id": "google.devtools.build.v1", @@ -79240,7 +82465,8 @@ "configFile": "buildeventservice_v1.yaml", "serviceConfigApiNames": [ "google.devtools.build.v1.PublishBuildEvent" - ] + ], + "nameInServiceConfig": "buildeventservice.googleapis.com" }, { "id": "google.devtools.cloudbuild.v1", @@ -79548,7 +82774,8 @@ "configFile": "cloudbuild_v1.yaml", "serviceConfigApiNames": [ "google.devtools.cloudbuild.v1.CloudBuild" - ] + ], + "nameInServiceConfig": "cloudbuild.googleapis.com" }, { "id": "google.devtools.clouddebugger.v2", @@ -79708,7 +82935,8 @@ "serviceConfigApiNames": [ "google.devtools.clouddebugger.v2.Controller2", "google.devtools.clouddebugger.v2.Debugger2" - ] + ], + "nameInServiceConfig": "clouddebugger.googleapis.com" }, { "id": "google.devtools.clouderrorreporting.v1beta1", @@ -79851,7 +83079,8 @@ "google.devtools.clouderrorreporting.v1beta1.ErrorGroupService", "google.devtools.clouderrorreporting.v1beta1.ErrorStatsService", "google.devtools.clouderrorreporting.v1beta1.ReportErrorsService" - ] + ], + "nameInServiceConfig": "clouderrorreporting.googleapis.com" }, { "id": "google.devtools.cloudprofiler.v2", @@ -79941,7 +83170,8 @@ "configFile": "cloudprofiler_v2.yaml", "serviceConfigApiNames": [ "google.devtools.cloudprofiler.v2.ProfilerService" - ] + ], + "nameInServiceConfig": "cloudprofiler.googleapis.com" }, { "id": "google.devtools.cloudtrace.v1", @@ -80031,7 +83261,8 @@ "configFile": "cloudtrace_v1.yaml", "serviceConfigApiNames": [ "google.devtools.cloudtrace.v1.TraceService" - ] + ], + "nameInServiceConfig": "cloudtrace.googleapis.com" }, { "id": "google.devtools.cloudtrace.v2", @@ -80112,7 +83343,8 @@ "configFile": "cloudtrace_v2.yaml", "serviceConfigApiNames": [ "google.devtools.cloudtrace.v2.TraceService" - ] + ], + "nameInServiceConfig": "cloudtrace.googleapis.com" }, { "id": "google.devtools.containeranalysis.v1", @@ -80231,7 +83463,8 @@ "configFile": "containeranalysis_v1.yaml", "serviceConfigApiNames": [ "google.devtools.containeranalysis.v1.ContainerAnalysis" - ] + ], + "nameInServiceConfig": "containeranalysis.googleapis.com" }, { "id": "google.devtools.containeranalysis.v1beta1", @@ -80564,7 +83797,8 @@ "configFile": "containeranalysis_v1beta1.yaml", "serviceConfigApiNames": [ "google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1" - ] + ], + "nameInServiceConfig": "containeranalysis.googleapis.com" }, { "id": "google.devtools.remoteworkers.v1test2", @@ -80645,7 +83879,8 @@ "configFile": "remoteworkers_v1beta2.yaml", "serviceConfigApiNames": [ "google.devtools.remoteworkers.v1test2.Bots" - ] + ], + "nameInServiceConfig": "remoteworkers.googleapis.com" }, { "id": "google.devtools.resultstore.v2", @@ -81179,7 +84414,8 @@ "google.devtools.resultstore.v2.ResultStoreDownload", "google.devtools.resultstore.v2.ResultStoreFileDownload", "google.devtools.resultstore.v2.ResultStoreUpload" - ] + ], + "nameInServiceConfig": "resultstore.googleapis.com" }, { "id": "google.devtools.testing.v1", @@ -81292,7 +84528,8 @@ "google.devtools.testing.v1.ApplicationDetailService", "google.devtools.testing.v1.TestEnvironmentDiscoveryService", "google.devtools.testing.v1.TestExecutionService" - ] + ], + "nameInServiceConfig": "testing.googleapis.com" }, { "id": "google.firestore.admin.v1", @@ -81490,7 +84727,8 @@ "google.cloud.location.Locations", "google.firestore.admin.v1.FirestoreAdmin", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "firestore.googleapis.com" }, { "id": "google.firestore.v1", @@ -81754,7 +84992,8 @@ "google.cloud.location.Locations", "google.firestore.v1.Firestore", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "firestore.googleapis.com" }, { "id": "google.firestore.v1beta1", @@ -81996,7 +85235,8 @@ "configFile": "firestore_v1beta1.yaml", "serviceConfigApiNames": [ "google.firestore.v1beta1.Firestore" - ] + ], + "nameInServiceConfig": "firestore.googleapis.com" }, { "id": "google.home.enterprise.sdm.v1", @@ -82131,7 +85371,8 @@ "configFile": "smartdevicemanagement_v1.yaml", "serviceConfigApiNames": [ "google.home.enterprise.sdm.v1.SmartDeviceManagementService" - ] + ], + "nameInServiceConfig": "smartdevicemanagement.googleapis.com" }, { "id": "google.home.graph.v1", @@ -82229,7 +85470,8 @@ "configFile": "homegraph_v1.yaml", "serviceConfigApiNames": [ "google.home.graph.v1.HomeGraphApiService" - ] + ], + "nameInServiceConfig": "homegraph.googleapis.com" }, { "id": "google.iam.admin.v1", @@ -82662,7 +85904,8 @@ "configFile": "iam.yaml", "serviceConfigApiNames": [ "google.iam.admin.v1.IAM" - ] + ], + "nameInServiceConfig": "iam.googleapis.com" }, { "id": "google.iam.credentials.v1", @@ -82764,7 +86007,8 @@ "configFile": "iamcredentials_v1.yaml", "serviceConfigApiNames": [ "google.iam.credentials.v1.IAMCredentials" - ] + ], + "nameInServiceConfig": "iamcredentials.googleapis.com" }, { "id": "google.iam.v1", @@ -82861,7 +86105,8 @@ "configFile": "iam_meta_api.yaml", "serviceConfigApiNames": [ "google.iam.v1.IAMPolicy" - ] + ], + "nameInServiceConfig": "iam-meta-api.googleapis.com" }, { "id": "google.iam.v1beta", @@ -83036,7 +86281,8 @@ "configFile": "iam_v1beta.yaml", "serviceConfigApiNames": [ "google.iam.v1beta.WorkloadIdentityPools" - ] + ], + "nameInServiceConfig": "iam.googleapis.com" }, { "id": "google.iam.v2", @@ -83147,7 +86393,8 @@ "serviceConfigApiNames": [ "google.iam.v2.Policies", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "iam.googleapis.com" }, { "id": "google.iam.v2beta", @@ -83258,7 +86505,8 @@ "serviceConfigApiNames": [ "google.iam.v2beta.Policies", "google.longrunning.Operations" - ] + ], + "nameInServiceConfig": "iam.googleapis.com" }, { "id": "google.identity.accesscontextmanager.v1", @@ -83270,6 +86518,7 @@ "description": "An API for setting attribute based access control to requests to GCP services.", "importDirectories": [ "google/api", + "google/iam/v1", "google/identity/accesscontextmanager/type", "google/identity/accesscontextmanager/v1", "google/longrunning", @@ -83450,6 +86699,17 @@ } ] }, + { + "shortName": "GetIamPolicy", + "fullName": "google.identity.accesscontextmanager.v1.AccessContextManager.GetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=accessPolicies/*}:getIamPolicy" + } + ] + }, { "shortName": "GetServicePerimeter", "fullName": "google.identity.accesscontextmanager.v1.AccessContextManager.GetServicePerimeter", @@ -83527,6 +86787,36 @@ } ] }, + { + "shortName": "SetIamPolicy", + "fullName": "google.identity.accesscontextmanager.v1.AccessContextManager.SetIamPolicy", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=accessPolicies/*}:setIamPolicy" + } + ] + }, + { + "shortName": "TestIamPermissions", + "fullName": "google.identity.accesscontextmanager.v1.AccessContextManager.TestIamPermissions", + "mode": "UNARY", + "bindings": [ + { + "httpMethod": "POST", + "path": "/v1/{resource=accessPolicies/*}:testIamPermissions" + }, + { + "httpMethod": "POST", + "path": "/v1/{resource=accessPolicies/*/accessLevels/*}:testIamPermissions" + }, + { + "httpMethod": "POST", + "path": "/v1/{resource=accessPolicies/*/servicePerimeters/*}:testIamPermissions" + } + ] + }, { "shortName": "UpdateAccessLevel", "fullName": "google.identity.accesscontextmanager.v1.AccessContextManager.UpdateAccessLevel", @@ -83576,8 +86866,10 @@ ], "configFile": "accesscontextmanager_v1.yaml", "serviceConfigApiNames": [ - "google.identity.accesscontextmanager.v1.AccessContextManager" - ] + "google.identity.accesscontextmanager.v1.AccessContextManager", + "google.longrunning.Operations" + ], + "nameInServiceConfig": "accesscontextmanager.googleapis.com" }, { "id": "google.logging.v2", @@ -84492,7 +87784,8 @@ "google.logging.v2.ConfigServiceV2", "google.logging.v2.LoggingServiceV2", "google.logging.v2.MetricsServiceV2" - ] + ], + "nameInServiceConfig": "logging.googleapis.com" }, { "id": "google.maps.addressvalidation.v1", @@ -84583,7 +87876,8 @@ "configFile": "addressvalidation_v1.yaml", "serviceConfigApiNames": [ "google.maps.addressvalidation.v1.AddressValidation" - ] + ], + "nameInServiceConfig": "addressvalidation.googleapis.com" }, { "id": "google.maps.fleetengine.delivery.v1", @@ -84745,7 +88039,8 @@ "maps.fleetengine.delivery.v1.DeliveryService", "maps.fleetengine.v1.TripService", "maps.fleetengine.v1.VehicleService" - ] + ], + "nameInServiceConfig": "fleetengine.googleapis.com" }, { "id": "google.maps.fleetengine.v1", @@ -84944,7 +88239,8 @@ "serviceConfigApiNames": [ "maps.fleetengine.v1.TripService", "maps.fleetengine.v1.VehicleService" - ] + ], + "nameInServiceConfig": "fleetengine.googleapis.com" }, { "id": "google.maps.mapsplatformdatasets.v1alpha", @@ -85086,7 +88382,8 @@ "configFile": "mapsplatformdatasets_v1alpha.yaml", "serviceConfigApiNames": [ "google.maps.mapsplatformdatasets.v1alpha.MapsPlatformDatasetsV1Alpha" - ] + ], + "nameInServiceConfig": "mapsplatformdatasets.googleapis.com" }, { "id": "google.maps.playablelocations.v3", @@ -85184,7 +88481,8 @@ "configFile": "playablelocations_v3.yaml", "serviceConfigApiNames": [ "google.maps.playablelocations.v3.PlayableLocations" - ] + ], + "nameInServiceConfig": "playablelocations.googleapis.com" }, { "id": "google.maps.regionlookup.v1alpha", @@ -85269,7 +88567,8 @@ "configFile": "regionlookup_v1alpha.yaml", "serviceConfigApiNames": [ "google.maps.regionlookup.v1alpha.RegionLookup" - ] + ], + "nameInServiceConfig": "regionlookup.googleapis.com" }, { "id": "google.maps.roads.v1op", @@ -85322,7 +88621,8 @@ "configFile": "roads_v1op.yaml", "serviceConfigApiNames": [ "google.maps.roads.v1op.RoadsService" - ] + ], + "nameInServiceConfig": "roads.googleapis.com" }, { "id": "google.maps.routes.v1", @@ -85422,7 +88722,8 @@ "serviceConfigApiNames": [ "google.maps.routes.v1.RoutesPreferred", "google.maps.routes.v1alpha.RoutesAlpha" - ] + ], + "nameInServiceConfig": "routespreferred.googleapis.com" }, { "id": "google.maps.routes.v1alpha", @@ -85517,7 +88818,8 @@ "configFile": "routespreferred_v1alpha.yaml", "serviceConfigApiNames": [ "google.maps.routes.v1alpha.RoutesAlpha" - ] + ], + "nameInServiceConfig": "routespreferred.googleapis.com" }, { "id": "google.maps.routespreferred.v1", @@ -85530,7 +88832,8 @@ "configFile": "routespreferred_v1.yaml", "serviceConfigApiNames": [ "google.maps.routes.v1.RoutesPreferred" - ] + ], + "nameInServiceConfig": "routespreferred.googleapis.com" }, { "id": "google.maps.routing.v2", @@ -85551,42 +88854,42 @@ "options": { "cc_enable_arenas": { "valueCounts": { - "true": 17 + "true": 18 } }, "csharp_namespace": { "valueCounts": { - "Google.Maps.Routing.V2": 17 + "Google.Maps.Routing.V2": 18 } }, "go_package": { "valueCounts": { - "google.golang.org/genproto/googleapis/maps/routing/v2;routing": 17 + "google.golang.org/genproto/googleapis/maps/routing/v2;routing": 18 } }, "java_multiple_files": { "valueCounts": { - "true": 17 + "true": 18 } }, "java_package": { "valueCounts": { - "com.google.maps.routing.v2": 17 + "com.google.maps.routing.v2": 18 } }, "objc_class_prefix": { "valueCounts": { - "GMRV2": 17 + "GMRV2": 18 } }, "php_namespace": { "valueCounts": { - "Google\\Maps\\Routing\\V2": 17 + "Google\\Maps\\Routing\\V2": 18 } }, "ruby_package": { "valueCounts": { - "Google::Maps::Routing::V2": 17 + "Google::Maps::Routing::V2": 18 } } }, @@ -85623,7 +88926,8 @@ "configFile": "routes_v2.yaml", "serviceConfigApiNames": [ "google.maps.routing.v2.Routes" - ] + ], + "nameInServiceConfig": "routes.googleapis.com" }, { "id": "google.monitoring.dashboard.v1", @@ -85632,7 +88936,7 @@ "majorVersion": "v1", "hostName": "monitoring.googleapis.com", "title": "Cloud Monitoring API", - "description": "Manages your Cloud Monitoring data and configurations. Most projects must be associated with a Workspace, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the [Cloud Monitoring documentation](https://cloud.google.com/monitoring/docs).", + "description": "Manages your Cloud Monitoring data and configurations.", "importDirectories": [ "google/api", "google/monitoring/dashboard/v1", @@ -85736,7 +89040,8 @@ "configFile": "monitoring.yaml", "serviceConfigApiNames": [ "google.monitoring.dashboard.v1.DashboardsService" - ] + ], + "nameInServiceConfig": "monitoring.googleapis.com" }, { "id": "google.monitoring.metricsscope.v1", @@ -85839,7 +89144,8 @@ "configFile": "monitoring.yaml", "serviceConfigApiNames": [ "google.monitoring.metricsscope.v1.MetricsScopes" - ] + ], + "nameInServiceConfig": "monitoring.googleapis.com" }, { "id": "google.monitoring.v3", @@ -86466,7 +89772,8 @@ "google.monitoring.v3.QueryService", "google.monitoring.v3.ServiceMonitoringService", "google.monitoring.v3.UptimeCheckService" - ] + ], + "nameInServiceConfig": "monitoring.googleapis.com" }, { "id": "google.partner.aistreams.v1alpha1", @@ -86629,7 +89936,8 @@ "configFile": "aistreams_v1alpha1.yaml", "serviceConfigApiNames": [ "google.partner.aistreams.v1alpha1.AIStreams" - ] + ], + "nameInServiceConfig": "aistreams.googleapis.com" }, { "id": "google.privacy.dlp.v2", @@ -87332,7 +90640,8 @@ "serviceConfigApiNames": [ "google.cloud.location.Locations", "google.privacy.dlp.v2.DlpService" - ] + ], + "nameInServiceConfig": "dlp.googleapis.com" }, { "id": "google.pubsub.v1", @@ -87745,7 +91054,8 @@ "google.pubsub.v1.Publisher", "google.pubsub.v1.SchemaService", "google.pubsub.v1.Subscriber" - ] + ], + "nameInServiceConfig": "pubsub.googleapis.com" }, { "id": "google.spanner.admin.database.v1", @@ -88032,7 +91342,8 @@ "serviceConfigApiNames": [ "google.longrunning.Operations", "google.spanner.admin.database.v1.DatabaseAdmin" - ] + ], + "nameInServiceConfig": "spanner.googleapis.com" }, { "id": "google.spanner.admin.instance.v1", @@ -88246,7 +91557,8 @@ "configFile": "spanner_admin_instance.yaml", "serviceConfigApiNames": [ "google.spanner.admin.instance.v1.InstanceAdmin" - ] + ], + "nameInServiceConfig": "spanner.googleapis.com" }, { "id": "google.spanner.v1", @@ -88476,7 +91788,8 @@ "configFile": "spanner.yaml", "serviceConfigApiNames": [ "google.spanner.v1.Spanner" - ] + ], + "nameInServiceConfig": "spanner.googleapis.com" }, { "id": "google.storage.v2", @@ -88670,7 +91983,8 @@ "configFile": "storage_v2.yaml", "serviceConfigApiNames": [ "google.storage.v2.Storage" - ] + ], + "nameInServiceConfig": "storage.googleapis.com" }, { "id": "google.storagetransfer.v1", @@ -88886,7 +92200,8 @@ "serviceConfigApiNames": [ "google.longrunning.Operations", "google.storagetransfer.v1.StorageTransferService" - ] + ], + "nameInServiceConfig": "storagetransfer.googleapis.com" }, { "id": "google.streetview.publish.v1", @@ -89081,7 +92396,8 @@ "configFile": "streetviewpublish.yaml", "serviceConfigApiNames": [ "google.streetview.publish.v1.StreetViewPublishService" - ] + ], + "nameInServiceConfig": "streetviewpublish.googleapis.com" }, { "id": "google.watcher.v1", @@ -89134,7 +92450,8 @@ "configFile": "watcher.yaml", "serviceConfigApiNames": [ "google.watcher.v1.Watcher" - ] + ], + "nameInServiceConfig": "watcher.googleapis.com" } ], "metadata": { diff --git a/google/actions/sdk/v2/BUILD.bazel b/google/actions/sdk/v2/BUILD.bazel index c569d2691..91dfaa4aa 100644 --- a/google/actions/sdk/v2/BUILD.bazel +++ b/google/actions/sdk/v2/BUILD.bazel @@ -85,7 +85,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "actions_grpc_service_config.json", package = "google.actions.sdk.v2", + rest_numeric_enums = True, service_yaml = "actions_v2.yaml", + transport = "grpc+rest", deps = [], ) diff --git a/google/ads/admob/v1/BUILD.bazel b/google/ads/admob/v1/BUILD.bazel index b3adf281a..7a91593e5 100644 --- a/google/ads/admob/v1/BUILD.bazel +++ b/google/ads/admob/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( ], gapic_yaml = "admob_gapic.yaml", grpc_service_config = "//google/ads/admob:admob_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":admob_java_grpc", ], @@ -91,7 +92,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-ads-admob-v1-java", - transport = "grpc+rest", + transport = "rest", deps = [ ":admob_java_gapic", ":admob_java_grpc", @@ -127,8 +128,9 @@ go_gapic_library( srcs = [":admob_proto_with_info"], grpc_service_config = None, importpath = "google.golang.org/google/ads/admob/v1;admob", + rest_numeric_enums = True, service_yaml = "//google/ads/admob:admob_v1.yaml", - transport = "grpc+rest", + transport = "rest", deps = [ ":admob_go_proto", ], @@ -158,9 +160,9 @@ load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", "py_gapic_library", - "py_test", "py_grpc_library", "py_proto_library", + "py_test", ) py_proto_library( @@ -179,6 +181,8 @@ py_gapic_library( srcs = [ ":admob_proto_with_info", ], + rest_numeric_enums = True, + transport = "rest", ) py_test( @@ -228,7 +232,9 @@ php_gapic_library( srcs = [":admob_proto"], gapic_yaml = "admob_gapic.yaml", grpc_service_config = None, + rest_numeric_enums = True, service_yaml = "//google/ads/admob:admob_v1.yaml", + transport = "rest", deps = [ ":admob_php_grpc", ":admob_php_proto", @@ -260,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = None, package = "google.ads.admob.v1", + rest_numeric_enums = True, service_yaml = "//google/ads/admob:admob_v1.yaml", + transport = "rest", deps = [], ) @@ -299,6 +307,7 @@ ruby_cloud_gapic_library( srcs = [":admob_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-admob-v1"], grpc_service_config = None, + rest_numeric_enums = True, deps = [ ":admob_ruby_grpc", ":admob_ruby_proto", @@ -341,6 +350,7 @@ csharp_gapic_library( name = "admob_csharp_gapic", srcs = [":admob_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + rest_numeric_enums = True, deps = [ ":admob_csharp_grpc", ":admob_csharp_proto", diff --git a/google/ads/googleads/v9/BUILD.bazel b/google/ads/googleads/v12/BUILD.bazel similarity index 71% rename from google/ads/googleads/v9/BUILD.bazel rename to google/ads/googleads/v12/BUILD.bazel index 40452d1d9..ca955e444 100644 --- a/google/ads/googleads/v9/BUILD.bazel +++ b/google/ads/googleads/v12/BUILD.bazel @@ -26,11 +26,11 @@ proto_library( name = "googleads_proto", srcs = [], deps = [ - "//google/ads/googleads/v9/common:common_proto", - "//google/ads/googleads/v9/enums:enums_proto", - "//google/ads/googleads/v9/errors:errors_proto", - "//google/ads/googleads/v9/resources:resources_proto", - "//google/ads/googleads/v9/services:services_proto", + "//google/ads/googleads/v12/common:common_proto", + "//google/ads/googleads/v12/enums:enums_proto", + "//google/ads/googleads/v12/errors:errors_proto", + "//google/ads/googleads/v12/resources:resources_proto", + "//google/ads/googleads/v12/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/v9/common:common_java_proto", - "//google/ads/googleads/v9/enums:enums_java_proto", - "//google/ads/googleads/v9/resources:resources_java_proto", - "//google/ads/googleads/v9/services:services_java_grpc", - "//google/ads/googleads/v9/services:services_java_proto", + "//google/ads/googleads/v12/common:common_java_proto", + "//google/ads/googleads/v12/enums:enums_java_proto", + "//google/ads/googleads/v12/resources:resources_java_proto", + "//google/ads/googleads/v12/services:services_java_grpc", + "//google/ads/googleads/v12/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.v9.services.CampaignServiceClientTest", + "com.google.ads.googleads.v12.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/v9:googleads_proto", - "//google/ads/googleads/v9/common:common_java_proto", - "//google/ads/googleads/v9/enums:enums_java_proto", - "//google/ads/googleads/v9/errors:errors_java_proto", - "//google/ads/googleads/v9/resources:resources_java_proto", - "//google/ads/googleads/v9/services:services_java_grpc", - "//google/ads/googleads/v9/services:services_java_proto", + "//google/ads/googleads/v12:googleads_proto", + "//google/ads/googleads/v12/common:common_java_proto", + "//google/ads/googleads/v12/enums:enums_java_proto", + "//google/ads/googleads/v12/errors:errors_java_proto", + "//google/ads/googleads/v12/resources:resources_java_proto", + "//google/ads/googleads/v12/services:services_java_grpc", + "//google/ads/googleads/v12/services:services_java_proto", ], ) @@ -119,7 +119,7 @@ php_gapic_library( srcs = [":googleads_proto"], gapic_yaml = "googleads_gapic.yaml", grpc_service_config = "googleads_grpc_service_config.json", - service_yaml = "googleads_v9.yaml", + service_yaml = "googleads_v12.yaml", deps = [ ":googleads_php_grpc", ":googleads_php_proto", @@ -151,7 +151,7 @@ csharp_gapic_library( ], grpc_service_config = "googleads_grpc_service_config.json", deps = [ - "//google/ads/googleads/v9/services:services_csharp_grpc", + "//google/ads/googleads/v12/services:services_csharp_grpc", ], ) @@ -159,12 +159,12 @@ csharp_gapic_assembly_pkg( name = "googleads-csharp", deps = [ ":googleads_csharp_gapic", - "//google/ads/googleads/v9/common:common_csharp_proto", - "//google/ads/googleads/v9/enums:enums_csharp_proto", - "//google/ads/googleads/v9/errors:errors_csharp_proto", - "//google/ads/googleads/v9/resources:resources_csharp_proto", - "//google/ads/googleads/v9/services:services_csharp_grpc", - "//google/ads/googleads/v9/services:services_csharp_proto", + "//google/ads/googleads/v12/common:common_csharp_proto", + "//google/ads/googleads/v12/enums:enums_csharp_proto", + "//google/ads/googleads/v12/errors:errors_csharp_proto", + "//google/ads/googleads/v12/resources:resources_csharp_proto", + "//google/ads/googleads/v12/services:services_csharp_grpc", + "//google/ads/googleads/v12/services:services_csharp_proto", ], ) @@ -192,12 +192,12 @@ ruby_gapic_assembly_pkg( name = "googleads-ruby", deps = [ ":googleads_ruby_gapic", - "//google/ads/googleads/v9/common:common_ruby_proto", - "//google/ads/googleads/v9/enums:enums_ruby_proto", - "//google/ads/googleads/v9/errors:errors_ruby_proto", - "//google/ads/googleads/v9/resources:resources_ruby_proto", - "//google/ads/googleads/v9/services:services_ruby_grpc", - "//google/ads/googleads/v9/services:services_ruby_proto", + "//google/ads/googleads/v12/common:common_ruby_proto", + "//google/ads/googleads/v12/enums:enums_ruby_proto", + "//google/ads/googleads/v12/errors:errors_ruby_proto", + "//google/ads/googleads/v12/resources:resources_ruby_proto", + "//google/ads/googleads/v12/services:services_ruby_grpc", + "//google/ads/googleads/v12/services:services_ruby_proto", ], ) @@ -227,12 +227,12 @@ py_gapic_assembly_pkg( name = "googleads-py", deps = [ ":googleads_py_gapic", - "//google/ads/googleads/v9/common:common_py_proto", - "//google/ads/googleads/v9/enums:enums_py_proto", - "//google/ads/googleads/v9/errors:errors_py_proto", - "//google/ads/googleads/v9/resources:resources_py_proto", - "//google/ads/googleads/v9/services:services_py_grpc", - "//google/ads/googleads/v9/services:services_py_proto", + "//google/ads/googleads/v12/common:common_py_proto", + "//google/ads/googleads/v12/enums:enums_py_proto", + "//google/ads/googleads/v12/errors:errors_py_proto", + "//google/ads/googleads/v12/resources:resources_py_proto", + "//google/ads/googleads/v12/services:services_py_grpc", + "//google/ads/googleads/v12/services:services_py_proto", ], ) @@ -252,8 +252,8 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "googleads_grpc_service_config.json", main_service = "GoogleAdsService", - package = "google.ads.googleads.v9", - service_yaml = "googleads_v9.yaml", + package = "google.ads.googleads.v12", + service_yaml = "googleads_v12.yaml", deps = [], ) diff --git a/google/ads/googleads/v9/common/BUILD.bazel b/google/ads/googleads/v12/common/BUILD.bazel similarity index 98% rename from google/ads/googleads/v9/common/BUILD.bazel rename to google/ads/googleads/v12/common/BUILD.bazel index b90f195ca..72d98af27 100644 --- a/google/ads/googleads/v9/common/BUILD.bazel +++ b/google/ads/googleads/v12/common/BUILD.bazel @@ -26,7 +26,7 @@ proto_library( name = "common_proto", srcs = glob(["*.proto"]), deps = [ - "//google/ads/googleads/v9/enums:enums_proto", + "//google/ads/googleads/v12/enums:enums_proto", "//google/api:annotations_proto", "//google/api:field_behavior_proto", "//google/api:resource_proto", diff --git a/google/ads/googleads/v9/common/ad_asset.proto b/google/ads/googleads/v12/common/ad_asset.proto similarity index 65% rename from google/ads/googleads/v9/common/ad_asset.proto rename to google/ads/googleads/v12/common/ad_asset.proto index d69a5c14e..83548f2c0 100644 --- a/google/ads/googleads/v9/common/ad_asset.proto +++ b/google/ads/googleads/v12/common/ad_asset.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/common/asset_policy.proto"; -import "google/ads/googleads/v9/enums/asset_performance_label.proto"; -import "google/ads/googleads/v9/enums/served_asset_field_type.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/common/asset_policy.proto"; +import "google/ads/googleads/v12/enums/asset_performance_label.proto"; +import "google/ads/googleads/v12/enums/served_asset_field_type.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "AdAssetProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing assets used inside an ad. @@ -41,10 +40,10 @@ 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.v9.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 2; + google.ads.googleads.v12.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 2; // The performance label of this text asset. - google.ads.googleads.v9.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel asset_performance_label = 5; + google.ads.googleads.v12.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel asset_performance_label = 5; // The policy summary of this text asset. AdAssetPolicySummary policy_summary_info = 6; @@ -67,3 +66,9 @@ message AdMediaBundleAsset { // The Asset resource name of this media bundle. optional string asset = 2; } + +// A discovery carousel card asset used inside an ad. +message AdDiscoveryCarouselCardAsset { + // The Asset resource name of this discovery carousel card. + optional string asset = 1; +} diff --git a/google/ads/googleads/v9/common/ad_type_infos.proto b/google/ads/googleads/v12/common/ad_type_infos.proto similarity index 76% rename from google/ads/googleads/v9/common/ad_type_infos.proto rename to google/ads/googleads/v12/common/ad_type_infos.proto index 7a449e997..4bf1efbf0 100644 --- a/google/ads/googleads/v9/common/ad_type_infos.proto +++ b/google/ads/googleads/v12/common/ad_type_infos.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. @@ -14,25 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/common/ad_asset.proto"; -import "google/ads/googleads/v9/enums/call_conversion_reporting_state.proto"; -import "google/ads/googleads/v9/enums/display_ad_format_setting.proto"; -import "google/ads/googleads/v9/enums/display_upload_product_type.proto"; -import "google/ads/googleads/v9/enums/legacy_app_install_ad_app_store.proto"; -import "google/ads/googleads/v9/enums/mime_type.proto"; -import "google/ads/googleads/v9/enums/video_thumbnail.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/common/ad_asset.proto"; +import "google/ads/googleads/v12/enums/call_conversion_reporting_state.proto"; +import "google/ads/googleads/v12/enums/display_ad_format_setting.proto"; +import "google/ads/googleads/v12/enums/display_upload_product_type.proto"; +import "google/ads/googleads/v12/enums/legacy_app_install_ad_app_store.proto"; +import "google/ads/googleads/v12/enums/mime_type.proto"; +import "google/ads/googleads/v12/enums/video_thumbnail.proto"; +import "google/api/field_behavior.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "AdTypeInfosProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file containing info messages for specific ad types. @@ -103,93 +103,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 +124,7 @@ message ImageAdInfo { optional string preview_image_url = 20; // The mime type of the image. - google.ads.googleads.v9.enums.MimeTypeEnum.MimeType mime_type = 10; + google.ads.googleads.v12.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. @@ -282,19 +195,19 @@ message VideoOutstreamAdInfo { string description = 4; } -// Representation of video TrueView discovery ad format. -message VideoTrueViewDiscoveryAdInfo { +// Representation of In-feed video ad format. +message InFeedVideoAdInfo { // The headline of the ad. - string headline = 4; + string headline = 1; - // First text line for a TrueView video discovery ad. - string description1 = 5; + // First text line for the ad. + string description1 = 2; - // Second text line for a TrueView video discovery ad. - string description2 = 6; + // Second text line for the ad. + string description2 = 3; // Video thumbnail image to use. - google.ads.googleads.v9.enums.VideoThumbnailEnum.VideoThumbnail thumbnail = 7; + google.ads.googleads.v12.enums.VideoThumbnailEnum.VideoThumbnail thumbnail = 4; } // A video ad. @@ -316,15 +229,16 @@ message VideoAdInfo { // Video non-skippable in-stream ad format. VideoNonSkippableInStreamAdInfo non_skippable = 5; - // Video TrueView discovery ad format. - VideoTrueViewDiscoveryAdInfo discovery = 6; + // In-feed video ad format. + InFeedVideoAdInfo in_feed = 9; } } // 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 +249,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. @@ -346,6 +260,12 @@ message VideoResponsiveAdInfo { // List of image assets used for the companion banner. // Currently, only a single value for the companion banner asset is supported. repeated AdImageAsset companion_banners = 6; + + // First part of text that appears in the ad with the displayed URL. + string breadcrumb1 = 7; + + // Second part of text that appears in the ad with the displayed URL. + string breadcrumb2 = 8; } // A responsive search ad. @@ -398,12 +318,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; @@ -424,9 +344,9 @@ message LegacyResponsiveDisplayAdInfo { optional string square_marketing_image = 27; // Specifies which format the ad will be served in. Default is ALL_FORMATS. - google.ads.googleads.v9.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 13; + google.ads.googleads.v12.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 @@ -479,7 +399,7 @@ message AppEngagementAdInfo { // App pre-registration ads link to your app or game listing on Google Play, and // can run on Google Play, on YouTube (in-stream only), and within other apps -// and mobile websites on the Display Network. It will help capture people’s +// and mobile websites on the Display Network. It will help capture people's // interest in your app or game and generate an early install base for your app // or game before a launch. message AppPreRegistrationAdInfo { @@ -504,7 +424,7 @@ message LegacyAppInstallAdInfo { optional string app_id = 6; // The app store the mobile app is available in. - google.ads.googleads.v9.enums.LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore app_store = 2; + google.ads.googleads.v12.enums.LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore app_store = 2; // The headline of the ad. optional string headline = 7; @@ -557,12 +477,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; @@ -577,7 +497,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 @@ -585,7 +505,7 @@ message ResponsiveDisplayAdInfo { optional string promo_text = 23; // Specifies which format the ad will be served in. Default is ALL_FORMATS. - google.ads.googleads.v9.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16; + google.ads.googleads.v12.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16; // Specification for various creative controls. ResponsiveDisplayAdControlSpec control_spec = 24; @@ -604,8 +524,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 @@ -618,8 +538,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. @@ -635,7 +555,7 @@ 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.v9.enums.DisplayUploadProductTypeEnum.DisplayUploadProductType display_upload_product_type = 1; + google.ads.googleads.v12.enums.DisplayUploadProductTypeEnum.DisplayUploadProductType display_upload_product_type = 1; // The asset data that makes up the ad. oneof media_asset { @@ -661,12 +581,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; } @@ -713,7 +633,7 @@ 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.v9.enums.CallConversionReportingStateEnum.CallConversionReportingState conversion_reporting_state = 10; + google.ads.googleads.v12.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; @@ -722,3 +642,69 @@ message CallAdInfo { // can only be set when `path1` is also set. Optional. string path2 = 14; } + +// A discovery multi asset ad. +message DiscoveryMultiAssetAdInfo { + // Marketing image assets to be used in the ad. Valid image types are GIF, + // JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must + // be 1.91:1 (+-1%). Required if square_marketing_images is + // not present. Combined with `square_marketing_images` and + // `portrait_marketing_images` the maximum is 20. + repeated AdImageAsset marketing_images = 1; + + // Square marketing image assets to be used in the ad. Valid image types are + // GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must + // be 1:1 (+-1%). Required if marketing_images is not present. Combined with + // `marketing_images` and `portrait_marketing_images` the maximum is 20. + repeated AdImageAsset square_marketing_images = 2; + + // Portrait marketing image assets to be used in the ad. Valid image types are + // GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must + // be 4:5 (+-1%). Combined with `marketing_images` and + // `square_marketing_images` the maximum is 20. + repeated AdImageAsset portrait_marketing_images = 3; + + // Logo image assets to be used in the ad. Valid image types are GIF, + // JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be + // 1:1(+-1%). At least 1 and max 5 logo images can be specified. + repeated AdImageAsset logo_images = 4; + + // Headline text asset of the ad. Maximum display width is 30. At least 1 and + // max 5 headlines can be specified. + repeated AdTextAsset headlines = 5; + + // The descriptive text of the ad. Maximum display width is 90. At least 1 and + // max 5 descriptions can be specified. + repeated AdTextAsset descriptions = 6; + + // The Advertiser/brand name. Maximum display width is 25. Required. + optional string business_name = 7; + + // Call to action text. + optional string call_to_action_text = 8; + + // Boolean option that indicates if this ad must be served with lead form. + optional bool lead_form_only = 9; +} + +// A discovery carousel ad. +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%). + AdImageAsset logo_image = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Headline of the ad. + AdTextAsset headline = 3 [(google.api.field_behavior) = REQUIRED]; + + // Required. The descriptive text of the ad. + AdTextAsset description = 4 [(google.api.field_behavior) = REQUIRED]; + + // Call to action text. + 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]; +} diff --git a/google/ads/googleads/v9/common/asset_policy.proto b/google/ads/googleads/v12/common/asset_policy.proto similarity index 60% rename from google/ads/googleads/v9/common/asset_policy.proto rename to google/ads/googleads/v12/common/asset_policy.proto index f9a5ffe2b..70ba6faf1 100644 --- a/google/ads/googleads/v9/common/asset_policy.proto +++ b/google/ads/googleads/v12/common/asset_policy.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "AssetPolicyProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing asset policies. @@ -38,9 +37,9 @@ message AdAssetPolicySummary { repeated PolicyTopicEntry policy_topic_entries = 1; // Where in the review process this asset. - google.ads.googleads.v9.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2; + google.ads.googleads.v12.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3; + google.ads.googleads.v12.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3; } diff --git a/google/ads/googleads/v12/common/asset_set_types.proto b/google/ads/googleads/v12/common/asset_set_types.proto new file mode 100644 index 000000000..50294fdf0 --- /dev/null +++ b/google/ads/googleads/v12/common/asset_set_types.proto @@ -0,0 +1,180 @@ +// 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.v12.common; + +import "google/ads/googleads/v12/enums/chain_relationship_type.proto"; +import "google/ads/googleads/v12/enums/location_ownership_type.proto"; +import "google/ads/googleads/v12/enums/location_string_filter_type.proto"; +import "google/api/field_behavior.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; +option java_multiple_files = true; +option java_outer_classname = "AssetSetTypesProto"; +option java_package = "com.google.ads.googleads.v12.common"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.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.v12.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.v12.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/google/ads/googleads/v12/common/asset_types.proto b/google/ads/googleads/v12/common/asset_types.proto new file mode 100644 index 000000000..3d57ba851 --- /dev/null +++ b/google/ads/googleads/v12/common/asset_types.proto @@ -0,0 +1,1023 @@ +// 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.v12.common; + +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/common/feed_common.proto"; +import "google/ads/googleads/v12/enums/call_conversion_reporting_state.proto"; +import "google/ads/googleads/v12/enums/call_to_action_type.proto"; +import "google/ads/googleads/v12/enums/lead_form_call_to_action_type.proto"; +import "google/ads/googleads/v12/enums/lead_form_desired_intent.proto"; +import "google/ads/googleads/v12/enums/lead_form_field_user_input_type.proto"; +import "google/ads/googleads/v12/enums/lead_form_post_submit_call_to_action_type.proto"; +import "google/ads/googleads/v12/enums/location_ownership_type.proto"; +import "google/ads/googleads/v12/enums/mime_type.proto"; +import "google/ads/googleads/v12/enums/mobile_app_vendor.proto"; +import "google/ads/googleads/v12/enums/price_extension_price_qualifier.proto"; +import "google/ads/googleads/v12/enums/price_extension_price_unit.proto"; +import "google/ads/googleads/v12/enums/price_extension_type.proto"; +import "google/ads/googleads/v12/enums/promotion_extension_discount_modifier.proto"; +import "google/ads/googleads/v12/enums/promotion_extension_occasion.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; +option java_multiple_files = true; +option java_outer_classname = "AssetTypesProto"; +option java_package = "com.google.ads.googleads.v12.common"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; + +// Proto file containing info messages for specific asset types. + +// A YouTube asset. +message YoutubeVideoAsset { + // YouTube video id. This is the 11 character string value used in the + // YouTube video URL. + optional string youtube_video_id = 2; + + // YouTube video title. + string youtube_video_title = 3; +} + +// A MediaBundle asset. +message MediaBundleAsset { + // Media bundle (ZIP file) asset data. The format of the uploaded ZIP file + // depends on the ad field where it will be used. For more information on the + // format, see the documentation of the ad field where you plan on using the + // MediaBundleAsset. This field is mutate only. + optional bytes data = 2; +} + +// An Image asset. +message ImageAsset { + // The raw bytes data of an image. This field is mutate only. + optional bytes data = 5; + + // File size of the image asset in bytes. + optional int64 file_size = 6; + + // MIME type of the image asset. + google.ads.googleads.v12.enums.MimeTypeEnum.MimeType mime_type = 3; + + // Metadata for this image at its original size. + ImageDimension full_size = 4; +} + +// Metadata for an image at a certain size, either original or resized. +message ImageDimension { + // Height of the image. + optional int64 height_pixels = 4; + + // Width of the image. + optional int64 width_pixels = 5; + + // A URL that returns the image with this height and width. + optional string url = 6; +} + +// A Text asset. +message TextAsset { + // Text content of the text asset. + optional string text = 2; +} + +// A Lead Form asset. +message LeadFormAsset { + // Required. The name of the business being advertised. + string business_name = 10 [(google.api.field_behavior) = REQUIRED]; + + // Required. Pre-defined display text that encourages user to expand the form. + google.ads.googleads.v12.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. 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. + 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. + string privacy_policy_url = 14 [(google.api.field_behavior) = REQUIRED]; + + // Headline of text shown after form submission that describes how the + // advertiser will follow up with the user. + optional string post_submit_headline = 15; + + // Detailed description shown after form submission that describes how the + // advertiser will follow up with the user. + optional string post_submit_description = 16; + + // 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. + repeated LeadFormCustomQuestionField custom_question_fields = 23; + + // Configured methods for collected lead data to be delivered to advertiser. + // Only one method typed as WebhookDelivery can be configured. + repeated LeadFormDeliveryMethod delivery_methods = 9; + + // Pre-defined display text that encourages user action after the form is + // submitted. + google.ads.googleads.v12.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; + + // Chosen intent for the lead form, for example, more volume or more + // qualified. + google.ads.googleads.v12.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21; + + // Custom disclosure shown along with Google disclaimer on the lead form. + // Accessible to allowed customers only. + optional string custom_disclosure = 22; +} + +// 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 "What kind of vehicle do you have?". + google.ads.googleads.v12.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. + oneof answers { + // Answer configuration for a single choice question. Can be set only for + // pre-vetted question fields. Minimum of 2 answers required and maximum of + // 12 allowed. + LeadFormSingleChoiceAnswers single_choice_answers = 2; + } +} + +// One custom question input field instance within a form. +message LeadFormCustomQuestionField { + // 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 + // oneof is not set, this is a free-text answer. + oneof answers { + // Answer configuration for a single choice question. + // Minimum of 2 answers and maximum of 12 allowed. + LeadFormSingleChoiceAnswers single_choice_answers = 2; + } +} + +// Defines possible answers for a single choice question, usually presented as +// a single-choice drop-down list. +message LeadFormSingleChoiceAnswers { + // List of choices for a single question field. The order of entries defines + // UI order. Minimum of 2 answers required and maximum of 12 allowed. + repeated string answers = 1; +} + +// A configuration of how leads are delivered to the advertiser. +message LeadFormDeliveryMethod { + // Various subtypes of delivery. + oneof delivery_details { + // Webhook method of delivery. + WebhookDelivery webhook = 1; + } +} + +// Google notifies the advertiser of leads by making HTTP calls to an +// endpoint they specify. The requests contain JSON matching a schema that +// Google publishes as part of form ads documentation. +message WebhookDelivery { + // Webhook url specified by advertiser to send the lead. + optional string advertiser_webhook_url = 4; + + // Anti-spoofing secret set by the advertiser as part of the webhook payload. + optional string google_secret = 5; + + // The schema version that this delivery instance will use. + optional int64 payload_schema_version = 6; +} + +// 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 { + +} + +// A Promotion asset. +message PromotionAsset { + // Required. A freeform description of what the promotion is targeting. + string promotion_target = 1 [(google.api.field_behavior) = REQUIRED]; + + // A modifier for qualification of the discount. + google.ads.googleads.v12.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2; + + // Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd + // format. + string redemption_start_date = 7; + + // Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd + // format. + string redemption_end_date = 8; + + // 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.v12.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9; + + // The language of the promotion. + // Represented as BCP 47 language tag. + string language_code = 10; + + // Start date of when this asset is effective and can begin serving, in + // yyyy-MM-dd format. + string start_date = 11; + + // Last date of when this asset is effective and still serving, in yyyy-MM-dd + // format. + string end_date = 12; + + // 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 + // total. + repeated AdScheduleInfo ad_schedule_targets = 13; + + // Discount type, can be percentage off or amount off. + oneof discount_type { + // Percentage off discount in the promotion. 1,000,000 = 100%. + // Either this or money_amount_off is required. + int64 percent_off = 3; + + // Money amount off for discount in the promotion. + // Either this or percent_off is required. + Money money_amount_off = 4; + } + + // Promotion trigger. Can be by promotion code or promo by eligible order + // amount. + oneof promotion_trigger { + // A code the user should use in order to be eligible for the promotion. + string promotion_code = 5; + + // The amount the total order needs to be for the user to be eligible for + // the promotion. + Money orders_over_amount = 6; + } +} + +// A Callout asset. +message CalloutAsset { + // Required. The callout text. + // The length of this string should be between 1 and 25, inclusive. + string callout_text = 1 [(google.api.field_behavior) = REQUIRED]; + + // Start date of when this asset is effective and can begin serving, in + // yyyy-MM-dd format. + string start_date = 2; + + // Last date of when this asset is effective and still serving, in yyyy-MM-dd + // format. + string end_date = 3; + + // 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 + // total. + repeated AdScheduleInfo ad_schedule_targets = 4; +} + +// A Structured Snippet asset. +message StructuredSnippetAsset { + // Required. The header of the snippet. + // This string should be one of the predefined values at + // https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers + string header = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The values in the snippet. + // The size of this collection should be between 3 and 10, inclusive. + // The length of each value should be between 1 and 25 characters, inclusive. + repeated string values = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// A Sitelink asset. +message SitelinkAsset { + // Required. URL display text for the sitelink. + // The length of this string should be between 1 and 25, inclusive. + string link_text = 1 [(google.api.field_behavior) = REQUIRED]; + + // First line of the description for the sitelink. + // If set, the length should be between 1 and 35, inclusive, and description2 + // must also be set. + string description1 = 2; + + // Second line of the description for the sitelink. + // If set, the length should be between 1 and 35, inclusive, and description1 + // must also be set. + string description2 = 3; + + // Start date of when this asset is effective and can begin serving, in + // yyyy-MM-dd format. + string start_date = 4; + + // Last date of when this asset is effective and still serving, in yyyy-MM-dd + // format. + string end_date = 5; + + // 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 + // total. + repeated AdScheduleInfo ad_schedule_targets = 6; +} + +// A Page Feed asset. +message PageFeedAsset { + // Required. The webpage that advertisers want to target. + string page_url = 1 [(google.api.field_behavior) = REQUIRED]; + + // Labels used to group the page urls. + repeated string labels = 2; +} + +// 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. + 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, for example, Nursing. Required. + string program_name = 3 [(google.api.field_behavior) = REQUIRED]; + + // Subject of study, for example, Health. + string subject = 4; + + // Program description, for example, Nursing Certification. + string program_description = 5; + + // 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, 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, for example, Nursing certification, Health, Mountain + // View. + repeated string contextual_keywords = 8; + + // 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, 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 12; + + // 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, 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 + // "12345689" for iOS. + string app_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The application store that distributes this specific app. + google.ads.googleads.v12.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. + string link_text = 3 [(google.api.field_behavior) = REQUIRED]; + + // Start date of when this asset is effective and can begin serving, in + // yyyy-MM-dd format. + string start_date = 4; + + // Last date of when this asset is effective and still serving, in yyyy-MM-dd + // format. + string end_date = 5; +} + +// An asset representing a hotel callout. +message HotelCalloutAsset { + // Required. The text of the hotel callout asset. + // The length of this string should be between 1 and 25, inclusive. + string text = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The language of the hotel callout. + // Represented as BCP 47 language tag. + string language_code = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// A Call asset. +message CallAsset { + // 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' + 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.v12.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" + }]; + + // 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 + // total. + repeated AdScheduleInfo ad_schedule_targets = 5; +} + +// An asset representing a list of price offers. +message PriceAsset { + // Required. The type of the price asset. + google.ads.googleads.v12.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1 [(google.api.field_behavior) = REQUIRED]; + + // The price qualifier of the price asset. + google.ads.googleads.v12.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2; + + // Required. The language of the price asset. + // Represented as BCP 47 language tag. + string language_code = 3 [(google.api.field_behavior) = REQUIRED]; + + // The price offerings of the price asset. + // The size of this collection should be between 3 and 8, inclusive. + repeated PriceOffering price_offerings = 4; +} + +// A single price offering within a PriceAsset. +message PriceOffering { + // Required. The header of the price offering. + // The length of this string should be between 1 and 25, inclusive. + string header = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The description of the price offering. + // The length of this string should be between 1 and 25, inclusive. + string description = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The price value of the price offering. + Money price = 3 [(google.api.field_behavior) = REQUIRED]; + + // The price unit of the price offering. + google.ads.googleads.v12.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4; + + // Required. The final URL after all cross domain redirects. + string final_url = 5 [(google.api.field_behavior) = REQUIRED]; + + // The final mobile URL after all cross domain redirects. + string final_mobile_url = 6; +} + +// A call to action asset. +message CallToActionAsset { + // Call to action. + google.ads.googleads.v12.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. + string listing_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Listing name, for example, Boulevard Bungalow. Required. + string listing_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // City name, for example, Mountain View, California. + string city_name = 3; + + // 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, 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, for example, 200,000.00 + // USD. + string price = 6; + + // 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, for example, House. + string property_type = 8; + + // Listing type, for example, For sale. + string listing_type = 9; + + // 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', for example, Starting at $200,000.00. + string formatted_price = 11; + + // Android deep link, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 12; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 14; + + // Similar listing IDs. + repeated string similar_listing_ids = 15; +} + +// 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, for example, sedan. + // Required. + string id = 1 [(google.api.field_behavior) = REQUIRED]; + + // 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, for example, Mid-size sedan. Required. + string item_title = 3 [(google.api.field_behavior) = REQUIRED]; + + // Item subtitle, for example, At your Mountain View dealership. + string item_subtitle = 4; + + // 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, 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, 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, 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, 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', 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', for example, On sale for $15,000.00. + string formatted_sale_price = 11; + + // 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, for example, Sedans, 4 door sedans. + repeated string contextual_keywords = 13; + + // Android deep link, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 14; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 17; + + // Similar IDs. + repeated string similar_ids = 15; +} + +// 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. + string property_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Property name, for example, Mountain View Hotel. Required. + string property_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // 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, for example, Downtown Mountain View. + string destination_name = 4; + + // 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, for example, 100.00 USD. + string price = 6; + + // 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 to 5, inclusive. + int64 star_rating = 8; + + // Category, for example, Hotel suite. + string category = 9; + + // 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, 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, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 12; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 14; + + // Formatted price which can be any characters. If set, this attribute will be + // 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', for example, On sale for $80.00. + string formatted_sale_price = 16; + + // Similar property IDs. + repeated string similar_property_ids = 17; +} + +// 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. + 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, for example, Book your ticket. Required. + string flight_description = 3 [(google.api.field_behavior) = REQUIRED]; + + // 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, for example, Paris. + string destination_name = 5; + + // 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, 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, 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', 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', for example, On sale for $80.00. + string formatted_sale_price = 10; + + // Android deep link, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 11; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 13; + + // 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 + // ": , , ... , | : , ... + // , | ... | : , ... ," for example, wifi: + // most | aircraft: 320, 77W | flights: 42 | legroom: 32". + string custom_mapping = 15; +} + +// A Discovery Carousel Card asset. +message DiscoveryCarouselCardAsset { + // Asset resource name of the associated 1.91:1 marketing image. This and/or + // square marketing image asset is required. + string marketing_image_asset = 1; + + // Asset resource name of the associated square marketing image. This + // and/or a marketing image asset is required. + string square_marketing_image_asset = 2; + + // Asset resource name of the associated 4:5 portrait marketing image. + string portrait_marketing_image_asset = 3; + + // Required. Headline of the carousel card. + string headline = 4 [(google.api.field_behavior) = REQUIRED]; + + // Call to action text. + string call_to_action_text = 5; +} + +// 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. + 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, for example, Book your train ticket. Required. + string title = 3 [(google.api.field_behavior) = REQUIRED]; + + // 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, 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, 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, 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, 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', 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', for example, On sale for $80.00. + string formatted_sale_price = 10; + + // Category, for example, Express. + string category = 11; + + // Contextual keywords, for example, Paris trains. + repeated string contextual_keywords = 12; + + // Similar destination IDs, for example, NYC. + repeated string similar_destination_ids = 13; + + // 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, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 15; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 17; +} + +// 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. + string deal_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Deal name, for example, 50% off at Mountain View Grocers. Required. + string deal_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // Subtitle, for example, Groceries. + string subtitle = 3; + + // 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, 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, for example, 80.00 USD. + // Must be less than the 'price' field. + string sale_price = 6; + + // 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, 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, for example, Food. + string category = 9; + + // 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', 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', for example, On sale for $80.00. + string formatted_sale_price = 12; + + // Android deep link, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 13; + + // Similar deal IDs, for example, 1275. + repeated string similar_deal_ids = 14; + + // 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 + // on their device before deep linking. If this field is set, then the + // ios_app_link field must also be present. + int64 ios_app_store_id = 16; +} + +// 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. + 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, for example, Software engineer. Required. + string job_title = 3 [(google.api.field_behavior) = REQUIRED]; + + // Job subtitle, for example, Level II. + string job_subtitle = 4; + + // Description, for example, Apply your technical skills. + string description = 5; + + // 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, for example, Technical. + string job_category = 7; + + // 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, 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, for example, $100,000. + string salary = 10; + + // Android deep link, for example, + // android-app://com.example.android/http/example.com/gizmos?1234. + string android_app_link = 11; + + // Similar job IDs, for example, 1275. + repeated string similar_job_ids = 12; + + // 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 + // on their device before deep linking. If this field is set, then the + // 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.v12.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; +} diff --git a/google/ads/googleads/v12/common/asset_usage.proto b/google/ads/googleads/v12/common/asset_usage.proto new file mode 100644 index 000000000..293a3ed77 --- /dev/null +++ b/google/ads/googleads/v12/common/asset_usage.proto @@ -0,0 +1,39 @@ +// 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.v12.common; + +import "google/ads/googleads/v12/enums/served_asset_field_type.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; +option java_multiple_files = true; +option java_outer_classname = "AssetUsageProto"; +option java_package = "com.google.ads.googleads.v12.common"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; + +// Proto file describing asset usage. + +// Contains the usage information of the asset. +message AssetUsage { + // Resource name of the asset. + string asset = 1; + + // The served field type of the asset. + google.ads.googleads.v12.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType served_asset_field_type = 2; +} diff --git a/google/ads/googleads/v12/common/audiences.proto b/google/ads/googleads/v12/common/audiences.proto new file mode 100644 index 000000000..6dab1a69d --- /dev/null +++ b/google/ads/googleads/v12/common/audiences.proto @@ -0,0 +1,173 @@ +// 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.v12.common; + +import "google/ads/googleads/v12/enums/gender_type.proto"; +import "google/ads/googleads/v12/enums/income_range_type.proto"; +import "google/ads/googleads/v12/enums/parental_status_type.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; +option java_multiple_files = true; +option java_outer_classname = "AudiencesProto"; +option java_package = "com.google.ads.googleads.v12.common"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; + +// Positive dimension specifying user's audience. +message AudienceDimension { + // Dimension specifying users who belong to the audience. + oneof dimension { + // Dimension specifying users by their age. + AgeDimension age = 1; + + // Dimension specifying users by their gender. + GenderDimension gender = 2; + + // Dimension specifying users by their household income. + HouseholdIncomeDimension household_income = 3; + + // Dimension specifying users by their parental status. + ParentalStatusDimension parental_status = 4; + + // Dimension specifying users by their membership in other audience + // segments. + AudienceSegmentDimension audience_segments = 5; + } +} + +// Negative dimension specifying users to exclude from the audience. +message AudienceExclusionDimension { + // Audience segment to be excluded. + repeated ExclusionSegment exclusions = 1; +} + +// An audience segment to be excluded from an audience. +message ExclusionSegment { + // Segment to be excluded. + oneof segment { + // User list segment to be excluded. + UserListSegment user_list = 1; + } +} + +// Dimension specifying users by their age. +message AgeDimension { + // Contiguous age range to be included in the dimension. + repeated AgeSegment age_ranges = 1; + + // Include users whose age is not determined. + optional bool include_undetermined = 2; +} + +// Contiguous age range. +message AgeSegment { + // Minimum age to include. A minimum age must be specified and must be at + // least 18. Allowed values are 18, 25, 35, 45, 55, and 65. + optional int32 min_age = 1; + + // Maximum age to include. A maximum age need not be specified. If specified, + // max_age must be greater than min_age, and allowed values are 24, 34, 44, + // 54, and 64. + optional int32 max_age = 2; +} + +// Dimension specifying users by their gender. +message GenderDimension { + // Included gender demographic segments. + repeated google.ads.googleads.v12.enums.GenderTypeEnum.GenderType genders = 1; + + // Include users whose gender is not determined. + optional bool include_undetermined = 2; +} + +// Dimension specifying users by their household income. +message HouseholdIncomeDimension { + // Included household income demographic segments. + repeated google.ads.googleads.v12.enums.IncomeRangeTypeEnum.IncomeRangeType income_ranges = 1; + + // Include users whose household income is not determined. + optional bool include_undetermined = 2; +} + +// Dimension specifying users by their parental status. +message ParentalStatusDimension { + // Included parental status demographic segments. + repeated google.ads.googleads.v12.enums.ParentalStatusTypeEnum.ParentalStatusType parental_statuses = 1; + + // Include users whose parental status is undetermined. + optional bool include_undetermined = 2; +} + +// Dimension specifying users by their membership in other audience segments. +message AudienceSegmentDimension { + // Included audience segments. Users are included if they belong to at least + // one segment. + repeated AudienceSegment segments = 1; +} + +// Positive audience segment. +message AudienceSegment { + // Positive segment. + oneof segment { + // User list segment. + UserListSegment user_list = 1; + + // Affinity or In-market segment. + UserInterestSegment user_interest = 2; + + // Live-event audience segment. + LifeEventSegment life_event = 3; + + // Detailed demographic segment. + DetailedDemographicSegment detailed_demographic = 4; + + // Custom audience segment. + CustomAudienceSegment custom_audience = 5; + } +} + +// User list segment. +message UserListSegment { + // The user list resource. + optional string user_list = 1; +} + +// User interest segment. +message UserInterestSegment { + // The user interest resource. + optional string user_interest_category = 1; +} + +// Live event segment. +message LifeEventSegment { + // The life event resource. + optional string life_event = 1; +} + +// Detailed demographic segment. +message DetailedDemographicSegment { + // The detailed demographic resource. + optional string detailed_demographic = 1; +} + +// Custom audience segment. +message CustomAudienceSegment { + // The custom audience resource. + optional string custom_audience = 1; +} diff --git a/google/ads/googleads/v9/common/bidding.proto b/google/ads/googleads/v12/common/bidding.proto similarity index 83% rename from google/ads/googleads/v9/common/bidding.proto rename to google/ads/googleads/v12/common/bidding.proto index eb41ee52d..15ba9c510 100644 --- a/google/ads/googleads/v9/common/bidding.proto +++ b/google/ads/googleads/v12/common/bidding.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. @@ -14,19 +14,18 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/target_impression_share_location.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/target_impression_share_location.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "BiddingProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing bidding schemes. @@ -43,10 +42,19 @@ 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. +// +// 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 { // Whether bids are to be enhanced based on conversion optimizer data. @@ -66,13 +74,6 @@ 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. 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 +83,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 @@ -135,10 +144,10 @@ message TargetCpm { // location). message TargetImpressionShare { // The targeted location on the search results page. - google.ads.googleads.v9.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1; + google.ads.googleads.v12.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 +159,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/google/ads/googleads/v9/common/click_location.proto b/google/ads/googleads/v12/common/click_location.proto similarity index 78% rename from google/ads/googleads/v9/common/click_location.proto rename to google/ads/googleads/v12/common/click_location.proto index e43f034f4..14b444802 100644 --- a/google/ads/googleads/v9/common/click_location.proto +++ b/google/ads/googleads/v12/common/click_location.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "ClickLocationProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing a ClickLocation. diff --git a/google/ads/googleads/v9/common/criteria.proto b/google/ads/googleads/v12/common/criteria.proto similarity index 69% rename from google/ads/googleads/v9/common/criteria.proto rename to google/ads/googleads/v12/common/criteria.proto index 0f57f985b..efc776042 100644 --- a/google/ads/googleads/v9/common/criteria.proto +++ b/google/ads/googleads/v12/common/criteria.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. @@ -14,42 +14,41 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; - -import "google/ads/googleads/v9/enums/age_range_type.proto"; -import "google/ads/googleads/v9/enums/app_payment_model_type.proto"; -import "google/ads/googleads/v9/enums/content_label_type.proto"; -import "google/ads/googleads/v9/enums/day_of_week.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/gender_type.proto"; -import "google/ads/googleads/v9/enums/hotel_date_selection_type.proto"; -import "google/ads/googleads/v9/enums/income_range_type.proto"; -import "google/ads/googleads/v9/enums/interaction_type.proto"; -import "google/ads/googleads/v9/enums/keyword_match_type.proto"; -import "google/ads/googleads/v9/enums/listing_group_type.proto"; -import "google/ads/googleads/v9/enums/location_group_radius_units.proto"; -import "google/ads/googleads/v9/enums/minute_of_hour.proto"; -import "google/ads/googleads/v9/enums/parental_status_type.proto"; -import "google/ads/googleads/v9/enums/preferred_content_type.proto"; -import "google/ads/googleads/v9/enums/product_bidding_category_level.proto"; -import "google/ads/googleads/v9/enums/product_channel.proto"; -import "google/ads/googleads/v9/enums/product_channel_exclusivity.proto"; -import "google/ads/googleads/v9/enums/product_condition.proto"; -import "google/ads/googleads/v9/enums/product_custom_attribute_index.proto"; -import "google/ads/googleads/v9/enums/product_type_level.proto"; -import "google/ads/googleads/v9/enums/proximity_radius_units.proto"; -import "google/ads/googleads/v9/enums/webpage_condition_operand.proto"; -import "google/ads/googleads/v9/enums/webpage_condition_operator.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +package google.ads.googleads.v12.common; + +import "google/ads/googleads/v12/enums/age_range_type.proto"; +import "google/ads/googleads/v12/enums/app_payment_model_type.proto"; +import "google/ads/googleads/v12/enums/content_label_type.proto"; +import "google/ads/googleads/v12/enums/day_of_week.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/gender_type.proto"; +import "google/ads/googleads/v12/enums/hotel_date_selection_type.proto"; +import "google/ads/googleads/v12/enums/income_range_type.proto"; +import "google/ads/googleads/v12/enums/interaction_type.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/enums/listing_group_type.proto"; +import "google/ads/googleads/v12/enums/location_group_radius_units.proto"; +import "google/ads/googleads/v12/enums/minute_of_hour.proto"; +import "google/ads/googleads/v12/enums/parental_status_type.proto"; +import "google/ads/googleads/v12/enums/preferred_content_type.proto"; +import "google/ads/googleads/v12/enums/product_bidding_category_level.proto"; +import "google/ads/googleads/v12/enums/product_channel.proto"; +import "google/ads/googleads/v12/enums/product_channel_exclusivity.proto"; +import "google/ads/googleads/v12/enums/product_condition.proto"; +import "google/ads/googleads/v12/enums/product_custom_attribute_index.proto"; +import "google/ads/googleads/v12/enums/product_type_level.proto"; +import "google/ads/googleads/v12/enums/proximity_radius_units.proto"; +import "google/ads/googleads/v12/enums/webpage_condition_operand.proto"; +import "google/ads/googleads/v12/enums/webpage_condition_operator.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "CriteriaProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing criteria types. @@ -59,7 +58,7 @@ message KeywordInfo { optional string text = 3; // The match type of the keyword. - google.ads.googleads.v9.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2; + google.ads.googleads.v12.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2; } // A placement criterion. This can be used to modify bids for sites when @@ -85,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. @@ -108,19 +108,19 @@ message LocationInfo { // A device criterion. message DeviceInfo { // Type of the device. - google.ads.googleads.v9.enums.DeviceEnum.Device type = 1; + google.ads.googleads.v12.enums.DeviceEnum.Device type = 1; } // A preferred content criterion. message PreferredContentInfo { // Type of the preferred content. - google.ads.googleads.v9.enums.PreferredContentTypeEnum.PreferredContentType type = 2; + google.ads.googleads.v12.enums.PreferredContentTypeEnum.PreferredContentType type = 2; } // A listing group criterion. message ListingGroupInfo { // Type of the listing group. - google.ads.googleads.v9.enums.ListingGroupTypeEnum.ListingGroupType type = 1; + google.ads.googleads.v12.enums.ListingGroupTypeEnum.ListingGroupType type = 1; // Dimension value with which this listing group is refining its parent. // Undefined for the root group. @@ -180,6 +180,18 @@ message ListingDimensionInfo { // Type of a product offer. ProductTypeInfo product_type = 12; + // Grouping of a product offer. + ProductGroupingInfo product_grouping = 17; + + // Labels of a product offer. + ProductLabelsInfo product_labels = 18; + + // Legacy condition of a product offer. + ProductLegacyConditionInfo product_legacy_condition = 19; + + // Full type of a product offer. + ProductTypeFullInfo product_type_full = 20; + // Unknown dimension. Set when no other listing dimension is set. UnknownListingDimensionInfo unknown_listing_dimension = 14; } @@ -228,7 +240,7 @@ message ProductBiddingCategoryInfo { optional string country_code = 5; // Level of the product bidding category. - google.ads.googleads.v9.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 3; + google.ads.googleads.v12.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 3; } // Brand of the product. @@ -240,19 +252,19 @@ message ProductBrandInfo { // Locality of a product offer. message ProductChannelInfo { // Value of the locality. - google.ads.googleads.v9.enums.ProductChannelEnum.ProductChannel channel = 1; + google.ads.googleads.v12.enums.ProductChannelEnum.ProductChannel channel = 1; } // Availability of a product offer. message ProductChannelExclusivityInfo { // Value of the availability. - google.ads.googleads.v9.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1; + google.ads.googleads.v12.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1; } // Condition of a product offer. message ProductConditionInfo { // Value of the condition. - google.ads.googleads.v9.enums.ProductConditionEnum.ProductCondition condition = 1; + google.ads.googleads.v12.enums.ProductConditionEnum.ProductCondition condition = 1; } // Custom attribute of a product offer. @@ -261,7 +273,7 @@ message ProductCustomAttributeInfo { optional string value = 3; // Indicates the index of the custom attribute. - google.ads.googleads.v9.enums.ProductCustomAttributeIndexEnum.ProductCustomAttributeIndex index = 2; + google.ads.googleads.v12.enums.ProductCustomAttributeIndexEnum.ProductCustomAttributeIndex index = 2; } // Item id of a product offer. @@ -276,7 +288,35 @@ message ProductTypeInfo { optional string value = 3; // Level of the type. - google.ads.googleads.v9.enums.ProductTypeLevelEnum.ProductTypeLevel level = 2; + google.ads.googleads.v12.enums.ProductTypeLevelEnum.ProductTypeLevel level = 2; +} + +// Grouping of a product offer. This listing dimension is deprecated and it is +// supported only in Display campaigns. +message ProductGroupingInfo { + // String value of the product grouping. + optional string value = 1; +} + +// Labels of a product offer. This listing dimension is deprecated and it is +// supported only in Display campaigns. +message ProductLabelsInfo { + // String value of the product labels. + optional string value = 1; +} + +// Legacy condition of a product offer. This listing dimension is deprecated and +// it is supported only in Display campaigns. +message ProductLegacyConditionInfo { + // String value of the product legacy condition. + optional string value = 1; +} + +// Full type of a product offer. This listing dimension is deprecated and it is +// supported only in Display campaigns. +message ProductTypeFullInfo { + // String value of the product full type. + optional string value = 1; } // Unknown listing dimension. @@ -284,10 +324,10 @@ 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.v9.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType type = 1; + google.ads.googleads.v12.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType type = 1; } // Criterion for number of days prior to the stay the booking is being made. @@ -320,13 +360,13 @@ message HotelCheckInDateRangeInfo { // Criterion for day of the week the booking is for. message HotelCheckInDayInfo { // The day of the week. - google.ads.googleads.v9.enums.DayOfWeekEnum.DayOfWeek day_of_week = 1; + google.ads.googleads.v12.enums.DayOfWeekEnum.DayOfWeek day_of_week = 1; } // Criterion for Interaction Type. message InteractionTypeInfo { // The interaction type. - google.ads.googleads.v9.enums.InteractionTypeEnum.InteractionType type = 1; + google.ads.googleads.v12.enums.InteractionTypeEnum.InteractionType type = 1; } // Represents an AdSchedule criterion. @@ -340,14 +380,14 @@ message AdScheduleInfo { // // This field is required for CREATE operations and is prohibited on UPDATE // operations. - google.ads.googleads.v9.enums.MinuteOfHourEnum.MinuteOfHour start_minute = 1; + google.ads.googleads.v12.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.v9.enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2; + google.ads.googleads.v12.enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2; // Starting hour in 24 hour time. // This field must be between 0 and 23, inclusive. @@ -367,31 +407,31 @@ message AdScheduleInfo { // // This field is required for CREATE operations and is prohibited on UPDATE // operations. - google.ads.googleads.v9.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; + google.ads.googleads.v12.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; } // An age range criterion. message AgeRangeInfo { // Type of the age range. - google.ads.googleads.v9.enums.AgeRangeTypeEnum.AgeRangeType type = 1; + google.ads.googleads.v12.enums.AgeRangeTypeEnum.AgeRangeType type = 1; } // A gender criterion. message GenderInfo { // Type of the gender. - google.ads.googleads.v9.enums.GenderTypeEnum.GenderType type = 1; + google.ads.googleads.v12.enums.GenderTypeEnum.GenderType type = 1; } // An income range criterion. message IncomeRangeInfo { // Type of the income range. - google.ads.googleads.v9.enums.IncomeRangeTypeEnum.IncomeRangeType type = 1; + google.ads.googleads.v12.enums.IncomeRangeTypeEnum.IncomeRangeType type = 1; } // A parental status criterion. message ParentalStatusInfo { // Type of the parental status. - google.ads.googleads.v9.enums.ParentalStatusTypeEnum.ParentalStatusType type = 1; + google.ads.googleads.v12.enums.ParentalStatusTypeEnum.ParentalStatusType type = 1; } // A YouTube Video criterion. @@ -429,7 +469,7 @@ message ProximityInfo { optional double radius = 5; // The unit of measurement of the radius. Default is KILOMETERS. - google.ads.googleads.v9.enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits radius_units = 3; + google.ads.googleads.v12.enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits radius_units = 3; // Full address. AddressInfo address = 4; @@ -503,7 +543,7 @@ message IpBlockInfo { // Content Label for category exclusion. message ContentLabelInfo { // Content label type, required for CREATE operations. - google.ads.googleads.v9.enums.ContentLabelTypeEnum.ContentLabelType type = 1; + google.ads.googleads.v12.enums.ContentLabelTypeEnum.ContentLabelType type = 1; } // Represents a Carrier Criterion. @@ -530,7 +570,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. @@ -550,10 +591,10 @@ message WebpageInfo { // Logical expression for targeting webpages of an advertiser's website. message WebpageConditionInfo { // Operand of webpage targeting condition. - google.ads.googleads.v9.enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1; + google.ads.googleads.v12.enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1; // Operator of webpage targeting condition. - google.ads.googleads.v9.enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2; + google.ads.googleads.v12.enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2; // Argument of webpage targeting condition. optional string argument = 4; @@ -574,7 +615,7 @@ message OperatingSystemVersionInfo { // An app payment model criterion. message AppPaymentModelInfo { // Type of the app payment model. - google.ads.googleads.v9.enums.AppPaymentModelTypeEnum.AppPaymentModelType type = 1; + google.ads.googleads.v12.enums.AppPaymentModelTypeEnum.AppPaymentModelType type = 1; } // A mobile device criterion. @@ -597,14 +638,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. @@ -612,15 +654,30 @@ 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.v9.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.v12.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. @@ -635,6 +692,12 @@ message CombinedAudienceInfo { string combined_audience = 1; } +// An audience criterion. +message AudienceInfo { + // The Audience resource name. + string audience = 1; +} + // A Smart Campaign keyword theme. message KeywordThemeInfo { // Either a predefined keyword theme constant or free-form text may be diff --git a/google/ads/googleads/v9/common/criterion_category_availability.proto b/google/ads/googleads/v12/common/criterion_category_availability.proto similarity index 69% rename from google/ads/googleads/v9/common/criterion_category_availability.proto rename to google/ads/googleads/v12/common/criterion_category_availability.proto index 811ee4e0d..d3a02443f 100644 --- a/google/ads/googleads/v9/common/criterion_category_availability.proto +++ b/google/ads/googleads/v12/common/criterion_category_availability.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/advertising_channel_sub_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/criterion_category_channel_availability_mode.proto"; -import "google/ads/googleads/v9/enums/criterion_category_locale_availability_mode.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_sub_type.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_type.proto"; +import "google/ads/googleads/v12/enums/criterion_category_channel_availability_mode.proto"; +import "google/ads/googleads/v12/enums/criterion_category_locale_availability_mode.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "CriterionCategoryAvailabilityProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing criterion category availability information. @@ -51,13 +50,13 @@ 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.v9.enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1; + google.ads.googleads.v12.enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1; // Channel type the category is available to. - google.ads.googleads.v9.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2; + google.ads.googleads.v12.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2; // Channel subtypes under the channel type the category is available to. - repeated google.ads.googleads.v9.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 3; + repeated google.ads.googleads.v12.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 @@ -72,7 +71,7 @@ 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.v9.enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1; + google.ads.googleads.v12.enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1; // Code of the country. optional string country_code = 4; diff --git a/google/ads/googleads/v9/common/custom_parameter.proto b/google/ads/googleads/v12/common/custom_parameter.proto similarity index 74% rename from google/ads/googleads/v9/common/custom_parameter.proto rename to google/ads/googleads/v12/common/custom_parameter.proto index 4bc74113f..d8d4f601c 100644 --- a/google/ads/googleads/v9/common/custom_parameter.proto +++ b/google/ads/googleads/v12/common/custom_parameter.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "CustomParameterProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing CustomParameter and operation diff --git a/google/ads/googleads/v9/common/customizer_value.proto b/google/ads/googleads/v12/common/customizer_value.proto similarity index 70% rename from google/ads/googleads/v9/common/customizer_value.proto rename to google/ads/googleads/v12/common/customizer_value.proto index 46b96fa8f..476892caa 100644 --- a/google/ads/googleads/v9/common/customizer_value.proto +++ b/google/ads/googleads/v12/common/customizer_value.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/customizer_attribute_type.proto"; +import "google/ads/googleads/v12/enums/customizer_attribute_type.proto"; import "google/api/field_behavior.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "CustomizerValueProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing common customizer value proto messages. @@ -37,7 +36,7 @@ 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.v9.enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 1 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.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. diff --git a/google/ads/googleads/v9/common/dates.proto b/google/ads/googleads/v12/common/dates.proto similarity index 70% rename from google/ads/googleads/v9/common/dates.proto rename to google/ads/googleads/v12/common/dates.proto index 4ae678e57..168f9bf54 100644 --- a/google/ads/googleads/v9/common/dates.proto +++ b/google/ads/googleads/v12/common/dates.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. @@ -14,19 +14,18 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/month_of_year.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/month_of_year.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "DatesProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing date range message. @@ -51,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.v9.enums.MonthOfYearEnum.MonthOfYear month = 2; + // The month of the year. (for example, FEBRUARY). + google.ads.googleads.v12.enums.MonthOfYearEnum.MonthOfYear month = 2; } diff --git a/google/ads/googleads/v9/common/explorer_auto_optimizer_setting.proto b/google/ads/googleads/v12/common/explorer_auto_optimizer_setting.proto similarity index 74% rename from google/ads/googleads/v9/common/explorer_auto_optimizer_setting.proto rename to google/ads/googleads/v12/common/explorer_auto_optimizer_setting.proto index 51a368b43..97982e9e9 100644 --- a/google/ads/googleads/v9/common/explorer_auto_optimizer_setting.proto +++ b/google/ads/googleads/v12/common/explorer_auto_optimizer_setting.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "ExplorerAutoOptimizerSettingProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing ExplorerAutoOptimizerSetting diff --git a/google/ads/googleads/v9/common/extensions.proto b/google/ads/googleads/v12/common/extensions.proto similarity index 86% rename from google/ads/googleads/v9/common/extensions.proto rename to google/ads/googleads/v12/common/extensions.proto index 2a91b364c..62569d561 100644 --- a/google/ads/googleads/v9/common/extensions.proto +++ b/google/ads/googleads/v12/common/extensions.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. @@ -14,29 +14,28 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; - -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/feed_common.proto"; -import "google/ads/googleads/v9/enums/app_store.proto"; -import "google/ads/googleads/v9/enums/call_conversion_reporting_state.proto"; -import "google/ads/googleads/v9/enums/price_extension_price_qualifier.proto"; -import "google/ads/googleads/v9/enums/price_extension_price_unit.proto"; -import "google/ads/googleads/v9/enums/price_extension_type.proto"; -import "google/ads/googleads/v9/enums/promotion_extension_discount_modifier.proto"; -import "google/ads/googleads/v9/enums/promotion_extension_occasion.proto"; +package google.ads.googleads.v12.common; + +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/feed_common.proto"; +import "google/ads/googleads/v12/enums/app_store.proto"; +import "google/ads/googleads/v12/enums/call_conversion_reporting_state.proto"; +import "google/ads/googleads/v12/enums/price_extension_price_qualifier.proto"; +import "google/ads/googleads/v12/enums/price_extension_price_unit.proto"; +import "google/ads/googleads/v12/enums/price_extension_type.proto"; +import "google/ads/googleads/v12/enums/promotion_extension_discount_modifier.proto"; +import "google/ads/googleads/v12/enums/promotion_extension_occasion.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "ExtensionsProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing extension types. @@ -53,7 +52,7 @@ message AppFeedItem { // The application store that the target application belongs to. // This field is required. - google.ads.googleads.v9.enums.AppStoreEnum.AppStore app_store = 3; + google.ads.googleads.v12.enums.AppStoreEnum.AppStore app_store = 3; // A list of possible final URLs after all cross domain redirects. // This list must not be empty. @@ -100,7 +99,7 @@ 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.v9.enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 6; + google.ads.googleads.v12.enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 6; } // Represents a callout extension. @@ -195,10 +194,10 @@ message TextMessageFeedItem { // Represents a Price extension. message PriceFeedItem { // Price extension type of this extension. - google.ads.googleads.v9.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1; + google.ads.googleads.v12.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1; // Price qualifier for all offers of this price extension. - google.ads.googleads.v9.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2; + google.ads.googleads.v12.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2; // Tracking URL template for all offers of this price extension. optional string tracking_url_template = 7; @@ -225,7 +224,7 @@ message PriceOffer { Money price = 3; // Price unit for this offer. - google.ads.googleads.v9.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4; + google.ads.googleads.v12.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4; // A list of possible final URLs after all cross domain redirects. repeated string final_urls = 9; @@ -241,7 +240,7 @@ message PromotionFeedItem { optional string promotion_target = 16; // Enum that modifies the qualification of the discount. - google.ads.googleads.v9.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2; + google.ads.googleads.v12.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2; // Start date of when the promotion is eligible to be redeemed. optional string promotion_start_date = 19; @@ -252,7 +251,7 @@ 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.v9.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9; + google.ads.googleads.v12.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9; // A list of possible final URLs after all cross domain redirects. // This field is required. diff --git a/google/ads/googleads/v9/common/feed_common.proto b/google/ads/googleads/v12/common/feed_common.proto similarity index 73% rename from google/ads/googleads/v9/common/feed_common.proto rename to google/ads/googleads/v12/common/feed_common.proto index 60aef6220..59c070ee5 100644 --- a/google/ads/googleads/v9/common/feed_common.proto +++ b/google/ads/googleads/v12/common/feed_common.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "FeedCommonProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing common feed proto messages. diff --git a/google/ads/googleads/v9/common/feed_item_set_filter_type_infos.proto b/google/ads/googleads/v12/common/feed_item_set_filter_type_infos.proto similarity index 76% rename from google/ads/googleads/v9/common/feed_item_set_filter_type_infos.proto rename to google/ads/googleads/v12/common/feed_item_set_filter_type_infos.proto index 9331c983d..84564e850 100644 --- a/google/ads/googleads/v9/common/feed_item_set_filter_type_infos.proto +++ b/google/ads/googleads/v12/common/feed_item_set_filter_type_infos.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. @@ -14,19 +14,18 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/feed_item_set_string_filter_type.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/feed_item_set_string_filter_type.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetFilterTypeInfosProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Represents a filter on locations in a feed item set. // Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed. @@ -45,7 +44,7 @@ message BusinessNameFilter { string business_name = 1; // The type of string matching to use when filtering with business_name. - google.ads.googleads.v9.enums.FeedItemSetStringFilterTypeEnum.FeedItemSetStringFilterType filter_type = 2; + google.ads.googleads.v12.enums.FeedItemSetStringFilterTypeEnum.FeedItemSetStringFilterType filter_type = 2; } // Represents a filter on affiliate locations in a FeedItemSet. diff --git a/google/ads/googleads/v9/common/final_app_url.proto b/google/ads/googleads/v12/common/final_app_url.proto similarity index 72% rename from google/ads/googleads/v9/common/final_app_url.proto rename to google/ads/googleads/v12/common/final_app_url.proto index 674161c9c..13add9296 100644 --- a/google/ads/googleads/v9/common/final_app_url.proto +++ b/google/ads/googleads/v12/common/final_app_url.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. @@ -14,26 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/app_url_operating_system_type.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/app_url_operating_system_type.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "FinalAppUrlProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v9.enums.AppUrlOperatingSystemTypeEnum.AppUrlOperatingSystemType os_type = 1; + google.ads.googleads.v12.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/google/ads/googleads/v9/common/frequency_cap.proto b/google/ads/googleads/v12/common/frequency_cap.proto similarity index 56% rename from google/ads/googleads/v9/common/frequency_cap.proto rename to google/ads/googleads/v12/common/frequency_cap.proto index 39b47bbec..bb7de0cae 100644 --- a/google/ads/googleads/v9/common/frequency_cap.proto +++ b/google/ads/googleads/v12/common/frequency_cap.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/frequency_cap_event_type.proto"; -import "google/ads/googleads/v9/enums/frequency_cap_level.proto"; -import "google/ads/googleads/v9/enums/frequency_cap_time_unit.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/frequency_cap_event_type.proto"; +import "google/ads/googleads/v12/enums/frequency_cap_level.proto"; +import "google/ads/googleads/v12/enums/frequency_cap_time_unit.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "FrequencyCapProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing frequency caps. @@ -46,15 +45,15 @@ 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.v9.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1; + // 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.v12.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1; - // The type of event that the cap applies to (e.g. impression). - google.ads.googleads.v9.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3; + // The type of event that the cap applies to (for example, impression). + google.ads.googleads.v12.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3; - // Unit of time the cap is defined at (e.g. day, week). - google.ads.googleads.v9.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2; + // Unit of time the cap is defined at (for example, day, week). + google.ads.googleads.v12.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2; // Number of time units the cap lasts. optional int32 time_length = 5; diff --git a/google/ads/googleads/v9/common/keyword_plan_common.proto b/google/ads/googleads/v12/common/keyword_plan_common.proto similarity index 70% rename from google/ads/googleads/v9/common/keyword_plan_common.proto rename to google/ads/googleads/v12/common/keyword_plan_common.proto index 3a28644f9..31e043bd0 100644 --- a/google/ads/googleads/v9/common/keyword_plan_common.proto +++ b/google/ads/googleads/v12/common/keyword_plan_common.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/common/dates.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_aggregate_metric_type.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_competition_level.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_concept_group_type.proto"; -import "google/ads/googleads/v9/enums/month_of_year.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/common/dates.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_aggregate_metric_type.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_competition_level.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_concept_group_type.proto"; +import "google/ads/googleads/v12/enums/month_of_year.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCommonProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing Keyword Planner messages. @@ -48,7 +47,7 @@ message KeywordPlanHistoricalMetrics { repeated MonthlySearchVolume monthly_search_volumes = 6; // The competition level for the query. - google.ads.googleads.v9.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2; + google.ads.googleads.v12.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. @@ -62,6 +61,9 @@ message KeywordPlanHistoricalMetrics { // Top of page bid high range (80th percentile) in micros for the keyword. optional int64 high_top_of_page_bid_micros = 10; + + // Average Cost Per Click in micros for the keyword. + optional int64 average_cpc_micros = 11; } // Historical metrics options. @@ -72,15 +74,22 @@ message HistoricalMetricsOptions { // not available for the entire year_month_range provided, the subset of the // year month range for which search volume is available will be returned. optional YearMonthRange year_month_range = 1; + + // Indicates whether to include average cost per click value. + // Average CPC is a legacy value that will be removed and replaced in the + // future, and as such we are including it as an optioanl value so clients + // only use it when strictly necessary and to better track clients that use + // this value. + bool include_average_cpc = 2; } // 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.v9.enums.MonthOfYearEnum.MonthOfYear month = 2; + google.ads.googleads.v12.enums.MonthOfYearEnum.MonthOfYear month = 2; // Approximate number of searches for the month. // A null value indicates the search volume is unavailable for @@ -91,7 +100,7 @@ message MonthlySearchVolume { // The aggregate metrics specification of the request. message KeywordPlanAggregateMetrics { // The list of aggregate metrics to fetch data. - repeated google.ads.googleads.v9.enums.KeywordPlanAggregateMetricTypeEnum.KeywordPlanAggregateMetricType aggregate_metric_types = 1; + repeated google.ads.googleads.v12.enums.KeywordPlanAggregateMetricTypeEnum.KeywordPlanAggregateMetricType aggregate_metric_types = 1; } // The aggregated historical metrics for keyword plan keywords. @@ -108,7 +117,7 @@ message KeywordPlanAggregateMetricResults { // The total searches for the device type during the specified time period. message KeywordPlanDeviceSearches { // The device type. - google.ads.googleads.v9.enums.DeviceEnum.Device device = 1; + google.ads.googleads.v12.enums.DeviceEnum.Device device = 1; // The total searches for the device. optional int64 search_count = 2; @@ -135,5 +144,5 @@ message ConceptGroup { string name = 1; // The concept group type. - google.ads.googleads.v9.enums.KeywordPlanConceptGroupTypeEnum.KeywordPlanConceptGroupType type = 2; + google.ads.googleads.v12.enums.KeywordPlanConceptGroupTypeEnum.KeywordPlanConceptGroupType type = 2; } diff --git a/google/ads/googleads/v9/common/matching_function.proto b/google/ads/googleads/v12/common/matching_function.proto similarity index 84% rename from google/ads/googleads/v9/common/matching_function.proto rename to google/ads/googleads/v12/common/matching_function.proto index 1300f30e7..749db42e1 100644 --- a/google/ads/googleads/v9/common/matching_function.proto +++ b/google/ads/googleads/v12/common/matching_function.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/matching_function_context_type.proto"; -import "google/ads/googleads/v9/enums/matching_function_operator.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/matching_function_context_type.proto"; +import "google/ads/googleads/v12/enums/matching_function_operator.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "MatchingFunctionProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing a matching function. @@ -55,7 +54,7 @@ message MatchingFunction { optional string function_string = 5; // Operator for a function. - google.ads.googleads.v9.enums.MatchingFunctionOperatorEnum.MatchingFunctionOperator operator = 4; + google.ads.googleads.v12.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. @@ -105,7 +104,7 @@ 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.v9.enums.MatchingFunctionContextTypeEnum.MatchingFunctionContextType context_type = 1; + google.ads.googleads.v12.enums.MatchingFunctionContextTypeEnum.MatchingFunctionContextType context_type = 1; } // Different operands that can be used in a matching function. Required. diff --git a/google/ads/googleads/v12/common/metric_goal.proto b/google/ads/googleads/v12/common/metric_goal.proto new file mode 100644 index 000000000..d03613690 --- /dev/null +++ b/google/ads/googleads/v12/common/metric_goal.proto @@ -0,0 +1,42 @@ +// 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.v12.common; + +import "google/ads/googleads/v12/enums/experiment_metric.proto"; +import "google/ads/googleads/v12/enums/experiment_metric_direction.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; +option java_multiple_files = true; +option java_outer_classname = "MetricGoalProto"; +option java_package = "com.google.ads.googleads.v12.common"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; + +// Proto file describing experiment metric goal. + +// A metric goal for an experiment. +message MetricGoal { + // The metric of the goal. For example, clicks, impressions, cost, + // conversions, etc. + google.ads.googleads.v12.enums.ExperimentMetricEnum.ExperimentMetric metric = 1; + + // The metric direction of the goal. For example, increase, decrease, no + // change. + google.ads.googleads.v12.enums.ExperimentMetricDirectionEnum.ExperimentMetricDirection direction = 2; +} diff --git a/google/ads/googleads/v9/common/metrics.proto b/google/ads/googleads/v12/common/metrics.proto similarity index 78% rename from google/ads/googleads/v9/common/metrics.proto rename to google/ads/googleads/v12/common/metrics.proto index 377bbcac2..72933a4da 100644 --- a/google/ads/googleads/v9/common/metrics.proto +++ b/google/ads/googleads/v12/common/metrics.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/interaction_event_type.proto"; -import "google/ads/googleads/v9/enums/quality_score_bucket.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/interaction_event_type.proto"; +import "google/ads/googleads/v12/enums/quality_score_bucket.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "MetricsProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing metrics. @@ -130,6 +129,48 @@ message Metrics { // 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; @@ -161,6 +202,12 @@ message Metrics { // An indication of how other advertisers are bidding on similar products. optional double benchmark_average_max_cpc = 210; + // Number of app installs. + optional double biddable_app_install_conversions = 254; + + // Number of in-app actions. + optional double biddable_app_post_install_conversions = 255; + // An indication on how other advertisers' Shopping ads for similar products // are performing based on how often people who see their ad click on it. optional double benchmark_ctr = 211; @@ -202,9 +249,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 @@ -343,6 +390,14 @@ message Metrics { // Average lead value based on clicks. optional double hotel_average_lead_value_micros = 213; + // Commission bid rate in micros. A 20% commission is represented as + // 200,000. + optional int64 hotel_commission_rate_micros = 256; + + // Expected commission cost. The result of multiplying the commission value + // times the hotel_commission_rate in advertiser currency. + optional double hotel_expected_commission_cost = 257; + // The average price difference between the price offered by reporting hotel // advertiser and the cheapest price offered by the competing advertiser. optional double hotel_price_difference_percentage = 214; @@ -352,16 +407,16 @@ message Metrics { optional int64 hotel_eligible_impressions = 215; // The creative historical quality score. - google.ads.googleads.v9.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; + google.ads.googleads.v12.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; // The quality of historical landing page experience. - google.ads.googleads.v9.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81; + google.ads.googleads.v12.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.v9.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83; + google.ads.googleads.v12.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; @@ -393,7 +448,7 @@ message Metrics { optional int64 interactions = 223; // The types of payable and free interactions. - repeated google.ads.googleads.v9.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100; + repeated google.ads.googleads.v12.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. @@ -610,10 +665,90 @@ 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/google/ads/googleads/v9/common/offline_user_data.proto b/google/ads/googleads/v12/common/offline_user_data.proto similarity index 80% rename from google/ads/googleads/v9/common/offline_user_data.proto rename to google/ads/googleads/v12/common/offline_user_data.proto index ba80cef0d..eac4f3705 100644 --- a/google/ads/googleads/v9/common/offline_user_data.proto +++ b/google/ads/googleads/v12/common/offline_user_data.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. @@ -14,19 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/user_identifier_source.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/user_identifier_source.proto"; +import "google/api/field_behavior.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing offline user data. @@ -65,7 +65,7 @@ message OfflineUserAddressInfo { message UserIdentifier { // Source of the user identifier when the upload is from Store Sales, // ConversionUploadService, or ConversionAdjustmentUploadService. - google.ads.googleads.v9.enums.UserIdentifierSourceEnum.UserIdentifierSource user_identifier_source = 6; + google.ads.googleads.v12.enums.UserIdentifierSourceEnum.UserIdentifierSource user_identifier_source = 6; // Exactly one must be specified. For OfflineUserDataJobService, Customer // Match accepts hashed_email, hashed_phone_number, mobile_id, @@ -214,8 +214,46 @@ message UserAttribute { // The shopping loyalty related data. Shopping utilizes this data to provide // users with a better experience. Accessible only to merchants on the - // allow-list with users’ consent. + // 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 @@ -237,10 +275,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 @@ -261,7 +298,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/google/ads/googleads/v9/common/policy.proto b/google/ads/googleads/v12/common/policy.proto similarity index 81% rename from google/ads/googleads/v9/common/policy.proto rename to google/ads/googleads/v12/common/policy.proto index d3741b5a2..09bfa4b19 100644 --- a/google/ads/googleads/v9/common/policy.proto +++ b/google/ads/googleads/v12/common/policy.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/policy_topic_entry_type.proto"; -import "google/ads/googleads/v9/enums/policy_topic_evidence_destination_mismatch_url_type.proto"; -import "google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_device.proto"; -import "google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/policy_topic_entry_type.proto"; +import "google/ads/googleads/v12/enums/policy_topic_evidence_destination_mismatch_url_type.proto"; +import "google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_device.proto"; +import "google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "PolicyProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing policy information. @@ -41,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; @@ -61,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 @@ -71,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 @@ -87,14 +86,14 @@ message PolicyTopicEntry { optional string topic = 5; // Describes the negative or positive effect this policy will have on serving. - google.ads.googleads.v9.enums.PolicyTopicEntryTypeEnum.PolicyTopicEntryType type = 2; + google.ads.googleads.v12.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; } @@ -125,7 +124,7 @@ 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.v9.enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1; + repeated google.ads.googleads.v12.enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1; } // Evidence details when the destination is returning an HTTP error @@ -135,7 +134,7 @@ message PolicyTopicEvidence { optional string expanded_url = 7; // The type of device that failed to load the URL. - google.ads.googleads.v9.enums.PolicyTopicEvidenceDestinationNotWorkingDeviceEnum.PolicyTopicEvidenceDestinationNotWorkingDevice device = 4; + google.ads.googleads.v12.enums.PolicyTopicEvidenceDestinationNotWorkingDeviceEnum.PolicyTopicEvidenceDestinationNotWorkingDevice device = 4; // The time the URL was last checked. // The format is "YYYY-MM-DD HH:MM:SS". @@ -145,7 +144,7 @@ message PolicyTopicEvidence { // Indicates the reason of the DESTINATION_NOT_WORKING policy finding. oneof reason { // The type of DNS error. - google.ads.googleads.v9.enums.PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum.PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type = 1; + google.ads.googleads.v12.enums.PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum.PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type = 1; // The HTTP error code. int64 http_error_code = 6; diff --git a/google/ads/googleads/v9/common/policy_summary.proto b/google/ads/googleads/v12/common/policy_summary.proto similarity index 59% rename from google/ads/googleads/v9/common/policy_summary.proto rename to google/ads/googleads/v12/common/policy_summary.proto index e84f3682e..ad19b53c3 100644 --- a/google/ads/googleads/v9/common/policy_summary.proto +++ b/google/ads/googleads/v12/common/policy_summary.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "PolicySummaryProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing policy summary. @@ -38,9 +37,9 @@ message PolicySummary { repeated PolicyTopicEntry policy_topic_entries = 1; // Where in the review process the resource is. - google.ads.googleads.v9.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2; + google.ads.googleads.v12.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3; + google.ads.googleads.v12.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3; } diff --git a/google/ads/googleads/v9/common/real_time_bidding_setting.proto b/google/ads/googleads/v12/common/real_time_bidding_setting.proto similarity index 73% rename from google/ads/googleads/v9/common/real_time_bidding_setting.proto rename to google/ads/googleads/v12/common/real_time_bidding_setting.proto index c827b26e1..e296e8249 100644 --- a/google/ads/googleads/v9/common/real_time_bidding_setting.proto +++ b/google/ads/googleads/v12/common/real_time_bidding_setting.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "RealTimeBiddingSettingProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing RealTimeBiddingSetting diff --git a/google/ads/googleads/v9/common/segments.proto b/google/ads/googleads/v12/common/segments.proto similarity index 54% rename from google/ads/googleads/v9/common/segments.proto rename to google/ads/googleads/v12/common/segments.proto index 5fe127bc6..cb6feacf4 100644 --- a/google/ads/googleads/v9/common/segments.proto +++ b/google/ads/googleads/v12/common/segments.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. @@ -14,99 +14,107 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; - -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/ad_destination_type.proto"; -import "google/ads/googleads/v9/enums/ad_network_type.proto"; -import "google/ads/googleads/v9/enums/budget_campaign_association_status.proto"; -import "google/ads/googleads/v9/enums/click_type.proto"; -import "google/ads/googleads/v9/enums/conversion_action_category.proto"; -import "google/ads/googleads/v9/enums/conversion_attribution_event_type.proto"; -import "google/ads/googleads/v9/enums/conversion_lag_bucket.proto"; -import "google/ads/googleads/v9/enums/conversion_or_adjustment_lag_bucket.proto"; -import "google/ads/googleads/v9/enums/conversion_value_rule_primary_dimension.proto"; -import "google/ads/googleads/v9/enums/day_of_week.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/external_conversion_source.proto"; -import "google/ads/googleads/v9/enums/hotel_date_selection_type.proto"; -import "google/ads/googleads/v9/enums/hotel_price_bucket.proto"; -import "google/ads/googleads/v9/enums/hotel_rate_type.proto"; -import "google/ads/googleads/v9/enums/month_of_year.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; -import "google/ads/googleads/v9/enums/product_channel.proto"; -import "google/ads/googleads/v9/enums/product_channel_exclusivity.proto"; -import "google/ads/googleads/v9/enums/product_condition.proto"; -import "google/ads/googleads/v9/enums/recommendation_type.proto"; -import "google/ads/googleads/v9/enums/search_engine_results_page_type.proto"; -import "google/ads/googleads/v9/enums/search_term_match_type.proto"; -import "google/ads/googleads/v9/enums/slot.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +package google.ads.googleads.v12.common; + +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/ad_destination_type.proto"; +import "google/ads/googleads/v12/enums/ad_network_type.proto"; +import "google/ads/googleads/v12/enums/budget_campaign_association_status.proto"; +import "google/ads/googleads/v12/enums/click_type.proto"; +import "google/ads/googleads/v12/enums/conversion_action_category.proto"; +import "google/ads/googleads/v12/enums/conversion_attribution_event_type.proto"; +import "google/ads/googleads/v12/enums/conversion_lag_bucket.proto"; +import "google/ads/googleads/v12/enums/conversion_or_adjustment_lag_bucket.proto"; +import "google/ads/googleads/v12/enums/conversion_value_rule_primary_dimension.proto"; +import "google/ads/googleads/v12/enums/day_of_week.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/external_conversion_source.proto"; +import "google/ads/googleads/v12/enums/hotel_date_selection_type.proto"; +import "google/ads/googleads/v12/enums/hotel_price_bucket.proto"; +import "google/ads/googleads/v12/enums/hotel_rate_type.proto"; +import "google/ads/googleads/v12/enums/month_of_year.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/enums/product_channel.proto"; +import "google/ads/googleads/v12/enums/product_channel_exclusivity.proto"; +import "google/ads/googleads/v12/enums/product_condition.proto"; +import "google/ads/googleads/v12/enums/recommendation_type.proto"; +import "google/ads/googleads/v12/enums/search_engine_results_page_type.proto"; +import "google/ads/googleads/v12/enums/search_term_match_type.proto"; +import "google/ads/googleads/v12/enums/sk_ad_network_ad_event_type.proto"; +import "google/ads/googleads/v12/enums/sk_ad_network_attribution_credit.proto"; +import "google/ads/googleads/v12/enums/sk_ad_network_user_type.proto"; +import "google/ads/googleads/v12/enums/slot.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "SegmentsProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing segment only fields. // Segment only fields. message Segments { // Ad Destination type. - google.ads.googleads.v9.enums.AdDestinationTypeEnum.AdDestinationType ad_destination_type = 136; + google.ads.googleads.v12.enums.AdDestinationTypeEnum.AdDestinationType ad_destination_type = 136; // Ad network type. - google.ads.googleads.v9.enums.AdNetworkTypeEnum.AdNetworkType ad_network_type = 3; + google.ads.googleads.v12.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.v9.enums.ClickTypeEnum.ClickType click_type = 26; + google.ads.googleads.v12.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.v9.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_category = 53; + google.ads.googleads.v12.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.v9.enums.ConversionAttributionEventTypeEnum.ConversionAttributionEventType conversion_attribution_event_type = 2; + google.ads.googleads.v12.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.v9.enums.ConversionLagBucketEnum.ConversionLagBucket conversion_lag_bucket = 50; + google.ads.googleads.v12.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.v9.enums.ConversionOrAdjustmentLagBucketEnum.ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51; + google.ads.googleads.v12.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.v9.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; + // Day of the week, for example, MONDAY. + google.ads.googleads.v12.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; // Device to which metrics apply. - google.ads.googleads.v9.enums.DeviceEnum.Device device = 1; + google.ads.googleads.v12.enums.DeviceEnum.Device device = 1; // External conversion source. - google.ads.googleads.v9.enums.ExternalConversionSourceEnum.ExternalConversionSource external_conversion_source = 55; + google.ads.googleads.v12.enums.ExternalConversionSourceEnum.ExternalConversionSource external_conversion_source = 55; // Resource name of the geo target constant that represents an airport. optional string geo_target_airport = 116; @@ -155,7 +163,7 @@ message Segments { optional string hotel_check_in_date = 81; // Hotel check-in day of week. - google.ads.googleads.v9.enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 9; + google.ads.googleads.v12.enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 9; // Hotel city. optional string hotel_city = 82; @@ -167,7 +175,7 @@ message Segments { optional string hotel_country = 84; // Hotel date selection type. - google.ads.googleads.v9.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 13; + google.ads.googleads.v12.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 13; // Hotel length of stay. optional int32 hotel_length_of_stay = 85; @@ -176,10 +184,10 @@ message Segments { optional string hotel_rate_rule_id = 86; // Hotel rate type. - google.ads.googleads.v9.enums.HotelRateTypeEnum.HotelRateType hotel_rate_type = 74; + google.ads.googleads.v12.enums.HotelRateTypeEnum.HotelRateType hotel_rate_type = 74; // Hotel price bucket. - google.ads.googleads.v9.enums.HotelPriceBucketEnum.HotelPriceBucket hotel_price_bucket = 78; + google.ads.googleads.v12.enums.HotelPriceBucketEnum.HotelPriceBucket hotel_price_bucket = 78; // Hotel state. optional string hotel_state = 87; @@ -199,14 +207,14 @@ message Segments { // yyyy-MM-dd. optional string month = 90; - // Month of the year, e.g., January. - google.ads.googleads.v9.enums.MonthOfYearEnum.MonthOfYear month_of_year = 18; + // Month of the year, for example, January. + google.ads.googleads.v12.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.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 20; + google.ads.googleads.v12.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 20; // Aggregator ID of the product. optional int64 product_aggregator_id = 132; @@ -230,13 +238,13 @@ message Segments { optional string product_brand = 97; // Channel of the product. - google.ads.googleads.v9.enums.ProductChannelEnum.ProductChannel product_channel = 30; + google.ads.googleads.v12.enums.ProductChannelEnum.ProductChannel product_channel = 30; // Channel exclusivity of the product. - google.ads.googleads.v9.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity product_channel_exclusivity = 31; + google.ads.googleads.v12.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity product_channel_exclusivity = 31; // Condition of the product. - google.ads.googleads.v9.enums.ProductConditionEnum.ProductCondition product_condition = 32; + google.ads.googleads.v12.enums.ProductConditionEnum.ProductCondition product_condition = 32; // Resource name of the geo target constant for the country of sale of the // product. @@ -288,21 +296,21 @@ 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.v9.enums.RecommendationTypeEnum.RecommendationType recommendation_type = 140; + google.ads.googleads.v12.enums.RecommendationTypeEnum.RecommendationType recommendation_type = 140; // Type of the search engine results page. - google.ads.googleads.v9.enums.SearchEngineResultsPageTypeEnum.SearchEngineResultsPageType search_engine_results_page_type = 70; + google.ads.googleads.v12.enums.SearchEngineResultsPageTypeEnum.SearchEngineResultsPageType search_engine_results_page_type = 70; // Match type of the keyword that triggered the ad, including variants. - google.ads.googleads.v9.enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 22; + google.ads.googleads.v12.enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 22; // Position of the ad. - google.ads.googleads.v9.enums.SlotEnum.Slot slot = 23; + google.ads.googleads.v12.enums.SlotEnum.Slot slot = 23; // Primary dimension of applied conversion value rules. // NO_RULE_APPLIED shows the total recorded value of conversions that @@ -311,7 +319,7 @@ message Segments { // has been applied. // GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value // rules were applied. - google.ads.googleads.v9.enums.ConversionValueRulePrimaryDimensionEnum.ConversionValueRulePrimaryDimension conversion_value_rule_primary_dimension = 138; + google.ads.googleads.v12.enums.ConversionValueRulePrimaryDimensionEnum.ConversionValueRulePrimaryDimension conversion_value_rule_primary_dimension = 138; // Resource name of the ad group criterion that represents webpage criterion. optional string webpage = 129; @@ -324,18 +332,34 @@ 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.v12.enums.SkAdNetworkUserTypeEnum.SkAdNetworkUserType sk_ad_network_user_type = 141; + + // iOS Store Kit Ad Network ad event type. + google.ads.googleads.v12.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, 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.v12.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; } @@ -354,7 +378,7 @@ message BudgetCampaignAssociationStatus { optional string campaign = 1; // Budget campaign association status. - google.ads.googleads.v9.enums.BudgetCampaignAssociationStatusEnum.BudgetCampaignAssociationStatus status = 2; + google.ads.googleads.v12.enums.BudgetCampaignAssociationStatusEnum.BudgetCampaignAssociationStatus status = 2; } // An AssetInteractionTarget segment. @@ -367,3 +391,10 @@ message AssetInteractionTarget { // different asset or ad unit. bool interaction_on_this_asset = 2; } + +// A SkAdNetworkSourceApp segment. +message SkAdNetworkSourceApp { + // App id where the ad that drove the iOS Store Kit Ad Network install was + // shown. + optional string sk_ad_network_source_app_id = 1; +} diff --git a/google/ads/googleads/v9/common/simulation.proto b/google/ads/googleads/v12/common/simulation.proto similarity index 95% rename from google/ads/googleads/v9/common/simulation.proto rename to google/ads/googleads/v12/common/simulation.proto index f2df42331..8e370ff19 100644 --- a/google/ads/googleads/v9/common/simulation.proto +++ b/google/ads/googleads/v12/common/simulation.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "SimulationProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing simulation points. @@ -321,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/google/ads/googleads/v9/common/tag_snippet.proto b/google/ads/googleads/v12/common/tag_snippet.proto similarity index 64% rename from google/ads/googleads/v9/common/tag_snippet.proto rename to google/ads/googleads/v12/common/tag_snippet.proto index 35ad133f0..673786d1f 100644 --- a/google/ads/googleads/v9/common/tag_snippet.proto +++ b/google/ads/googleads/v12/common/tag_snippet.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. @@ -14,31 +14,30 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/tracking_code_page_format.proto"; -import "google/ads/googleads/v9/enums/tracking_code_type.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/tracking_code_page_format.proto"; +import "google/ads/googleads/v12/enums/tracking_code_type.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "TagSnippetProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v9.enums.TrackingCodeTypeEnum.TrackingCodeType type = 1; + google.ads.googleads.v12.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.v9.enums.TrackingCodePageFormatEnum.TrackingCodePageFormat page_format = 2; + // installed, for example, HTML. + google.ads.googleads.v12.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/google/ads/googleads/v9/common/targeting_setting.proto b/google/ads/googleads/v12/common/targeting_setting.proto similarity index 83% rename from google/ads/googleads/v9/common/targeting_setting.proto rename to google/ads/googleads/v12/common/targeting_setting.proto index 10cebf18e..35356b2fc 100644 --- a/google/ads/googleads/v9/common/targeting_setting.proto +++ b/google/ads/googleads/v12/common/targeting_setting.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. @@ -14,19 +14,18 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/ads/googleads/v9/enums/targeting_dimension.proto"; -import "google/api/annotations.proto"; +import "google/ads/googleads/v12/enums/targeting_dimension.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "TargetingSettingProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing TargetingSetting @@ -48,7 +47,7 @@ message TargetingSetting { // The list of per-targeting-dimension targeting settings. message TargetRestriction { // The targeting dimension that these settings apply to. - google.ads.googleads.v9.enums.TargetingDimensionEnum.TargetingDimension targeting_dimension = 1; + google.ads.googleads.v12.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/google/ads/googleads/v9/common/text_label.proto b/google/ads/googleads/v12/common/text_label.proto similarity index 76% rename from google/ads/googleads/v9/common/text_label.proto rename to google/ads/googleads/v12/common/text_label.proto index 64f98a7e9..13147a277 100644 --- a/google/ads/googleads/v9/common/text_label.proto +++ b/google/ads/googleads/v12/common/text_label.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "TextLabelProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // A type of label displaying text on a colored background. message TextLabel { diff --git a/google/ads/googleads/v9/common/url_collection.proto b/google/ads/googleads/v12/common/url_collection.proto similarity index 76% rename from google/ads/googleads/v9/common/url_collection.proto rename to google/ads/googleads/v12/common/url_collection.proto index 3a4411fd6..23f794812 100644 --- a/google/ads/googleads/v9/common/url_collection.proto +++ b/google/ads/googleads/v12/common/url_collection.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "UrlCollectionProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file UrlCollection type. diff --git a/google/ads/googleads/v9/common/user_lists.proto b/google/ads/googleads/v12/common/user_lists.proto similarity index 71% rename from google/ads/googleads/v9/common/user_lists.proto rename to google/ads/googleads/v12/common/user_lists.proto index 970b490b9..b72576dcb 100644 --- a/google/ads/googleads/v9/common/user_lists.proto +++ b/google/ads/googleads/v12/common/user_lists.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. @@ -14,27 +14,27 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; - -import "google/ads/googleads/v9/enums/customer_match_upload_key_type.proto"; -import "google/ads/googleads/v9/enums/user_list_combined_rule_operator.proto"; -import "google/ads/googleads/v9/enums/user_list_crm_data_source_type.proto"; -import "google/ads/googleads/v9/enums/user_list_date_rule_item_operator.proto"; -import "google/ads/googleads/v9/enums/user_list_logical_rule_operator.proto"; -import "google/ads/googleads/v9/enums/user_list_number_rule_item_operator.proto"; -import "google/ads/googleads/v9/enums/user_list_prepopulation_status.proto"; -import "google/ads/googleads/v9/enums/user_list_rule_type.proto"; -import "google/ads/googleads/v9/enums/user_list_string_rule_item_operator.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +package google.ads.googleads.v12.common; + +import "google/ads/googleads/v12/enums/customer_match_upload_key_type.proto"; +import "google/ads/googleads/v12/enums/user_list_combined_rule_operator.proto"; +import "google/ads/googleads/v12/enums/user_list_crm_data_source_type.proto"; +import "google/ads/googleads/v12/enums/user_list_date_rule_item_operator.proto"; +import "google/ads/googleads/v12/enums/user_list_flexible_rule_operator.proto"; +import "google/ads/googleads/v12/enums/user_list_logical_rule_operator.proto"; +import "google/ads/googleads/v12/enums/user_list_number_rule_item_operator.proto"; +import "google/ads/googleads/v12/enums/user_list_prepopulation_status.proto"; +import "google/ads/googleads/v12/enums/user_list_rule_type.proto"; +import "google/ads/googleads/v12/enums/user_list_string_rule_item_operator.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "UserListsProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing user list types. @@ -50,10 +50,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. @@ -62,11 +62,11 @@ 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.v9.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType upload_key_type = 2; + google.ads.googleads.v12.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.v9.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType data_source_type = 3; + google.ads.googleads.v12.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType data_source_type = 3; } // A client defined rule based on custom parameters sent by web sites or @@ -80,7 +80,7 @@ message UserListRuleInfo { // // Currently AND of ORs (conjunctive normal form) is only supported for // ExpressionRuleUserList. - google.ads.googleads.v9.enums.UserListRuleTypeEnum.UserListRuleType rule_type = 1; + google.ads.googleads.v12.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. @@ -123,7 +123,7 @@ message UserListDateRuleItemInfo { // Date comparison operator. // This field is required and must be populated when creating new date // rule item. - google.ads.googleads.v9.enums.UserListDateRuleItemOperatorEnum.UserListDateRuleItemOperator operator = 1; + google.ads.googleads.v12.enums.UserListDateRuleItemOperatorEnum.UserListDateRuleItemOperator operator = 1; // String representing date value to be compared with the rule variable. // Supported date format is YYYY-MM-DD. @@ -141,7 +141,7 @@ message UserListNumberRuleItemInfo { // Number comparison operator. // This field is required and must be populated when creating a new number // rule item. - google.ads.googleads.v9.enums.UserListNumberRuleItemOperatorEnum.UserListNumberRuleItemOperator operator = 1; + google.ads.googleads.v12.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 @@ -154,7 +154,7 @@ message UserListStringRuleItemInfo { // String comparison operator. // This field is required and must be populated when creating a new string // rule item. - google.ads.googleads.v9.enums.UserListStringRuleItemOperatorEnum.UserListStringRuleItemOperator operator = 1; + google.ads.googleads.v12.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, @@ -180,27 +180,7 @@ message CombinedRuleUserListInfo { // Operator to connect the two operands. // // Required for creating a combined rule user list. - google.ads.googleads.v9.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. - 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; + google.ads.googleads.v12.enums.UserListCombinedRuleOperatorEnum.UserListCombinedRuleOperator rule_operator = 3; } // Visitors of a page. The page visit is defined by one boolean rule expression. @@ -214,6 +194,31 @@ message ExpressionRuleUserListInfo { UserListRuleInfo rule = 1; } +// 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; + + // Lookback window for this rule in days. From now until X days ago. + optional int64 lookback_window_days = 2; +} + +// Flexible rule representation of visitors with one or multiple actions. +message FlexibleRuleUserListInfo { + // Operator that defines how the inclusive operands are combined. + google.ads.googleads.v12.enums.UserListFlexibleRuleOperatorEnum.UserListFlexibleRuleOperator inclusive_rule_operator = 1; + + // Actions that are located on the inclusive side. + // These are joined together by either AND/OR as specified by the + // inclusive_rule_operator. + repeated FlexibleRuleOperandInfo inclusive_operands = 2; + + // Actions that are located on the exclusive side. + // These are joined together with OR. + repeated FlexibleRuleOperandInfo exclusive_operands = 3; +} + // Representation of a userlist that is generated by a rule. message RuleBasedUserListInfo { // The status of pre-population. The field is default to NONE if not set which @@ -224,7 +229,10 @@ 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.v9.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus prepopulation_status = 1; + google.ads.googleads.v12.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus prepopulation_status = 1; + + // Flexible rule representation of visitors with one or multiple actions. + FlexibleRuleUserListInfo flexible_rule_user_list = 5; // Subtypes of rule based user lists. oneof rule_based_user_list { @@ -233,13 +241,6 @@ message RuleBasedUserListInfo { // 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; @@ -260,7 +261,7 @@ message LogicalUserListInfo { // list of user lists as operands. message UserListLogicalRuleInfo { // The logical operator of the rule. - google.ads.googleads.v9.enums.UserListLogicalRuleOperatorEnum.UserListLogicalRuleOperator operator = 1; + google.ads.googleads.v12.enums.UserListLogicalRuleOperatorEnum.UserListLogicalRuleOperator operator = 1; // The list of operands of the rule. repeated LogicalUserListOperandInfo rule_operands = 2; diff --git a/google/ads/googleads/v9/common/value.proto b/google/ads/googleads/v12/common/value.proto similarity index 74% rename from google/ads/googleads/v9/common/value.proto rename to google/ads/googleads/v12/common/value.proto index 724a47259..42533a774 100644 --- a/google/ads/googleads/v9/common/value.proto +++ b/google/ads/googleads/v12/common/value.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.common; +package google.ads.googleads.v12.common; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common"; option java_multiple_files = true; option java_outer_classname = "ValueProto"; -option java_package = "com.google.ads.googleads.v9.common"; +option java_package = "com.google.ads.googleads.v12.common"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Common"; +option ruby_package = "Google::Ads::GoogleAds::V12::Common"; // Proto file describing value types. diff --git a/google/ads/googleads/v9/enums/BUILD.bazel b/google/ads/googleads/v12/enums/BUILD.bazel similarity index 100% rename from google/ads/googleads/v9/enums/BUILD.bazel rename to google/ads/googleads/v12/enums/BUILD.bazel diff --git a/google/ads/googleads/v9/enums/access_invitation_status.proto b/google/ads/googleads/v12/enums/access_invitation_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/access_invitation_status.proto rename to google/ads/googleads/v12/enums/access_invitation_status.proto index 802f147b6..fd0e97606 100644 --- a/google/ads/googleads/v9/enums/access_invitation_status.proto +++ b/google/ads/googleads/v12/enums/access_invitation_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccessInvitationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing AccessInvitationStatus enum. diff --git a/google/ads/googleads/v9/enums/access_reason.proto b/google/ads/googleads/v12/enums/access_reason.proto similarity index 78% rename from google/ads/googleads/v9/enums/access_reason.proto rename to google/ads/googleads/v12/enums/access_reason.proto index 68c59f970..e16e75ed5 100644 --- a/google/ads/googleads/v9/enums/access_reason.proto +++ b/google/ads/googleads/v12/enums/access_reason.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccessReasonProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Indicates the way the resource such as user list is related to a user. message AccessReasonEnum { diff --git a/google/ads/googleads/v9/enums/access_role.proto b/google/ads/googleads/v12/enums/access_role.proto similarity index 79% rename from google/ads/googleads/v9/enums/access_role.proto rename to google/ads/googleads/v12/enums/access_role.proto index ca9f1198e..264051725 100644 --- a/google/ads/googleads/v9/enums/access_role.proto +++ b/google/ads/googleads/v12/enums/access_role.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccessRoleProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing possible access role for user. message AccessRoleEnum { diff --git a/google/ads/googleads/v9/enums/account_budget_proposal_status.proto b/google/ads/googleads/v12/enums/account_budget_proposal_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/account_budget_proposal_status.proto rename to google/ads/googleads/v12/enums/account_budget_proposal_status.proto index b54a6fd3a..b3dcef09a 100644 --- a/google/ads/googleads/v9/enums/account_budget_proposal_status.proto +++ b/google/ads/googleads/v12/enums/account_budget_proposal_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProposalStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing AccountBudgetProposal statuses. @@ -54,7 +52,7 @@ 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/google/ads/googleads/v9/enums/account_budget_proposal_type.proto b/google/ads/googleads/v12/enums/account_budget_proposal_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/account_budget_proposal_type.proto rename to google/ads/googleads/v12/enums/account_budget_proposal_type.proto index c3c06e045..7a77b2269 100644 --- a/google/ads/googleads/v9/enums/account_budget_proposal_type.proto +++ b/google/ads/googleads/v12/enums/account_budget_proposal_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProposalTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing AccountBudgetProposal types. diff --git a/google/ads/googleads/v9/enums/account_budget_status.proto b/google/ads/googleads/v12/enums/account_budget_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/account_budget_status.proto rename to google/ads/googleads/v12/enums/account_budget_status.proto index 949d9ce54..e8b0875d8 100644 --- a/google/ads/googleads/v9/enums/account_budget_status.proto +++ b/google/ads/googleads/v12/enums/account_budget_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing AccountBudget statuses. diff --git a/google/ads/googleads/v9/enums/account_link_status.proto b/google/ads/googleads/v12/enums/account_link_status.proto similarity index 82% rename from google/ads/googleads/v9/enums/account_link_status.proto rename to google/ads/googleads/v12/enums/account_link_status.proto index 4a99583fe..c81e1f5e2 100644 --- a/google/ads/googleads/v9/enums/account_link_status.proto +++ b/google/ads/googleads/v12/enums/account_link_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AccountLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing possible statuses of an account link. message AccountLinkStatusEnum { diff --git a/google/ads/googleads/v9/enums/ad_customizer_placeholder_field.proto b/google/ads/googleads/v12/enums/ad_customizer_placeholder_field.proto similarity index 79% rename from google/ads/googleads/v9/enums/ad_customizer_placeholder_field.proto rename to google/ads/googleads/v12/enums/ad_customizer_placeholder_field.proto index 1aa0154ac..ee6f0417b 100644 --- a/google/ads/googleads/v9/enums/ad_customizer_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/ad_customizer_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdCustomizerPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Ad Customizer placeholder fields. diff --git a/google/ads/googleads/v9/enums/ad_destination_type.proto b/google/ads/googleads/v12/enums/ad_destination_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/ad_destination_type.proto rename to google/ads/googleads/v12/enums/ad_destination_type.proto index e1e454901..47f5de4a3 100644 --- a/google/ads/googleads/v9/enums/ad_destination_type.proto +++ b/google/ads/googleads/v12/enums/ad_destination_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdDestinationTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad destination types. diff --git a/google/ads/googleads/v9/enums/ad_group_ad_rotation_mode.proto b/google/ads/googleads/v12/enums/ad_group_ad_rotation_mode.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_group_ad_rotation_mode.proto rename to google/ads/googleads/v12/enums/ad_group_ad_rotation_mode.proto index f7c997681..4a54755eb 100644 --- a/google/ads/googleads/v9/enums/ad_group_ad_rotation_mode.proto +++ b/google/ads/googleads/v12/enums/ad_group_ad_rotation_mode.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdRotationModeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad group ad rotation mode. diff --git a/google/ads/googleads/v9/enums/ad_group_ad_status.proto b/google/ads/googleads/v12/enums/ad_group_ad_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_group_ad_status.proto rename to google/ads/googleads/v12/enums/ad_group_ad_status.proto index ad90af3a0..c882676af 100644 --- a/google/ads/googleads/v9/enums/ad_group_ad_status.proto +++ b/google/ads/googleads/v12/enums/ad_group_ad_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad group status. diff --git a/google/ads/googleads/v9/enums/ad_group_criterion_approval_status.proto b/google/ads/googleads/v12/enums/ad_group_criterion_approval_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_group_criterion_approval_status.proto rename to google/ads/googleads/v12/enums/ad_group_criterion_approval_status.proto index a6d68b642..d1272d4ee 100644 --- a/google/ads/googleads/v9/enums/ad_group_criterion_approval_status.proto +++ b/google/ads/googleads/v12/enums/ad_group_criterion_approval_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionApprovalStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing approval status for the criterion. diff --git a/google/ads/googleads/v9/enums/ad_group_criterion_status.proto b/google/ads/googleads/v12/enums/ad_group_criterion_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_group_criterion_status.proto rename to google/ads/googleads/v12/enums/ad_group_criterion_status.proto index 61a753151..4b1d0500a 100644 --- a/google/ads/googleads/v9/enums/ad_group_criterion_status.proto +++ b/google/ads/googleads/v12/enums/ad_group_criterion_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing AdGroupCriterion statuses. diff --git a/google/ads/googleads/v9/enums/ad_group_status.proto b/google/ads/googleads/v12/enums/ad_group_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/ad_group_status.proto rename to google/ads/googleads/v12/enums/ad_group_status.proto index a5a15bd53..f8ae521c2 100644 --- a/google/ads/googleads/v9/enums/ad_group_status.proto +++ b/google/ads/googleads/v12/enums/ad_group_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad group status. diff --git a/google/ads/googleads/v9/enums/ad_group_type.proto b/google/ads/googleads/v12/enums/ad_group_type.proto similarity index 87% rename from google/ads/googleads/v9/enums/ad_group_type.proto rename to google/ads/googleads/v12/enums/ad_group_type.proto index 18d80cc3c..2d8c9c69e 100644 --- a/google/ads/googleads/v9/enums/ad_group_type.proto +++ b/google/ads/googleads/v12/enums/ad_group_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdGroupTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad group types. diff --git a/google/ads/googleads/v9/enums/ad_network_type.proto b/google/ads/googleads/v12/enums/ad_network_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_network_type.proto rename to google/ads/googleads/v12/enums/ad_network_type.proto index 803115c76..65a9eacd8 100644 --- a/google/ads/googleads/v9/enums/ad_network_type.proto +++ b/google/ads/googleads/v12/enums/ad_network_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdNetworkTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad network types. diff --git a/google/ads/googleads/v9/enums/ad_serving_optimization_status.proto b/google/ads/googleads/v12/enums/ad_serving_optimization_status.proto similarity index 82% rename from google/ads/googleads/v9/enums/ad_serving_optimization_status.proto rename to google/ads/googleads/v12/enums/ad_serving_optimization_status.proto index 76307f12c..976e86df7 100644 --- a/google/ads/googleads/v9/enums/ad_serving_optimization_status.proto +++ b/google/ads/googleads/v12/enums/ad_serving_optimization_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdServingOptimizationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad serving statuses. diff --git a/google/ads/googleads/v9/enums/ad_strength.proto b/google/ads/googleads/v12/enums/ad_strength.proto similarity index 78% rename from google/ads/googleads/v9/enums/ad_strength.proto rename to google/ads/googleads/v12/enums/ad_strength.proto index 1bb2aaa82..846957e47 100644 --- a/google/ads/googleads/v9/enums/ad_strength.proto +++ b/google/ads/googleads/v12/enums/ad_strength.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdStrengthProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing ad strengths. diff --git a/google/ads/googleads/v9/enums/ad_type.proto b/google/ads/googleads/v12/enums/ad_type.proto similarity index 84% rename from google/ads/googleads/v9/enums/ad_type.proto rename to google/ads/googleads/v12/enums/ad_type.proto index 940604baa..b11c5b8d8 100644 --- a/google/ads/googleads/v9/enums/ad_type.proto +++ b/google/ads/googleads/v12/enums/ad_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the ad type. @@ -62,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; @@ -108,9 +103,6 @@ message AdTypeEnum { // Video outstream ad. VIDEO_OUTSTREAM_AD = 27; - // Video TrueView in-display ad. - VIDEO_TRUEVIEW_DISCOVERY_AD = 28; - // Video TrueView in-stream ad. VIDEO_TRUEVIEW_IN_STREAM_AD = 29; @@ -125,6 +117,15 @@ message AdTypeEnum { // Universal app pre-registration ad. APP_PRE_REGISTRATION_AD = 33; + + // In-feed video ad. + IN_FEED_VIDEO_AD = 34; + + // Discovery multi asset ad. + DISCOVERY_MULTI_ASSET_AD = 35; + + // Discovery carousel ad. + DISCOVERY_CAROUSEL_AD = 36; } diff --git a/google/ads/googleads/v9/enums/advertising_channel_sub_type.proto b/google/ads/googleads/v12/enums/advertising_channel_sub_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/advertising_channel_sub_type.proto rename to google/ads/googleads/v12/enums/advertising_channel_sub_type.proto index a18c75c09..5cf4c3093 100644 --- a/google/ads/googleads/v9/enums/advertising_channel_sub_type.proto +++ b/google/ads/googleads/v12/enums/advertising_channel_sub_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdvertisingChannelSubTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing advertising channel subtypes. @@ -57,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. @@ -69,13 +68,13 @@ 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; // App Campaign for engagement, focused on driving re-engagement with the - // app across several of Google’s top properties including Search, YouTube, + // app across several of Google's top properties including Search, YouTube, // and the Google Display Network. APP_CAMPAIGN_FOR_ENGAGEMENT = 13; diff --git a/google/ads/googleads/v9/enums/advertising_channel_type.proto b/google/ads/googleads/v12/enums/advertising_channel_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/advertising_channel_type.proto rename to google/ads/googleads/v12/enums/advertising_channel_type.proto index dee11f139..5cc0c90d3 100644 --- a/google/ads/googleads/v9/enums/advertising_channel_type.proto +++ b/google/ads/googleads/v12/enums/advertising_channel_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AdvertisingChannelTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing advertising channel types @@ -67,6 +65,12 @@ message AdvertisingChannelTypeEnum { // Performance Max campaigns. PERFORMANCE_MAX = 10; + + // Local services campaigns. + LOCAL_SERVICES = 11; + + // Discovery campaigns. + DISCOVERY = 12; } diff --git a/google/ads/googleads/v9/enums/affiliate_location_feed_relationship_type.proto b/google/ads/googleads/v12/enums/affiliate_location_feed_relationship_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/affiliate_location_feed_relationship_type.proto rename to google/ads/googleads/v12/enums/affiliate_location_feed_relationship_type.proto index 3bee231d0..1c65697fb 100644 --- a/google/ads/googleads/v9/enums/affiliate_location_feed_relationship_type.proto +++ b/google/ads/googleads/v12/enums/affiliate_location_feed_relationship_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AffiliateLocationFeedRelationshipTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing relation type for affiliate location feeds. diff --git a/google/ads/googleads/v9/enums/affiliate_location_placeholder_field.proto b/google/ads/googleads/v12/enums/affiliate_location_placeholder_field.proto similarity index 84% rename from google/ads/googleads/v9/enums/affiliate_location_placeholder_field.proto rename to google/ads/googleads/v12/enums/affiliate_location_placeholder_field.proto index 45c431ef6..9956a0354 100644 --- a/google/ads/googleads/v9/enums/affiliate_location_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/affiliate_location_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AffiliateLocationPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Affiliate Location placeholder fields. diff --git a/google/ads/googleads/v9/enums/age_range_type.proto b/google/ads/googleads/v12/enums/age_range_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/age_range_type.proto rename to google/ads/googleads/v12/enums/age_range_type.proto index 22bf34849..378c03488 100644 --- a/google/ads/googleads/v9/enums/age_range_type.proto +++ b/google/ads/googleads/v12/enums/age_range_type.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AgeRangeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/app_campaign_app_store.proto b/google/ads/googleads/v12/enums/app_campaign_app_store.proto similarity index 76% rename from google/ads/googleads/v9/enums/app_campaign_app_store.proto rename to google/ads/googleads/v12/enums/app_campaign_app_store.proto index f018f24df..742b5851c 100644 --- a/google/ads/googleads/v9/enums/app_campaign_app_store.proto +++ b/google/ads/googleads/v12/enums/app_campaign_app_store.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppCampaignAppStoreProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing App Campaign app store. diff --git a/google/ads/googleads/v9/enums/app_campaign_bidding_strategy_goal_type.proto b/google/ads/googleads/v12/enums/app_campaign_bidding_strategy_goal_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/app_campaign_bidding_strategy_goal_type.proto rename to google/ads/googleads/v12/enums/app_campaign_bidding_strategy_goal_type.proto index b39873f3c..a17935226 100644 --- a/google/ads/googleads/v9/enums/app_campaign_bidding_strategy_goal_type.proto +++ b/google/ads/googleads/v12/enums/app_campaign_bidding_strategy_goal_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppCampaignBiddingStrategyGoalTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing App Campaign bidding strategy goal types. @@ -51,12 +49,12 @@ message AppCampaignBiddingStrategyGoalTypeEnum { // Aim to maximize the long term number of selected in-app conversions from // app installs. The cpa bid is the target cost per in-app conversion. Note // that the actual cpa may seem higher than the target cpa at first, since - // the long term conversions haven’t happened yet. + // 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. diff --git a/google/ads/googleads/v9/enums/app_payment_model_type.proto b/google/ads/googleads/v12/enums/app_payment_model_type.proto similarity index 75% rename from google/ads/googleads/v9/enums/app_payment_model_type.proto rename to google/ads/googleads/v12/enums/app_payment_model_type.proto index bf67202b3..e7b0416a3 100644 --- a/google/ads/googleads/v9/enums/app_payment_model_type.proto +++ b/google/ads/googleads/v12/enums/app_payment_model_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppPaymentModelTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing criteria types. diff --git a/google/ads/googleads/v9/enums/app_placeholder_field.proto b/google/ads/googleads/v12/enums/app_placeholder_field.proto similarity index 84% rename from google/ads/googleads/v9/enums/app_placeholder_field.proto rename to google/ads/googleads/v12/enums/app_placeholder_field.proto index cb8a56600..b5be5ce59 100644 --- a/google/ads/googleads/v9/enums/app_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/app_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing App placeholder fields. diff --git a/google/ads/googleads/v9/enums/app_store.proto b/google/ads/googleads/v12/enums/app_store.proto similarity index 76% rename from google/ads/googleads/v9/enums/app_store.proto rename to google/ads/googleads/v12/enums/app_store.proto index 0cc57a067..236fb7818 100644 --- a/google/ads/googleads/v9/enums/app_store.proto +++ b/google/ads/googleads/v12/enums/app_store.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppStoreProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing app store types for an app extension. diff --git a/google/ads/googleads/v9/enums/app_url_operating_system_type.proto b/google/ads/googleads/v12/enums/app_url_operating_system_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/app_url_operating_system_type.proto rename to google/ads/googleads/v12/enums/app_url_operating_system_type.proto index ca4df8b13..326c2223a 100644 --- a/google/ads/googleads/v9/enums/app_url_operating_system_type.proto +++ b/google/ads/googleads/v12/enums/app_url_operating_system_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AppUrlOperatingSystemTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing operating system for a deeplink app URL. diff --git a/google/ads/googleads/v9/enums/asset_field_type.proto b/google/ads/googleads/v12/enums/asset_field_type.proto similarity index 88% rename from google/ads/googleads/v9/enums/asset_field_type.proto rename to google/ads/googleads/v12/enums/asset_field_type.proto index 84960311c..1da0c57ae 100644 --- a/google/ads/googleads/v9/enums/asset_field_type.proto +++ b/google/ads/googleads/v12/enums/asset_field_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetFieldTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing asset type. @@ -111,6 +109,9 @@ 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; } diff --git a/google/ads/googleads/v9/enums/asset_group_status.proto b/google/ads/googleads/v12/enums/asset_group_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/asset_group_status.proto rename to google/ads/googleads/v12/enums/asset_group_status.proto index 15113c909..c3afa01ac 100644 --- a/google/ads/googleads/v9/enums/asset_group_status.proto +++ b/google/ads/googleads/v12/enums/asset_group_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetGroupStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing asset group status. diff --git a/google/ads/googleads/v9/enums/asset_link_status.proto b/google/ads/googleads/v12/enums/asset_link_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/asset_link_status.proto rename to google/ads/googleads/v12/enums/asset_link_status.proto index de012c76f..7b8a46a04 100644 --- a/google/ads/googleads/v9/enums/asset_link_status.proto +++ b/google/ads/googleads/v12/enums/asset_link_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing status of an asset link. diff --git a/google/ads/googleads/v9/enums/asset_performance_label.proto b/google/ads/googleads/v12/enums/asset_performance_label.proto similarity index 81% rename from google/ads/googleads/v9/enums/asset_performance_label.proto rename to google/ads/googleads/v12/enums/asset_performance_label.proto index 570d1f245..d6022cb70 100644 --- a/google/ads/googleads/v9/enums/asset_performance_label.proto +++ b/google/ads/googleads/v12/enums/asset_performance_label.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetPerformanceLabelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the performance label of an asset. diff --git a/google/ads/googleads/v9/enums/asset_set_asset_status.proto b/google/ads/googleads/v12/enums/asset_set_asset_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/asset_set_asset_status.proto rename to google/ads/googleads/v12/enums/asset_set_asset_status.proto index bcb815f12..b709aa5b5 100644 --- a/google/ads/googleads/v9/enums/asset_set_asset_status.proto +++ b/google/ads/googleads/v12/enums/asset_set_asset_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetSetAssetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing asset set status. diff --git a/google/ads/googleads/v9/enums/asset_set_link_status.proto b/google/ads/googleads/v12/enums/asset_set_link_status.proto similarity index 74% rename from google/ads/googleads/v9/enums/asset_set_link_status.proto rename to google/ads/googleads/v12/enums/asset_set_link_status.proto index 9ef8c4fb1..a3c6333f2 100644 --- a/google/ads/googleads/v9/enums/asset_set_link_status.proto +++ b/google/ads/googleads/v12/enums/asset_set_link_status.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. @@ -14,25 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetSetLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/asset_set_status.proto b/google/ads/googleads/v12/enums/asset_set_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/asset_set_status.proto rename to google/ads/googleads/v12/enums/asset_set_status.proto index 6faac36be..0edd4bb36 100644 --- a/google/ads/googleads/v9/enums/asset_set_status.proto +++ b/google/ads/googleads/v12/enums/asset_set_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetSetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing asset set status. diff --git a/google/ads/googleads/v12/enums/asset_set_type.proto b/google/ads/googleads/v12/enums/asset_set_type.proto new file mode 100644 index 000000000..93f0f697c --- /dev/null +++ b/google/ads/googleads/v12/enums/asset_set_type.proto @@ -0,0 +1,86 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AssetSetTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing asset set type. + +// Container for enum describing possible types of an asset set. +message AssetSetTypeEnum { + // Possible types of an asset set. + enum AssetSetType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Page asset set. + PAGE_FEED = 2; + + // Dynamic education asset set. + DYNAMIC_EDUCATION = 3; + + // Google Merchant Center asset set. + MERCHANT_CENTER_FEED = 4; + + // Dynamic real estate asset set. + DYNAMIC_REAL_ESTATE = 5; + + // Dynamic custom asset set. + DYNAMIC_CUSTOM = 6; + + // Dynamic hotels and rentals asset set. + DYNAMIC_HOTELS_AND_RENTALS = 7; + + // Dynamic flights asset set. + DYNAMIC_FLIGHTS = 8; + + // Dynamic travel asset set. + DYNAMIC_TRAVEL = 9; + + // Dynamic local asset set. + DYNAMIC_LOCAL = 10; + + // 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; + } + + +} diff --git a/google/ads/googleads/v9/enums/asset_set_type.proto b/google/ads/googleads/v12/enums/asset_source.proto similarity index 51% rename from google/ads/googleads/v9/enums/asset_set_type.proto rename to google/ads/googleads/v12/enums/asset_source.proto index b208ae2cc..4706dbb65 100644 --- a/google/ads/googleads/v9/enums/asset_set_type.proto +++ b/google/ads/googleads/v12/enums/asset_source.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. @@ -14,39 +14,35 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; -option java_outer_classname = "AssetSetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_outer_classname = "AssetSourceProto"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; -// Proto file describing asset set type. +// Proto file describing asset source. -// Container for enum describing possible types of an asset set. -message AssetSetTypeEnum { - // Possible types of an asset set. - enum AssetSetType { +// 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; - // Page feed. - PAGE_FEED = 2; - - // Dynamic education feed. - DYNAMIC_EDUCATION = 3; + // The asset or asset link is provided by advertiser. + ADVERTISER = 2; - // Google Merchant Center asset set. - MERCHANT_CENTER_FEED = 4; + // The asset or asset link is generated by Google. + AUTOMATICALLY_CREATED = 3; } diff --git a/google/ads/googleads/v9/enums/asset_type.proto b/google/ads/googleads/v12/enums/asset_type.proto similarity index 68% rename from google/ads/googleads/v9/enums/asset_type.proto rename to google/ads/googleads/v12/enums/asset_type.proto index 2966e4158..5d684ae2b 100644 --- a/google/ads/googleads/v9/enums/asset_type.proto +++ b/google/ads/googleads/v12/enums/asset_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AssetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing asset type. @@ -89,6 +87,33 @@ message AssetTypeEnum { // Call to action asset. CALL_TO_ACTION = 18; + + // Dynamic real estate asset. + DYNAMIC_REAL_ESTATE = 19; + + // Dynamic custom asset. + DYNAMIC_CUSTOM = 20; + + // Dynamic hotels and rentals asset. + DYNAMIC_HOTELS_AND_RENTALS = 21; + + // Dynamic flights asset. + DYNAMIC_FLIGHTS = 22; + + // Discovery Carousel Card asset. + DISCOVERY_CAROUSEL_CARD = 23; + + // Dynamic travel asset. + DYNAMIC_TRAVEL = 24; + + // Dynamic local asset. + DYNAMIC_LOCAL = 25; + + // Dynamic jobs asset. + DYNAMIC_JOBS = 26; + + // Location asset. + LOCATION = 27; } diff --git a/google/ads/googleads/v12/enums/async_action_status.proto b/google/ads/googleads/v12/enums/async_action_status.proto new file mode 100644 index 000000000..761270913 --- /dev/null +++ b/google/ads/googleads/v12/enums/async_action_status.proto @@ -0,0 +1,57 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AsyncActionStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing experiment async action status. + +// Container for enum describing the experiment async action status. +message AsyncActionStatusEnum { + // The async action status of the experiment. + enum AsyncActionStatus { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // Action has not started. + NOT_STARTED = 2; + + // Action is in progress. + IN_PROGRESS = 3; + + // Action has completed successfully. + COMPLETED = 4; + + // Action has failed. + FAILED = 5; + + // Action has completed successfully with warnings. + COMPLETED_WITH_WARNING = 6; + } + + +} diff --git a/google/ads/googleads/v9/enums/attribution_model.proto b/google/ads/googleads/v12/enums/attribution_model.proto similarity index 86% rename from google/ads/googleads/v9/enums/attribution_model.proto rename to google/ads/googleads/v12/enums/attribution_model.proto index c5c03b9e5..c07e3e198 100644 --- a/google/ads/googleads/v9/enums/attribution_model.proto +++ b/google/ads/googleads/v12/enums/attribution_model.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "AttributionModelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum representing the attribution model that describes how to // distribute credit for a particular conversion across potentially many prior diff --git a/google/ads/googleads/v12/enums/audience_insights_dimension.proto b/google/ads/googleads/v12/enums/audience_insights_dimension.proto new file mode 100644 index 000000000..1d5762609 --- /dev/null +++ b/google/ads/googleads/v12/enums/audience_insights_dimension.proto @@ -0,0 +1,78 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AudienceInsightsDimensionProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v12/enums/audience_status.proto b/google/ads/googleads/v12/enums/audience_status.proto new file mode 100644 index 000000000..47b480869 --- /dev/null +++ b/google/ads/googleads/v12/enums/audience_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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AudienceStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing audience status. + +// The status of audience. +message AudienceStatusEnum { + // Enum containing possible audience status types. + enum AudienceStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Enabled status - audience is enabled and can be targeted. + ENABLED = 2; + + // Removed status - audience is removed and cannot be used for + // targeting. + REMOVED = 3; + } + + +} diff --git a/google/ads/googleads/v9/enums/batch_job_status.proto b/google/ads/googleads/v12/enums/batch_job_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/batch_job_status.proto rename to google/ads/googleads/v12/enums/batch_job_status.proto index a3747c2e3..bf748e9ce 100644 --- a/google/ads/googleads/v9/enums/batch_job_status.proto +++ b/google/ads/googleads/v12/enums/batch_job_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BatchJobStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing batch job statuses. diff --git a/google/ads/googleads/v9/enums/bid_modifier_source.proto b/google/ads/googleads/v12/enums/bid_modifier_source.proto similarity index 78% rename from google/ads/googleads/v9/enums/bid_modifier_source.proto rename to google/ads/googleads/v12/enums/bid_modifier_source.proto index e30e7c6a0..1b66d2b96 100644 --- a/google/ads/googleads/v9/enums/bid_modifier_source.proto +++ b/google/ads/googleads/v12/enums/bid_modifier_source.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BidModifierSourceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bid modifier source. diff --git a/google/ads/googleads/v9/enums/bidding_source.proto b/google/ads/googleads/v12/enums/bidding_source.proto similarity index 80% rename from google/ads/googleads/v9/enums/bidding_source.proto rename to google/ads/googleads/v12/enums/bidding_source.proto index 0d5b32be4..eeddf1172 100644 --- a/google/ads/googleads/v9/enums/bidding_source.proto +++ b/google/ads/googleads/v12/enums/bidding_source.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BiddingSourceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding sources. diff --git a/google/ads/googleads/v9/enums/bidding_strategy_status.proto b/google/ads/googleads/v12/enums/bidding_strategy_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/bidding_strategy_status.proto rename to google/ads/googleads/v12/enums/bidding_strategy_status.proto index 00e448b62..ec57b7667 100644 --- a/google/ads/googleads/v9/enums/bidding_strategy_status.proto +++ b/google/ads/googleads/v12/enums/bidding_strategy_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategyStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing BiddingStrategy statuses. diff --git a/google/ads/googleads/v12/enums/bidding_strategy_system_status.proto b/google/ads/googleads/v12/enums/bidding_strategy_system_status.proto new file mode 100644 index 000000000..da457e6fe --- /dev/null +++ b/google/ads/googleads/v12/enums/bidding_strategy_system_status.proto @@ -0,0 +1,139 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BiddingStrategySystemStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/enums/bidding_strategy_type.proto b/google/ads/googleads/v12/enums/bidding_strategy_type.proto similarity index 89% rename from google/ads/googleads/v9/enums/bidding_strategy_type.proto rename to google/ads/googleads/v12/enums/bidding_strategy_type.proto index 47bd8d5cd..955cd3727 100644 --- a/google/ads/googleads/v9/enums/bidding_strategy_type.proto +++ b/google/ads/googleads/v12/enums/bidding_strategy_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategyTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. @@ -57,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; diff --git a/google/ads/googleads/v9/enums/billing_setup_status.proto b/google/ads/googleads/v12/enums/billing_setup_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/billing_setup_status.proto rename to google/ads/googleads/v12/enums/billing_setup_status.proto index 8f7a3bf8a..1cfb22b73 100644 --- a/google/ads/googleads/v9/enums/billing_setup_status.proto +++ b/google/ads/googleads/v12/enums/billing_setup_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BillingSetupStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing BillingSetup statuses. diff --git a/google/ads/googleads/v9/enums/brand_safety_suitability.proto b/google/ads/googleads/v12/enums/brand_safety_suitability.proto similarity index 88% rename from google/ads/googleads/v9/enums/brand_safety_suitability.proto rename to google/ads/googleads/v12/enums/brand_safety_suitability.proto index ebfbb7c8f..d33f89a14 100644 --- a/google/ads/googleads/v9/enums/brand_safety_suitability.proto +++ b/google/ads/googleads/v12/enums/brand_safety_suitability.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BrandSafetySuitabilityProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing brand safety suitability settings. diff --git a/google/ads/googleads/v9/enums/budget_campaign_association_status.proto b/google/ads/googleads/v12/enums/budget_campaign_association_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/budget_campaign_association_status.proto rename to google/ads/googleads/v12/enums/budget_campaign_association_status.proto index 6b53fab6d..1fa4a9537 100644 --- a/google/ads/googleads/v9/enums/budget_campaign_association_status.proto +++ b/google/ads/googleads/v12/enums/budget_campaign_association_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BudgetCampaignAssociationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Budget and Campaign association status. diff --git a/google/ads/googleads/v9/enums/budget_delivery_method.proto b/google/ads/googleads/v12/enums/budget_delivery_method.proto similarity index 79% rename from google/ads/googleads/v9/enums/budget_delivery_method.proto rename to google/ads/googleads/v12/enums/budget_delivery_method.proto index bfc7aff41..0bd719d9b 100644 --- a/google/ads/googleads/v9/enums/budget_delivery_method.proto +++ b/google/ads/googleads/v12/enums/budget_delivery_method.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BudgetDeliveryMethodProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Budget delivery methods. diff --git a/google/ads/googleads/v9/enums/budget_period.proto b/google/ads/googleads/v12/enums/budget_period.proto similarity index 78% rename from google/ads/googleads/v9/enums/budget_period.proto rename to google/ads/googleads/v12/enums/budget_period.proto index 924fd95b6..039229777 100644 --- a/google/ads/googleads/v9/enums/budget_period.proto +++ b/google/ads/googleads/v12/enums/budget_period.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BudgetPeriodProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Budget delivery methods. diff --git a/google/ads/googleads/v9/enums/budget_status.proto b/google/ads/googleads/v12/enums/budget_status.proto similarity index 75% rename from google/ads/googleads/v9/enums/budget_status.proto rename to google/ads/googleads/v12/enums/budget_status.proto index 49ae3eac8..f127dbf19 100644 --- a/google/ads/googleads/v9/enums/budget_status.proto +++ b/google/ads/googleads/v12/enums/budget_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BudgetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Budget statuses diff --git a/google/ads/googleads/v9/enums/budget_type.proto b/google/ads/googleads/v12/enums/budget_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/budget_type.proto rename to google/ads/googleads/v12/enums/budget_type.proto index 7c6a70b5a..2df4518f7 100644 --- a/google/ads/googleads/v9/enums/budget_type.proto +++ b/google/ads/googleads/v12/enums/budget_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "BudgetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Budget types. @@ -60,6 +58,13 @@ message BudgetTypeEnum { // AdvertisingChannelType.SMART and // AdvertisingChannelSubType.SMART_CAMPAIGN. SMART_CAMPAIGN = 5; + + // Budget type for Local Services Campaign. + // Full details: https://support.google.com/localservices/answer/7434558 + // + // This type is only supported by campaigns with + // AdvertisingChannelType.LOCAL_SERVICES. + LOCAL_SERVICES = 6; } diff --git a/google/ads/googleads/v9/enums/call_conversion_reporting_state.proto b/google/ads/googleads/v12/enums/call_conversion_reporting_state.proto similarity index 81% rename from google/ads/googleads/v9/enums/call_conversion_reporting_state.proto rename to google/ads/googleads/v12/enums/call_conversion_reporting_state.proto index ff4629b8e..cad7e5bf0 100644 --- a/google/ads/googleads/v9/enums/call_conversion_reporting_state.proto +++ b/google/ads/googleads/v12/enums/call_conversion_reporting_state.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CallConversionReportingStateProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing call conversion reporting state. diff --git a/google/ads/googleads/v9/enums/call_placeholder_field.proto b/google/ads/googleads/v12/enums/call_placeholder_field.proto similarity index 84% rename from google/ads/googleads/v9/enums/call_placeholder_field.proto rename to google/ads/googleads/v12/enums/call_placeholder_field.proto index f06246090..094b0e5a9 100644 --- a/google/ads/googleads/v9/enums/call_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/call_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CallPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Call placeholder fields. diff --git a/google/ads/googleads/v9/enums/call_to_action_type.proto b/google/ads/googleads/v12/enums/call_to_action_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/call_to_action_type.proto rename to google/ads/googleads/v12/enums/call_to_action_type.proto index e8636caad..85310a3ef 100644 --- a/google/ads/googleads/v9/enums/call_to_action_type.proto +++ b/google/ads/googleads/v12/enums/call_to_action_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CallToActionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing call to action type. diff --git a/google/ads/googleads/v9/enums/call_tracking_display_location.proto b/google/ads/googleads/v12/enums/call_tracking_display_location.proto similarity index 78% rename from google/ads/googleads/v9/enums/call_tracking_display_location.proto rename to google/ads/googleads/v12/enums/call_tracking_display_location.proto index 958e67bcb..003ae8730 100644 --- a/google/ads/googleads/v9/enums/call_tracking_display_location.proto +++ b/google/ads/googleads/v12/enums/call_tracking_display_location.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CallTrackingDisplayLocationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing call tracking display location. diff --git a/google/ads/googleads/v9/enums/call_type.proto b/google/ads/googleads/v12/enums/call_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/call_type.proto rename to google/ads/googleads/v12/enums/call_type.proto index 84aa8deba..3116dbe7b 100644 --- a/google/ads/googleads/v9/enums/call_type.proto +++ b/google/ads/googleads/v12/enums/call_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CallTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing call types. diff --git a/google/ads/googleads/v9/enums/callout_placeholder_field.proto b/google/ads/googleads/v12/enums/callout_placeholder_field.proto similarity index 76% rename from google/ads/googleads/v9/enums/callout_placeholder_field.proto rename to google/ads/googleads/v12/enums/callout_placeholder_field.proto index 461872447..2e6a86a01 100644 --- a/google/ads/googleads/v9/enums/callout_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/callout_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CalloutPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Callout placeholder fields. diff --git a/google/ads/googleads/v9/enums/campaign_criterion_status.proto b/google/ads/googleads/v12/enums/campaign_criterion_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/campaign_criterion_status.proto rename to google/ads/googleads/v12/enums/campaign_criterion_status.proto index a18fd14b0..492f8306c 100644 --- a/google/ads/googleads/v9/enums/campaign_criterion_status.proto +++ b/google/ads/googleads/v12/enums/campaign_criterion_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignCriterionStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing CampaignCriterion statuses. diff --git a/google/ads/googleads/v9/enums/campaign_draft_status.proto b/google/ads/googleads/v12/enums/campaign_draft_status.proto similarity index 83% rename from google/ads/googleads/v9/enums/campaign_draft_status.proto rename to google/ads/googleads/v12/enums/campaign_draft_status.proto index 1bc2f8093..dc84a455c 100644 --- a/google/ads/googleads/v9/enums/campaign_draft_status.proto +++ b/google/ads/googleads/v12/enums/campaign_draft_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignDraftStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing campaign draft status. diff --git a/google/ads/googleads/v9/enums/campaign_experiment_type.proto b/google/ads/googleads/v12/enums/campaign_experiment_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/campaign_experiment_type.proto rename to google/ads/googleads/v12/enums/campaign_experiment_type.proto index aa517f87b..f8753e027 100644 --- a/google/ads/googleads/v9/enums/campaign_experiment_type.proto +++ b/google/ads/googleads/v12/enums/campaign_experiment_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignExperimentTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing campaign experiment type. diff --git a/google/ads/googleads/v12/enums/campaign_group_status.proto b/google/ads/googleads/v12/enums/campaign_group_status.proto new file mode 100644 index 000000000..629ef45b4 --- /dev/null +++ b/google/ads/googleads/v12/enums/campaign_group_status.proto @@ -0,0 +1,48 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CampaignGroupStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing CampaignGroup statuses. + +// Message describing CampaignGroup statuses. +message CampaignGroupStatusEnum { + // Possible statuses of a CampaignGroup. + enum CampaignGroupStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The campaign group is active. + ENABLED = 2; + + // The campaign group has been removed. + REMOVED = 3; + } + + +} diff --git a/google/ads/googleads/v12/enums/campaign_primary_status.proto b/google/ads/googleads/v12/enums/campaign_primary_status.proto new file mode 100644 index 000000000..170101696 --- /dev/null +++ b/google/ads/googleads/v12/enums/campaign_primary_status.proto @@ -0,0 +1,75 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CampaignPrimaryStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v12/enums/campaign_primary_status_reason.proto b/google/ads/googleads/v12/enums/campaign_primary_status_reason.proto new file mode 100644 index 000000000..40de43b31 --- /dev/null +++ b/google/ads/googleads/v12/enums/campaign_primary_status_reason.proto @@ -0,0 +1,147 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CampaignPrimaryStatusReasonProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/enums/campaign_serving_status.proto b/google/ads/googleads/v12/enums/campaign_serving_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/campaign_serving_status.proto rename to google/ads/googleads/v12/enums/campaign_serving_status.proto index 6209eb0ed..dcf788442 100644 --- a/google/ads/googleads/v9/enums/campaign_serving_status.proto +++ b/google/ads/googleads/v12/enums/campaign_serving_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignServingStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Campaign serving statuses. diff --git a/google/ads/googleads/v9/enums/campaign_shared_set_status.proto b/google/ads/googleads/v12/enums/campaign_shared_set_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/campaign_shared_set_status.proto rename to google/ads/googleads/v12/enums/campaign_shared_set_status.proto index 6aa44d8cd..b4facb351 100644 --- a/google/ads/googleads/v9/enums/campaign_shared_set_status.proto +++ b/google/ads/googleads/v12/enums/campaign_shared_set_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignSharedSetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing campaign shared set statuses. diff --git a/google/ads/googleads/v9/enums/campaign_status.proto b/google/ads/googleads/v12/enums/campaign_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/campaign_status.proto rename to google/ads/googleads/v12/enums/campaign_status.proto index 4d9ad040c..939d45039 100644 --- a/google/ads/googleads/v9/enums/campaign_status.proto +++ b/google/ads/googleads/v12/enums/campaign_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CampaignStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing campaign status. diff --git a/google/ads/googleads/v12/enums/chain_relationship_type.proto b/google/ads/googleads/v12/enums/chain_relationship_type.proto new file mode 100644 index 000000000..9a27dc86a --- /dev/null +++ b/google/ads/googleads/v12/enums/chain_relationship_type.proto @@ -0,0 +1,48 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ChainRelationshipTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/enums/change_client_type.proto b/google/ads/googleads/v12/enums/change_client_type.proto similarity index 87% rename from google/ads/googleads/v9/enums/change_client_type.proto rename to google/ads/googleads/v12/enums/change_client_type.proto index 2fb7f3897..4c7b7a1b1 100644 --- a/google/ads/googleads/v9/enums/change_client_type.proto +++ b/google/ads/googleads/v12/enums/change_client_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ChangeClientTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the sources that the change event resource was // made through. diff --git a/google/ads/googleads/v9/enums/change_event_resource_type.proto b/google/ads/googleads/v12/enums/change_event_resource_type.proto similarity index 80% rename from google/ads/googleads/v9/enums/change_event_resource_type.proto rename to google/ads/googleads/v12/enums/change_event_resource_type.proto index eac06181c..8b760b429 100644 --- a/google/ads/googleads/v9/enums/change_event_resource_type.proto +++ b/google/ads/googleads/v12/enums/change_event_resource_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ChangeEventResourceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the resource types the ChangeEvent resource supports. @@ -88,6 +86,15 @@ message ChangeEventResourceTypeEnum { // An AdGroupAsset resource change. AD_GROUP_ASSET = 17; + + // An AssetSet resource change. + ASSET_SET = 18; + + // An AssetSetAsset resource change. + ASSET_SET_ASSET = 19; + + // A CampaignAssetSet resource change. + CAMPAIGN_ASSET_SET = 20; } diff --git a/google/ads/googleads/v9/enums/change_status_operation.proto b/google/ads/googleads/v12/enums/change_status_operation.proto similarity index 78% rename from google/ads/googleads/v9/enums/change_status_operation.proto rename to google/ads/googleads/v12/enums/change_status_operation.proto index c1b95cdb1..ce9c7aca8 100644 --- a/google/ads/googleads/v9/enums/change_status_operation.proto +++ b/google/ads/googleads/v12/enums/change_status_operation.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ChangeStatusOperationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the change status operations. diff --git a/google/ads/googleads/v9/enums/change_status_resource_type.proto b/google/ads/googleads/v12/enums/change_status_resource_type.proto similarity index 86% rename from google/ads/googleads/v9/enums/change_status_resource_type.proto rename to google/ads/googleads/v12/enums/change_status_resource_type.proto index 51d8472b8..d6e5e6835 100644 --- a/google/ads/googleads/v9/enums/change_status_resource_type.proto +++ b/google/ads/googleads/v12/enums/change_status_resource_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ChangeStatusResourceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the resource types the ChangeStatus resource supports. diff --git a/google/ads/googleads/v9/enums/click_type.proto b/google/ads/googleads/v12/enums/click_type.proto similarity index 90% rename from google/ads/googleads/v9/enums/click_type.proto rename to google/ads/googleads/v12/enums/click_type.proto index 088fd7b18..f5c1a689f 100644 --- a/google/ads/googleads/v9/enums/click_type.proto +++ b/google/ads/googleads/v12/enums/click_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ClickTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing click types. @@ -197,6 +195,9 @@ message ClickTypeEnum { // Shopping - Comparison Listing. SHOPPING_COMPARISON_LISTING = 56; + + // Cross-network. From Performance Max and Discovery Campaigns. + CROSS_NETWORK = 57; } diff --git a/google/ads/googleads/v9/enums/combined_audience_status.proto b/google/ads/googleads/v12/enums/combined_audience_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/combined_audience_status.proto rename to google/ads/googleads/v12/enums/combined_audience_status.proto index 922355b7f..e82c06fc4 100644 --- a/google/ads/googleads/v9/enums/combined_audience_status.proto +++ b/google/ads/googleads/v12/enums/combined_audience_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CombinedAudienceStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing combined audience status. diff --git a/google/ads/googleads/v9/enums/content_label_type.proto b/google/ads/googleads/v12/enums/content_label_type.proto similarity index 84% rename from google/ads/googleads/v9/enums/content_label_type.proto rename to google/ads/googleads/v12/enums/content_label_type.proto index 2b3acf689..8d87248eb 100644 --- a/google/ads/googleads/v9/enums/content_label_type.proto +++ b/google/ads/googleads/v12/enums/content_label_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ContentLabelTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing content label types. diff --git a/google/ads/googleads/v9/enums/conversion_action_category.proto b/google/ads/googleads/v12/enums/conversion_action_category.proto similarity index 74% rename from google/ads/googleads/v9/enums/conversion_action_category.proto rename to google/ads/googleads/v12/enums/conversion_action_category.proto index e94bdbd84..3f8d7153e 100644 --- a/google/ads/googleads/v9/enums/conversion_action_category.proto +++ b/google/ads/googleads/v12/enums/conversion_action_category.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionActionCategoryProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing the category of conversions that are associated // with a ConversionAction. @@ -50,9 +48,6 @@ message ConversionActionCategoryEnum { // Signup user action. SIGNUP = 5; - // Lead-generating action. - LEAD = 6; - // Software download action (as for an app). DOWNLOAD = 7; @@ -100,6 +95,19 @@ message ConversionActionCategoryEnum { // A sale occurring in a physical store. STORE_SALE = 21; + + // A lead conversion imported from an external source into Google Ads, + // that has been further qualified by the advertiser (marketing/sales team). + // In the lead-to-sale journey, advertisers get leads, then act on them + // by reaching out to the consumer. If the consumer is interested and + // may end up buying their product, the advertiser marks such leads as + // "qualified leads". + QUALIFIED_LEAD = 22; + + // A lead conversion imported from an external source into Google Ads, that + // has further completed a chosen stage as defined by the lead gen + // advertiser. + CONVERTED_LEAD = 23; } diff --git a/google/ads/googleads/v9/enums/conversion_action_counting_type.proto b/google/ads/googleads/v12/enums/conversion_action_counting_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/conversion_action_counting_type.proto rename to google/ads/googleads/v12/enums/conversion_action_counting_type.proto index 8a243ba4d..a4f967399 100644 --- a/google/ads/googleads/v9/enums/conversion_action_counting_type.proto +++ b/google/ads/googleads/v12/enums/conversion_action_counting_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionActionCountingTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion action counting type. diff --git a/google/ads/googleads/v9/enums/conversion_action_status.proto b/google/ads/googleads/v12/enums/conversion_action_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/conversion_action_status.proto rename to google/ads/googleads/v12/enums/conversion_action_status.proto index 5e3de168f..80e6e0307 100644 --- a/google/ads/googleads/v9/enums/conversion_action_status.proto +++ b/google/ads/googleads/v12/enums/conversion_action_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionActionStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion action status. diff --git a/google/ads/googleads/v9/enums/conversion_action_type.proto b/google/ads/googleads/v12/enums/conversion_action_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/conversion_action_type.proto rename to google/ads/googleads/v12/enums/conversion_action_type.proto index b2e34666d..1c30ad516 100644 --- a/google/ads/googleads/v9/enums/conversion_action_type.proto +++ b/google/ads/googleads/v12/enums/conversion_action_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionActionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion action type. @@ -80,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 diff --git a/google/ads/googleads/v9/enums/conversion_adjustment_type.proto b/google/ads/googleads/v12/enums/conversion_adjustment_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/conversion_adjustment_type.proto rename to google/ads/googleads/v12/enums/conversion_adjustment_type.proto index e5d3ba70b..03f2c9657 100644 --- a/google/ads/googleads/v9/enums/conversion_adjustment_type.proto +++ b/google/ads/googleads/v12/enums/conversion_adjustment_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionAdjustmentTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion adjustment type. diff --git a/google/ads/googleads/v9/enums/conversion_attribution_event_type.proto b/google/ads/googleads/v12/enums/conversion_attribution_event_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/conversion_attribution_event_type.proto rename to google/ads/googleads/v12/enums/conversion_attribution_event_type.proto index 42e72c4f6..fe93875e8 100644 --- a/google/ads/googleads/v9/enums/conversion_attribution_event_type.proto +++ b/google/ads/googleads/v12/enums/conversion_attribution_event_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionAttributionEventTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum indicating the event type the conversion is attributed to. message ConversionAttributionEventTypeEnum { diff --git a/google/ads/googleads/v9/enums/conversion_custom_variable_status.proto b/google/ads/googleads/v12/enums/conversion_custom_variable_status.proto similarity index 81% rename from google/ads/googleads/v9/enums/conversion_custom_variable_status.proto rename to google/ads/googleads/v12/enums/conversion_custom_variable_status.proto index 9c37cbe20..51bb59299 100644 --- a/google/ads/googleads/v9/enums/conversion_custom_variable_status.proto +++ b/google/ads/googleads/v12/enums/conversion_custom_variable_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionCustomVariableStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion custom variable status. diff --git a/google/ads/googleads/v12/enums/conversion_environment_enum.proto b/google/ads/googleads/v12/enums/conversion_environment_enum.proto new file mode 100644 index 000000000..a4e0fc4bf --- /dev/null +++ b/google/ads/googleads/v12/enums/conversion_environment_enum.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionEnvironmentEnumProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Container for enum representing the conversion environment an uploaded +// conversion was recorded on, for example, App or Web. +message ConversionEnvironmentEnum { + // Conversion environment of the uploaded conversion. + enum ConversionEnvironment { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The conversion was recorded on an app. + APP = 2; + + // The conversion was recorded on a website. + WEB = 3; + } + + +} diff --git a/google/ads/googleads/v9/enums/conversion_lag_bucket.proto b/google/ads/googleads/v12/enums/conversion_lag_bucket.proto similarity index 90% rename from google/ads/googleads/v9/enums/conversion_lag_bucket.proto rename to google/ads/googleads/v12/enums/conversion_lag_bucket.proto index 0fb3e1a3b..5b6539e2c 100644 --- a/google/ads/googleads/v9/enums/conversion_lag_bucket.proto +++ b/google/ads/googleads/v12/enums/conversion_lag_bucket.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionLagBucketProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum representing the number of days between impression and // conversion. diff --git a/google/ads/googleads/v9/enums/conversion_or_adjustment_lag_bucket.proto b/google/ads/googleads/v12/enums/conversion_or_adjustment_lag_bucket.proto similarity index 95% rename from google/ads/googleads/v9/enums/conversion_or_adjustment_lag_bucket.proto rename to google/ads/googleads/v12/enums/conversion_or_adjustment_lag_bucket.proto index 76371efe9..ba9d3cafe 100644 --- a/google/ads/googleads/v9/enums/conversion_or_adjustment_lag_bucket.proto +++ b/google/ads/googleads/v12/enums/conversion_or_adjustment_lag_bucket.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionOrAdjustmentLagBucketProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum representing the number of days between the impression and // the conversion or between the impression and adjustments to the conversion. diff --git a/google/ads/googleads/v9/enums/conversion_origin.proto b/google/ads/googleads/v12/enums/conversion_origin.proto similarity index 74% rename from google/ads/googleads/v9/enums/conversion_origin.proto rename to google/ads/googleads/v12/enums/conversion_origin.proto index 084509a6a..fa1289f23 100644 --- a/google/ads/googleads/v9/enums/conversion_origin.proto +++ b/google/ads/googleads/v12/enums/conversion_origin.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionOriginProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion origin. @@ -44,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; diff --git a/google/ads/googleads/v12/enums/conversion_tracking_status_enum.proto b/google/ads/googleads/v12/enums/conversion_tracking_status_enum.proto new file mode 100644 index 000000000..3df80bb8d --- /dev/null +++ b/google/ads/googleads/v12/enums/conversion_tracking_status_enum.proto @@ -0,0 +1,56 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionTrackingStatusEnumProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Container for enum representing the conversion tracking status of the +// customer. +message ConversionTrackingStatusEnum { + // Conversion Tracking status of the customer. + enum ConversionTrackingStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Customer does not use any conversion tracking. + NOT_CONVERSION_TRACKED = 2; + + // The conversion actions are created and managed by this customer. + CONVERSION_TRACKING_MANAGED_BY_SELF = 3; + + // The conversion actions are created and managed by the manager specified + // in the request's `login-customer-id`. + CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER = 4; + + // The conversion actions are created and managed by a manager different + // from the customer or manager specified in the request's + // `login-customer-id`. + CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER = 5; + } + + +} diff --git a/google/ads/googleads/v9/enums/conversion_value_rule_primary_dimension.proto b/google/ads/googleads/v12/enums/conversion_value_rule_primary_dimension.proto similarity index 83% rename from google/ads/googleads/v9/enums/conversion_value_rule_primary_dimension.proto rename to google/ads/googleads/v12/enums/conversion_value_rule_primary_dimension.proto index 89db3946a..629ed3691 100644 --- a/google/ads/googleads/v9/enums/conversion_value_rule_primary_dimension.proto +++ b/google/ads/googleads/v12/enums/conversion_value_rule_primary_dimension.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRulePrimaryDimensionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule primary dimension. diff --git a/google/ads/googleads/v9/enums/conversion_value_rule_set_status.proto b/google/ads/googleads/v12/enums/conversion_value_rule_set_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/conversion_value_rule_set_status.proto rename to google/ads/googleads/v12/enums/conversion_value_rule_set_status.proto index 64d582ac1..6f7928a18 100644 --- a/google/ads/googleads/v9/enums/conversion_value_rule_set_status.proto +++ b/google/ads/googleads/v12/enums/conversion_value_rule_set_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleSetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule set status. diff --git a/google/ads/googleads/v9/enums/conversion_value_rule_status.proto b/google/ads/googleads/v12/enums/conversion_value_rule_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/conversion_value_rule_status.proto rename to google/ads/googleads/v12/enums/conversion_value_rule_status.proto index d77214c96..43243ed6c 100644 --- a/google/ads/googleads/v9/enums/conversion_value_rule_status.proto +++ b/google/ads/googleads/v12/enums/conversion_value_rule_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule status. diff --git a/google/ads/googleads/v9/enums/criterion_category_channel_availability_mode.proto b/google/ads/googleads/v12/enums/criterion_category_channel_availability_mode.proto similarity index 83% rename from google/ads/googleads/v9/enums/criterion_category_channel_availability_mode.proto rename to google/ads/googleads/v12/enums/criterion_category_channel_availability_mode.proto index bf030b5c6..9f505b17b 100644 --- a/google/ads/googleads/v9/enums/criterion_category_channel_availability_mode.proto +++ b/google/ads/googleads/v12/enums/criterion_category_channel_availability_mode.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CriterionCategoryChannelAvailabilityModeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the criterion category channel availability mode. diff --git a/google/ads/googleads/v9/enums/criterion_category_locale_availability_mode.proto b/google/ads/googleads/v12/enums/criterion_category_locale_availability_mode.proto similarity index 83% rename from google/ads/googleads/v9/enums/criterion_category_locale_availability_mode.proto rename to google/ads/googleads/v12/enums/criterion_category_locale_availability_mode.proto index 899289ed5..10d131ac0 100644 --- a/google/ads/googleads/v9/enums/criterion_category_locale_availability_mode.proto +++ b/google/ads/googleads/v12/enums/criterion_category_locale_availability_mode.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CriterionCategoryLocaleAvailabilityModeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the criterion category locale availability mode. diff --git a/google/ads/googleads/v9/enums/criterion_system_serving_status.proto b/google/ads/googleads/v12/enums/criterion_system_serving_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/criterion_system_serving_status.proto rename to google/ads/googleads/v12/enums/criterion_system_serving_status.proto index 69f262ce6..3c9feb26b 100644 --- a/google/ads/googleads/v9/enums/criterion_system_serving_status.proto +++ b/google/ads/googleads/v12/enums/criterion_system_serving_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CriterionSystemServingStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing approval status for the criterion. diff --git a/google/ads/googleads/v9/enums/criterion_type.proto b/google/ads/googleads/v12/enums/criterion_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/criterion_type.proto rename to google/ads/googleads/v12/enums/criterion_type.proto index a076dd542..1fb9d48d2 100644 --- a/google/ads/googleads/v9/enums/criterion_type.proto +++ b/google/ads/googleads/v12/enums/criterion_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CriterionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing criteria types. @@ -39,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. @@ -87,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. @@ -137,6 +135,9 @@ message CriterionTypeEnum { // Smart Campaign keyword theme KEYWORD_THEME = 34; + + // Audience + AUDIENCE = 35; } diff --git a/google/ads/googleads/v9/enums/custom_audience_member_type.proto b/google/ads/googleads/v12/enums/custom_audience_member_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/custom_audience_member_type.proto rename to google/ads/googleads/v12/enums/custom_audience_member_type.proto index a45f9fd9c..e47276f8c 100644 --- a/google/ads/googleads/v9/enums/custom_audience_member_type.proto +++ b/google/ads/googleads/v12/enums/custom_audience_member_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceMemberTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom audience member type. diff --git a/google/ads/googleads/v9/enums/custom_audience_status.proto b/google/ads/googleads/v12/enums/custom_audience_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/custom_audience_status.proto rename to google/ads/googleads/v12/enums/custom_audience_status.proto index 5430f5273..9bd6752f5 100644 --- a/google/ads/googleads/v9/enums/custom_audience_status.proto +++ b/google/ads/googleads/v12/enums/custom_audience_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom audience status. diff --git a/google/ads/googleads/v9/enums/custom_audience_type.proto b/google/ads/googleads/v12/enums/custom_audience_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/custom_audience_type.proto rename to google/ads/googleads/v12/enums/custom_audience_type.proto index 0dfe387a6..1c056d5a9 100644 --- a/google/ads/googleads/v9/enums/custom_audience_type.proto +++ b/google/ads/googleads/v12/enums/custom_audience_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom audience type. diff --git a/google/ads/googleads/v9/enums/custom_conversion_goal_status.proto b/google/ads/googleads/v12/enums/custom_conversion_goal_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/custom_conversion_goal_status.proto rename to google/ads/googleads/v12/enums/custom_conversion_goal_status.proto index 4e73c3127..89c2d1c8c 100644 --- a/google/ads/googleads/v9/enums/custom_conversion_goal_status.proto +++ b/google/ads/googleads/v12/enums/custom_conversion_goal_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomConversionGoalStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom conversion goal status. diff --git a/google/ads/googleads/v9/enums/custom_interest_member_type.proto b/google/ads/googleads/v12/enums/custom_interest_member_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/custom_interest_member_type.proto rename to google/ads/googleads/v12/enums/custom_interest_member_type.proto index 14716c78f..07cec98c9 100644 --- a/google/ads/googleads/v9/enums/custom_interest_member_type.proto +++ b/google/ads/googleads/v12/enums/custom_interest_member_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomInterestMemberTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom interest member type. diff --git a/google/ads/googleads/v9/enums/custom_interest_status.proto b/google/ads/googleads/v12/enums/custom_interest_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/custom_interest_status.proto rename to google/ads/googleads/v12/enums/custom_interest_status.proto index e759a5dde..5df6a5646 100644 --- a/google/ads/googleads/v9/enums/custom_interest_status.proto +++ b/google/ads/googleads/v12/enums/custom_interest_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomInterestStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom interest status. diff --git a/google/ads/googleads/v9/enums/custom_interest_type.proto b/google/ads/googleads/v12/enums/custom_interest_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/custom_interest_type.proto rename to google/ads/googleads/v12/enums/custom_interest_type.proto index b9d8213f7..4257b3ad5 100644 --- a/google/ads/googleads/v9/enums/custom_interest_type.proto +++ b/google/ads/googleads/v12/enums/custom_interest_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomInterestTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing custom interest type. diff --git a/google/ads/googleads/v9/enums/custom_placeholder_field.proto b/google/ads/googleads/v12/enums/custom_placeholder_field.proto similarity index 91% rename from google/ads/googleads/v9/enums/custom_placeholder_field.proto rename to google/ads/googleads/v12/enums/custom_placeholder_field.proto index 781e3742b..a6a748eb4 100644 --- a/google/ads/googleads/v9/enums/custom_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/custom_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Custom placeholder fields. diff --git a/google/ads/googleads/v9/enums/customer_match_upload_key_type.proto b/google/ads/googleads/v12/enums/customer_match_upload_key_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/customer_match_upload_key_type.proto rename to google/ads/googleads/v12/enums/customer_match_upload_key_type.proto index 3c4c64d99..42454b1b3 100644 --- a/google/ads/googleads/v9/enums/customer_match_upload_key_type.proto +++ b/google/ads/googleads/v12/enums/customer_match_upload_key_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomerMatchUploadKeyTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Indicates what type of data are the user list's members matched from. message CustomerMatchUploadKeyTypeEnum { diff --git a/google/ads/googleads/v9/enums/customer_pay_per_conversion_eligibility_failure_reason.proto b/google/ads/googleads/v12/enums/customer_pay_per_conversion_eligibility_failure_reason.proto similarity index 84% rename from google/ads/googleads/v9/enums/customer_pay_per_conversion_eligibility_failure_reason.proto rename to google/ads/googleads/v12/enums/customer_pay_per_conversion_eligibility_failure_reason.proto index c7d3555cb..76c990c4f 100644 --- a/google/ads/googleads/v9/enums/customer_pay_per_conversion_eligibility_failure_reason.proto +++ b/google/ads/googleads/v12/enums/customer_pay_per_conversion_eligibility_failure_reason.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomerPayPerConversionEligibilityFailureReasonProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing pay per conversion eligibility failure reasons. diff --git a/google/ads/googleads/v12/enums/customer_status.proto b/google/ads/googleads/v12/enums/customer_status.proto new file mode 100644 index 000000000..a4c62be19 --- /dev/null +++ b/google/ads/googleads/v12/enums/customer_status.proto @@ -0,0 +1,56 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CustomerStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Container for enum describing possible statuses of a customer. +message CustomerStatusEnum { + // Possible statuses of a customer. + enum CustomerStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Indicates an active account able to serve ads. + ENABLED = 2; + + // Indicates a canceled account unable to serve ads. + // Can be reactivated by an admin user. + CANCELED = 3; + + // Indicates a suspended account unable to serve ads. + // May only be activated by Google support. + SUSPENDED = 4; + + // Indicates a closed account unable to serve ads. + // Test account will also have CLOSED status. + // Status is permanent and may not be reopened. + CLOSED = 5; + } + + +} diff --git a/google/ads/googleads/v9/enums/customizer_attribute_status.proto b/google/ads/googleads/v12/enums/customizer_attribute_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/customizer_attribute_status.proto rename to google/ads/googleads/v12/enums/customizer_attribute_status.proto index 7b609ecf6..26214b99f 100644 --- a/google/ads/googleads/v9/enums/customizer_attribute_status.proto +++ b/google/ads/googleads/v12/enums/customizer_attribute_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomizerAttributeStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing customizer attribute status. diff --git a/google/ads/googleads/v9/enums/customizer_attribute_type.proto b/google/ads/googleads/v12/enums/customizer_attribute_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/customizer_attribute_type.proto rename to google/ads/googleads/v12/enums/customizer_attribute_type.proto index 9719e6cc0..74d325a8d 100644 --- a/google/ads/googleads/v9/enums/customizer_attribute_type.proto +++ b/google/ads/googleads/v12/enums/customizer_attribute_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomizerAttributeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing customizer attribute type. diff --git a/google/ads/googleads/v9/enums/customizer_value_status.proto b/google/ads/googleads/v12/enums/customizer_value_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/customizer_value_status.proto rename to google/ads/googleads/v12/enums/customizer_value_status.proto index 33e0308f4..1ebd2193d 100644 --- a/google/ads/googleads/v9/enums/customizer_value_status.proto +++ b/google/ads/googleads/v12/enums/customizer_value_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "CustomizerValueStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing customizer value status. diff --git a/google/ads/googleads/v9/enums/data_driven_model_status.proto b/google/ads/googleads/v12/enums/data_driven_model_status.proto similarity index 83% rename from google/ads/googleads/v9/enums/data_driven_model_status.proto rename to google/ads/googleads/v12/enums/data_driven_model_status.proto index 754a98961..af0b558f8 100644 --- a/google/ads/googleads/v9/enums/data_driven_model_status.proto +++ b/google/ads/googleads/v12/enums/data_driven_model_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DataDrivenModelStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing data-driven model status. diff --git a/google/ads/googleads/v9/enums/day_of_week.proto b/google/ads/googleads/v12/enums/day_of_week.proto similarity index 71% rename from google/ads/googleads/v9/enums/day_of_week.proto rename to google/ads/googleads/v12/enums/day_of_week.proto index 548b9e005..6198f1118 100644 --- a/google/ads/googleads/v9/enums/day_of_week.proto +++ b/google/ads/googleads/v12/enums/day_of_week.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DayOfWeekProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/device.proto b/google/ads/googleads/v12/enums/device.proto similarity index 78% rename from google/ads/googleads/v9/enums/device.proto rename to google/ads/googleads/v12/enums/device.proto index c44c336fc..882c21731 100644 --- a/google/ads/googleads/v9/enums/device.proto +++ b/google/ads/googleads/v12/enums/device.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DeviceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing devices. diff --git a/google/ads/googleads/v9/enums/display_ad_format_setting.proto b/google/ads/googleads/v12/enums/display_ad_format_setting.proto similarity index 72% rename from google/ads/googleads/v9/enums/display_ad_format_setting.proto rename to google/ads/googleads/v12/enums/display_ad_format_setting.proto index b54db6d97..85f0f6e92 100644 --- a/google/ads/googleads/v9/enums/display_ad_format_setting.proto +++ b/google/ads/googleads/v12/enums/display_ad_format_setting.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DisplayAdFormatSettingProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing display ad format settings. @@ -45,8 +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/google/ads/googleads/v9/enums/display_upload_product_type.proto b/google/ads/googleads/v12/enums/display_upload_product_type.proto similarity index 90% rename from google/ads/googleads/v9/enums/display_upload_product_type.proto rename to google/ads/googleads/v12/enums/display_upload_product_type.proto index 5a5e29699..15ec5a79c 100644 --- a/google/ads/googleads/v9/enums/display_upload_product_type.proto +++ b/google/ads/googleads/v12/enums/display_upload_product_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DisplayUploadProductTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing display upload product types. diff --git a/google/ads/googleads/v9/enums/distance_bucket.proto b/google/ads/googleads/v12/enums/distance_bucket.proto similarity index 84% rename from google/ads/googleads/v9/enums/distance_bucket.proto rename to google/ads/googleads/v12/enums/distance_bucket.proto index cfbccb1c1..9f3ae98c2 100644 --- a/google/ads/googleads/v9/enums/distance_bucket.proto +++ b/google/ads/googleads/v12/enums/distance_bucket.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. @@ -14,25 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DistanceBucketProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing distance buckets. -// Container for distance buckets of a user’s distance from an advertiser’s +// Container for distance buckets of a user's distance from an advertiser's // location extension. message DistanceBucketEnum { - // The distance bucket for a user’s distance from an advertiser’s location + // The distance bucket for a user's distance from an advertiser's location // extension. enum DistanceBucket { // Not specified. diff --git a/google/ads/googleads/v9/enums/dsa_page_feed_criterion_field.proto b/google/ads/googleads/v12/enums/dsa_page_feed_criterion_field.proto similarity index 79% rename from google/ads/googleads/v9/enums/dsa_page_feed_criterion_field.proto rename to google/ads/googleads/v12/enums/dsa_page_feed_criterion_field.proto index 0e558866e..e83ea466a 100644 --- a/google/ads/googleads/v9/enums/dsa_page_feed_criterion_field.proto +++ b/google/ads/googleads/v12/enums/dsa_page_feed_criterion_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "DsaPageFeedCriterionFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Dynamic Search Ad Page Feed criterion fields. diff --git a/google/ads/googleads/v9/enums/education_placeholder_field.proto b/google/ads/googleads/v12/enums/education_placeholder_field.proto similarity index 87% rename from google/ads/googleads/v9/enums/education_placeholder_field.proto rename to google/ads/googleads/v12/enums/education_placeholder_field.proto index ecc015710..0272f3474 100644 --- a/google/ads/googleads/v9/enums/education_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/education_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "EducationPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Education placeholder fields. @@ -73,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 diff --git a/google/ads/googleads/v12/enums/experiment_metric.proto b/google/ads/googleads/v12/enums/experiment_metric.proto new file mode 100644 index 000000000..1d0a99e84 --- /dev/null +++ b/google/ads/googleads/v12/enums/experiment_metric.proto @@ -0,0 +1,81 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentMetricProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing experiment metric. + +// Container for enum describing the type of experiment metric. +message ExperimentMetricEnum { + // The type of experiment metric. + enum ExperimentMetric { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // The goal of the experiment is clicks. + CLICKS = 2; + + // The goal of the experiment is impressions. + IMPRESSIONS = 3; + + // The goal of the experiment is cost. + COST = 4; + + // The goal of the experiment is conversion rate. + CONVERSIONS_PER_INTERACTION_RATE = 5; + + // The goal of the experiment is cost per conversion. + COST_PER_CONVERSION = 6; + + // The goal of the experiment is conversion value per cost. + CONVERSIONS_VALUE_PER_COST = 7; + + // The goal of the experiment is avg cpc. + AVERAGE_CPC = 8; + + // The goal of the experiment is ctr. + CTR = 9; + + // The goal of the experiment is incremental conversions. + INCREMENTAL_CONVERSIONS = 10; + + // The goal of the experiment is completed video views. + COMPLETED_VIDEO_VIEWS = 11; + + // The goal of the experiment is custom algorithms. + CUSTOM_ALGORITHMS = 12; + + // The goal of the experiment is conversions. + CONVERSIONS = 13; + + // The goal of the experiment is conversion value. + CONVERSION_VALUE = 14; + } + + +} diff --git a/google/ads/googleads/v12/enums/experiment_metric_direction.proto b/google/ads/googleads/v12/enums/experiment_metric_direction.proto new file mode 100644 index 000000000..9012564e2 --- /dev/null +++ b/google/ads/googleads/v12/enums/experiment_metric_direction.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentMetricDirectionProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing experiment metric direction. + +// Container for enum describing the type of experiment metric direction. +message ExperimentMetricDirectionEnum { + // The type of experiment metric direction. + enum ExperimentMetricDirection { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // The goal of the experiment is to not change the metric. + NO_CHANGE = 2; + + // The goal of the experiment is to increate the metric. + INCREASE = 3; + + // The goal of the experiment is to decrease the metric. + DECREASE = 4; + + // The goal of the experiment is to either not change or increase the + // metric. + NO_CHANGE_OR_INCREASE = 5; + + // The goal of the experiment is to either not change or decrease the + // metric. + NO_CHANGE_OR_DECREASE = 6; + } + + +} diff --git a/google/ads/googleads/v12/enums/experiment_status.proto b/google/ads/googleads/v12/enums/experiment_status.proto new file mode 100644 index 000000000..cabb87715 --- /dev/null +++ b/google/ads/googleads/v12/enums/experiment_status.proto @@ -0,0 +1,65 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing experiment status. + +// Container for enum describing the experiment status. +message ExperimentStatusEnum { + // The status of the experiment. + enum ExperimentStatus { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // The experiment is enabled. + ENABLED = 2; + + // The experiment has been removed. + REMOVED = 3; + + // The experiment has been halted. + // This status can be set from ENABLED status through API. + HALTED = 4; + + // The experiment will be promoted out of experimental status. + PROMOTED = 5; + + // Initial status of the experiment. + SETUP = 6; + + // The experiment's campaigns are pending materialization. + // This status can be set from SETUP status through API. + INITIATED = 7; + + // The experiment has been graduated. + GRADUATED = 8; + } + + +} diff --git a/google/ads/googleads/v12/enums/experiment_type.proto b/google/ads/googleads/v12/enums/experiment_type.proto new file mode 100644 index 000000000..55f81c558 --- /dev/null +++ b/google/ads/googleads/v12/enums/experiment_type.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing experiment type. + +// Container for enum describing the type of experiment. +message ExperimentTypeEnum { + // The type of the experiment. + enum ExperimentType { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // This is a DISPLAY_AND_VIDEO_360 experiment. + DISPLAY_AND_VIDEO_360 = 2; + + // This is an ad variation experiment. + AD_VARIATION = 3; + + // A custom experiment consisting of Video campaigns. + YOUTUBE_CUSTOM = 5; + + // A custom experiment consisting of display campaigns. + DISPLAY_CUSTOM = 6; + + // A custom experiment consisting of search campaigns. + SEARCH_CUSTOM = 7; + + // An experiment that compares bidding strategies for display campaigns. + DISPLAY_AUTOMATED_BIDDING_STRATEGY = 8; + + // An experiment that compares bidding strategies for search campaigns." + SEARCH_AUTOMATED_BIDDING_STRATEGY = 9; + + // An experiment that compares bidding strategies for shopping campaigns. + SHOPPING_AUTOMATED_BIDDING_STRATEGY = 10; + + // DEPRECATED. A smart matching experiment with search campaigns. + SMART_MATCHING = 11; + + // A custom experiment consisting of hotel campaigns. + HOTEL_CUSTOM = 12; + } + + +} diff --git a/google/ads/googleads/v9/enums/extension_setting_device.proto b/google/ads/googleads/v12/enums/extension_setting_device.proto similarity index 78% rename from google/ads/googleads/v9/enums/extension_setting_device.proto rename to google/ads/googleads/v12/enums/extension_setting_device.proto index df50d0e9f..05658215b 100644 --- a/google/ads/googleads/v9/enums/extension_setting_device.proto +++ b/google/ads/googleads/v12/enums/extension_setting_device.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ExtensionSettingDeviceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing extension setting device type. diff --git a/google/ads/googleads/v9/enums/extension_type.proto b/google/ads/googleads/v12/enums/extension_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/extension_type.proto rename to google/ads/googleads/v12/enums/extension_type.proto index 5224da803..0c6266a32 100644 --- a/google/ads/googleads/v9/enums/extension_type.proto +++ b/google/ads/googleads/v12/enums/extension_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ExtensionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing extension type. diff --git a/google/ads/googleads/v9/enums/external_conversion_source.proto b/google/ads/googleads/v12/enums/external_conversion_source.proto similarity index 92% rename from google/ads/googleads/v9/enums/external_conversion_source.proto rename to google/ads/googleads/v12/enums/external_conversion_source.proto index 9ff8a9436..52c744899 100644 --- a/google/ads/googleads/v9/enums/external_conversion_source.proto +++ b/google/ads/googleads/v12/enums/external_conversion_source.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ExternalConversionSourceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing the external conversion source that is // associated with a ConversionAction. @@ -146,6 +144,9 @@ message ExternalConversionSourceEnum { // Conversion that comes from a linked Firebase event for Search Ads 360. FIREBASE_SEARCH_ADS_360 = 33; + + // Conversion that is reported by Floodlight for DV360. + DISPLAY_AND_VIDEO_360_FLOODLIGHT = 34; } diff --git a/google/ads/googleads/v9/enums/feed_attribute_type.proto b/google/ads/googleads/v12/enums/feed_attribute_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/feed_attribute_type.proto rename to google/ads/googleads/v12/enums/feed_attribute_type.proto index 41ad1f8a4..6cb6ca953 100644 --- a/google/ads/googleads/v9/enums/feed_attribute_type.proto +++ b/google/ads/googleads/v12/enums/feed_attribute_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedAttributeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed attribute type. diff --git a/google/ads/googleads/v9/enums/feed_item_quality_approval_status.proto b/google/ads/googleads/v12/enums/feed_item_quality_approval_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/feed_item_quality_approval_status.proto rename to google/ads/googleads/v12/enums/feed_item_quality_approval_status.proto index e0b1dbb45..676277031 100644 --- a/google/ads/googleads/v9/enums/feed_item_quality_approval_status.proto +++ b/google/ads/googleads/v12/enums/feed_item_quality_approval_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemQualityApprovalStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item quality evaluation approval statuses. diff --git a/google/ads/googleads/v9/enums/feed_item_quality_disapproval_reason.proto b/google/ads/googleads/v12/enums/feed_item_quality_disapproval_reason.proto similarity index 89% rename from google/ads/googleads/v9/enums/feed_item_quality_disapproval_reason.proto rename to google/ads/googleads/v12/enums/feed_item_quality_disapproval_reason.proto index dc4b83d59..734f0a64b 100644 --- a/google/ads/googleads/v9/enums/feed_item_quality_disapproval_reason.proto +++ b/google/ads/googleads/v12/enums/feed_item_quality_disapproval_reason.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemQualityDisapprovalReasonProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item quality disapproval reasons. diff --git a/google/ads/googleads/v9/enums/feed_item_set_status.proto b/google/ads/googleads/v12/enums/feed_item_set_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/feed_item_set_status.proto rename to google/ads/googleads/v12/enums/feed_item_set_status.proto index f42b1c1c7..4cd37d9ef 100644 --- a/google/ads/googleads/v9/enums/feed_item_set_status.proto +++ b/google/ads/googleads/v12/enums/feed_item_set_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item set status. diff --git a/google/ads/googleads/v9/enums/feed_item_set_string_filter_type.proto b/google/ads/googleads/v12/enums/feed_item_set_string_filter_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_item_set_string_filter_type.proto rename to google/ads/googleads/v12/enums/feed_item_set_string_filter_type.proto index 5f27b405b..bf8aca461 100644 --- a/google/ads/googleads/v9/enums/feed_item_set_string_filter_type.proto +++ b/google/ads/googleads/v12/enums/feed_item_set_string_filter_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetStringFilterTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // The type of string matching to be used for a dynamic FeedItemSet filter. message FeedItemSetStringFilterTypeEnum { diff --git a/google/ads/googleads/v9/enums/feed_item_status.proto b/google/ads/googleads/v12/enums/feed_item_status.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_item_status.proto rename to google/ads/googleads/v12/enums/feed_item_status.proto index 7a1d523a0..33c18f819 100644 --- a/google/ads/googleads/v9/enums/feed_item_status.proto +++ b/google/ads/googleads/v12/enums/feed_item_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item status. diff --git a/google/ads/googleads/v9/enums/feed_item_target_device.proto b/google/ads/googleads/v12/enums/feed_item_target_device.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_item_target_device.proto rename to google/ads/googleads/v12/enums/feed_item_target_device.proto index 21bfd071b..8834aa6cb 100644 --- a/google/ads/googleads/v9/enums/feed_item_target_device.proto +++ b/google/ads/googleads/v12/enums/feed_item_target_device.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetDeviceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item target device type. diff --git a/google/ads/googleads/v9/enums/feed_item_target_status.proto b/google/ads/googleads/v12/enums/feed_item_target_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/feed_item_target_status.proto rename to google/ads/googleads/v12/enums/feed_item_target_status.proto index 50369d863..7d9e65e41 100644 --- a/google/ads/googleads/v9/enums/feed_item_target_status.proto +++ b/google/ads/googleads/v12/enums/feed_item_target_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item target status. diff --git a/google/ads/googleads/v9/enums/feed_item_target_type.proto b/google/ads/googleads/v12/enums/feed_item_target_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/feed_item_target_type.proto rename to google/ads/googleads/v12/enums/feed_item_target_type.proto index 6576c25d7..70c5d7200 100644 --- a/google/ads/googleads/v9/enums/feed_item_target_type.proto +++ b/google/ads/googleads/v12/enums/feed_item_target_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item target type status. diff --git a/google/ads/googleads/v9/enums/feed_item_validation_status.proto b/google/ads/googleads/v12/enums/feed_item_validation_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/feed_item_validation_status.proto rename to google/ads/googleads/v12/enums/feed_item_validation_status.proto index 18e25f119..66b80062e 100644 --- a/google/ads/googleads/v9/enums/feed_item_validation_status.proto +++ b/google/ads/googleads/v12/enums/feed_item_validation_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedItemValidationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed item validation statuses. diff --git a/google/ads/googleads/v9/enums/feed_link_status.proto b/google/ads/googleads/v12/enums/feed_link_status.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_link_status.proto rename to google/ads/googleads/v12/enums/feed_link_status.proto index c6cf54b6e..91c86e177 100644 --- a/google/ads/googleads/v9/enums/feed_link_status.proto +++ b/google/ads/googleads/v12/enums/feed_link_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing status of a feed link. diff --git a/google/ads/googleads/v9/enums/feed_mapping_criterion_type.proto b/google/ads/googleads/v12/enums/feed_mapping_criterion_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/feed_mapping_criterion_type.proto rename to google/ads/googleads/v12/enums/feed_mapping_criterion_type.proto index a7b975f54..ba203d779 100644 --- a/google/ads/googleads/v9/enums/feed_mapping_criterion_type.proto +++ b/google/ads/googleads/v12/enums/feed_mapping_criterion_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedMappingCriterionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing criterion types for feed mappings. diff --git a/google/ads/googleads/v9/enums/feed_mapping_status.proto b/google/ads/googleads/v12/enums/feed_mapping_status.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_mapping_status.proto rename to google/ads/googleads/v12/enums/feed_mapping_status.proto index 03ecba308..d150ab237 100644 --- a/google/ads/googleads/v9/enums/feed_mapping_status.proto +++ b/google/ads/googleads/v12/enums/feed_mapping_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedMappingStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed mapping status. diff --git a/google/ads/googleads/v9/enums/feed_origin.proto b/google/ads/googleads/v12/enums/feed_origin.proto similarity index 79% rename from google/ads/googleads/v9/enums/feed_origin.proto rename to google/ads/googleads/v12/enums/feed_origin.proto index 8dc17f473..8ea5d73b8 100644 --- a/google/ads/googleads/v9/enums/feed_origin.proto +++ b/google/ads/googleads/v12/enums/feed_origin.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedOriginProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed origin. diff --git a/google/ads/googleads/v9/enums/feed_status.proto b/google/ads/googleads/v12/enums/feed_status.proto similarity index 76% rename from google/ads/googleads/v9/enums/feed_status.proto rename to google/ads/googleads/v12/enums/feed_status.proto index d2463b4a0..e56b4210c 100644 --- a/google/ads/googleads/v9/enums/feed_status.proto +++ b/google/ads/googleads/v12/enums/feed_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FeedStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed status. diff --git a/google/ads/googleads/v9/enums/flight_placeholder_field.proto b/google/ads/googleads/v12/enums/flight_placeholder_field.proto similarity index 91% rename from google/ads/googleads/v9/enums/flight_placeholder_field.proto rename to google/ads/googleads/v12/enums/flight_placeholder_field.proto index fc0dc5caa..5549ded33 100644 --- a/google/ads/googleads/v9/enums/flight_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/flight_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FlightsPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Flight placeholder fields. diff --git a/google/ads/googleads/v9/enums/frequency_cap_event_type.proto b/google/ads/googleads/v12/enums/frequency_cap_event_type.proto similarity index 73% rename from google/ads/googleads/v9/enums/frequency_cap_event_type.proto rename to google/ads/googleads/v12/enums/frequency_cap_event_type.proto index f433086b6..ceded8b4d 100644 --- a/google/ads/googleads/v9/enums/frequency_cap_event_type.proto +++ b/google/ads/googleads/v12/enums/frequency_cap_event_type.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FrequencyCapEventTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/frequency_cap_level.proto b/google/ads/googleads/v12/enums/frequency_cap_level.proto similarity index 79% rename from google/ads/googleads/v9/enums/frequency_cap_level.proto rename to google/ads/googleads/v12/enums/frequency_cap_level.proto index 67961cbf7..42d927dd8 100644 --- a/google/ads/googleads/v9/enums/frequency_cap_level.proto +++ b/google/ads/googleads/v12/enums/frequency_cap_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FrequencyCapLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing frequency caps. diff --git a/google/ads/googleads/v9/enums/frequency_cap_time_unit.proto b/google/ads/googleads/v12/enums/frequency_cap_time_unit.proto similarity index 75% rename from google/ads/googleads/v9/enums/frequency_cap_time_unit.proto rename to google/ads/googleads/v12/enums/frequency_cap_time_unit.proto index 2f97bd839..b19372e44 100644 --- a/google/ads/googleads/v9/enums/frequency_cap_time_unit.proto +++ b/google/ads/googleads/v12/enums/frequency_cap_time_unit.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "FrequencyCapTimeUnitProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/gender_type.proto b/google/ads/googleads/v12/enums/gender_type.proto similarity index 73% rename from google/ads/googleads/v9/enums/gender_type.proto rename to google/ads/googleads/v12/enums/gender_type.proto index b515fc621..e11c0f88a 100644 --- a/google/ads/googleads/v9/enums/gender_type.proto +++ b/google/ads/googleads/v12/enums/gender_type.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GenderTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/geo_target_constant_status.proto b/google/ads/googleads/v12/enums/geo_target_constant_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/geo_target_constant_status.proto rename to google/ads/googleads/v12/enums/geo_target_constant_status.proto index c2d2247a6..bce105ee5 100644 --- a/google/ads/googleads/v9/enums/geo_target_constant_status.proto +++ b/google/ads/googleads/v12/enums/geo_target_constant_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GeoTargetConstantStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing geo target constant statuses. diff --git a/google/ads/googleads/v9/enums/geo_targeting_restriction.proto b/google/ads/googleads/v12/enums/geo_targeting_restriction.proto similarity index 78% rename from google/ads/googleads/v9/enums/geo_targeting_restriction.proto rename to google/ads/googleads/v12/enums/geo_targeting_restriction.proto index 7da3a650f..70c27617a 100644 --- a/google/ads/googleads/v9/enums/geo_targeting_restriction.proto +++ b/google/ads/googleads/v12/enums/geo_targeting_restriction.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GeoTargetingRestrictionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing GeoTargetingRestriction. diff --git a/google/ads/googleads/v9/enums/geo_targeting_type.proto b/google/ads/googleads/v12/enums/geo_targeting_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/geo_targeting_type.proto rename to google/ads/googleads/v12/enums/geo_targeting_type.proto index b7b00db22..3bc9c6429 100644 --- a/google/ads/googleads/v9/enums/geo_targeting_type.proto +++ b/google/ads/googleads/v12/enums/geo_targeting_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GeoTargetingTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing geo targeting types. diff --git a/google/ads/googleads/v9/enums/goal_config_level.proto b/google/ads/googleads/v12/enums/goal_config_level.proto similarity index 79% rename from google/ads/googleads/v9/enums/goal_config_level.proto rename to google/ads/googleads/v12/enums/goal_config_level.proto index 72e2164cc..ff8068e49 100644 --- a/google/ads/googleads/v9/enums/goal_config_level.proto +++ b/google/ads/googleads/v12/enums/goal_config_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GoalConfigLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing goal config level. diff --git a/google/ads/googleads/v9/enums/google_ads_field_category.proto b/google/ads/googleads/v12/enums/google_ads_field_category.proto similarity index 82% rename from google/ads/googleads/v9/enums/google_ads_field_category.proto rename to google/ads/googleads/v12/enums/google_ads_field_category.proto index 3b3b15cac..d98a3429f 100644 --- a/google/ads/googleads/v9/enums/google_ads_field_category.proto +++ b/google/ads/googleads/v12/enums/google_ads_field_category.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GoogleAdsFieldCategoryProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing GoogleAdsField categories. diff --git a/google/ads/googleads/v9/enums/google_ads_field_data_type.proto b/google/ads/googleads/v12/enums/google_ads_field_data_type.proto similarity index 88% rename from google/ads/googleads/v9/enums/google_ads_field_data_type.proto rename to google/ads/googleads/v12/enums/google_ads_field_data_type.proto index 8fed90108..981f8acfc 100644 --- a/google/ads/googleads/v9/enums/google_ads_field_data_type.proto +++ b/google/ads/googleads/v12/enums/google_ads_field_data_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GoogleAdsFieldDataTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing GoogleAdsField data types. diff --git a/google/ads/googleads/v9/enums/google_voice_call_status.proto b/google/ads/googleads/v12/enums/google_voice_call_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/google_voice_call_status.proto rename to google/ads/googleads/v12/enums/google_voice_call_status.proto index 3fb3f0e66..d1cb4a9df 100644 --- a/google/ads/googleads/v9/enums/google_voice_call_status.proto +++ b/google/ads/googleads/v12/enums/google_voice_call_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "GoogleVoiceCallStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing google voice call status. diff --git a/google/ads/googleads/v9/enums/hotel_date_selection_type.proto b/google/ads/googleads/v12/enums/hotel_date_selection_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/hotel_date_selection_type.proto rename to google/ads/googleads/v12/enums/hotel_date_selection_type.proto index 7f42efc18..ff874d55c 100644 --- a/google/ads/googleads/v9/enums/hotel_date_selection_type.proto +++ b/google/ads/googleads/v12/enums/hotel_date_selection_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "HotelDateSelectionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing hotel date selection types. diff --git a/google/ads/googleads/v9/enums/hotel_placeholder_field.proto b/google/ads/googleads/v12/enums/hotel_placeholder_field.proto similarity index 91% rename from google/ads/googleads/v9/enums/hotel_placeholder_field.proto rename to google/ads/googleads/v12/enums/hotel_placeholder_field.proto index 3acc3cb9e..972218740 100644 --- a/google/ads/googleads/v9/enums/hotel_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/hotel_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "HotelsPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Hotel placeholder fields. diff --git a/google/ads/googleads/v9/enums/hotel_price_bucket.proto b/google/ads/googleads/v12/enums/hotel_price_bucket.proto similarity index 80% rename from google/ads/googleads/v9/enums/hotel_price_bucket.proto rename to google/ads/googleads/v12/enums/hotel_price_bucket.proto index 6dd418446..4a7b879c2 100644 --- a/google/ads/googleads/v9/enums/hotel_price_bucket.proto +++ b/google/ads/googleads/v12/enums/hotel_price_bucket.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "HotelPriceBucketProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing hotel price buckets. diff --git a/google/ads/googleads/v9/enums/hotel_rate_type.proto b/google/ads/googleads/v12/enums/hotel_rate_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/hotel_rate_type.proto rename to google/ads/googleads/v12/enums/hotel_rate_type.proto index 0e9b12b00..860401ff8 100644 --- a/google/ads/googleads/v9/enums/hotel_rate_type.proto +++ b/google/ads/googleads/v12/enums/hotel_rate_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "HotelRateTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing hotel rate types. @@ -52,9 +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/google/ads/googleads/v9/enums/hotel_reconciliation_status.proto b/google/ads/googleads/v12/enums/hotel_reconciliation_status.proto similarity index 83% rename from google/ads/googleads/v9/enums/hotel_reconciliation_status.proto rename to google/ads/googleads/v12/enums/hotel_reconciliation_status.proto index c2ef158be..2494510bf 100644 --- a/google/ads/googleads/v9/enums/hotel_reconciliation_status.proto +++ b/google/ads/googleads/v12/enums/hotel_reconciliation_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "HotelReconciliationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing hotel reconciliation row status. diff --git a/google/ads/googleads/v9/enums/image_placeholder_field.proto b/google/ads/googleads/v12/enums/image_placeholder_field.proto similarity index 77% rename from google/ads/googleads/v9/enums/image_placeholder_field.proto rename to google/ads/googleads/v12/enums/image_placeholder_field.proto index d16b0ec33..f37bbf1f5 100644 --- a/google/ads/googleads/v9/enums/image_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/image_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ImagePlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Advertiser Provided Image placeholder fields. diff --git a/google/ads/googleads/v9/enums/income_range_type.proto b/google/ads/googleads/v12/enums/income_range_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/income_range_type.proto rename to google/ads/googleads/v12/enums/income_range_type.proto index c718e9818..e91deeff6 100644 --- a/google/ads/googleads/v9/enums/income_range_type.proto +++ b/google/ads/googleads/v12/enums/income_range_type.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "IncomeRangeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/interaction_event_type.proto b/google/ads/googleads/v12/enums/interaction_event_type.proto similarity index 80% rename from google/ads/googleads/v9/enums/interaction_event_type.proto rename to google/ads/googleads/v12/enums/interaction_event_type.proto index 89adab63a..a3fad24b2 100644 --- a/google/ads/googleads/v9/enums/interaction_event_type.proto +++ b/google/ads/googleads/v12/enums/interaction_event_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "InteractionEventTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing types of payable and free interactions. @@ -52,7 +50,7 @@ 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/google/ads/googleads/v9/enums/interaction_type.proto b/google/ads/googleads/v12/enums/interaction_type.proto similarity index 75% rename from google/ads/googleads/v9/enums/interaction_type.proto rename to google/ads/googleads/v12/enums/interaction_type.proto index 5f93f3bcc..3c5216aaa 100644 --- a/google/ads/googleads/v9/enums/interaction_type.proto +++ b/google/ads/googleads/v12/enums/interaction_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "InteractionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing interaction types. diff --git a/google/ads/googleads/v9/enums/invoice_type.proto b/google/ads/googleads/v12/enums/invoice_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/invoice_type.proto rename to google/ads/googleads/v12/enums/invoice_type.proto index 451542071..984e294a2 100644 --- a/google/ads/googleads/v9/enums/invoice_type.proto +++ b/google/ads/googleads/v12/enums/invoice_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "InvoiceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing invoice types. diff --git a/google/ads/googleads/v9/enums/job_placeholder_field.proto b/google/ads/googleads/v12/enums/job_placeholder_field.proto similarity index 87% rename from google/ads/googleads/v9/enums/job_placeholder_field.proto rename to google/ads/googleads/v12/enums/job_placeholder_field.proto index f799defc6..c5638d93b 100644 --- a/google/ads/googleads/v9/enums/job_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/job_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "JobsPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Job placeholder fields. @@ -80,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 diff --git a/google/ads/googleads/v9/enums/keyword_match_type.proto b/google/ads/googleads/v12/enums/keyword_match_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/keyword_match_type.proto rename to google/ads/googleads/v12/enums/keyword_match_type.proto index 0c96c7aa2..e977e433d 100644 --- a/google/ads/googleads/v9/enums/keyword_match_type.proto +++ b/google/ads/googleads/v12/enums/keyword_match_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordMatchTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Keyword match types. diff --git a/google/ads/googleads/v9/enums/keyword_plan_aggregate_metric_type.proto b/google/ads/googleads/v12/enums/keyword_plan_aggregate_metric_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/keyword_plan_aggregate_metric_type.proto rename to google/ads/googleads/v12/enums/keyword_plan_aggregate_metric_type.proto index a525c8fe9..a3556eb09 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_aggregate_metric_type.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_aggregate_metric_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAggregateMetricTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing keyword plan aggregate metric types. diff --git a/google/ads/googleads/v9/enums/keyword_plan_competition_level.proto b/google/ads/googleads/v12/enums/keyword_plan_competition_level.proto similarity index 82% rename from google/ads/googleads/v9/enums/keyword_plan_competition_level.proto rename to google/ads/googleads/v12/enums/keyword_plan_competition_level.proto index 678ef8cb2..240b3ab50 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_competition_level.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_competition_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCompetitionLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Keyword Planner competition levels. diff --git a/google/ads/googleads/v9/enums/keyword_plan_concept_group_type.proto b/google/ads/googleads/v12/enums/keyword_plan_concept_group_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/keyword_plan_concept_group_type.proto rename to google/ads/googleads/v12/enums/keyword_plan_concept_group_type.proto index fba7e29b2..725ce6845 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_concept_group_type.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_concept_group_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanConceptGroupTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Keyword Planner Concept Group types. diff --git a/google/ads/googleads/v9/enums/keyword_plan_forecast_interval.proto b/google/ads/googleads/v12/enums/keyword_plan_forecast_interval.proto similarity index 80% rename from google/ads/googleads/v9/enums/keyword_plan_forecast_interval.proto rename to google/ads/googleads/v12/enums/keyword_plan_forecast_interval.proto index ca7bef128..53a3475a4 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_forecast_interval.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_forecast_interval.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanForecastIntervalProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing keyword plan forecast intervals. diff --git a/google/ads/googleads/v9/enums/keyword_plan_keyword_annotation.proto b/google/ads/googleads/v12/enums/keyword_plan_keyword_annotation.proto similarity index 77% rename from google/ads/googleads/v9/enums/keyword_plan_keyword_annotation.proto rename to google/ads/googleads/v12/enums/keyword_plan_keyword_annotation.proto index 8d63512ea..d61ffbf1f 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_keyword_annotation.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_keyword_annotation.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanKeywordAnnotationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Keyword Planner Keyword annotation types. diff --git a/google/ads/googleads/v9/enums/keyword_plan_network.proto b/google/ads/googleads/v12/enums/keyword_plan_network.proto similarity index 77% rename from google/ads/googleads/v9/enums/keyword_plan_network.proto rename to google/ads/googleads/v12/enums/keyword_plan_network.proto index e48cf13f8..06e1e748f 100644 --- a/google/ads/googleads/v9/enums/keyword_plan_network.proto +++ b/google/ads/googleads/v12/enums/keyword_plan_network.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanNetworkProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Keyword Planner forecastable network types. diff --git a/google/ads/googleads/v9/enums/label_status.proto b/google/ads/googleads/v12/enums/label_status.proto similarity index 75% rename from google/ads/googleads/v9/enums/label_status.proto rename to google/ads/googleads/v12/enums/label_status.proto index 13f72dfff..8ccbeb793 100644 --- a/google/ads/googleads/v9/enums/label_status.proto +++ b/google/ads/googleads/v12/enums/label_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LabelStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing possible status of a label. message LabelStatusEnum { diff --git a/google/ads/googleads/v9/enums/lead_form_call_to_action_type.proto b/google/ads/googleads/v12/enums/lead_form_call_to_action_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/lead_form_call_to_action_type.proto rename to google/ads/googleads/v12/enums/lead_form_call_to_action_type.proto index 7279a4322..eb0cadc87 100644 --- a/google/ads/googleads/v9/enums/lead_form_call_to_action_type.proto +++ b/google/ads/googleads/v12/enums/lead_form_call_to_action_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LeadFormCallToActionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Describes the type of call-to-action phrases in a lead form. message LeadFormCallToActionTypeEnum { diff --git a/google/ads/googleads/v9/enums/lead_form_desired_intent.proto b/google/ads/googleads/v12/enums/lead_form_desired_intent.proto similarity index 69% rename from google/ads/googleads/v9/enums/lead_form_desired_intent.proto rename to google/ads/googleads/v12/enums/lead_form_desired_intent.proto index 6cb79db73..231587036 100644 --- a/google/ads/googleads/v9/enums/lead_form_desired_intent.proto +++ b/google/ads/googleads/v12/enums/lead_form_desired_intent.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. @@ -14,22 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LeadFormDesiredIntentProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/lead_form_field_user_input_type.proto b/google/ads/googleads/v12/enums/lead_form_field_user_input_type.proto similarity index 54% rename from google/ads/googleads/v9/enums/lead_form_field_user_input_type.proto rename to google/ads/googleads/v12/enums/lead_form_field_user_input_type.proto index 264badfc4..00ec7835f 100644 --- a/google/ads/googleads/v9/enums/lead_form_field_user_input_type.proto +++ b/google/ads/googleads/v12/enums/lead_form_field_user_input_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LeadFormFieldUserInputTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Describes the input type of a lead form field. message LeadFormFieldUserInputTypeEnum { @@ -50,11 +48,14 @@ message LeadFormFieldUserInputTypeEnum { // 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 (e.g. - // state for US, province for Canada). + // 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. @@ -72,6 +73,27 @@ message LeadFormFieldUserInputTypeEnum { // 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; @@ -128,6 +150,198 @@ message LeadFormFieldUserInputTypeEnum { // Category: "Business" JOB_ROLE = 1012; + // Question: "Are you over 18 years of age?" + // Category: "Demographics" + OVER_18_AGE = 1078; + + // Question: "Are you over 19 years of age?" + // Category: "Demographics" + OVER_19_AGE = 1079; + + // Question: "Are you over 20 years of age?" + // Category: "Demographics" + OVER_20_AGE = 1080; + + // Question: "Are you over 21 years of age?" + // Category: "Demographics" + OVER_21_AGE = 1081; + + // Question: "Are you over 22 years of age?" + // Category: "Demographics" + OVER_22_AGE = 1082; + + // Question: "Are you over 23 years of age?" + // Category: "Demographics" + OVER_23_AGE = 1083; + + // Question: "Are you over 24 years of age?" + // Category: "Demographics" + OVER_24_AGE = 1084; + + // Question: "Are you over 25 years of age?" + // Category: "Demographics" + OVER_25_AGE = 1085; + + // Question: "Are you over 26 years of age?" + // Category: "Demographics" + OVER_26_AGE = 1086; + + // Question: "Are you over 27 years of age?" + // Category: "Demographics" + OVER_27_AGE = 1087; + + // Question: "Are you over 28 years of age?" + // Category: "Demographics" + OVER_28_AGE = 1088; + + // Question: "Are you over 29 years of age?" + // Category: "Demographics" + OVER_29_AGE = 1089; + + // Question: "Are you over 30 years of age?" + // Category: "Demographics" + OVER_30_AGE = 1090; + + // Question: "Are you over 31 years of age?" + // Category: "Demographics" + OVER_31_AGE = 1091; + + // Question: "Are you over 32 years of age?" + // Category: "Demographics" + OVER_32_AGE = 1092; + + // Question: "Are you over 33 years of age?" + // Category: "Demographics" + OVER_33_AGE = 1093; + + // Question: "Are you over 34 years of age?" + // Category: "Demographics" + OVER_34_AGE = 1094; + + // Question: "Are you over 35 years of age?" + // Category: "Demographics" + OVER_35_AGE = 1095; + + // Question: "Are you over 36 years of age?" + // Category: "Demographics" + OVER_36_AGE = 1096; + + // Question: "Are you over 37 years of age?" + // Category: "Demographics" + OVER_37_AGE = 1097; + + // Question: "Are you over 38 years of age?" + // Category: "Demographics" + OVER_38_AGE = 1098; + + // Question: "Are you over 39 years of age?" + // Category: "Demographics" + OVER_39_AGE = 1099; + + // Question: "Are you over 40 years of age?" + // Category: "Demographics" + OVER_40_AGE = 1100; + + // Question: "Are you over 41 years of age?" + // Category: "Demographics" + OVER_41_AGE = 1101; + + // Question: "Are you over 42 years of age?" + // Category: "Demographics" + OVER_42_AGE = 1102; + + // Question: "Are you over 43 years of age?" + // Category: "Demographics" + OVER_43_AGE = 1103; + + // Question: "Are you over 44 years of age?" + // Category: "Demographics" + OVER_44_AGE = 1104; + + // Question: "Are you over 45 years of age?" + // Category: "Demographics" + OVER_45_AGE = 1105; + + // Question: "Are you over 46 years of age?" + // Category: "Demographics" + OVER_46_AGE = 1106; + + // Question: "Are you over 47 years of age?" + // Category: "Demographics" + OVER_47_AGE = 1107; + + // Question: "Are you over 48 years of age?" + // Category: "Demographics" + OVER_48_AGE = 1108; + + // Question: "Are you over 49 years of age?" + // Category: "Demographics" + OVER_49_AGE = 1109; + + // Question: "Are you over 50 years of age?" + // Category: "Demographics" + OVER_50_AGE = 1110; + + // Question: "Are you over 51 years of age?" + // Category: "Demographics" + OVER_51_AGE = 1111; + + // Question: "Are you over 52 years of age?" + // Category: "Demographics" + OVER_52_AGE = 1112; + + // Question: "Are you over 53 years of age?" + // Category: "Demographics" + OVER_53_AGE = 1113; + + // Question: "Are you over 54 years of age?" + // Category: "Demographics" + OVER_54_AGE = 1114; + + // Question: "Are you over 55 years of age?" + // Category: "Demographics" + OVER_55_AGE = 1115; + + // Question: "Are you over 56 years of age?" + // Category: "Demographics" + OVER_56_AGE = 1116; + + // Question: "Are you over 57 years of age?" + // Category: "Demographics" + OVER_57_AGE = 1117; + + // Question: "Are you over 58 years of age?" + // Category: "Demographics" + OVER_58_AGE = 1118; + + // Question: "Are you over 59 years of age?" + // Category: "Demographics" + OVER_59_AGE = 1119; + + // Question: "Are you over 60 years of age?" + // Category: "Demographics" + OVER_60_AGE = 1120; + + // Question: "Are you over 61 years of age?" + // Category: "Demographics" + OVER_61_AGE = 1121; + + // Question: "Are you over 62 years of age?" + // Category: "Demographics" + OVER_62_AGE = 1122; + + // Question: "Are you over 63 years of age?" + // Category: "Demographics" + OVER_63_AGE = 1123; + + // Question: "Are you over 64 years of age?" + // Category: "Demographics" + OVER_64_AGE = 1124; + + // Question: "Are you over 65 years of age?" + // Category: "Demographics" + OVER_65_AGE = 1125; + // Question: "Which program are you interested in?" // Category: "Education" EDUCATION_PROGRAM = 1013; diff --git a/google/ads/googleads/v9/enums/lead_form_post_submit_call_to_action_type.proto b/google/ads/googleads/v12/enums/lead_form_post_submit_call_to_action_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/lead_form_post_submit_call_to_action_type.proto rename to google/ads/googleads/v12/enums/lead_form_post_submit_call_to_action_type.proto index 50c51eb69..e3b686209 100644 --- a/google/ads/googleads/v9/enums/lead_form_post_submit_call_to_action_type.proto +++ b/google/ads/googleads/v12/enums/lead_form_post_submit_call_to_action_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LeadFormPostSubmitCallToActionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Describes the type of post-submit call-to-action phrases for a lead form. message LeadFormPostSubmitCallToActionTypeEnum { diff --git a/google/ads/googleads/v9/enums/legacy_app_install_ad_app_store.proto b/google/ads/googleads/v12/enums/legacy_app_install_ad_app_store.proto similarity index 79% rename from google/ads/googleads/v9/enums/legacy_app_install_ad_app_store.proto rename to google/ads/googleads/v12/enums/legacy_app_install_ad_app_store.proto index 3d24ee299..2b959611e 100644 --- a/google/ads/googleads/v9/enums/legacy_app_install_ad_app_store.proto +++ b/google/ads/googleads/v12/enums/legacy_app_install_ad_app_store.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LegacyAppInstallAdAppStoreProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing app store types for a legacy app install ad. diff --git a/google/ads/googleads/v9/enums/linked_account_type.proto b/google/ads/googleads/v12/enums/linked_account_type.proto similarity index 69% rename from google/ads/googleads/v9/enums/linked_account_type.proto rename to google/ads/googleads/v12/enums/linked_account_type.proto index 084644179..72fcfd5e8 100644 --- a/google/ads/googleads/v9/enums/linked_account_type.proto +++ b/google/ads/googleads/v12/enums/linked_account_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LinkedAccountTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing different types of Linked accounts. message LinkedAccountTypeEnum { @@ -46,6 +44,14 @@ message LinkedAccountTypeEnum { // A link to Google Ads. GOOGLE_ADS = 4; + + // 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/google/ads/googleads/v9/enums/listing_group_filter_bidding_category_level.proto b/google/ads/googleads/v12/enums/listing_group_filter_bidding_category_level.proto similarity index 79% rename from google/ads/googleads/v9/enums/listing_group_filter_bidding_category_level.proto rename to google/ads/googleads/v12/enums/listing_group_filter_bidding_category_level.proto index 37e0d997f..83e568d93 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_bidding_category_level.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_bidding_category_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterBiddingCategoryLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_custom_attribute_index.proto b/google/ads/googleads/v12/enums/listing_group_filter_custom_attribute_index.proto similarity index 80% rename from google/ads/googleads/v9/enums/listing_group_filter_custom_attribute_index.proto rename to google/ads/googleads/v12/enums/listing_group_filter_custom_attribute_index.proto index 7646020ea..ed42d2b2b 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_custom_attribute_index.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_custom_attribute_index.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterCustomAttributeIndexProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_product_channel.proto b/google/ads/googleads/v12/enums/listing_group_filter_product_channel.proto similarity index 77% rename from google/ads/googleads/v9/enums/listing_group_filter_product_channel.proto rename to google/ads/googleads/v12/enums/listing_group_filter_product_channel.proto index c49637f39..3dbc00b12 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_product_channel.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_product_channel.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterProductChannelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_product_condition.proto b/google/ads/googleads/v12/enums/listing_group_filter_product_condition.proto similarity index 78% rename from google/ads/googleads/v9/enums/listing_group_filter_product_condition.proto rename to google/ads/googleads/v12/enums/listing_group_filter_product_condition.proto index 4310f1475..12cf27323 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_product_condition.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_product_condition.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterProductConditionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_product_type_level.proto b/google/ads/googleads/v12/enums/listing_group_filter_product_type_level.proto similarity index 78% rename from google/ads/googleads/v9/enums/listing_group_filter_product_type_level.proto rename to google/ads/googleads/v12/enums/listing_group_filter_product_type_level.proto index e429fe13c..74ff48999 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_product_type_level.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_product_type_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterProductTypeLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_type_enum.proto b/google/ads/googleads/v12/enums/listing_group_filter_type_enum.proto similarity index 78% rename from google/ads/googleads/v9/enums/listing_group_filter_type_enum.proto rename to google/ads/googleads/v12/enums/listing_group_filter_type_enum.proto index 18ae23439..156ba6c6b 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_type_enum.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_type_enum.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterTypeEnumProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_filter_vertical.proto b/google/ads/googleads/v12/enums/listing_group_filter_vertical.proto similarity index 77% rename from google/ads/googleads/v9/enums/listing_group_filter_vertical.proto rename to google/ads/googleads/v12/enums/listing_group_filter_vertical.proto index 81b458815..bec6986ca 100644 --- a/google/ads/googleads/v9/enums/listing_group_filter_vertical.proto +++ b/google/ads/googleads/v12/enums/listing_group_filter_vertical.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupFilterVerticalProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/listing_group_type.proto b/google/ads/googleads/v12/enums/listing_group_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/listing_group_type.proto rename to google/ads/googleads/v12/enums/listing_group_type.proto index e57d53a96..0e644924f 100644 --- a/google/ads/googleads/v9/enums/listing_group_type.proto +++ b/google/ads/googleads/v12/enums/listing_group_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ListingGroupTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing listing groups. diff --git a/google/ads/googleads/v9/enums/local_placeholder_field.proto b/google/ads/googleads/v12/enums/local_placeholder_field.proto similarity index 87% rename from google/ads/googleads/v9/enums/local_placeholder_field.proto rename to google/ads/googleads/v12/enums/local_placeholder_field.proto index 7fae7b3d5..f09cc438d 100644 --- a/google/ads/googleads/v9/enums/local_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/local_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LocalPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Local placeholder fields. @@ -84,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 diff --git a/google/ads/googleads/v9/enums/location_extension_targeting_criterion_field.proto b/google/ads/googleads/v12/enums/location_extension_targeting_criterion_field.proto similarity index 82% rename from google/ads/googleads/v9/enums/location_extension_targeting_criterion_field.proto rename to google/ads/googleads/v12/enums/location_extension_targeting_criterion_field.proto index acfe44f32..6bac1a2c9 100644 --- a/google/ads/googleads/v9/enums/location_extension_targeting_criterion_field.proto +++ b/google/ads/googleads/v12/enums/location_extension_targeting_criterion_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LocationExtensionTargetingCriterionFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Location Extension Targeting criterion fields. diff --git a/google/ads/googleads/v9/enums/location_group_radius_units.proto b/google/ads/googleads/v12/enums/location_group_radius_units.proto similarity index 73% rename from google/ads/googleads/v9/enums/location_group_radius_units.proto rename to google/ads/googleads/v12/enums/location_group_radius_units.proto index 870e4bd96..f51c6d25d 100644 --- a/google/ads/googleads/v9/enums/location_group_radius_units.proto +++ b/google/ads/googleads/v12/enums/location_group_radius_units.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LocationGroupRadiusUnitsProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v12/enums/location_ownership_type.proto b/google/ads/googleads/v12/enums/location_ownership_type.proto new file mode 100644 index 000000000..bbb80066a --- /dev/null +++ b/google/ads/googleads/v12/enums/location_ownership_type.proto @@ -0,0 +1,48 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "LocationOwnershipTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/enums/location_placeholder_field.proto b/google/ads/googleads/v12/enums/location_placeholder_field.proto similarity index 82% rename from google/ads/googleads/v9/enums/location_placeholder_field.proto rename to google/ads/googleads/v12/enums/location_placeholder_field.proto index 216aeec88..1f7529c3f 100644 --- a/google/ads/googleads/v9/enums/location_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/location_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LocationPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Location placeholder fields. diff --git a/google/ads/googleads/v9/enums/location_source_type.proto b/google/ads/googleads/v12/enums/location_source_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/location_source_type.proto rename to google/ads/googleads/v12/enums/location_source_type.proto index d1ecb4fed..266e828c6 100644 --- a/google/ads/googleads/v9/enums/location_source_type.proto +++ b/google/ads/googleads/v12/enums/location_source_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "LocationSourceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing location source types. diff --git a/google/ads/googleads/v12/enums/location_string_filter_type.proto b/google/ads/googleads/v12/enums/location_string_filter_type.proto new file mode 100644 index 000000000..1f9d92ec7 --- /dev/null +++ b/google/ads/googleads/v12/enums/location_string_filter_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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "LocationStringFilterTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing location string filter type. + +// 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; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The filter will use exact string matching. + EXACT = 2; + } + + +} diff --git a/google/ads/googleads/v9/enums/manager_link_status.proto b/google/ads/googleads/v12/enums/manager_link_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/manager_link_status.proto rename to google/ads/googleads/v12/enums/manager_link_status.proto index 2f85dc442..7df2c7190 100644 --- a/google/ads/googleads/v9/enums/manager_link_status.proto +++ b/google/ads/googleads/v12/enums/manager_link_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ManagerLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing possible status of a manager and client link. message ManagerLinkStatusEnum { diff --git a/google/ads/googleads/v9/enums/matching_function_context_type.proto b/google/ads/googleads/v12/enums/matching_function_context_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/matching_function_context_type.proto rename to google/ads/googleads/v12/enums/matching_function_context_type.proto index 53e0ffcd0..b7de67570 100644 --- a/google/ads/googleads/v9/enums/matching_function_context_type.proto +++ b/google/ads/googleads/v12/enums/matching_function_context_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MatchingFunctionContextTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing matching function context types. diff --git a/google/ads/googleads/v9/enums/matching_function_operator.proto b/google/ads/googleads/v12/enums/matching_function_operator.proto similarity index 82% rename from google/ads/googleads/v9/enums/matching_function_operator.proto rename to google/ads/googleads/v12/enums/matching_function_operator.proto index 476b2470a..30113e170 100644 --- a/google/ads/googleads/v9/enums/matching_function_operator.proto +++ b/google/ads/googleads/v12/enums/matching_function_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MatchingFunctionOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing matching function operators. diff --git a/google/ads/googleads/v9/enums/media_type.proto b/google/ads/googleads/v12/enums/media_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/media_type.proto rename to google/ads/googleads/v12/enums/media_type.proto index 0be1d4735..a7bbf91ef 100644 --- a/google/ads/googleads/v9/enums/media_type.proto +++ b/google/ads/googleads/v12/enums/media_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MediaTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing media types. diff --git a/google/ads/googleads/v9/enums/merchant_center_link_status.proto b/google/ads/googleads/v12/enums/merchant_center_link_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/merchant_center_link_status.proto rename to google/ads/googleads/v12/enums/merchant_center_link_status.proto index 0c3979de6..c4a6b51bd 100644 --- a/google/ads/googleads/v9/enums/merchant_center_link_status.proto +++ b/google/ads/googleads/v12/enums/merchant_center_link_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MerchantCenterLinkStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Merchant Center link statuses. diff --git a/google/ads/googleads/v9/enums/message_placeholder_field.proto b/google/ads/googleads/v12/enums/message_placeholder_field.proto similarity index 82% rename from google/ads/googleads/v9/enums/message_placeholder_field.proto rename to google/ads/googleads/v12/enums/message_placeholder_field.proto index 0e9a38a69..e62e62584 100644 --- a/google/ads/googleads/v9/enums/message_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/message_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MessagePlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Message placeholder fields. diff --git a/google/ads/googleads/v9/enums/mime_type.proto b/google/ads/googleads/v12/enums/mime_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/mime_type.proto rename to google/ads/googleads/v12/enums/mime_type.proto index f8c1d5497..400f01b9d 100644 --- a/google/ads/googleads/v9/enums/mime_type.proto +++ b/google/ads/googleads/v12/enums/mime_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MimeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing mime types. diff --git a/google/ads/googleads/v9/enums/minute_of_hour.proto b/google/ads/googleads/v12/enums/minute_of_hour.proto similarity index 74% rename from google/ads/googleads/v9/enums/minute_of_hour.proto rename to google/ads/googleads/v12/enums/minute_of_hour.proto index 7dc8f5df8..312ad40ae 100644 --- a/google/ads/googleads/v9/enums/minute_of_hour.proto +++ b/google/ads/googleads/v12/enums/minute_of_hour.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MinuteOfHourProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/mobile_app_vendor.proto b/google/ads/googleads/v12/enums/mobile_app_vendor.proto similarity index 76% rename from google/ads/googleads/v9/enums/mobile_app_vendor.proto rename to google/ads/googleads/v12/enums/mobile_app_vendor.proto index c3a805c26..738bbe761 100644 --- a/google/ads/googleads/v9/enums/mobile_app_vendor.proto +++ b/google/ads/googleads/v12/enums/mobile_app_vendor.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MobileAppVendorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing different types of mobile app vendors. message MobileAppVendorEnum { diff --git a/google/ads/googleads/v9/enums/mobile_device_type.proto b/google/ads/googleads/v12/enums/mobile_device_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/mobile_device_type.proto rename to google/ads/googleads/v12/enums/mobile_device_type.proto index ac91fc9c7..ac01a97bd 100644 --- a/google/ads/googleads/v9/enums/mobile_device_type.proto +++ b/google/ads/googleads/v12/enums/mobile_device_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MobileDeviceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing mobile device types. diff --git a/google/ads/googleads/v9/enums/month_of_year.proto b/google/ads/googleads/v12/enums/month_of_year.proto similarity index 73% rename from google/ads/googleads/v9/enums/month_of_year.proto rename to google/ads/googleads/v12/enums/month_of_year.proto index dbc85b3f4..cdb139c8e 100644 --- a/google/ads/googleads/v9/enums/month_of_year.proto +++ b/google/ads/googleads/v12/enums/month_of_year.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "MonthOfYearProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/negative_geo_target_type.proto b/google/ads/googleads/v12/enums/negative_geo_target_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/negative_geo_target_type.proto rename to google/ads/googleads/v12/enums/negative_geo_target_type.proto index 0f379553c..145e73584 100644 --- a/google/ads/googleads/v9/enums/negative_geo_target_type.proto +++ b/google/ads/googleads/v12/enums/negative_geo_target_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "NegativeGeoTargetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing negative geo target types. diff --git a/google/ads/googleads/v9/enums/offline_user_data_job_failure_reason.proto b/google/ads/googleads/v12/enums/offline_user_data_job_failure_reason.proto similarity index 61% rename from google/ads/googleads/v9/enums/offline_user_data_job_failure_reason.proto rename to google/ads/googleads/v12/enums/offline_user_data_job_failure_reason.proto index fe016df98..67467cf6a 100644 --- a/google/ads/googleads/v9/enums/offline_user_data_job_failure_reason.proto +++ b/google/ads/googleads/v12/enums/offline_user_data_job_failure_reason.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobFailureReasonProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing offline user data job failure reasons. @@ -45,6 +43,18 @@ 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. + 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. + 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. + NEWLY_OBSERVED_CURRENCY_CODE = 6; } diff --git a/google/ads/googleads/v9/enums/offline_user_data_job_match_rate_range.proto b/google/ads/googleads/v12/enums/offline_user_data_job_match_rate_range.proto similarity index 82% rename from google/ads/googleads/v9/enums/offline_user_data_job_match_rate_range.proto rename to google/ads/googleads/v12/enums/offline_user_data_job_match_rate_range.proto index 9218ee478..d43d6ab63 100644 --- a/google/ads/googleads/v9/enums/offline_user_data_job_match_rate_range.proto +++ b/google/ads/googleads/v12/enums/offline_user_data_job_match_rate_range.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobMatchRateRangeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing reasons match rate ranges for a customer match // list upload. @@ -62,7 +60,7 @@ 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/google/ads/googleads/v9/enums/offline_user_data_job_status.proto b/google/ads/googleads/v12/enums/offline_user_data_job_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/offline_user_data_job_status.proto rename to google/ads/googleads/v12/enums/offline_user_data_job_status.proto index 5e287a3a7..250e6ca7c 100644 --- a/google/ads/googleads/v9/enums/offline_user_data_job_status.proto +++ b/google/ads/googleads/v12/enums/offline_user_data_job_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing offline user data job status. diff --git a/google/ads/googleads/v9/enums/offline_user_data_job_type.proto b/google/ads/googleads/v12/enums/offline_user_data_job_type.proto similarity index 80% rename from google/ads/googleads/v9/enums/offline_user_data_job_type.proto rename to google/ads/googleads/v12/enums/offline_user_data_job_type.proto index 1de3c83db..a67eab334 100644 --- a/google/ads/googleads/v9/enums/offline_user_data_job_type.proto +++ b/google/ads/googleads/v12/enums/offline_user_data_job_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing offline user data job types. diff --git a/google/ads/googleads/v9/enums/operating_system_version_operator_type.proto b/google/ads/googleads/v12/enums/operating_system_version_operator_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/operating_system_version_operator_type.proto rename to google/ads/googleads/v12/enums/operating_system_version_operator_type.proto index fcd024b75..4b3701b48 100644 --- a/google/ads/googleads/v9/enums/operating_system_version_operator_type.proto +++ b/google/ads/googleads/v12/enums/operating_system_version_operator_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OperatingSystemVersionOperatorTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing operating system version operator types. diff --git a/google/ads/googleads/v9/enums/optimization_goal_type.proto b/google/ads/googleads/v12/enums/optimization_goal_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/optimization_goal_type.proto rename to google/ads/googleads/v12/enums/optimization_goal_type.proto index 48b5583c0..78b106aa5 100644 --- a/google/ads/googleads/v9/enums/optimization_goal_type.proto +++ b/google/ads/googleads/v12/enums/optimization_goal_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "OptimizationGoalTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing optimization goal type. diff --git a/google/ads/googleads/v9/enums/parental_status_type.proto b/google/ads/googleads/v12/enums/parental_status_type.proto similarity index 74% rename from google/ads/googleads/v9/enums/parental_status_type.proto rename to google/ads/googleads/v12/enums/parental_status_type.proto index 6785db0b4..a7e2a163b 100644 --- a/google/ads/googleads/v9/enums/parental_status_type.proto +++ b/google/ads/googleads/v12/enums/parental_status_type.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ParentalStatusTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/payment_mode.proto b/google/ads/googleads/v12/enums/payment_mode.proto similarity index 81% rename from google/ads/googleads/v9/enums/payment_mode.proto rename to google/ads/googleads/v12/enums/payment_mode.proto index 8961219a4..e35cc60d5 100644 --- a/google/ads/googleads/v9/enums/payment_mode.proto +++ b/google/ads/googleads/v12/enums/payment_mode.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PaymentModeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing payment modes. @@ -39,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 diff --git a/google/ads/googleads/v12/enums/performance_max_upgrade_status.proto b/google/ads/googleads/v12/enums/performance_max_upgrade_status.proto new file mode 100644 index 000000000..aff129d54 --- /dev/null +++ b/google/ads/googleads/v12/enums/performance_max_upgrade_status.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "PerformanceMaxUpgradeStatusProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/enums/placeholder_type.proto b/google/ads/googleads/v12/enums/placeholder_type.proto similarity index 89% rename from google/ads/googleads/v9/enums/placeholder_type.proto rename to google/ads/googleads/v12/enums/placeholder_type.proto index 725f11d18..b8d1694bc 100644 --- a/google/ads/googleads/v9/enums/placeholder_type.proto +++ b/google/ads/googleads/v12/enums/placeholder_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PlaceholderTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing feed placeholder types. @@ -82,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; diff --git a/google/ads/googleads/v9/enums/placement_type.proto b/google/ads/googleads/v12/enums/placement_type.proto similarity index 64% rename from google/ads/googleads/v9/enums/placement_type.proto rename to google/ads/googleads/v12/enums/placement_type.proto index 7ea18a868..d39c6e4e4 100644 --- a/google/ads/googleads/v9/enums/placement_type.proto +++ b/google/ads/googleads/v12/enums/placement_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PlacementTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing placement types. @@ -39,19 +37,19 @@ 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; } diff --git a/google/ads/googleads/v9/enums/policy_approval_status.proto b/google/ads/googleads/v12/enums/policy_approval_status.proto similarity index 82% rename from google/ads/googleads/v9/enums/policy_approval_status.proto rename to google/ads/googleads/v12/enums/policy_approval_status.proto index 9462df773..f3a1d610e 100644 --- a/google/ads/googleads/v9/enums/policy_approval_status.proto +++ b/google/ads/googleads/v12/enums/policy_approval_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyApprovalStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing policy approval statuses. diff --git a/google/ads/googleads/v9/enums/policy_review_status.proto b/google/ads/googleads/v12/enums/policy_review_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/policy_review_status.proto rename to google/ads/googleads/v12/enums/policy_review_status.proto index 5e34834be..cfbaede57 100644 --- a/google/ads/googleads/v9/enums/policy_review_status.proto +++ b/google/ads/googleads/v12/enums/policy_review_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyReviewStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing policy review statuses. diff --git a/google/ads/googleads/v9/enums/policy_topic_entry_type.proto b/google/ads/googleads/v12/enums/policy_topic_entry_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/policy_topic_entry_type.proto rename to google/ads/googleads/v12/enums/policy_topic_entry_type.proto index 69eef6938..ba523f8a9 100644 --- a/google/ads/googleads/v9/enums/policy_topic_entry_type.proto +++ b/google/ads/googleads/v12/enums/policy_topic_entry_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyTopicEntryTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing policy topic entry types. diff --git a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_mismatch_url_type.proto b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_mismatch_url_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/policy_topic_evidence_destination_mismatch_url_type.proto rename to google/ads/googleads/v12/enums/policy_topic_evidence_destination_mismatch_url_type.proto index bf1b391fc..2f53bdfeb 100644 --- a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_mismatch_url_type.proto +++ b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_mismatch_url_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyTopicEvidenceDestinationMismatchUrlTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing policy topic evidence destination mismatch url types. diff --git a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_device.proto b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_device.proto similarity index 80% rename from google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_device.proto rename to google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_device.proto index fc8a83931..288000182 100644 --- a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_device.proto +++ b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_device.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyTopicEvidenceDestinationNotWorkingDeviceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing device of destination not working policy topic // evidence. diff --git a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto rename to google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto index 600d0c308..5b036b551 100644 --- a/google/ads/googleads/v9/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto +++ b/google/ads/googleads/v12/enums/policy_topic_evidence_destination_not_working_dns_error_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing DNS error types of destination not working policy topic // evidence. diff --git a/google/ads/googleads/v9/enums/positive_geo_target_type.proto b/google/ads/googleads/v12/enums/positive_geo_target_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/positive_geo_target_type.proto rename to google/ads/googleads/v12/enums/positive_geo_target_type.proto index ca81822ed..1ad7911e1 100644 --- a/google/ads/googleads/v9/enums/positive_geo_target_type.proto +++ b/google/ads/googleads/v12/enums/positive_geo_target_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PositiveGeoTargetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing positive geo target types. diff --git a/google/ads/googleads/v9/enums/preferred_content_type.proto b/google/ads/googleads/v12/enums/preferred_content_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/preferred_content_type.proto rename to google/ads/googleads/v12/enums/preferred_content_type.proto index 49b5548ec..f156aadff 100644 --- a/google/ads/googleads/v9/enums/preferred_content_type.proto +++ b/google/ads/googleads/v12/enums/preferred_content_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PreferredContentTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing preferred content criterion type. diff --git a/google/ads/googleads/v9/enums/price_extension_price_qualifier.proto b/google/ads/googleads/v12/enums/price_extension_price_qualifier.proto similarity index 78% rename from google/ads/googleads/v9/enums/price_extension_price_qualifier.proto rename to google/ads/googleads/v12/enums/price_extension_price_qualifier.proto index 67f252460..97a9f60c6 100644 --- a/google/ads/googleads/v9/enums/price_extension_price_qualifier.proto +++ b/google/ads/googleads/v12/enums/price_extension_price_qualifier.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PriceExtensionPriceQualifierProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing price extension price qualifier type. diff --git a/google/ads/googleads/v9/enums/price_extension_price_unit.proto b/google/ads/googleads/v12/enums/price_extension_price_unit.proto similarity index 78% rename from google/ads/googleads/v9/enums/price_extension_price_unit.proto rename to google/ads/googleads/v12/enums/price_extension_price_unit.proto index d781a573b..c52e15d10 100644 --- a/google/ads/googleads/v9/enums/price_extension_price_unit.proto +++ b/google/ads/googleads/v12/enums/price_extension_price_unit.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PriceExtensionPriceUnitProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing price extension price unit. diff --git a/google/ads/googleads/v9/enums/price_extension_type.proto b/google/ads/googleads/v12/enums/price_extension_type.proto similarity index 83% rename from google/ads/googleads/v9/enums/price_extension_type.proto rename to google/ads/googleads/v12/enums/price_extension_type.proto index 4b79d88d2..efef9f0f3 100644 --- a/google/ads/googleads/v9/enums/price_extension_type.proto +++ b/google/ads/googleads/v12/enums/price_extension_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PriceExtensionTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing price extension type. diff --git a/google/ads/googleads/v9/enums/price_placeholder_field.proto b/google/ads/googleads/v12/enums/price_placeholder_field.proto similarity index 87% rename from google/ads/googleads/v9/enums/price_placeholder_field.proto rename to google/ads/googleads/v12/enums/price_placeholder_field.proto index 7dc0497b8..7138dec1b 100644 --- a/google/ads/googleads/v9/enums/price_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/price_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PricePlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Price placeholder fields. @@ -66,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 @@ -88,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 @@ -110,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 @@ -132,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 @@ -154,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 @@ -176,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 @@ -198,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 @@ -220,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 diff --git a/google/ads/googleads/v9/enums/product_bidding_category_level.proto b/google/ads/googleads/v12/enums/product_bidding_category_level.proto similarity index 77% rename from google/ads/googleads/v9/enums/product_bidding_category_level.proto rename to google/ads/googleads/v12/enums/product_bidding_category_level.proto index 7c0ac5e0f..6752fea77 100644 --- a/google/ads/googleads/v9/enums/product_bidding_category_level.proto +++ b/google/ads/googleads/v12/enums/product_bidding_category_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductBiddingCategoryLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Level of a product bidding category. message ProductBiddingCategoryLevelEnum { diff --git a/google/ads/googleads/v9/enums/product_bidding_category_status.proto b/google/ads/googleads/v12/enums/product_bidding_category_status.proto similarity index 78% rename from google/ads/googleads/v9/enums/product_bidding_category_status.proto rename to google/ads/googleads/v12/enums/product_bidding_category_status.proto index 244de109e..93b682fd0 100644 --- a/google/ads/googleads/v9/enums/product_bidding_category_status.proto +++ b/google/ads/googleads/v12/enums/product_bidding_category_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductBiddingCategoryStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. diff --git a/google/ads/googleads/v9/enums/product_channel.proto b/google/ads/googleads/v12/enums/product_channel.proto similarity index 76% rename from google/ads/googleads/v9/enums/product_channel.proto rename to google/ads/googleads/v12/enums/product_channel.proto index d6a03fcec..daefabc8d 100644 --- a/google/ads/googleads/v9/enums/product_channel.proto +++ b/google/ads/googleads/v12/enums/product_channel.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductChannelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. diff --git a/google/ads/googleads/v9/enums/product_channel_exclusivity.proto b/google/ads/googleads/v12/enums/product_channel_exclusivity.proto similarity index 79% rename from google/ads/googleads/v9/enums/product_channel_exclusivity.proto rename to google/ads/googleads/v12/enums/product_channel_exclusivity.proto index 4c463f3e3..47efcbf34 100644 --- a/google/ads/googleads/v9/enums/product_channel_exclusivity.proto +++ b/google/ads/googleads/v12/enums/product_channel_exclusivity.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductChannelExclusivityProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. diff --git a/google/ads/googleads/v9/enums/product_condition.proto b/google/ads/googleads/v12/enums/product_condition.proto similarity index 77% rename from google/ads/googleads/v9/enums/product_condition.proto rename to google/ads/googleads/v12/enums/product_condition.proto index 2897f0dcd..e6fad5153 100644 --- a/google/ads/googleads/v9/enums/product_condition.proto +++ b/google/ads/googleads/v12/enums/product_condition.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductConditionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. diff --git a/google/ads/googleads/v9/enums/product_custom_attribute_index.proto b/google/ads/googleads/v12/enums/product_custom_attribute_index.proto similarity index 79% rename from google/ads/googleads/v9/enums/product_custom_attribute_index.proto rename to google/ads/googleads/v12/enums/product_custom_attribute_index.proto index 4ca7973a7..3032c62b4 100644 --- a/google/ads/googleads/v9/enums/product_custom_attribute_index.proto +++ b/google/ads/googleads/v12/enums/product_custom_attribute_index.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductCustomAttributeIndexProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing product custom attributes. diff --git a/google/ads/googleads/v9/enums/product_type_level.proto b/google/ads/googleads/v12/enums/product_type_level.proto similarity index 77% rename from google/ads/googleads/v9/enums/product_type_level.proto rename to google/ads/googleads/v12/enums/product_type_level.proto index eb34ee8d2..ee1e21b04 100644 --- a/google/ads/googleads/v9/enums/product_type_level.proto +++ b/google/ads/googleads/v12/enums/product_type_level.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProductTypeLevelProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing bidding schemes. diff --git a/google/ads/googleads/v9/enums/promotion_extension_discount_modifier.proto b/google/ads/googleads/v12/enums/promotion_extension_discount_modifier.proto similarity index 77% rename from google/ads/googleads/v9/enums/promotion_extension_discount_modifier.proto rename to google/ads/googleads/v12/enums/promotion_extension_discount_modifier.proto index 57633d358..c62382689 100644 --- a/google/ads/googleads/v9/enums/promotion_extension_discount_modifier.proto +++ b/google/ads/googleads/v12/enums/promotion_extension_discount_modifier.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PromotionExtensionDiscountModifierProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing promotion extension discount modifier. diff --git a/google/ads/googleads/v9/enums/promotion_extension_occasion.proto b/google/ads/googleads/v12/enums/promotion_extension_occasion.proto similarity index 86% rename from google/ads/googleads/v9/enums/promotion_extension_occasion.proto rename to google/ads/googleads/v12/enums/promotion_extension_occasion.proto index b5d578f21..9c66e1c62 100644 --- a/google/ads/googleads/v9/enums/promotion_extension_occasion.proto +++ b/google/ads/googleads/v12/enums/promotion_extension_occasion.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. @@ -14,23 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PromotionExtensionOccasionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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. diff --git a/google/ads/googleads/v9/enums/promotion_placeholder_field.proto b/google/ads/googleads/v12/enums/promotion_placeholder_field.proto similarity index 85% rename from google/ads/googleads/v9/enums/promotion_placeholder_field.proto rename to google/ads/googleads/v12/enums/promotion_placeholder_field.proto index a68ddec0e..feb42ef4e 100644 --- a/google/ads/googleads/v9/enums/promotion_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/promotion_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "PromotionPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Promotion placeholder fields. @@ -43,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; diff --git a/google/ads/googleads/v9/enums/proximity_radius_units.proto b/google/ads/googleads/v12/enums/proximity_radius_units.proto similarity index 73% rename from google/ads/googleads/v9/enums/proximity_radius_units.proto rename to google/ads/googleads/v12/enums/proximity_radius_units.proto index 50a11901b..1b655f712 100644 --- a/google/ads/googleads/v9/enums/proximity_radius_units.proto +++ b/google/ads/googleads/v12/enums/proximity_radius_units.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ProximityRadiusUnitsProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; diff --git a/google/ads/googleads/v9/enums/quality_score_bucket.proto b/google/ads/googleads/v12/enums/quality_score_bucket.proto similarity index 78% rename from google/ads/googleads/v9/enums/quality_score_bucket.proto rename to google/ads/googleads/v12/enums/quality_score_bucket.proto index 583e0b188..11298780b 100644 --- a/google/ads/googleads/v9/enums/quality_score_bucket.proto +++ b/google/ads/googleads/v12/enums/quality_score_bucket.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "QualityScoreBucketProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing quality score buckets. diff --git a/google/ads/googleads/v9/enums/reach_plan_age_range.proto b/google/ads/googleads/v12/enums/reach_plan_age_range.proto similarity index 88% rename from google/ads/googleads/v9/enums/reach_plan_age_range.proto rename to google/ads/googleads/v12/enums/reach_plan_age_range.proto index 20bc5a36a..6728854c4 100644 --- a/google/ads/googleads/v9/enums/reach_plan_age_range.proto +++ b/google/ads/googleads/v12/enums/reach_plan_age_range.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ReachPlanAgeRangeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing a plannable age range. diff --git a/google/ads/googleads/v9/enums/reach_plan_network.proto b/google/ads/googleads/v12/enums/reach_plan_network.proto similarity index 78% rename from google/ads/googleads/v9/enums/reach_plan_network.proto rename to google/ads/googleads/v12/enums/reach_plan_network.proto index 1b6f2f6bd..ded3c240c 100644 --- a/google/ads/googleads/v9/enums/reach_plan_network.proto +++ b/google/ads/googleads/v12/enums/reach_plan_network.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ReachPlanNetworkProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing a plannable network. diff --git a/google/ads/googleads/v9/enums/real_estate_placeholder_field.proto b/google/ads/googleads/v12/enums/real_estate_placeholder_field.proto similarity index 87% rename from google/ads/googleads/v9/enums/real_estate_placeholder_field.proto rename to google/ads/googleads/v12/enums/real_estate_placeholder_field.proto index d07d4a3bc..824ed18d6 100644 --- a/google/ads/googleads/v9/enums/real_estate_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/real_estate_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "RealEstatePlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Real Estate placeholder fields. @@ -80,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 diff --git a/google/ads/googleads/v9/enums/recommendation_type.proto b/google/ads/googleads/v12/enums/recommendation_type.proto similarity index 67% rename from google/ads/googleads/v9/enums/recommendation_type.proto rename to google/ads/googleads/v12/enums/recommendation_type.proto index a20f17f36..ad660b530 100644 --- a/google/ads/googleads/v9/enums/recommendation_type.proto +++ b/google/ads/googleads/v12/enums/recommendation_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "RecommendationTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Recommendation types. @@ -106,6 +104,38 @@ message RecommendationTypeEnum { // Budget recommendation for campaigns whose ROI is predicted to increase // with a budget adjustment. MARGINAL_ROI_CAMPAIGN_BUDGET = 19; + + // Recommendation to expand keywords to broad match for fully automated + // conversion-based bidding campaigns. + USE_BROAD_MATCH_KEYWORD = 20; + + // 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; } diff --git a/google/ads/googleads/v9/enums/resource_change_operation.proto b/google/ads/googleads/v12/enums/resource_change_operation.proto similarity index 79% rename from google/ads/googleads/v9/enums/resource_change_operation.proto rename to google/ads/googleads/v12/enums/resource_change_operation.proto index ea23eb0a7..a87c887df 100644 --- a/google/ads/googleads/v9/enums/resource_change_operation.proto +++ b/google/ads/googleads/v12/enums/resource_change_operation.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ResourceChangeOperationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the resource change operations in change event. diff --git a/google/ads/googleads/v9/enums/resource_limit_type.proto b/google/ads/googleads/v12/enums/resource_limit_type.proto similarity index 83% rename from google/ads/googleads/v9/enums/resource_limit_type.proto rename to google/ads/googleads/v12/enums/resource_limit_type.proto index e24d35d08..13ae4f2d7 100644 --- a/google/ads/googleads/v9/enums/resource_limit_type.proto +++ b/google/ads/googleads/v12/enums/resource_limit_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ResourceLimitTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing possible resource limit types. message ResourceLimitTypeEnum { @@ -142,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. @@ -188,6 +186,9 @@ message ResourceLimitTypeEnum { // Number of open logical user lists per customer. LOGICAL_USER_LISTS_PER_CUSTOMER = 48; + // Number of open rule based user lists per customer. + RULE_BASED_USER_LISTS_PER_CUSTOMER = 153; + // Number of ENABLED and PAUSED ad group ads across all base campaigns for a // customer. BASE_AD_GROUP_ADS_PER_CUSTOMER = 53; @@ -299,6 +300,67 @@ 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; + + // Number of ENABLED dynamic education feed asset sets per customer. + DYNAMIC_EDUCATION_FEED_ASSET_SETS_PER_CUSTOMER = 158; + + // Number of ENABLED assets per page feed asset set. + ASSETS_PER_PAGE_FEED_ASSET_SET = 159; + + // Number of ENABLED assets per dynamic education asset set. + ASSETS_PER_DYNAMIC_EDUCATION_FEED_ASSET_SET = 160; + + // Number of ENABLED dynamic real estate asset sets per customer. + DYNAMIC_REAL_ESTATE_ASSET_SETS_PER_CUSTOMER = 161; + + // Number of ENABLED assets per dynamic real estate asset set. + ASSETS_PER_DYNAMIC_REAL_ESTATE_ASSET_SET = 162; + + // Number of ENABLED dynamic custom asset sets per customer. + DYNAMIC_CUSTOM_ASSET_SETS_PER_CUSTOMER = 163; + + // Number of ENABLED assets per dynamic custom asset set. + ASSETS_PER_DYNAMIC_CUSTOM_ASSET_SET = 164; + + // Number of ENABLED dynamic hotels and rentals asset sets per + // customer. + DYNAMIC_HOTELS_AND_RENTALS_ASSET_SETS_PER_CUSTOMER = 165; + + // Number of ENABLED assets per dynamic hotels and rentals asset set. + ASSETS_PER_DYNAMIC_HOTELS_AND_RENTALS_ASSET_SET = 166; + + // Number of ENABLED dynamic local asset sets per customer. + DYNAMIC_LOCAL_ASSET_SETS_PER_CUSTOMER = 167; + + // Number of ENABLED assets per dynamic local asset set. + ASSETS_PER_DYNAMIC_LOCAL_ASSET_SET = 168; + + // Number of ENABLED dynamic flights asset sets per customer. + DYNAMIC_FLIGHTS_ASSET_SETS_PER_CUSTOMER = 169; + + // Number of ENABLED assets per dynamic flights asset set. + ASSETS_PER_DYNAMIC_FLIGHTS_ASSET_SET = 170; + + // Number of ENABLED dynamic travel asset sets per customer. + DYNAMIC_TRAVEL_ASSET_SETS_PER_CUSTOMER = 171; + + // Number of ENABLED assets per dynamic travel asset set. + ASSETS_PER_DYNAMIC_TRAVEL_ASSET_SET = 172; + + // Number of ENABLED dynamic jobs asset sets per customer. + DYNAMIC_JOBS_ASSET_SETS_PER_CUSTOMER = 173; + + // Number of ENABLED assets per dynamic jobs asset set. + ASSETS_PER_DYNAMIC_JOBS_ASSET_SET = 174; + // Number of versions per ad. VERSIONS_PER_AD = 82; @@ -371,8 +433,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. diff --git a/google/ads/googleads/v9/enums/response_content_type.proto b/google/ads/googleads/v12/enums/response_content_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/response_content_type.proto rename to google/ads/googleads/v12/enums/response_content_type.proto index dc36f4fcd..497373b0b 100644 --- a/google/ads/googleads/v9/enums/response_content_type.proto +++ b/google/ads/googleads/v12/enums/response_content_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ResponseContentTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the response content types used in mutate operations. diff --git a/google/ads/googleads/v9/enums/search_engine_results_page_type.proto b/google/ads/googleads/v12/enums/search_engine_results_page_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/search_engine_results_page_type.proto rename to google/ads/googleads/v12/enums/search_engine_results_page_type.proto index 15c0ad353..74ca42e8d 100644 --- a/google/ads/googleads/v9/enums/search_engine_results_page_type.proto +++ b/google/ads/googleads/v12/enums/search_engine_results_page_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SearchEngineResultsPageTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing search engine results page types. diff --git a/google/ads/googleads/v9/enums/search_term_match_type.proto b/google/ads/googleads/v12/enums/search_term_match_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/search_term_match_type.proto rename to google/ads/googleads/v12/enums/search_term_match_type.proto index 7a75805a3..33b34725a 100644 --- a/google/ads/googleads/v9/enums/search_term_match_type.proto +++ b/google/ads/googleads/v12/enums/search_term_match_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SearchTermMatchTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing search term match types. diff --git a/google/ads/googleads/v9/enums/search_term_targeting_status.proto b/google/ads/googleads/v12/enums/search_term_targeting_status.proto similarity index 80% rename from google/ads/googleads/v9/enums/search_term_targeting_status.proto rename to google/ads/googleads/v12/enums/search_term_targeting_status.proto index 8eb53613d..2048a78da 100644 --- a/google/ads/googleads/v9/enums/search_term_targeting_status.proto +++ b/google/ads/googleads/v12/enums/search_term_targeting_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SearchTermTargetingStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing search term targeting statuses. diff --git a/google/ads/googleads/v9/enums/seasonality_event_scope.proto b/google/ads/googleads/v12/enums/seasonality_event_scope.proto similarity index 78% rename from google/ads/googleads/v9/enums/seasonality_event_scope.proto rename to google/ads/googleads/v12/enums/seasonality_event_scope.proto index 58eeb10d7..0a04c03ed 100644 --- a/google/ads/googleads/v9/enums/seasonality_event_scope.proto +++ b/google/ads/googleads/v12/enums/seasonality_event_scope.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SeasonalityEventScopeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing seasonality event status. @@ -42,7 +40,7 @@ message SeasonalityEventScopeEnum { // This is a response-only value. UNKNOWN = 1; - // The seasonality event is applied to all the customer’s traffic for + // The seasonality event is applied to all the customer's traffic for // supported advertising channel types and device types. The CUSTOMER scope // cannot be used in mutates. CUSTOMER = 2; diff --git a/google/ads/googleads/v9/enums/seasonality_event_status.proto b/google/ads/googleads/v12/enums/seasonality_event_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/seasonality_event_status.proto rename to google/ads/googleads/v12/enums/seasonality_event_status.proto index 0ea6d26ca..43000af1f 100644 --- a/google/ads/googleads/v9/enums/seasonality_event_status.proto +++ b/google/ads/googleads/v12/enums/seasonality_event_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SeasonalityEventStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing seasonality event status. diff --git a/google/ads/googleads/v9/enums/served_asset_field_type.proto b/google/ads/googleads/v12/enums/served_asset_field_type.proto similarity index 80% rename from google/ads/googleads/v9/enums/served_asset_field_type.proto rename to google/ads/googleads/v12/enums/served_asset_field_type.proto index c0f355e8e..6e2fa6646 100644 --- a/google/ads/googleads/v9/enums/served_asset_field_type.proto +++ b/google/ads/googleads/v12/enums/served_asset_field_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ServedAssetFieldTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing policy review statuses. diff --git a/google/ads/googleads/v9/enums/shared_set_status.proto b/google/ads/googleads/v12/enums/shared_set_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/shared_set_status.proto rename to google/ads/googleads/v12/enums/shared_set_status.proto index 9d45810d5..673de2a30 100644 --- a/google/ads/googleads/v9/enums/shared_set_status.proto +++ b/google/ads/googleads/v12/enums/shared_set_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SharedSetStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing shared set statuses. diff --git a/google/ads/googleads/v9/enums/shared_set_type.proto b/google/ads/googleads/v12/enums/shared_set_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/shared_set_type.proto rename to google/ads/googleads/v12/enums/shared_set_type.proto index a4ebe603d..c5536f953 100644 --- a/google/ads/googleads/v9/enums/shared_set_type.proto +++ b/google/ads/googleads/v12/enums/shared_set_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SharedSetTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing shared set types. diff --git a/google/ads/googleads/v9/enums/simulation_modification_method.proto b/google/ads/googleads/v12/enums/simulation_modification_method.proto similarity index 83% rename from google/ads/googleads/v9/enums/simulation_modification_method.proto rename to google/ads/googleads/v12/enums/simulation_modification_method.proto index fd92eb2ce..70f3c915a 100644 --- a/google/ads/googleads/v9/enums/simulation_modification_method.proto +++ b/google/ads/googleads/v12/enums/simulation_modification_method.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SimulationModificationMethodProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing simulation modification methods. diff --git a/google/ads/googleads/v9/enums/simulation_type.proto b/google/ads/googleads/v12/enums/simulation_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/simulation_type.proto rename to google/ads/googleads/v12/enums/simulation_type.proto index 7bb2a612e..9d782266c 100644 --- a/google/ads/googleads/v9/enums/simulation_type.proto +++ b/google/ads/googleads/v12/enums/simulation_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SimulationTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing simulation types. diff --git a/google/ads/googleads/v9/enums/sitelink_placeholder_field.proto b/google/ads/googleads/v12/enums/sitelink_placeholder_field.proto similarity index 83% rename from google/ads/googleads/v9/enums/sitelink_placeholder_field.proto rename to google/ads/googleads/v12/enums/sitelink_placeholder_field.proto index b8cb46fcf..90d2827cd 100644 --- a/google/ads/googleads/v9/enums/sitelink_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/sitelink_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SitelinkPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Sitelink placeholder fields. diff --git a/google/ads/googleads/v12/enums/sk_ad_network_ad_event_type.proto b/google/ads/googleads/v12/enums/sk_ad_network_ad_event_type.proto new file mode 100644 index 000000000..668f4984a --- /dev/null +++ b/google/ads/googleads/v12/enums/sk_ad_network_ad_event_type.proto @@ -0,0 +1,52 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SkAdNetworkAdEventTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing SkAdNetwork Ad Event Types. + +// Container for enumeration of SkAdNetwork ad event types. +message SkAdNetworkAdEventTypeEnum { + // Enumerates SkAdNetwork ad event types + enum SkAdNetworkAdEventType { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // The value was not present in the postback or we do not have this data for + // other reasons. + UNAVAILABLE = 2; + + // The user interacted with the ad. + INTERACTION = 3; + + // The user viewed the ad. + VIEW = 4; + } + + +} diff --git a/google/ads/googleads/v12/enums/sk_ad_network_attribution_credit.proto b/google/ads/googleads/v12/enums/sk_ad_network_attribution_credit.proto new file mode 100644 index 000000000..076418fc5 --- /dev/null +++ b/google/ads/googleads/v12/enums/sk_ad_network_attribution_credit.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SkAdNetworkAttributionCreditProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing SkAdNetwork attribution credits. + +// Container for enumeration of SkAdNetwork attribution credits. +message SkAdNetworkAttributionCreditEnum { + // Enumerates SkAdNetwork attribution credits. + enum SkAdNetworkAttributionCredit { + // Default value. This value is equivalent to null. + UNSPECIFIED = 0; + + // The value is unknown in this API version. The true enum value cannot be + // returned in this API version or is not supported yet. + UNKNOWN = 1; + + // The value was not present in the postback or we do not have this data for + // other reasons. + UNAVAILABLE = 2; + + // Google was the ad network that won ad attribution. + WON = 3; + + // Google qualified for attribution, but didn't win. + CONTRIBUTED = 4; + } + + +} diff --git a/google/ads/googleads/v12/enums/sk_ad_network_user_type.proto b/google/ads/googleads/v12/enums/sk_ad_network_user_type.proto new file mode 100644 index 000000000..525abe6e9 --- /dev/null +++ b/google/ads/googleads/v12/enums/sk_ad_network_user_type.proto @@ -0,0 +1,52 @@ +// 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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SkAdNetworkUserTypeProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Proto file describing SkAdNetwork user types. + +// Container for enumeration of SkAdNetwork user types. +message SkAdNetworkUserTypeEnum { + // Enumerates SkAdNetwork user types + enum SkAdNetworkUserType { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // The value was not present in the postback or we do not have this data for + // other reasons. + UNAVAILABLE = 2; + + // The user installed the app for the first time. + NEW_INSTALLER = 3; + + // The user has previously installed the app. + REINSTALLER = 4; + } + + +} diff --git a/google/ads/googleads/v9/enums/slot.proto b/google/ads/googleads/v12/enums/slot.proto similarity index 79% rename from google/ads/googleads/v9/enums/slot.proto rename to google/ads/googleads/v12/enums/slot.proto index f3200ea6f..8684aedd6 100644 --- a/google/ads/googleads/v9/enums/slot.proto +++ b/google/ads/googleads/v12/enums/slot.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SlotProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing slots. diff --git a/google/ads/googleads/v9/enums/spending_limit_type.proto b/google/ads/googleads/v12/enums/spending_limit_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/spending_limit_type.proto rename to google/ads/googleads/v12/enums/spending_limit_type.proto index adfae6384..8c7582ce9 100644 --- a/google/ads/googleads/v9/enums/spending_limit_type.proto +++ b/google/ads/googleads/v12/enums/spending_limit_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SpendingLimitTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing SpendingLimit types. diff --git a/google/ads/googleads/v9/enums/structured_snippet_placeholder_field.proto b/google/ads/googleads/v12/enums/structured_snippet_placeholder_field.proto similarity index 82% rename from google/ads/googleads/v9/enums/structured_snippet_placeholder_field.proto rename to google/ads/googleads/v12/enums/structured_snippet_placeholder_field.proto index 3528b84d9..201fd6526 100644 --- a/google/ads/googleads/v9/enums/structured_snippet_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/structured_snippet_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "StructuredSnippetPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Structured Snippet placeholder fields. diff --git a/google/ads/googleads/v9/enums/summary_row_setting.proto b/google/ads/googleads/v12/enums/summary_row_setting.proto similarity index 79% rename from google/ads/googleads/v9/enums/summary_row_setting.proto rename to google/ads/googleads/v12/enums/summary_row_setting.proto index 6440da263..4a9d6a1d5 100644 --- a/google/ads/googleads/v9/enums/summary_row_setting.proto +++ b/google/ads/googleads/v12/enums/summary_row_setting.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SummaryRowSettingProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing summary row setting. diff --git a/google/ads/googleads/v9/enums/system_managed_entity_source.proto b/google/ads/googleads/v12/enums/system_managed_entity_source.proto similarity index 77% rename from google/ads/googleads/v9/enums/system_managed_entity_source.proto rename to google/ads/googleads/v12/enums/system_managed_entity_source.proto index 623163fcf..fadb659c2 100644 --- a/google/ads/googleads/v9/enums/system_managed_entity_source.proto +++ b/google/ads/googleads/v12/enums/system_managed_entity_source.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "SystemManagedEntitySourceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing system managed entity sources. diff --git a/google/ads/googleads/v9/enums/target_cpa_opt_in_recommendation_goal.proto b/google/ads/googleads/v12/enums/target_cpa_opt_in_recommendation_goal.proto similarity index 81% rename from google/ads/googleads/v9/enums/target_cpa_opt_in_recommendation_goal.proto rename to google/ads/googleads/v12/enums/target_cpa_opt_in_recommendation_goal.proto index 9b4c4e1e4..d6cafc478 100644 --- a/google/ads/googleads/v9/enums/target_cpa_opt_in_recommendation_goal.proto +++ b/google/ads/googleads/v12/enums/target_cpa_opt_in_recommendation_goal.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TargetCpaOptInRecommendationGoalProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing TargetCpaOptIn recommendation goals. diff --git a/google/ads/googleads/v9/enums/target_impression_share_location.proto b/google/ads/googleads/v12/enums/target_impression_share_location.proto similarity index 79% rename from google/ads/googleads/v9/enums/target_impression_share_location.proto rename to google/ads/googleads/v12/enums/target_impression_share_location.proto index 8ffcf90b3..63229a79d 100644 --- a/google/ads/googleads/v9/enums/target_impression_share_location.proto +++ b/google/ads/googleads/v12/enums/target_impression_share_location.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TargetImpressionShareLocationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing target impression share goal. diff --git a/google/ads/googleads/v9/enums/targeting_dimension.proto b/google/ads/googleads/v12/enums/targeting_dimension.proto similarity index 73% rename from google/ads/googleads/v9/enums/targeting_dimension.proto rename to google/ads/googleads/v12/enums/targeting_dimension.proto index 25fe5be3f..06eb19d85 100644 --- a/google/ads/googleads/v9/enums/targeting_dimension.proto +++ b/google/ads/googleads/v12/enums/targeting_dimension.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TargetingDimensionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing criteria types. @@ -39,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; diff --git a/google/ads/googleads/v9/enums/time_type.proto b/google/ads/googleads/v12/enums/time_type.proto similarity index 76% rename from google/ads/googleads/v9/enums/time_type.proto rename to google/ads/googleads/v12/enums/time_type.proto index 9eab9def0..431bd8d4b 100644 --- a/google/ads/googleads/v9/enums/time_type.proto +++ b/google/ads/googleads/v12/enums/time_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TimeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing TimeType types. diff --git a/google/ads/googleads/v9/enums/tracking_code_page_format.proto b/google/ads/googleads/v12/enums/tracking_code_page_format.proto similarity index 77% rename from google/ads/googleads/v9/enums/tracking_code_page_format.proto rename to google/ads/googleads/v12/enums/tracking_code_page_format.proto index 1eaab4f83..ef86001bd 100644 --- a/google/ads/googleads/v9/enums/tracking_code_page_format.proto +++ b/google/ads/googleads/v12/enums/tracking_code_page_format.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TrackingCodePageFormatProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing the format of the web page where the tracking // tag and snippet will be installed. diff --git a/google/ads/googleads/v9/enums/tracking_code_type.proto b/google/ads/googleads/v12/enums/tracking_code_type.proto similarity index 82% rename from google/ads/googleads/v9/enums/tracking_code_type.proto rename to google/ads/googleads/v12/enums/tracking_code_type.proto index d77c175d4..105a32508 100644 --- a/google/ads/googleads/v9/enums/tracking_code_type.proto +++ b/google/ads/googleads/v12/enums/tracking_code_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TrackingCodeTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Container for enum describing the type of the generated tag snippets for // tracking conversions. diff --git a/google/ads/googleads/v9/enums/travel_placeholder_field.proto b/google/ads/googleads/v12/enums/travel_placeholder_field.proto similarity index 88% rename from google/ads/googleads/v9/enums/travel_placeholder_field.proto rename to google/ads/googleads/v12/enums/travel_placeholder_field.proto index 241d9bc03..6dc11e182 100644 --- a/google/ads/googleads/v9/enums/travel_placeholder_field.proto +++ b/google/ads/googleads/v12/enums/travel_placeholder_field.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "TravelPlaceholderFieldProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing Travel placeholder fields. @@ -93,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 diff --git a/google/ads/googleads/v9/enums/user_identifier_source.proto b/google/ads/googleads/v12/enums/user_identifier_source.proto similarity index 80% rename from google/ads/googleads/v9/enums/user_identifier_source.proto rename to google/ads/googleads/v12/enums/user_identifier_source.proto index 8f0fb29d7..4314774e4 100644 --- a/google/ads/googleads/v9/enums/user_identifier_source.proto +++ b/google/ads/googleads/v12/enums/user_identifier_source.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserIdentifierSourceProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user identifier source diff --git a/google/ads/googleads/v9/enums/user_interest_taxonomy_type.proto b/google/ads/googleads/v12/enums/user_interest_taxonomy_type.proto similarity index 80% rename from google/ads/googleads/v9/enums/user_interest_taxonomy_type.proto rename to google/ads/googleads/v12/enums/user_interest_taxonomy_type.proto index b8a5ab519..b07fe98c6 100644 --- a/google/ads/googleads/v9/enums/user_interest_taxonomy_type.proto +++ b/google/ads/googleads/v12/enums/user_interest_taxonomy_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserInterestTaxonomyTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing the UserInterest taxonomy type diff --git a/google/ads/googleads/v9/enums/user_list_access_status.proto b/google/ads/googleads/v12/enums/user_list_access_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/user_list_access_status.proto rename to google/ads/googleads/v12/enums/user_list_access_status.proto index 5439a3c4b..ac2a8d9da 100644 --- a/google/ads/googleads/v9/enums/user_list_access_status.proto +++ b/google/ads/googleads/v12/enums/user_list_access_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListAccessStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user list access status. diff --git a/google/ads/googleads/v9/enums/user_list_closing_reason.proto b/google/ads/googleads/v12/enums/user_list_closing_reason.proto similarity index 77% rename from google/ads/googleads/v9/enums/user_list_closing_reason.proto rename to google/ads/googleads/v12/enums/user_list_closing_reason.proto index 7c3e81b6f..3c2b0c562 100644 --- a/google/ads/googleads/v9/enums/user_list_closing_reason.proto +++ b/google/ads/googleads/v12/enums/user_list_closing_reason.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListClosingReasonProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user list closing reason. diff --git a/google/ads/googleads/v9/enums/user_list_combined_rule_operator.proto b/google/ads/googleads/v12/enums/user_list_combined_rule_operator.proto similarity index 76% rename from google/ads/googleads/v9/enums/user_list_combined_rule_operator.proto rename to google/ads/googleads/v12/enums/user_list_combined_rule_operator.proto index 92d1abb85..357fae0b5 100644 --- a/google/ads/googleads/v9/enums/user_list_combined_rule_operator.proto +++ b/google/ads/googleads/v12/enums/user_list_combined_rule_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListCombinedRuleOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Logical operator connecting two rules. message UserListCombinedRuleOperatorEnum { diff --git a/google/ads/googleads/v9/enums/user_list_crm_data_source_type.proto b/google/ads/googleads/v12/enums/user_list_crm_data_source_type.proto similarity index 78% rename from google/ads/googleads/v9/enums/user_list_crm_data_source_type.proto rename to google/ads/googleads/v12/enums/user_list_crm_data_source_type.proto index 11c016b11..6eaa454b5 100644 --- a/google/ads/googleads/v9/enums/user_list_crm_data_source_type.proto +++ b/google/ads/googleads/v12/enums/user_list_crm_data_source_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListCrmDataSourceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Indicates source of Crm upload data. message UserListCrmDataSourceTypeEnum { diff --git a/google/ads/googleads/v9/enums/user_list_date_rule_item_operator.proto b/google/ads/googleads/v12/enums/user_list_date_rule_item_operator.proto similarity index 77% rename from google/ads/googleads/v9/enums/user_list_date_rule_item_operator.proto rename to google/ads/googleads/v12/enums/user_list_date_rule_item_operator.proto index 85cf9a7a0..9ff678196 100644 --- a/google/ads/googleads/v9/enums/user_list_date_rule_item_operator.proto +++ b/google/ads/googleads/v12/enums/user_list_date_rule_item_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListDateRuleItemOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Supported rule operator for date type. message UserListDateRuleItemOperatorEnum { diff --git a/google/ads/googleads/v12/enums/user_list_flexible_rule_operator.proto b/google/ads/googleads/v12/enums/user_list_flexible_rule_operator.proto new file mode 100644 index 000000000..4af0eda13 --- /dev/null +++ b/google/ads/googleads/v12/enums/user_list_flexible_rule_operator.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.v12.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "UserListFlexibleRuleOperatorProto"; +option java_package = "com.google.ads.googleads.v12.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; + +// Logical operator connecting two rules. +message UserListFlexibleRuleOperatorEnum { + // Enum describing possible user list combined rule operators. + enum UserListFlexibleRuleOperator { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // A AND B. + AND = 2; + + // A OR B. + OR = 3; + } + + +} diff --git a/google/ads/googleads/v9/enums/user_list_logical_rule_operator.proto b/google/ads/googleads/v12/enums/user_list_logical_rule_operator.proto similarity index 77% rename from google/ads/googleads/v9/enums/user_list_logical_rule_operator.proto rename to google/ads/googleads/v12/enums/user_list_logical_rule_operator.proto index facb5a5af..195c35003 100644 --- a/google/ads/googleads/v9/enums/user_list_logical_rule_operator.proto +++ b/google/ads/googleads/v12/enums/user_list_logical_rule_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListLogicalRuleOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // The logical operator of the rule. message UserListLogicalRuleOperatorEnum { diff --git a/google/ads/googleads/v9/enums/user_list_membership_status.proto b/google/ads/googleads/v12/enums/user_list_membership_status.proto similarity index 79% rename from google/ads/googleads/v9/enums/user_list_membership_status.proto rename to google/ads/googleads/v12/enums/user_list_membership_status.proto index 5a6c0a270..88753b5a2 100644 --- a/google/ads/googleads/v9/enums/user_list_membership_status.proto +++ b/google/ads/googleads/v12/enums/user_list_membership_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListMembershipStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user list membership status. diff --git a/google/ads/googleads/v9/enums/user_list_number_rule_item_operator.proto b/google/ads/googleads/v12/enums/user_list_number_rule_item_operator.proto similarity index 79% rename from google/ads/googleads/v9/enums/user_list_number_rule_item_operator.proto rename to google/ads/googleads/v12/enums/user_list_number_rule_item_operator.proto index b8ad47baa..d397ca303 100644 --- a/google/ads/googleads/v9/enums/user_list_number_rule_item_operator.proto +++ b/google/ads/googleads/v12/enums/user_list_number_rule_item_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListNumberRuleItemOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Supported rule operator for number type. message UserListNumberRuleItemOperatorEnum { diff --git a/google/ads/googleads/v9/enums/user_list_prepopulation_status.proto b/google/ads/googleads/v12/enums/user_list_prepopulation_status.proto similarity index 77% rename from google/ads/googleads/v9/enums/user_list_prepopulation_status.proto rename to google/ads/googleads/v12/enums/user_list_prepopulation_status.proto index e4592b168..1db32aa1d 100644 --- a/google/ads/googleads/v9/enums/user_list_prepopulation_status.proto +++ b/google/ads/googleads/v12/enums/user_list_prepopulation_status.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListPrepopulationStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Indicates status of prepopulation based on the rule. message UserListPrepopulationStatusEnum { diff --git a/google/ads/googleads/v9/enums/user_list_rule_type.proto b/google/ads/googleads/v12/enums/user_list_rule_type.proto similarity index 75% rename from google/ads/googleads/v9/enums/user_list_rule_type.proto rename to google/ads/googleads/v12/enums/user_list_rule_type.proto index d52ec7659..e698ae428 100644 --- a/google/ads/googleads/v9/enums/user_list_rule_type.proto +++ b/google/ads/googleads/v12/enums/user_list_rule_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListRuleTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Rule based user list rule type. message UserListRuleTypeEnum { diff --git a/google/ads/googleads/v9/enums/user_list_size_range.proto b/google/ads/googleads/v12/enums/user_list_size_range.proto similarity index 88% rename from google/ads/googleads/v9/enums/user_list_size_range.proto rename to google/ads/googleads/v12/enums/user_list_size_range.proto index 720c179d7..f017af14c 100644 --- a/google/ads/googleads/v9/enums/user_list_size_range.proto +++ b/google/ads/googleads/v12/enums/user_list_size_range.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListSizeRangeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user list size range. diff --git a/google/ads/googleads/v9/enums/user_list_string_rule_item_operator.proto b/google/ads/googleads/v12/enums/user_list_string_rule_item_operator.proto similarity index 79% rename from google/ads/googleads/v9/enums/user_list_string_rule_item_operator.proto rename to google/ads/googleads/v12/enums/user_list_string_rule_item_operator.proto index 97115c0aa..80b24c7db 100644 --- a/google/ads/googleads/v9/enums/user_list_string_rule_item_operator.proto +++ b/google/ads/googleads/v12/enums/user_list_string_rule_item_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListStringRuleItemOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Supported rule operator for string type. message UserListStringRuleItemOperatorEnum { diff --git a/google/ads/googleads/v9/enums/user_list_type.proto b/google/ads/googleads/v12/enums/user_list_type.proto similarity index 81% rename from google/ads/googleads/v9/enums/user_list_type.proto rename to google/ads/googleads/v12/enums/user_list_type.proto index 4119387d0..d36d85565 100644 --- a/google/ads/googleads/v9/enums/user_list_type.proto +++ b/google/ads/googleads/v12/enums/user_list_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "UserListTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing user list type. diff --git a/google/ads/googleads/v9/enums/value_rule_device_type.proto b/google/ads/googleads/v12/enums/value_rule_device_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/value_rule_device_type.proto rename to google/ads/googleads/v12/enums/value_rule_device_type.proto index 546625d18..e89165399 100644 --- a/google/ads/googleads/v9/enums/value_rule_device_type.proto +++ b/google/ads/googleads/v12/enums/value_rule_device_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ValueRuleDeviceTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule device type. diff --git a/google/ads/googleads/v9/enums/value_rule_geo_location_match_type.proto b/google/ads/googleads/v12/enums/value_rule_geo_location_match_type.proto similarity index 79% rename from google/ads/googleads/v9/enums/value_rule_geo_location_match_type.proto rename to google/ads/googleads/v12/enums/value_rule_geo_location_match_type.proto index a5fd0b4e2..4e1e62c0c 100644 --- a/google/ads/googleads/v9/enums/value_rule_geo_location_match_type.proto +++ b/google/ads/googleads/v12/enums/value_rule_geo_location_match_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ValueRuleGeoLocationMatchTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule geo location match type. diff --git a/google/ads/googleads/v9/enums/value_rule_operation.proto b/google/ads/googleads/v12/enums/value_rule_operation.proto similarity index 79% rename from google/ads/googleads/v9/enums/value_rule_operation.proto rename to google/ads/googleads/v12/enums/value_rule_operation.proto index e41a9750c..414ee13c8 100644 --- a/google/ads/googleads/v9/enums/value_rule_operation.proto +++ b/google/ads/googleads/v12/enums/value_rule_operation.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ValueRuleOperationProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule operation. diff --git a/google/ads/googleads/v9/enums/value_rule_set_attachment_type.proto b/google/ads/googleads/v12/enums/value_rule_set_attachment_type.proto similarity index 77% rename from google/ads/googleads/v9/enums/value_rule_set_attachment_type.proto rename to google/ads/googleads/v12/enums/value_rule_set_attachment_type.proto index 68e40db01..8ed39bb87 100644 --- a/google/ads/googleads/v9/enums/value_rule_set_attachment_type.proto +++ b/google/ads/googleads/v12/enums/value_rule_set_attachment_type.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ValueRuleSetAttachmentTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing where the conversion value rule is attached. diff --git a/google/ads/googleads/v9/enums/value_rule_set_dimension.proto b/google/ads/googleads/v12/enums/value_rule_set_dimension.proto similarity index 76% rename from google/ads/googleads/v9/enums/value_rule_set_dimension.proto rename to google/ads/googleads/v12/enums/value_rule_set_dimension.proto index f95e2b3ee..c112e60f9 100644 --- a/google/ads/googleads/v9/enums/value_rule_set_dimension.proto +++ b/google/ads/googleads/v12/enums/value_rule_set_dimension.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "ValueRuleSetDimensionProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing conversion value rule set dimension. @@ -48,6 +46,9 @@ message ValueRuleSetDimensionEnum { // Dimension for audience. AUDIENCE = 4; + + // This dimension implies the rule will always apply. + NO_CONDITION = 5; } diff --git a/google/ads/googleads/v9/enums/vanity_pharma_display_url_mode.proto b/google/ads/googleads/v12/enums/vanity_pharma_display_url_mode.proto similarity index 78% rename from google/ads/googleads/v9/enums/vanity_pharma_display_url_mode.proto rename to google/ads/googleads/v12/enums/vanity_pharma_display_url_mode.proto index 07c7dc8c7..1e2916d5f 100644 --- a/google/ads/googleads/v9/enums/vanity_pharma_display_url_mode.proto +++ b/google/ads/googleads/v12/enums/vanity_pharma_display_url_mode.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "VanityPharmaDisplayUrlModeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing vanity pharma display url modes. diff --git a/google/ads/googleads/v9/enums/vanity_pharma_text.proto b/google/ads/googleads/v12/enums/vanity_pharma_text.proto similarity index 88% rename from google/ads/googleads/v9/enums/vanity_pharma_text.proto rename to google/ads/googleads/v12/enums/vanity_pharma_text.proto index bea8cb6cb..a0f47fa02 100644 --- a/google/ads/googleads/v9/enums/vanity_pharma_text.proto +++ b/google/ads/googleads/v12/enums/vanity_pharma_text.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "VanityPharmaTextProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing vanity pharma texts. diff --git a/google/ads/googleads/v9/enums/video_thumbnail.proto b/google/ads/googleads/v12/enums/video_thumbnail.proto similarity index 81% rename from google/ads/googleads/v9/enums/video_thumbnail.proto rename to google/ads/googleads/v12/enums/video_thumbnail.proto index 6cb70c698..a11d3f6b0 100644 --- a/google/ads/googleads/v9/enums/video_thumbnail.proto +++ b/google/ads/googleads/v12/enums/video_thumbnail.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "VideoThumbnailProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing video thumbnails. diff --git a/google/ads/googleads/v9/enums/webpage_condition_operand.proto b/google/ads/googleads/v12/enums/webpage_condition_operand.proto similarity index 81% rename from google/ads/googleads/v9/enums/webpage_condition_operand.proto rename to google/ads/googleads/v12/enums/webpage_condition_operand.proto index b53e2f1de..7ee2244d5 100644 --- a/google/ads/googleads/v9/enums/webpage_condition_operand.proto +++ b/google/ads/googleads/v12/enums/webpage_condition_operand.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "WebpageConditionOperandProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing webpage condition operand. diff --git a/google/ads/googleads/v9/enums/webpage_condition_operator.proto b/google/ads/googleads/v12/enums/webpage_condition_operator.proto similarity index 78% rename from google/ads/googleads/v9/enums/webpage_condition_operator.proto rename to google/ads/googleads/v12/enums/webpage_condition_operator.proto index 11f52d369..1105fbb47 100644 --- a/google/ads/googleads/v9/enums/webpage_condition_operator.proto +++ b/google/ads/googleads/v12/enums/webpage_condition_operator.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.enums; +package google.ads.googleads.v12.enums; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums"; option java_multiple_files = true; option java_outer_classname = "WebpageConditionOperatorProto"; -option java_package = "com.google.ads.googleads.v9.enums"; +option java_package = "com.google.ads.googleads.v12.enums"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::Enums"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V12::Enums"; // Proto file describing webpage condition operator. diff --git a/google/ads/googleads/v9/errors/BUILD.bazel b/google/ads/googleads/v12/errors/BUILD.bazel similarity index 96% rename from google/ads/googleads/v9/errors/BUILD.bazel rename to google/ads/googleads/v12/errors/BUILD.bazel index 898db2426..1d75069de 100644 --- a/google/ads/googleads/v9/errors/BUILD.bazel +++ b/google/ads/googleads/v12/errors/BUILD.bazel @@ -26,8 +26,8 @@ proto_library( name = "errors_proto", srcs = glob(["*.proto"]), deps = [ - "//google/ads/googleads/v9/common:common_proto", - "//google/ads/googleads/v9/enums:enums_proto", + "//google/ads/googleads/v12/common:common_proto", + "//google/ads/googleads/v12/enums:enums_proto", "//google/api:annotations_proto", "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:wrappers_proto", diff --git a/google/ads/googleads/v9/errors/access_invitation_error.proto b/google/ads/googleads/v12/errors/access_invitation_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/access_invitation_error.proto rename to google/ads/googleads/v12/errors/access_invitation_error.proto index d5215afa0..c0f445724 100644 --- a/google/ads/googleads/v9/errors/access_invitation_error.proto +++ b/google/ads/googleads/v12/errors/access_invitation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AccessInvitationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing AccessInvitation errors. @@ -51,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. @@ -60,7 +58,7 @@ 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/google/ads/googleads/v9/errors/account_budget_proposal_error.proto b/google/ads/googleads/v12/errors/account_budget_proposal_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/account_budget_proposal_error.proto rename to google/ads/googleads/v12/errors/account_budget_proposal_error.proto index f30be85d9..f17775305 100644 --- a/google/ads/googleads/v9/errors/account_budget_proposal_error.proto +++ b/google/ads/googleads/v12/errors/account_budget_proposal_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProposalErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing account budget proposal errors. @@ -116,6 +114,10 @@ message AccountBudgetProposalErrorEnum { // 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; } diff --git a/google/ads/googleads/v9/errors/account_link_error.proto b/google/ads/googleads/v12/errors/account_link_error.proto similarity index 72% rename from google/ads/googleads/v9/errors/account_link_error.proto rename to google/ads/googleads/v12/errors/account_link_error.proto index a55823b62..8aa6ddde5 100644 --- a/google/ads/googleads/v9/errors/account_link_error.proto +++ b/google/ads/googleads/v12/errors/account_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AccountLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing AccountLink errors. @@ -41,6 +39,9 @@ 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/google/ads/googleads/v9/errors/ad_customizer_error.proto b/google/ads/googleads/v12/errors/ad_customizer_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/ad_customizer_error.proto rename to google/ads/googleads/v12/errors/ad_customizer_error.proto index 155e6e5c6..d445d4767 100644 --- a/google/ads/googleads/v9/errors/ad_customizer_error.proto +++ b/google/ads/googleads/v12/errors/ad_customizer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdCustomizerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad customizer errors. diff --git a/google/ads/googleads/v9/errors/ad_error.proto b/google/ads/googleads/v12/errors/ad_error.proto similarity index 94% rename from google/ads/googleads/v9/errors/ad_error.proto rename to google/ads/googleads/v12/errors/ad_error.proto index 27dca1725..6b758de5d 100644 --- a/google/ads/googleads/v9/errors/ad_error.proto +++ b/google/ads/googleads/v12/errors/ad_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad errors. @@ -115,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; @@ -197,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; @@ -235,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. @@ -347,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 @@ -440,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. @@ -518,6 +516,12 @@ message AdErrorEnum { // Missing required image aspect ratio. MISSING_REQUIRED_IMAGE_ASPECT_RATIO = 153; + + // Aspect ratios mismatch between different assets. + MISMATCHED_ASPECT_RATIOS = 155; + + // Images must be unique between different carousel card assets. + DUPLICATE_IMAGE_ACROSS_CAROUSEL_CARDS = 156; } diff --git a/google/ads/googleads/v9/errors/ad_group_ad_error.proto b/google/ads/googleads/v12/errors/ad_group_ad_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/ad_group_ad_error.proto rename to google/ads/googleads/v12/errors/ad_group_ad_error.proto index 1078c22df..46958fd0e 100644 --- a/google/ads/googleads/v9/errors/ad_group_ad_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_ad_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group ad errors. diff --git a/google/ads/googleads/v9/errors/ad_group_bid_modifier_error.proto b/google/ads/googleads/v12/errors/ad_group_bid_modifier_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/ad_group_bid_modifier_error.proto rename to google/ads/googleads/v12/errors/ad_group_bid_modifier_error.proto index e1fcb72b6..10a396696 100644 --- a/google/ads/googleads/v9/errors/ad_group_bid_modifier_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_bid_modifier_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupBidModifierErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group bid modifier errors. diff --git a/google/ads/googleads/v9/errors/ad_group_criterion_customizer_error.proto b/google/ads/googleads/v12/errors/ad_group_criterion_customizer_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/ad_group_criterion_customizer_error.proto rename to google/ads/googleads/v12/errors/ad_group_criterion_customizer_error.proto index 05177ddf6..032335c0e 100644 --- a/google/ads/googleads/v9/errors/ad_group_criterion_customizer_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_criterion_customizer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionCustomizerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group criterion customizer errors. diff --git a/google/ads/googleads/v9/errors/ad_group_criterion_error.proto b/google/ads/googleads/v12/errors/ad_group_criterion_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/ad_group_criterion_error.proto rename to google/ads/googleads/v12/errors/ad_group_criterion_error.proto index 5a7fb6666..29eebb5b0 100644 --- a/google/ads/googleads/v9/errors/ad_group_criterion_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_criterion_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group criterion errors. @@ -73,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 @@ -97,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; diff --git a/google/ads/googleads/v9/errors/ad_group_customizer_error.proto b/google/ads/googleads/v12/errors/ad_group_customizer_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/ad_group_customizer_error.proto rename to google/ads/googleads/v12/errors/ad_group_customizer_error.proto index fadbdcbba..69b9d9a5d 100644 --- a/google/ads/googleads/v9/errors/ad_group_customizer_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_customizer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupCustomizerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group customizer errors. diff --git a/google/ads/googleads/v9/errors/ad_group_error.proto b/google/ads/googleads/v12/errors/ad_group_error.proto similarity index 88% rename from google/ads/googleads/v9/errors/ad_group_error.proto rename to google/ads/googleads/v12/errors/ad_group_error.proto index 7f56ed28a..c3c6ba662 100644 --- a/google/ads/googleads/v9/errors/ad_group_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group errors. diff --git a/google/ads/googleads/v9/errors/ad_group_feed_error.proto b/google/ads/googleads/v12/errors/ad_group_feed_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/ad_group_feed_error.proto rename to google/ads/googleads/v12/errors/ad_group_feed_error.proto index b52b038de..f4ac17d3c 100644 --- a/google/ads/googleads/v9/errors/ad_group_feed_error.proto +++ b/google/ads/googleads/v12/errors/ad_group_feed_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdGroupFeedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad group feed errors. diff --git a/google/ads/googleads/v9/errors/ad_parameter_error.proto b/google/ads/googleads/v12/errors/ad_parameter_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/ad_parameter_error.proto rename to google/ads/googleads/v12/errors/ad_parameter_error.proto index 12c8ec7f7..e79fcae08 100644 --- a/google/ads/googleads/v9/errors/ad_parameter_error.proto +++ b/google/ads/googleads/v12/errors/ad_parameter_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdParameterErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad parameter errors. diff --git a/google/ads/googleads/v9/errors/ad_sharing_error.proto b/google/ads/googleads/v12/errors/ad_sharing_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/ad_sharing_error.proto rename to google/ads/googleads/v12/errors/ad_sharing_error.proto index 27a149266..e1d088721 100644 --- a/google/ads/googleads/v9/errors/ad_sharing_error.proto +++ b/google/ads/googleads/v12/errors/ad_sharing_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdSharingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ad sharing errors. diff --git a/google/ads/googleads/v9/errors/adx_error.proto b/google/ads/googleads/v12/errors/adx_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/adx_error.proto rename to google/ads/googleads/v12/errors/adx_error.proto index 4d141b4c4..79073379c 100644 --- a/google/ads/googleads/v9/errors/adx_error.proto +++ b/google/ads/googleads/v12/errors/adx_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AdxErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing adx errors. diff --git a/google/ads/googleads/v9/errors/asset_error.proto b/google/ads/googleads/v12/errors/asset_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/asset_error.proto rename to google/ads/googleads/v12/errors/asset_error.proto index 4720f3bdc..53957aa9f 100644 --- a/google/ads/googleads/v9/errors/asset_error.proto +++ b/google/ads/googleads/v12/errors/asset_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset errors. @@ -128,6 +126,28 @@ message AssetErrorEnum { // PriceOffering cannot have the same value for header and description. PRICE_HEADER_SAME_AS_DESCRIPTION = 29; + + // AppId is invalid. + MOBILE_APP_INVALID_APP_ID = 30; + + // Invalid App download URL in final URLs. + MOBILE_APP_INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URL = 31; + + // Asset name is required for the asset type. + NAME_REQUIRED_FOR_ASSET_TYPE = 32; + + // Legacy qualifying questions cannot be in the same Lead Form as + // custom questions. + LEAD_FORM_LEGACY_QUALIFYING_QUESTIONS_DISALLOWED = 33; + + // 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/google/ads/googleads/v9/errors/asset_group_asset_error.proto b/google/ads/googleads/v12/errors/asset_group_asset_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/asset_group_asset_error.proto rename to google/ads/googleads/v12/errors/asset_group_asset_error.proto index 8ff06ec54..f77552a14 100644 --- a/google/ads/googleads/v9/errors/asset_group_asset_error.proto +++ b/google/ads/googleads/v12/errors/asset_group_asset_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetGroupAssetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset group asset errors. diff --git a/google/ads/googleads/v9/errors/asset_group_error.proto b/google/ads/googleads/v12/errors/asset_group_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/asset_group_error.proto rename to google/ads/googleads/v12/errors/asset_group_error.proto index 99ec9eab5..eb71daf88 100644 --- a/google/ads/googleads/v9/errors/asset_group_error.proto +++ b/google/ads/googleads/v12/errors/asset_group_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetGroupErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset group errors. diff --git a/google/ads/googleads/v9/errors/asset_group_listing_group_filter_error.proto b/google/ads/googleads/v12/errors/asset_group_listing_group_filter_error.proto similarity index 87% rename from google/ads/googleads/v9/errors/asset_group_listing_group_filter_error.proto rename to google/ads/googleads/v12/errors/asset_group_listing_group_filter_error.proto index 84b2b3948..c54f7ee43 100644 --- a/google/ads/googleads/v9/errors/asset_group_listing_group_filter_error.proto +++ b/google/ads/googleads/v12/errors/asset_group_listing_group_filter_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetGroupListingGroupFilterErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset group asset errors. diff --git a/google/ads/googleads/v9/errors/asset_link_error.proto b/google/ads/googleads/v12/errors/asset_link_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/asset_link_error.proto rename to google/ads/googleads/v12/errors/asset_link_error.proto index 09cc4e82d..2a5d9544e 100644 --- a/google/ads/googleads/v9/errors/asset_link_error.proto +++ b/google/ads/googleads/v12/errors/asset_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset link errors. @@ -42,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; @@ -72,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 @@ -94,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; @@ -102,6 +103,16 @@ 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/google/ads/googleads/v9/errors/asset_set_asset_error.proto b/google/ads/googleads/v12/errors/asset_set_asset_error.proto similarity index 72% rename from google/ads/googleads/v9/errors/asset_set_asset_error.proto rename to google/ads/googleads/v12/errors/asset_set_asset_error.proto index c96383ccd..190239606 100644 --- a/google/ads/googleads/v9/errors/asset_set_asset_error.proto +++ b/google/ads/googleads/v12/errors/asset_set_asset_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetSetAssetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset set asset errors. @@ -50,6 +48,11 @@ 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/google/ads/googleads/v12/errors/asset_set_error.proto b/google/ads/googleads/v12/errors/asset_set_error.proto new file mode 100644 index 000000000..645837ae6 --- /dev/null +++ b/google/ads/googleads/v12/errors/asset_set_error.proto @@ -0,0 +1,70 @@ +// 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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "AssetSetErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; + } + + +} diff --git a/google/ads/googleads/v9/errors/asset_set_link_error.proto b/google/ads/googleads/v12/errors/asset_set_link_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/asset_set_link_error.proto rename to google/ads/googleads/v12/errors/asset_set_link_error.proto index d8620aa3e..252a2b754 100644 --- a/google/ads/googleads/v9/errors/asset_set_link_error.proto +++ b/google/ads/googleads/v12/errors/asset_set_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AssetSetLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing asset set link errors. diff --git a/google/ads/googleads/v12/errors/audience_error.proto b/google/ads/googleads/v12/errors/audience_error.proto new file mode 100644 index 000000000..ddaa2ad6c --- /dev/null +++ b/google/ads/googleads/v12/errors/audience_error.proto @@ -0,0 +1,68 @@ +// 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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "AudienceErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; + +// Proto file describing audience errors. + +// Container for enum describing possible audience errors. +message AudienceErrorEnum { + // Enum describing possible audience errors. + enum AudienceError { + // Enum unspecified. + UNSPECIFIED = 0; + + // The received error code is not known in this version. + UNKNOWN = 1; + + // An audience with this name already exists. + NAME_ALREADY_IN_USE = 2; + + // A dimension within the audience definition is not valid. + DIMENSION_INVALID = 3; + + // One of the audience segment added is not found. + AUDIENCE_SEGMENT_NOT_FOUND = 4; + + // One of the audience segment type is not supported. + AUDIENCE_SEGMENT_TYPE_NOT_SUPPORTED = 5; + + // The same segment already exists in this audience. + DUPLICATE_AUDIENCE_SEGMENT = 6; + + // Audience can't have more than allowed number segments. + TOO_MANY_SEGMENTS = 7; + + // Audience can't have multiple dimensions of same type. + TOO_MANY_DIMENSIONS_OF_SAME_TYPE = 8; + + // The audience cannot be removed, because it is currently used in an + // ad group criterion or asset group signal in an (enabled or paused) + // ad group or campaign. + IN_USE = 9; + } + + +} diff --git a/google/ads/googleads/v12/errors/audience_insights_error.proto b/google/ads/googleads/v12/errors/audience_insights_error.proto new file mode 100644 index 000000000..543f23d9d --- /dev/null +++ b/google/ads/googleads/v12/errors/audience_insights_error.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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "AudienceInsightsErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/errors/authentication_error.proto b/google/ads/googleads/v12/errors/authentication_error.proto similarity index 78% rename from google/ads/googleads/v9/errors/authentication_error.proto rename to google/ads/googleads/v12/errors/authentication_error.proto index 0d686b27f..70adcce61 100644 --- a/google/ads/googleads/v9/errors/authentication_error.proto +++ b/google/ads/googleads/v12/errors/authentication_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AuthenticationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing authentication errors. @@ -42,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. @@ -67,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. diff --git a/google/ads/googleads/v9/errors/authorization_error.proto b/google/ads/googleads/v12/errors/authorization_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/authorization_error.proto rename to google/ads/googleads/v12/errors/authorization_error.proto index 2b705b527..5ea43ddc4 100644 --- a/google/ads/googleads/v9/errors/authorization_error.proto +++ b/google/ads/googleads/v12/errors/authorization_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "AuthorizationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing authorization errors. @@ -59,7 +57,7 @@ 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. @@ -86,6 +84,9 @@ message AuthorizationErrorEnum { // The customer (or login customer) isn't in Google Ads. It belongs to // another ads system. ACCESS_DENIED_FOR_ACCOUNT_TYPE = 25; + + // The developer does not have access to the metrics queried. + METRIC_ACCESS_DENIED = 26; } diff --git a/google/ads/googleads/v9/errors/batch_job_error.proto b/google/ads/googleads/v12/errors/batch_job_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/batch_job_error.proto rename to google/ads/googleads/v12/errors/batch_job_error.proto index 59a8da2b8..10bce15c0 100644 --- a/google/ads/googleads/v9/errors/batch_job_error.proto +++ b/google/ads/googleads/v12/errors/batch_job_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "BatchJobErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing batch job errors. diff --git a/google/ads/googleads/v9/errors/bidding_error.proto b/google/ads/googleads/v12/errors/bidding_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/bidding_error.proto rename to google/ads/googleads/v12/errors/bidding_error.proto index 774d26db7..8973eb1f9 100644 --- a/google/ads/googleads/v9/errors/bidding_error.proto +++ b/google/ads/googleads/v12/errors/bidding_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "BiddingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing bidding errors. @@ -116,6 +114,17 @@ message BiddingErrorEnum { // Bidding strategy type is incompatible with shared budget. BIDDING_STRATEGY_TYPE_INCOMPATIBLE_WITH_SHARED_BUDGET = 37; + + // The attached bidding strategy and budget must be aligned with each other + // if alignment is specified on either entity. + BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ALIGNED = 38; + + // 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; + + // The aligned bidding strategy and budget must be removed at the same time. + BIDDING_STRATEGY_AND_BUDGET_MUST_BE_REMOVED_TOGETHER = 40; } diff --git a/google/ads/googleads/v9/errors/bidding_strategy_error.proto b/google/ads/googleads/v12/errors/bidding_strategy_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/bidding_strategy_error.proto rename to google/ads/googleads/v12/errors/bidding_strategy_error.proto index 151365158..5ef1506b2 100644 --- a/google/ads/googleads/v9/errors/bidding_strategy_error.proto +++ b/google/ads/googleads/v12/errors/bidding_strategy_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategyErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing bidding strategy errors. diff --git a/google/ads/googleads/v9/errors/billing_setup_error.proto b/google/ads/googleads/v12/errors/billing_setup_error.proto similarity index 88% rename from google/ads/googleads/v9/errors/billing_setup_error.proto rename to google/ads/googleads/v12/errors/billing_setup_error.proto index d26cc4c54..c168382c6 100644 --- a/google/ads/googleads/v9/errors/billing_setup_error.proto +++ b/google/ads/googleads/v12/errors/billing_setup_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "BillingSetupErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing billing setup errors. @@ -103,6 +101,9 @@ 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/google/ads/googleads/v9/errors/campaign_budget_error.proto b/google/ads/googleads/v12/errors/campaign_budget_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/campaign_budget_error.proto rename to google/ads/googleads/v12/errors/campaign_budget_error.proto index 535440916..ba03f8974 100644 --- a/google/ads/googleads/v9/errors/campaign_budget_error.proto +++ b/google/ads/googleads/v12/errors/campaign_budget_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignBudgetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign budget errors. diff --git a/google/ads/googleads/v9/errors/asset_set_error.proto b/google/ads/googleads/v12/errors/campaign_conversion_goal_error.proto similarity index 50% rename from google/ads/googleads/v9/errors/asset_set_error.proto rename to google/ads/googleads/v12/errors/campaign_conversion_goal_error.proto index 309e46442..856765584 100644 --- a/google/ads/googleads/v9/errors/asset_set_error.proto +++ b/google/ads/googleads/v12/errors/campaign_conversion_goal_error.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. @@ -14,33 +14,31 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; -option java_outer_classname = "AssetSetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_outer_classname = "CampaignConversionGoalErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; -// Proto file describing asset set errors. +// Proto file describing campaign conversion goal errors. -// Container for enum describing possible asset set errors. -message AssetSetErrorEnum { - // Enum describing possible asset set errors. - enum AssetSetError { +// Container for enum describing possible campaign conversion goal errors. +message CampaignConversionGoalErrorEnum { + // Enum describing possible campaign conversion goal errors. + enum CampaignConversionGoalError { // 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; + // 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/google/ads/googleads/v9/errors/campaign_criterion_error.proto b/google/ads/googleads/v12/errors/campaign_criterion_error.proto similarity index 73% rename from google/ads/googleads/v9/errors/campaign_criterion_error.proto rename to google/ads/googleads/v12/errors/campaign_criterion_error.proto index 4bdeb76c6..113202539 100644 --- a/google/ads/googleads/v9/errors/campaign_criterion_error.proto +++ b/google/ads/googleads/v12/errors/campaign_criterion_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignCriterionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign criterion errors. @@ -93,6 +91,25 @@ 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; } diff --git a/google/ads/googleads/v9/errors/campaign_customizer_error.proto b/google/ads/googleads/v12/errors/campaign_customizer_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/campaign_customizer_error.proto rename to google/ads/googleads/v12/errors/campaign_customizer_error.proto index 99dc8e253..6ca698b18 100644 --- a/google/ads/googleads/v9/errors/campaign_customizer_error.proto +++ b/google/ads/googleads/v12/errors/campaign_customizer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignCustomizerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign customizer errors. diff --git a/google/ads/googleads/v9/errors/campaign_draft_error.proto b/google/ads/googleads/v12/errors/campaign_draft_error.proto similarity index 86% rename from google/ads/googleads/v9/errors/campaign_draft_error.proto rename to google/ads/googleads/v12/errors/campaign_draft_error.proto index 1f97e172b..45e2f6761 100644 --- a/google/ads/googleads/v9/errors/campaign_draft_error.proto +++ b/google/ads/googleads/v12/errors/campaign_draft_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignDraftErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign draft errors. diff --git a/google/ads/googleads/v9/errors/campaign_error.proto b/google/ads/googleads/v12/errors/campaign_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/campaign_error.proto rename to google/ads/googleads/v12/errors/campaign_error.proto index 2a55f028c..db7196895 100644 --- a/google/ads/googleads/v9/errors/campaign_error.proto +++ b/google/ads/googleads/v12/errors/campaign_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign errors. @@ -195,6 +193,18 @@ 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; } diff --git a/google/ads/googleads/v9/errors/campaign_experiment_error.proto b/google/ads/googleads/v12/errors/campaign_experiment_error.proto similarity index 87% rename from google/ads/googleads/v9/errors/campaign_experiment_error.proto rename to google/ads/googleads/v12/errors/campaign_experiment_error.proto index f5f6e70eb..516627eb2 100644 --- a/google/ads/googleads/v9/errors/campaign_experiment_error.proto +++ b/google/ads/googleads/v12/errors/campaign_experiment_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignExperimentErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign experiment errors. diff --git a/google/ads/googleads/v9/errors/campaign_feed_error.proto b/google/ads/googleads/v12/errors/campaign_feed_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/campaign_feed_error.proto rename to google/ads/googleads/v12/errors/campaign_feed_error.proto index 1b0a1f945..6b348b679 100644 --- a/google/ads/googleads/v9/errors/campaign_feed_error.proto +++ b/google/ads/googleads/v12/errors/campaign_feed_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignFeedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign feed errors. @@ -61,6 +59,9 @@ 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/google/ads/googleads/v9/errors/campaign_shared_set_error.proto b/google/ads/googleads/v12/errors/campaign_shared_set_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/campaign_shared_set_error.proto rename to google/ads/googleads/v12/errors/campaign_shared_set_error.proto index d0e53f332..ea0af811f 100644 --- a/google/ads/googleads/v9/errors/campaign_shared_set_error.proto +++ b/google/ads/googleads/v12/errors/campaign_shared_set_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CampaignSharedSetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing campaign shared set errors. diff --git a/google/ads/googleads/v9/errors/change_event_error.proto b/google/ads/googleads/v12/errors/change_event_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/change_event_error.proto rename to google/ads/googleads/v12/errors/change_event_error.proto index 077a77df7..a913f4891 100644 --- a/google/ads/googleads/v9/errors/change_event_error.proto +++ b/google/ads/googleads/v12/errors/change_event_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ChangeEventErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing change event errors. diff --git a/google/ads/googleads/v9/errors/change_status_error.proto b/google/ads/googleads/v12/errors/change_status_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/change_status_error.proto rename to google/ads/googleads/v12/errors/change_status_error.proto index 7fc45a2ee..b01282fcc 100644 --- a/google/ads/googleads/v9/errors/change_status_error.proto +++ b/google/ads/googleads/v12/errors/change_status_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ChangeStatusErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing change status errors. diff --git a/google/ads/googleads/v9/errors/collection_size_error.proto b/google/ads/googleads/v12/errors/collection_size_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/collection_size_error.proto rename to google/ads/googleads/v12/errors/collection_size_error.proto index 18002b753..f533a782a 100644 --- a/google/ads/googleads/v9/errors/collection_size_error.proto +++ b/google/ads/googleads/v12/errors/collection_size_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CollectionSizeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing collection size errors. diff --git a/google/ads/googleads/v9/errors/context_error.proto b/google/ads/googleads/v12/errors/context_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/context_error.proto rename to google/ads/googleads/v12/errors/context_error.proto index e6bd62454..f5a910536 100644 --- a/google/ads/googleads/v9/errors/context_error.proto +++ b/google/ads/googleads/v12/errors/context_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ContextErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing context errors. diff --git a/google/ads/googleads/v9/errors/conversion_action_error.proto b/google/ads/googleads/v12/errors/conversion_action_error.proto similarity index 87% rename from google/ads/googleads/v9/errors/conversion_action_error.proto rename to google/ads/googleads/v12/errors/conversion_action_error.proto index ebe23fcb7..f4b1c05eb 100644 --- a/google/ads/googleads/v9/errors/conversion_action_error.proto +++ b/google/ads/googleads/v12/errors/conversion_action_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionActionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion action errors. diff --git a/google/ads/googleads/v9/errors/conversion_adjustment_upload_error.proto b/google/ads/googleads/v12/errors/conversion_adjustment_upload_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/conversion_adjustment_upload_error.proto rename to google/ads/googleads/v12/errors/conversion_adjustment_upload_error.proto index d923c4dc2..fa07d771c 100644 --- a/google/ads/googleads/v9/errors/conversion_adjustment_upload_error.proto +++ b/google/ads/googleads/v12/errors/conversion_adjustment_upload_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionAdjustmentUploadErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion adjustment upload errors. @@ -40,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; @@ -81,11 +79,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,6 +114,20 @@ message ConversionAdjustmentUploadErrorEnum { // This enhancement has the same conversion action and order_id as // another enhancement in the request. DUPLICATE_ENHANCEMENT_IN_REQUEST = 22; + + // Per our customer data policies, enhancement has been prohibited in your + // account. If you have any questions, contact your Google + // representative. + CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT = 23; + + // The conversion adjustment is for a conversion action of type WEBPAGE, but + // 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/google/ads/googleads/v9/errors/conversion_custom_variable_error.proto b/google/ads/googleads/v12/errors/conversion_custom_variable_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/conversion_custom_variable_error.proto rename to google/ads/googleads/v12/errors/conversion_custom_variable_error.proto index a8a4cb960..e8f916e97 100644 --- a/google/ads/googleads/v9/errors/conversion_custom_variable_error.proto +++ b/google/ads/googleads/v12/errors/conversion_custom_variable_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionCustomVariableErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion custom variable errors. @@ -44,6 +42,10 @@ message ConversionCustomVariableErrorEnum { // A conversion custom variable with the specified tag already exists. DUPLICATE_TAG = 3; + + // A conversion custom variable with the specified tag is reserved for other + // uses. + RESERVED_TAG = 4; } diff --git a/google/ads/googleads/v12/errors/conversion_goal_campaign_config_error.proto b/google/ads/googleads/v12/errors/conversion_goal_campaign_config_error.proto new file mode 100644 index 000000000..9fbc0e316 --- /dev/null +++ b/google/ads/googleads/v12/errors/conversion_goal_campaign_config_error.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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "ConversionGoalCampaignConfigErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; + +// Proto file describing conversion goal campaign config errors. + +// Container for enum describing possible conversion goal campaign config +// errors. +message ConversionGoalCampaignConfigErrorEnum { + // Enum describing possible conversion goal campaign config errors. + enum ConversionGoalCampaignConfigError { + // Enum unspecified. + UNSPECIFIED = 0; + + // The received error code is not known in this version. + UNKNOWN = 1; + + // Campaign is managed by Search Ads 360 but uses Unified Goal. + CANNOT_USE_CAMPAIGN_GOAL_FOR_SEARCH_ADS_360_MANAGED_CAMPAIGN = 2; + + // The campaign is using a custom goal that does not belong to its Google + // Ads conversion customer (conversion tracking customer). + CUSTOM_GOAL_DOES_NOT_BELONG_TO_GOOGLE_ADS_CONVERSION_CUSTOMER = 3; + + // The campaign is not allowed to use unified goals. + CAMPAIGN_CANNOT_USE_UNIFIED_GOALS = 4; + } + + +} diff --git a/google/ads/googleads/v9/errors/conversion_upload_error.proto b/google/ads/googleads/v12/errors/conversion_upload_error.proto similarity index 81% rename from google/ads/googleads/v9/errors/conversion_upload_error.proto rename to google/ads/googleads/v12/errors/conversion_upload_error.proto index 06ab12c08..5bf431db3 100644 --- a/google/ads/googleads/v9/errors/conversion_upload_error.proto +++ b/google/ads/googleads/v12/errors/conversion_upload_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionUploadErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion upload errors. @@ -55,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; @@ -73,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; @@ -103,7 +101,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; @@ -121,34 +119,34 @@ message ConversionUploadErrorEnum { // information. CONVERSION_TRACKING_NOT_ENABLED_AT_CALL_TIME = 21; - // The caller’s phone number cannot be parsed. It should be formatted either + // The caller's phone number cannot be parsed. It should be formatted either // as E.164 "+16502531234", International "+64 3-331 6005" or US national // number "6502531234". 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; // The custom variable is not enabled. CUSTOM_VARIABLE_NOT_ENABLED = 28; - // The value of the custom variable contains private customer data, such - // as email addresses or phone numbers. + // The value of the custom variable contains personally identifiable + // information (PII), such as an email address or phone number. CUSTOM_VARIABLE_VALUE_CONTAINS_PII = 29; // The click associated with the given identifier or iOS URL parameter isn't @@ -164,8 +162,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 @@ -189,13 +187,22 @@ 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, 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; } diff --git a/google/ads/googleads/v9/errors/conversion_value_rule_error.proto b/google/ads/googleads/v12/errors/conversion_value_rule_error.proto similarity index 87% rename from google/ads/googleads/v9/errors/conversion_value_rule_error.proto rename to google/ads/googleads/v12/errors/conversion_value_rule_error.proto index 62aee9283..cb1a3037e 100644 --- a/google/ads/googleads/v9/errors/conversion_value_rule_error.proto +++ b/google/ads/googleads/v12/errors/conversion_value_rule_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion value rule errors. @@ -40,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 diff --git a/google/ads/googleads/v9/errors/conversion_value_rule_set_error.proto b/google/ads/googleads/v12/errors/conversion_value_rule_set_error.proto similarity index 72% rename from google/ads/googleads/v9/errors/conversion_value_rule_set_error.proto rename to google/ads/googleads/v12/errors/conversion_value_rule_set_error.proto index a4bcc9eba..7637a24a8 100644 --- a/google/ads/googleads/v9/errors/conversion_value_rule_set_error.proto +++ b/google/ads/googleads/v12/errors/conversion_value_rule_set_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleSetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing conversion value rule set errors. @@ -78,6 +76,24 @@ message ConversionValueRuleSetErrorEnum { // rules. Currently, campaign level value rule sets can only be created on // Search, or Display campaigns. VALUE_RULES_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE = 10; + + // To add a value rule set that applies on Store Visits/Store Sales + // conversion action categories, the customer must have valid Store Visits/ + // Store Sales conversion actions. + INELIGIBLE_CONVERSION_ACTION_CATEGORIES = 11; + + // If NO_CONDITION is used as a dimension of a value rule set, it must be + // the only dimension. + DIMENSION_NO_CONDITION_USED_WITH_OTHER_DIMENSIONS = 12; + + // Dimension NO_CONDITION can only be used by Store Visits/Store Sales value + // rule set. + DIMENSION_NO_CONDITION_NOT_ALLOWED = 13; + + // Value rule sets defined on the specified conversion action categories are + // not supported. The list of conversion action categories must be an empty + // list, only STORE_VISIT, or only STORE_SALE. + UNSUPPORTED_CONVERSION_ACTION_CATEGORIES = 14; } diff --git a/google/ads/googleads/v9/errors/country_code_error.proto b/google/ads/googleads/v12/errors/country_code_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/country_code_error.proto rename to google/ads/googleads/v12/errors/country_code_error.proto index f70dfbee2..0640fd22b 100644 --- a/google/ads/googleads/v9/errors/country_code_error.proto +++ b/google/ads/googleads/v12/errors/country_code_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CountryCodeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing country code errors. diff --git a/google/ads/googleads/v9/errors/criterion_error.proto b/google/ads/googleads/v12/errors/criterion_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/criterion_error.proto rename to google/ads/googleads/v12/errors/criterion_error.proto index 2f0ee26a7..97b1f78ce 100644 --- a/google/ads/googleads/v9/errors/criterion_error.proto +++ b/google/ads/googleads/v12/errors/criterion_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CriterionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing criterion errors. @@ -284,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; @@ -303,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. @@ -407,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 @@ -447,9 +464,24 @@ 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; + + // Only one audience is allowed in an asset group. + ONE_AUDIENCE_ALLOWED_PER_ASSET_GROUP = 136; + + // Audience is not supported for the specified campaign type. + AUDIENCE_NOT_ELIGIBLE_FOR_CAMPAIGN_TYPE = 137; + + // Audience is not allowed to attach when use_audience_grouped bit is set to + // false. + 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. See + // https://support.google.com/google-ads/answer/6299717. + CANNOT_TARGET_CUSTOMER_MATCH_USER_LIST = 139; } diff --git a/google/ads/googleads/v9/errors/currency_code_error.proto b/google/ads/googleads/v12/errors/currency_code_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/currency_code_error.proto rename to google/ads/googleads/v12/errors/currency_code_error.proto index de4c5b308..1db7ab744 100644 --- a/google/ads/googleads/v9/errors/currency_code_error.proto +++ b/google/ads/googleads/v12/errors/currency_code_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CurrencyCodeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing currency code errors. diff --git a/google/ads/googleads/v9/errors/custom_audience_error.proto b/google/ads/googleads/v12/errors/custom_audience_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/custom_audience_error.proto rename to google/ads/googleads/v12/errors/custom_audience_error.proto index 1b0d8af3a..585144d2c 100644 --- a/google/ads/googleads/v9/errors/custom_audience_error.proto +++ b/google/ads/googleads/v12/errors/custom_audience_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing custom audience errors. diff --git a/google/ads/googleads/v9/errors/custom_conversion_goal_error.proto b/google/ads/googleads/v12/errors/custom_conversion_goal_error.proto similarity index 74% rename from google/ads/googleads/v9/errors/custom_conversion_goal_error.proto rename to google/ads/googleads/v12/errors/custom_conversion_goal_error.proto index 494307ddb..4995f7cf9 100644 --- a/google/ads/googleads/v9/errors/custom_conversion_goal_error.proto +++ b/google/ads/googleads/v12/errors/custom_conversion_goal_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomConversionGoalErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing CustomConversionGoal errors. @@ -49,6 +47,12 @@ message CustomConversionGoalErrorEnum { // The custom conversion goal cannot be removed because it's linked to a // campaign. CANNOT_REMOVE_LINKED_CUSTOM_CONVERSION_GOAL = 4; + + // Custom goal with the same name already exists. + CUSTOM_GOAL_DUPLICATE_NAME = 5; + + // Custom goal with the same conversion action list already exists. + DUPLICATE_CONVERSION_ACTION_LIST = 6; } diff --git a/google/ads/googleads/v9/errors/custom_interest_error.proto b/google/ads/googleads/v12/errors/custom_interest_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/custom_interest_error.proto rename to google/ads/googleads/v12/errors/custom_interest_error.proto index 3685c31ec..5c2ee1975 100644 --- a/google/ads/googleads/v9/errors/custom_interest_error.proto +++ b/google/ads/googleads/v12/errors/custom_interest_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomInterestErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing custom interest errors. diff --git a/google/ads/googleads/v9/errors/customer_client_link_error.proto b/google/ads/googleads/v12/errors/customer_client_link_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/customer_client_link_error.proto rename to google/ads/googleads/v12/errors/customer_client_link_error.proto index 2afccc3b5..1f17bd51f 100644 --- a/google/ads/googleads/v9/errors/customer_client_link_error.proto +++ b/google/ads/googleads/v12/errors/customer_client_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerClientLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing CustomerClientLink errors. diff --git a/google/ads/googleads/v9/errors/customer_customizer_error.proto b/google/ads/googleads/v12/errors/customer_customizer_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/customer_customizer_error.proto rename to google/ads/googleads/v12/errors/customer_customizer_error.proto index 6c9a94ef7..a2ccea844 100644 --- a/google/ads/googleads/v9/errors/customer_customizer_error.proto +++ b/google/ads/googleads/v12/errors/customer_customizer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerCustomizerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing customer customizer errors. diff --git a/google/ads/googleads/v9/errors/customer_error.proto b/google/ads/googleads/v12/errors/customer_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/customer_error.proto rename to google/ads/googleads/v12/errors/customer_error.proto index 07aa869da..c2c89a5f5 100644 --- a/google/ads/googleads/v9/errors/customer_error.proto +++ b/google/ads/googleads/v12/errors/customer_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Container for enum describing possible customer errors. message CustomerErrorEnum { diff --git a/google/ads/googleads/v9/errors/customer_feed_error.proto b/google/ads/googleads/v12/errors/customer_feed_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/customer_feed_error.proto rename to google/ads/googleads/v12/errors/customer_feed_error.proto index c8653b1da..9dc837eb6 100644 --- a/google/ads/googleads/v9/errors/customer_feed_error.proto +++ b/google/ads/googleads/v12/errors/customer_feed_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerFeedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing customer feed errors. diff --git a/google/ads/googleads/v9/errors/customer_manager_link_error.proto b/google/ads/googleads/v12/errors/customer_manager_link_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/customer_manager_link_error.proto rename to google/ads/googleads/v12/errors/customer_manager_link_error.proto index 8c623eef0..bd97b7f45 100644 --- a/google/ads/googleads/v9/errors/customer_manager_link_error.proto +++ b/google/ads/googleads/v12/errors/customer_manager_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerManagerLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing CustomerManagerLink errors. diff --git a/google/ads/googleads/v9/errors/customer_user_access_error.proto b/google/ads/googleads/v12/errors/customer_user_access_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/customer_user_access_error.proto rename to google/ads/googleads/v12/errors/customer_user_access_error.proto index e98de2971..15aa501f8 100644 --- a/google/ads/googleads/v9/errors/customer_user_access_error.proto +++ b/google/ads/googleads/v12/errors/customer_user_access_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomerUserAccessErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing CustomerUserAccess errors. diff --git a/google/ads/googleads/v9/errors/customizer_attribute_error.proto b/google/ads/googleads/v12/errors/customizer_attribute_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/customizer_attribute_error.proto rename to google/ads/googleads/v12/errors/customizer_attribute_error.proto index 1cd22f570..30ee68652 100644 --- a/google/ads/googleads/v9/errors/customizer_attribute_error.proto +++ b/google/ads/googleads/v12/errors/customizer_attribute_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "CustomizerAttributeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing customizer attribute errors. diff --git a/google/ads/googleads/v9/errors/database_error.proto b/google/ads/googleads/v12/errors/database_error.proto similarity index 74% rename from google/ads/googleads/v9/errors/database_error.proto rename to google/ads/googleads/v12/errors/database_error.proto index 337871a46..4814289e1 100644 --- a/google/ads/googleads/v9/errors/database_error.proto +++ b/google/ads/googleads/v12/errors/database_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "DatabaseErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing database errors. @@ -40,14 +38,14 @@ 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/google/ads/googleads/v9/errors/date_error.proto b/google/ads/googleads/v12/errors/date_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/date_error.proto rename to google/ads/googleads/v12/errors/date_error.proto index b1264d541..5bd9102d3 100644 --- a/google/ads/googleads/v9/errors/date_error.proto +++ b/google/ads/googleads/v12/errors/date_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "DateErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing date errors. diff --git a/google/ads/googleads/v9/errors/date_range_error.proto b/google/ads/googleads/v12/errors/date_range_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/date_range_error.proto rename to google/ads/googleads/v12/errors/date_range_error.proto index 62531e723..2f40c4145 100644 --- a/google/ads/googleads/v9/errors/date_range_error.proto +++ b/google/ads/googleads/v12/errors/date_range_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "DateRangeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing date range errors. diff --git a/google/ads/googleads/v9/errors/distinct_error.proto b/google/ads/googleads/v12/errors/distinct_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/distinct_error.proto rename to google/ads/googleads/v12/errors/distinct_error.proto index 4daecc1cb..36bdd9759 100644 --- a/google/ads/googleads/v9/errors/distinct_error.proto +++ b/google/ads/googleads/v12/errors/distinct_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "DistinctErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing distinct errors. diff --git a/google/ads/googleads/v9/errors/enum_error.proto b/google/ads/googleads/v12/errors/enum_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/enum_error.proto rename to google/ads/googleads/v12/errors/enum_error.proto index 0b3e17d30..29598ccc7 100644 --- a/google/ads/googleads/v9/errors/enum_error.proto +++ b/google/ads/googleads/v12/errors/enum_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "EnumErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing enum errors. diff --git a/google/ads/googleads/v9/errors/errors.proto b/google/ads/googleads/v12/errors/errors.proto similarity index 66% rename from google/ads/googleads/v9/errors/errors.proto rename to google/ads/googleads/v12/errors/errors.proto index f72ebc94f..2e0718506 100644 --- a/google/ads/googleads/v9/errors/errors.proto +++ b/google/ads/googleads/v12/errors/errors.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. @@ -14,156 +14,162 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; - -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/common/value.proto"; -import "google/ads/googleads/v9/enums/resource_limit_type.proto"; -import "google/ads/googleads/v9/errors/access_invitation_error.proto"; -import "google/ads/googleads/v9/errors/account_budget_proposal_error.proto"; -import "google/ads/googleads/v9/errors/account_link_error.proto"; -import "google/ads/googleads/v9/errors/ad_customizer_error.proto"; -import "google/ads/googleads/v9/errors/ad_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_ad_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_bid_modifier_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_criterion_customizer_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_criterion_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_customizer_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_error.proto"; -import "google/ads/googleads/v9/errors/ad_group_feed_error.proto"; -import "google/ads/googleads/v9/errors/ad_parameter_error.proto"; -import "google/ads/googleads/v9/errors/ad_sharing_error.proto"; -import "google/ads/googleads/v9/errors/adx_error.proto"; -import "google/ads/googleads/v9/errors/asset_error.proto"; -import "google/ads/googleads/v9/errors/asset_group_asset_error.proto"; -import "google/ads/googleads/v9/errors/asset_group_error.proto"; -import "google/ads/googleads/v9/errors/asset_group_listing_group_filter_error.proto"; -import "google/ads/googleads/v9/errors/asset_link_error.proto"; -import "google/ads/googleads/v9/errors/asset_set_asset_error.proto"; -import "google/ads/googleads/v9/errors/asset_set_error.proto"; -import "google/ads/googleads/v9/errors/asset_set_link_error.proto"; -import "google/ads/googleads/v9/errors/authentication_error.proto"; -import "google/ads/googleads/v9/errors/authorization_error.proto"; -import "google/ads/googleads/v9/errors/batch_job_error.proto"; -import "google/ads/googleads/v9/errors/bidding_error.proto"; -import "google/ads/googleads/v9/errors/bidding_strategy_error.proto"; -import "google/ads/googleads/v9/errors/billing_setup_error.proto"; -import "google/ads/googleads/v9/errors/campaign_budget_error.proto"; -import "google/ads/googleads/v9/errors/campaign_criterion_error.proto"; -import "google/ads/googleads/v9/errors/campaign_customizer_error.proto"; -import "google/ads/googleads/v9/errors/campaign_draft_error.proto"; -import "google/ads/googleads/v9/errors/campaign_error.proto"; -import "google/ads/googleads/v9/errors/campaign_experiment_error.proto"; -import "google/ads/googleads/v9/errors/campaign_feed_error.proto"; -import "google/ads/googleads/v9/errors/campaign_shared_set_error.proto"; -import "google/ads/googleads/v9/errors/change_event_error.proto"; -import "google/ads/googleads/v9/errors/change_status_error.proto"; -import "google/ads/googleads/v9/errors/collection_size_error.proto"; -import "google/ads/googleads/v9/errors/context_error.proto"; -import "google/ads/googleads/v9/errors/conversion_action_error.proto"; -import "google/ads/googleads/v9/errors/conversion_adjustment_upload_error.proto"; -import "google/ads/googleads/v9/errors/conversion_custom_variable_error.proto"; -import "google/ads/googleads/v9/errors/conversion_upload_error.proto"; -import "google/ads/googleads/v9/errors/conversion_value_rule_error.proto"; -import "google/ads/googleads/v9/errors/conversion_value_rule_set_error.proto"; -import "google/ads/googleads/v9/errors/country_code_error.proto"; -import "google/ads/googleads/v9/errors/criterion_error.proto"; -import "google/ads/googleads/v9/errors/currency_code_error.proto"; -import "google/ads/googleads/v9/errors/custom_audience_error.proto"; -import "google/ads/googleads/v9/errors/custom_conversion_goal_error.proto"; -import "google/ads/googleads/v9/errors/custom_interest_error.proto"; -import "google/ads/googleads/v9/errors/customer_client_link_error.proto"; -import "google/ads/googleads/v9/errors/customer_customizer_error.proto"; -import "google/ads/googleads/v9/errors/customer_error.proto"; -import "google/ads/googleads/v9/errors/customer_feed_error.proto"; -import "google/ads/googleads/v9/errors/customer_manager_link_error.proto"; -import "google/ads/googleads/v9/errors/customer_user_access_error.proto"; -import "google/ads/googleads/v9/errors/customizer_attribute_error.proto"; -import "google/ads/googleads/v9/errors/database_error.proto"; -import "google/ads/googleads/v9/errors/date_error.proto"; -import "google/ads/googleads/v9/errors/date_range_error.proto"; -import "google/ads/googleads/v9/errors/distinct_error.proto"; -import "google/ads/googleads/v9/errors/enum_error.proto"; -import "google/ads/googleads/v9/errors/extension_feed_item_error.proto"; -import "google/ads/googleads/v9/errors/extension_setting_error.proto"; -import "google/ads/googleads/v9/errors/feed_attribute_reference_error.proto"; -import "google/ads/googleads/v9/errors/feed_error.proto"; -import "google/ads/googleads/v9/errors/feed_item_error.proto"; -import "google/ads/googleads/v9/errors/feed_item_set_error.proto"; -import "google/ads/googleads/v9/errors/feed_item_set_link_error.proto"; -import "google/ads/googleads/v9/errors/feed_item_target_error.proto"; -import "google/ads/googleads/v9/errors/feed_item_validation_error.proto"; -import "google/ads/googleads/v9/errors/feed_mapping_error.proto"; -import "google/ads/googleads/v9/errors/field_error.proto"; -import "google/ads/googleads/v9/errors/field_mask_error.proto"; -import "google/ads/googleads/v9/errors/function_error.proto"; -import "google/ads/googleads/v9/errors/function_parsing_error.proto"; -import "google/ads/googleads/v9/errors/geo_target_constant_suggestion_error.proto"; -import "google/ads/googleads/v9/errors/header_error.proto"; -import "google/ads/googleads/v9/errors/id_error.proto"; -import "google/ads/googleads/v9/errors/image_error.proto"; -import "google/ads/googleads/v9/errors/internal_error.proto"; -import "google/ads/googleads/v9/errors/invoice_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_ad_group_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_ad_group_keyword_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_campaign_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_campaign_keyword_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_error.proto"; -import "google/ads/googleads/v9/errors/keyword_plan_idea_error.proto"; -import "google/ads/googleads/v9/errors/label_error.proto"; -import "google/ads/googleads/v9/errors/language_code_error.proto"; -import "google/ads/googleads/v9/errors/list_operation_error.proto"; -import "google/ads/googleads/v9/errors/manager_link_error.proto"; -import "google/ads/googleads/v9/errors/media_bundle_error.proto"; -import "google/ads/googleads/v9/errors/media_file_error.proto"; -import "google/ads/googleads/v9/errors/media_upload_error.proto"; -import "google/ads/googleads/v9/errors/merchant_center_error.proto"; -import "google/ads/googleads/v9/errors/multiplier_error.proto"; -import "google/ads/googleads/v9/errors/mutate_error.proto"; -import "google/ads/googleads/v9/errors/new_resource_creation_error.proto"; -import "google/ads/googleads/v9/errors/not_allowlisted_error.proto"; -import "google/ads/googleads/v9/errors/not_empty_error.proto"; -import "google/ads/googleads/v9/errors/null_error.proto"; -import "google/ads/googleads/v9/errors/offline_user_data_job_error.proto"; -import "google/ads/googleads/v9/errors/operation_access_denied_error.proto"; -import "google/ads/googleads/v9/errors/operator_error.proto"; -import "google/ads/googleads/v9/errors/partial_failure_error.proto"; -import "google/ads/googleads/v9/errors/payments_account_error.proto"; -import "google/ads/googleads/v9/errors/policy_finding_error.proto"; -import "google/ads/googleads/v9/errors/policy_validation_parameter_error.proto"; -import "google/ads/googleads/v9/errors/policy_violation_error.proto"; -import "google/ads/googleads/v9/errors/query_error.proto"; -import "google/ads/googleads/v9/errors/quota_error.proto"; -import "google/ads/googleads/v9/errors/range_error.proto"; -import "google/ads/googleads/v9/errors/reach_plan_error.proto"; -import "google/ads/googleads/v9/errors/recommendation_error.proto"; -import "google/ads/googleads/v9/errors/region_code_error.proto"; -import "google/ads/googleads/v9/errors/request_error.proto"; -import "google/ads/googleads/v9/errors/resource_access_denied_error.proto"; -import "google/ads/googleads/v9/errors/resource_count_limit_exceeded_error.proto"; -import "google/ads/googleads/v9/errors/setting_error.proto"; -import "google/ads/googleads/v9/errors/shared_criterion_error.proto"; -import "google/ads/googleads/v9/errors/shared_set_error.proto"; -import "google/ads/googleads/v9/errors/size_limit_error.proto"; -import "google/ads/googleads/v9/errors/string_format_error.proto"; -import "google/ads/googleads/v9/errors/string_length_error.proto"; -import "google/ads/googleads/v9/errors/third_party_app_analytics_link_error.proto"; -import "google/ads/googleads/v9/errors/time_zone_error.proto"; -import "google/ads/googleads/v9/errors/url_field_error.proto"; -import "google/ads/googleads/v9/errors/user_data_error.proto"; -import "google/ads/googleads/v9/errors/user_list_error.proto"; -import "google/ads/googleads/v9/errors/youtube_video_registration_error.proto"; +package google.ads.googleads.v12.errors; + +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/common/value.proto"; +import "google/ads/googleads/v12/enums/resource_limit_type.proto"; +import "google/ads/googleads/v12/errors/access_invitation_error.proto"; +import "google/ads/googleads/v12/errors/account_budget_proposal_error.proto"; +import "google/ads/googleads/v12/errors/account_link_error.proto"; +import "google/ads/googleads/v12/errors/ad_customizer_error.proto"; +import "google/ads/googleads/v12/errors/ad_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_ad_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_bid_modifier_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_criterion_customizer_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_criterion_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_customizer_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_error.proto"; +import "google/ads/googleads/v12/errors/ad_group_feed_error.proto"; +import "google/ads/googleads/v12/errors/ad_parameter_error.proto"; +import "google/ads/googleads/v12/errors/ad_sharing_error.proto"; +import "google/ads/googleads/v12/errors/adx_error.proto"; +import "google/ads/googleads/v12/errors/asset_error.proto"; +import "google/ads/googleads/v12/errors/asset_group_asset_error.proto"; +import "google/ads/googleads/v12/errors/asset_group_error.proto"; +import "google/ads/googleads/v12/errors/asset_group_listing_group_filter_error.proto"; +import "google/ads/googleads/v12/errors/asset_link_error.proto"; +import "google/ads/googleads/v12/errors/asset_set_asset_error.proto"; +import "google/ads/googleads/v12/errors/asset_set_error.proto"; +import "google/ads/googleads/v12/errors/asset_set_link_error.proto"; +import "google/ads/googleads/v12/errors/audience_error.proto"; +import "google/ads/googleads/v12/errors/audience_insights_error.proto"; +import "google/ads/googleads/v12/errors/authentication_error.proto"; +import "google/ads/googleads/v12/errors/authorization_error.proto"; +import "google/ads/googleads/v12/errors/batch_job_error.proto"; +import "google/ads/googleads/v12/errors/bidding_error.proto"; +import "google/ads/googleads/v12/errors/bidding_strategy_error.proto"; +import "google/ads/googleads/v12/errors/billing_setup_error.proto"; +import "google/ads/googleads/v12/errors/campaign_budget_error.proto"; +import "google/ads/googleads/v12/errors/campaign_conversion_goal_error.proto"; +import "google/ads/googleads/v12/errors/campaign_criterion_error.proto"; +import "google/ads/googleads/v12/errors/campaign_customizer_error.proto"; +import "google/ads/googleads/v12/errors/campaign_draft_error.proto"; +import "google/ads/googleads/v12/errors/campaign_error.proto"; +import "google/ads/googleads/v12/errors/campaign_experiment_error.proto"; +import "google/ads/googleads/v12/errors/campaign_feed_error.proto"; +import "google/ads/googleads/v12/errors/campaign_shared_set_error.proto"; +import "google/ads/googleads/v12/errors/change_event_error.proto"; +import "google/ads/googleads/v12/errors/change_status_error.proto"; +import "google/ads/googleads/v12/errors/collection_size_error.proto"; +import "google/ads/googleads/v12/errors/context_error.proto"; +import "google/ads/googleads/v12/errors/conversion_action_error.proto"; +import "google/ads/googleads/v12/errors/conversion_adjustment_upload_error.proto"; +import "google/ads/googleads/v12/errors/conversion_custom_variable_error.proto"; +import "google/ads/googleads/v12/errors/conversion_goal_campaign_config_error.proto"; +import "google/ads/googleads/v12/errors/conversion_upload_error.proto"; +import "google/ads/googleads/v12/errors/conversion_value_rule_error.proto"; +import "google/ads/googleads/v12/errors/conversion_value_rule_set_error.proto"; +import "google/ads/googleads/v12/errors/country_code_error.proto"; +import "google/ads/googleads/v12/errors/criterion_error.proto"; +import "google/ads/googleads/v12/errors/currency_code_error.proto"; +import "google/ads/googleads/v12/errors/custom_audience_error.proto"; +import "google/ads/googleads/v12/errors/custom_conversion_goal_error.proto"; +import "google/ads/googleads/v12/errors/custom_interest_error.proto"; +import "google/ads/googleads/v12/errors/customer_client_link_error.proto"; +import "google/ads/googleads/v12/errors/customer_customizer_error.proto"; +import "google/ads/googleads/v12/errors/customer_error.proto"; +import "google/ads/googleads/v12/errors/customer_feed_error.proto"; +import "google/ads/googleads/v12/errors/customer_manager_link_error.proto"; +import "google/ads/googleads/v12/errors/customer_user_access_error.proto"; +import "google/ads/googleads/v12/errors/customizer_attribute_error.proto"; +import "google/ads/googleads/v12/errors/database_error.proto"; +import "google/ads/googleads/v12/errors/date_error.proto"; +import "google/ads/googleads/v12/errors/date_range_error.proto"; +import "google/ads/googleads/v12/errors/distinct_error.proto"; +import "google/ads/googleads/v12/errors/enum_error.proto"; +import "google/ads/googleads/v12/errors/experiment_arm_error.proto"; +import "google/ads/googleads/v12/errors/experiment_error.proto"; +import "google/ads/googleads/v12/errors/extension_feed_item_error.proto"; +import "google/ads/googleads/v12/errors/extension_setting_error.proto"; +import "google/ads/googleads/v12/errors/feed_attribute_reference_error.proto"; +import "google/ads/googleads/v12/errors/feed_error.proto"; +import "google/ads/googleads/v12/errors/feed_item_error.proto"; +import "google/ads/googleads/v12/errors/feed_item_set_error.proto"; +import "google/ads/googleads/v12/errors/feed_item_set_link_error.proto"; +import "google/ads/googleads/v12/errors/feed_item_target_error.proto"; +import "google/ads/googleads/v12/errors/feed_item_validation_error.proto"; +import "google/ads/googleads/v12/errors/feed_mapping_error.proto"; +import "google/ads/googleads/v12/errors/field_error.proto"; +import "google/ads/googleads/v12/errors/field_mask_error.proto"; +import "google/ads/googleads/v12/errors/function_error.proto"; +import "google/ads/googleads/v12/errors/function_parsing_error.proto"; +import "google/ads/googleads/v12/errors/geo_target_constant_suggestion_error.proto"; +import "google/ads/googleads/v12/errors/header_error.proto"; +import "google/ads/googleads/v12/errors/id_error.proto"; +import "google/ads/googleads/v12/errors/image_error.proto"; +import "google/ads/googleads/v12/errors/internal_error.proto"; +import "google/ads/googleads/v12/errors/invoice_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_ad_group_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_ad_group_keyword_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_campaign_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_campaign_keyword_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_error.proto"; +import "google/ads/googleads/v12/errors/keyword_plan_idea_error.proto"; +import "google/ads/googleads/v12/errors/label_error.proto"; +import "google/ads/googleads/v12/errors/language_code_error.proto"; +import "google/ads/googleads/v12/errors/list_operation_error.proto"; +import "google/ads/googleads/v12/errors/manager_link_error.proto"; +import "google/ads/googleads/v12/errors/media_bundle_error.proto"; +import "google/ads/googleads/v12/errors/media_file_error.proto"; +import "google/ads/googleads/v12/errors/media_upload_error.proto"; +import "google/ads/googleads/v12/errors/merchant_center_error.proto"; +import "google/ads/googleads/v12/errors/multiplier_error.proto"; +import "google/ads/googleads/v12/errors/mutate_error.proto"; +import "google/ads/googleads/v12/errors/new_resource_creation_error.proto"; +import "google/ads/googleads/v12/errors/not_allowlisted_error.proto"; +import "google/ads/googleads/v12/errors/not_empty_error.proto"; +import "google/ads/googleads/v12/errors/null_error.proto"; +import "google/ads/googleads/v12/errors/offline_user_data_job_error.proto"; +import "google/ads/googleads/v12/errors/operation_access_denied_error.proto"; +import "google/ads/googleads/v12/errors/operator_error.proto"; +import "google/ads/googleads/v12/errors/partial_failure_error.proto"; +import "google/ads/googleads/v12/errors/payments_account_error.proto"; +import "google/ads/googleads/v12/errors/policy_finding_error.proto"; +import "google/ads/googleads/v12/errors/policy_validation_parameter_error.proto"; +import "google/ads/googleads/v12/errors/policy_violation_error.proto"; +import "google/ads/googleads/v12/errors/query_error.proto"; +import "google/ads/googleads/v12/errors/quota_error.proto"; +import "google/ads/googleads/v12/errors/range_error.proto"; +import "google/ads/googleads/v12/errors/reach_plan_error.proto"; +import "google/ads/googleads/v12/errors/recommendation_error.proto"; +import "google/ads/googleads/v12/errors/region_code_error.proto"; +import "google/ads/googleads/v12/errors/request_error.proto"; +import "google/ads/googleads/v12/errors/resource_access_denied_error.proto"; +import "google/ads/googleads/v12/errors/resource_count_limit_exceeded_error.proto"; +import "google/ads/googleads/v12/errors/setting_error.proto"; +import "google/ads/googleads/v12/errors/shared_criterion_error.proto"; +import "google/ads/googleads/v12/errors/shared_set_error.proto"; +import "google/ads/googleads/v12/errors/size_limit_error.proto"; +import "google/ads/googleads/v12/errors/smart_campaign_error.proto"; +import "google/ads/googleads/v12/errors/string_format_error.proto"; +import "google/ads/googleads/v12/errors/string_length_error.proto"; +import "google/ads/googleads/v12/errors/third_party_app_analytics_link_error.proto"; +import "google/ads/googleads/v12/errors/time_zone_error.proto"; +import "google/ads/googleads/v12/errors/url_field_error.proto"; +import "google/ads/googleads/v12/errors/user_data_error.proto"; +import "google/ads/googleads/v12/errors/user_list_error.proto"; +import "google/ads/googleads/v12/errors/youtube_video_registration_error.proto"; import "google/protobuf/duration.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ErrorsProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing the common error protos @@ -186,7 +192,7 @@ message GoogleAdsError { string message = 2; // The value that triggered the error. - google.ads.googleads.v9.common.Value trigger = 3; + google.ads.googleads.v12.common.Value trigger = 3; // Describes the part of the request proto that caused the error. ErrorLocation location = 4; @@ -293,12 +299,18 @@ message ErrorCode { // The reasons for the campaign criterion error CampaignCriterionErrorEnum.CampaignCriterionError campaign_criterion_error = 29; + // The reasons for the campaign conversion goal error + CampaignConversionGoalErrorEnum.CampaignConversionGoalError campaign_conversion_goal_error = 166; + // The reasons for the campaign customizer error. 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; + // The reasons for the country code error CountryCodeErrorEnum.CountryCodeError country_code_error = 109; @@ -566,6 +578,9 @@ message ErrorCode { // The reasons for the currency code error CurrencyCodeErrorEnum.CurrencyCodeError currency_code_error = 122; + // The reasons for the experiment error + ExperimentErrorEnum.ExperimentError experiment_error = 123; + // The reasons for the access invitation error AccessInvitationErrorEnum.AccessInvitationError access_invitation_error = 124; @@ -601,6 +616,18 @@ message ErrorCode { // The reasons for the custom audience error CustomAudienceErrorEnum.CustomAudienceError custom_audience_error = 139; + + // 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; } } @@ -648,7 +675,7 @@ message PolicyViolationDetails { // Unique identifier for this violation. // If policy is exemptible, this key may be used to request exemption. - google.ads.googleads.v9.common.PolicyViolationKey key = 4; + google.ads.googleads.v12.common.PolicyViolationKey key = 4; // Human readable name of the policy. string external_policy_name = 5; @@ -664,7 +691,7 @@ 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.v9.common.PolicyTopicEntry policy_topic_entries = 1; + repeated google.ads.googleads.v12.common.PolicyTopicEntry policy_topic_entries = 1; } // Additional quota error details when there is QuotaError. @@ -709,7 +736,7 @@ message ResourceCountDetails { int32 limit = 2; // The resource limit type which was exceeded. - google.ads.googleads.v9.enums.ResourceLimitTypeEnum.ResourceLimitType limit_type = 3; + google.ads.googleads.v12.enums.ResourceLimitTypeEnum.ResourceLimitType limit_type = 3; // The count of existing entities. int32 existing_count = 4; diff --git a/google/ads/googleads/v12/errors/experiment_arm_error.proto b/google/ads/googleads/v12/errors/experiment_arm_error.proto new file mode 100644 index 000000000..1e2232ad4 --- /dev/null +++ b/google/ads/googleads/v12/errors/experiment_arm_error.proto @@ -0,0 +1,86 @@ +// 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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentArmErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; + +// Proto file describing experiment arm errors. + +// Container for enum describing possible experiment arm error. +message ExperimentArmErrorEnum { + // Enum describing possible experiment arm errors. + enum ExperimentArmError { + // Enum unspecified. + UNSPECIFIED = 0; + + // The received error code is not known in this version. + UNKNOWN = 1; + + // Number of experiment arms is above limit. + EXPERIMENT_ARM_COUNT_LIMIT_EXCEEDED = 2; + + // Cannot add campaign with invalid status to the experiment arm. + INVALID_CAMPAIGN_STATUS = 3; + + // Cannot add duplicate experiment arm name in one experiment. + DUPLICATE_EXPERIMENT_ARM_NAME = 4; + + // Cannot set campaigns of treatment experiment arm. + CANNOT_SET_TREATMENT_ARM_CAMPAIGN = 5; + + // Cannot edit campaign ids in trial arms in non SETUP experiment. + CANNOT_MODIFY_CAMPAIGN_IDS = 6; + + // Cannot modify the campaigns in the control arm + // if there is not a suffix set in the trial. + CANNOT_MODIFY_CAMPAIGN_WITHOUT_SUFFIX_SET = 7; + + // Traffic split related settings (like traffic share bounds) can't be + // modified after the trial has started. + CANNOT_MUTATE_TRAFFIC_SPLIT_AFTER_START = 8; + + // Cannot use shared budget on experiment's control campaign. + CANNOT_ADD_CAMPAIGN_WITH_SHARED_BUDGET = 9; + + // Cannot use custom budget on experiment's control campaigns. + CANNOT_ADD_CAMPAIGN_WITH_CUSTOM_BUDGET = 10; + + // Cannot have enable_dynamic_assets turned on in experiment's campaigns. + CANNOT_ADD_CAMPAIGNS_WITH_DYNAMIC_ASSETS_ENABLED = 11; + + // Cannot use campaign's advertising channel sub type in experiment. + UNSUPPORTED_CAMPAIGN_ADVERTISING_CHANNEL_SUB_TYPE = 12; + + // Experiment date range must be within base campaign's date range. + CANNOT_ADD_BASE_CAMPAIGN_WITH_DATE_RANGE = 13; + + // Bidding strategy is not supported in experiments. + BIDDING_STRATEGY_NOT_SUPPORTED_IN_EXPERIMENTS = 14; + + // Traffic split is not supported for some channel types. + TRAFFIC_SPLIT_NOT_SUPPORTED_FOR_CHANNEL_TYPE = 15; + } + + +} diff --git a/google/ads/googleads/v12/errors/experiment_error.proto b/google/ads/googleads/v12/errors/experiment_error.proto new file mode 100644 index 000000000..3a5b12f32 --- /dev/null +++ b/google/ads/googleads/v12/errors/experiment_error.proto @@ -0,0 +1,120 @@ +// 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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; + +// Proto file describing experiment errors. + +// Container for enum describing possible experiment error. +message ExperimentErrorEnum { + // Enum describing possible experiment errors. + enum ExperimentError { + // Enum unspecified. + UNSPECIFIED = 0; + + // The received error code is not known in this version. + UNKNOWN = 1; + + // The start date of an experiment cannot be set in the past. + // 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. + // 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. + // 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. + DUPLICATE_EXPERIMENT_NAME = 5; + + // Experiments can only be modified when they are ENABLED. + CANNOT_MODIFY_REMOVED_EXPERIMENT = 6; + + // The start date of an experiment cannot be modified if the existing start + // date has already passed. + START_DATE_ALREADY_PASSED = 7; + + // The end date of an experiment cannot be set in the past. + CANNOT_SET_END_DATE_IN_PAST = 8; + + // The status of an experiment cannot be set to REMOVED. + CANNOT_SET_STATUS_TO_REMOVED = 9; + + // The end date of an expired experiment cannot be modified. + CANNOT_MODIFY_PAST_END_DATE = 10; + + // The status is invalid. + INVALID_STATUS = 11; + + // Experiment arm contains campaigns with invalid advertising channel type. + INVALID_CAMPAIGN_CHANNEL_TYPE = 12; + + // A pair of trials share members and have overlapping date ranges. + OVERLAPPING_MEMBERS_AND_DATE_RANGE = 13; + + // Experiment arm contains invalid traffic split. + INVALID_TRIAL_ARM_TRAFFIC_SPLIT = 14; + + // Experiment contains trial arms with overlapping traffic split. + TRAFFIC_SPLIT_OVERLAPPING = 15; + + // The total traffic split of trial arms is not equal to 100. + SUM_TRIAL_ARM_TRAFFIC_UNEQUALS_TO_TRIAL_TRAFFIC_SPLIT_DENOMINATOR = 16; + + // Traffic split related settings (like traffic share bounds) can't be + // modified after the experiment has started. + CANNOT_MODIFY_TRAFFIC_SPLIT_AFTER_START = 17; + + // The experiment could not be found. + EXPERIMENT_NOT_FOUND = 18; + + // Experiment has not begun. + EXPERIMENT_NOT_YET_STARTED = 19; + + // The experiment cannot have more than one control arm. + CANNOT_HAVE_MULTIPLE_CONTROL_ARMS = 20; + + // The experiment doesn't set in-design campaigns. + IN_DESIGN_CAMPAIGNS_NOT_SET = 21; + + // Clients must use the graduate action to graduate experiments and cannot + // set the status to GRADUATED directly. + CANNOT_SET_STATUS_TO_GRADUATED = 22; + + // Cannot use shared budget on base campaign when scheduling an experiment. + CANNOT_CREATE_EXPERIMENT_CAMPAIGN_WITH_SHARED_BUDGET = 23; + + // Cannot use custom budget on base campaign when scheduling an experiment. + CANNOT_CREATE_EXPERIMENT_CAMPAIGN_WITH_CUSTOM_BUDGET = 24; + + // Invalid status transition. + STATUS_TRANSITION_INVALID = 25; + } + + +} diff --git a/google/ads/googleads/v9/errors/extension_feed_item_error.proto b/google/ads/googleads/v12/errors/extension_feed_item_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/extension_feed_item_error.proto rename to google/ads/googleads/v12/errors/extension_feed_item_error.proto index 11913cae3..e6157c1a4 100644 --- a/google/ads/googleads/v9/errors/extension_feed_item_error.proto +++ b/google/ads/googleads/v12/errors/extension_feed_item_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ExtensionFeedItemErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing extension feed item errors. @@ -77,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. @@ -93,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; @@ -138,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. @@ -162,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; diff --git a/google/ads/googleads/v9/errors/extension_setting_error.proto b/google/ads/googleads/v12/errors/extension_setting_error.proto similarity index 92% rename from google/ads/googleads/v9/errors/extension_setting_error.proto rename to google/ads/googleads/v12/errors/extension_setting_error.proto index caf8220b6..4eccf7b28 100644 --- a/google/ads/googleads/v9/errors/extension_setting_error.proto +++ b/google/ads/googleads/v12/errors/extension_setting_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ExtensionSettingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing extension setting validation errors. @@ -118,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. @@ -176,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. @@ -245,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; diff --git a/google/ads/googleads/v9/errors/feed_attribute_reference_error.proto b/google/ads/googleads/v12/errors/feed_attribute_reference_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/feed_attribute_reference_error.proto rename to google/ads/googleads/v12/errors/feed_attribute_reference_error.proto index c07b8989d..28de97bbd 100644 --- a/google/ads/googleads/v9/errors/feed_attribute_reference_error.proto +++ b/google/ads/googleads/v12/errors/feed_attribute_reference_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedAttributeReferenceErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed attribute reference errors. diff --git a/google/ads/googleads/v9/errors/feed_error.proto b/google/ads/googleads/v12/errors/feed_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/feed_error.proto rename to google/ads/googleads/v12/errors/feed_error.proto index b8d67cd35..5283021b2 100644 --- a/google/ads/googleads/v9/errors/feed_error.proto +++ b/google/ads/googleads/v12/errors/feed_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed errors. diff --git a/google/ads/googleads/v9/errors/feed_item_error.proto b/google/ads/googleads/v12/errors/feed_item_error.proto similarity index 82% rename from google/ads/googleads/v9/errors/feed_item_error.proto rename to google/ads/googleads/v12/errors/feed_item_error.proto index 01ffbdffc..d0eb21043 100644 --- a/google/ads/googleads/v9/errors/feed_item_error.proto +++ b/google/ads/googleads/v12/errors/feed_item_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedItemErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item errors. @@ -65,6 +63,9 @@ 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/google/ads/googleads/v9/errors/feed_item_set_error.proto b/google/ads/googleads/v12/errors/feed_item_set_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/feed_item_set_error.proto rename to google/ads/googleads/v12/errors/feed_item_set_error.proto index 2a60ec46c..3de5d8127 100644 --- a/google/ads/googleads/v9/errors/feed_item_set_error.proto +++ b/google/ads/googleads/v12/errors/feed_item_set_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item set errors. diff --git a/google/ads/googleads/v9/errors/feed_item_set_link_error.proto b/google/ads/googleads/v12/errors/feed_item_set_link_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/feed_item_set_link_error.proto rename to google/ads/googleads/v12/errors/feed_item_set_link_error.proto index 76e26c26d..041cfeab6 100644 --- a/google/ads/googleads/v9/errors/feed_item_set_link_error.proto +++ b/google/ads/googleads/v12/errors/feed_item_set_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item set link errors. diff --git a/google/ads/googleads/v9/errors/feed_item_target_error.proto b/google/ads/googleads/v12/errors/feed_item_target_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/feed_item_target_error.proto rename to google/ads/googleads/v12/errors/feed_item_target_error.proto index 77188f214..a4007b7e1 100644 --- a/google/ads/googleads/v9/errors/feed_item_target_error.proto +++ b/google/ads/googleads/v12/errors/feed_item_target_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item target errors. diff --git a/google/ads/googleads/v9/errors/feed_item_validation_error.proto b/google/ads/googleads/v12/errors/feed_item_validation_error.proto similarity index 95% rename from google/ads/googleads/v9/errors/feed_item_validation_error.proto rename to google/ads/googleads/v12/errors/feed_item_validation_error.proto index 135d9d277..a0d109171 100644 --- a/google/ads/googleads/v9/errors/feed_item_validation_error.proto +++ b/google/ads/googleads/v12/errors/feed_item_validation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedItemValidationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item validation errors. @@ -176,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; @@ -300,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; diff --git a/google/ads/googleads/v9/errors/feed_mapping_error.proto b/google/ads/googleads/v12/errors/feed_mapping_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/feed_mapping_error.proto rename to google/ads/googleads/v12/errors/feed_mapping_error.proto index 44e5834b8..16eef41be 100644 --- a/google/ads/googleads/v9/errors/feed_mapping_error.proto +++ b/google/ads/googleads/v12/errors/feed_mapping_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FeedMappingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing feed item errors. @@ -94,6 +92,9 @@ 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/google/ads/googleads/v9/errors/field_error.proto b/google/ads/googleads/v12/errors/field_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/field_error.proto rename to google/ads/googleads/v12/errors/field_error.proto index 36ad3b5e5..164169cbe 100644 --- a/google/ads/googleads/v9/errors/field_error.proto +++ b/google/ads/googleads/v12/errors/field_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FieldErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing field errors. @@ -59,6 +57,9 @@ 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/google/ads/googleads/v9/errors/field_mask_error.proto b/google/ads/googleads/v12/errors/field_mask_error.proto similarity index 81% rename from google/ads/googleads/v9/errors/field_mask_error.proto rename to google/ads/googleads/v12/errors/field_mask_error.proto index 218708ff9..23baaf26f 100644 --- a/google/ads/googleads/v9/errors/field_mask_error.proto +++ b/google/ads/googleads/v12/errors/field_mask_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FieldMaskErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing field mask errors. diff --git a/google/ads/googleads/v9/errors/function_error.proto b/google/ads/googleads/v12/errors/function_error.proto similarity index 86% rename from google/ads/googleads/v9/errors/function_error.proto rename to google/ads/googleads/v12/errors/function_error.proto index 01d909832..b11d64c90 100644 --- a/google/ads/googleads/v9/errors/function_error.proto +++ b/google/ads/googleads/v12/errors/function_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FunctionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing function errors. diff --git a/google/ads/googleads/v9/errors/function_parsing_error.proto b/google/ads/googleads/v12/errors/function_parsing_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/function_parsing_error.proto rename to google/ads/googleads/v12/errors/function_parsing_error.proto index 0e48eec6f..08e141354 100644 --- a/google/ads/googleads/v9/errors/function_parsing_error.proto +++ b/google/ads/googleads/v12/errors/function_parsing_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "FunctionParsingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing function parsing errors. diff --git a/google/ads/googleads/v9/errors/geo_target_constant_suggestion_error.proto b/google/ads/googleads/v12/errors/geo_target_constant_suggestion_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/geo_target_constant_suggestion_error.proto rename to google/ads/googleads/v12/errors/geo_target_constant_suggestion_error.proto index 7ece814bc..f1681cc37 100644 --- a/google/ads/googleads/v9/errors/geo_target_constant_suggestion_error.proto +++ b/google/ads/googleads/v12/errors/geo_target_constant_suggestion_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "GeoTargetConstantSuggestionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Container for enum describing possible geo target constant suggestion errors. message GeoTargetConstantSuggestionErrorEnum { diff --git a/google/ads/googleads/v9/errors/header_error.proto b/google/ads/googleads/v12/errors/header_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/header_error.proto rename to google/ads/googleads/v12/errors/header_error.proto index b02d10148..782e55b68 100644 --- a/google/ads/googleads/v9/errors/header_error.proto +++ b/google/ads/googleads/v12/errors/header_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "HeaderErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing header errors. diff --git a/google/ads/googleads/v9/errors/id_error.proto b/google/ads/googleads/v12/errors/id_error.proto similarity index 66% rename from google/ads/googleads/v9/errors/id_error.proto rename to google/ads/googleads/v12/errors/id_error.proto index 2a528913d..c7a274ac7 100644 --- a/google/ads/googleads/v9/errors/id_error.proto +++ b/google/ads/googleads/v12/errors/id_error.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. @@ -14,24 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "IdErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::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; @@ -39,7 +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/google/ads/googleads/v9/errors/image_error.proto b/google/ads/googleads/v12/errors/image_error.proto similarity index 91% rename from google/ads/googleads/v9/errors/image_error.proto rename to google/ads/googleads/v12/errors/image_error.proto index e27011416..a6101551e 100644 --- a/google/ads/googleads/v9/errors/image_error.proto +++ b/google/ads/googleads/v12/errors/image_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ImageErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing image errors. diff --git a/google/ads/googleads/v9/errors/internal_error.proto b/google/ads/googleads/v12/errors/internal_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/internal_error.proto rename to google/ads/googleads/v12/errors/internal_error.proto index 3018ec60d..742cdd809 100644 --- a/google/ads/googleads/v9/errors/internal_error.proto +++ b/google/ads/googleads/v12/errors/internal_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "InternalErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing internal errors. diff --git a/google/ads/googleads/v9/errors/invoice_error.proto b/google/ads/googleads/v12/errors/invoice_error.proto similarity index 81% rename from google/ads/googleads/v9/errors/invoice_error.proto rename to google/ads/googleads/v12/errors/invoice_error.proto index 9d5dcf29e..db278b33c 100644 --- a/google/ads/googleads/v9/errors/invoice_error.proto +++ b/google/ads/googleads/v12/errors/invoice_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "InvoiceErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing invoice errors. diff --git a/google/ads/googleads/v9/errors/keyword_plan_ad_group_error.proto b/google/ads/googleads/v12/errors/keyword_plan_ad_group_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/keyword_plan_ad_group_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_ad_group_error.proto index 29cd9fbca..d877db5e2 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_ad_group_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_ad_group_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying a keyword plan ad group. diff --git a/google/ads/googleads/v9/errors/keyword_plan_ad_group_keyword_error.proto b/google/ads/googleads/v12/errors/keyword_plan_ad_group_keyword_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/keyword_plan_ad_group_keyword_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_ad_group_keyword_error.proto index e13a35616..f5e461319 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_ad_group_keyword_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_ad_group_keyword_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupKeywordErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying a keyword plan ad group keyword or // keyword plan campaign keyword. diff --git a/google/ads/googleads/v9/errors/keyword_plan_campaign_error.proto b/google/ads/googleads/v12/errors/keyword_plan_campaign_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/keyword_plan_campaign_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_campaign_error.proto index 21ed4ac6b..403ee9c19 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_campaign_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_campaign_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying a keyword plan campaign. diff --git a/google/ads/googleads/v9/errors/keyword_plan_campaign_keyword_error.proto b/google/ads/googleads/v12/errors/keyword_plan_campaign_keyword_error.proto similarity index 78% rename from google/ads/googleads/v9/errors/keyword_plan_campaign_keyword_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_campaign_keyword_error.proto index a4759e2c3..765f41891 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_campaign_keyword_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_campaign_keyword_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignKeywordErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying a keyword plan campaign keyword. diff --git a/google/ads/googleads/v9/errors/keyword_plan_error.proto b/google/ads/googleads/v12/errors/keyword_plan_error.proto similarity index 87% rename from google/ads/googleads/v9/errors/keyword_plan_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_error.proto index 7706490cc..1affcac38 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying keyword plan resources (keyword // plan, keyword plan campaign, keyword plan ad group or keyword plan keyword) diff --git a/google/ads/googleads/v9/errors/keyword_plan_idea_error.proto b/google/ads/googleads/v12/errors/keyword_plan_idea_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/keyword_plan_idea_error.proto rename to google/ads/googleads/v12/errors/keyword_plan_idea_error.proto index be00b8b00..fffa56154 100644 --- a/google/ads/googleads/v9/errors/keyword_plan_idea_error.proto +++ b/google/ads/googleads/v12/errors/keyword_plan_idea_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanIdeaErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from KeywordPlanIdeaService. diff --git a/google/ads/googleads/v9/errors/label_error.proto b/google/ads/googleads/v12/errors/label_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/label_error.proto rename to google/ads/googleads/v12/errors/label_error.proto index 4c7b6be06..59a2ae445 100644 --- a/google/ads/googleads/v9/errors/label_error.proto +++ b/google/ads/googleads/v12/errors/label_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "LabelErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing label errors. diff --git a/google/ads/googleads/v9/errors/language_code_error.proto b/google/ads/googleads/v12/errors/language_code_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/language_code_error.proto rename to google/ads/googleads/v12/errors/language_code_error.proto index 444a26ecd..c097809b5 100644 --- a/google/ads/googleads/v9/errors/language_code_error.proto +++ b/google/ads/googleads/v12/errors/language_code_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "LanguageCodeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing language code errors. diff --git a/google/ads/googleads/v9/errors/list_operation_error.proto b/google/ads/googleads/v12/errors/list_operation_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/list_operation_error.proto rename to google/ads/googleads/v12/errors/list_operation_error.proto index ea2c9440c..d6510df12 100644 --- a/google/ads/googleads/v9/errors/list_operation_error.proto +++ b/google/ads/googleads/v12/errors/list_operation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ListOperationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing list operation errors. diff --git a/google/ads/googleads/v9/errors/manager_link_error.proto b/google/ads/googleads/v12/errors/manager_link_error.proto similarity index 88% rename from google/ads/googleads/v9/errors/manager_link_error.proto rename to google/ads/googleads/v12/errors/manager_link_error.proto index b6f7cf371..c9a648f6f 100644 --- a/google/ads/googleads/v9/errors/manager_link_error.proto +++ b/google/ads/googleads/v12/errors/manager_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ManagerLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ManagerLink errors. diff --git a/google/ads/googleads/v9/errors/media_bundle_error.proto b/google/ads/googleads/v12/errors/media_bundle_error.proto similarity index 88% rename from google/ads/googleads/v9/errors/media_bundle_error.proto rename to google/ads/googleads/v12/errors/media_bundle_error.proto index c7bd8e0f9..90e8e7207 100644 --- a/google/ads/googleads/v9/errors/media_bundle_error.proto +++ b/google/ads/googleads/v12/errors/media_bundle_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MediaBundleErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing media bundle errors. diff --git a/google/ads/googleads/v9/errors/media_file_error.proto b/google/ads/googleads/v12/errors/media_file_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/media_file_error.proto rename to google/ads/googleads/v12/errors/media_file_error.proto index 521a63125..018fd01ec 100644 --- a/google/ads/googleads/v9/errors/media_file_error.proto +++ b/google/ads/googleads/v12/errors/media_file_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MediaFileErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing media file errors. diff --git a/google/ads/googleads/v9/errors/media_upload_error.proto b/google/ads/googleads/v12/errors/media_upload_error.proto similarity index 91% rename from google/ads/googleads/v9/errors/media_upload_error.proto rename to google/ads/googleads/v12/errors/media_upload_error.proto index 1c333e15d..aea8cbdb1 100644 --- a/google/ads/googleads/v9/errors/media_upload_error.proto +++ b/google/ads/googleads/v12/errors/media_upload_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MediaUploadErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing media uploading errors. @@ -113,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 diff --git a/google/ads/googleads/v9/errors/merchant_center_error.proto b/google/ads/googleads/v12/errors/merchant_center_error.proto similarity index 78% rename from google/ads/googleads/v9/errors/merchant_center_error.proto rename to google/ads/googleads/v12/errors/merchant_center_error.proto index b749907bd..0c50ab844 100644 --- a/google/ads/googleads/v9/errors/merchant_center_error.proto +++ b/google/ads/googleads/v12/errors/merchant_center_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MerchantCenterErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing merchant center errors. diff --git a/google/ads/googleads/v9/errors/multiplier_error.proto b/google/ads/googleads/v12/errors/multiplier_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/multiplier_error.proto rename to google/ads/googleads/v12/errors/multiplier_error.proto index 11b1e9bd7..6ca2ac8aa 100644 --- a/google/ads/googleads/v9/errors/multiplier_error.proto +++ b/google/ads/googleads/v12/errors/multiplier_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MultiplierErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing multiplier errors. @@ -51,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 @@ -73,7 +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/google/ads/googleads/v9/errors/mutate_error.proto b/google/ads/googleads/v12/errors/mutate_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/mutate_error.proto rename to google/ads/googleads/v12/errors/mutate_error.proto index f37fdc547..a07e2d4f5 100644 --- a/google/ads/googleads/v9/errors/mutate_error.proto +++ b/google/ads/googleads/v12/errors/mutate_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "MutateErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing mutate errors. diff --git a/google/ads/googleads/v9/errors/new_resource_creation_error.proto b/google/ads/googleads/v12/errors/new_resource_creation_error.proto similarity index 80% rename from google/ads/googleads/v9/errors/new_resource_creation_error.proto rename to google/ads/googleads/v12/errors/new_resource_creation_error.proto index 4761317cc..55e35eb58 100644 --- a/google/ads/googleads/v9/errors/new_resource_creation_error.proto +++ b/google/ads/googleads/v12/errors/new_resource_creation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "NewResourceCreationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing new resource creation errors. diff --git a/google/ads/googleads/v9/errors/not_allowlisted_error.proto b/google/ads/googleads/v12/errors/not_allowlisted_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/not_allowlisted_error.proto rename to google/ads/googleads/v12/errors/not_allowlisted_error.proto index 16e68680a..c0d324787 100644 --- a/google/ads/googleads/v9/errors/not_allowlisted_error.proto +++ b/google/ads/googleads/v12/errors/not_allowlisted_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "NotAllowlistedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing not allowlisted errors. diff --git a/google/ads/googleads/v9/errors/not_empty_error.proto b/google/ads/googleads/v12/errors/not_empty_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/not_empty_error.proto rename to google/ads/googleads/v12/errors/not_empty_error.proto index aae0e2892..abace8283 100644 --- a/google/ads/googleads/v9/errors/not_empty_error.proto +++ b/google/ads/googleads/v12/errors/not_empty_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "NotEmptyErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing not empty errors. diff --git a/google/ads/googleads/v9/errors/null_error.proto b/google/ads/googleads/v12/errors/null_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/null_error.proto rename to google/ads/googleads/v12/errors/null_error.proto index 161b84732..66e7a9bac 100644 --- a/google/ads/googleads/v9/errors/null_error.proto +++ b/google/ads/googleads/v12/errors/null_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "NullErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing null errors. diff --git a/google/ads/googleads/v9/errors/offline_user_data_job_error.proto b/google/ads/googleads/v12/errors/offline_user_data_job_error.proto similarity index 84% rename from google/ads/googleads/v9/errors/offline_user_data_job_error.proto rename to google/ads/googleads/v12/errors/offline_user_data_job_error.proto index 2391baaf2..fc049a1ee 100644 --- a/google/ads/googleads/v9/errors/offline_user_data_job_error.proto +++ b/google/ads/googleads/v12/errors/offline_user_data_job_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing offline user data job errors. @@ -58,7 +56,8 @@ message OfflineUserDataJobErrorEnum { // The mobile ID is malformed. INVALID_MOBILE_ID_FORMAT = 8; - // Maximum number of user identifiers allowed per request is 100,000. + // Maximum number of user identifiers allowed per request is 100,000 and per + // operation is 20. TOO_MANY_USER_IDENTIFIERS = 9; // Customer is not on the allow-list for store sales direct data. @@ -132,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 @@ -154,6 +153,20 @@ 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/google/ads/googleads/v9/errors/operation_access_denied_error.proto b/google/ads/googleads/v12/errors/operation_access_denied_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/operation_access_denied_error.proto rename to google/ads/googleads/v12/errors/operation_access_denied_error.proto index 8101b4b63..b5b506e5c 100644 --- a/google/ads/googleads/v9/errors/operation_access_denied_error.proto +++ b/google/ads/googleads/v12/errors/operation_access_denied_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "OperationAccessDeniedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing operation access denied errors. diff --git a/google/ads/googleads/v9/errors/operator_error.proto b/google/ads/googleads/v12/errors/operator_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/operator_error.proto rename to google/ads/googleads/v12/errors/operator_error.proto index f39d7e85a..926f79866 100644 --- a/google/ads/googleads/v9/errors/operator_error.proto +++ b/google/ads/googleads/v12/errors/operator_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "OperatorErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing operator errors. diff --git a/google/ads/googleads/v9/errors/partial_failure_error.proto b/google/ads/googleads/v12/errors/partial_failure_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/partial_failure_error.proto rename to google/ads/googleads/v12/errors/partial_failure_error.proto index 108e90915..509345597 100644 --- a/google/ads/googleads/v9/errors/partial_failure_error.proto +++ b/google/ads/googleads/v12/errors/partial_failure_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "PartialFailureErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing partial failure errors. diff --git a/google/ads/googleads/v9/errors/payments_account_error.proto b/google/ads/googleads/v12/errors/payments_account_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/payments_account_error.proto rename to google/ads/googleads/v12/errors/payments_account_error.proto index ac90a7078..5635d7e78 100644 --- a/google/ads/googleads/v9/errors/payments_account_error.proto +++ b/google/ads/googleads/v12/errors/payments_account_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "PaymentsAccountErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing payments account service errors. diff --git a/google/ads/googleads/v9/errors/policy_finding_error.proto b/google/ads/googleads/v12/errors/policy_finding_error.proto similarity index 78% rename from google/ads/googleads/v9/errors/policy_finding_error.proto rename to google/ads/googleads/v12/errors/policy_finding_error.proto index e6d4d8da0..40be635a0 100644 --- a/google/ads/googleads/v9/errors/policy_finding_error.proto +++ b/google/ads/googleads/v12/errors/policy_finding_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "PolicyFindingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing policy finding errors. diff --git a/google/ads/googleads/v9/errors/policy_validation_parameter_error.proto b/google/ads/googleads/v12/errors/policy_validation_parameter_error.proto similarity index 81% rename from google/ads/googleads/v9/errors/policy_validation_parameter_error.proto rename to google/ads/googleads/v12/errors/policy_validation_parameter_error.proto index d8fa0bbf6..1bbc33373 100644 --- a/google/ads/googleads/v9/errors/policy_validation_parameter_error.proto +++ b/google/ads/googleads/v12/errors/policy_validation_parameter_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "PolicyValidationParameterErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing policy validation parameter errors. diff --git a/google/ads/googleads/v9/errors/policy_violation_error.proto b/google/ads/googleads/v12/errors/policy_violation_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/policy_violation_error.proto rename to google/ads/googleads/v12/errors/policy_violation_error.proto index 31c90e410..f364ebc3f 100644 --- a/google/ads/googleads/v9/errors/policy_violation_error.proto +++ b/google/ads/googleads/v12/errors/policy_violation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "PolicyViolationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing policy violation errors. diff --git a/google/ads/googleads/v9/errors/query_error.proto b/google/ads/googleads/v12/errors/query_error.proto similarity index 92% rename from google/ads/googleads/v9/errors/query_error.proto rename to google/ads/googleads/v12/errors/query_error.proto index 8cb206840..78951f802 100644 --- a/google/ads/googleads/v9/errors/query_error.proto +++ b/google/ads/googleads/v12/errors/query_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "QueryErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing query errors. @@ -51,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. @@ -123,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. diff --git a/google/ads/googleads/v9/errors/quota_error.proto b/google/ads/googleads/v12/errors/quota_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/quota_error.proto rename to google/ads/googleads/v12/errors/quota_error.proto index 9993344da..afb567696 100644 --- a/google/ads/googleads/v9/errors/quota_error.proto +++ b/google/ads/googleads/v12/errors/quota_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "QuotaErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing quota errors. diff --git a/google/ads/googleads/v9/errors/range_error.proto b/google/ads/googleads/v12/errors/range_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/range_error.proto rename to google/ads/googleads/v12/errors/range_error.proto index 9bab3f87f..13b87ec4b 100644 --- a/google/ads/googleads/v9/errors/range_error.proto +++ b/google/ads/googleads/v12/errors/range_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "RangeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing range errors. diff --git a/google/ads/googleads/v9/errors/reach_plan_error.proto b/google/ads/googleads/v12/errors/reach_plan_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/reach_plan_error.proto rename to google/ads/googleads/v12/errors/reach_plan_error.proto index f32aa697d..795a7e0be 100644 --- a/google/ads/googleads/v9/errors/reach_plan_error.proto +++ b/google/ads/googleads/v12/errors/reach_plan_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ReachPlanErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors generated from ReachPlanService. diff --git a/google/ads/googleads/v9/errors/recommendation_error.proto b/google/ads/googleads/v12/errors/recommendation_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/recommendation_error.proto rename to google/ads/googleads/v12/errors/recommendation_error.proto index 65850f1e3..26e959d0a 100644 --- a/google/ads/googleads/v9/errors/recommendation_error.proto +++ b/google/ads/googleads/v12/errors/recommendation_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "RecommendationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing errors from applying a recommendation. @@ -39,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. diff --git a/google/ads/googleads/v9/errors/region_code_error.proto b/google/ads/googleads/v12/errors/region_code_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/region_code_error.proto rename to google/ads/googleads/v12/errors/region_code_error.proto index 12834b61b..b3ba148ab 100644 --- a/google/ads/googleads/v9/errors/region_code_error.proto +++ b/google/ads/googleads/v12/errors/region_code_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "RegionCodeErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing region code errors. diff --git a/google/ads/googleads/v9/errors/request_error.proto b/google/ads/googleads/v12/errors/request_error.proto similarity index 90% rename from google/ads/googleads/v9/errors/request_error.proto rename to google/ads/googleads/v12/errors/request_error.proto index 20e254bd0..c9d90cd25 100644 --- a/google/ads/googleads/v9/errors/request_error.proto +++ b/google/ads/googleads/v12/errors/request_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "RequestErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing request errors. diff --git a/google/ads/googleads/v9/errors/resource_access_denied_error.proto b/google/ads/googleads/v12/errors/resource_access_denied_error.proto similarity index 76% rename from google/ads/googleads/v9/errors/resource_access_denied_error.proto rename to google/ads/googleads/v12/errors/resource_access_denied_error.proto index 6d33d6f39..e368738de 100644 --- a/google/ads/googleads/v9/errors/resource_access_denied_error.proto +++ b/google/ads/googleads/v12/errors/resource_access_denied_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ResourceAccessDeniedErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing resource access denied errors. diff --git a/google/ads/googleads/v9/errors/resource_count_limit_exceeded_error.proto b/google/ads/googleads/v12/errors/resource_count_limit_exceeded_error.proto similarity index 90% rename from google/ads/googleads/v9/errors/resource_count_limit_exceeded_error.proto rename to google/ads/googleads/v12/errors/resource_count_limit_exceeded_error.proto index d5b8f1599..3d3efbc68 100644 --- a/google/ads/googleads/v9/errors/resource_count_limit_exceeded_error.proto +++ b/google/ads/googleads/v12/errors/resource_count_limit_exceeded_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ResourceCountLimitExceededErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing resource count limit exceeded errors. diff --git a/google/ads/googleads/v9/errors/setting_error.proto b/google/ads/googleads/v12/errors/setting_error.proto similarity index 83% rename from google/ads/googleads/v9/errors/setting_error.proto rename to google/ads/googleads/v12/errors/setting_error.proto index 9230efc6c..6696a7205 100644 --- a/google/ads/googleads/v9/errors/setting_error.proto +++ b/google/ads/googleads/v12/errors/setting_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "SettingErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing setting errors. @@ -79,6 +77,11 @@ 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/google/ads/googleads/v9/errors/shared_criterion_error.proto b/google/ads/googleads/v12/errors/shared_criterion_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/shared_criterion_error.proto rename to google/ads/googleads/v12/errors/shared_criterion_error.proto index 900c2a9b6..15d39cc5e 100644 --- a/google/ads/googleads/v9/errors/shared_criterion_error.proto +++ b/google/ads/googleads/v12/errors/shared_criterion_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "SharedCriterionErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing shared criterion errors. diff --git a/google/ads/googleads/v9/errors/shared_set_error.proto b/google/ads/googleads/v12/errors/shared_set_error.proto similarity index 79% rename from google/ads/googleads/v9/errors/shared_set_error.proto rename to google/ads/googleads/v12/errors/shared_set_error.proto index ffe828f33..8436fe220 100644 --- a/google/ads/googleads/v9/errors/shared_set_error.proto +++ b/google/ads/googleads/v12/errors/shared_set_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "SharedSetErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing shared set errors. diff --git a/google/ads/googleads/v9/errors/size_limit_error.proto b/google/ads/googleads/v12/errors/size_limit_error.proto similarity index 72% rename from google/ads/googleads/v9/errors/size_limit_error.proto rename to google/ads/googleads/v12/errors/size_limit_error.proto index 673e58576..7f4eb0f8b 100644 --- a/google/ads/googleads/v9/errors/size_limit_error.proto +++ b/google/ads/googleads/v12/errors/size_limit_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "SizeLimitErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing size limit errors. @@ -39,7 +37,9 @@ 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. diff --git a/google/ads/googleads/v12/errors/smart_campaign_error.proto b/google/ads/googleads/v12/errors/smart_campaign_error.proto new file mode 100644 index 000000000..46ec2f13f --- /dev/null +++ b/google/ads/googleads/v12/errors/smart_campaign_error.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.v12.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "SmartCampaignErrorProto"; +option java_package = "com.google.ads.googleads.v12.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::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/google/ads/googleads/v9/errors/string_format_error.proto b/google/ads/googleads/v12/errors/string_format_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/string_format_error.proto rename to google/ads/googleads/v12/errors/string_format_error.proto index d01e11345..597967400 100644 --- a/google/ads/googleads/v9/errors/string_format_error.proto +++ b/google/ads/googleads/v12/errors/string_format_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "StringFormatErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing string format errors. diff --git a/google/ads/googleads/v9/errors/string_length_error.proto b/google/ads/googleads/v12/errors/string_length_error.proto similarity index 77% rename from google/ads/googleads/v9/errors/string_length_error.proto rename to google/ads/googleads/v12/errors/string_length_error.proto index 906e4a226..84148b12e 100644 --- a/google/ads/googleads/v9/errors/string_length_error.proto +++ b/google/ads/googleads/v12/errors/string_length_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "StringLengthErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing string length errors. diff --git a/google/ads/googleads/v9/errors/third_party_app_analytics_link_error.proto b/google/ads/googleads/v12/errors/third_party_app_analytics_link_error.proto similarity index 81% rename from google/ads/googleads/v9/errors/third_party_app_analytics_link_error.proto rename to google/ads/googleads/v12/errors/third_party_app_analytics_link_error.proto index 72ec12688..4f1c0e739 100644 --- a/google/ads/googleads/v9/errors/third_party_app_analytics_link_error.proto +++ b/google/ads/googleads/v12/errors/third_party_app_analytics_link_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "ThirdPartyAppAnalyticsLinkErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing ThirdPartyAppAnalyticsLink errors. diff --git a/google/ads/googleads/v9/errors/time_zone_error.proto b/google/ads/googleads/v12/errors/time_zone_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/time_zone_error.proto rename to google/ads/googleads/v12/errors/time_zone_error.proto index ec0b7c109..da9a04b5a 100644 --- a/google/ads/googleads/v9/errors/time_zone_error.proto +++ b/google/ads/googleads/v12/errors/time_zone_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "TimeZoneErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing time zone errors. diff --git a/google/ads/googleads/v9/errors/url_field_error.proto b/google/ads/googleads/v12/errors/url_field_error.proto similarity index 85% rename from google/ads/googleads/v9/errors/url_field_error.proto rename to google/ads/googleads/v12/errors/url_field_error.proto index 00171edeb..a3ef5fda9 100644 --- a/google/ads/googleads/v9/errors/url_field_error.proto +++ b/google/ads/googleads/v12/errors/url_field_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "UrlFieldErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing url field errors. @@ -45,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 @@ -68,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. @@ -78,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. @@ -104,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. @@ -130,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. @@ -139,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. @@ -159,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. @@ -177,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. @@ -193,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. diff --git a/google/ads/googleads/v9/errors/user_data_error.proto b/google/ads/googleads/v12/errors/user_data_error.proto similarity index 75% rename from google/ads/googleads/v9/errors/user_data_error.proto rename to google/ads/googleads/v12/errors/user_data_error.proto index a9b39d022..19f501609 100644 --- a/google/ads/googleads/v9/errors/user_data_error.proto +++ b/google/ads/googleads/v12/errors/user_data_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "UserDataErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing user data errors. @@ -42,7 +40,8 @@ message UserDataErrorEnum { // Customer is not allowed to perform operations related to Customer Match. OPERATIONS_FOR_CUSTOMER_MATCH_NOT_ALLOWED = 2; - // Maximum number of user identifiers allowed for each mutate is 100. + // Maximum number of user identifiers allowed for each request is 100 and + // for each operation is 20. TOO_MANY_USER_IDENTIFIERS = 3; // Current user list is not applicable for the given customer. diff --git a/google/ads/googleads/v9/errors/user_list_error.proto b/google/ads/googleads/v12/errors/user_list_error.proto similarity index 89% rename from google/ads/googleads/v9/errors/user_list_error.proto rename to google/ads/googleads/v12/errors/user_list_error.proto index 01f9a57ef..2e8bc0130 100644 --- a/google/ads/googleads/v9/errors/user_list_error.proto +++ b/google/ads/googleads/v12/errors/user_list_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "UserListErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing user list errors. @@ -111,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. diff --git a/google/ads/googleads/v9/errors/youtube_video_registration_error.proto b/google/ads/googleads/v12/errors/youtube_video_registration_error.proto similarity index 71% rename from google/ads/googleads/v9/errors/youtube_video_registration_error.proto rename to google/ads/googleads/v12/errors/youtube_video_registration_error.proto index 322eff896..80f737db0 100644 --- a/google/ads/googleads/v9/errors/youtube_video_registration_error.proto +++ b/google/ads/googleads/v12/errors/youtube_video_registration_error.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. @@ -14,18 +14,16 @@ syntax = "proto3"; -package google.ads.googleads.v9.errors; +package google.ads.googleads.v12.errors; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Errors"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/errors;errors"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors"; option java_multiple_files = true; option java_outer_classname = "YoutubeVideoRegistrationErrorProto"; -option java_package = "com.google.ads.googleads.v9.errors"; +option java_package = "com.google.ads.googleads.v12.errors"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Errors"; -option ruby_package = "Google::Ads::GoogleAds::V9::Errors"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V12::Errors"; // Proto file describing YouTube video registration errors. @@ -42,10 +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/google/ads/googleads/v12/googleads_gapic.yaml b/google/ads/googleads/v12/googleads_gapic.yaml new file mode 100644 index 000000000..be30ba68b --- /dev/null +++ b/google/ads/googleads/v12/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.V12.Services + go: + package_name: google.golang.org/google/ads/googleads/v12/services + java: + package_name: com.google.ads.googleads.v12.services + nodejs: + package_name: v12.services + php: + package_name: Google\Ads\GoogleAds\V12\Services + python: + package_name: google.ads.googleads_v12.gapic.services + ruby: + package_name: Google::Ads::Googleads::V12::Services +interfaces: +- name: google.ads.googleads.v12.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/google/ads/googleads/v12/googleads_grpc_service_config.json b/google/ads/googleads/v12/googleads_grpc_service_config.json new file mode 100755 index 000000000..5767e0aef --- /dev/null +++ b/google/ads/googleads/v12/googleads_grpc_service_config.json @@ -0,0 +1,330 @@ +{ + "methodConfig": [ + { + "name": [ + { + "service": "google.ads.googleads.v12.services.AccountBudgetProposalService" + }, + { + "service": "google.ads.googleads.v12.services.AccountLinkService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupAdLabelService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupAdService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupAssetService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupAssetSetService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupBidModifierService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupCriterionLabelService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupCriterionService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupCustomizerService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupExtensionSettingService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupFeedService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupLabelService" + }, + { + "service": "google.ads.googleads.v12.services.AdGroupService" + }, + { + "service": "google.ads.googleads.v12.services.AdParameterService" + }, + { + "service": "google.ads.googleads.v12.services.AdService" + }, + { + "service": "google.ads.googleads.v12.services.AssetGroupAssetService" + }, + { + "service": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService" + }, + { + "service": "google.ads.googleads.v12.services.AssetGroupService" + }, + { + "service": "google.ads.googleads.v12.services.AssetGroupSignalService" + }, + { + "service": "google.ads.googleads.v12.services.AssetService" + }, + { + "service": "google.ads.googleads.v12.services.AssetSetAssetService" + }, + { + "service": "google.ads.googleads.v12.services.AssetSetService" + }, + { + "service": "google.ads.googleads.v12.services.AudienceInsightsService" + }, + { + "service": "google.ads.googleads.v12.services.AudienceService" + }, + { + "service": "google.ads.googleads.v12.services.BatchJobService" + }, + { + "service": "google.ads.googleads.v12.services.BiddingDataExclusionService" + }, + { + "service": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService" + }, + { + "service": "google.ads.googleads.v12.services.BiddingStrategyService" + }, + { + "service": "google.ads.googleads.v12.services.BillingSetupService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignAssetService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignAssetSetService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignBidModifierService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignBudgetService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignConversionGoalService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignCriterionService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignCustomizerService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignDraftService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignExtensionSettingService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignFeedService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignGroupService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignLabelService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignService" + }, + { + "service": "google.ads.googleads.v12.services.CampaignSharedSetService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionActionService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionCustomVariableService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionUploadService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionValueRuleService" + }, + { + "service": "google.ads.googleads.v12.services.ConversionValueRuleSetService" + }, + { + "service": "google.ads.googleads.v12.services.CustomAudienceService" + }, + { + "service": "google.ads.googleads.v12.services.CustomConversionGoalService" + }, + { + "service": "google.ads.googleads.v12.services.CustomInterestService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerAssetService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerAssetSetService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerClientLinkService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerConversionGoalService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerCustomizerService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerExtensionSettingService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerFeedService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerLabelService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerManagerLinkService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerNegativeCriterionService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService" + }, + { + "service": "google.ads.googleads.v12.services.CustomerUserAccessService" + }, + { + "service": "google.ads.googleads.v12.services.CustomizerAttributeService" + }, + { + "service": "google.ads.googleads.v12.services.ExperimentArmService" + }, + { + "service": "google.ads.googleads.v12.services.ExperimentService" + }, + { + "service": "google.ads.googleads.v12.services.ExtensionFeedItemService" + }, + { + "service": "google.ads.googleads.v12.services.FeedItemService" + }, + { + "service": "google.ads.googleads.v12.services.FeedItemSetLinkService" + }, + { + "service": "google.ads.googleads.v12.services.FeedItemSetService" + }, + { + "service": "google.ads.googleads.v12.services.FeedItemTargetService" + }, + { + "service": "google.ads.googleads.v12.services.FeedMappingService" + }, + { + "service": "google.ads.googleads.v12.services.FeedService" + }, + { + "service": "google.ads.googleads.v12.services.GeoTargetConstantService" + }, + { + "service": "google.ads.googleads.v12.services.GoogleAdsFieldService" + }, + { + "service": "google.ads.googleads.v12.services.GoogleAdsService" + }, + { + "service": "google.ads.googleads.v12.services.InvoiceService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanAdGroupService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanCampaignService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanIdeaService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordPlanService" + }, + { + "service": "google.ads.googleads.v12.services.KeywordThemeConstantService" + }, + { + "service": "google.ads.googleads.v12.services.LabelService" + }, + { + "service": "google.ads.googleads.v12.services.MediaFileService" + }, + { + "service": "google.ads.googleads.v12.services.MerchantCenterLinkService" + }, + { + "service": "google.ads.googleads.v12.services.OfflineUserDataJobService" + }, + { + "service": "google.ads.googleads.v12.services.PaymentsAccountService" + }, + { + "service": "google.ads.googleads.v12.services.ReachPlanService" + }, + { + "service": "google.ads.googleads.v12.services.RecommendationService" + }, + { + "service": "google.ads.googleads.v12.services.RemarketingActionService" + }, + { + "service": "google.ads.googleads.v12.services.SharedCriterionService" + }, + { + "service": "google.ads.googleads.v12.services.SharedSetService" + }, + { + "service": "google.ads.googleads.v12.services.SmartCampaignSettingService" + }, + { + "service": "google.ads.googleads.v12.services.SmartCampaignSuggestService" + }, + { + "service": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService" + }, + { + "service": "google.ads.googleads.v12.services.UserDataService" + }, + { + "service": "google.ads.googleads.v12.services.UserListService" + } + ], + "timeout": "14400s", + "retryPolicy": { + "initialBackoff": "5s", + "maxBackoff": "60s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": [ + "UNAVAILABLE", + "DEADLINE_EXCEEDED" + ] + } + } + ] +} diff --git a/google/ads/googleads/v12/googleads_v12.yaml b/google/ads/googleads/v12/googleads_v12.yaml new file mode 100644 index 000000000..b16ee2c07 --- /dev/null +++ b/google/ads/googleads/v12/googleads_v12.yaml @@ -0,0 +1,817 @@ +type: google.api.Service +config_version: 3 +name: googleads.googleapis.com +title: Google Ads API + +apis: +- name: google.ads.googleads.v12.services.AccountBudgetProposalService +- name: google.ads.googleads.v12.services.AccountLinkService +- name: google.ads.googleads.v12.services.AdGroupAdLabelService +- name: google.ads.googleads.v12.services.AdGroupAdService +- name: google.ads.googleads.v12.services.AdGroupAssetService +- name: google.ads.googleads.v12.services.AdGroupAssetSetService +- name: google.ads.googleads.v12.services.AdGroupBidModifierService +- name: google.ads.googleads.v12.services.AdGroupCriterionCustomizerService +- name: google.ads.googleads.v12.services.AdGroupCriterionLabelService +- name: google.ads.googleads.v12.services.AdGroupCriterionService +- name: google.ads.googleads.v12.services.AdGroupCustomizerService +- name: google.ads.googleads.v12.services.AdGroupExtensionSettingService +- name: google.ads.googleads.v12.services.AdGroupFeedService +- name: google.ads.googleads.v12.services.AdGroupLabelService +- name: google.ads.googleads.v12.services.AdGroupService +- name: google.ads.googleads.v12.services.AdParameterService +- name: google.ads.googleads.v12.services.AdService +- name: google.ads.googleads.v12.services.AssetGroupAssetService +- name: google.ads.googleads.v12.services.AssetGroupListingGroupFilterService +- name: google.ads.googleads.v12.services.AssetGroupService +- name: google.ads.googleads.v12.services.AssetGroupSignalService +- name: google.ads.googleads.v12.services.AssetService +- name: google.ads.googleads.v12.services.AssetSetAssetService +- name: google.ads.googleads.v12.services.AssetSetService +- name: google.ads.googleads.v12.services.AudienceInsightsService +- name: google.ads.googleads.v12.services.AudienceService +- name: google.ads.googleads.v12.services.BatchJobService +- name: google.ads.googleads.v12.services.BiddingDataExclusionService +- name: google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService +- name: google.ads.googleads.v12.services.BiddingStrategyService +- name: google.ads.googleads.v12.services.BillingSetupService +- name: google.ads.googleads.v12.services.CampaignAssetService +- name: google.ads.googleads.v12.services.CampaignAssetSetService +- name: google.ads.googleads.v12.services.CampaignBidModifierService +- name: google.ads.googleads.v12.services.CampaignBudgetService +- name: google.ads.googleads.v12.services.CampaignConversionGoalService +- name: google.ads.googleads.v12.services.CampaignCriterionService +- name: google.ads.googleads.v12.services.CampaignCustomizerService +- name: google.ads.googleads.v12.services.CampaignDraftService +- name: google.ads.googleads.v12.services.CampaignExtensionSettingService +- name: google.ads.googleads.v12.services.CampaignFeedService +- name: google.ads.googleads.v12.services.CampaignGroupService +- name: google.ads.googleads.v12.services.CampaignLabelService +- name: google.ads.googleads.v12.services.CampaignService +- name: google.ads.googleads.v12.services.CampaignSharedSetService +- name: google.ads.googleads.v12.services.ConversionActionService +- name: google.ads.googleads.v12.services.ConversionAdjustmentUploadService +- name: google.ads.googleads.v12.services.ConversionCustomVariableService +- name: google.ads.googleads.v12.services.ConversionGoalCampaignConfigService +- name: google.ads.googleads.v12.services.ConversionUploadService +- name: google.ads.googleads.v12.services.ConversionValueRuleService +- name: google.ads.googleads.v12.services.ConversionValueRuleSetService +- name: google.ads.googleads.v12.services.CustomAudienceService +- name: google.ads.googleads.v12.services.CustomConversionGoalService +- name: google.ads.googleads.v12.services.CustomInterestService +- name: google.ads.googleads.v12.services.CustomerAssetService +- name: google.ads.googleads.v12.services.CustomerAssetSetService +- name: google.ads.googleads.v12.services.CustomerClientLinkService +- name: google.ads.googleads.v12.services.CustomerConversionGoalService +- name: google.ads.googleads.v12.services.CustomerCustomizerService +- name: google.ads.googleads.v12.services.CustomerExtensionSettingService +- name: google.ads.googleads.v12.services.CustomerFeedService +- name: google.ads.googleads.v12.services.CustomerLabelService +- name: google.ads.googleads.v12.services.CustomerManagerLinkService +- name: google.ads.googleads.v12.services.CustomerNegativeCriterionService +- name: google.ads.googleads.v12.services.CustomerService +- name: google.ads.googleads.v12.services.CustomerUserAccessInvitationService +- name: google.ads.googleads.v12.services.CustomerUserAccessService +- name: google.ads.googleads.v12.services.CustomizerAttributeService +- name: google.ads.googleads.v12.services.ExperimentArmService +- name: google.ads.googleads.v12.services.ExperimentService +- name: google.ads.googleads.v12.services.ExtensionFeedItemService +- name: google.ads.googleads.v12.services.FeedItemService +- name: google.ads.googleads.v12.services.FeedItemSetLinkService +- name: google.ads.googleads.v12.services.FeedItemSetService +- name: google.ads.googleads.v12.services.FeedItemTargetService +- name: google.ads.googleads.v12.services.FeedMappingService +- name: google.ads.googleads.v12.services.FeedService +- name: google.ads.googleads.v12.services.GeoTargetConstantService +- name: google.ads.googleads.v12.services.GoogleAdsFieldService +- name: google.ads.googleads.v12.services.GoogleAdsService +- name: google.ads.googleads.v12.services.InvoiceService +- name: google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService +- name: google.ads.googleads.v12.services.KeywordPlanAdGroupService +- name: google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService +- name: google.ads.googleads.v12.services.KeywordPlanCampaignService +- name: google.ads.googleads.v12.services.KeywordPlanIdeaService +- name: google.ads.googleads.v12.services.KeywordPlanService +- name: google.ads.googleads.v12.services.KeywordThemeConstantService +- name: google.ads.googleads.v12.services.LabelService +- name: google.ads.googleads.v12.services.MediaFileService +- name: google.ads.googleads.v12.services.MerchantCenterLinkService +- name: google.ads.googleads.v12.services.OfflineUserDataJobService +- name: google.ads.googleads.v12.services.PaymentsAccountService +- name: google.ads.googleads.v12.services.ReachPlanService +- name: google.ads.googleads.v12.services.RecommendationService +- name: google.ads.googleads.v12.services.RemarketingActionService +- name: google.ads.googleads.v12.services.SharedCriterionService +- name: google.ads.googleads.v12.services.SharedSetService +- name: google.ads.googleads.v12.services.SmartCampaignSettingService +- name: google.ads.googleads.v12.services.SmartCampaignSuggestService +- name: google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService +- name: google.ads.googleads.v12.services.UserDataService +- name: google.ads.googleads.v12.services.UserListService + +types: +- name: google.ads.googleads.v12.errors.GoogleAdsFailure +- name: google.ads.googleads.v12.resources.BatchJob.BatchJobMetadata +- name: google.ads.googleads.v12.services.PromoteExperimentMetadata +- name: google.ads.googleads.v12.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.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink + deadline: 600.0 + - selector: google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink + deadline: 600.0 + - selector: google.ads.googleads.v12.services.AdGroupAdLabelService.MutateAdGroupAdLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupAdService.MutateAdGroupAds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupAssetService.MutateAdGroupAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupAssetSetService.MutateAdGroupAssetSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupFeedService.MutateAdGroupFeeds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupLabelService.MutateAdGroupLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdGroupService.MutateAdGroups + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdParameterService.MutateAdParameters + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdService.GetAd + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AdService.MutateAds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetGroupService.MutateAssetGroups + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetService.MutateAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetSetAssetService.MutateAssetSetAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.AssetSetService.MutateAssetSets + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.AudienceInsightsService.*' + deadline: 600.0 + - selector: google.ads.googleads.v12.services.AudienceService.MutateAudiences + deadline: 600.0 + - selector: 'google.ads.googleads.v12.services.BatchJobService.*' + deadline: 60.0 + - selector: google.ads.googleads.v12.services.BiddingDataExclusionService.MutateBiddingDataExclusions + deadline: 60.0 + - selector: google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments + deadline: 60.0 + - selector: google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies + deadline: 60.0 + - selector: google.ads.googleads.v12.services.BillingSetupService.MutateBillingSetup + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignAssetService.MutateCampaignAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignBudgetService.MutateCampaignBudgets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignCriterionService.MutateCampaignCriteria + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.CampaignDraftService.*' + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignFeedService.MutateCampaignFeeds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignGroupService.MutateCampaignGroups + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignService.MutateCampaigns + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments + deadline: 600.0 + - selector: google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions + deadline: 600.0 + - selector: google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions + deadline: 600.0 + - selector: google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomAudienceService.MutateCustomAudiences + deadline: 600.0 + - selector: google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomInterestService.MutateCustomInterests + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerAssetService.MutateCustomerAssets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerAssetSetService.MutateCustomerAssetSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerClientLinkService.MutateCustomerClientLink + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerFeedService.MutateCustomerFeeds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerManagerLinkService.MoveManagerLink + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.CustomerService.*' + deadline: 60.0 + - selector: google.ads.googleads.v12.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation + deadline: 600.0 + - selector: google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess + deadline: 600.0 + - selector: google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ExperimentArmService.MutateExperimentArms + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.ExperimentService.*' + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedItemService.MutateFeedItems + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedItemSetService.MutateFeedItemSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedMappingService.MutateFeedMappings + deadline: 60.0 + - selector: google.ads.googleads.v12.services.FeedService.MutateFeeds + deadline: 60.0 + - selector: google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants + deadline: 60.0 + - selector: google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField + deadline: 600.0 + - selector: google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields + deadline: 600.0 + - selector: google.ads.googleads.v12.services.GoogleAdsService.Mutate + deadline: 600.0 + - selector: google.ads.googleads.v12.services.GoogleAdsService.Search + deadline: 14400.0 + - selector: google.ads.googleads.v12.services.GoogleAdsService.SearchStream + deadline: 14400.0 + - selector: google.ads.googleads.v12.services.InvoiceService.ListInvoices + deadline: 60.0 + - selector: google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords + deadline: 60.0 + - selector: google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups + deadline: 60.0 + - selector: google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords + deadline: 60.0 + - selector: google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.KeywordPlanIdeaService.*' + deadline: 600.0 + - selector: 'google.ads.googleads.v12.services.KeywordPlanService.*' + deadline: 600.0 + - selector: google.ads.googleads.v12.services.KeywordPlanService.MutateKeywordPlans + deadline: 60.0 + - selector: google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants + deadline: 60.0 + - selector: google.ads.googleads.v12.services.LabelService.MutateLabels + deadline: 60.0 + - selector: google.ads.googleads.v12.services.MediaFileService.MutateMediaFiles + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.MerchantCenterLinkService.*' + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.OfflineUserDataJobService.*' + deadline: 600.0 + - selector: google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.ReachPlanService.*' + deadline: 600.0 + - selector: google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation + deadline: 600.0 + - selector: google.ads.googleads.v12.services.RecommendationService.DismissRecommendation + deadline: 600.0 + - selector: google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions + deadline: 60.0 + - selector: google.ads.googleads.v12.services.SharedCriterionService.MutateSharedCriteria + deadline: 60.0 + - selector: google.ads.googleads.v12.services.SharedSetService.MutateSharedSets + deadline: 60.0 + - selector: google.ads.googleads.v12.services.SmartCampaignSettingService.MutateSmartCampaignSettings + deadline: 60.0 + - selector: 'google.ads.googleads.v12.services.SmartCampaignSuggestService.*' + deadline: 60.0 + - selector: google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId + deadline: 600.0 + - selector: google.ads.googleads.v12.services.UserDataService.UploadUserData + deadline: 600.0 + - selector: google.ads.googleads.v12.services.UserListService.MutateUserLists + deadline: 60.0 + - selector: 'google.longrunning.Operations.*' + deadline: 60.0 + +http: + rules: + - selector: google.longrunning.Operations.CancelOperation + post: '/v12/{name=customers/*/operations/*}:cancel' + body: '*' + - selector: google.longrunning.Operations.DeleteOperation + delete: '/v12/{name=customers/*/operations/*}' + - selector: google.longrunning.Operations.GetOperation + get: '/v12/{name=customers/*/operations/*}' + - selector: google.longrunning.Operations.ListOperations + get: '/v12/{name=customers/*/operations}' + - selector: google.longrunning.Operations.WaitOperation + post: '/v12/{name=customers/*/operations/*}:wait' + body: '*' + +authentication: + rules: + - selector: google.ads.googleads.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupAdLabelService.MutateAdGroupAdLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupAdService.MutateAdGroupAds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupAssetService.MutateAdGroupAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupAssetSetService.MutateAdGroupAssetSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupFeedService.MutateAdGroupFeeds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupLabelService.MutateAdGroupLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdGroupService.MutateAdGroups + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdParameterService.MutateAdParameters + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdService.GetAd + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AdService.MutateAds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetGroupService.MutateAssetGroups + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetService.MutateAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetSetAssetService.MutateAssetSetAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AssetSetService.MutateAssetSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.AudienceInsightsService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.AudienceService.MutateAudiences + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.BatchJobService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.BiddingDataExclusionService.MutateBiddingDataExclusions + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.BillingSetupService.MutateBillingSetup + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignAssetService.MutateCampaignAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignBudgetService.MutateCampaignBudgets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignCriterionService.MutateCampaignCriteria + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.CampaignDraftService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignFeedService.MutateCampaignFeeds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignGroupService.MutateCampaignGroups + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignService.MutateCampaigns + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomAudienceService.MutateCustomAudiences + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomInterestService.MutateCustomInterests + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerAssetService.MutateCustomerAssets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerAssetSetService.MutateCustomerAssetSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerClientLinkService.MutateCustomerClientLink + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerFeedService.MutateCustomerFeeds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerManagerLinkService.MoveManagerLink + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.CustomerService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ExperimentArmService.MutateExperimentArms + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.ExperimentService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedItemService.MutateFeedItems + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedItemSetService.MutateFeedItemSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedMappingService.MutateFeedMappings + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.FeedService.MutateFeeds + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.GoogleAdsService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.InvoiceService.ListInvoices + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.KeywordPlanIdeaService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.KeywordPlanService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.LabelService.MutateLabels + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.MediaFileService.MutateMediaFiles + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.MerchantCenterLinkService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.OfflineUserDataJobService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.ReachPlanService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.RecommendationService.DismissRecommendation + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.SharedCriterionService.MutateSharedCriteria + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.SharedSetService.MutateSharedSets + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.SmartCampaignSettingService.MutateSmartCampaignSettings + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: 'google.ads.googleads.v12.services.SmartCampaignSuggestService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.services.UserDataService.UploadUserData + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/adwords + - selector: google.ads.googleads.v12.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/google/ads/googleads/v9/resources/BUILD.bazel b/google/ads/googleads/v12/resources/BUILD.bazel similarity index 94% rename from google/ads/googleads/v9/resources/BUILD.bazel rename to google/ads/googleads/v12/resources/BUILD.bazel index 96eda3459..70ab3bd0b 100644 --- a/google/ads/googleads/v9/resources/BUILD.bazel +++ b/google/ads/googleads/v12/resources/BUILD.bazel @@ -26,9 +26,9 @@ proto_library( name = "resources_proto", srcs = glob(["*.proto"]), deps = [ - "//google/ads/googleads/v9/common:common_proto", - "//google/ads/googleads/v9/enums:enums_proto", - "//google/ads/googleads/v9/errors:errors_proto", + "//google/ads/googleads/v12/common:common_proto", + "//google/ads/googleads/v12/enums:enums_proto", + "//google/ads/googleads/v12/errors:errors_proto", "//google/api:annotations_proto", "//google/api:field_behavior_proto", "//google/api:resource_proto", diff --git a/google/ads/googleads/v9/resources/accessible_bidding_strategy.proto b/google/ads/googleads/v12/resources/accessible_bidding_strategy.proto similarity index 86% rename from google/ads/googleads/v9/resources/accessible_bidding_strategy.proto rename to google/ads/googleads/v12/resources/accessible_bidding_strategy.proto index 434e8f757..e809697f1 100644 --- a/google/ads/googleads/v9/resources/accessible_bidding_strategy.proto +++ b/google/ads/googleads/v12/resources/accessible_bidding_strategy.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/bidding_strategy_type.proto"; -import "google/ads/googleads/v9/enums/target_impression_share_location.proto"; +import "google/ads/googleads/v12/enums/bidding_strategy_type.proto"; +import "google/ads/googleads/v12/enums/target_impression_share_location.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AccessibleBiddingStrategyProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Represents a view of BiddingStrategies owned by and shared with the customer. // @@ -59,14 +58,7 @@ message AccessibleBiddingStrategy { 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]; - } - - // 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. - optional double target_roas = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + 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 @@ -83,10 +75,10 @@ message AccessibleBiddingStrategy { // location). message TargetImpressionShare { // Output only. The targeted location on the search results page. - google.ads.googleads.v9.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -95,6 +87,13 @@ message AccessibleBiddingStrategy { 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 chosen revenue (based on conversion data) per unit of spend. + optional double target_roas = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + // An automated bid strategy that sets your bids to help get as many clicks // as possible within your budget. message TargetSpend { @@ -133,7 +132,7 @@ message AccessibleBiddingStrategy { string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of the bidding strategy. - google.ads.googleads.v9.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -157,7 +156,7 @@ message AccessibleBiddingStrategy { // 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 + // 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]; diff --git a/google/ads/googleads/v9/resources/account_budget.proto b/google/ads/googleads/v12/resources/account_budget.proto similarity index 78% rename from google/ads/googleads/v9/resources/account_budget.proto rename to google/ads/googleads/v12/resources/account_budget.proto index 02249cb1b..34dc11614 100644 --- a/google/ads/googleads/v9/resources/account_budget.proto +++ b/google/ads/googleads/v12/resources/account_budget.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/account_budget_proposal_type.proto"; -import "google/ads/googleads/v9/enums/account_budget_status.proto"; -import "google/ads/googleads/v9/enums/spending_limit_type.proto"; -import "google/ads/googleads/v9/enums/time_type.proto"; +import "google/ads/googleads/v12/enums/account_budget_proposal_type.proto"; +import "google/ads/googleads/v12/enums/account_budget_status.proto"; +import "google/ads/googleads/v12/enums/spending_limit_type.proto"; +import "google/ads/googleads/v12/enums/time_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AccountBudget resource. @@ -41,8 +40,8 @@ option ruby_package = "Google::Ads::GoogleAds::V9::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. @@ -71,9 +70,9 @@ message AccountBudget { } ]; - // Output only. The type of this proposal, e.g. END to end the budget associated + // Output only. The type of this proposal, for example, END to end the budget associated // with this proposal. - google.ads.googleads.v9.enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -97,8 +96,8 @@ message AccountBudget { // 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.v9.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.v12.enums.TimeTypeEnum.TimeType end_time_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The spending limit. @@ -107,8 +106,8 @@ message AccountBudget { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType spending_limit_type = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The spending limit as a well-defined type, for example, INFINITE. + google.ads.googleads.v12.enums.SpendingLimitTypeEnum.SpendingLimitType spending_limit_type = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } } @@ -138,7 +137,7 @@ message AccountBudget { ]; // Output only. The status of this account-level budget. - google.ads.googleads.v9.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -181,8 +180,8 @@ message AccountBudget { // 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]; - // Output only. The proposed end time as a well-defined type, e.g. FOREVER. - google.ads.googleads.v9.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.v12.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The approved end time of the account-level budget. @@ -193,8 +192,8 @@ message AccountBudget { // 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]; - // Output only. The approved end time as a well-defined type, e.g. FOREVER. - google.ads.googleads.v9.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.v12.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The proposed spending limit. @@ -203,8 +202,9 @@ message AccountBudget { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The proposed spending limit as a well-defined type, for example, + // INFINITE. + google.ads.googleads.v12.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The approved spending limit. @@ -219,9 +219,10 @@ message AccountBudget { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(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.v12.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The spending limit after adjustments have been applied. Adjustments are @@ -243,10 +244,10 @@ message AccountBudget { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(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.v12.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/account_budget_proposal.proto b/google/ads/googleads/v12/resources/account_budget_proposal.proto similarity index 72% rename from google/ads/googleads/v9/resources/account_budget_proposal.proto rename to google/ads/googleads/v12/resources/account_budget_proposal.proto index a581bf59b..cb97daeea 100644 --- a/google/ads/googleads/v9/resources/account_budget_proposal.proto +++ b/google/ads/googleads/v12/resources/account_budget_proposal.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/account_budget_proposal_status.proto"; -import "google/ads/googleads/v9/enums/account_budget_proposal_type.proto"; -import "google/ads/googleads/v9/enums/spending_limit_type.proto"; -import "google/ads/googleads/v9/enums/time_type.proto"; +import "google/ads/googleads/v12/enums/account_budget_proposal_status.proto"; +import "google/ads/googleads/v12/enums/account_budget_proposal_type.proto"; +import "google/ads/googleads/v12/enums/spending_limit_type.proto"; +import "google/ads/googleads/v12/enums/time_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProposalProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AccountBudgetProposal resource. @@ -40,9 +39,9 @@ option ruby_package = "Google::Ads::GoogleAds::V9::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) = { @@ -81,13 +80,13 @@ message AccountBudgetProposal { } ]; - // Immutable. The type of this proposal, e.g. END to end the budget associated with this - // proposal. - google.ads.googleads.v9.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.v12.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.v9.enums.AccountBudgetProposalStatusEnum.AccountBudgetProposalStatus status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -115,8 +114,8 @@ message AccountBudgetProposal { // 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]; - // Immutable. The proposed start date time as a well-defined type, e.g. NOW. - google.ads.googleads.v9.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.v12.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 @@ -125,8 +124,8 @@ message AccountBudgetProposal { // 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]; - // Immutable. The proposed end date time as a well-defined type, e.g. FOREVER. - google.ads.googleads.v9.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.v12.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(google.api.field_behavior) = IMMUTABLE]; } // The approved end date time of the account-level budget. @@ -134,8 +133,8 @@ message AccountBudgetProposal { // 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]; - // Output only. The approved end date time as a well-defined type, e.g. FOREVER. - google.ads.googleads.v9.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.v12.enums.TimeTypeEnum.TimeType approved_end_time_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The proposed spending limit. @@ -144,8 +143,9 @@ message AccountBudgetProposal { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11 [(google.api.field_behavior) = IMMUTABLE]; + // Immutable. The proposed spending limit as a well-defined type, for example, + // INFINITE. + google.ads.googleads.v12.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11 [(google.api.field_behavior) = IMMUTABLE]; } // The approved spending limit. @@ -154,7 +154,8 @@ message AccountBudgetProposal { // 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.v9.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The approved spending limit as a well-defined type, for example, + // INFINITE. + google.ads.googleads.v12.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/account_link.proto b/google/ads/googleads/v12/resources/account_link.proto similarity index 66% rename from google/ads/googleads/v9/resources/account_link.proto rename to google/ads/googleads/v12/resources/account_link.proto index 1930f1ce2..74f6bf1d0 100644 --- a/google/ads/googleads/v9/resources/account_link.proto +++ b/google/ads/googleads/v12/resources/account_link.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/account_link_status.proto"; -import "google/ads/googleads/v9/enums/linked_account_type.proto"; -import "google/ads/googleads/v9/enums/mobile_app_vendor.proto"; +import "google/ads/googleads/v12/enums/account_link_status.proto"; +import "google/ads/googleads/v12/enums/linked_account_type.proto"; +import "google/ads/googleads/v12/enums/mobile_app_vendor.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AccountLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Represents the data sharing connection between a Google Ads account and // another account @@ -55,10 +54,10 @@ message AccountLink { optional int64 account_link_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // The status of the link. - google.ads.googleads.v9.enums.AccountLinkStatusEnum.AccountLinkStatus status = 3; + google.ads.googleads.v12.enums.AccountLinkStatusEnum.AccountLinkStatus status = 3; // Output only. The type of the linked account. - google.ads.googleads.v9.enums.LinkedAccountTypeEnum.LinkedAccountType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.LinkedAccountTypeEnum.LinkedAccountType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // An account linked to this Google Ads account. oneof linked_account { @@ -70,6 +69,12 @@ message AccountLink { // Output only. Google Ads link. GoogleAdsLinkIdentifier google_ads = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Hotel link + 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]; } } @@ -83,10 +88,10 @@ message ThirdPartyAppAnalyticsLinkIdentifier { // 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 + // 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 @@ -98,7 +103,7 @@ 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.v9.enums.MobileAppVendorEnum.MobileAppVendor app_vendor = 3 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.MobileAppVendorEnum.MobileAppVendor app_vendor = 3 [(google.api.field_behavior) = IMMUTABLE]; } // The identifier for Data Partner account. @@ -110,6 +115,12 @@ message DataPartnerLinkIdentifier { optional int64 data_partner_id = 1 [(google.api.field_behavior) = IMMUTABLE]; } +// The identifier for Hotel account. +message HotelCenterLinkIdentifier { + // Output only. The hotel center id of the hotel account. + int64 hotel_center_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + // The identifier for Google Ads account. message GoogleAdsLinkIdentifier { // Immutable. The resource name of the Google Ads account. @@ -123,3 +134,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/google/ads/googleads/v9/resources/ad.proto b/google/ads/googleads/v12/resources/ad.proto similarity index 57% rename from google/ads/googleads/v9/resources/ad.proto rename to google/ads/googleads/v12/resources/ad.proto index a67fd4d2e..4117e193b 100644 --- a/google/ads/googleads/v9/resources/ad.proto +++ b/google/ads/googleads/v12/resources/ad.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. @@ -14,27 +14,26 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/ad_type_infos.proto"; -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/final_app_url.proto"; -import "google/ads/googleads/v9/common/url_collection.proto"; -import "google/ads/googleads/v9/enums/ad_type.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/system_managed_entity_source.proto"; +import "google/ads/googleads/v12/common/ad_type_infos.proto"; +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/final_app_url.proto"; +import "google/ads/googleads/v12/common/url_collection.proto"; +import "google/ads/googleads/v12/enums/ad_type.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/system_managed_entity_source.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad type. @@ -65,7 +64,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.v9.common.FinalAppUrl final_app_urls = 35; + repeated google.ads.googleads.v12.common.FinalAppUrl final_app_urls = 35; // The list of possible final mobile URLs after all cross-domain redirects // for the ad. @@ -79,14 +78,14 @@ 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.v9.common.CustomParameter url_custom_parameters = 10; + // For mutates, use url custom parameter operations. + repeated google.ads.googleads.v12.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.v9.enums.AdTypeEnum.AdType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 @@ -97,14 +96,14 @@ message Ad { // 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.v9.enums.DeviceEnum.Device device_preference = 20; + google.ads.googleads.v12.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.v9.common.UrlCollection url_collections = 26; + repeated google.ads.googleads.v12.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 @@ -114,78 +113,81 @@ message Ad { // Output only. If this ad is system managed, then this field will indicate the source. // This field is read-only. - google.ads.googleads.v9.enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TextAdInfo text_ad = 6 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.TextAdInfo text_ad = 6 [(google.api.field_behavior) = IMMUTABLE]; // Details pertaining to an expanded text ad. - google.ads.googleads.v9.common.ExpandedTextAdInfo expanded_text_ad = 7; + google.ads.googleads.v12.common.ExpandedTextAdInfo expanded_text_ad = 7; // Details pertaining to a call ad. - google.ads.googleads.v9.common.CallAdInfo call_ad = 49; + google.ads.googleads.v12.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.v9.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(google.api.field_behavior) = IMMUTABLE]; // Details pertaining to a hotel ad. - google.ads.googleads.v9.common.HotelAdInfo hotel_ad = 15; + google.ads.googleads.v12.common.HotelAdInfo hotel_ad = 15; // Details pertaining to a Smart Shopping ad. - google.ads.googleads.v9.common.ShoppingSmartAdInfo shopping_smart_ad = 17; + google.ads.googleads.v12.common.ShoppingSmartAdInfo shopping_smart_ad = 17; // Details pertaining to a Shopping product ad. - google.ads.googleads.v9.common.ShoppingProductAdInfo shopping_product_ad = 18; - - // Immutable. Details pertaining to a Gmail ad. - google.ads.googleads.v9.common.GmailAdInfo gmail_ad = 21 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ShoppingProductAdInfo shopping_product_ad = 18; // Immutable. Details pertaining to an Image ad. - google.ads.googleads.v9.common.ImageAdInfo image_ad = 22 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ImageAdInfo image_ad = 22 [(google.api.field_behavior) = IMMUTABLE]; // Details pertaining to a Video ad. - google.ads.googleads.v9.common.VideoAdInfo video_ad = 24; + google.ads.googleads.v12.common.VideoAdInfo video_ad = 24; // Details pertaining to a Video responsive ad. - google.ads.googleads.v9.common.VideoResponsiveAdInfo video_responsive_ad = 39; + google.ads.googleads.v12.common.VideoResponsiveAdInfo video_responsive_ad = 39; // Details pertaining to a responsive search ad. - google.ads.googleads.v9.common.ResponsiveSearchAdInfo responsive_search_ad = 25; + google.ads.googleads.v12.common.ResponsiveSearchAdInfo responsive_search_ad = 25; // Details pertaining to a legacy responsive display ad. - google.ads.googleads.v9.common.LegacyResponsiveDisplayAdInfo legacy_responsive_display_ad = 28; + google.ads.googleads.v12.common.LegacyResponsiveDisplayAdInfo legacy_responsive_display_ad = 28; // Details pertaining to an app ad. - google.ads.googleads.v9.common.AppAdInfo app_ad = 29; + google.ads.googleads.v12.common.AppAdInfo app_ad = 29; // Immutable. Details pertaining to a legacy app install ad. - google.ads.googleads.v9.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(google.api.field_behavior) = IMMUTABLE]; // Details pertaining to a responsive display ad. - google.ads.googleads.v9.common.ResponsiveDisplayAdInfo responsive_display_ad = 31; + google.ads.googleads.v12.common.ResponsiveDisplayAdInfo responsive_display_ad = 31; // Details pertaining to a local ad. - google.ads.googleads.v9.common.LocalAdInfo local_ad = 32; + google.ads.googleads.v12.common.LocalAdInfo local_ad = 32; // Details pertaining to a display upload ad. - google.ads.googleads.v9.common.DisplayUploadAdInfo display_upload_ad = 33; + google.ads.googleads.v12.common.DisplayUploadAdInfo display_upload_ad = 33; // Details pertaining to an app engagement ad. - google.ads.googleads.v9.common.AppEngagementAdInfo app_engagement_ad = 34; + google.ads.googleads.v12.common.AppEngagementAdInfo app_engagement_ad = 34; // Details pertaining to a Shopping Comparison Listing ad. - google.ads.googleads.v9.common.ShoppingComparisonListingAdInfo shopping_comparison_listing_ad = 36; + google.ads.googleads.v12.common.ShoppingComparisonListingAdInfo shopping_comparison_listing_ad = 36; // Details pertaining to a Smart campaign ad. - google.ads.googleads.v9.common.SmartCampaignAdInfo smart_campaign_ad = 48; + google.ads.googleads.v12.common.SmartCampaignAdInfo smart_campaign_ad = 48; // Details pertaining to an app pre-registration ad. - google.ads.googleads.v9.common.AppPreRegistrationAdInfo app_pre_registration_ad = 50; + google.ads.googleads.v12.common.AppPreRegistrationAdInfo app_pre_registration_ad = 50; + + // Details pertaining to a discovery multi asset ad. + google.ads.googleads.v12.common.DiscoveryMultiAssetAdInfo discovery_multi_asset_ad = 51; + + // Details pertaining to a discovery carousel ad. + google.ads.googleads.v12.common.DiscoveryCarouselAdInfo discovery_carousel_ad = 52; } } diff --git a/google/ads/googleads/v9/resources/ad_group.proto b/google/ads/googleads/v12/resources/ad_group.proto similarity index 60% rename from google/ads/googleads/v9/resources/ad_group.proto rename to google/ads/googleads/v12/resources/ad_group.proto index bdfd36073..401adb596 100644 --- a/google/ads/googleads/v9/resources/ad_group.proto +++ b/google/ads/googleads/v12/resources/ad_group.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. @@ -14,29 +14,29 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/explorer_auto_optimizer_setting.proto"; -import "google/ads/googleads/v9/common/targeting_setting.proto"; -import "google/ads/googleads/v9/enums/ad_group_ad_rotation_mode.proto"; -import "google/ads/googleads/v9/enums/ad_group_status.proto"; -import "google/ads/googleads/v9/enums/ad_group_type.proto"; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/bidding_source.proto"; -import "google/ads/googleads/v9/enums/targeting_dimension.proto"; +package google.ads.googleads.v12.resources; + +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/explorer_auto_optimizer_setting.proto"; +import "google/ads/googleads/v12/common/targeting_setting.proto"; +import "google/ads/googleads/v12/enums/ad_group_ad_rotation_mode.proto"; +import "google/ads/googleads/v12/enums/ad_group_status.proto"; +import "google/ads/googleads/v12/enums/ad_group_type.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_set_type.proto"; +import "google/ads/googleads/v12/enums/bidding_source.proto"; +import "google/ads/googleads/v12/enums/targeting_dimension.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group resource. @@ -47,6 +47,13 @@ message AdGroup { pattern: "customers/{customer_id}/adGroups/{ad_group_id}" }; + // 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. + bool use_audience_grouped = 1 [(google.api.field_behavior) = IMMUTABLE]; + } + // Immutable. The resource name of the ad group. // Ad group resource names have the form: // @@ -73,13 +80,13 @@ message AdGroup { optional string name = 35; // The status of the ad group. - google.ads.googleads.v9.enums.AdGroupStatusEnum.AdGroupStatus status = 5; + google.ads.googleads.v12.enums.AdGroupStatusEnum.AdGroupStatus status = 5; // Immutable. The type of the ad group. - google.ads.googleads.v9.enums.AdGroupTypeEnum.AdGroupType type = 12 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.AdGroupTypeEnum.AdGroupType type = 12 [(google.api.field_behavior) = IMMUTABLE]; // The ad rotation mode of the ad group. - google.ads.googleads.v9.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22; + google.ads.googleads.v12.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 @@ -100,7 +107,7 @@ 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.v9.common.CustomParameter url_custom_parameters = 6; + repeated google.ads.googleads.v12.common.CustomParameter url_custom_parameters = 6; // Immutable. The campaign to which the ad group belongs. optional string campaign = 38 [ @@ -113,6 +120,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]; + // The maximum CPM (cost-per-thousand viewable impressions) bid. optional int64 cpm_bid_micros = 40; @@ -123,8 +135,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. @@ -143,18 +155,21 @@ message AdGroup { optional int64 percent_cpc_bid_micros = 45; // Settings for the Display Campaign Optimizer, initially termed "Explorer". - google.ads.googleads.v9.common.ExplorerAutoOptimizerSetting explorer_auto_optimizer_setting = 21; + google.ads.googleads.v12.common.ExplorerAutoOptimizerSetting explorer_auto_optimizer_setting = 21; // 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.v9.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23; + google.ads.googleads.v12.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.v9.common.TargetingSetting targeting_setting = 25; + google.ads.googleads.v12.common.TargetingSetting targeting_setting = 25; + + // Immutable. Setting for audience related features. + AudienceSetting audience_setting = 56 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The effective target CPA (cost-per-acquisition). // This field is read-only. @@ -162,7 +177,7 @@ message AdGroup { // Output only. Source of the effective target CPA. // This field is read-only. - google.ads.googleads.v9.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -170,7 +185,7 @@ message AdGroup { // Output only. Source of the effective target ROAS. // This field is read-only. - google.ads.googleads.v9.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 [ @@ -183,5 +198,17 @@ 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.v9.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54; + repeated google.ads.googleads.v12.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.v12.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58; } diff --git a/google/ads/googleads/v9/resources/ad_group_ad.proto b/google/ads/googleads/v12/resources/ad_group_ad.proto similarity index 67% rename from google/ads/googleads/v9/resources/ad_group_ad.proto rename to google/ads/googleads/v12/resources/ad_group_ad.proto index 315818c98..ff42f216b 100644 --- a/google/ads/googleads/v9/resources/ad_group_ad.proto +++ b/google/ads/googleads/v12/resources/ad_group_ad.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. @@ -14,26 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/ad_group_ad_status.proto"; -import "google/ads/googleads/v9/enums/ad_strength.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; -import "google/ads/googleads/v9/resources/ad.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/ad_group_ad_status.proto"; +import "google/ads/googleads/v12/enums/ad_strength.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; +import "google/ads/googleads/v12/resources/ad.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group ad resource. @@ -56,7 +55,7 @@ message AdGroupAd { ]; // The status of the ad. - google.ads.googleads.v9.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3; + google.ads.googleads.v12.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3; // Immutable. The ad group to which the ad belongs. optional string ad_group = 9 [ @@ -73,7 +72,7 @@ message AdGroupAd { AdGroupAdPolicySummary policy_summary = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Overall ad strength for this ad group ad. - google.ads.googleads.v9.enums.AdStrengthEnum.AdStrength ad_strength = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -92,12 +91,12 @@ message AdGroupAd { // Contains policy information for an ad. message AdGroupAdPolicySummary { // Output only. The list of policy findings for this ad. - repeated google.ads.googleads.v9.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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.v9.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v12/resources/ad_group_ad_asset_combination_view.proto b/google/ads/googleads/v12/resources/ad_group_ad_asset_combination_view.proto new file mode 100644 index 000000000..55eb76691 --- /dev/null +++ b/google/ads/googleads/v12/resources/ad_group_ad_asset_combination_view.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.v12.resources; + +import "google/ads/googleads/v12/common/asset_usage.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupAdAssetCombinationViewProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the asset combination view resource. + +// A view on the usage of ad group ad asset combination. +// Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, +// with more ad types planned for the future. +message AdGroupAdAssetCombinationView { + option (google.api.resource) = { + type: "googleads.googleapis.com/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 + // 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: + // `customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAdAssetCombinationView" + } + ]; + + // Output only. Served assets. + repeated google.ads.googleads.v12.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. + optional bool enabled = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v9/resources/ad_group_ad_asset_view.proto b/google/ads/googleads/v12/resources/ad_group_ad_asset_view.proto similarity index 66% rename from google/ads/googleads/v9/resources/ad_group_ad_asset_view.proto rename to google/ads/googleads/v12/resources/ad_group_ad_asset_view.proto index 13bf4d447..7b39aad89 100644 --- a/google/ads/googleads/v9/resources/ad_group_ad_asset_view.proto +++ b/google/ads/googleads/v12/resources/ad_group_ad_asset_view.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. @@ -14,30 +14,31 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/asset_performance_label.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_performance_label.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; +import "google/ads/googleads/v12/enums/served_asset_field_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdAssetViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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" @@ -76,7 +77,7 @@ message AdGroupAdAssetView { ]; // Output only. Role that the asset takes in the ad. - google.ads.googleads.v9.enums.AssetFieldTypeEnum.AssetFieldType field_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 @@ -88,18 +89,21 @@ message AdGroupAdAssetView { AdGroupAdAssetPolicySummary policy_summary = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Performance of an asset linkage. - google.ads.googleads.v9.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Pinned field. + google.ads.googleads.v12.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.v9.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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.v9.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/ad_group_ad_label.proto b/google/ads/googleads/v12/resources/ad_group_ad_label.proto similarity index 83% rename from google/ads/googleads/v9/resources/ad_group_ad_label.proto rename to google/ads/googleads/v12/resources/ad_group_ad_label.proto index d45072b76..9ec9831d5 100644 --- a/google/ads/googleads/v9/resources/ad_group_ad_label.proto +++ b/google/ads/googleads/v12/resources/ad_group_ad_label.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdLabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group ad label resource. diff --git a/google/ads/googleads/v9/resources/ad_group_asset.proto b/google/ads/googleads/v12/resources/ad_group_asset.proto similarity index 71% rename from google/ads/googleads/v9/resources/ad_group_asset.proto rename to google/ads/googleads/v12/resources/ad_group_asset.proto index cfb8dfc49..67467bda2 100644 --- a/google/ads/googleads/v9/resources/ad_group_asset.proto +++ b/google/ads/googleads/v12/resources/ad_group_asset.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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_source.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupAssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AdGroupAsset resource. @@ -70,11 +70,14 @@ message AdGroupAsset { ]; // Required. Immutable. Role that the asset takes under the linked ad group. - google.ads.googleads.v9.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [ + google.ads.googleads.v12.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.v12.enums.AssetSourceEnum.AssetSource source = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status of the ad group asset. - google.ads.googleads.v9.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; + google.ads.googleads.v12.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; } diff --git a/google/ads/googleads/v12/resources/ad_group_asset_set.proto b/google/ads/googleads/v12/resources/ad_group_asset_set.proto new file mode 100644 index 000000000..9bd6ffa2b --- /dev/null +++ b/google/ads/googleads/v12/resources/ad_group_asset_set.proto @@ -0,0 +1,71 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/enums/asset_set_link_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupAssetSetProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v9/resources/ad_group_audience_view.proto b/google/ads/googleads/v12/resources/ad_group_audience_view.proto similarity index 81% rename from google/ads/googleads/v9/resources/ad_group_audience_view.proto rename to google/ads/googleads/v12/resources/ad_group_audience_view.proto index f62b8da90..3bfab4a03 100644 --- a/google/ads/googleads/v9/resources/ad_group_audience_view.proto +++ b/google/ads/googleads/v12/resources/ad_group_audience_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupAudienceViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group audience view resource. diff --git a/google/ads/googleads/v9/resources/ad_group_bid_modifier.proto b/google/ads/googleads/v12/resources/ad_group_bid_modifier.proto similarity index 68% rename from google/ads/googleads/v9/resources/ad_group_bid_modifier.proto rename to google/ads/googleads/v12/resources/ad_group_bid_modifier.proto index 665768283..79665e7eb 100644 --- a/google/ads/googleads/v9/resources/ad_group_bid_modifier.proto +++ b/google/ads/googleads/v12/resources/ad_group_bid_modifier.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/bid_modifier_source.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/bid_modifier_source.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupBidModifierProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group bid modifier resource. @@ -82,31 +81,31 @@ message AdGroupBidModifier { ]; // Output only. Bid modifier source. - google.ads.googleads.v9.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.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.v12.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.v9.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Criterion for length of hotel stay in nights. - google.ads.googleads.v9.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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.v9.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. A device criterion. - google.ads.googleads.v9.common.DeviceInfo device = 11 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.DeviceInfo device = 11 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. A preferred content criterion. - google.ads.googleads.v9.common.PreferredContentInfo preferred_content = 12 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.PreferredContentInfo preferred_content = 12 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Criterion for a hotel check-in date range. - google.ads.googleads.v9.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/ad_group_criterion.proto b/google/ads/googleads/v12/resources/ad_group_criterion.proto similarity index 64% rename from google/ads/googleads/v9/resources/ad_group_criterion.proto rename to google/ads/googleads/v12/resources/ad_group_criterion.proto index 973905021..f139c45ed 100644 --- a/google/ads/googleads/v9/resources/ad_group_criterion.proto +++ b/google/ads/googleads/v12/resources/ad_group_criterion.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. @@ -14,28 +14,27 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/enums/ad_group_criterion_approval_status.proto"; -import "google/ads/googleads/v9/enums/ad_group_criterion_status.proto"; -import "google/ads/googleads/v9/enums/bidding_source.proto"; -import "google/ads/googleads/v9/enums/criterion_system_serving_status.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; -import "google/ads/googleads/v9/enums/quality_score_bucket.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/enums/ad_group_criterion_approval_status.proto"; +import "google/ads/googleads/v12/enums/ad_group_criterion_status.proto"; +import "google/ads/googleads/v12/enums/bidding_source.proto"; +import "google/ads/googleads/v12/enums/criterion_system_serving_status.proto"; +import "google/ads/googleads/v12/enums/criterion_type.proto"; +import "google/ads/googleads/v12/enums/quality_score_bucket.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group criterion resource. @@ -55,13 +54,13 @@ message AdGroupCriterion { 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.v9.enums.QualityScoreBucketEnum.QualityScoreBucket creative_quality_score = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.QualityScoreBucketEnum.QualityScoreBucket post_click_quality_score = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Estimates for criterion bids at various positions. @@ -118,7 +117,7 @@ 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.v9.enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3; + google.ads.googleads.v12.enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3; // Output only. Information regarding the quality of the criterion. QualityInfo quality_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -132,7 +131,7 @@ message AdGroupCriterion { ]; // Output only. The type of the criterion. - google.ads.googleads.v9.enums.CriterionTypeEnum.CriterionType type = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CriterionTypeEnum.CriterionType type = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Whether to target (`false`) or exclude (`true`) the criterion. // @@ -141,10 +140,10 @@ message AdGroupCriterion { optional bool negative = 58 [(google.api.field_behavior) = IMMUTABLE]; // Output only. Serving status of the criterion. - google.ads.googleads.v9.enums.CriterionSystemServingStatusEnum.CriterionSystemServingStatus system_serving_status = 52 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CriterionSystemServingStatusEnum.CriterionSystemServingStatus system_serving_status = 52 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Approval status of the criterion. - google.ads.googleads.v9.enums.AdGroupCriterionApprovalStatusEnum.AdGroupCriterionApprovalStatus approval_status = 53 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AdGroupCriterionApprovalStatusEnum.AdGroupCriterionApprovalStatus approval_status = 53 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. List of disapproval reasons of the criterion. // @@ -193,16 +192,16 @@ message AdGroupCriterion { 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.v9.enums.BiddingSourceEnum.BiddingSource effective_cpc_bid_source = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.BiddingSourceEnum.BiddingSource effective_cpm_bid_source = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.BiddingSourceEnum.BiddingSource effective_cpv_bid_source = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.BiddingSourceEnum.BiddingSource effective_percent_cpc_bid_source = 35 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -222,70 +221,73 @@ 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.v9.common.CustomParameter url_custom_parameters = 14; + repeated google.ads.googleads.v12.common.CustomParameter url_custom_parameters = 14; // The ad group criterion. // // Exactly one must be set. oneof criterion { // Immutable. Keyword. - google.ads.googleads.v9.common.KeywordInfo keyword = 27 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.KeywordInfo keyword = 27 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Placement. - google.ads.googleads.v9.common.PlacementInfo placement = 28 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.PlacementInfo placement = 28 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile app category. - google.ads.googleads.v9.common.MobileAppCategoryInfo mobile_app_category = 29 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileAppCategoryInfo mobile_app_category = 29 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile application. - google.ads.googleads.v9.common.MobileApplicationInfo mobile_application = 30 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileApplicationInfo mobile_application = 30 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Listing group. - google.ads.googleads.v9.common.ListingGroupInfo listing_group = 32 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ListingGroupInfo listing_group = 32 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Age range. - google.ads.googleads.v9.common.AgeRangeInfo age_range = 36 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.AgeRangeInfo age_range = 36 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Gender. - google.ads.googleads.v9.common.GenderInfo gender = 37 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.GenderInfo gender = 37 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Income range. - google.ads.googleads.v9.common.IncomeRangeInfo income_range = 38 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.IncomeRangeInfo income_range = 38 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Parental status. - google.ads.googleads.v9.common.ParentalStatusInfo parental_status = 39 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ParentalStatusInfo parental_status = 39 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User List. - google.ads.googleads.v9.common.UserListInfo user_list = 42 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.UserListInfo user_list = 42 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Video. - google.ads.googleads.v9.common.YouTubeVideoInfo youtube_video = 40 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeVideoInfo youtube_video = 40 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Channel. - google.ads.googleads.v9.common.YouTubeChannelInfo youtube_channel = 41 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeChannelInfo youtube_channel = 41 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Topic. - google.ads.googleads.v9.common.TopicInfo topic = 43 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.TopicInfo topic = 43 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User Interest. - google.ads.googleads.v9.common.UserInterestInfo user_interest = 45 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.UserInterestInfo user_interest = 45 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Webpage - google.ads.googleads.v9.common.WebpageInfo webpage = 46 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.WebpageInfo webpage = 46 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. App Payment Model. - google.ads.googleads.v9.common.AppPaymentModelInfo app_payment_model = 47 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.AppPaymentModelInfo app_payment_model = 47 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Custom Affinity. - google.ads.googleads.v9.common.CustomAffinityInfo custom_affinity = 48 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomAffinityInfo custom_affinity = 48 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Custom Intent. - google.ads.googleads.v9.common.CustomIntentInfo custom_intent = 49 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomIntentInfo custom_intent = 49 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Custom Audience. - google.ads.googleads.v9.common.CustomAudienceInfo custom_audience = 74 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomAudienceInfo custom_audience = 74 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Combined Audience. - google.ads.googleads.v9.common.CombinedAudienceInfo combined_audience = 75 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CombinedAudienceInfo combined_audience = 75 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Audience. + google.ads.googleads.v12.common.AudienceInfo audience = 79 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/ad_group_criterion_customizer.proto b/google/ads/googleads/v12/resources/ad_group_criterion_customizer.proto similarity index 76% rename from google/ads/googleads/v9/resources/ad_group_criterion_customizer.proto rename to google/ads/googleads/v12/resources/ad_group_criterion_customizer.proto index 2d76ba4b1..2b38b5f44 100644 --- a/google/ads/googleads/v9/resources/ad_group_criterion_customizer.proto +++ b/google/ads/googleads/v12/resources/ad_group_criterion_customizer.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/customizer_value.proto"; -import "google/ads/googleads/v9/enums/customizer_value_status.proto"; +import "google/ads/googleads/v12/common/customizer_value.proto"; +import "google/ads/googleads/v12/enums/customizer_value_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionCustomizerProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A customizer value for the associated CustomizerAttribute at the // AdGroupCriterion level. @@ -69,9 +68,9 @@ message AdGroupCriterionCustomizer { ]; // Output only. The status of the ad group criterion customizer. - google.ads.googleads.v9.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/ads/googleads/v9/resources/ad_group_criterion_label.proto b/google/ads/googleads/v12/resources/ad_group_criterion_label.proto similarity index 84% rename from google/ads/googleads/v9/resources/ad_group_criterion_label.proto rename to google/ads/googleads/v12/resources/ad_group_criterion_label.proto index d89b334f1..02d5e098d 100644 --- a/google/ads/googleads/v9/resources/ad_group_criterion_label.proto +++ b/google/ads/googleads/v12/resources/ad_group_criterion_label.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionLabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group criterion label resource. diff --git a/google/ads/googleads/v9/resources/ad_group_criterion_simulation.proto b/google/ads/googleads/v12/resources/ad_group_criterion_simulation.proto similarity index 73% rename from google/ads/googleads/v9/resources/ad_group_criterion_simulation.proto rename to google/ads/googleads/v12/resources/ad_group_criterion_simulation.proto index cb9a4bfd9..e2eef71fa 100644 --- a/google/ads/googleads/v9/resources/ad_group_criterion_simulation.proto +++ b/google/ads/googleads/v12/resources/ad_group_criterion_simulation.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/simulation.proto"; -import "google/ads/googleads/v9/enums/simulation_modification_method.proto"; -import "google/ads/googleads/v9/enums/simulation_type.proto"; +import "google/ads/googleads/v12/common/simulation.proto"; +import "google/ads/googleads/v12/enums/simulation_modification_method.proto"; +import "google/ads/googleads/v12/enums/simulation_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionSimulationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group criterion simulation resource. @@ -68,10 +67,10 @@ message AdGroupCriterionSimulation { optional int64 criterion_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The field that the simulation modifies. - google.ads.googleads.v9.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. How the simulation modifies the field. - google.ads.googleads.v9.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. optional string start_date = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -82,9 +81,9 @@ message AdGroupCriterionSimulation { // List of simulation points. oneof point_list { // Output only. Simulation points if the simulation type is CPC_BID. - google.ads.googleads.v9.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/ad_group_customizer.proto b/google/ads/googleads/v12/resources/ad_group_customizer.proto similarity index 75% rename from google/ads/googleads/v9/resources/ad_group_customizer.proto rename to google/ads/googleads/v12/resources/ad_group_customizer.proto index 9b09d032c..70cb93bfe 100644 --- a/google/ads/googleads/v9/resources/ad_group_customizer.proto +++ b/google/ads/googleads/v12/resources/ad_group_customizer.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/customizer_value.proto"; -import "google/ads/googleads/v9/enums/customizer_value_status.proto"; +import "google/ads/googleads/v12/common/customizer_value.proto"; +import "google/ads/googleads/v12/enums/customizer_value_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupCustomizerProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A customizer value for the associated CustomizerAttribute at the AdGroup // level. @@ -68,9 +67,9 @@ message AdGroupCustomizer { ]; // Output only. The status of the ad group customizer. - google.ads.googleads.v9.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/ads/googleads/v9/resources/ad_group_extension_setting.proto b/google/ads/googleads/v12/resources/ad_group_extension_setting.proto similarity index 77% rename from google/ads/googleads/v9/resources/ad_group_extension_setting.proto rename to google/ads/googleads/v12/resources/ad_group_extension_setting.proto index 5f13588f5..8d7c88e49 100644 --- a/google/ads/googleads/v9/resources/ad_group_extension_setting.proto +++ b/google/ads/googleads/v12/resources/ad_group_extension_setting.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/extension_setting_device.proto"; -import "google/ads/googleads/v9/enums/extension_type.proto"; +import "google/ads/googleads/v12/enums/extension_setting_device.proto"; +import "google/ads/googleads/v12/enums/extension_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupExtensionSettingProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AdGroupExtensionSetting resource. @@ -52,7 +51,7 @@ message AdGroupExtensionSetting { ]; // Immutable. The extension type of the ad group extension setting. - google.ads.googleads.v9.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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. @@ -75,5 +74,5 @@ message AdGroupExtensionSetting { }]; // The device for which the extensions will serve. Optional. - google.ads.googleads.v9.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5; + google.ads.googleads.v12.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5; } diff --git a/google/ads/googleads/v9/resources/ad_group_feed.proto b/google/ads/googleads/v12/resources/ad_group_feed.proto similarity index 71% rename from google/ads/googleads/v9/resources/ad_group_feed.proto rename to google/ads/googleads/v12/resources/ad_group_feed.proto index 44d67750a..f236d62dc 100644 --- a/google/ads/googleads/v9/resources/ad_group_feed.proto +++ b/google/ads/googleads/v12/resources/ad_group_feed.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/matching_function.proto"; -import "google/ads/googleads/v9/enums/feed_link_status.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/common/matching_function.proto"; +import "google/ads/googleads/v12/enums/feed_link_status.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupFeedProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AdGroupFeed resource. @@ -70,14 +69,14 @@ message AdGroupFeed { // Indicates which placeholder types the feed may populate under the connected // ad group. Required. - repeated google.ads.googleads.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4; + repeated google.ads.googleads.v12.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.v9.common.MatchingFunction matching_function = 5; + google.ads.googleads.v12.common.MatchingFunction matching_function = 5; // Output only. Status of the ad group feed. // This field is read-only. - google.ads.googleads.v9.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/ad_group_label.proto b/google/ads/googleads/v12/resources/ad_group_label.proto similarity index 83% rename from google/ads/googleads/v9/resources/ad_group_label.proto rename to google/ads/googleads/v12/resources/ad_group_label.proto index 70789b107..46fbdedb2 100644 --- a/google/ads/googleads/v9/resources/ad_group_label.proto +++ b/google/ads/googleads/v12/resources/ad_group_label.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupLabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group label resource. diff --git a/google/ads/googleads/v9/resources/ad_group_simulation.proto b/google/ads/googleads/v12/resources/ad_group_simulation.proto similarity index 67% rename from google/ads/googleads/v9/resources/ad_group_simulation.proto rename to google/ads/googleads/v12/resources/ad_group_simulation.proto index b2de488aa..981b42456 100644 --- a/google/ads/googleads/v9/resources/ad_group_simulation.proto +++ b/google/ads/googleads/v12/resources/ad_group_simulation.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/simulation.proto"; -import "google/ads/googleads/v9/enums/simulation_modification_method.proto"; -import "google/ads/googleads/v9/enums/simulation_type.proto"; +import "google/ads/googleads/v12/common/simulation.proto"; +import "google/ads/googleads/v12/enums/simulation_modification_method.proto"; +import "google/ads/googleads/v12/enums/simulation_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdGroupSimulationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad group simulation resource. @@ -66,10 +65,10 @@ 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.v9.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. How the simulation modifies the field. - google.ads.googleads.v9.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. optional string start_date = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -80,15 +79,15 @@ message AdGroupSimulation { // List of simulation points. oneof point_list { // Output only. Simulation points if the simulation type is CPC_BID. - google.ads.googleads.v9.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.CpvBidSimulationPointList cpv_bid_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetCpaSimulationPointList target_cpa_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/ad_parameter.proto b/google/ads/googleads/v12/resources/ad_parameter.proto similarity index 87% rename from google/ads/googleads/v9/resources/ad_parameter.proto rename to google/ads/googleads/v12/resources/ad_parameter.proto index 629d2dbda..963e0363d 100644 --- a/google/ads/googleads/v9/resources/ad_parameter.proto +++ b/google/ads/googleads/v12/resources/ad_parameter.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdParameterProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad parameter resource. @@ -36,7 +35,7 @@ option ruby_package = "Google::Ads::GoogleAds::V9::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/google/ads/googleads/v9/resources/ad_schedule_view.proto b/google/ads/googleads/v12/resources/ad_schedule_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/ad_schedule_view.proto rename to google/ads/googleads/v12/resources/ad_schedule_view.proto index a69b26e81..817768929 100644 --- a/google/ads/googleads/v9/resources/ad_schedule_view.proto +++ b/google/ads/googleads/v12/resources/ad_schedule_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AdScheduleViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ad schedule view resource. diff --git a/google/ads/googleads/v9/resources/age_range_view.proto b/google/ads/googleads/v12/resources/age_range_view.proto similarity index 78% rename from google/ads/googleads/v9/resources/age_range_view.proto rename to google/ads/googleads/v12/resources/age_range_view.proto index 7c88ceabc..72a729265 100644 --- a/google/ads/googleads/v9/resources/age_range_view.proto +++ b/google/ads/googleads/v12/resources/age_range_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AgeRangeViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the age range view resource. diff --git a/google/ads/googleads/v12/resources/asset.proto b/google/ads/googleads/v12/resources/asset.proto new file mode 100644 index 000000000..09dcf1cfb --- /dev/null +++ b/google/ads/googleads/v12/resources/asset.proto @@ -0,0 +1,186 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/common/asset_types.proto"; +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/asset_source.proto"; +import "google/ads/googleads/v12/enums/asset_type.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AssetProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.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.v12.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.v12.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]; + + // The specific type of the asset. + oneof asset_data { + // Immutable. A YouTube video asset. + google.ads.googleads.v12.common.YoutubeVideoAsset youtube_video_asset = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. A media bundle asset. + google.ads.googleads.v12.common.MediaBundleAsset media_bundle_asset = 6 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. An image asset. + google.ads.googleads.v12.common.ImageAsset image_asset = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Immutable. A text asset. + google.ads.googleads.v12.common.TextAsset text_asset = 8 [(google.api.field_behavior) = IMMUTABLE]; + + // A lead form asset. + google.ads.googleads.v12.common.LeadFormAsset lead_form_asset = 9; + + // A book on google asset. + google.ads.googleads.v12.common.BookOnGoogleAsset book_on_google_asset = 10; + + // A promotion asset. + google.ads.googleads.v12.common.PromotionAsset promotion_asset = 15; + + // A callout asset. + google.ads.googleads.v12.common.CalloutAsset callout_asset = 20; + + // A structured snippet asset. + google.ads.googleads.v12.common.StructuredSnippetAsset structured_snippet_asset = 21; + + // A sitelink asset. + google.ads.googleads.v12.common.SitelinkAsset sitelink_asset = 22; + + // A page feed asset. + google.ads.googleads.v12.common.PageFeedAsset page_feed_asset = 23; + + // A dynamic education asset. + google.ads.googleads.v12.common.DynamicEducationAsset dynamic_education_asset = 24; + + // A mobile app asset. + google.ads.googleads.v12.common.MobileAppAsset mobile_app_asset = 25; + + // A hotel callout asset. + google.ads.googleads.v12.common.HotelCalloutAsset hotel_callout_asset = 26; + + // A call asset. + google.ads.googleads.v12.common.CallAsset call_asset = 27; + + // A price asset. + google.ads.googleads.v12.common.PriceAsset price_asset = 28; + + // Immutable. A call to action asset. + google.ads.googleads.v12.common.CallToActionAsset call_to_action_asset = 29 [(google.api.field_behavior) = IMMUTABLE]; + + // A dynamic real estate asset. + google.ads.googleads.v12.common.DynamicRealEstateAsset dynamic_real_estate_asset = 30; + + // A dynamic custom asset. + google.ads.googleads.v12.common.DynamicCustomAsset dynamic_custom_asset = 31; + + // A dynamic hotels and rentals asset. + google.ads.googleads.v12.common.DynamicHotelsAndRentalsAsset dynamic_hotels_and_rentals_asset = 32; + + // A dynamic flights asset. + google.ads.googleads.v12.common.DynamicFlightsAsset dynamic_flights_asset = 33; + + // Immutable. A discovery carousel card asset. + google.ads.googleads.v12.common.DiscoveryCarouselCardAsset discovery_carousel_card_asset = 34 [(google.api.field_behavior) = IMMUTABLE]; + + // A dynamic travel asset. + google.ads.googleads.v12.common.DynamicTravelAsset dynamic_travel_asset = 35; + + // A dynamic local asset. + google.ads.googleads.v12.common.DynamicLocalAsset dynamic_local_asset = 36; + + // A dynamic jobs asset. + google.ads.googleads.v12.common.DynamicJobsAsset dynamic_jobs_asset = 37; + + // Output only. A location asset. + google.ads.googleads.v12.common.LocationAsset location_asset = 39 [(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.v12.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.v12.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.v12.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v9/resources/asset_field_type_view.proto b/google/ads/googleads/v12/resources/asset_field_type_view.proto similarity index 74% rename from google/ads/googleads/v9/resources/asset_field_type_view.proto rename to google/ads/googleads/v12/resources/asset_field_type_view.proto index 664255186..4bbc10028 100644 --- a/google/ads/googleads/v9/resources/asset_field_type_view.proto +++ b/google/ads/googleads/v12/resources/asset_field_type_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetFieldTypeViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AssetFieldTypeView resource. @@ -53,5 +52,5 @@ message AssetFieldTypeView { ]; // Output only. The asset field type of the asset field type view. - google.ads.googleads.v9.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/asset_group.proto b/google/ads/googleads/v12/resources/asset_group.proto similarity index 71% rename from google/ads/googleads/v9/resources/asset_group.proto rename to google/ads/googleads/v12/resources/asset_group.proto index 073775779..d459120cd 100644 --- a/google/ads/googleads/v9/resources/asset_group.proto +++ b/google/ads/googleads/v12/resources/asset_group.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. @@ -14,25 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_group_status.proto"; +import "google/ads/googleads/v12/enums/ad_strength.proto"; +import "google/ads/googleads/v12/enums/asset_group_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetGroupProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // An asset group. -// AssetGroupAsset will be used to link an asset to the asset group. -// AssetGroupHint will be used to associate a hint to an asset group. +// AssetGroupAsset is used to link an asset to the asset group. +// AssetGroupSignal is used to associate a signal to an asset group. message AssetGroup { option (google.api.resource) = { type: "googleads.googleapis.com/AssetGroup" @@ -67,16 +67,16 @@ message AssetGroup { string name = 3 [(google.api.field_behavior) = REQUIRED]; // A list of final URLs after all cross domain redirects. In performance max, - // by default, the urls will be eligible for expansion unless opted out. + // by default, the urls are eligible for expansion unless opted out. repeated string final_urls = 4; // A list of final mobile URLs after all cross domain redirects. In - // performance max, by default, the urls will be eligible for expansion + // performance max, by default, the urls are eligible for expansion // unless opted out. repeated string final_mobile_urls = 5; // The status of the asset group. - google.ads.googleads.v9.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6; + google.ads.googleads.v12.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6; // First part of text that may appear appended to the url displayed in // the ad. @@ -85,4 +85,7 @@ 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.v12.enums.AdStrengthEnum.AdStrength ad_strength = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/asset_group_asset.proto b/google/ads/googleads/v12/resources/asset_group_asset.proto similarity index 67% rename from google/ads/googleads/v9/resources/asset_group_asset.proto rename to google/ads/googleads/v12/resources/asset_group_asset.proto index 6962f3055..be6688022 100644 --- a/google/ads/googleads/v9/resources/asset_group_asset.proto +++ b/google/ads/googleads/v12/resources/asset_group_asset.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/policy_summary.proto"; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/asset_link_status.proto"; -import "google/ads/googleads/v9/enums/asset_performance_label.proto"; +import "google/ads/googleads/v12/common/policy_summary.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_performance_label.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetGroupAssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // AssetGroupAsset is the link between an asset and an asset group. // Adding an AssetGroupAsset links an asset with an asset group. @@ -68,16 +67,16 @@ message AssetGroupAsset { } ]; - // The description of the placement of the asset within the asset group. E.g.: - // HEADLINE, YOUTUBE_VIDEO etc - google.ads.googleads.v9.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.v12.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4; // The status of the link between an asset and asset group. - google.ads.googleads.v9.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; + google.ads.googleads.v12.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; // Output only. The performance of this asset group asset. - google.ads.googleads.v9.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.PolicySummary policy_summary = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.PolicySummary policy_summary = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/asset_group_listing_group_filter.proto b/google/ads/googleads/v12/resources/asset_group_listing_group_filter.proto similarity index 72% rename from google/ads/googleads/v9/resources/asset_group_listing_group_filter.proto rename to google/ads/googleads/v12/resources/asset_group_listing_group_filter.proto index afc0aeb2a..2bdb8b626 100644 --- a/google/ads/googleads/v9/resources/asset_group_listing_group_filter.proto +++ b/google/ads/googleads/v12/resources/asset_group_listing_group_filter.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. @@ -14,27 +14,26 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/listing_group_filter_bidding_category_level.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_custom_attribute_index.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_product_channel.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_product_condition.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_product_type_level.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_type_enum.proto"; -import "google/ads/googleads/v9/enums/listing_group_filter_vertical.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_bidding_category_level.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_custom_attribute_index.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_product_channel.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_product_condition.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_product_type_level.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_type_enum.proto"; +import "google/ads/googleads/v12/enums/listing_group_filter_vertical.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetGroupListingGroupFilterProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // AssetGroupListingGroupFilter represents a listing group filter tree node in // an asset group. @@ -67,11 +66,11 @@ message AssetGroupListingGroupFilter { int64 id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Type of a listing group filter node. - google.ads.googleads.v9.enums.ListingGroupFilterTypeEnum.ListingGroupFilterType type = 4 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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.v9.enums.ListingGroupFilterVerticalEnum.ListingGroupFilterVertical vertical = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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. @@ -102,7 +101,7 @@ message ListingGroupFilterDimension { optional int64 id = 1; // Indicates the level of the category in the taxonomy. - google.ads.googleads.v9.enums.ListingGroupFilterBiddingCategoryLevelEnum.ListingGroupFilterBiddingCategoryLevel level = 2; + google.ads.googleads.v12.enums.ListingGroupFilterBiddingCategoryLevelEnum.ListingGroupFilterBiddingCategoryLevel level = 2; } // Brand of the product. @@ -114,7 +113,13 @@ message ListingGroupFilterDimension { // Locality of a product offer. message ProductChannel { // Value of the locality. - google.ads.googleads.v9.enums.ListingGroupFilterProductChannelEnum.ListingGroupFilterProductChannel channel = 1; + google.ads.googleads.v12.enums.ListingGroupFilterProductChannelEnum.ListingGroupFilterProductChannel channel = 1; + } + + // Condition of a product offer. + message ProductCondition { + // Value of the condition. + google.ads.googleads.v12.enums.ListingGroupFilterProductConditionEnum.ListingGroupFilterProductCondition condition = 1; } // Custom attribute of a product offer. @@ -123,13 +128,7 @@ message ListingGroupFilterDimension { optional string value = 1; // Indicates the index of the custom attribute. - google.ads.googleads.v9.enums.ListingGroupFilterCustomAttributeIndexEnum.ListingGroupFilterCustomAttributeIndex index = 2; - } - - // Condition of a product offer. - message ProductCondition { - // Value of the condition. - google.ads.googleads.v9.enums.ListingGroupFilterProductConditionEnum.ListingGroupFilterProductCondition condition = 1; + google.ads.googleads.v12.enums.ListingGroupFilterCustomAttributeIndexEnum.ListingGroupFilterCustomAttributeIndex index = 2; } // Item id of a product offer. @@ -144,7 +143,7 @@ message ListingGroupFilterDimension { optional string value = 1; // Level of the type. - google.ads.googleads.v9.enums.ListingGroupFilterProductTypeLevelEnum.ListingGroupFilterProductTypeLevel level = 2; + google.ads.googleads.v12.enums.ListingGroupFilterProductTypeLevelEnum.ListingGroupFilterProductTypeLevel level = 2; } // Dimension of one of the types below is always present. diff --git a/google/ads/googleads/v9/resources/asset_group_product_group_view.proto b/google/ads/googleads/v12/resources/asset_group_product_group_view.proto similarity index 64% rename from google/ads/googleads/v9/resources/asset_group_product_group_view.proto rename to google/ads/googleads/v12/resources/asset_group_product_group_view.proto index 680e5d93b..ec875e64b 100644 --- a/google/ads/googleads/v9/resources/asset_group_product_group_view.proto +++ b/google/ads/googleads/v12/resources/asset_group_product_group_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetGroupProductGroupViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the AssetGroupProductGroupView resource. @@ -48,4 +47,20 @@ message AssetGroupProductGroupView { type: "googleads.googleapis.com/AssetGroupProductGroupView" } ]; + + // Output only. The asset group associated with the listing group filter. + string asset_group = 2 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroup" + } + ]; + + // Output only. The resource name of the asset group listing group filter. + string asset_group_listing_group_filter = 4 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroupListingGroupFilter" + } + ]; } diff --git a/google/ads/googleads/v12/resources/asset_group_signal.proto b/google/ads/googleads/v12/resources/asset_group_signal.proto new file mode 100644 index 000000000..c2f4cd812 --- /dev/null +++ b/google/ads/googleads/v12/resources/asset_group_signal.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.v12.resources; + +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AssetGroupSignalProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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. +// Performance Max uses the signal to look for new people with similar or +// stronger intent to find conversions across Search, Display, Video, and more. +message AssetGroupSignal { + option (google.api.resource) = { + type: "googleads.googleapis.com/AssetGroupSignal" + pattern: "customers/{customer_id}/assetGroupSignals/{asset_group_id}~{criterion_id}" + }; + + // Immutable. The resource name of the asset group signal. + // Asset group signal resource name have the form: + // + // `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroupSignal" + } + ]; + + // Immutable. The asset group which this asset group signal belongs to. + string asset_group = 2 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroup" + } + ]; + + // Immutable. The signal(audience criterion) to be used by the performance max campaign. + google.ads.googleads.v12.common.AudienceInfo audience = 3 [(google.api.field_behavior) = IMMUTABLE]; +} diff --git a/google/ads/googleads/v9/resources/asset_set.proto b/google/ads/googleads/v12/resources/asset_set.proto similarity index 53% rename from google/ads/googleads/v9/resources/asset_set.proto rename to google/ads/googleads/v12/resources/asset_set.proto index c681e2e50..95aded3bf 100644 --- a/google/ads/googleads/v9/resources/asset_set.proto +++ b/google/ads/googleads/v12/resources/asset_set.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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_set_status.proto"; -import "google/ads/googleads/v9/enums/asset_set_type.proto"; +import "google/ads/googleads/v12/common/asset_set_types.proto"; +import "google/ads/googleads/v12/enums/asset_set_status.proto"; +import "google/ads/googleads/v12/enums/asset_set_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // An asset set representing a collection of assets. // Use AssetSetAsset to link an asset to the asset set. @@ -48,6 +48,9 @@ message AssetSet { 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: // @@ -64,14 +67,36 @@ message AssetSet { string name = 2 [(google.api.field_behavior) = REQUIRED]; // Required. Immutable. The type of the asset set. Required. - google.ads.googleads.v9.enums.AssetSetTypeEnum.AssetSetType type = 3 [ + google.ads.googleads.v12.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.v9.enums.AssetSetStatusEnum.AssetSetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; + + // 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.v12.common.LocationSet location_set = 7; + + // Business Profile location group asset set data. + google.ads.googleads.v12.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.v12.common.ChainLocationGroup chain_location_group = 9; + } } diff --git a/google/ads/googleads/v9/resources/asset_set_asset.proto b/google/ads/googleads/v12/resources/asset_set_asset.proto similarity index 77% rename from google/ads/googleads/v9/resources/asset_set_asset.proto rename to google/ads/googleads/v12/resources/asset_set_asset.proto index effa745ea..9f7efd06c 100644 --- a/google/ads/googleads/v9/resources/asset_set_asset.proto +++ b/google/ads/googleads/v12/resources/asset_set_asset.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_set_asset_status.proto"; +import "google/ads/googleads/v12/enums/asset_set_asset_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "AssetSetAssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // AssetSetAsset is the link between an asset and an asset set. // Adding an AssetSetAsset links an asset with an asset set. @@ -66,5 +65,5 @@ message AssetSetAsset { ]; // Output only. The status of the asset set asset. Read-only. - google.ads.googleads.v9.enums.AssetSetAssetStatusEnum.AssetSetAssetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AssetSetAssetStatusEnum.AssetSetAssetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v12/resources/asset_set_type_view.proto b/google/ads/googleads/v12/resources/asset_set_type_view.proto new file mode 100644 index 000000000..4190667b1 --- /dev/null +++ b/google/ads/googleads/v12/resources/asset_set_type_view.proto @@ -0,0 +1,57 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/enums/asset_set_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AssetSetTypeViewProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.enums.AssetSetTypeEnum.AssetSetType asset_set_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v12/resources/audience.proto b/google/ads/googleads/v12/resources/audience.proto new file mode 100644 index 000000000..d4bf6dbb3 --- /dev/null +++ b/google/ads/googleads/v12/resources/audience.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.v12.resources; + +import "google/ads/googleads/v12/common/audiences.proto"; +import "google/ads/googleads/v12/enums/audience_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AudienceProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the Audience resource. + +// 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. +message Audience { + option (google.api.resource) = { + type: "googleads.googleapis.com/Audience" + pattern: "customers/{customer_id}/audiences/{audience_id}" + }; + + // Immutable. The resource name of the audience. + // Audience names have the form: + // + // `customers/{customer_id}/audiences/{audience_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Audience" + } + ]; + + // Output only. ID of the audience. + int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Status of this audience. Indicates whether the audience + // is enabled or removed. + google.ads.googleads.v12.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 + // maximum length of 255. + string name = 4 [(google.api.field_behavior) = REQUIRED]; + + // Description of this audience. + string description = 5; + + // Positive dimensions specifying the audience composition. + repeated google.ads.googleads.v12.common.AudienceDimension dimensions = 6; + + // Negative dimension specifying the audience composition. + google.ads.googleads.v12.common.AudienceExclusionDimension exclusion_dimension = 7; +} diff --git a/google/ads/googleads/v9/resources/batch_job.proto b/google/ads/googleads/v12/resources/batch_job.proto similarity index 86% rename from google/ads/googleads/v9/resources/batch_job.proto rename to google/ads/googleads/v12/resources/batch_job.proto index 1c54b863f..75a7c9940 100644 --- a/google/ads/googleads/v9/resources/batch_job.proto +++ b/google/ads/googleads/v12/resources/batch_job.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/batch_job_status.proto"; +import "google/ads/googleads/v12/enums/batch_job_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BatchJobProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the batch job resource. @@ -90,7 +89,7 @@ message BatchJob { BatchJobMetadata metadata = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Status of this batch job. - google.ads.googleads.v9.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. diff --git a/google/ads/googleads/v9/resources/bidding_data_exclusion.proto b/google/ads/googleads/v12/resources/bidding_data_exclusion.proto similarity index 76% rename from google/ads/googleads/v9/resources/bidding_data_exclusion.proto rename to google/ads/googleads/v12/resources/bidding_data_exclusion.proto index fc45d05f4..6835c4056 100644 --- a/google/ads/googleads/v9/resources/bidding_data_exclusion.proto +++ b/google/ads/googleads/v12/resources/bidding_data_exclusion.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/seasonality_event_scope.proto"; -import "google/ads/googleads/v9/enums/seasonality_event_status.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_type.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/seasonality_event_scope.proto"; +import "google/ads/googleads/v12/enums/seasonality_event_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BiddingDataExclusionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Represents a bidding data exclusion. // @@ -58,10 +57,10 @@ message BiddingDataExclusion { int64 data_exclusion_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // The scope of the data exclusion. - google.ads.googleads.v9.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3; + google.ads.googleads.v12.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3; // Output only. The status of the data exclusion. - google.ads.googleads.v9.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -87,7 +86,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.v9.enums.DeviceEnum.Device devices = 9; + repeated google.ads.googleads.v12.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 @@ -104,5 +103,5 @@ 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.v9.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 11; + repeated google.ads.googleads.v12.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 11; } diff --git a/google/ads/googleads/v9/resources/bidding_seasonality_adjustment.proto b/google/ads/googleads/v12/resources/bidding_seasonality_adjustment.proto similarity index 78% rename from google/ads/googleads/v9/resources/bidding_seasonality_adjustment.proto rename to google/ads/googleads/v12/resources/bidding_seasonality_adjustment.proto index 089cf36dc..a9a980bac 100644 --- a/google/ads/googleads/v9/resources/bidding_seasonality_adjustment.proto +++ b/google/ads/googleads/v12/resources/bidding_seasonality_adjustment.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/device.proto"; -import "google/ads/googleads/v9/enums/seasonality_event_scope.proto"; -import "google/ads/googleads/v9/enums/seasonality_event_status.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_type.proto"; +import "google/ads/googleads/v12/enums/device.proto"; +import "google/ads/googleads/v12/enums/seasonality_event_scope.proto"; +import "google/ads/googleads/v12/enums/seasonality_event_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BiddingSeasonalityAdjustmentProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Represents a bidding seasonality adjustment. // @@ -58,10 +57,10 @@ message BiddingSeasonalityAdjustment { int64 seasonality_adjustment_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // The scope of the seasonality adjustment. - google.ads.googleads.v9.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3; + google.ads.googleads.v12.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3; // Output only. The status of the seasonality adjustment. - google.ads.googleads.v9.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -88,7 +87,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.v9.enums.DeviceEnum.Device devices = 9; + repeated google.ads.googleads.v12.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 @@ -110,5 +109,5 @@ 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.v9.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12; + repeated google.ads.googleads.v12.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12; } diff --git a/google/ads/googleads/v9/resources/bidding_strategy.proto b/google/ads/googleads/v12/resources/bidding_strategy.proto similarity index 71% rename from google/ads/googleads/v9/resources/bidding_strategy.proto rename to google/ads/googleads/v12/resources/bidding_strategy.proto index 177ed108e..cd0f96136 100644 --- a/google/ads/googleads/v9/resources/bidding_strategy.proto +++ b/google/ads/googleads/v12/resources/bidding_strategy.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/bidding.proto"; -import "google/ads/googleads/v9/enums/bidding_strategy_status.proto"; -import "google/ads/googleads/v9/enums/bidding_strategy_type.proto"; +import "google/ads/googleads/v12/common/bidding.proto"; +import "google/ads/googleads/v12/enums/bidding_strategy_status.proto"; +import "google/ads/googleads/v12/enums/bidding_strategy_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategyProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the BiddingStrategy resource @@ -65,13 +64,13 @@ message BiddingStrategy { // Output only. The status of the bidding strategy. // // This field is read-only. - google.ads.googleads.v9.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). // @@ -93,6 +92,13 @@ message BiddingStrategy { // This field is read-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. @@ -110,30 +116,30 @@ 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.v9.common.EnhancedCpc enhanced_cpc = 7; + google.ads.googleads.v12.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.v9.common.MaximizeConversionValue maximize_conversion_value = 21; + google.ads.googleads.v12.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.v9.common.MaximizeConversions maximize_conversions = 22; + google.ads.googleads.v12.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.v9.common.TargetCpa target_cpa = 9; + google.ads.googleads.v12.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.v9.common.TargetImpressionShare target_impression_share = 48; + google.ads.googleads.v12.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.v9.common.TargetRoas target_roas = 11; + google.ads.googleads.v12.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.v9.common.TargetSpend target_spend = 12; + google.ads.googleads.v12.common.TargetSpend target_spend = 12; } } diff --git a/google/ads/googleads/v9/resources/bidding_strategy_simulation.proto b/google/ads/googleads/v12/resources/bidding_strategy_simulation.proto similarity index 69% rename from google/ads/googleads/v9/resources/bidding_strategy_simulation.proto rename to google/ads/googleads/v12/resources/bidding_strategy_simulation.proto index 1b725121b..5fb4cf139 100644 --- a/google/ads/googleads/v9/resources/bidding_strategy_simulation.proto +++ b/google/ads/googleads/v12/resources/bidding_strategy_simulation.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/simulation.proto"; -import "google/ads/googleads/v9/enums/simulation_modification_method.proto"; -import "google/ads/googleads/v9/enums/simulation_type.proto"; +import "google/ads/googleads/v12/common/simulation.proto"; +import "google/ads/googleads/v12/enums/simulation_modification_method.proto"; +import "google/ads/googleads/v12/enums/simulation_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategySimulationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the bidding strategy simulation resource. @@ -60,10 +59,10 @@ message BiddingStrategySimulation { int64 bidding_strategy_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The field that the simulation modifies. - google.ads.googleads.v9.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. How the simulation modifies the field. - google.ads.googleads.v9.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. string start_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -74,9 +73,9 @@ message BiddingStrategySimulation { // List of simulation points. oneof point_list { // Output only. Simulation points if the simulation type is TARGET_CPA. - google.ads.googleads.v9.common.TargetCpaSimulationPointList target_cpa_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetRoasSimulationPointList target_roas_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.TargetRoasSimulationPointList target_roas_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/billing_setup.proto b/google/ads/googleads/v12/resources/billing_setup.proto similarity index 81% rename from google/ads/googleads/v9/resources/billing_setup.proto rename to google/ads/googleads/v12/resources/billing_setup.proto index 4d5a1cd00..121ac998a 100644 --- a/google/ads/googleads/v9/resources/billing_setup.proto +++ b/google/ads/googleads/v12/resources/billing_setup.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/billing_setup_status.proto"; -import "google/ads/googleads/v9/enums/time_type.proto"; +import "google/ads/googleads/v12/enums/billing_setup_status.proto"; +import "google/ads/googleads/v12/enums/time_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "BillingSetupProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the BillingSetup resource. @@ -46,7 +45,8 @@ message BillingSetup { // 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". + // 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. @@ -60,14 +60,15 @@ message BillingSetup { // 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". + // 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, e.g. - // when a sequential liability agreement has been arranged. + // 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]; } @@ -86,7 +87,7 @@ message BillingSetup { optional int64 id = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The status of the billing setup. - google.ads.googleads.v9.enums.BillingSetupStatusEnum.BillingSetupStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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: @@ -123,7 +124,7 @@ message BillingSetup { string start_date_time = 16 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. The start time as a type. Only NOW is allowed. - google.ads.googleads.v9.enums.TimeTypeEnum.TimeType start_time_type = 10 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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 @@ -133,6 +134,6 @@ message BillingSetup { 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.v9.enums.TimeTypeEnum.TimeType end_time_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.TimeTypeEnum.TimeType end_time_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/call_view.proto b/google/ads/googleads/v12/resources/call_view.proto similarity index 69% rename from google/ads/googleads/v9/resources/call_view.proto rename to google/ads/googleads/v12/resources/call_view.proto index 3b25042d6..5cce98169 100644 --- a/google/ads/googleads/v9/resources/call_view.proto +++ b/google/ads/googleads/v12/resources/call_view.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/call_tracking_display_location.proto"; -import "google/ads/googleads/v9/enums/call_type.proto"; -import "google/ads/googleads/v9/enums/google_voice_call_status.proto"; +import "google/ads/googleads/v12/enums/call_tracking_display_location.proto"; +import "google/ads/googleads/v12/enums/call_type.proto"; +import "google/ads/googleads/v12/enums/google_voice_call_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CallViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the call view resource. @@ -70,11 +69,11 @@ message CallView { string end_call_date_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The call tracking display location. - google.ads.googleads.v9.enums.CallTrackingDisplayLocationEnum.CallTrackingDisplayLocation call_tracking_display_location = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CallTrackingDisplayLocationEnum.CallTrackingDisplayLocation call_tracking_display_location = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of the call. - google.ads.googleads.v9.enums.CallTypeEnum.CallType type = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CallTypeEnum.CallType type = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The status of the call. - google.ads.googleads.v9.enums.GoogleVoiceCallStatusEnum.GoogleVoiceCallStatus call_status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.GoogleVoiceCallStatusEnum.GoogleVoiceCallStatus call_status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/campaign.proto b/google/ads/googleads/v12/resources/campaign.proto similarity index 55% rename from google/ads/googleads/v9/resources/campaign.proto rename to google/ads/googleads/v12/resources/campaign.proto index 05b761493..5b23c14fb 100644 --- a/google/ads/googleads/v9/resources/campaign.proto +++ b/google/ads/googleads/v12/resources/campaign.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. @@ -14,43 +14,47 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/common/bidding.proto"; -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/frequency_cap.proto"; -import "google/ads/googleads/v9/common/real_time_bidding_setting.proto"; -import "google/ads/googleads/v9/common/targeting_setting.proto"; -import "google/ads/googleads/v9/enums/ad_serving_optimization_status.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_sub_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/app_campaign_app_store.proto"; -import "google/ads/googleads/v9/enums/app_campaign_bidding_strategy_goal_type.proto"; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/bidding_strategy_type.proto"; -import "google/ads/googleads/v9/enums/brand_safety_suitability.proto"; -import "google/ads/googleads/v9/enums/campaign_experiment_type.proto"; -import "google/ads/googleads/v9/enums/campaign_serving_status.proto"; -import "google/ads/googleads/v9/enums/campaign_status.proto"; -import "google/ads/googleads/v9/enums/location_source_type.proto"; -import "google/ads/googleads/v9/enums/negative_geo_target_type.proto"; -import "google/ads/googleads/v9/enums/optimization_goal_type.proto"; -import "google/ads/googleads/v9/enums/payment_mode.proto"; -import "google/ads/googleads/v9/enums/positive_geo_target_type.proto"; -import "google/ads/googleads/v9/enums/vanity_pharma_display_url_mode.proto"; -import "google/ads/googleads/v9/enums/vanity_pharma_text.proto"; +package google.ads.googleads.v12.resources; + +import "google/ads/googleads/v12/common/bidding.proto"; +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/frequency_cap.proto"; +import "google/ads/googleads/v12/common/real_time_bidding_setting.proto"; +import "google/ads/googleads/v12/common/targeting_setting.proto"; +import "google/ads/googleads/v12/enums/ad_serving_optimization_status.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_sub_type.proto"; +import "google/ads/googleads/v12/enums/advertising_channel_type.proto"; +import "google/ads/googleads/v12/enums/app_campaign_app_store.proto"; +import "google/ads/googleads/v12/enums/app_campaign_bidding_strategy_goal_type.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_set_type.proto"; +import "google/ads/googleads/v12/enums/bidding_strategy_system_status.proto"; +import "google/ads/googleads/v12/enums/bidding_strategy_type.proto"; +import "google/ads/googleads/v12/enums/brand_safety_suitability.proto"; +import "google/ads/googleads/v12/enums/campaign_experiment_type.proto"; +import "google/ads/googleads/v12/enums/campaign_primary_status.proto"; +import "google/ads/googleads/v12/enums/campaign_primary_status_reason.proto"; +import "google/ads/googleads/v12/enums/campaign_serving_status.proto"; +import "google/ads/googleads/v12/enums/campaign_status.proto"; +import "google/ads/googleads/v12/enums/location_source_type.proto"; +import "google/ads/googleads/v12/enums/negative_geo_target_type.proto"; +import "google/ads/googleads/v12/enums/optimization_goal_type.proto"; +import "google/ads/googleads/v12/enums/payment_mode.proto"; +import "google/ads/googleads/v12/enums/performance_max_upgrade_status.proto"; +import "google/ads/googleads/v12/enums/positive_geo_target_type.proto"; +import "google/ads/googleads/v12/enums/vanity_pharma_display_url_mode.proto"; +import "google/ads/googleads/v12/enums/vanity_pharma_text.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Campaign resource. @@ -61,6 +65,29 @@ 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.v12.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. @@ -87,11 +114,12 @@ message Campaign { // 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. @@ -103,13 +131,6 @@ message Campaign { }]; } - // 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.v9.enums.OptimizationGoalTypeEnum.OptimizationGoalType optimization_goal_types = 1; - } - // The setting for Shopping campaigns. Defines the universe of products that // can be advertised by the campaign, and how this campaign interacts with // other Shopping campaigns. @@ -120,11 +141,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,6 +165,9 @@ message Campaign { // Whether to include local products. optional bool enable_local = 8; + + // Immutable. Whether to target Vehicle Listing inventory. + bool use_vehicle_inventory = 9 [(google.api.field_behavior) = IMMUTABLE]; } // Campaign-level settings for tracking information. @@ -146,39 +179,39 @@ message Campaign { // Represents a collection of settings related to ads geotargeting. message GeoTargetTypeSetting { // The setting used for positive geotargeting in this particular campaign. - google.ads.googleads.v9.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1; + google.ads.googleads.v12.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1; // The setting used for negative geotargeting in this particular campaign. - google.ads.googleads.v9.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2; + google.ads.googleads.v12.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.v9.enums.LocationSourceTypeEnum.LocationSourceType location_source_type = 1; + google.ads.googleads.v12.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.v9.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1; + google.ads.googleads.v12.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.v9.enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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.v9.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1; + google.ads.googleads.v12.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.v9.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2; + google.ads.googleads.v12.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2; } // Selective optimization setting for this campaign, which includes a set of @@ -190,6 +223,38 @@ message Campaign { }]; } + // 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.v12.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]; + } + + // 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; + } + // Immutable. The resource name of the campaign. // Campaign resource names have the form: // @@ -213,16 +278,33 @@ 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.v12.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.v12.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.v9.enums.CampaignStatusEnum.CampaignStatus status = 5; + google.ads.googleads.v12.enums.CampaignStatusEnum.CampaignStatus status = 5; // Output only. The ad serving status of the campaign. - google.ads.googleads.v9.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v12.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.v9.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8; + google.ads.googleads.v12.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`. @@ -232,25 +314,28 @@ message Campaign { // // Can be set only when creating campaigns. // After the campaign is created, the field can not be changed. - google.ads.googleads.v9.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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.v9.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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.v9.common.CustomParameter url_custom_parameters = 12; + repeated google.ads.googleads.v12.common.CustomParameter url_custom_parameters = 12; + + // The Local Services Campaign related settings. + LocalServicesCampaignSettings local_services_campaign_settings = 75; // Settings for Real-Time Bidding, a feature only available for campaigns // targeting the Ad Exchange network. - google.ads.googleads.v9.common.RealTimeBiddingSetting real_time_bidding_setting = 39; + google.ads.googleads.v12.common.RealTimeBiddingSetting real_time_bidding_setting = 39; // The network settings for the campaign. NetworkSettings network_settings = 14; @@ -265,7 +350,10 @@ message Campaign { ShoppingSetting shopping_setting = 36; // Setting for targeting related features. - google.ads.googleads.v9.common.TargetingSetting targeting_setting = 43; + google.ads.googleads.v12.common.TargetingSetting targeting_setting = 43; + + // Immutable. Setting for audience related features. + optional AudienceSetting audience_setting = 73 [(google.api.field_behavior) = IMMUTABLE]; // The setting for ads geotargeting. GeoTargetTypeSetting geo_target_type_setting = 47; @@ -285,7 +373,7 @@ message Campaign { ]; // Output only. The type of campaign: normal, draft, or experiment. - google.ads.googleads.v9.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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`. @@ -310,7 +398,7 @@ message Campaign { // create a portfolio bidding strategy. // // This field is read-only. - google.ads.googleads.v9.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 @@ -328,10 +416,19 @@ message Campaign { } ]; - // The date when campaign started. + // The date when campaign started in serving customer's timezone in YYYY-MM-DD + // format. optional string start_date = 63; - // The last day of the campaign. + // The campaign group this campaign belongs to. + optional string campaign_group = 76 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignGroup" + }]; + + // The last day of the campaign in serving customer's timezone in YYYY-MM-DD + // 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 @@ -339,10 +436,10 @@ 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.v9.common.FrequencyCapEntry frequency_caps = 40; + repeated google.ads.googleads.v12.common.FrequencyCapEntry frequency_caps = 40; // Output only. 3-Tier Brand Safety setting for the campaign. - google.ads.googleads.v9.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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; @@ -359,7 +456,7 @@ message Campaign { TrackingSetting tracking_setting = 46 [(google.api.field_behavior) = OUTPUT_ONLY]; // Payment mode for the campaign. - google.ads.googleads.v9.enums.PaymentModeEnum.PaymentMode payment_mode = 52; + google.ads.googleads.v12.enums.PaymentModeEnum.PaymentMode payment_mode = 52; // Output only. Optimization score of the campaign. // @@ -377,7 +474,19 @@ message Campaign { // 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.v9.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69; + repeated google.ads.googleads.v12.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.v12.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 @@ -387,9 +496,12 @@ 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]; + // 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. @@ -399,51 +511,56 @@ message Campaign { // Commission is an automatic bidding strategy in which the advertiser pays // a certain portion of the conversion value. - google.ads.googleads.v9.common.Commission commission = 49; + google.ads.googleads.v12.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.v12.common.ManualCpa manual_cpa = 74; // Standard Manual CPC bidding strategy. // Manual click-based bidding where user pays per click. - google.ads.googleads.v9.common.ManualCpc manual_cpc = 24; + google.ads.googleads.v12.common.ManualCpc manual_cpc = 24; // Standard Manual CPM bidding strategy. // Manual impression-based bidding where user pays per thousand // impressions. - google.ads.googleads.v9.common.ManualCpm manual_cpm = 25; + google.ads.googleads.v12.common.ManualCpm manual_cpm = 25; // Output only. A bidding strategy that pays a configurable amount per video view. - google.ads.googleads.v9.common.ManualCpv manual_cpv = 37 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.MaximizeConversions maximize_conversions = 30; + google.ads.googleads.v12.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.v9.common.MaximizeConversionValue maximize_conversion_value = 31; + google.ads.googleads.v12.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.v9.common.TargetCpa target_cpa = 26; + google.ads.googleads.v12.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.v9.common.TargetImpressionShare target_impression_share = 48; + // that sets bids to achieve a chosen percentage of impressions. + google.ads.googleads.v12.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.v9.common.TargetRoas target_roas = 29; + google.ads.googleads.v12.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.v9.common.TargetSpend target_spend = 27; + google.ads.googleads.v12.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.v9.common.PercentCpc percent_cpc = 34; + google.ads.googleads.v12.common.PercentCpc percent_cpc = 34; // A bidding strategy that automatically optimizes cost per thousand // impressions. - google.ads.googleads.v9.common.TargetCpm target_cpm = 41; + google.ads.googleads.v12.common.TargetCpm target_cpm = 41; } } diff --git a/google/ads/googleads/v9/resources/campaign_asset.proto b/google/ads/googleads/v12/resources/campaign_asset.proto similarity index 69% rename from google/ads/googleads/v9/resources/campaign_asset.proto rename to google/ads/googleads/v12/resources/campaign_asset.proto index b78f1fcf5..b5b03b8d2 100644 --- a/google/ads/googleads/v9/resources/campaign_asset.proto +++ b/google/ads/googleads/v12/resources/campaign_asset.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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_source.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignAssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CampaignAsset resource. @@ -69,8 +69,11 @@ message CampaignAsset { // Immutable. Role that the asset takes under the linked campaign. // Required. - google.ads.googleads.v9.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. Source of the campaign asset link. + google.ads.googleads.v12.enums.AssetSourceEnum.AssetSource source = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Status of the campaign asset. - google.ads.googleads.v9.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; + google.ads.googleads.v12.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; } diff --git a/google/ads/googleads/v9/resources/campaign_asset_set.proto b/google/ads/googleads/v12/resources/campaign_asset_set.proto similarity index 78% rename from google/ads/googleads/v9/resources/campaign_asset_set.proto rename to google/ads/googleads/v12/resources/campaign_asset_set.proto index a0e0edf7e..39abbe219 100644 --- a/google/ads/googleads/v9/resources/campaign_asset_set.proto +++ b/google/ads/googleads/v12/resources/campaign_asset_set.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_set_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_set_link_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignAssetSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CampaignAsset resource. @@ -68,5 +67,5 @@ message CampaignAssetSet { ]; // Output only. The status of the campaign asset set asset. Read-only. - google.ads.googleads.v9.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/campaign_audience_view.proto b/google/ads/googleads/v12/resources/campaign_audience_view.proto similarity index 82% rename from google/ads/googleads/v9/resources/campaign_audience_view.proto rename to google/ads/googleads/v12/resources/campaign_audience_view.proto index 1f40fd485..876200230 100644 --- a/google/ads/googleads/v9/resources/campaign_audience_view.proto +++ b/google/ads/googleads/v12/resources/campaign_audience_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignAudienceViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the campaign audience view resource. diff --git a/google/ads/googleads/v9/resources/campaign_bid_modifier.proto b/google/ads/googleads/v12/resources/campaign_bid_modifier.proto similarity index 80% rename from google/ads/googleads/v9/resources/campaign_bid_modifier.proto rename to google/ads/googleads/v12/resources/campaign_bid_modifier.proto index f7415a8fd..cddb9015b 100644 --- a/google/ads/googleads/v9/resources/campaign_bid_modifier.proto +++ b/google/ads/googleads/v12/resources/campaign_bid_modifier.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignBidModifierProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Campaign Bid Modifier resource. @@ -71,6 +70,6 @@ message CampaignBidModifier { // Required in create operations starting in V5. oneof criterion { // Immutable. Criterion for interaction type. Only supported for search campaigns. - google.ads.googleads.v9.common.InteractionTypeInfo interaction_type = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.InteractionTypeInfo interaction_type = 5 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/campaign_budget.proto b/google/ads/googleads/v12/resources/campaign_budget.proto similarity index 79% rename from google/ads/googleads/v9/resources/campaign_budget.proto rename to google/ads/googleads/v12/resources/campaign_budget.proto index 4401d6dbf..b31a6b351 100644 --- a/google/ads/googleads/v9/resources/campaign_budget.proto +++ b/google/ads/googleads/v12/resources/campaign_budget.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/budget_delivery_method.proto"; -import "google/ads/googleads/v9/enums/budget_period.proto"; -import "google/ads/googleads/v9/enums/budget_status.proto"; -import "google/ads/googleads/v9/enums/budget_type.proto"; +import "google/ads/googleads/v12/enums/budget_delivery_method.proto"; +import "google/ads/googleads/v12/enums/budget_period.proto"; +import "google/ads/googleads/v12/enums/budget_status.proto"; +import "google/ads/googleads/v12/enums/budget_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignBudgetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Budget resource. @@ -83,13 +82,13 @@ message CampaignBudget { optional int64 total_amount_micros = 22; // Output only. The status of this campaign budget. This field is read-only. - google.ads.googleads.v9.enums.BudgetStatusEnum.BudgetStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7; + google.ads.googleads.v12.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7; // Specifies whether the budget is explicitly shared. Defaults to true if // unspecified in a create operation. @@ -127,7 +126,7 @@ message CampaignBudget { 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.v9.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The estimated change in weekly clicks if the recommended budget is applied. // @@ -152,5 +151,12 @@ message CampaignBudget { 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.v9.enums.BudgetTypeEnum.BudgetType type = 18 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/campaign_conversion_goal.proto b/google/ads/googleads/v12/resources/campaign_conversion_goal.proto similarity index 74% rename from google/ads/googleads/v9/resources/campaign_conversion_goal.proto rename to google/ads/googleads/v12/resources/campaign_conversion_goal.proto index 7556d1eba..ff9e434e0 100644 --- a/google/ads/googleads/v9/resources/campaign_conversion_goal.proto +++ b/google/ads/googleads/v12/resources/campaign_conversion_goal.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/conversion_action_category.proto"; -import "google/ads/googleads/v9/enums/conversion_origin.proto"; +import "google/ads/googleads/v12/enums/conversion_action_category.proto"; +import "google/ads/googleads/v12/enums/conversion_origin.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignConversionGoalProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // The biddability setting for the specified campaign only for all // conversion actions with a matching category and origin. @@ -59,10 +58,10 @@ message CampaignConversionGoal { ]; // The conversion category of this campaign conversion goal. - google.ads.googleads.v9.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 3; + google.ads.googleads.v12.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 3; // The conversion origin of this campaign conversion goal. - google.ads.googleads.v9.enums.ConversionOriginEnum.ConversionOrigin origin = 4; + google.ads.googleads.v12.enums.ConversionOriginEnum.ConversionOrigin origin = 4; // The biddability of the campaign conversion goal. bool biddable = 5; diff --git a/google/ads/googleads/v9/resources/campaign_criterion.proto b/google/ads/googleads/v12/resources/campaign_criterion.proto similarity index 50% rename from google/ads/googleads/v9/resources/campaign_criterion.proto rename to google/ads/googleads/v12/resources/campaign_criterion.proto index 924b3993d..2c72fd802 100644 --- a/google/ads/googleads/v9/resources/campaign_criterion.proto +++ b/google/ads/googleads/v12/resources/campaign_criterion.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/campaign_criterion_status.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/campaign_criterion_status.proto"; +import "google/ads/googleads/v12/enums/criterion_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignCriterionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Campaign Criterion resource. @@ -79,103 +78,103 @@ message CampaignCriterion { optional bool negative = 40 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The type of the criterion. - google.ads.googleads.v9.enums.CriterionTypeEnum.CriterionType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CriterionTypeEnum.CriterionType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // The status of the criterion. - google.ads.googleads.v9.enums.CampaignCriterionStatusEnum.CampaignCriterionStatus status = 35; + google.ads.googleads.v12.enums.CampaignCriterionStatusEnum.CampaignCriterionStatus status = 35; // The campaign criterion. // // Exactly one must be set. oneof criterion { // Immutable. Keyword. - google.ads.googleads.v9.common.KeywordInfo keyword = 8 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.KeywordInfo keyword = 8 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Placement. - google.ads.googleads.v9.common.PlacementInfo placement = 9 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.PlacementInfo placement = 9 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile app category. - google.ads.googleads.v9.common.MobileAppCategoryInfo mobile_app_category = 10 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileAppCategoryInfo mobile_app_category = 10 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile application. - google.ads.googleads.v9.common.MobileApplicationInfo mobile_application = 11 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileApplicationInfo mobile_application = 11 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Location. - google.ads.googleads.v9.common.LocationInfo location = 12 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.LocationInfo location = 12 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Device. - google.ads.googleads.v9.common.DeviceInfo device = 13 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.DeviceInfo device = 13 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Ad Schedule. - google.ads.googleads.v9.common.AdScheduleInfo ad_schedule = 15 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.AdScheduleInfo ad_schedule = 15 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Age range. - google.ads.googleads.v9.common.AgeRangeInfo age_range = 16 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.AgeRangeInfo age_range = 16 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Gender. - google.ads.googleads.v9.common.GenderInfo gender = 17 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.GenderInfo gender = 17 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Income range. - google.ads.googleads.v9.common.IncomeRangeInfo income_range = 18 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.IncomeRangeInfo income_range = 18 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Parental status. - google.ads.googleads.v9.common.ParentalStatusInfo parental_status = 19 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ParentalStatusInfo parental_status = 19 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User List. - google.ads.googleads.v9.common.UserListInfo user_list = 22 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.UserListInfo user_list = 22 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Video. - google.ads.googleads.v9.common.YouTubeVideoInfo youtube_video = 20 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeVideoInfo youtube_video = 20 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Channel. - google.ads.googleads.v9.common.YouTubeChannelInfo youtube_channel = 21 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeChannelInfo youtube_channel = 21 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Proximity. - google.ads.googleads.v9.common.ProximityInfo proximity = 23 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ProximityInfo proximity = 23 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Topic. - google.ads.googleads.v9.common.TopicInfo topic = 24 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.TopicInfo topic = 24 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Listing scope. - google.ads.googleads.v9.common.ListingScopeInfo listing_scope = 25 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ListingScopeInfo listing_scope = 25 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Language. - google.ads.googleads.v9.common.LanguageInfo language = 26 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.LanguageInfo language = 26 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. IpBlock. - google.ads.googleads.v9.common.IpBlockInfo ip_block = 27 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.IpBlockInfo ip_block = 27 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. ContentLabel. - google.ads.googleads.v9.common.ContentLabelInfo content_label = 28 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ContentLabelInfo content_label = 28 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Carrier. - google.ads.googleads.v9.common.CarrierInfo carrier = 29 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CarrierInfo carrier = 29 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User Interest. - google.ads.googleads.v9.common.UserInterestInfo user_interest = 30 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.UserInterestInfo user_interest = 30 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Webpage. - google.ads.googleads.v9.common.WebpageInfo webpage = 31 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.WebpageInfo webpage = 31 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Operating system version. - google.ads.googleads.v9.common.OperatingSystemVersionInfo operating_system_version = 32 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.OperatingSystemVersionInfo operating_system_version = 32 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile Device. - google.ads.googleads.v9.common.MobileDeviceInfo mobile_device = 33 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileDeviceInfo mobile_device = 33 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Location Group - google.ads.googleads.v9.common.LocationGroupInfo location_group = 34 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.LocationGroupInfo location_group = 34 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Custom Affinity. - google.ads.googleads.v9.common.CustomAffinityInfo custom_affinity = 36 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomAffinityInfo custom_affinity = 36 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Custom Audience - google.ads.googleads.v9.common.CustomAudienceInfo custom_audience = 41 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomAudienceInfo custom_audience = 41 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Combined Audience. - google.ads.googleads.v9.common.CombinedAudienceInfo combined_audience = 42 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CombinedAudienceInfo combined_audience = 42 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Smart Campaign Keyword Theme. - google.ads.googleads.v9.common.KeywordThemeInfo keyword_theme = 45 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.KeywordThemeInfo keyword_theme = 45 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/campaign_criterion_simulation.proto b/google/ads/googleads/v12/resources/campaign_criterion_simulation.proto similarity index 73% rename from google/ads/googleads/v9/resources/campaign_criterion_simulation.proto rename to google/ads/googleads/v12/resources/campaign_criterion_simulation.proto index 3165994bc..f5fe9b067 100644 --- a/google/ads/googleads/v9/resources/campaign_criterion_simulation.proto +++ b/google/ads/googleads/v12/resources/campaign_criterion_simulation.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/simulation.proto"; -import "google/ads/googleads/v9/enums/simulation_modification_method.proto"; -import "google/ads/googleads/v9/enums/simulation_type.proto"; +import "google/ads/googleads/v12/common/simulation.proto"; +import "google/ads/googleads/v12/enums/simulation_modification_method.proto"; +import "google/ads/googleads/v12/enums/simulation_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignCriterionSimulationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the campaign criterion simulation resource. @@ -64,10 +63,10 @@ message CampaignCriterionSimulation { optional int64 criterion_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The field that the simulation modifies. - google.ads.googleads.v9.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. How the simulation modifies the field. - google.ads.googleads.v9.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. optional string start_date = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -78,6 +77,6 @@ message CampaignCriterionSimulation { // List of simulation points. oneof point_list { // Output only. Simulation points if the simulation type is BID_MODIFIER. - google.ads.googleads.v9.common.BidModifierSimulationPointList bid_modifier_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.BidModifierSimulationPointList bid_modifier_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/campaign_customizer.proto b/google/ads/googleads/v12/resources/campaign_customizer.proto similarity index 75% rename from google/ads/googleads/v9/resources/campaign_customizer.proto rename to google/ads/googleads/v12/resources/campaign_customizer.proto index 06903164c..d4c065405 100644 --- a/google/ads/googleads/v9/resources/campaign_customizer.proto +++ b/google/ads/googleads/v12/resources/campaign_customizer.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/customizer_value.proto"; -import "google/ads/googleads/v9/enums/customizer_value_status.proto"; +import "google/ads/googleads/v12/common/customizer_value.proto"; +import "google/ads/googleads/v12/enums/customizer_value_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignCustomizerProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A customizer value for the associated CustomizerAttribute at the Campaign // level. @@ -68,9 +67,9 @@ message CampaignCustomizer { ]; // Output only. The status of the campaign customizer. - google.ads.googleads.v9.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/ads/googleads/v9/resources/campaign_draft.proto b/google/ads/googleads/v12/resources/campaign_draft.proto similarity index 84% rename from google/ads/googleads/v9/resources/campaign_draft.proto rename to google/ads/googleads/v12/resources/campaign_draft.proto index a6ff902ec..623ca6214 100644 --- a/google/ads/googleads/v9/resources/campaign_draft.proto +++ b/google/ads/googleads/v12/resources/campaign_draft.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/campaign_draft_status.proto"; +import "google/ads/googleads/v12/enums/campaign_draft_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignDraftProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Campaign Draft resource. @@ -86,7 +85,7 @@ 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.v9.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; diff --git a/google/ads/googleads/v9/resources/campaign_extension_setting.proto b/google/ads/googleads/v12/resources/campaign_extension_setting.proto similarity index 77% rename from google/ads/googleads/v9/resources/campaign_extension_setting.proto rename to google/ads/googleads/v12/resources/campaign_extension_setting.proto index ff9601678..c9f34fce1 100644 --- a/google/ads/googleads/v9/resources/campaign_extension_setting.proto +++ b/google/ads/googleads/v12/resources/campaign_extension_setting.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/extension_setting_device.proto"; -import "google/ads/googleads/v9/enums/extension_type.proto"; +import "google/ads/googleads/v12/enums/extension_setting_device.proto"; +import "google/ads/googleads/v12/enums/extension_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignExtensionSettingProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CampaignExtensionSetting resource. @@ -52,7 +51,7 @@ message CampaignExtensionSetting { ]; // Immutable. The extension type of the customer extension setting. - google.ads.googleads.v9.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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. @@ -75,5 +74,5 @@ message CampaignExtensionSetting { }]; // The device for which the extensions will serve. Optional. - google.ads.googleads.v9.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5; + google.ads.googleads.v12.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5; } diff --git a/google/ads/googleads/v9/resources/campaign_feed.proto b/google/ads/googleads/v12/resources/campaign_feed.proto similarity index 72% rename from google/ads/googleads/v9/resources/campaign_feed.proto rename to google/ads/googleads/v12/resources/campaign_feed.proto index ce353d131..9fe27f904 100644 --- a/google/ads/googleads/v9/resources/campaign_feed.proto +++ b/google/ads/googleads/v12/resources/campaign_feed.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/matching_function.proto"; -import "google/ads/googleads/v9/enums/feed_link_status.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/common/matching_function.proto"; +import "google/ads/googleads/v12/enums/feed_link_status.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignFeedProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CampaignFeed resource. @@ -70,14 +69,14 @@ message CampaignFeed { // Indicates which placeholder types the feed may populate under the connected // campaign. Required. - repeated google.ads.googleads.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4; + repeated google.ads.googleads.v12.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.v9.common.MatchingFunction matching_function = 5; + google.ads.googleads.v12.common.MatchingFunction matching_function = 5; // Output only. Status of the campaign feed. // This field is read-only. - google.ads.googleads.v9.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v12/resources/campaign_group.proto b/google/ads/googleads/v12/resources/campaign_group.proto new file mode 100644 index 000000000..05375fd25 --- /dev/null +++ b/google/ads/googleads/v12/resources/campaign_group.proto @@ -0,0 +1,68 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/enums/campaign_group_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CampaignGroupProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the Campaign group resource. + +// A campaign group. +message CampaignGroup { + option (google.api.resource) = { + type: "googleads.googleapis.com/CampaignGroup" + pattern: "customers/{customer_id}/campaignGroups/{campaign_group_id}" + }; + + // Immutable. The resource name of the campaign group. + // Campaign group resource names have the form: + // + // `customers/{customer_id}/campaignGroups/{campaign_group_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignGroup" + } + ]; + + // Output only. The ID of the campaign group. + int64 id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The name of the campaign group. + // + // This field is required and should not be empty when creating new campaign + // groups. + // + // It must not contain any null (code point 0x0), NL line feed + // (code point 0xA) or carriage return (code point 0xD) characters. + string name = 4; + + // The status of the campaign group. + // + // When a new campaign group is added, the status defaults to ENABLED. + google.ads.googleads.v12.enums.CampaignGroupStatusEnum.CampaignGroupStatus status = 5; +} diff --git a/google/ads/googleads/v9/resources/campaign_label.proto b/google/ads/googleads/v12/resources/campaign_label.proto similarity index 83% rename from google/ads/googleads/v9/resources/campaign_label.proto rename to google/ads/googleads/v12/resources/campaign_label.proto index b27ff4b5e..a02b34657 100644 --- a/google/ads/googleads/v9/resources/campaign_label.proto +++ b/google/ads/googleads/v12/resources/campaign_label.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignLabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the campaign label resource. diff --git a/google/ads/googleads/v9/resources/campaign_shared_set.proto b/google/ads/googleads/v12/resources/campaign_shared_set.proto similarity index 80% rename from google/ads/googleads/v9/resources/campaign_shared_set.proto rename to google/ads/googleads/v12/resources/campaign_shared_set.proto index 03a0c581f..ab7c392cb 100644 --- a/google/ads/googleads/v9/resources/campaign_shared_set.proto +++ b/google/ads/googleads/v12/resources/campaign_shared_set.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/campaign_shared_set_status.proto"; +import "google/ads/googleads/v12/enums/campaign_shared_set_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignSharedSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CampaignSharedSet resource. @@ -73,5 +72,5 @@ message CampaignSharedSet { ]; // Output only. The status of this campaign shared set. Read only. - google.ads.googleads.v9.enums.CampaignSharedSetStatusEnum.CampaignSharedSetStatus status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CampaignSharedSetStatusEnum.CampaignSharedSetStatus status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/campaign_simulation.proto b/google/ads/googleads/v12/resources/campaign_simulation.proto similarity index 58% rename from google/ads/googleads/v9/resources/campaign_simulation.proto rename to google/ads/googleads/v12/resources/campaign_simulation.proto index 3c42edc48..5781ad4fe 100644 --- a/google/ads/googleads/v9/resources/campaign_simulation.proto +++ b/google/ads/googleads/v12/resources/campaign_simulation.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/simulation.proto"; -import "google/ads/googleads/v9/enums/simulation_modification_method.proto"; -import "google/ads/googleads/v9/enums/simulation_type.proto"; +import "google/ads/googleads/v12/common/simulation.proto"; +import "google/ads/googleads/v12/enums/simulation_modification_method.proto"; +import "google/ads/googleads/v12/enums/simulation_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CampaignSimulationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the campaign simulation resource. @@ -38,18 +37,18 @@ option ruby_package = "Google::Ads::GoogleAds::V9::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" @@ -71,10 +70,10 @@ message CampaignSimulation { int64 campaign_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The field that the simulation modifies. - google.ads.googleads.v9.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. How the simulation modifies the field. - google.ads.googleads.v9.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. string start_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -85,18 +84,18 @@ message CampaignSimulation { // List of simulation points. oneof point_list { // Output only. Simulation points if the simulation type is CPC_BID. - google.ads.googleads.v9.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.BudgetSimulationPointList budget_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.BudgetSimulationPointList budget_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/google/ads/googleads/v9/resources/carrier_constant.proto b/google/ads/googleads/v12/resources/carrier_constant.proto similarity index 80% rename from google/ads/googleads/v9/resources/carrier_constant.proto rename to google/ads/googleads/v12/resources/carrier_constant.proto index 9d9428346..929a6c5d8 100644 --- a/google/ads/googleads/v9/resources/carrier_constant.proto +++ b/google/ads/googleads/v12/resources/carrier_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CarrierConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Carrier constant resource. @@ -55,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/google/ads/googleads/v9/resources/change_event.proto b/google/ads/googleads/v12/resources/change_event.proto similarity index 71% rename from google/ads/googleads/v9/resources/change_event.proto rename to google/ads/googleads/v12/resources/change_event.proto index f66e36a02..77373f214 100644 --- a/google/ads/googleads/v9/resources/change_event.proto +++ b/google/ads/googleads/v12/resources/change_event.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. @@ -14,46 +14,42 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/enums/ad_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_sub_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/asset_type.proto"; -import "google/ads/googleads/v9/enums/change_client_type.proto"; -import "google/ads/googleads/v9/enums/change_event_resource_type.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; -import "google/ads/googleads/v9/enums/feed_origin.proto"; -import "google/ads/googleads/v9/enums/resource_change_operation.proto"; -import "google/ads/googleads/v9/resources/ad.proto"; -import "google/ads/googleads/v9/resources/ad_group.proto"; -import "google/ads/googleads/v9/resources/ad_group_ad.proto"; -import "google/ads/googleads/v9/resources/ad_group_asset.proto"; -import "google/ads/googleads/v9/resources/ad_group_bid_modifier.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion.proto"; -import "google/ads/googleads/v9/resources/ad_group_feed.proto"; -import "google/ads/googleads/v9/resources/asset.proto"; -import "google/ads/googleads/v9/resources/campaign.proto"; -import "google/ads/googleads/v9/resources/campaign_asset.proto"; -import "google/ads/googleads/v9/resources/campaign_budget.proto"; -import "google/ads/googleads/v9/resources/campaign_criterion.proto"; -import "google/ads/googleads/v9/resources/campaign_feed.proto"; -import "google/ads/googleads/v9/resources/customer_asset.proto"; -import "google/ads/googleads/v9/resources/feed.proto"; -import "google/ads/googleads/v9/resources/feed_item.proto"; +package google.ads.googleads.v12.resources; + +import "google/ads/googleads/v12/enums/change_client_type.proto"; +import "google/ads/googleads/v12/enums/change_event_resource_type.proto"; +import "google/ads/googleads/v12/enums/resource_change_operation.proto"; +import "google/ads/googleads/v12/resources/ad.proto"; +import "google/ads/googleads/v12/resources/ad_group.proto"; +import "google/ads/googleads/v12/resources/ad_group_ad.proto"; +import "google/ads/googleads/v12/resources/ad_group_asset.proto"; +import "google/ads/googleads/v12/resources/ad_group_bid_modifier.proto"; +import "google/ads/googleads/v12/resources/ad_group_criterion.proto"; +import "google/ads/googleads/v12/resources/ad_group_feed.proto"; +import "google/ads/googleads/v12/resources/asset.proto"; +import "google/ads/googleads/v12/resources/asset_set.proto"; +import "google/ads/googleads/v12/resources/asset_set_asset.proto"; +import "google/ads/googleads/v12/resources/campaign.proto"; +import "google/ads/googleads/v12/resources/campaign_asset.proto"; +import "google/ads/googleads/v12/resources/campaign_asset_set.proto"; +import "google/ads/googleads/v12/resources/campaign_budget.proto"; +import "google/ads/googleads/v12/resources/campaign_criterion.proto"; +import "google/ads/googleads/v12/resources/campaign_feed.proto"; +import "google/ads/googleads/v12/resources/customer_asset.proto"; +import "google/ads/googleads/v12/resources/feed.proto"; +import "google/ads/googleads/v12/resources/feed_item.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/protobuf/field_mask.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ChangeEventProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Change Event resource. @@ -120,6 +116,15 @@ message ChangeEvent { // Output only. Set if change_resource_type == AD_GROUP_ASSET. 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]; + + // Output only. Set if change_resource_type == CAMPAIGN_ASSET_SET. + CampaignAssetSet campaign_asset_set = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. The resource name of the change event. @@ -138,13 +143,13 @@ 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.v9.enums.ChangeEventResourceTypeEnum.ChangeEventResourceType change_resource_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.ChangeClientTypeEnum.ChangeClientType client_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -156,7 +161,7 @@ message ChangeEvent { ChangedResource new_resource = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The operation on the changed resource. - google.ads.googleads.v9.enums.ResourceChangeOperationEnum.ResourceChangeOperation resource_change_operation = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; diff --git a/google/ads/googleads/v9/resources/change_status.proto b/google/ads/googleads/v12/resources/change_status.proto similarity index 83% rename from google/ads/googleads/v9/resources/change_status.proto rename to google/ads/googleads/v12/resources/change_status.proto index 442125c6f..1fcea04f3 100644 --- a/google/ads/googleads/v9/resources/change_status.proto +++ b/google/ads/googleads/v12/resources/change_status.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. @@ -14,28 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/ad_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_sub_type.proto"; -import "google/ads/googleads/v9/enums/advertising_channel_type.proto"; -import "google/ads/googleads/v9/enums/asset_type.proto"; -import "google/ads/googleads/v9/enums/change_status_operation.proto"; -import "google/ads/googleads/v9/enums/change_status_resource_type.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; -import "google/ads/googleads/v9/enums/feed_origin.proto"; +import "google/ads/googleads/v12/enums/change_status_operation.proto"; +import "google/ads/googleads/v12/enums/change_status_resource_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ChangeStatusProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Change Status resource. @@ -64,7 +57,7 @@ message ChangeStatus { // 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.v9.enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The Campaign affected by this change. optional string campaign = 17 [ @@ -83,7 +76,7 @@ message ChangeStatus { ]; // Output only. Represents the status of the changed resource. - google.ads.googleads.v9.enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 [ diff --git a/google/ads/googleads/v9/resources/click_view.proto b/google/ads/googleads/v12/resources/click_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/click_view.proto rename to google/ads/googleads/v12/resources/click_view.proto index bbbac1076..ab14f8f01 100644 --- a/google/ads/googleads/v9/resources/click_view.proto +++ b/google/ads/googleads/v12/resources/click_view.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/click_location.proto"; -import "google/ads/googleads/v9/common/criteria.proto"; +import "google/ads/googleads/v12/common/click_location.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ClickViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ClickView resource. @@ -61,11 +60,11 @@ message ClickView { // Output only. The location criteria matching the area of interest associated with the // impression. - google.ads.googleads.v9.common.ClickLocation area_of_interest = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.ClickLocation location_of_presence = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -104,5 +103,5 @@ message ClickView { ]; // Output only. Basic information about the associated keyword, if it exists. - google.ads.googleads.v9.common.KeywordInfo keyword_info = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.KeywordInfo keyword_info = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/combined_audience.proto b/google/ads/googleads/v12/resources/combined_audience.proto similarity index 77% rename from google/ads/googleads/v9/resources/combined_audience.proto rename to google/ads/googleads/v12/resources/combined_audience.proto index 32ac886b7..65127f4e2 100644 --- a/google/ads/googleads/v9/resources/combined_audience.proto +++ b/google/ads/googleads/v12/resources/combined_audience.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/combined_audience_status.proto"; +import "google/ads/googleads/v12/enums/combined_audience_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CombinedAudienceProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Combined Audience resource. @@ -56,7 +55,7 @@ message CombinedAudience { // Output only. Status of this combined audience. Indicates whether the combined audience // is enabled or removed. - google.ads.googleads.v9.enums.CombinedAudienceStatusEnum.CombinedAudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. diff --git a/google/ads/googleads/v9/resources/conversion_action.proto b/google/ads/googleads/v12/resources/conversion_action.proto similarity index 70% rename from google/ads/googleads/v9/resources/conversion_action.proto rename to google/ads/googleads/v12/resources/conversion_action.proto index 6382c8381..a081af0e6 100644 --- a/google/ads/googleads/v9/resources/conversion_action.proto +++ b/google/ads/googleads/v12/resources/conversion_action.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. @@ -14,29 +14,28 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/common/tag_snippet.proto"; -import "google/ads/googleads/v9/enums/attribution_model.proto"; -import "google/ads/googleads/v9/enums/conversion_action_category.proto"; -import "google/ads/googleads/v9/enums/conversion_action_counting_type.proto"; -import "google/ads/googleads/v9/enums/conversion_action_status.proto"; -import "google/ads/googleads/v9/enums/conversion_action_type.proto"; -import "google/ads/googleads/v9/enums/conversion_origin.proto"; -import "google/ads/googleads/v9/enums/data_driven_model_status.proto"; -import "google/ads/googleads/v9/enums/mobile_app_vendor.proto"; +package google.ads.googleads.v12.resources; + +import "google/ads/googleads/v12/common/tag_snippet.proto"; +import "google/ads/googleads/v12/enums/attribution_model.proto"; +import "google/ads/googleads/v12/enums/conversion_action_category.proto"; +import "google/ads/googleads/v12/enums/conversion_action_counting_type.proto"; +import "google/ads/googleads/v12/enums/conversion_action_status.proto"; +import "google/ads/googleads/v12/enums/conversion_action_type.proto"; +import "google/ads/googleads/v12/enums/conversion_origin.proto"; +import "google/ads/googleads/v12/enums/data_driven_model_status.proto"; +import "google/ads/googleads/v12/enums/mobile_app_vendor.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ConversionActionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Conversion Action resource. @@ -50,11 +49,11 @@ message ConversionAction { // Settings related to this conversion action's attribution model. message AttributionModelSettings { // The attribution model type of this conversion action. - google.ads.googleads.v9.enums.AttributionModelEnum.AttributionModel attribution_model = 1; + google.ads.googleads.v12.enums.AttributionModelEnum.AttributionModel attribution_model = 1; // Output only. The status of the data-driven attribution model for the conversion // action. - google.ads.googleads.v9.enums.DataDrivenModelStatusEnum.DataDrivenModelStatus data_driven_model_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 @@ -92,6 +91,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. @@ -115,25 +120,28 @@ message ConversionAction { optional string name = 22; // The status of this conversion action for conversion event accrual. - google.ads.googleads.v9.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4; + google.ads.googleads.v12.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4; // Immutable. The type of this conversion action. - google.ads.googleads.v9.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The conversion origin of this conversion action. - google.ads.googleads.v9.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; - // If a conversion action’s primary_for_goal bit is false, the conversion + // If a conversion action's primary_for_goal bit is false, the conversion // action is non-biddable for all campaigns regardless of their customer // conversion goal or campaign conversion goal. // However, custom conversion goals do not respect primary_for_goal, so if // a campaign has a custom conversion goal configured with a // primary_for_goal = false conversion action, that conversion action is // still biddable. - bool primary_for_goal = 31; + // By default, primary_for_goal will be true if not set. In V9, + // 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.v9.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6; + google.ads.googleads.v12.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. @@ -149,7 +157,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 @@ -161,13 +169,13 @@ message ConversionAction { ValueSettings value_settings = 11; // How to count conversion events for the conversion action. - google.ads.googleads.v9.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12; + google.ads.googleads.v12.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.v9.common.TagSnippet tag_snippets = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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. @@ -179,7 +187,7 @@ message ConversionAction { optional string app_id = 28; // Output only. Mobile app vendor for an app conversion action. - google.ads.googleads.v9.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; diff --git a/google/ads/googleads/v9/resources/conversion_custom_variable.proto b/google/ads/googleads/v12/resources/conversion_custom_variable.proto similarity index 83% rename from google/ads/googleads/v9/resources/conversion_custom_variable.proto rename to google/ads/googleads/v12/resources/conversion_custom_variable.proto index 6357ecbcc..11aaf89af 100644 --- a/google/ads/googleads/v9/resources/conversion_custom_variable.proto +++ b/google/ads/googleads/v12/resources/conversion_custom_variable.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/conversion_custom_variable_status.proto"; +import "google/ads/googleads/v12/enums/conversion_custom_variable_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ConversionCustomVariableProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Conversion Custom Variable resource. @@ -74,7 +73,7 @@ message ConversionCustomVariable { ]; // The status of the conversion custom variable for conversion event accrual. - google.ads.googleads.v9.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5; + google.ads.googleads.v12.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5; // Output only. The resource name of the customer that owns the conversion custom variable. string owner_customer = 6 [ diff --git a/google/ads/googleads/v9/resources/conversion_goal_campaign_config.proto b/google/ads/googleads/v12/resources/conversion_goal_campaign_config.proto similarity index 79% rename from google/ads/googleads/v9/resources/conversion_goal_campaign_config.proto rename to google/ads/googleads/v12/resources/conversion_goal_campaign_config.proto index 20dc2ea7c..d1d84c718 100644 --- a/google/ads/googleads/v9/resources/conversion_goal_campaign_config.proto +++ b/google/ads/googleads/v12/resources/conversion_goal_campaign_config.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/goal_config_level.proto"; +import "google/ads/googleads/v12/enums/goal_config_level.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ConversionGoalCampaignConfigProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Conversion goal settings for a Campaign. message ConversionGoalCampaignConfig { @@ -57,7 +56,7 @@ message ConversionGoalCampaignConfig { ]; // The level of goal config the campaign is using. - google.ads.googleads.v9.enums.GoalConfigLevelEnum.GoalConfigLevel goal_config_level = 3; + google.ads.googleads.v12.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) = { diff --git a/google/ads/googleads/v9/resources/conversion_value_rule.proto b/google/ads/googleads/v12/resources/conversion_value_rule.proto similarity index 77% rename from google/ads/googleads/v9/resources/conversion_value_rule.proto rename to google/ads/googleads/v12/resources/conversion_value_rule.proto index ddbc4e576..5039b32d5 100644 --- a/google/ads/googleads/v9/resources/conversion_value_rule.proto +++ b/google/ads/googleads/v12/resources/conversion_value_rule.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/conversion_value_rule_status.proto"; -import "google/ads/googleads/v9/enums/value_rule_device_type.proto"; -import "google/ads/googleads/v9/enums/value_rule_geo_location_match_type.proto"; -import "google/ads/googleads/v9/enums/value_rule_operation.proto"; +import "google/ads/googleads/v12/enums/conversion_value_rule_status.proto"; +import "google/ads/googleads/v12/enums/value_rule_device_type.proto"; +import "google/ads/googleads/v12/enums/value_rule_geo_location_match_type.proto"; +import "google/ads/googleads/v12/enums/value_rule_operation.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Conversion Value Rule resource. @@ -45,7 +44,7 @@ message ConversionValueRule { // Action applied when rule is applied. message ValueRuleAction { // Specifies applied operation. - google.ads.googleads.v9.enums.ValueRuleOperationEnum.ValueRuleOperation operation = 1; + google.ads.googleads.v12.enums.ValueRuleOperationEnum.ValueRuleOperation operation = 1; // Specifies applied value. double value = 2; @@ -59,7 +58,7 @@ message ConversionValueRule { }]; // Excluded Geo location match type. - google.ads.googleads.v9.enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType excluded_geo_match_type = 2; + google.ads.googleads.v12.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) = { @@ -67,13 +66,13 @@ message ConversionValueRule { }]; // Included Geo location match type. - google.ads.googleads.v9.enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType geo_match_type = 4; + google.ads.googleads.v12.enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType geo_match_type = 4; } // Condition on Device dimension. message ValueRuleDeviceCondition { // Value for device type condition. - repeated google.ads.googleads.v9.enums.ValueRuleDeviceTypeEnum.ValueRuleDeviceType device_types = 1; + repeated google.ads.googleads.v12.enums.ValueRuleDeviceTypeEnum.ValueRuleDeviceType device_types = 1; } // Condition on Audience dimension. @@ -131,5 +130,5 @@ message ConversionValueRule { ]; // The status of the conversion value rule. - google.ads.googleads.v9.enums.ConversionValueRuleStatusEnum.ConversionValueRuleStatus status = 8; + google.ads.googleads.v12.enums.ConversionValueRuleStatusEnum.ConversionValueRuleStatus status = 8; } diff --git a/google/ads/googleads/v9/resources/conversion_value_rule_set.proto b/google/ads/googleads/v12/resources/conversion_value_rule_set.proto similarity index 69% rename from google/ads/googleads/v9/resources/conversion_value_rule_set.proto rename to google/ads/googleads/v12/resources/conversion_value_rule_set.proto index a9ec440f9..99fb88cea 100644 --- a/google/ads/googleads/v9/resources/conversion_value_rule_set.proto +++ b/google/ads/googleads/v12/resources/conversion_value_rule_set.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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/conversion_value_rule_set_status.proto"; -import "google/ads/googleads/v9/enums/value_rule_set_attachment_type.proto"; -import "google/ads/googleads/v9/enums/value_rule_set_dimension.proto"; +import "google/ads/googleads/v12/enums/conversion_action_category.proto"; +import "google/ads/googleads/v12/enums/conversion_value_rule_set_status.proto"; +import "google/ads/googleads/v12/enums/value_rule_set_attachment_type.proto"; +import "google/ads/googleads/v12/enums/value_rule_set_dimension.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Conversion Value Rule Set resource. @@ -66,7 +66,7 @@ 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.v9.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4; + repeated google.ads.googleads.v12.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 @@ -81,8 +81,8 @@ message ConversionValueRuleSet { } ]; - // Defines the scope where the conversion value rule set is attached. - google.ads.googleads.v9.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6; + // Immutable. Defines the scope where the conversion value rule set is attached. + google.ads.googleads.v12.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. @@ -92,5 +92,8 @@ message ConversionValueRuleSet { // Output only. The status of the conversion value rule set. // ** Read-only ** - google.ads.googleads.v9.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v12.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(google.api.field_behavior) = IMMUTABLE]; } diff --git a/google/ads/googleads/v9/resources/currency_constant.proto b/google/ads/googleads/v12/resources/currency_constant.proto similarity index 80% rename from google/ads/googleads/v9/resources/currency_constant.proto rename to google/ads/googleads/v12/resources/currency_constant.proto index 6a90a95af..140a22e77 100644 --- a/google/ads/googleads/v9/resources/currency_constant.proto +++ b/google/ads/googleads/v12/resources/currency_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CurrencyConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Currency Constant resource. @@ -49,13 +48,14 @@ 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 diff --git a/google/ads/googleads/v9/resources/custom_audience.proto b/google/ads/googleads/v12/resources/custom_audience.proto similarity index 78% rename from google/ads/googleads/v9/resources/custom_audience.proto rename to google/ads/googleads/v12/resources/custom_audience.proto index b3239c1a7..77e3ea4e4 100644 --- a/google/ads/googleads/v9/resources/custom_audience.proto +++ b/google/ads/googleads/v12/resources/custom_audience.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/custom_audience_member_type.proto"; -import "google/ads/googleads/v9/enums/custom_audience_status.proto"; -import "google/ads/googleads/v9/enums/custom_audience_type.proto"; +import "google/ads/googleads/v12/enums/custom_audience_member_type.proto"; +import "google/ads/googleads/v12/enums/custom_audience_status.proto"; +import "google/ads/googleads/v12/enums/custom_audience_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Custom Audience resource. @@ -57,7 +56,7 @@ message CustomAudience { // Output only. Status of this custom audience. Indicates whether the custom audience is // enabled or removed. - google.ads.googleads.v9.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -67,7 +66,7 @@ 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.v9.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5; + google.ads.googleads.v12.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5; // Description of this custom audience. string description = 6; @@ -82,7 +81,7 @@ 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.v9.enums.CustomAudienceMemberTypeEnum.CustomAudienceMemberType member_type = 1; + google.ads.googleads.v12.enums.CustomAudienceMemberTypeEnum.CustomAudienceMemberType member_type = 1; // The CustomAudienceMember value. One field is populated depending on the // member type. diff --git a/google/ads/googleads/v9/resources/custom_conversion_goal.proto b/google/ads/googleads/v12/resources/custom_conversion_goal.proto similarity index 77% rename from google/ads/googleads/v9/resources/custom_conversion_goal.proto rename to google/ads/googleads/v12/resources/custom_conversion_goal.proto index 54bcd89f8..8e4f38312 100644 --- a/google/ads/googleads/v9/resources/custom_conversion_goal.proto +++ b/google/ads/googleads/v12/resources/custom_conversion_goal.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/custom_conversion_goal_status.proto"; +import "google/ads/googleads/v12/enums/custom_conversion_goal_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomConversionGoalProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Custom conversion goal that can make arbitrary conversion actions biddable. message CustomConversionGoal { @@ -60,5 +59,5 @@ message CustomConversionGoal { }]; // The status of the custom conversion goal. - google.ads.googleads.v9.enums.CustomConversionGoalStatusEnum.CustomConversionGoalStatus status = 5; + google.ads.googleads.v12.enums.CustomConversionGoalStatusEnum.CustomConversionGoalStatus status = 5; } diff --git a/google/ads/googleads/v9/resources/custom_interest.proto b/google/ads/googleads/v12/resources/custom_interest.proto similarity index 75% rename from google/ads/googleads/v9/resources/custom_interest.proto rename to google/ads/googleads/v12/resources/custom_interest.proto index 1978fd535..daa481f5c 100644 --- a/google/ads/googleads/v9/resources/custom_interest.proto +++ b/google/ads/googleads/v12/resources/custom_interest.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/custom_interest_member_type.proto"; -import "google/ads/googleads/v9/enums/custom_interest_status.proto"; -import "google/ads/googleads/v9/enums/custom_interest_type.proto"; +import "google/ads/googleads/v12/enums/custom_interest_member_type.proto"; +import "google/ads/googleads/v12/enums/custom_interest_status.proto"; +import "google/ads/googleads/v12/enums/custom_interest_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomInterestProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Custom Interest resource. @@ -57,7 +56,7 @@ message CustomInterest { // Status of this custom interest. Indicates whether the custom interest is // enabled or removed. - google.ads.googleads.v9.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3; + google.ads.googleads.v12.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3; // Name of the custom interest. It should be unique across the same custom // affinity audience. @@ -66,7 +65,7 @@ message CustomInterest { // Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. // By default the type is set to CUSTOM_AFFINITY. - google.ads.googleads.v9.enums.CustomInterestTypeEnum.CustomInterestType type = 5; + google.ads.googleads.v12.enums.CustomInterestTypeEnum.CustomInterestType type = 5; // Description of this custom interest audience. optional string description = 10; @@ -81,7 +80,7 @@ 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.v9.enums.CustomInterestMemberTypeEnum.CustomInterestMemberType member_type = 1; + google.ads.googleads.v12.enums.CustomInterestMemberTypeEnum.CustomInterestMemberType member_type = 1; // Keyword text when member_type is KEYWORD or URL string when // member_type is URL. diff --git a/google/ads/googleads/v9/resources/customer.proto b/google/ads/googleads/v12/resources/customer.proto similarity index 67% rename from google/ads/googleads/v9/resources/customer.proto rename to google/ads/googleads/v12/resources/customer.proto index ed71fd2a9..cf0042432 100644 --- a/google/ads/googleads/v9/resources/customer.proto +++ b/google/ads/googleads/v12/resources/customer.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. @@ -14,21 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/customer_pay_per_conversion_eligibility_failure_reason.proto"; +import "google/ads/googleads/v12/enums/conversion_tracking_status_enum.proto"; +import "google/ads/googleads/v12/enums/customer_pay_per_conversion_eligibility_failure_reason.proto"; +import "google/ads/googleads/v12/enums/customer_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Customer resource. @@ -84,7 +85,8 @@ 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. @@ -95,7 +97,7 @@ message Customer { // 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.v9.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Optimization score of the customer. // @@ -120,11 +122,14 @@ message Customer { // // This field is read-only. double optimization_score_weight = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The status of the customer. + google.ads.googleads.v12.enums.CustomerStatusEnum.CustomerStatus status = 36 [(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; @@ -142,9 +147,9 @@ message CallReportingSetting { // 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. + // 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 @@ -152,10 +157,32 @@ message ConversionTrackingSetting { // 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]; + + // 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.v12.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]; + + // 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 global site tag. + // Output only. The Google tag. optional string google_global_site_tag = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/customer_asset.proto b/google/ads/googleads/v12/resources/customer_asset.proto similarity index 68% rename from google/ads/googleads/v9/resources/customer_asset.proto rename to google/ads/googleads/v12/resources/customer_asset.proto index 2785b83b0..7a756101d 100644 --- a/google/ads/googleads/v9/resources/customer_asset.proto +++ b/google/ads/googleads/v12/resources/customer_asset.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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/asset_field_type.proto"; -import "google/ads/googleads/v9/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_field_type.proto"; +import "google/ads/googleads/v12/enums/asset_link_status.proto"; +import "google/ads/googleads/v12/enums/asset_source.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerAssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerAsset resource. @@ -61,11 +61,14 @@ message CustomerAsset { ]; // Required. Immutable. Role that the asset takes for the customer link. - google.ads.googleads.v9.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [ + google.ads.googleads.v12.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.v12.enums.AssetSourceEnum.AssetSource source = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status of the customer asset. - google.ads.googleads.v9.enums.AssetLinkStatusEnum.AssetLinkStatus status = 4; + google.ads.googleads.v12.enums.AssetLinkStatusEnum.AssetLinkStatus status = 4; } diff --git a/google/ads/googleads/v12/resources/customer_asset_set.proto b/google/ads/googleads/v12/resources/customer_asset_set.proto new file mode 100644 index 000000000..569c32043 --- /dev/null +++ b/google/ads/googleads/v12/resources/customer_asset_set.proto @@ -0,0 +1,71 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/enums/asset_set_link_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CustomerAssetSetProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v9/resources/customer_client.proto b/google/ads/googleads/v12/resources/customer_client.proto similarity index 82% rename from google/ads/googleads/v9/resources/customer_client.proto rename to google/ads/googleads/v12/resources/customer_client.proto index d97d8b835..bc672449b 100644 --- a/google/ads/googleads/v9/resources/customer_client.proto +++ b/google/ads/googleads/v12/resources/customer_client.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. @@ -14,20 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; +import "google/ads/googleads/v12/enums/customer_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerClientProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerClient resource. @@ -69,7 +69,7 @@ message CustomerClient { 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. + // 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. @@ -81,7 +81,7 @@ message CustomerClient { // Output only. Descriptive name for the client. Read 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. + // 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. @@ -98,4 +98,7 @@ message CustomerClient { type: "googleads.googleapis.com/Label" } ]; + + // Output only. The status of the client customer. Read only. + google.ads.googleads.v12.enums.CustomerStatusEnum.CustomerStatus status = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/customer_client_link.proto b/google/ads/googleads/v12/resources/customer_client_link.proto similarity index 80% rename from google/ads/googleads/v9/resources/customer_client_link.proto rename to google/ads/googleads/v12/resources/customer_client_link.proto index 8e0b1ce1a..15ecaae43 100644 --- a/google/ads/googleads/v9/resources/customer_client_link.proto +++ b/google/ads/googleads/v12/resources/customer_client_link.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/manager_link_status.proto"; +import "google/ads/googleads/v12/enums/manager_link_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerClientLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerClientLink resource. @@ -61,7 +60,7 @@ message CustomerClientLink { 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.v9.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/customer_conversion_goal.proto b/google/ads/googleads/v12/resources/customer_conversion_goal.proto similarity index 72% rename from google/ads/googleads/v9/resources/customer_conversion_goal.proto rename to google/ads/googleads/v12/resources/customer_conversion_goal.proto index 9d76f3acd..795dd8d69 100644 --- a/google/ads/googleads/v9/resources/customer_conversion_goal.proto +++ b/google/ads/googleads/v12/resources/customer_conversion_goal.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/conversion_action_category.proto"; -import "google/ads/googleads/v9/enums/conversion_origin.proto"; +import "google/ads/googleads/v12/enums/conversion_action_category.proto"; +import "google/ads/googleads/v12/enums/conversion_origin.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerConversionGoalProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Biddability control for conversion actions with a matching category and // origin. @@ -52,12 +51,12 @@ 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.v9.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 2; + google.ads.googleads.v12.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.v9.enums.ConversionOriginEnum.ConversionOrigin origin = 3; + google.ads.googleads.v12.enums.ConversionOriginEnum.ConversionOrigin origin = 3; // The biddability of the customer conversion goal. bool biddable = 4; diff --git a/google/ads/googleads/v9/resources/customer_customizer.proto b/google/ads/googleads/v12/resources/customer_customizer.proto similarity index 72% rename from google/ads/googleads/v9/resources/customer_customizer.proto rename to google/ads/googleads/v12/resources/customer_customizer.proto index 719f8e4df..b8c1b8d03 100644 --- a/google/ads/googleads/v9/resources/customer_customizer.proto +++ b/google/ads/googleads/v12/resources/customer_customizer.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/customizer_value.proto"; -import "google/ads/googleads/v9/enums/customizer_value_status.proto"; +import "google/ads/googleads/v12/common/customizer_value.proto"; +import "google/ads/googleads/v12/enums/customizer_value_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerCustomizerProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A customizer value for the associated CustomizerAttribute at the Customer // level. @@ -60,9 +59,9 @@ message CustomerCustomizer { ]; // Output only. The status of the customer customizer attribute. - google.ads.googleads.v9.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.CustomizerValue value = 4 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.common.CustomizerValue value = 4 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/ads/googleads/v9/resources/customer_extension_setting.proto b/google/ads/googleads/v12/resources/customer_extension_setting.proto similarity index 74% rename from google/ads/googleads/v9/resources/customer_extension_setting.proto rename to google/ads/googleads/v12/resources/customer_extension_setting.proto index da7f2b3d1..50f2affa9 100644 --- a/google/ads/googleads/v9/resources/customer_extension_setting.proto +++ b/google/ads/googleads/v12/resources/customer_extension_setting.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/extension_setting_device.proto"; -import "google/ads/googleads/v9/enums/extension_type.proto"; +import "google/ads/googleads/v12/enums/extension_setting_device.proto"; +import "google/ads/googleads/v12/enums/extension_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerExtensionSettingProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerExtensionSetting resource. @@ -52,7 +51,7 @@ message CustomerExtensionSetting { ]; // Immutable. The extension type of the customer extension setting. - google.ads.googleads.v9.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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: @@ -63,5 +62,5 @@ message CustomerExtensionSetting { }]; // The device for which the extensions will serve. Optional. - google.ads.googleads.v9.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 4; + google.ads.googleads.v12.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 4; } diff --git a/google/ads/googleads/v9/resources/customer_feed.proto b/google/ads/googleads/v12/resources/customer_feed.proto similarity index 69% rename from google/ads/googleads/v9/resources/customer_feed.proto rename to google/ads/googleads/v12/resources/customer_feed.proto index fa60000be..ac48f8bb6 100644 --- a/google/ads/googleads/v9/resources/customer_feed.proto +++ b/google/ads/googleads/v12/resources/customer_feed.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. @@ -14,23 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/matching_function.proto"; -import "google/ads/googleads/v9/enums/feed_link_status.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/common/matching_function.proto"; +import "google/ads/googleads/v12/enums/feed_link_status.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerFeedProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerFeed resource. @@ -62,14 +61,14 @@ message CustomerFeed { // Indicates which placeholder types the feed may populate under the connected // customer. Required. - repeated google.ads.googleads.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 3; + repeated google.ads.googleads.v12.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.v9.common.MatchingFunction matching_function = 4; + google.ads.googleads.v12.common.MatchingFunction matching_function = 4; // Output only. Status of the customer feed. // This field is read-only. - google.ads.googleads.v9.enums.FeedLinkStatusEnum.FeedLinkStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.FeedLinkStatusEnum.FeedLinkStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/customer_label.proto b/google/ads/googleads/v12/resources/customer_label.proto similarity index 85% rename from google/ads/googleads/v9/resources/customer_label.proto rename to google/ads/googleads/v12/resources/customer_label.proto index ec8935af6..96d987621 100644 --- a/google/ads/googleads/v9/resources/customer_label.proto +++ b/google/ads/googleads/v12/resources/customer_label.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerLabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the customer label resource. diff --git a/google/ads/googleads/v9/resources/customer_manager_link.proto b/google/ads/googleads/v12/resources/customer_manager_link.proto similarity index 78% rename from google/ads/googleads/v9/resources/customer_manager_link.proto rename to google/ads/googleads/v12/resources/customer_manager_link.proto index 79b6db27d..ebad815a7 100644 --- a/google/ads/googleads/v9/resources/customer_manager_link.proto +++ b/google/ads/googleads/v12/resources/customer_manager_link.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/manager_link_status.proto"; +import "google/ads/googleads/v12/enums/manager_link_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerManagerLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerManagerLink resource. @@ -61,5 +60,5 @@ message CustomerManagerLink { 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.v9.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5; + google.ads.googleads.v12.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5; } diff --git a/google/ads/googleads/v9/resources/customer_negative_criterion.proto b/google/ads/googleads/v12/resources/customer_negative_criterion.proto similarity index 60% rename from google/ads/googleads/v9/resources/customer_negative_criterion.proto rename to google/ads/googleads/v12/resources/customer_negative_criterion.proto index 40a945335..060cb5221 100644 --- a/google/ads/googleads/v9/resources/customer_negative_criterion.proto +++ b/google/ads/googleads/v12/resources/customer_negative_criterion.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/criterion_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerNegativeCriterionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Customer Negative Criterion resource. @@ -55,28 +54,28 @@ message CustomerNegativeCriterion { optional int64 id = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of the criterion. - google.ads.googleads.v9.enums.CriterionTypeEnum.CriterionType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.ContentLabelInfo content_label = 4 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ContentLabelInfo content_label = 4 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. MobileApplication. - google.ads.googleads.v9.common.MobileApplicationInfo mobile_application = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileApplicationInfo mobile_application = 5 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. MobileAppCategory. - google.ads.googleads.v9.common.MobileAppCategoryInfo mobile_app_category = 6 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileAppCategoryInfo mobile_app_category = 6 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Placement. - google.ads.googleads.v9.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Video. - google.ads.googleads.v9.common.YouTubeVideoInfo youtube_video = 8 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeVideoInfo youtube_video = 8 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Channel. - google.ads.googleads.v9.common.YouTubeChannelInfo youtube_channel = 9 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeChannelInfo youtube_channel = 9 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/customer_user_access.proto b/google/ads/googleads/v12/resources/customer_user_access.proto similarity index 81% rename from google/ads/googleads/v9/resources/customer_user_access.proto rename to google/ads/googleads/v12/resources/customer_user_access.proto index 858293410..e89e20f35 100644 --- a/google/ads/googleads/v9/resources/customer_user_access.proto +++ b/google/ads/googleads/v12/resources/customer_user_access.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/access_role.proto"; +import "google/ads/googleads/v12/enums/access_role.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerUserAccessProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerUserAccess resource. @@ -58,7 +57,7 @@ message CustomerUserAccess { optional string email_address = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Access role of the user. - google.ads.googleads.v9.enums.AccessRoleEnum.AccessRole access_role = 4; + google.ads.googleads.v12.enums.AccessRoleEnum.AccessRole access_role = 4; // Output only. The customer user access creation time. // Read only field diff --git a/google/ads/googleads/v9/resources/customer_user_access_invitation.proto b/google/ads/googleads/v12/resources/customer_user_access_invitation.proto similarity index 74% rename from google/ads/googleads/v9/resources/customer_user_access_invitation.proto rename to google/ads/googleads/v12/resources/customer_user_access_invitation.proto index 1fe90f402..f5cf3663d 100644 --- a/google/ads/googleads/v9/resources/customer_user_access_invitation.proto +++ b/google/ads/googleads/v12/resources/customer_user_access_invitation.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/access_invitation_status.proto"; -import "google/ads/googleads/v9/enums/access_role.proto"; +import "google/ads/googleads/v12/enums/access_invitation_status.proto"; +import "google/ads/googleads/v12/enums/access_role.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomerUserAccessInvitationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the CustomerUserAccessInvitation resource. @@ -55,7 +54,7 @@ message CustomerUserAccessInvitation { int64 invitation_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Access role of the user. - google.ads.googleads.v9.enums.AccessRoleEnum.AccessRole access_role = 3 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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 @@ -69,5 +68,5 @@ message CustomerUserAccessInvitation { string creation_date_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Invitation status of the user. - google.ads.googleads.v9.enums.AccessInvitationStatusEnum.AccessInvitationStatus invitation_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.AccessInvitationStatusEnum.AccessInvitationStatus invitation_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/customizer_attribute.proto b/google/ads/googleads/v12/resources/customizer_attribute.proto similarity index 73% rename from google/ads/googleads/v9/resources/customizer_attribute.proto rename to google/ads/googleads/v12/resources/customizer_attribute.proto index c19a00b9b..ca5cf433d 100644 --- a/google/ads/googleads/v9/resources/customizer_attribute.proto +++ b/google/ads/googleads/v12/resources/customizer_attribute.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/customizer_attribute_status.proto"; -import "google/ads/googleads/v9/enums/customizer_attribute_type.proto"; +import "google/ads/googleads/v12/enums/customizer_attribute_status.proto"; +import "google/ads/googleads/v12/enums/customizer_attribute_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "CustomizerAttributeProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A customizer attribute. // Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or @@ -65,8 +64,8 @@ message CustomizerAttribute { ]; // Immutable. The type of the customizer attribute. - google.ads.googleads.v9.enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 4 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 4 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The status of the customizer attribute. - google.ads.googleads.v9.enums.CustomizerAttributeStatusEnum.CustomizerAttributeStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.CustomizerAttributeStatusEnum.CustomizerAttributeStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/detail_placement_view.proto b/google/ads/googleads/v12/resources/detail_placement_view.proto similarity index 70% rename from google/ads/googleads/v9/resources/detail_placement_view.proto rename to google/ads/googleads/v12/resources/detail_placement_view.proto index cc639c8a7..0e7141503 100644 --- a/google/ads/googleads/v9/resources/detail_placement_view.proto +++ b/google/ads/googleads/v12/resources/detail_placement_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/placement_type.proto"; +import "google/ads/googleads/v12/enums/placement_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DetailPlacementViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the detail placement view resource. @@ -58,14 +57,15 @@ message DetailPlacementView { // 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. + // 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.v9.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.v12.enums.PlacementTypeEnum.PlacementType placement_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/detailed_demographic.proto b/google/ads/googleads/v12/resources/detailed_demographic.proto similarity index 76% rename from google/ads/googleads/v9/resources/detailed_demographic.proto rename to google/ads/googleads/v12/resources/detailed_demographic.proto index 496936b4b..e01ca420e 100644 --- a/google/ads/googleads/v9/resources/detailed_demographic.proto +++ b/google/ads/googleads/v12/resources/detailed_demographic.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criterion_category_availability.proto"; +import "google/ads/googleads/v12/common/criterion_category_availability.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DetailedDemographicProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Detailed Demographic resource. @@ -54,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. @@ -70,5 +69,5 @@ message DetailedDemographic { bool launched_to_all = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Availability information of the detailed demographic. - repeated google.ads.googleads.v9.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/display_keyword_view.proto b/google/ads/googleads/v12/resources/display_keyword_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/display_keyword_view.proto rename to google/ads/googleads/v12/resources/display_keyword_view.proto index ba53d3b34..26c8c7da9 100644 --- a/google/ads/googleads/v9/resources/display_keyword_view.proto +++ b/google/ads/googleads/v12/resources/display_keyword_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DisplayKeywordViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the display keyword view resource. diff --git a/google/ads/googleads/v9/resources/distance_view.proto b/google/ads/googleads/v12/resources/distance_view.proto similarity index 77% rename from google/ads/googleads/v9/resources/distance_view.proto rename to google/ads/googleads/v12/resources/distance_view.proto index 711d9e507..f17916876 100644 --- a/google/ads/googleads/v9/resources/distance_view.proto +++ b/google/ads/googleads/v12/resources/distance_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/distance_bucket.proto"; +import "google/ads/googleads/v12/enums/distance_bucket.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DistanceViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the DistanceView resource. @@ -55,7 +54,7 @@ message DistanceView { ]; // Output only. Grouping of user distance from location extensions. - google.ads.googleads.v9.enums.DistanceBucketEnum.DistanceBucket distance_bucket = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. optional bool metric_system = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/google/ads/googleads/v9/resources/domain_category.proto b/google/ads/googleads/v12/resources/domain_category.proto similarity index 83% rename from google/ads/googleads/v9/resources/domain_category.proto rename to google/ads/googleads/v12/resources/domain_category.proto index 4fa7f739d..c41a717f0 100644 --- a/google/ads/googleads/v9/resources/domain_category.proto +++ b/google/ads/googleads/v12/resources/domain_category.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DomainCategoryProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Domain Category resource. @@ -60,12 +59,13 @@ 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 + // 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. diff --git a/google/ads/googleads/v9/resources/dynamic_search_ads_search_term_view.proto b/google/ads/googleads/v12/resources/dynamic_search_ads_search_term_view.proto similarity index 88% rename from google/ads/googleads/v9/resources/dynamic_search_ads_search_term_view.proto rename to google/ads/googleads/v12/resources/dynamic_search_ads_search_term_view.proto index 6ca9d0a00..742a67518 100644 --- a/google/ads/googleads/v9/resources/dynamic_search_ads_search_term_view.proto +++ b/google/ads/googleads/v12/resources/dynamic_search_ads_search_term_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "DynamicSearchAdsSearchTermViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Dynamic Search Ads Search Term View resource. diff --git a/google/ads/googleads/v9/resources/expanded_landing_page_view.proto b/google/ads/googleads/v12/resources/expanded_landing_page_view.proto similarity index 81% rename from google/ads/googleads/v9/resources/expanded_landing_page_view.proto rename to google/ads/googleads/v12/resources/expanded_landing_page_view.proto index 43d3e6d42..5e0ab62a9 100644 --- a/google/ads/googleads/v9/resources/expanded_landing_page_view.proto +++ b/google/ads/googleads/v12/resources/expanded_landing_page_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ExpandedLandingPageViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the expanded landing page view resource. diff --git a/google/ads/googleads/v12/resources/experiment.proto b/google/ads/googleads/v12/resources/experiment.proto new file mode 100644 index 000000000..d00bcfe3d --- /dev/null +++ b/google/ads/googleads/v12/resources/experiment.proto @@ -0,0 +1,106 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/common/metric_goal.proto"; +import "google/ads/googleads/v12/enums/async_action_status.proto"; +import "google/ads/googleads/v12/enums/experiment_status.proto"; +import "google/ads/googleads/v12/enums/experiment_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the Experiment resource. + +// A Google ads experiment for users to experiment changes on multiple +// campaigns, compare the performance, and apply the effective changes. +message Experiment { + option (google.api.resource) = { + type: "googleads.googleapis.com/Experiment" + pattern: "customers/{customer_id}/experiments/{trial_id}" + }; + + // Immutable. The resource name of the experiment. + // Experiment resource names have the form: + // + // `customers/{customer_id}/experiments/{experiment_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/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. + string name = 10 [(google.api.field_behavior) = REQUIRED]; + + // The description of the experiment. It must have a minimum length of 1 and + // maximum length of 2048. + string description = 11; + + // For system managed experiments, the advertiser must provide a suffix during + // construction, in the setup stage before moving to initiated. The suffix + // will be appended to the in-design and experiment campaign names so that the + // name is base campaign name + suffix. + string suffix = 12; + + // Required. The product/feature that uses this experiment. + google.ads.googleads.v12.enums.ExperimentTypeEnum.ExperimentType type = 13 [(google.api.field_behavior) = REQUIRED]; + + // The Advertiser-chosen status of this experiment. + google.ads.googleads.v12.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 + // set, then the experiment starts at the beginning of the specified date in + // the customer's time zone. + // + // Format: YYYY-MM-DD + // Example: 2019-03-14 + optional string start_date = 15; + + // Date when the experiment ends. 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 = 16; + + // The goals of this experiment. + repeated google.ads.googleads.v12.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 status of the experiment promotion process. + google.ads.googleads.v12.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v12/resources/experiment_arm.proto b/google/ads/googleads/v12/resources/experiment_arm.proto new file mode 100644 index 000000000..329691a73 --- /dev/null +++ b/google/ads/googleads/v12/resources/experiment_arm.proto @@ -0,0 +1,84 @@ +// 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.v12.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentArmProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the Experiment arm resource. + +// A Google ads experiment for users to experiment changes on multiple +// campaigns, compare the performance, and apply the effective changes. +message ExperimentArm { + option (google.api.resource) = { + type: "googleads.googleapis.com/ExperimentArm" + pattern: "customers/{customer_id}/experimentArms/{trial_id}~{trial_arm_id}" + }; + + // Immutable. The resource name of the experiment arm. + // Experiment arm resource names have the form: + // + // `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/ExperimentArm" + } + ]; + + // Immutable. The experiment to which the ExperimentArm belongs. + 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. + string name = 3 [(google.api.field_behavior) = REQUIRED]; + + // Whether this arm is a control arm. A control arm is the arm against + // which the other arms are compared. + bool control = 4; + + // Traffic split of the trial arm. The value should be between 1 and 100 + // and must total 100 between the two trial arms. + int64 traffic_split = 5; + + // 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" + }]; + + // Output only. The in design campaigns in the treatment experiment arm. + repeated string in_design_campaigns = 7 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Campaign" + } + ]; +} diff --git a/google/ads/googleads/v9/resources/extension_feed_item.proto b/google/ads/googleads/v12/resources/extension_feed_item.proto similarity index 64% rename from google/ads/googleads/v9/resources/extension_feed_item.proto rename to google/ads/googleads/v12/resources/extension_feed_item.proto index a870eb40a..7717e7a28 100644 --- a/google/ads/googleads/v9/resources/extension_feed_item.proto +++ b/google/ads/googleads/v12/resources/extension_feed_item.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. @@ -14,25 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/common/extensions.proto"; -import "google/ads/googleads/v9/enums/extension_type.proto"; -import "google/ads/googleads/v9/enums/feed_item_status.proto"; -import "google/ads/googleads/v9/enums/feed_item_target_device.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/common/extensions.proto"; +import "google/ads/googleads/v12/enums/extension_type.proto"; +import "google/ads/googleads/v12/enums/feed_item_status.proto"; +import "google/ads/googleads/v12/enums/feed_item_target_device.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ExtensionFeedItemProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ExtensionFeedItem resource. @@ -59,7 +58,7 @@ message ExtensionFeedItem { // Output only. The extension type of the extension feed item. // This field is read-only. - google.ads.googleads.v9.enums.ExtensionTypeEnum.ExtensionType extension_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -76,10 +75,10 @@ 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.v9.common.AdScheduleInfo ad_schedules = 16; + repeated google.ads.googleads.v12.common.AdScheduleInfo ad_schedules = 16; // The targeted device. - google.ads.googleads.v9.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 17; + google.ads.googleads.v12.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 17; // The targeted geo target constant. optional string targeted_geo_target_constant = 30 [(google.api.resource_reference) = { @@ -87,52 +86,52 @@ message ExtensionFeedItem { }]; // The targeted keyword. - google.ads.googleads.v9.common.KeywordInfo targeted_keyword = 22; + google.ads.googleads.v12.common.KeywordInfo targeted_keyword = 22; // Output only. Status of the feed item. // This field is read-only. - google.ads.googleads.v9.enums.FeedItemStatusEnum.FeedItemStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.FeedItemStatusEnum.FeedItemStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Extension type. oneof extension { // Sitelink extension. - google.ads.googleads.v9.common.SitelinkFeedItem sitelink_feed_item = 2; + google.ads.googleads.v12.common.SitelinkFeedItem sitelink_feed_item = 2; // Structured snippet extension. - google.ads.googleads.v9.common.StructuredSnippetFeedItem structured_snippet_feed_item = 3; + google.ads.googleads.v12.common.StructuredSnippetFeedItem structured_snippet_feed_item = 3; // App extension. - google.ads.googleads.v9.common.AppFeedItem app_feed_item = 7; + google.ads.googleads.v12.common.AppFeedItem app_feed_item = 7; // Call extension. - google.ads.googleads.v9.common.CallFeedItem call_feed_item = 8; + google.ads.googleads.v12.common.CallFeedItem call_feed_item = 8; // Callout extension. - google.ads.googleads.v9.common.CalloutFeedItem callout_feed_item = 9; + google.ads.googleads.v12.common.CalloutFeedItem callout_feed_item = 9; // Text message extension. - google.ads.googleads.v9.common.TextMessageFeedItem text_message_feed_item = 10; + google.ads.googleads.v12.common.TextMessageFeedItem text_message_feed_item = 10; // Price extension. - google.ads.googleads.v9.common.PriceFeedItem price_feed_item = 11; + google.ads.googleads.v12.common.PriceFeedItem price_feed_item = 11; // Promotion extension. - google.ads.googleads.v9.common.PromotionFeedItem promotion_feed_item = 12; + google.ads.googleads.v12.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.v9.common.LocationFeedItem location_feed_item = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.AffiliateLocationFeedItem affiliate_location_feed_item = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.AffiliateLocationFeedItem affiliate_location_feed_item = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; // Hotel Callout extension. - google.ads.googleads.v9.common.HotelCalloutFeedItem hotel_callout_feed_item = 23; + google.ads.googleads.v12.common.HotelCalloutFeedItem hotel_callout_feed_item = 23; // Immutable. Advertiser provided image extension. - google.ads.googleads.v9.common.ImageFeedItem image_feed_item = 31 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.ImageFeedItem image_feed_item = 31 [(google.api.field_behavior) = IMMUTABLE]; } // Targeting at either the campaign or ad group level. Feed items that target diff --git a/google/ads/googleads/v9/resources/feed.proto b/google/ads/googleads/v12/resources/feed.proto similarity index 85% rename from google/ads/googleads/v9/resources/feed.proto rename to google/ads/googleads/v12/resources/feed.proto index d995e02d5..d5dbcfa1f 100644 --- a/google/ads/googleads/v9/resources/feed.proto +++ b/google/ads/googleads/v12/resources/feed.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/affiliate_location_feed_relationship_type.proto"; -import "google/ads/googleads/v9/enums/feed_attribute_type.proto"; -import "google/ads/googleads/v9/enums/feed_origin.proto"; -import "google/ads/googleads/v9/enums/feed_status.proto"; +import "google/ads/googleads/v12/enums/affiliate_location_feed_relationship_type.proto"; +import "google/ads/googleads/v12/enums/feed_attribute_type.proto"; +import "google/ads/googleads/v12/enums/feed_origin.proto"; +import "google/ads/googleads/v12/enums/feed_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Feed resource. @@ -97,7 +96,7 @@ message Feed { repeated int64 chain_ids = 3; // The relationship the chains have with the advertiser. - google.ads.googleads.v9.enums.AffiliateLocationFeedRelationshipTypeEnum.AffiliateLocationFeedRelationshipType relationship_type = 2; + google.ads.googleads.v12.enums.AffiliateLocationFeedRelationshipTypeEnum.AffiliateLocationFeedRelationshipType relationship_type = 2; } // Immutable. The resource name of the feed. @@ -129,11 +128,11 @@ message Feed { repeated FeedAttributeOperation attribute_operations = 9; // Immutable. Specifies who manages the FeedAttributes for the Feed. - google.ads.googleads.v9.enums.FeedOriginEnum.FeedOrigin origin = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.FeedOriginEnum.FeedOrigin origin = 5 [(google.api.field_behavior) = IMMUTABLE]; // Output only. Status of the feed. // This field is read-only. - google.ads.googleads.v9.enums.FeedStatusEnum.FeedStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -159,7 +158,7 @@ message FeedAttribute { optional string name = 6; // Data type for feed attribute. Required. - google.ads.googleads.v9.enums.FeedAttributeTypeEnum.FeedAttributeType type = 3; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/feed_item.proto b/google/ads/googleads/v12/resources/feed_item.proto similarity index 68% rename from google/ads/googleads/v9/resources/feed_item.proto rename to google/ads/googleads/v12/resources/feed_item.proto index ec8cdecce..d82900125 100644 --- a/google/ads/googleads/v9/resources/feed_item.proto +++ b/google/ads/googleads/v12/resources/feed_item.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. @@ -14,32 +14,31 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/feed_common.proto"; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/feed_item_quality_approval_status.proto"; -import "google/ads/googleads/v9/enums/feed_item_quality_disapproval_reason.proto"; -import "google/ads/googleads/v9/enums/feed_item_status.proto"; -import "google/ads/googleads/v9/enums/feed_item_validation_status.proto"; -import "google/ads/googleads/v9/enums/geo_targeting_restriction.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; -import "google/ads/googleads/v9/errors/feed_item_validation_error.proto"; +package google.ads.googleads.v12.resources; + +import "google/ads/googleads/v12/common/custom_parameter.proto"; +import "google/ads/googleads/v12/common/feed_common.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/feed_item_quality_approval_status.proto"; +import "google/ads/googleads/v12/enums/feed_item_quality_disapproval_reason.proto"; +import "google/ads/googleads/v12/enums/feed_item_status.proto"; +import "google/ads/googleads/v12/enums/feed_item_validation_status.proto"; +import "google/ads/googleads/v12/enums/geo_targeting_restriction.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/enums/policy_approval_status.proto"; +import "google/ads/googleads/v12/enums/policy_review_status.proto"; +import "google/ads/googleads/v12/errors/feed_item_validation_error.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedItemProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the FeedItem resource. @@ -89,22 +88,22 @@ message FeedItem { // Geo targeting restriction specifies the type of location that can be used // for targeting. - google.ads.googleads.v9.enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction geo_targeting_restriction = 7; + google.ads.googleads.v12.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.v9.common.CustomParameter url_custom_parameters = 8; + repeated google.ads.googleads.v12.common.CustomParameter url_custom_parameters = 8; // Output only. Status of the feed item. // This field is read-only. - google.ads.googleads.v9.enums.FeedItemStatusEnum.FeedItemStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. - // This field is read-only. + // 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]; } @@ -134,7 +133,7 @@ message FeedItemAttributeValue { // Price value. Should be set if feed_attribute_id refers to a feed attribute // of type PRICE. - google.ads.googleads.v9.common.Money price_value = 6; + google.ads.googleads.v12.common.Money price_value = 6; // Repeated int64 value. Should be set if feed_attribute_id refers to a feed // attribute of type INT64_LIST. @@ -164,32 +163,32 @@ message FeedItemAttributeValue { // specified placeholder type. message FeedItemPlaceholderPolicyInfo { // Output only. The placeholder type. - google.ads.googleads.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type_enum = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; // Output only. Where the placeholder type is in the review process. - google.ads.googleads.v9.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.PolicyTopicEntry policy_topic_entries = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.common.PolicyTopicEntry policy_topic_entries = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The validation status of the palceholder type. - google.ads.googleads.v9.enums.FeedItemValidationStatusEnum.FeedItemValidationStatus validation_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; // Output only. Placeholder type quality evaluation approval status. - google.ads.googleads.v9.enums.FeedItemQualityApprovalStatusEnum.FeedItemQualityApprovalStatus quality_approval_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.FeedItemQualityDisapprovalReasonEnum.FeedItemQualityDisapprovalReason quality_disapproval_reasons = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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 @@ -197,18 +196,19 @@ message FeedItemPlaceholderPolicyInfo { 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.v9.errors.FeedItemValidationErrorEnum.FeedItemValidationError validation_error = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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). + // (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. + // 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/google/ads/googleads/v9/resources/feed_item_set.proto b/google/ads/googleads/v12/resources/feed_item_set.proto similarity index 74% rename from google/ads/googleads/v9/resources/feed_item_set.proto rename to google/ads/googleads/v12/resources/feed_item_set.proto index 8966f1f26..ac77d1586 100644 --- a/google/ads/googleads/v9/resources/feed_item_set.proto +++ b/google/ads/googleads/v12/resources/feed_item_set.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/feed_item_set_filter_type_infos.proto"; -import "google/ads/googleads/v9/enums/feed_item_set_status.proto"; +import "google/ads/googleads/v12/common/feed_item_set_filter_type_infos.proto"; +import "google/ads/googleads/v12/enums/feed_item_set_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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 @@ -67,18 +66,18 @@ message FeedItemSet { // Output only. Status of the feed item set. // This field is read-only. - google.ads.googleads.v9.enums.FeedItemSetStatusEnum.FeedItemSetStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.DynamicLocationSetFilter dynamic_location_set_filter = 5; + google.ads.googleads.v12.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.v9.common.DynamicAffiliateLocationSetFilter dynamic_affiliate_location_set_filter = 6; + google.ads.googleads.v12.common.DynamicAffiliateLocationSetFilter dynamic_affiliate_location_set_filter = 6; } } diff --git a/google/ads/googleads/v9/resources/feed_item_set_link.proto b/google/ads/googleads/v12/resources/feed_item_set_link.proto similarity index 83% rename from google/ads/googleads/v9/resources/feed_item_set_link.proto rename to google/ads/googleads/v12/resources/feed_item_set_link.proto index 709af2347..3090493b7 100644 --- a/google/ads/googleads/v9/resources/feed_item_set_link.proto +++ b/google/ads/googleads/v12/resources/feed_item_set_link.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the FeedItemSetLink resource. diff --git a/google/ads/googleads/v9/resources/feed_item_target.proto b/google/ads/googleads/v12/resources/feed_item_target.proto similarity index 70% rename from google/ads/googleads/v9/resources/feed_item_target.proto rename to google/ads/googleads/v12/resources/feed_item_target.proto index 032257003..6cb10da1b 100644 --- a/google/ads/googleads/v9/resources/feed_item_target.proto +++ b/google/ads/googleads/v12/resources/feed_item_target.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. @@ -14,24 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/feed_item_target_device.proto"; -import "google/ads/googleads/v9/enums/feed_item_target_status.proto"; -import "google/ads/googleads/v9/enums/feed_item_target_type.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/feed_item_target_device.proto"; +import "google/ads/googleads/v12/enums/feed_item_target_status.proto"; +import "google/ads/googleads/v12/enums/feed_item_target_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the FeedItemTarget resource. @@ -61,14 +60,14 @@ message FeedItemTarget { ]; // Output only. The target type of this feed item target. This field is read-only. - google.ads.googleads.v9.enums.FeedItemTargetTypeEnum.FeedItemTargetType feed_item_target_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; // Output only. Status of the feed item target. // This field is read-only. - google.ads.googleads.v9.enums.FeedItemTargetStatusEnum.FeedItemTargetStatus status = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.FeedItemTargetStatusEnum.FeedItemTargetStatus status = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // The targeted resource. oneof target { @@ -89,7 +88,7 @@ message FeedItemTarget { ]; // Immutable. The targeted keyword. - google.ads.googleads.v9.common.KeywordInfo keyword = 7 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.KeywordInfo keyword = 7 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. The targeted geo target constant resource name. string geo_target_constant = 16 [ @@ -100,9 +99,9 @@ message FeedItemTarget { ]; // Immutable. The targeted device. - google.ads.googleads.v9.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 9 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 9 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. The targeted schedule. - google.ads.googleads.v9.common.AdScheduleInfo ad_schedule = 10 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.AdScheduleInfo ad_schedule = 10 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v12/resources/feed_mapping.proto b/google/ads/googleads/v12/resources/feed_mapping.proto new file mode 100644 index 000000000..e06b1e5c1 --- /dev/null +++ b/google/ads/googleads/v12/resources/feed_mapping.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.v12.resources; + +import "google/ads/googleads/v12/enums/ad_customizer_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/affiliate_location_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/app_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/call_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/callout_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/custom_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/dsa_page_feed_criterion_field.proto"; +import "google/ads/googleads/v12/enums/education_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/feed_mapping_criterion_type.proto"; +import "google/ads/googleads/v12/enums/feed_mapping_status.proto"; +import "google/ads/googleads/v12/enums/flight_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/hotel_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/image_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/job_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/local_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/location_extension_targeting_criterion_field.proto"; +import "google/ads/googleads/v12/enums/location_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/message_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/enums/price_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/promotion_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/real_estate_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/sitelink_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/structured_snippet_placeholder_field.proto"; +import "google/ads/googleads/v12/enums/travel_placeholder_field.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "FeedMappingProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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.v12.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.v12.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.v12.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.v12.enums.SitelinkPlaceholderFieldEnum.SitelinkPlaceholderField sitelink_field = 3 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Call Placeholder Fields. + google.ads.googleads.v12.enums.CallPlaceholderFieldEnum.CallPlaceholderField call_field = 4 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. App Placeholder Fields. + google.ads.googleads.v12.enums.AppPlaceholderFieldEnum.AppPlaceholderField app_field = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. Location Placeholder Fields. This field is read-only. + google.ads.googleads.v12.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.v12.enums.AffiliateLocationPlaceholderFieldEnum.AffiliateLocationPlaceholderField affiliate_location_field = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Immutable. Callout Placeholder Fields. + google.ads.googleads.v12.enums.CalloutPlaceholderFieldEnum.CalloutPlaceholderField callout_field = 8 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Structured Snippet Placeholder Fields. + google.ads.googleads.v12.enums.StructuredSnippetPlaceholderFieldEnum.StructuredSnippetPlaceholderField structured_snippet_field = 9 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Message Placeholder Fields. + google.ads.googleads.v12.enums.MessagePlaceholderFieldEnum.MessagePlaceholderField message_field = 10 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Price Placeholder Fields. + google.ads.googleads.v12.enums.PricePlaceholderFieldEnum.PricePlaceholderField price_field = 11 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Promotion Placeholder Fields. + google.ads.googleads.v12.enums.PromotionPlaceholderFieldEnum.PromotionPlaceholderField promotion_field = 12 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Ad Customizer Placeholder Fields + google.ads.googleads.v12.enums.AdCustomizerPlaceholderFieldEnum.AdCustomizerPlaceholderField ad_customizer_field = 13 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Dynamic Search Ad Page Feed Fields. + google.ads.googleads.v12.enums.DsaPageFeedCriterionFieldEnum.DsaPageFeedCriterionField dsa_page_feed_field = 14 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Location Target Fields. + google.ads.googleads.v12.enums.LocationExtensionTargetingCriterionFieldEnum.LocationExtensionTargetingCriterionField location_extension_targeting_field = 15 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Education Placeholder Fields + google.ads.googleads.v12.enums.EducationPlaceholderFieldEnum.EducationPlaceholderField education_field = 16 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Flight Placeholder Fields + google.ads.googleads.v12.enums.FlightPlaceholderFieldEnum.FlightPlaceholderField flight_field = 17 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Custom Placeholder Fields + google.ads.googleads.v12.enums.CustomPlaceholderFieldEnum.CustomPlaceholderField custom_field = 18 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Hotel Placeholder Fields + google.ads.googleads.v12.enums.HotelPlaceholderFieldEnum.HotelPlaceholderField hotel_field = 19 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Real Estate Placeholder Fields + google.ads.googleads.v12.enums.RealEstatePlaceholderFieldEnum.RealEstatePlaceholderField real_estate_field = 20 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Travel Placeholder Fields + google.ads.googleads.v12.enums.TravelPlaceholderFieldEnum.TravelPlaceholderField travel_field = 21 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Local Placeholder Fields + google.ads.googleads.v12.enums.LocalPlaceholderFieldEnum.LocalPlaceholderField local_field = 22 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Job Placeholder Fields + google.ads.googleads.v12.enums.JobPlaceholderFieldEnum.JobPlaceholderField job_field = 23 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Image Placeholder Fields + google.ads.googleads.v12.enums.ImagePlaceholderFieldEnum.ImagePlaceholderField image_field = 26 [(google.api.field_behavior) = IMMUTABLE]; + } +} diff --git a/google/ads/googleads/v9/resources/feed_placeholder_view.proto b/google/ads/googleads/v12/resources/feed_placeholder_view.proto similarity index 72% rename from google/ads/googleads/v9/resources/feed_placeholder_view.proto rename to google/ads/googleads/v12/resources/feed_placeholder_view.proto index 1fe913670..35184cbaf 100644 --- a/google/ads/googleads/v9/resources/feed_placeholder_view.proto +++ b/google/ads/googleads/v12/resources/feed_placeholder_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; +import "google/ads/googleads/v12/enums/placeholder_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "FeedPlaceholderViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the FeedPlaceholderView resource. @@ -51,5 +50,5 @@ message FeedPlaceholderView { ]; // Output only. The placeholder type of the feed placeholder view. - google.ads.googleads.v9.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/gender_view.proto b/google/ads/googleads/v12/resources/gender_view.proto similarity index 78% rename from google/ads/googleads/v9/resources/gender_view.proto rename to google/ads/googleads/v12/resources/gender_view.proto index 55edbf79b..4e4a34a78 100644 --- a/google/ads/googleads/v9/resources/gender_view.proto +++ b/google/ads/googleads/v12/resources/gender_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "GenderViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the gender view resource. diff --git a/google/ads/googleads/v9/resources/geo_target_constant.proto b/google/ads/googleads/v12/resources/geo_target_constant.proto similarity index 81% rename from google/ads/googleads/v9/resources/geo_target_constant.proto rename to google/ads/googleads/v12/resources/geo_target_constant.proto index 2f7971865..fdbfc4542 100644 --- a/google/ads/googleads/v9/resources/geo_target_constant.proto +++ b/google/ads/googleads/v12/resources/geo_target_constant.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/geo_target_constant_status.proto"; +import "google/ads/googleads/v12/enums/geo_target_constant_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "GeoTargetConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the geo target constant resource. @@ -63,7 +62,7 @@ message GeoTargetConstant { optional string target_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Geo target constant status. - google.ads.googleads.v9.enums.GeoTargetConstantStatusEnum.GeoTargetConstantStatus status = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. diff --git a/google/ads/googleads/v9/resources/geographic_view.proto b/google/ads/googleads/v12/resources/geographic_view.proto similarity index 77% rename from google/ads/googleads/v9/resources/geographic_view.proto rename to google/ads/googleads/v12/resources/geographic_view.proto index 7c6bcc6c2..4863e7de7 100644 --- a/google/ads/googleads/v9/resources/geographic_view.proto +++ b/google/ads/googleads/v12/resources/geographic_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/geo_targeting_type.proto"; +import "google/ads/googleads/v12/enums/geo_targeting_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "GeographicViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the geographic view resource. @@ -56,7 +55,7 @@ message GeographicView { ]; // Output only. Type of the geo targeting of the campaign. - google.ads.googleads.v9.enums.GeoTargetingTypeEnum.GeoTargetingType location_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; diff --git a/google/ads/googleads/v9/resources/google_ads_field.proto b/google/ads/googleads/v12/resources/google_ads_field.proto similarity index 83% rename from google/ads/googleads/v9/resources/google_ads_field.proto rename to google/ads/googleads/v12/resources/google_ads_field.proto index 021ab2139..f80557e76 100644 --- a/google/ads/googleads/v9/resources/google_ads_field.proto +++ b/google/ads/googleads/v12/resources/google_ads_field.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/google_ads_field_category.proto"; -import "google/ads/googleads/v9/enums/google_ads_field_data_type.proto"; +import "google/ads/googleads/v12/enums/google_ads_field_category.proto"; +import "google/ads/googleads/v12/enums/google_ads_field_data_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "GoogleAdsFieldProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Google Ads Field resource. @@ -55,7 +54,7 @@ message GoogleAdsField { optional string name = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The category of the artifact. - google.ads.googleads.v9.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -98,7 +97,7 @@ message GoogleAdsField { // Output only. This field determines the operators that can be used with the artifact // in WHERE clauses. - google.ads.googleads.v9.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/group_placement_view.proto b/google/ads/googleads/v12/resources/group_placement_view.proto similarity index 71% rename from google/ads/googleads/v9/resources/group_placement_view.proto rename to google/ads/googleads/v12/resources/group_placement_view.proto index d00b1df24..dd28fea9a 100644 --- a/google/ads/googleads/v9/resources/group_placement_view.proto +++ b/google/ads/googleads/v12/resources/group_placement_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/placement_type.proto"; +import "google/ads/googleads/v12/enums/placement_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "GroupPlacementViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the group placement view resource. @@ -57,10 +56,11 @@ message GroupPlacementView { // 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.v9.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.v12.enums.PlacementTypeEnum.PlacementType placement_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/hotel_group_view.proto b/google/ads/googleads/v12/resources/hotel_group_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/hotel_group_view.proto rename to google/ads/googleads/v12/resources/hotel_group_view.proto index 17f94345d..b41a5d885 100644 --- a/google/ads/googleads/v9/resources/hotel_group_view.proto +++ b/google/ads/googleads/v12/resources/hotel_group_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "HotelGroupViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the hotel group view resource. diff --git a/google/ads/googleads/v9/resources/hotel_performance_view.proto b/google/ads/googleads/v12/resources/hotel_performance_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/hotel_performance_view.proto rename to google/ads/googleads/v12/resources/hotel_performance_view.proto index 9ebaa1060..d27f87a91 100644 --- a/google/ads/googleads/v9/resources/hotel_performance_view.proto +++ b/google/ads/googleads/v12/resources/hotel_performance_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "HotelPerformanceViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the hotel performance view resource. diff --git a/google/ads/googleads/v9/resources/hotel_reconciliation.proto b/google/ads/googleads/v12/resources/hotel_reconciliation.proto similarity index 83% rename from google/ads/googleads/v9/resources/hotel_reconciliation.proto rename to google/ads/googleads/v12/resources/hotel_reconciliation.proto index 8d677d56c..649c2143c 100644 --- a/google/ads/googleads/v9/resources/hotel_reconciliation.proto +++ b/google/ads/googleads/v12/resources/hotel_reconciliation.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. @@ -14,27 +14,26 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/hotel_reconciliation_status.proto"; +import "google/ads/googleads/v12/enums/hotel_reconciliation_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "HotelReconciliationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::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" @@ -63,6 +62,14 @@ message HotelReconciliation { // '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. + string campaign = 11 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/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]; @@ -102,7 +109,7 @@ message HotelReconciliation { // 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.v9.enums.HotelReconciliationStatusEnum.HotelReconciliationStatus status = 10 [ + google.ads.googleads.v12.enums.HotelReconciliationStatusEnum.HotelReconciliationStatus status = 10 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = OUTPUT_ONLY ]; diff --git a/google/ads/googleads/v9/resources/income_range_view.proto b/google/ads/googleads/v12/resources/income_range_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/income_range_view.proto rename to google/ads/googleads/v12/resources/income_range_view.proto index 4cefe063f..bdddaaba6 100644 --- a/google/ads/googleads/v9/resources/income_range_view.proto +++ b/google/ads/googleads/v12/resources/income_range_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "IncomeRangeViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the income range view resource. diff --git a/google/ads/googleads/v9/resources/invoice.proto b/google/ads/googleads/v12/resources/invoice.proto similarity index 61% rename from google/ads/googleads/v9/resources/invoice.proto rename to google/ads/googleads/v12/resources/invoice.proto index 1da7d815a..6c3dd7e22 100644 --- a/google/ads/googleads/v9/resources/invoice.proto +++ b/google/ads/googleads/v12/resources/invoice.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/dates.proto"; -import "google/ads/googleads/v9/enums/invoice_type.proto"; +import "google/ads/googleads/v12/common/dates.proto"; +import "google/ads/googleads/v12/enums/invoice_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "InvoiceProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Invoice resource. @@ -42,6 +41,62 @@ message 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. @@ -52,7 +107,7 @@ message Invoice { // `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 + // 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]; @@ -87,7 +142,28 @@ message Invoice { // 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.v9.common.DateRange billable_activity_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 resource name of the invoice. Multiple customers can share a given @@ -106,21 +182,21 @@ message Invoice { optional string id = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of invoice. - google.ads.googleads.v9.enums.InvoiceTypeEnum.InvoiceType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.InvoiceTypeEnum.InvoiceType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The resource name of this invoice’s billing setup. + // 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". + // 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, e.g. "1234-5678-9012". It appears on the invoice PDF as - // "Billing ID". + // 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 @@ -131,7 +207,7 @@ message Invoice { 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.v9.common.DateRange service_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -200,4 +276,7 @@ message Invoice { // 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/google/ads/googleads/v9/resources/keyword_plan.proto b/google/ads/googleads/v12/resources/keyword_plan.proto similarity index 75% rename from google/ads/googleads/v9/resources/keyword_plan.proto rename to google/ads/googleads/v12/resources/keyword_plan.proto index 41a660aef..d0232bf65 100644 --- a/google/ads/googleads/v9/resources/keyword_plan.proto +++ b/google/ads/googleads/v12/resources/keyword_plan.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/dates.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_forecast_interval.proto"; +import "google/ads/googleads/v12/common/dates.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_forecast_interval.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword plan resource. @@ -71,12 +70,13 @@ 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.v9.enums.KeywordPlanForecastIntervalEnum.KeywordPlanForecastInterval date_interval = 1; + google.ads.googleads.v12.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.v9.common.DateRange date_range = 2; + google.ads.googleads.v12.common.DateRange date_range = 2; } } diff --git a/google/ads/googleads/v9/resources/keyword_plan_ad_group.proto b/google/ads/googleads/v12/resources/keyword_plan_ad_group.proto similarity index 85% rename from google/ads/googleads/v9/resources/keyword_plan_ad_group.proto rename to google/ads/googleads/v12/resources/keyword_plan_ad_group.proto index a04308b35..980c12240 100644 --- a/google/ads/googleads/v9/resources/keyword_plan_ad_group.proto +++ b/google/ads/googleads/v12/resources/keyword_plan_ad_group.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword plan ad group resource. diff --git a/google/ads/googleads/v9/resources/keyword_plan_ad_group_keyword.proto b/google/ads/googleads/v12/resources/keyword_plan_ad_group_keyword.proto similarity index 73% rename from google/ads/googleads/v9/resources/keyword_plan_ad_group_keyword.proto rename to google/ads/googleads/v12/resources/keyword_plan_ad_group_keyword.proto index b39b02091..9ef059b3a 100644 --- a/google/ads/googleads/v9/resources/keyword_plan_ad_group_keyword.proto +++ b/google/ads/googleads/v12/resources/keyword_plan_ad_group_keyword.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupKeywordProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword plan ad group keyword resource. @@ -63,13 +62,12 @@ message KeywordPlanAdGroupKeyword { optional string text = 10; // The keyword match type. - google.ads.googleads.v9.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/keyword_plan_campaign.proto b/google/ads/googleads/v12/resources/keyword_plan_campaign.proto similarity index 85% rename from google/ads/googleads/v9/resources/keyword_plan_campaign.proto rename to google/ads/googleads/v12/resources/keyword_plan_campaign.proto index c2e5cdd6b..e6a0de516 100644 --- a/google/ads/googleads/v9/resources/keyword_plan_campaign.proto +++ b/google/ads/googleads/v12/resources/keyword_plan_campaign.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/keyword_plan_network.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_network.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword plan campaign resource. @@ -75,7 +74,7 @@ message KeywordPlanCampaign { // // This field is required and should not be empty when creating Keyword Plan // campaigns. - google.ads.googleads.v9.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6; + google.ads.googleads.v12.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. diff --git a/google/ads/googleads/v9/resources/keyword_plan_campaign_keyword.proto b/google/ads/googleads/v12/resources/keyword_plan_campaign_keyword.proto similarity index 81% rename from google/ads/googleads/v9/resources/keyword_plan_campaign_keyword.proto rename to google/ads/googleads/v12/resources/keyword_plan_campaign_keyword.proto index e5bf72e02..31af4212c 100644 --- a/google/ads/googleads/v9/resources/keyword_plan_campaign_keyword.proto +++ b/google/ads/googleads/v12/resources/keyword_plan_campaign_keyword.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignKeywordProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword plan negative keyword resource. @@ -63,7 +62,7 @@ message KeywordPlanCampaignKeyword { optional string text = 10; // The keyword match type. - google.ads.googleads.v9.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5; + google.ads.googleads.v12.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/google/ads/googleads/v9/resources/keyword_theme_constant.proto b/google/ads/googleads/v12/resources/keyword_theme_constant.proto similarity index 84% rename from google/ads/googleads/v9/resources/keyword_theme_constant.proto rename to google/ads/googleads/v12/resources/keyword_theme_constant.proto index 8e35dce0b..94e73f890 100644 --- a/google/ads/googleads/v9/resources/keyword_theme_constant.proto +++ b/google/ads/googleads/v12/resources/keyword_theme_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordThemeConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Smart Campaign keyword theme constant resource. diff --git a/google/ads/googleads/v9/resources/keyword_view.proto b/google/ads/googleads/v12/resources/keyword_view.proto similarity index 78% rename from google/ads/googleads/v9/resources/keyword_view.proto rename to google/ads/googleads/v12/resources/keyword_view.proto index a78971d18..43ecb6037 100644 --- a/google/ads/googleads/v9/resources/keyword_view.proto +++ b/google/ads/googleads/v12/resources/keyword_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "KeywordViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the keyword view resource. diff --git a/google/ads/googleads/v9/resources/label.proto b/google/ads/googleads/v12/resources/label.proto similarity index 69% rename from google/ads/googleads/v9/resources/label.proto rename to google/ads/googleads/v12/resources/label.proto index 7345ad07b..722dd912e 100644 --- a/google/ads/googleads/v9/resources/label.proto +++ b/google/ads/googleads/v12/resources/label.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/text_label.proto"; -import "google/ads/googleads/v9/enums/label_status.proto"; +import "google/ads/googleads/v12/common/text_label.proto"; +import "google/ads/googleads/v12/enums/label_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "LabelProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A label. message Label { @@ -48,7 +47,7 @@ message 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. @@ -59,8 +58,8 @@ message Label { optional string name = 7; // Output only. Status of the label. Read only. - google.ads.googleads.v9.enums.LabelStatusEnum.LabelStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.LabelStatusEnum.LabelStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // A type of label displaying text on a colored background. - google.ads.googleads.v9.common.TextLabel text_label = 5; + google.ads.googleads.v12.common.TextLabel text_label = 5; } diff --git a/google/ads/googleads/v9/resources/landing_page_view.proto b/google/ads/googleads/v12/resources/landing_page_view.proto similarity index 81% rename from google/ads/googleads/v9/resources/landing_page_view.proto rename to google/ads/googleads/v12/resources/landing_page_view.proto index bbd4bc500..30a823309 100644 --- a/google/ads/googleads/v9/resources/landing_page_view.proto +++ b/google/ads/googleads/v12/resources/landing_page_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "LandingPageViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the landing page view resource. diff --git a/google/ads/googleads/v9/resources/language_constant.proto b/google/ads/googleads/v12/resources/language_constant.proto similarity index 76% rename from google/ads/googleads/v9/resources/language_constant.proto rename to google/ads/googleads/v12/resources/language_constant.proto index 69934780d..1ee3a0f6d 100644 --- a/google/ads/googleads/v9/resources/language_constant.proto +++ b/google/ads/googleads/v12/resources/language_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "LanguageConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the language constant resource. @@ -52,11 +51,11 @@ 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/google/ads/googleads/v12/resources/lead_form_submission_data.proto b/google/ads/googleads/v12/resources/lead_form_submission_data.proto new file mode 100644 index 000000000..93b8a3a3e --- /dev/null +++ b/google/ads/googleads/v12/resources/lead_form_submission_data.proto @@ -0,0 +1,118 @@ +// 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.v12.resources; + +import "google/ads/googleads/v12/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.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "LeadFormSubmissionDataProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the lead form submission data resource. + +// Data from lead form submissions. +message LeadFormSubmissionData { + option (google.api.resource) = { + type: "googleads.googleapis.com/LeadFormSubmissionData" + pattern: "customers/{customer_id}/leadFormSubmissionData/{lead_form_user_submission_id}" + }; + + // Output only. The resource name of the lead form submission data. + // Lead form submission data resource names have the form: + // + // `customers/{customer_id}/leadFormSubmissionData/{lead_form_submission_data_id}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/LeadFormSubmissionData" + } + ]; + + // Output only. ID of this lead form submission. + string id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // 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" + } + ]; + + // Output only. Campaign associated with the submitted lead form. + string campaign = 4 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Campaign" + } + ]; + + // Output only. Submission data associated with a lead form. + 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 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroup" + } + ]; + + // Output only. AdGroupAd associated with the submitted lead form. + string ad_group_ad = 7 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAd" + } + ]; + + // 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", 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.v12.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/google/ads/googleads/v9/resources/life_event.proto b/google/ads/googleads/v12/resources/life_event.proto similarity index 76% rename from google/ads/googleads/v9/resources/life_event.proto rename to google/ads/googleads/v12/resources/life_event.proto index 374b9ecc2..bc44a9c31 100644 --- a/google/ads/googleads/v9/resources/life_event.proto +++ b/google/ads/googleads/v12/resources/life_event.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criterion_category_availability.proto"; +import "google/ads/googleads/v12/common/criterion_category_availability.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "LifeEventProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Life Event resource. @@ -54,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. @@ -69,5 +68,5 @@ message LifeEvent { bool launched_to_all = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Availability information of the life event. - repeated google.ads.googleads.v9.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/location_view.proto b/google/ads/googleads/v12/resources/location_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/location_view.proto rename to google/ads/googleads/v12/resources/location_view.proto index a218d83ee..fcb33e026 100644 --- a/google/ads/googleads/v9/resources/location_view.proto +++ b/google/ads/googleads/v12/resources/location_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "LocationViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the location view resource. diff --git a/google/ads/googleads/v9/resources/managed_placement_view.proto b/google/ads/googleads/v12/resources/managed_placement_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/managed_placement_view.proto rename to google/ads/googleads/v12/resources/managed_placement_view.proto index 82f352d6d..1ad726214 100644 --- a/google/ads/googleads/v9/resources/managed_placement_view.proto +++ b/google/ads/googleads/v12/resources/managed_placement_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ManagedPlacementViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Managed Placement view resource. diff --git a/google/ads/googleads/v9/resources/media_file.proto b/google/ads/googleads/v12/resources/media_file.proto similarity index 85% rename from google/ads/googleads/v9/resources/media_file.proto rename to google/ads/googleads/v12/resources/media_file.proto index 0e2c4eb93..d62ffcce4 100644 --- a/google/ads/googleads/v9/resources/media_file.proto +++ b/google/ads/googleads/v12/resources/media_file.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/media_type.proto"; -import "google/ads/googleads/v9/enums/mime_type.proto"; +import "google/ads/googleads/v12/enums/media_type.proto"; +import "google/ads/googleads/v12/enums/mime_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "MediaFileProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the media file resource. @@ -55,10 +54,10 @@ message MediaFile { optional int64 id = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Type of the media file. - google.ads.googleads.v9.enums.MediaTypeEnum.MediaType type = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.MediaTypeEnum.MediaType type = 5 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The mime type of the media file. - google.ads.googleads.v9.enums.MimeTypeEnum.MimeType mime_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -105,7 +104,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]; } diff --git a/google/ads/googleads/v9/resources/merchant_center_link.proto b/google/ads/googleads/v12/resources/merchant_center_link.proto similarity index 77% rename from google/ads/googleads/v9/resources/merchant_center_link.proto rename to google/ads/googleads/v12/resources/merchant_center_link.proto index 4643ce1a3..2b79b4b56 100644 --- a/google/ads/googleads/v9/resources/merchant_center_link.proto +++ b/google/ads/googleads/v12/resources/merchant_center_link.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/merchant_center_link_status.proto"; +import "google/ads/googleads/v12/enums/merchant_center_link_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "MerchantCenterLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Merchant Center link resource. @@ -60,5 +59,5 @@ message MerchantCenterLink { optional string merchant_center_account_name = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // The status of the link. - google.ads.googleads.v9.enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus status = 5; + google.ads.googleads.v12.enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus status = 5; } diff --git a/google/ads/googleads/v9/resources/mobile_app_category_constant.proto b/google/ads/googleads/v12/resources/mobile_app_category_constant.proto similarity index 82% rename from google/ads/googleads/v9/resources/mobile_app_category_constant.proto rename to google/ads/googleads/v12/resources/mobile_app_category_constant.proto index f2788d96d..3f6098c5d 100644 --- a/google/ads/googleads/v9/resources/mobile_app_category_constant.proto +++ b/google/ads/googleads/v12/resources/mobile_app_category_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "MobileAppCategoryConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Mobile App Category Constant resource. diff --git a/google/ads/googleads/v9/resources/mobile_device_constant.proto b/google/ads/googleads/v12/resources/mobile_device_constant.proto similarity index 78% rename from google/ads/googleads/v9/resources/mobile_device_constant.proto rename to google/ads/googleads/v12/resources/mobile_device_constant.proto index 32b3da89a..87c280958 100644 --- a/google/ads/googleads/v9/resources/mobile_device_constant.proto +++ b/google/ads/googleads/v12/resources/mobile_device_constant.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/mobile_device_type.proto"; +import "google/ads/googleads/v12/enums/mobile_device_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "MobileDeviceConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the mobile device constant resource. @@ -63,5 +62,5 @@ message MobileDeviceConstant { optional string operating_system_name = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of mobile device. - google.ads.googleads.v9.enums.MobileDeviceTypeEnum.MobileDeviceType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.MobileDeviceTypeEnum.MobileDeviceType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/offline_user_data_job.proto b/google/ads/googleads/v12/resources/offline_user_data_job.proto similarity index 60% rename from google/ads/googleads/v9/resources/offline_user_data_job.proto rename to google/ads/googleads/v12/resources/offline_user_data_job.proto index 9ec8cbd57..c61e2d9ba 100644 --- a/google/ads/googleads/v9/resources/offline_user_data_job.proto +++ b/google/ads/googleads/v12/resources/offline_user_data_job.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. @@ -14,32 +14,31 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/offline_user_data.proto"; -import "google/ads/googleads/v9/enums/offline_user_data_job_failure_reason.proto"; -import "google/ads/googleads/v9/enums/offline_user_data_job_match_rate_range.proto"; -import "google/ads/googleads/v9/enums/offline_user_data_job_status.proto"; -import "google/ads/googleads/v9/enums/offline_user_data_job_type.proto"; +import "google/ads/googleads/v12/common/offline_user_data.proto"; +import "google/ads/googleads/v12/enums/offline_user_data_job_failure_reason.proto"; +import "google/ads/googleads/v12/enums/offline_user_data_job_match_rate_range.proto"; +import "google/ads/googleads/v12/enums/offline_user_data_job_status.proto"; +import "google/ads/googleads/v12/enums/offline_user_data_job_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the offline user data job resource. // A job containing offline user data of store visitors, or user list members // that will be processed asynchronously. The uploaded data isn't readable and // the processing results of the job can only be read using -// OfflineUserDataJobService.GetOfflineUserDataJob. +// GoogleAdsService.Search/SearchStream. message OfflineUserDataJob { option (google.api.resource) = { type: "googleads.googleapis.com/OfflineUserDataJob" @@ -64,13 +63,13 @@ message OfflineUserDataJob { optional int64 external_id = 10 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Type of the job. - google.ads.googleads.v9.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(google.api.field_behavior) = IMMUTABLE]; // Output only. Status of the job. - google.ads.googleads.v9.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -78,18 +77,18 @@ message OfflineUserDataJob { // Metadata of the job. oneof metadata { // Immutable. Metadata for data updates to a CRM-based user list. - google.ads.googleads.v9.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Metadata for store sales data update. - google.ads.googleads.v9.common.StoreSalesMetadata store_sales_metadata = 8 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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 + // 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.v9.enums.OfflineUserDataJobMatchRateRangeEnum.OfflineUserDataJobMatchRateRange match_rate_range = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // "SUCCESS/FAILED". + google.ads.googleads.v12.enums.OfflineUserDataJobMatchRateRangeEnum.OfflineUserDataJobMatchRateRange match_rate_range = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/operating_system_version_constant.proto b/google/ads/googleads/v12/resources/operating_system_version_constant.proto similarity index 78% rename from google/ads/googleads/v9/resources/operating_system_version_constant.proto rename to google/ads/googleads/v12/resources/operating_system_version_constant.proto index 0031309f1..0fca27fe1 100644 --- a/google/ads/googleads/v9/resources/operating_system_version_constant.proto +++ b/google/ads/googleads/v12/resources/operating_system_version_constant.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/operating_system_version_operator_type.proto"; +import "google/ads/googleads/v12/enums/operating_system_version_operator_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "OperatingSystemVersionConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the operating system version constant resource. @@ -66,5 +65,5 @@ message OperatingSystemVersionConstant { // Output only. Determines whether this constant represents a single version or a range of // versions. - google.ads.googleads.v9.enums.OperatingSystemVersionOperatorTypeEnum.OperatingSystemVersionOperatorType operator_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.OperatingSystemVersionOperatorTypeEnum.OperatingSystemVersionOperatorType operator_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/paid_organic_search_term_view.proto b/google/ads/googleads/v12/resources/paid_organic_search_term_view.proto similarity index 82% rename from google/ads/googleads/v9/resources/paid_organic_search_term_view.proto rename to google/ads/googleads/v12/resources/paid_organic_search_term_view.proto index 261b2c6ad..e51055f38 100644 --- a/google/ads/googleads/v9/resources/paid_organic_search_term_view.proto +++ b/google/ads/googleads/v12/resources/paid_organic_search_term_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "PaidOrganicSearchTermViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the PaidOrganicSearchTermView resource. diff --git a/google/ads/googleads/v9/resources/parental_status_view.proto b/google/ads/googleads/v12/resources/parental_status_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/parental_status_view.proto rename to google/ads/googleads/v12/resources/parental_status_view.proto index de331f8f3..cb7781b1a 100644 --- a/google/ads/googleads/v9/resources/parental_status_view.proto +++ b/google/ads/googleads/v12/resources/parental_status_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ParentalStatusViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the parental status view resource. diff --git a/google/ads/googleads/v9/resources/payments_account.proto b/google/ads/googleads/v12/resources/payments_account.proto similarity index 84% rename from google/ads/googleads/v9/resources/payments_account.proto rename to google/ads/googleads/v12/resources/payments_account.proto index a20d481f8..2bcc1d007 100644 --- a/google/ads/googleads/v9/resources/payments_account.proto +++ b/google/ads/googleads/v12/resources/payments_account.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "PaymentsAccountProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the PaymentsAccount resource. @@ -64,8 +63,8 @@ message PaymentsAccount { // 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. + // 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. diff --git a/google/ads/googleads/v12/resources/per_store_view.proto b/google/ads/googleads/v12/resources/per_store_view.proto new file mode 100644 index 000000000..a79c5a0a4 --- /dev/null +++ b/google/ads/googleads/v12/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.v12.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "PerStoreViewProto"; +option java_package = "com.google.ads.googleads.v12.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; + +// Proto file describing the PerStoreView resource. + +// An 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/google/ads/googleads/v9/resources/product_bidding_category_constant.proto b/google/ads/googleads/v12/resources/product_bidding_category_constant.proto similarity index 76% rename from google/ads/googleads/v9/resources/product_bidding_category_constant.proto rename to google/ads/googleads/v12/resources/product_bidding_category_constant.proto index 925889008..b6635f5d5 100644 --- a/google/ads/googleads/v9/resources/product_bidding_category_constant.proto +++ b/google/ads/googleads/v12/resources/product_bidding_category_constant.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/product_bidding_category_level.proto"; -import "google/ads/googleads/v9/enums/product_bidding_category_status.proto"; +import "google/ads/googleads/v12/enums/product_bidding_category_level.proto"; +import "google/ads/googleads/v12/enums/product_bidding_category_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ProductBiddingCategoryConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ProductBiddingCategoryConstant resource. @@ -69,10 +68,10 @@ message ProductBiddingCategoryConstant { ]; // Output only. Level of the product bidding category. - google.ads.googleads.v9.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Status of the product bidding category. - google.ads.googleads.v9.enums.ProductBiddingCategoryStatusEnum.ProductBiddingCategoryStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; diff --git a/google/ads/googleads/v9/resources/product_group_view.proto b/google/ads/googleads/v12/resources/product_group_view.proto similarity index 79% rename from google/ads/googleads/v9/resources/product_group_view.proto rename to google/ads/googleads/v12/resources/product_group_view.proto index 1ce1ccfa0..31e69b08e 100644 --- a/google/ads/googleads/v9/resources/product_group_view.proto +++ b/google/ads/googleads/v12/resources/product_group_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ProductGroupViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ProductGroup View resource. diff --git a/google/ads/googleads/v9/resources/recommendation.proto b/google/ads/googleads/v12/resources/recommendation.proto similarity index 62% rename from google/ads/googleads/v9/resources/recommendation.proto rename to google/ads/googleads/v12/resources/recommendation.proto index d426c4e16..213b6ffe6 100644 --- a/google/ads/googleads/v9/resources/recommendation.proto +++ b/google/ads/googleads/v12/resources/recommendation.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. @@ -14,26 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/common/extensions.proto"; -import "google/ads/googleads/v9/enums/keyword_match_type.proto"; -import "google/ads/googleads/v9/enums/recommendation_type.proto"; -import "google/ads/googleads/v9/enums/target_cpa_opt_in_recommendation_goal.proto"; -import "google/ads/googleads/v9/resources/ad.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/common/extensions.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/enums/recommendation_type.proto"; +import "google/ads/googleads/v12/enums/target_cpa_opt_in_recommendation_goal.proto"; +import "google/ads/googleads/v12/resources/ad.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "RecommendationProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Recommendation resource. @@ -99,53 +98,33 @@ message Recommendation { // The keyword recommendation. message KeywordRecommendation { // Output only. The recommended keyword. - google.ads.googleads.v9.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 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 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. + // 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, e.g., 2018-04-17. + // YYYY-MM-DD format, for example, 2018-04-17. optional string auto_apply_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // 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 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.v9.enums.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal goal = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -174,23 +153,21 @@ message Recommendation { optional int64 recommended_budget_amount_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // The Search Partners Opt-In recommendation. - message SearchPartnersOptInRecommendation { + // The Enhanced Cost-Per-Click Opt-In recommendation. + message EnhancedCpcOptInRecommendation { } - // 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]; + // The Search Partners Opt-In recommendation. + message SearchPartnersOptInRecommendation { - // Output only. The recommendation for the constrained budget to increase. - CampaignBudgetRecommendation budget_recommendation = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // The Enhanced Cost-Per-Click Opt-In recommendation. - message EnhancedCpcOptInRecommendation { - + // 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. @@ -201,28 +178,69 @@ message Recommendation { // The Callout extension recommendation. message CalloutExtensionRecommendation { // Output only. Callout extensions recommended to be added. - repeated google.ads.googleads.v9.common.CalloutFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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.v9.common.SitelinkFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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.v9.common.CallFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.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.v9.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The recommended new match type. - google.ads.googleads.v9.enums.KeywordMatchTypeEnum.KeywordMatchType recommended_match_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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 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. @@ -231,6 +249,80 @@ message Recommendation { 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.v12.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}` @@ -242,7 +334,7 @@ message Recommendation { ]; // Output only. The type of recommendation. - google.ads.googleads.v9.enums.RecommendationTypeEnum.RecommendationType type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -265,10 +357,17 @@ message Recommendation { // the recommendation affects a single campaign. // // This field will be set for the following recommendation types: - // CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, KEYWORD, - // KEYWORD_MATCH_TYPE, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, - // OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, SEARCH_PARTNERS_OPT_IN, - // SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD + // 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) = { @@ -280,7 +379,8 @@ message Recommendation { // the recommendation affects a single ad group. // // This field will be set for the following recommendation types: - // KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, TEXT_AD + // 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) = { @@ -346,5 +446,31 @@ message Recommendation { // 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]; } } diff --git a/google/ads/googleads/v9/resources/remarketing_action.proto b/google/ads/googleads/v12/resources/remarketing_action.proto similarity index 78% rename from google/ads/googleads/v9/resources/remarketing_action.proto rename to google/ads/googleads/v12/resources/remarketing_action.proto index 9ba66f5a0..f8c7e3845 100644 --- a/google/ads/googleads/v9/resources/remarketing_action.proto +++ b/google/ads/googleads/v12/resources/remarketing_action.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/tag_snippet.proto"; +import "google/ads/googleads/v12/common/tag_snippet.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "RemarketingActionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Remarketing Action resource. @@ -62,5 +61,5 @@ message RemarketingAction { optional string name = 6; // Output only. The snippets used for tracking remarketing actions. - repeated google.ads.googleads.v9.common.TagSnippet tag_snippets = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.common.TagSnippet tag_snippets = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/search_term_view.proto b/google/ads/googleads/v12/resources/search_term_view.proto similarity index 76% rename from google/ads/googleads/v9/resources/search_term_view.proto rename to google/ads/googleads/v12/resources/search_term_view.proto index 207854250..c95afd4fd 100644 --- a/google/ads/googleads/v9/resources/search_term_view.proto +++ b/google/ads/googleads/v12/resources/search_term_view.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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/search_term_targeting_status.proto"; +import "google/ads/googleads/v12/enums/search_term_targeting_status.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "SearchTermViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the SearchTermView resource. @@ -64,5 +63,5 @@ message SearchTermView { // Output only. Indicates whether the search term is currently one of your // targeted or excluded keywords. - google.ads.googleads.v9.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/shared_criterion.proto b/google/ads/googleads/v12/resources/shared_criterion.proto similarity index 63% rename from google/ads/googleads/v9/resources/shared_criterion.proto rename to google/ads/googleads/v12/resources/shared_criterion.proto index 24e999d4f..7aa235588 100644 --- a/google/ads/googleads/v9/resources/shared_criterion.proto +++ b/google/ads/googleads/v12/resources/shared_criterion.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/enums/criterion_type.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/enums/criterion_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "SharedCriterionProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the SharedCriterion resource. @@ -65,28 +64,28 @@ message SharedCriterion { optional int64 criterion_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of the criterion. - google.ads.googleads.v9.enums.CriterionTypeEnum.CriterionType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.common.KeywordInfo keyword = 3 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.KeywordInfo keyword = 3 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Video. - google.ads.googleads.v9.common.YouTubeVideoInfo youtube_video = 5 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeVideoInfo youtube_video = 5 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. YouTube Channel. - google.ads.googleads.v9.common.YouTubeChannelInfo youtube_channel = 6 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.YouTubeChannelInfo youtube_channel = 6 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Placement. - google.ads.googleads.v9.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile App Category. - google.ads.googleads.v9.common.MobileAppCategoryInfo mobile_app_category = 8 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileAppCategoryInfo mobile_app_category = 8 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Mobile application. - google.ads.googleads.v9.common.MobileApplicationInfo mobile_application = 9 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.common.MobileApplicationInfo mobile_application = 9 [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v9/resources/shared_set.proto b/google/ads/googleads/v12/resources/shared_set.proto similarity index 75% rename from google/ads/googleads/v9/resources/shared_set.proto rename to google/ads/googleads/v12/resources/shared_set.proto index 9e73ff713..eacc9faaf 100644 --- a/google/ads/googleads/v9/resources/shared_set.proto +++ b/google/ads/googleads/v12/resources/shared_set.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/enums/shared_set_status.proto"; -import "google/ads/googleads/v9/enums/shared_set_type.proto"; +import "google/ads/googleads/v12/enums/shared_set_status.proto"; +import "google/ads/googleads/v12/enums/shared_set_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "SharedSetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the SharedSet resource. @@ -57,7 +56,7 @@ message SharedSet { // Immutable. The type of this shared set: each shared set holds only a single kind // of resource. Required. Immutable. - google.ads.googleads.v9.enums.SharedSetTypeEnum.SharedSetType type = 3 [(google.api.field_behavior) = IMMUTABLE]; + google.ads.googleads.v12.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 @@ -67,7 +66,7 @@ message SharedSet { optional string name = 9; // Output only. The status of this shared set. Read only. - google.ads.googleads.v9.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(google.api.field_behavior) = OUTPUT_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]; diff --git a/google/ads/googleads/v9/resources/shopping_performance_view.proto b/google/ads/googleads/v12/resources/shopping_performance_view.proto similarity index 82% rename from google/ads/googleads/v9/resources/shopping_performance_view.proto rename to google/ads/googleads/v12/resources/shopping_performance_view.proto index b2d741fc3..6015c0b28 100644 --- a/google/ads/googleads/v9/resources/shopping_performance_view.proto +++ b/google/ads/googleads/v12/resources/shopping_performance_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ShoppingPerformanceViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the ShoppingPerformanceView resource. diff --git a/google/ads/googleads/v9/resources/smart_campaign_search_term_view.proto b/google/ads/googleads/v12/resources/smart_campaign_search_term_view.proto similarity index 83% rename from google/ads/googleads/v9/resources/smart_campaign_search_term_view.proto rename to google/ads/googleads/v12/resources/smart_campaign_search_term_view.proto index 9e1cf544e..4e466fd83 100644 --- a/google/ads/googleads/v9/resources/smart_campaign_search_term_view.proto +++ b/google/ads/googleads/v12/resources/smart_campaign_search_term_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "SmartCampaignSearchTermViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the SmartCampaignSearchTermView resource. diff --git a/google/ads/googleads/v9/resources/smart_campaign_setting.proto b/google/ads/googleads/v12/resources/smart_campaign_setting.proto similarity index 57% rename from google/ads/googleads/v9/resources/smart_campaign_setting.proto rename to google/ads/googleads/v12/resources/smart_campaign_setting.proto index 293c7cefd..6c38f7521 100644 --- a/google/ads/googleads/v9/resources/smart_campaign_setting.proto +++ b/google/ads/googleads/v12/resources/smart_campaign_setting.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "SmartCampaignSettingProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Smart campaign setting resource. @@ -47,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: // @@ -69,23 +77,34 @@ 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. 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/google/ads/googleads/v9/resources/third_party_app_analytics_link.proto b/google/ads/googleads/v12/resources/third_party_app_analytics_link.proto similarity index 82% rename from google/ads/googleads/v9/resources/third_party_app_analytics_link.proto rename to google/ads/googleads/v12/resources/third_party_app_analytics_link.proto index 2aa49b91c..f042ed90e 100644 --- a/google/ads/googleads/v9/resources/third_party_app_analytics_link.proto +++ b/google/ads/googleads/v12/resources/third_party_app_analytics_link.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "ThirdPartyAppAnalyticsLinkProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // A data sharing connection, allowing the import of third party app analytics // into a Google Ads Customer. diff --git a/google/ads/googleads/v9/resources/topic_constant.proto b/google/ads/googleads/v12/resources/topic_constant.proto similarity index 85% rename from google/ads/googleads/v9/resources/topic_constant.proto rename to google/ads/googleads/v12/resources/topic_constant.proto index 3cd6f64e0..4b6a12115 100644 --- a/google/ads/googleads/v9/resources/topic_constant.proto +++ b/google/ads/googleads/v12/resources/topic_constant.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "TopicConstantProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the Topic Constant resource. diff --git a/google/ads/googleads/v9/resources/topic_view.proto b/google/ads/googleads/v12/resources/topic_view.proto similarity index 78% rename from google/ads/googleads/v9/resources/topic_view.proto rename to google/ads/googleads/v12/resources/topic_view.proto index 8040a3d0f..5c20bfabf 100644 --- a/google/ads/googleads/v9/resources/topic_view.proto +++ b/google/ads/googleads/v12/resources/topic_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "TopicViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the topic view resource. diff --git a/google/ads/googleads/v9/resources/user_interest.proto b/google/ads/googleads/v12/resources/user_interest.proto similarity index 73% rename from google/ads/googleads/v9/resources/user_interest.proto rename to google/ads/googleads/v12/resources/user_interest.proto index 345a0e16e..459b42a4a 100644 --- a/google/ads/googleads/v9/resources/user_interest.proto +++ b/google/ads/googleads/v12/resources/user_interest.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. @@ -14,22 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/criterion_category_availability.proto"; -import "google/ads/googleads/v9/enums/user_interest_taxonomy_type.proto"; +import "google/ads/googleads/v12/common/criterion_category_availability.proto"; +import "google/ads/googleads/v12/enums/user_interest_taxonomy_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "UserInterestProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the User Interest resource. @@ -52,7 +51,7 @@ message UserInterest { ]; // Output only. Taxonomy type of the user interest. - google.ads.googleads.v9.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType taxonomy_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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]; @@ -72,5 +71,5 @@ message UserInterest { optional bool launched_to_all = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Availability information of the user interest. - repeated google.ads.googleads.v9.common.CriterionCategoryAvailability availabilities = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated google.ads.googleads.v12.common.CriterionCategoryAvailability availabilities = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v9/resources/user_list.proto b/google/ads/googleads/v12/resources/user_list.proto similarity index 70% rename from google/ads/googleads/v9/resources/user_list.proto rename to google/ads/googleads/v12/resources/user_list.proto index f479d053d..c93df2564 100644 --- a/google/ads/googleads/v9/resources/user_list.proto +++ b/google/ads/googleads/v12/resources/user_list.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. @@ -14,27 +14,26 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; -import "google/ads/googleads/v9/common/user_lists.proto"; -import "google/ads/googleads/v9/enums/access_reason.proto"; -import "google/ads/googleads/v9/enums/user_list_access_status.proto"; -import "google/ads/googleads/v9/enums/user_list_closing_reason.proto"; -import "google/ads/googleads/v9/enums/user_list_membership_status.proto"; -import "google/ads/googleads/v9/enums/user_list_size_range.proto"; -import "google/ads/googleads/v9/enums/user_list_type.proto"; +import "google/ads/googleads/v12/common/user_lists.proto"; +import "google/ads/googleads/v12/enums/access_reason.proto"; +import "google/ads/googleads/v12/enums/user_list_access_status.proto"; +import "google/ads/googleads/v12/enums/user_list_closing_reason.proto"; +import "google/ads/googleads/v12/enums/user_list_membership_status.proto"; +import "google/ads/googleads/v12/enums/user_list_size_range.proto"; +import "google/ads/googleads/v12/enums/user_list_type.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "UserListProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the User List resource. @@ -59,7 +58,7 @@ 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 + // 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. // @@ -67,7 +66,7 @@ message UserList { 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. @@ -76,7 +75,7 @@ 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.v9.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6; + google.ads.googleads.v12.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6; // An ID from external system. It is used by user list sellers to correlate // IDs on their systems. @@ -100,7 +99,7 @@ message UserList { // Display Network. // // This field is read-only. - google.ads.googleads.v9.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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. @@ -112,29 +111,29 @@ message UserList { // Output only. Size range in terms of number of users of the UserList, for Search ads. // // This field is read-only. - google.ads.googleads.v9.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.UserListTypeEnum.UserListType type = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14; + google.ads.googleads.v12.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. // // This field is read-only. - google.ads.googleads.v9.enums.AccessReasonEnum.AccessReason access_reason = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.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.v9.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16; + google.ads.googleads.v12.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; @@ -156,19 +155,19 @@ message UserList { // Exactly one must be set. oneof user_list { // User list of CRM users provided by the advertiser. - google.ads.googleads.v9.common.CrmBasedUserListInfo crm_based_user_list = 19; + google.ads.googleads.v12.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.v9.common.SimilarUserListInfo similar_user_list = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.ads.googleads.v12.common.SimilarUserListInfo similar_user_list = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; // User list generated by a rule. - google.ads.googleads.v9.common.RuleBasedUserListInfo rule_based_user_list = 21; + google.ads.googleads.v12.common.RuleBasedUserListInfo rule_based_user_list = 21; // User list that is a custom combination of user lists and user interests. - google.ads.googleads.v9.common.LogicalUserListInfo logical_user_list = 22; + google.ads.googleads.v12.common.LogicalUserListInfo logical_user_list = 22; // User list targeting as a collection of conversion or remarketing actions. - google.ads.googleads.v9.common.BasicUserListInfo basic_user_list = 23; + google.ads.googleads.v12.common.BasicUserListInfo basic_user_list = 23; } } diff --git a/google/ads/googleads/v9/resources/user_location_view.proto b/google/ads/googleads/v12/resources/user_location_view.proto similarity index 84% rename from google/ads/googleads/v9/resources/user_location_view.proto rename to google/ads/googleads/v12/resources/user_location_view.proto index 496c4a98a..624056a54 100644 --- a/google/ads/googleads/v9/resources/user_location_view.proto +++ b/google/ads/googleads/v12/resources/user_location_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "UserLocationViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the user location view resource. diff --git a/google/ads/googleads/v9/resources/video.proto b/google/ads/googleads/v12/resources/video.proto similarity index 82% rename from google/ads/googleads/v9/resources/video.proto rename to google/ads/googleads/v12/resources/video.proto index 3078b6d4b..73e3a91d9 100644 --- a/google/ads/googleads/v9/resources/video.proto +++ b/google/ads/googleads/v12/resources/video.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "VideoProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the video resource. diff --git a/google/ads/googleads/v9/resources/webpage_view.proto b/google/ads/googleads/v12/resources/webpage_view.proto similarity index 78% rename from google/ads/googleads/v9/resources/webpage_view.proto rename to google/ads/googleads/v12/resources/webpage_view.proto index 8bea57f30..82aaeeacc 100644 --- a/google/ads/googleads/v9/resources/webpage_view.proto +++ b/google/ads/googleads/v12/resources/webpage_view.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. @@ -14,20 +14,19 @@ syntax = "proto3"; -package google.ads.googleads.v9.resources; +package google.ads.googleads.v12.resources; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -import "google/api/annotations.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources"; option java_multiple_files = true; option java_outer_classname = "WebpageViewProto"; -option java_package = "com.google.ads.googleads.v9.resources"; +option java_package = "com.google.ads.googleads.v12.resources"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::Resources"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources"; +option ruby_package = "Google::Ads::GoogleAds::V12::Resources"; // Proto file describing the webpage view resource. diff --git a/google/ads/googleads/v9/services/BUILD.bazel b/google/ads/googleads/v12/services/BUILD.bazel similarity index 94% rename from google/ads/googleads/v9/services/BUILD.bazel rename to google/ads/googleads/v12/services/BUILD.bazel index f34bc42c0..358291a40 100644 --- a/google/ads/googleads/v9/services/BUILD.bazel +++ b/google/ads/googleads/v12/services/BUILD.bazel @@ -27,10 +27,10 @@ proto_library( name = "services_proto", srcs = glob(["*.proto"]), deps = [ - "//google/ads/googleads/v9/common:common_proto", - "//google/ads/googleads/v9/enums:enums_proto", - "//google/ads/googleads/v9/errors:errors_proto", - "//google/ads/googleads/v9/resources:resources_proto", + "//google/ads/googleads/v12/common:common_proto", + "//google/ads/googleads/v12/enums:enums_proto", + "//google/ads/googleads/v12/errors:errors_proto", + "//google/ads/googleads/v12/resources:resources_proto", "//google/api:annotations_proto", "//google/api:client_proto", "//google/api:field_behavior_proto", diff --git a/google/ads/googleads/v9/services/account_budget_proposal_service.proto b/google/ads/googleads/v12/services/account_budget_proposal_service.proto similarity index 66% rename from google/ads/googleads/v9/services/account_budget_proposal_service.proto rename to google/ads/googleads/v12/services/account_budget_proposal_service.proto index 4252e7bbf..38e673747 100644 --- a/google/ads/googleads/v9/services/account_budget_proposal_service.proto +++ b/google/ads/googleads/v12/services/account_budget_proposal_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. @@ -14,36 +14,31 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/account_budget_proposal.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AccountBudgetProposalServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::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. // -// Reads for account-level budgets managed by these proposals will be -// supported in a future version. Until then, please use the -// BudgetOrderService from the AdWords API. Learn more at -// https://developers.google.com/adwords/api/docs/guides/budget-order -// // Mutates: // The CREATE operation creates a new proposal. // UPDATE operations aren't supported. @@ -52,22 +47,6 @@ service AccountBudgetProposalService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns an account-level budget proposal in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAccountBudgetProposal(GetAccountBudgetProposalRequest) returns (google.ads.googleads.v9.resources.AccountBudgetProposal) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/accountBudgetProposals/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes account budget proposals. Operation statuses // are returned. // @@ -87,7 +66,7 @@ service AccountBudgetProposalService { // [StringLengthError]() rpc MutateAccountBudgetProposal(MutateAccountBudgetProposalRequest) returns (MutateAccountBudgetProposalResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/accountBudgetProposals:mutate" + post: "/v12/customers/{customer_id=*}/accountBudgetProposals:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; @@ -95,19 +74,7 @@ service AccountBudgetProposalService { } // Request message for -// [AccountBudgetProposalService.GetAccountBudgetProposal][google.ads.googleads.v9.services.AccountBudgetProposalService.GetAccountBudgetProposal]. -message GetAccountBudgetProposalRequest { - // Required. The resource name of the account-level budget proposal to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AccountBudgetProposal" - } - ]; -} - -// Request message for -// [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v9.services.AccountBudgetProposalService.MutateAccountBudgetProposal]. +// [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal]. message MutateAccountBudgetProposalRequest { // Required. The ID of the customer. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -137,14 +104,16 @@ 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.v9.resources.AccountBudgetProposal create = 2; + google.ads.googleads.v12.resources.AccountBudgetProposal create = 2; // Remove operation: A resource name for the removed proposal is expected, // in this format: // // `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}` // A request may be cancelled iff it is pending. - string remove = 1; + string remove = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AccountBudgetProposal" + }]; } } @@ -157,5 +126,7 @@ message MutateAccountBudgetProposalResponse { // The result for the account budget proposal mutate. message MutateAccountBudgetProposalResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AccountBudgetProposal" + }]; } diff --git a/google/ads/googleads/v9/services/account_link_service.proto b/google/ads/googleads/v12/services/account_link_service.proto similarity index 70% rename from google/ads/googleads/v9/services/account_link_service.proto rename to google/ads/googleads/v12/services/account_link_service.proto index 5ffabd9d9..3bda47f9b 100644 --- a/google/ads/googleads/v9/services/account_link_service.proto +++ b/google/ads/googleads/v12/services/account_link_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/account_link.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AccountLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // This service allows management of links between Google Ads accounts and other // accounts. @@ -39,22 +39,6 @@ service AccountLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the account link in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAccountLink(GetAccountLinkRequest) returns (google.ads.googleads.v9.resources.AccountLink) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/accountLinks/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates an account link. // // List of thrown errors: @@ -70,7 +54,7 @@ service AccountLinkService { // [ThirdPartyAppAnalyticsLinkError]() rpc CreateAccountLink(CreateAccountLinkRequest) returns (CreateAccountLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/accountLinks:create" + post: "/v12/customers/{customer_id=*}/accountLinks:create" body: "*" }; option (google.api.method_signature) = "customer_id,account_link"; @@ -78,7 +62,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: @@ -93,42 +77,33 @@ service AccountLinkService { // [RequestError]() rpc MutateAccountLink(MutateAccountLinkRequest) returns (MutateAccountLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/accountLinks:mutate" + post: "/v12/customers/{customer_id=*}/accountLinks:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for [AccountLinkService.GetAccountLink][google.ads.googleads.v9.services.AccountLinkService.GetAccountLink]. -message GetAccountLinkRequest { - // Required. Resource name of the account link. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AccountLink" - } - ]; -} - // Request message for -// [AccountLinkService.CreateAccountLink][google.ads.googleads.v9.services.AccountLinkService.CreateAccountLink]. +// [AccountLinkService.CreateAccountLink][google.ads.googleads.v12.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.v9.resources.AccountLink account_link = 2 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.resources.AccountLink account_link = 2 [(google.api.field_behavior) = REQUIRED]; } // Response message for -// [AccountLinkService.CreateAccountLink][google.ads.googleads.v9.services.AccountLinkService.CreateAccountLink]. +// [AccountLinkService.CreateAccountLink][google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink]. message CreateAccountLinkResponse { // Returned for successful operations. Resource name of the account link. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AccountLink" + }]; } -// Request message for [AccountLinkService.MutateAccountLink][google.ads.googleads.v9.services.AccountLinkService.MutateAccountLink]. +// Request message for [AccountLinkService.MutateAccountLink][google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink]. message MutateAccountLinkRequest { // Required. The ID of the customer being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -156,13 +131,15 @@ message AccountLinkOperation { oneof operation { // Update operation: The account link is expected to have // a valid resource name. - google.ads.googleads.v9.resources.AccountLink update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AccountLink" + }]; } } @@ -173,13 +150,15 @@ 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; } // The result for the account link mutate. message MutateAccountLinkResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AccountLink" + }]; } diff --git a/google/ads/googleads/v9/services/ad_group_ad_label_service.proto b/google/ads/googleads/v12/services/ad_group_ad_label_service.proto similarity index 66% rename from google/ads/googleads/v9/services/ad_group_ad_label_service.proto rename to google/ads/googleads/v12/services/ad_group_ad_label_service.proto index d19ecd960..7611743ab 100644 --- a/google/ads/googleads/v9/services/ad_group_ad_label_service.proto +++ b/google/ads/googleads/v12/services/ad_group_ad_label_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/ad_group_ad_label.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdLabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Ad Label service. @@ -39,22 +39,6 @@ service AdGroupAdLabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group ad label in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupAdLabel(GetAdGroupAdLabelRequest) returns (google.ads.googleads.v9.resources.AdGroupAdLabel) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupAdLabels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates and removes ad group ad labels. // Operation statuses are returned. // @@ -71,25 +55,14 @@ service AdGroupAdLabelService { // [RequestError]() rpc MutateAdGroupAdLabels(MutateAdGroupAdLabelsRequest) returns (MutateAdGroupAdLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupAdLabels:mutate" + post: "/v12/customers/{customer_id=*}/adGroupAdLabels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupAdLabelService.GetAdGroupAdLabel][google.ads.googleads.v9.services.AdGroupAdLabelService.GetAdGroupAdLabel]. -message GetAdGroupAdLabelRequest { - // Required. The resource name of the ad group ad label to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupAdLabel" - } - ]; -} - -// Request message for [AdGroupAdLabelService.MutateAdGroupAdLabels][google.ads.googleads.v9.services.AdGroupAdLabelService.MutateAdGroupAdLabels]. +// Request message for [AdGroupAdLabelService.MutateAdGroupAdLabels][google.ads.googleads.v12.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]; @@ -114,14 +87,15 @@ message AdGroupAdLabelOperation { oneof operation { // Create operation: No resource name is expected for the new ad group ad // label. - google.ads.googleads.v9.resources.AdGroupAdLabel create = 1; + google.ads.googleads.v12.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}` - string remove = 2; + // `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}` + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAdLabel" + }]; } } @@ -129,8 +103,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. @@ -140,5 +114,7 @@ message MutateAdGroupAdLabelsResponse { // The result for an ad group ad label mutate. message MutateAdGroupAdLabelResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAdLabel" + }]; } diff --git a/google/ads/googleads/v9/services/ad_group_ad_service.proto b/google/ads/googleads/v12/services/ad_group_ad_service.proto similarity index 70% rename from google/ads/googleads/v9/services/ad_group_ad_service.proto rename to google/ads/googleads/v12/services/ad_group_ad_service.proto index c3b2ff9e0..f2d5acf5b 100644 --- a/google/ads/googleads/v9/services/ad_group_ad_service.proto +++ b/google/ads/googleads/v12/services/ad_group_ad_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. @@ -14,11 +14,11 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_ad.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupAdServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Ad service. @@ -42,22 +42,6 @@ service AdGroupAdService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupAd(GetAdGroupAdRequest) returns (google.ads.googleads.v9.resources.AdGroupAd) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupAds/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ads. Operation statuses are returned. // // List of thrown errors: @@ -106,25 +90,14 @@ service AdGroupAdService { // [UrlFieldError]() rpc MutateAdGroupAds(MutateAdGroupAdsRequest) returns (MutateAdGroupAdsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupAds:mutate" + post: "/v12/customers/{customer_id=*}/adGroupAds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupAdService.GetAdGroupAd][google.ads.googleads.v9.services.AdGroupAdService.GetAdGroupAd]. -message GetAdGroupAdRequest { - // 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/AdGroupAd" - } - ]; -} - -// Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v9.services.AdGroupAdService.MutateAdGroupAds]. +// Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v12.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]; @@ -144,7 +117,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an ad group ad. @@ -153,21 +126,23 @@ message AdGroupAdOperation { google.protobuf.FieldMask update_mask = 4; // Configuration for how policies are validated. - google.ads.googleads.v9.common.PolicyValidationParameter policy_validation_parameter = 5; + google.ads.googleads.v12.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.v9.resources.AdGroupAd create = 1; + google.ads.googleads.v12.resources.AdGroupAd create = 1; // Update operation: The ad is expected to have a valid resource name. - google.ads.googleads.v9.resources.AdGroupAd update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAd" + }]; } } @@ -175,8 +150,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. @@ -186,10 +161,12 @@ message MutateAdGroupAdsResponse { // The result for the ad mutate. message MutateAdGroupAdResult { // The resource name returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupAd ad_group_ad = 2; + google.ads.googleads.v12.resources.AdGroupAd ad_group_ad = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_asset_service.proto b/google/ads/googleads/v12/services/ad_group_asset_service.proto similarity index 67% rename from google/ads/googleads/v9/services/ad_group_asset_service.proto rename to google/ads/googleads/v12/services/ad_group_asset_service.proto index e9978f7f0..a78fc0bf9 100644 --- a/google/ads/googleads/v9/services/ad_group_asset_service.proto +++ b/google/ads/googleads/v12/services/ad_group_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_asset.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupAssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AdGroupAsset service. @@ -41,22 +41,6 @@ service AdGroupAssetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group asset in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupAsset(GetAdGroupAssetRequest) returns (google.ads.googleads.v9.resources.AdGroupAsset) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupAssets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad group assets. Operation statuses are // returned. // @@ -74,25 +58,14 @@ service AdGroupAssetService { // [RequestError]() rpc MutateAdGroupAssets(MutateAdGroupAssetsRequest) returns (MutateAdGroupAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupAssets:mutate" + post: "/v12/customers/{customer_id=*}/adGroupAssets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupAssetService.GetAdGroupAsset][google.ads.googleads.v9.services.AdGroupAssetService.GetAdGroupAsset]. -message GetAdGroupAssetRequest { - // Required. The resource name of the ad group asset to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupAsset" - } - ]; -} - -// Request message for [AdGroupAssetService.MutateAdGroupAssets][google.ads.googleads.v9.services.AdGroupAssetService.MutateAdGroupAssets]. +// Request message for [AdGroupAssetService.MutateAdGroupAssets][google.ads.googleads.v12.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]; @@ -112,7 +85,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an ad group asset. @@ -124,17 +97,19 @@ message AdGroupAssetOperation { oneof operation { // Create operation: No resource name is expected for the new ad group // asset. - google.ads.googleads.v9.resources.AdGroupAsset create = 1; + google.ads.googleads.v12.resources.AdGroupAsset create = 1; // Update operation: The ad group asset is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AdGroupAsset update = 3; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupAsset" + }]; } } @@ -142,8 +117,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. @@ -153,10 +128,12 @@ message MutateAdGroupAssetsResponse { // The result for the ad group asset mutate. message MutateAdGroupAssetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupAsset ad_group_asset = 2; + google.ads.googleads.v12.resources.AdGroupAsset ad_group_asset = 2; } diff --git a/google/ads/googleads/v12/services/ad_group_asset_set_service.proto b/google/ads/googleads/v12/services/ad_group_asset_set_service.proto new file mode 100644 index 000000000..988447a58 --- /dev/null +++ b/google/ads/googleads/v12/services/ad_group_asset_set_service.proto @@ -0,0 +1,117 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupAssetSetServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::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: "/v12/customers/{customer_id=*}/adGroupAssetSets:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for [AdGroupAssetSetService.MutateAdGroupAssetSets][google.ads.googleads.v12.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.v12.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.v12.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.v12.resources.AdGroupAssetSet ad_group_asset_set = 2; +} diff --git a/google/ads/googleads/v9/services/ad_group_bid_modifier_service.proto b/google/ads/googleads/v12/services/ad_group_bid_modifier_service.proto similarity index 68% rename from google/ads/googleads/v9/services/ad_group_bid_modifier_service.proto rename to google/ads/googleads/v12/services/ad_group_bid_modifier_service.proto index ff9f91588..0d1f74e14 100644 --- a/google/ads/googleads/v9/services/ad_group_bid_modifier_service.proto +++ b/google/ads/googleads/v12/services/ad_group_bid_modifier_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_bid_modifier.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupBidModifierServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Bid Modifier service. @@ -41,22 +41,6 @@ service AdGroupBidModifierService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group bid modifier in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupBidModifier(GetAdGroupBidModifierRequest) returns (google.ads.googleads.v9.resources.AdGroupBidModifier) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupBidModifiers/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad group bid modifiers. // Operation statuses are returned. // @@ -86,25 +70,14 @@ service AdGroupBidModifierService { // [StringLengthError]() rpc MutateAdGroupBidModifiers(MutateAdGroupBidModifiersRequest) returns (MutateAdGroupBidModifiersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupBidModifiers:mutate" + post: "/v12/customers/{customer_id=*}/adGroupBidModifiers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupBidModifierService.GetAdGroupBidModifier][google.ads.googleads.v9.services.AdGroupBidModifierService.GetAdGroupBidModifier]. -message GetAdGroupBidModifierRequest { - // Required. The resource name of the ad group bid modifier to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupBidModifier" - } - ]; -} - -// Request message for [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v9.services.AdGroupBidModifierService.MutateAdGroupBidModifiers]. +// Request message for [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers]. message MutateAdGroupBidModifiersRequest { // Required. ID of the customer whose ad group bid modifiers are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -124,7 +97,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on an ad group bid modifier. @@ -136,17 +109,19 @@ message AdGroupBidModifierOperation { oneof operation { // Create operation: No resource name is expected for the new ad group bid // modifier. - google.ads.googleads.v9.resources.AdGroupBidModifier create = 1; + google.ads.googleads.v12.resources.AdGroupBidModifier create = 1; // Update operation: The ad group bid modifier is expected to have a valid // resource name. - google.ads.googleads.v9.resources.AdGroupBidModifier update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupBidModifier" + }]; } } @@ -154,8 +129,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. @@ -165,10 +140,12 @@ message MutateAdGroupBidModifiersResponse { // The result for the criterion mutate. message MutateAdGroupBidModifierResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupBidModifier ad_group_bid_modifier = 2; + google.ads.googleads.v12.resources.AdGroupBidModifier ad_group_bid_modifier = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_criterion_customizer_service.proto b/google/ads/googleads/v12/services/ad_group_criterion_customizer_service.proto similarity index 72% rename from google/ads/googleads/v9/services/ad_group_criterion_customizer_service.proto rename to google/ads/googleads/v12/services/ad_group_criterion_customizer_service.proto index d77aff7e6..e05327346 100644 --- a/google/ads/googleads/v9/services/ad_group_criterion_customizer_service.proto +++ b/google/ads/googleads/v12/services/ad_group_criterion_customizer_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion_customizer.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionCustomizerServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AdGroupCriterionCustomizer service. @@ -43,7 +44,7 @@ service AdGroupCriterionCustomizerService { // statuses are returned. rpc MutateAdGroupCriterionCustomizers(MutateAdGroupCriterionCustomizersRequest) returns (MutateAdGroupCriterionCustomizersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate" + post: "/v12/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service AdGroupCriterionCustomizerService { } // Request message for -// [AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers][google.ads.googleads.v9.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers]. +// [AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers][google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers]. message MutateAdGroupCriterionCustomizersRequest { // Required. The ID of the customer whose ad group criterion customizers are being // modified. @@ -73,7 +74,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an customizer attribute. @@ -82,13 +83,15 @@ message AdGroupCriterionCustomizerOperation { oneof operation { // Create operation: No resource name is expected for the new ad group // criterion customizer. - google.ads.googleads.v9.resources.AdGroupCriterionCustomizer create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupCriterionCustomizer" + }]; } } @@ -99,18 +102,20 @@ 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; } // The result for the ad group criterion customizer mutate. message MutateAdGroupCriterionCustomizerResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 2; + google.ads.googleads.v12.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_criterion_label_service.proto b/google/ads/googleads/v12/services/ad_group_criterion_label_service.proto similarity index 66% rename from google/ads/googleads/v9/services/ad_group_criterion_label_service.proto rename to google/ads/googleads/v12/services/ad_group_criterion_label_service.proto index 8bd2c85e2..c3285ad9c 100644 --- a/google/ads/googleads/v9/services/ad_group_criterion_label_service.proto +++ b/google/ads/googleads/v12/services/ad_group_criterion_label_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/ad_group_criterion_label.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionLabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Criterion Label service. @@ -39,22 +39,6 @@ service AdGroupCriterionLabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group criterion label in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupCriterionLabel(GetAdGroupCriterionLabelRequest) returns (google.ads.googleads.v9.resources.AdGroupCriterionLabel) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupCriterionLabels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates and removes ad group criterion labels. // Operation statuses are returned. // @@ -69,7 +53,7 @@ service AdGroupCriterionLabelService { // [RequestError]() rpc MutateAdGroupCriterionLabels(MutateAdGroupCriterionLabelsRequest) returns (MutateAdGroupCriterionLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupCriterionLabels:mutate" + post: "/v12/customers/{customer_id=*}/adGroupCriterionLabels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -77,19 +61,7 @@ service AdGroupCriterionLabelService { } // Request message for -// [AdGroupCriterionLabelService.GetAdGroupCriterionLabel][google.ads.googleads.v9.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel]. -message GetAdGroupCriterionLabelRequest { - // Required. The resource name of the ad group criterion label to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupCriterionLabel" - } - ]; -} - -// Request message for -// [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v9.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels]. +// [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels]. message MutateAdGroupCriterionLabelsRequest { // Required. ID of the customer whose ad group criterion labels are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -114,13 +86,15 @@ message AdGroupCriterionLabelOperation { oneof operation { // Create operation: No resource name is expected for the new ad group // label. - google.ads.googleads.v9.resources.AdGroupCriterionLabel create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupCriterionLabel" + }]; } } @@ -128,8 +102,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. @@ -139,5 +113,7 @@ message MutateAdGroupCriterionLabelsResponse { // The result for an ad group criterion label mutate. message MutateAdGroupCriterionLabelResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupCriterionLabel" + }]; } diff --git a/google/ads/googleads/v9/services/ad_group_criterion_service.proto b/google/ads/googleads/v12/services/ad_group_criterion_service.proto similarity index 69% rename from google/ads/googleads/v9/services/ad_group_criterion_service.proto rename to google/ads/googleads/v12/services/ad_group_criterion_service.proto index cf063a2bc..11907eac9 100644 --- a/google/ads/googleads/v9/services/ad_group_criterion_service.proto +++ b/google/ads/googleads/v12/services/ad_group_criterion_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. @@ -14,11 +14,11 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupCriterionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Criterion service. @@ -42,22 +42,6 @@ service AdGroupCriterionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested criterion in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupCriterion(GetAdGroupCriterionRequest) returns (google.ads.googleads.v9.resources.AdGroupCriterion) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupCriteria/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes criteria. Operation statuses are returned. // // List of thrown errors: @@ -96,25 +80,14 @@ service AdGroupCriterionService { // [UrlFieldError]() rpc MutateAdGroupCriteria(MutateAdGroupCriteriaRequest) returns (MutateAdGroupCriteriaResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupCriteria:mutate" + post: "/v12/customers/{customer_id=*}/adGroupCriteria:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupCriterionService.GetAdGroupCriterion][google.ads.googleads.v9.services.AdGroupCriterionService.GetAdGroupCriterion]. -message GetAdGroupCriterionRequest { - // Required. The resource name of the criterion to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupCriterion" - } - ]; -} - -// Request message for [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v9.services.AdGroupCriterionService.MutateAdGroupCriteria]. +// Request message for [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria]. message MutateAdGroupCriteriaRequest { // Required. ID of the customer whose criteria are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -134,7 +107,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on an ad group criterion. @@ -144,29 +117,31 @@ 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.v9.common.PolicyViolationKey exempt_policy_violation_keys = 5; + repeated google.ads.googleads.v12.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.v9.resources.AdGroupCriterion create = 1; + google.ads.googleads.v12.resources.AdGroupCriterion create = 1; // Update operation: The criterion is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AdGroupCriterion update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupCriterion" + }]; } } @@ -174,8 +149,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. @@ -185,10 +160,12 @@ message MutateAdGroupCriteriaResponse { // The result for the criterion mutate. message MutateAdGroupCriterionResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupCriterion ad_group_criterion = 2; + google.ads.googleads.v12.resources.AdGroupCriterion ad_group_criterion = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_customizer_service.proto b/google/ads/googleads/v12/services/ad_group_customizer_service.proto similarity index 72% rename from google/ads/googleads/v9/services/ad_group_customizer_service.proto rename to google/ads/googleads/v12/services/ad_group_customizer_service.proto index 244910aff..4098daca2 100644 --- a/google/ads/googleads/v9/services/ad_group_customizer_service.proto +++ b/google/ads/googleads/v12/services/ad_group_customizer_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_customizer.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupCustomizerServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AdGroupCustomizer service. @@ -43,7 +44,7 @@ service AdGroupCustomizerService { // returned. rpc MutateAdGroupCustomizers(MutateAdGroupCustomizersRequest) returns (MutateAdGroupCustomizersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupCustomizers:mutate" + post: "/v12/customers/{customer_id=*}/adGroupCustomizers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service AdGroupCustomizerService { } // Request message for -// [AdGroupCustomizerService.MutateAdGroupCustomizers][google.ads.googleads.v9.services.AdGroupCustomizerService.MutateAdGroupCustomizers]. +// [AdGroupCustomizerService.MutateAdGroupCustomizers][google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers]. message MutateAdGroupCustomizersRequest { // Required. The ID of the customer whose ad group customizers are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -71,7 +72,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an customizer attribute. @@ -80,12 +81,14 @@ message AdGroupCustomizerOperation { oneof operation { // Create operation: No resource name is expected for the new ad group // customizer - google.ads.googleads.v9.resources.AdGroupCustomizer create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupCustomizer" + }]; } } @@ -96,18 +99,20 @@ 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; } // The result for the ad group customizer mutate. message MutateAdGroupCustomizerResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupCustomizer ad_group_customizer = 2; + google.ads.googleads.v12.resources.AdGroupCustomizer ad_group_customizer = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_extension_setting_service.proto b/google/ads/googleads/v12/services/ad_group_extension_setting_service.proto similarity index 68% rename from google/ads/googleads/v9/services/ad_group_extension_setting_service.proto rename to google/ads/googleads/v12/services/ad_group_extension_setting_service.proto index 1c9e25ea1..0b6a1afc5 100644 --- a/google/ads/googleads/v9/services/ad_group_extension_setting_service.proto +++ b/google/ads/googleads/v12/services/ad_group_extension_setting_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_extension_setting.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupExtensionSettingServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AdGroupExtensionSetting service. @@ -41,22 +41,6 @@ service AdGroupExtensionSettingService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group extension setting in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupExtensionSetting(GetAdGroupExtensionSettingRequest) returns (google.ads.googleads.v9.resources.AdGroupExtensionSetting) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupExtensionSettings/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad group extension settings. Operation // statuses are returned. // @@ -91,7 +75,7 @@ service AdGroupExtensionSettingService { // [UrlFieldError]() rpc MutateAdGroupExtensionSettings(MutateAdGroupExtensionSettingsRequest) returns (MutateAdGroupExtensionSettingsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupExtensionSettings:mutate" + post: "/v12/customers/{customer_id=*}/adGroupExtensionSettings:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -99,19 +83,7 @@ service AdGroupExtensionSettingService { } // Request message for -// [AdGroupExtensionSettingService.GetAdGroupExtensionSetting][google.ads.googleads.v9.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting]. -message GetAdGroupExtensionSettingRequest { - // Required. The resource name of the ad group extension setting to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupExtensionSetting" - } - ]; -} - -// Request message for -// [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v9.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings]. +// [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings]. message MutateAdGroupExtensionSettingsRequest { // Required. The ID of the customer whose ad group extension settings are being // modified. @@ -139,23 +111,25 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.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.v9.resources.AdGroupExtensionSetting create = 1; + google.ads.googleads.v12.resources.AdGroupExtensionSetting create = 1; // Update operation: The ad group extension setting is expected to have a // valid resource name. - google.ads.googleads.v9.resources.AdGroupExtensionSetting update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupExtensionSetting" + }]; } } @@ -163,8 +137,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. @@ -174,10 +148,12 @@ message MutateAdGroupExtensionSettingsResponse { // The result for the ad group extension setting mutate. message MutateAdGroupExtensionSettingResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupExtensionSetting ad_group_extension_setting = 2; + google.ads.googleads.v12.resources.AdGroupExtensionSetting ad_group_extension_setting = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_feed_service.proto b/google/ads/googleads/v12/services/ad_group_feed_service.proto similarity index 68% rename from google/ads/googleads/v9/services/ad_group_feed_service.proto rename to google/ads/googleads/v12/services/ad_group_feed_service.proto index 043182212..71c3e27ac 100644 --- a/google/ads/googleads/v9/services/ad_group_feed_service.proto +++ b/google/ads/googleads/v12/services/ad_group_feed_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group_feed.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupFeedServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AdGroupFeed service. @@ -41,22 +41,6 @@ service AdGroupFeedService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group feed in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupFeed(GetAdGroupFeedRequest) returns (google.ads.googleads.v9.resources.AdGroupFeed) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupFeeds/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad group feeds. Operation statuses are // returned. // @@ -85,25 +69,14 @@ service AdGroupFeedService { // [StringLengthError]() rpc MutateAdGroupFeeds(MutateAdGroupFeedsRequest) returns (MutateAdGroupFeedsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupFeeds:mutate" + post: "/v12/customers/{customer_id=*}/adGroupFeeds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupFeedService.GetAdGroupFeed][google.ads.googleads.v9.services.AdGroupFeedService.GetAdGroupFeed]. -message GetAdGroupFeedRequest { - // Required. The resource name of the ad group feed to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupFeed" - } - ]; -} - -// Request message for [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v9.services.AdGroupFeedService.MutateAdGroupFeeds]. +// Request message for [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v12.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]; @@ -123,7 +96,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an ad group feed. @@ -134,17 +107,19 @@ message AdGroupFeedOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new ad group feed. - google.ads.googleads.v9.resources.AdGroupFeed create = 1; + google.ads.googleads.v12.resources.AdGroupFeed create = 1; // Update operation: The ad group feed is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AdGroupFeed update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupFeed" + }]; } } @@ -152,8 +127,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. @@ -163,10 +138,12 @@ message MutateAdGroupFeedsResponse { // The result for the ad group feed mutate. message MutateAdGroupFeedResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroupFeed ad_group_feed = 2; + google.ads.googleads.v12.resources.AdGroupFeed ad_group_feed = 2; } diff --git a/google/ads/googleads/v9/services/ad_group_label_service.proto b/google/ads/googleads/v12/services/ad_group_label_service.proto similarity index 67% rename from google/ads/googleads/v9/services/ad_group_label_service.proto rename to google/ads/googleads/v12/services/ad_group_label_service.proto index 6ad8aec68..f3ce0f890 100644 --- a/google/ads/googleads/v9/services/ad_group_label_service.proto +++ b/google/ads/googleads/v12/services/ad_group_label_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/ad_group_label.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupLabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group Label service. @@ -39,22 +39,6 @@ service AdGroupLabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group label in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupLabel(GetAdGroupLabelRequest) returns (google.ads.googleads.v9.resources.AdGroupLabel) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupLabels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates and removes ad group labels. // Operation statuses are returned. // @@ -72,25 +56,14 @@ service AdGroupLabelService { // [RequestError]() rpc MutateAdGroupLabels(MutateAdGroupLabelsRequest) returns (MutateAdGroupLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroupLabels:mutate" + post: "/v12/customers/{customer_id=*}/adGroupLabels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupLabelService.GetAdGroupLabel][google.ads.googleads.v9.services.AdGroupLabelService.GetAdGroupLabel]. -message GetAdGroupLabelRequest { - // Required. The resource name of the ad group label to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupLabel" - } - ]; -} - -// Request message for [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v9.services.AdGroupLabelService.MutateAdGroupLabels]. +// Request message for [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v12.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]; @@ -115,13 +88,15 @@ message AdGroupLabelOperation { oneof operation { // Create operation: No resource name is expected for the new ad group // label. - google.ads.googleads.v9.resources.AdGroupLabel create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupLabel" + }]; } } @@ -129,8 +104,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. @@ -140,5 +115,7 @@ message MutateAdGroupLabelsResponse { // The result for an ad group label mutate. message MutateAdGroupLabelResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroupLabel" + }]; } diff --git a/google/ads/googleads/v9/services/ad_group_service.proto b/google/ads/googleads/v12/services/ad_group_service.proto similarity index 70% rename from google/ads/googleads/v9/services/ad_group_service.proto rename to google/ads/googleads/v12/services/ad_group_service.proto index 132d29265..7bafa7ead 100644 --- a/google/ads/googleads/v9/services/ad_group_service.proto +++ b/google/ads/googleads/v12/services/ad_group_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_group.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdGroupServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Group service. @@ -41,22 +41,6 @@ service AdGroupService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad group in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroup(GetAdGroupRequest) returns (google.ads.googleads.v9.resources.AdGroup) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroups/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad groups. Operation statuses are returned. // // List of thrown errors: @@ -93,25 +77,14 @@ service AdGroupService { // [UrlFieldError]() rpc MutateAdGroups(MutateAdGroupsRequest) returns (MutateAdGroupsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adGroups:mutate" + post: "/v12/customers/{customer_id=*}/adGroups:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdGroupService.GetAdGroup][google.ads.googleads.v9.services.AdGroupService.GetAdGroup]. -message GetAdGroupRequest { - // Required. The resource name of the ad group to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroup" - } - ]; -} - -// Request message for [AdGroupService.MutateAdGroups][google.ads.googleads.v9.services.AdGroupService.MutateAdGroups]. +// Request message for [AdGroupService.MutateAdGroups][google.ads.googleads.v12.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]; @@ -131,7 +104,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an ad group. @@ -142,16 +115,18 @@ message AdGroupOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new ad group. - google.ads.googleads.v9.resources.AdGroup create = 1; + google.ads.googleads.v12.resources.AdGroup create = 1; // Update operation: The ad group is expected to have a valid resource name. - google.ads.googleads.v9.resources.AdGroup update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdGroup" + }]; } } @@ -159,8 +134,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. @@ -170,9 +145,11 @@ message MutateAdGroupsResponse { // The result for the ad group mutate. message MutateAdGroupResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdGroup ad_group = 2; + google.ads.googleads.v12.resources.AdGroup ad_group = 2; } diff --git a/google/ads/googleads/v9/services/ad_parameter_service.proto b/google/ads/googleads/v12/services/ad_parameter_service.proto similarity index 67% rename from google/ads/googleads/v9/services/ad_parameter_service.proto rename to google/ads/googleads/v12/services/ad_parameter_service.proto index 841622556..b6932ba24 100644 --- a/google/ads/googleads/v9/services/ad_parameter_service.proto +++ b/google/ads/googleads/v12/services/ad_parameter_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad_parameter.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdParameterServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad Parameter service. @@ -41,22 +41,6 @@ service AdParameterService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested ad parameter in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdParameter(GetAdParameterRequest) returns (google.ads.googleads.v9.resources.AdParameter) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adParameters/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes ad parameters. Operation statuses are // returned. // @@ -75,25 +59,14 @@ service AdParameterService { // [RequestError]() rpc MutateAdParameters(MutateAdParametersRequest) returns (MutateAdParametersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/adParameters:mutate" + post: "/v12/customers/{customer_id=*}/adParameters:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdParameterService.GetAdParameter][google.ads.googleads.v9.services.AdParameterService.GetAdParameter] -message GetAdParameterRequest { - // Required. The resource name of the ad parameter to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdParameter" - } - ]; -} - -// Request message for [AdParameterService.MutateAdParameters][google.ads.googleads.v9.services.AdParameterService.MutateAdParameters] +// Request message for [AdParameterService.MutateAdParameters][google.ads.googleads.v12.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]; @@ -113,7 +86,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on ad parameter. @@ -124,17 +97,19 @@ message AdParameterOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new ad parameter. - google.ads.googleads.v9.resources.AdParameter create = 1; + google.ads.googleads.v12.resources.AdParameter create = 1; // Update operation: The ad parameter is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AdParameter update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AdParameter" + }]; } } @@ -142,8 +117,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. @@ -153,10 +128,12 @@ message MutateAdParametersResponse { // The result for the ad parameter mutate. message MutateAdParameterResult { // The resource name returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AdParameter ad_parameter = 2; + google.ads.googleads.v12.resources.AdParameter ad_parameter = 2; } diff --git a/google/ads/googleads/v9/services/ad_service.proto b/google/ads/googleads/v12/services/ad_service.proto similarity index 78% rename from google/ads/googleads/v9/services/ad_service.proto rename to google/ads/googleads/v12/services/ad_service.proto index eea1077bc..1c1809f1a 100644 --- a/google/ads/googleads/v9/services/ad_service.proto +++ b/google/ads/googleads/v12/services/ad_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. @@ -14,11 +14,11 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/ad.proto"; +import "google/ads/googleads/v12/common/policy.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AdServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Ad service. @@ -51,9 +51,9 @@ service AdService { // [InternalError]() // [QuotaError]() // [RequestError]() - rpc GetAd(GetAdRequest) returns (google.ads.googleads.v9.resources.Ad) { + rpc GetAd(GetAdRequest) returns (google.ads.googleads.v12.resources.Ad) { option (google.api.http) = { - get: "/v9/{resource_name=customers/*/ads/*}" + get: "/v12/{resource_name=customers/*/ads/*}" }; option (google.api.method_signature) = "resource_name"; } @@ -102,14 +102,14 @@ service AdService { // [UrlFieldError]() rpc MutateAds(MutateAdsRequest) returns (MutateAdsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/ads:mutate" + post: "/v12/customers/{customer_id=*}/ads:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AdService.GetAd][google.ads.googleads.v9.services.AdService.GetAd]. +// Request message for [AdService.GetAd][google.ads.googleads.v12.services.AdService.GetAd]. message GetAdRequest { // Required. The resource name of the ad to fetch. string resource_name = 1 [ @@ -120,7 +120,7 @@ message GetAdRequest { ]; } -// Request message for [AdService.MutateAds][google.ads.googleads.v9.services.AdService.MutateAds]. +// Request message for [AdService.MutateAds][google.ads.googleads.v12.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,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; // If true, the request is validated but not executed. Only errors are // returned, not results. @@ -149,7 +149,7 @@ message AdOperation { google.protobuf.FieldMask update_mask = 2; // Configuration for how policies are validated. - google.ads.googleads.v9.common.PolicyValidationParameter policy_validation_parameter = 3; + google.ads.googleads.v12.common.PolicyValidationParameter policy_validation_parameter = 3; // The mutate operation. oneof operation { @@ -157,7 +157,7 @@ message AdOperation { // in this format: // // `customers/{customer_id}/ads/{ad_id}` - google.ads.googleads.v9.resources.Ad update = 1; + google.ads.googleads.v12.resources.Ad update = 1; } } @@ -165,8 +165,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,9 +176,11 @@ message MutateAdsResponse { // The result for the ad mutate. message MutateAdResult { // The resource name returned for successful operations. - string resource_name = 1; + 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.v9.resources.Ad ad = 2; + google.ads.googleads.v12.resources.Ad ad = 2; } diff --git a/google/ads/googleads/v9/services/asset_group_asset_service.proto b/google/ads/googleads/v12/services/asset_group_asset_service.proto similarity index 66% rename from google/ads/googleads/v9/services/asset_group_asset_service.proto rename to google/ads/googleads/v12/services/asset_group_asset_service.proto index 21c2319e3..b6aea52ef 100644 --- a/google/ads/googleads/v9/services/asset_group_asset_service.proto +++ b/google/ads/googleads/v12/services/asset_group_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/asset_group_asset.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetGroupAssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AssetGroupAsset service. @@ -40,37 +40,18 @@ service AssetGroupAssetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested asset group asset in full detail. - rpc GetAssetGroupAsset(GetAssetGroupAssetRequest) returns (google.ads.googleads.v9.resources.AssetGroupAsset) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/assetGroupAssets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates or removes asset group assets. Operation statuses are // returned. rpc MutateAssetGroupAssets(MutateAssetGroupAssetsRequest) returns (MutateAssetGroupAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assetGroupAssets:mutate" + post: "/v12/customers/{customer_id=*}/assetGroupAssets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AssetGroupAssetService.GetAssetGroupAsset][google.ads.googleads.v9.services.AssetGroupAssetService.GetAssetGroupAsset]. -message GetAssetGroupAssetRequest { - // Required. The resource name of the asset group asset to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AssetGroupAsset" - } - ]; -} - -// Request message for [AssetGroupAssetService.MutateAssetGroupAssets][google.ads.googleads.v9.services.AssetGroupAssetService.MutateAssetGroupAssets]. +// Request message for [AssetGroupAssetService.MutateAssetGroupAssets][google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets]. message MutateAssetGroupAssetsRequest { // Required. The ID of the customer whose asset group assets are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -97,17 +78,19 @@ message AssetGroupAssetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new asset group - // asset - google.ads.googleads.v9.resources.AssetGroupAsset create = 1; + // asset. + google.ads.googleads.v12.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.v9.resources.AssetGroupAsset update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroupAsset" + }]; } } @@ -118,13 +101,15 @@ 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; } // The result for the asset group asset mutate. message MutateAssetGroupAssetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroupAsset" + }]; } diff --git a/google/ads/googleads/v9/services/asset_group_listing_group_filter_service.proto b/google/ads/googleads/v12/services/asset_group_listing_group_filter_service.proto similarity index 73% rename from google/ads/googleads/v9/services/asset_group_listing_group_filter_service.proto rename to google/ads/googleads/v12/services/asset_group_listing_group_filter_service.proto index 2af559696..aa111106f 100644 --- a/google/ads/googleads/v9/services/asset_group_listing_group_filter_service.proto +++ b/google/ads/googleads/v12/services/asset_group_listing_group_filter_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/asset_group_listing_group_filter.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetGroupListingGroupFilterServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AssetGroupListingGroupFilter service. @@ -43,7 +44,7 @@ service AssetGroupListingGroupFilterService { // statuses are returned. rpc MutateAssetGroupListingGroupFilters(MutateAssetGroupListingGroupFiltersRequest) returns (MutateAssetGroupListingGroupFiltersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate" + post: "/v12/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service AssetGroupListingGroupFilterService { } // Request message for -// [AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters][google.ads.googleads.v9.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters]. +// [AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters][google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters]. // partial_failure is not supported because the tree needs to be validated // together. message MutateAssetGroupListingGroupFiltersRequest { @@ -69,7 +70,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } // A single operation (create, remove) on an asset group listing group filter. @@ -81,11 +82,11 @@ message AssetGroupListingGroupFilterOperation { oneof operation { // Create operation: No resource name is expected for the new asset group // listing group filter. - google.ads.googleads.v9.resources.AssetGroupListingGroupFilter create = 1; + google.ads.googleads.v12.resources.AssetGroupListingGroupFilter create = 1; // Update operation: The asset group listing group filter is expected to // have a valid resource name. - google.ads.googleads.v9.resources.AssetGroupListingGroupFilter update = 2; + google.ads.googleads.v12.resources.AssetGroupListingGroupFilter update = 2; // Remove operation: A resource name for the removed asset group listing // group filter is expected, in this format: @@ -93,7 +94,9 @@ message AssetGroupListingGroupFilterOperation { // An entity can be removed only if it's not referenced by other // parent_listing_group_id. If multiple entities are being deleted, the // mutates must be in the correct order. - string remove = 3; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroupListingGroupFilter" + }]; } } @@ -106,10 +109,12 @@ message MutateAssetGroupListingGroupFiltersResponse { // The result for the asset group listing group filter mutate. message MutateAssetGroupListingGroupFilterResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 2; + google.ads.googleads.v12.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 2; } diff --git a/google/ads/googleads/v9/services/asset_group_service.proto b/google/ads/googleads/v12/services/asset_group_service.proto similarity index 67% rename from google/ads/googleads/v9/services/asset_group_service.proto rename to google/ads/googleads/v12/services/asset_group_service.proto index 3b98f6d24..f331010f6 100644 --- a/google/ads/googleads/v9/services/asset_group_service.proto +++ b/google/ads/googleads/v12/services/asset_group_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/asset_group.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetGroupServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AssetGroup service. @@ -40,37 +40,18 @@ service AssetGroupService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested asset group in full detail. - rpc GetAssetGroup(GetAssetGroupRequest) returns (google.ads.googleads.v9.resources.AssetGroup) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/assetGroups/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates or removes asset groups. Operation statuses are // returned. rpc MutateAssetGroups(MutateAssetGroupsRequest) returns (MutateAssetGroupsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assetGroups:mutate" + post: "/v12/customers/{customer_id=*}/assetGroups:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AssetGroupService.GetAssetGroup][google.ads.googleads.v9.services.AssetGroupService.GetAssetGroup]. -message GetAssetGroupRequest { - // Required. The resource name of the asset group to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AssetGroup" - } - ]; -} - -// Request message for [AssetGroupService.MutateAssetGroups][google.ads.googleads.v9.services.AssetGroupService.MutateAssetGroups]. +// Request message for [AssetGroupService.MutateAssetGroups][google.ads.googleads.v12.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]; @@ -91,16 +72,18 @@ message AssetGroupOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new asset group - google.ads.googleads.v9.resources.AssetGroup create = 1; + google.ads.googleads.v12.resources.AssetGroup create = 1; // Update operation: The asset group is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AssetGroup update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroup" + }]; } } @@ -111,13 +94,15 @@ 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; } // The result for the asset group mutate. message MutateAssetGroupResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetGroup" + }]; } diff --git a/google/ads/googleads/v12/services/asset_group_signal_service.proto b/google/ads/googleads/v12/services/asset_group_signal_service.proto new file mode 100644 index 000000000..33d302a6e --- /dev/null +++ b/google/ads/googleads/v12/services/asset_group_signal_service.proto @@ -0,0 +1,117 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "AssetGroupSignalServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the AssetGroupSignal service. + +// Service to manage asset group signal. +service AssetGroupSignalService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Creates or removes asset group signals. Operation statuses are + // returned. + rpc MutateAssetGroupSignals(MutateAssetGroupSignalsRequest) returns (MutateAssetGroupSignalsResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}/assetGroupSignals:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for +// [AssetGroupSignalService.MutateAssetGroupSignals][google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals]. +message MutateAssetGroupSignalsRequest { + // 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]; + + // 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.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; +} + +// A single operation (create, remove) on an asset group signal. +message AssetGroupSignalOperation { + // The mutate operation. Update is not supported. + oneof operation { + // Create operation: No resource name is expected for the new asset group + // signal. + google.ads.googleads.v12.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" + }]; + } +} + +// Response message for an asset group signal mutate. +message MutateAssetGroupSignalsResponse { + // All results for the mutate. + repeated MutateAssetGroupSignalResult 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 (for example, auth + // errors), we return an RPC level error. + google.rpc.Status partial_failure_error = 2; +} + +// The result for the asset group signal mutate. +message MutateAssetGroupSignalResult { + // Returned for successful operations. + string resource_name = 1 [(google.api.resource_reference) = { + 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.v12.resources.AssetGroupSignal asset_group_signal = 2; +} diff --git a/google/ads/googleads/v9/services/asset_service.proto b/google/ads/googleads/v12/services/asset_service.proto similarity index 71% rename from google/ads/googleads/v9/services/asset_service.proto rename to google/ads/googleads/v12/services/asset_service.proto index 9a841de2f..46267015f 100644 --- a/google/ads/googleads/v9/services/asset_service.proto +++ b/google/ads/googleads/v12/services/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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/asset.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Asset service. @@ -43,22 +43,6 @@ service AssetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested asset in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAsset(GetAssetRequest) returns (google.ads.googleads.v9.resources.Asset) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/assets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates assets. Operation statuses are returned. // // List of thrown errors: @@ -91,25 +75,14 @@ service AssetService { // [YoutubeVideoRegistrationError]() rpc MutateAssets(MutateAssetsRequest) returns (MutateAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assets:mutate" + post: "/v12/customers/{customer_id=*}/assets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AssetService.GetAsset][google.ads.googleads.v9.services.AssetService.GetAsset] -message GetAssetRequest { - // Required. The resource name of the asset to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Asset" - } - ]; -} - -// Request message for [AssetService.MutateAssets][google.ads.googleads.v9.services.AssetService.MutateAssets] +// Request message for [AssetService.MutateAssets][google.ads.googleads.v12.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]; @@ -125,7 +98,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 3; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 3; // If true, the request is validated but not executed. Only errors are // returned, not results. @@ -142,13 +115,13 @@ message AssetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new asset. - google.ads.googleads.v9.resources.Asset create = 1; + google.ads.googleads.v12.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.v9.resources.Asset update = 2; + google.ads.googleads.v12.resources.Asset update = 2; } } @@ -156,8 +129,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. @@ -167,9 +140,11 @@ message MutateAssetsResponse { // The result for the asset mutate. message MutateAssetResult { // The resource name returned for successful operations. - string resource_name = 1; + 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.v9.resources.Asset asset = 2; + google.ads.googleads.v12.resources.Asset asset = 2; } diff --git a/google/ads/googleads/v9/services/asset_set_asset_service.proto b/google/ads/googleads/v12/services/asset_set_asset_service.proto similarity index 72% rename from google/ads/googleads/v9/services/asset_set_asset_service.proto rename to google/ads/googleads/v12/services/asset_set_asset_service.proto index c89b229aa..4d8b0ca76 100644 --- a/google/ads/googleads/v9/services/asset_set_asset_service.proto +++ b/google/ads/googleads/v12/services/asset_set_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/asset_set_asset.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetSetAssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AssetSetAsset service. @@ -43,14 +44,14 @@ service AssetSetAssetService { // returned. rpc MutateAssetSetAssets(MutateAssetSetAssetsRequest) returns (MutateAssetSetAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assetSetAssets:mutate" + post: "/v12/customers/{customer_id=*}/assetSetAssets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AssetSetAssetService.MutateAssetSetAssets][google.ads.googleads.v9.services.AssetSetAssetService.MutateAssetSetAssets]. +// Request message for [AssetSetAssetService.MutateAssetSetAssets][google.ads.googleads.v12.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]; @@ -70,7 +71,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an asset set asset. @@ -79,12 +80,14 @@ message AssetSetAssetOperation { oneof operation { // Create operation: No resource name is expected for the new asset set // asset - google.ads.googleads.v9.resources.AssetSetAsset create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetSetAsset" + }]; } } @@ -95,18 +98,20 @@ 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; } // The result for the asset set asset mutate. message MutateAssetSetAssetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AssetSetAsset asset_set_asset = 2; + google.ads.googleads.v12.resources.AssetSetAsset asset_set_asset = 2; } diff --git a/google/ads/googleads/v9/services/asset_set_service.proto b/google/ads/googleads/v12/services/asset_set_service.proto similarity index 72% rename from google/ads/googleads/v9/services/asset_set_service.proto rename to google/ads/googleads/v12/services/asset_set_service.proto index 772851f81..2cba7da56 100644 --- a/google/ads/googleads/v9/services/asset_set_service.proto +++ b/google/ads/googleads/v12/services/asset_set_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. @@ -14,24 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/asset_set.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/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/protobuf/field_mask.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "AssetSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the AssetSet service. @@ -44,14 +45,14 @@ service AssetSetService { // returned. rpc MutateAssetSets(MutateAssetSetsRequest) returns (MutateAssetSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/assetSets:mutate" + post: "/v12/customers/{customer_id=*}/assetSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [AssetSetService.MutateAssetSets][google.ads.googleads.v9.services.AssetSetService.MutateAssetSets]. +// Request message for [AssetSetService.MutateAssetSets][google.ads.googleads.v12.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]; @@ -71,7 +72,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an asset set. @@ -82,16 +83,18 @@ message AssetSetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new asset set - google.ads.googleads.v9.resources.AssetSet create = 1; + google.ads.googleads.v12.resources.AssetSet create = 1; // Update operation: The asset set is expected to have a valid resource // name. - google.ads.googleads.v9.resources.AssetSet update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/AssetSet" + }]; } } @@ -102,17 +105,19 @@ 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; } // The result for the asset set mutate. message MutateAssetSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.AssetSet asset_set = 2; + google.ads.googleads.v12.resources.AssetSet asset_set = 2; } diff --git a/google/ads/googleads/v12/services/audience_insights_service.proto b/google/ads/googleads/v12/services/audience_insights_service.proto new file mode 100644 index 000000000..92c562335 --- /dev/null +++ b/google/ads/googleads/v12/services/audience_insights_service.proto @@ -0,0 +1,484 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "AudienceInsightsServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::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. +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: "/v12/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: "/v12/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: "/v12/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: "/v12/customers/{customer_id=*}:generateAudienceCompositionInsights" + body: "*" + }; + option (google.api.method_signature) = "customer_id,audience,dimensions"; + } +} + +// Request message for [AudienceInsightsService.GenerateInsightsFinderReport][google.ads.googleads.v12.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.v12.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.v12.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.v12.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.v12.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.v12.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.v12.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.v12.common.LocationInfo location_country_filters = 5; +} + +// Response message for +// [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v12.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.v12.common.AgeRangeInfo age_range = 1; + + // An audience attribute defined by a gender. + google.ads.googleads.v12.common.GenderInfo gender = 2; + + // An audience attribute defined by a geographic location. + google.ads.googleads.v12.common.LocationInfo location = 3; + + // An Affinity or In-Market audience. + google.ads.googleads.v12.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.v12.common.ParentalStatusInfo parental_status = 8; + + // A household income percentile range. + google.ads.googleads.v12.common.IncomeRangeInfo income_range = 9; + + // A YouTube channel. + google.ads.googleads.v12.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.v12.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.v12.common.LocationInfo sub_country_locations = 2; + + // Gender for the audience. If absent, the audience does not restrict by + // gender. + google.ads.googleads.v12.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.v12.common.AgeRangeInfo age_ranges = 4; + + // User interests defining this audience. Affinity and In-Market audiences + // are supported. + repeated google.ads.googleads.v12.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.v12.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.v12.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.v12.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.v12.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.v12.common.LocationInfo sub_country_locations = 2; + + // Gender for the audience. If absent, the audience does not restrict by + // gender. + google.ads.googleads.v12.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.v12.common.AgeRangeInfo age_ranges = 4; + + // Parental status for the audience. If absent, the audience does not + // restrict by parental status. + google.ads.googleads.v12.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.v12.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.v12.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/google/ads/googleads/v12/services/audience_service.proto b/google/ads/googleads/v12/services/audience_service.proto new file mode 100644 index 000000000..7e0240075 --- /dev/null +++ b/google/ads/googleads/v12/services/audience_service.proto @@ -0,0 +1,118 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/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"; +import "google/rpc/status.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "AudienceServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the Audience service. + +// Service to manage audiences. +service AudienceService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Creates audiences. Operation statuses are returned. + // + // List of thrown errors: + // [AudienceError]() + rpc MutateAudiences(MutateAudiencesRequest) returns (MutateAudiencesResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}/audiences:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for [AudienceService.MutateAudiences][google.ads.googleads.v12.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]; + + // 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.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; +} + +// Response message for an audience mutate. +message MutateAudiencesResponse { + // All results for the mutate. + repeated MutateAudienceResult 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 (for example, auth + // errors), we return an RPC level error. + google.rpc.Status partial_failure_error = 2; +} + +// A single operation (create, update) on an audience. +message AudienceOperation { + // FieldMask that determines which resource fields are modified in an update. + google.protobuf.FieldMask update_mask = 4; + + // The mutate operation. + oneof operation { + // Create operation: No resource name is expected for the new audience + google.ads.googleads.v12.resources.Audience create = 1; + + // Update operation: The audience is expected to have a valid resource + // name. + google.ads.googleads.v12.resources.Audience update = 2; + } +} + +// The result for the audience mutate. +message MutateAudienceResult { + // Returned for successful operations. + string resource_name = 1 [(google.api.resource_reference) = { + 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.v12.resources.Audience audience = 2; +} diff --git a/google/ads/googleads/v9/services/batch_job_service.proto b/google/ads/googleads/v12/services/batch_job_service.proto similarity index 77% rename from google/ads/googleads/v9/services/batch_job_service.proto rename to google/ads/googleads/v12/services/batch_job_service.proto index aa63d7b28..9ad9381d5 100644 --- a/google/ads/googleads/v9/services/batch_job_service.proto +++ b/google/ads/googleads/v12/services/batch_job_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. @@ -14,11 +14,11 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/batch_job.proto"; -import "google/ads/googleads/v9/services/google_ads_service.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/batch_job.proto"; +import "google/ads/googleads/v12/services/google_ads_service.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/longrunning/operations.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "BatchJobServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the BatchJobService. @@ -54,28 +54,12 @@ service BatchJobService { // [ResourceCountLimitExceededError]() rpc MutateBatchJob(MutateBatchJobRequest) returns (MutateBatchJobResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/batchJobs:mutate" + post: "/v12/customers/{customer_id=*}/batchJobs:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } - // Returns the batch job. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetBatchJob(GetBatchJobRequest) returns (google.ads.googleads.v9.resources.BatchJob) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/batchJobs/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Returns the results of the batch job. The job must be done. // Supports standard list paging. // @@ -89,7 +73,7 @@ service BatchJobService { // [RequestError]() rpc ListBatchJobResults(ListBatchJobResultsRequest) returns (ListBatchJobResultsResponse) { option (google.api.http) = { - get: "/v9/{resource_name=customers/*/batchJobs/*}:listResults" + get: "/v12/{resource_name=customers/*/batchJobs/*}:listResults" }; option (google.api.method_signature) = "resource_name"; } @@ -110,13 +94,13 @@ service BatchJobService { // [RequestError]() rpc RunBatchJob(RunBatchJobRequest) returns (google.longrunning.Operation) { option (google.api.http) = { - post: "/v9/{resource_name=customers/*/batchJobs/*}:run" + post: "/v12/{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.v9.resources.BatchJob.BatchJobMetadata" + metadata_type: "google.ads.googleads.v12.resources.BatchJob.BatchJobMetadata" }; } @@ -133,7 +117,7 @@ service BatchJobService { // [ResourceCountLimitExceededError]() rpc AddBatchJobOperations(AddBatchJobOperationsRequest) returns (AddBatchJobOperationsResponse) { option (google.api.http) = { - post: "/v9/{resource_name=customers/*/batchJobs/*}:addOperations" + post: "/v12/{resource_name=customers/*/batchJobs/*}:addOperations" body: "*" }; option (google.api.method_signature) = "resource_name,sequence_token,mutate_operations"; @@ -141,7 +125,7 @@ service BatchJobService { } } -// Request message for [BatchJobService.MutateBatchJob][google.ads.googleads.v9.services.BatchJobService.MutateBatchJob]. +// Request message for [BatchJobService.MutateBatchJob][google.ads.googleads.v12.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]; @@ -155,11 +139,19 @@ message BatchJobOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new batch job. - google.ads.googleads.v9.resources.BatchJob create = 1; + google.ads.googleads.v12.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" + }]; } } -// Response message for [BatchJobService.MutateBatchJob][google.ads.googleads.v9.services.BatchJobService.MutateBatchJob]. +// Response message for [BatchJobService.MutateBatchJob][google.ads.googleads.v12.services.BatchJobService.MutateBatchJob]. message MutateBatchJobResponse { // The result for the mutate. MutateBatchJobResult result = 1; @@ -168,21 +160,12 @@ message MutateBatchJobResponse { // The result for the batch job mutate. message MutateBatchJobResult { // The resource name of the batch job. - string resource_name = 1; -} - -// Request message for [BatchJobService.GetBatchJob][google.ads.googleads.v9.services.BatchJobService.GetBatchJob]. -message GetBatchJobRequest { - // Required. The resource name of the batch job to get. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BatchJob" - } - ]; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BatchJob" + }]; } -// Request message for [BatchJobService.RunBatchJob][google.ads.googleads.v9.services.BatchJobService.RunBatchJob]. +// Request message for [BatchJobService.RunBatchJob][google.ads.googleads.v12.services.BatchJobService.RunBatchJob]. message RunBatchJobRequest { // Required. The resource name of the BatchJob to run. string resource_name = 1 [ @@ -193,7 +176,7 @@ message RunBatchJobRequest { ]; } -// Request message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v9.services.BatchJobService.AddBatchJobOperations]. +// Request message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v12.services.BatchJobService.AddBatchJobOperations]. message AddBatchJobOperationsRequest { // Required. The resource name of the batch job. string resource_name = 1 [ @@ -223,7 +206,7 @@ message AddBatchJobOperationsRequest { repeated MutateOperation mutate_operations = 3 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v9.services.BatchJobService.AddBatchJobOperations]. +// Response message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v12.services.BatchJobService.AddBatchJobOperations]. message AddBatchJobOperationsResponse { // The total number of operations added so far for this batch job. int64 total_operations = 1; @@ -234,7 +217,7 @@ message AddBatchJobOperationsResponse { string next_sequence_token = 2; } -// Request message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v9.services.BatchJobService.ListBatchJobResults]. +// Request message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v12.services.BatchJobService.ListBatchJobResults]. message ListBatchJobResultsRequest { // Required. The resource name of the batch job whose results are being listed. string resource_name = 1 [ @@ -257,10 +240,10 @@ message ListBatchJobResultsRequest { // The response content type setting. Determines whether the mutable resource // or just the resource name should be returned. - google.ads.googleads.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } -// Response message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v9.services.BatchJobService.ListBatchJobResults]. +// Response message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v12.services.BatchJobService.ListBatchJobResults]. message ListBatchJobResultsResponse { // The list of rows that matched the query. repeated BatchJobResult results = 1; diff --git a/google/ads/googleads/v9/services/bidding_data_exclusion_service.proto b/google/ads/googleads/v12/services/bidding_data_exclusion_service.proto similarity index 66% rename from google/ads/googleads/v9/services/bidding_data_exclusion_service.proto rename to google/ads/googleads/v12/services/bidding_data_exclusion_service.proto index 0e1deceae..d50f1eb28 100644 --- a/google/ads/googleads/v9/services/bidding_data_exclusion_service.proto +++ b/google/ads/googleads/v12/services/bidding_data_exclusion_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/bidding_data_exclusion.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/bidding_data_exclusion.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; @@ -25,33 +25,25 @@ import "google/api/resource.proto"; import "google/protobuf/field_mask.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "BiddingDataExclusionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to manage bidding data exclusions. service BiddingDataExclusionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested data exclusion in full detail. - rpc GetBiddingDataExclusion(GetBiddingDataExclusionRequest) returns (google.ads.googleads.v9.resources.BiddingDataExclusion) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/biddingDataExclusions/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes data exclusions. // Operation statuses are returned. rpc MutateBiddingDataExclusions(MutateBiddingDataExclusionsRequest) returns (MutateBiddingDataExclusionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/biddingDataExclusions:mutate" + post: "/v12/customers/{customer_id=*}/biddingDataExclusions:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -59,19 +51,7 @@ service BiddingDataExclusionService { } // Request message for -// [BiddingDataExclusionService.GetBiddingDataExclusion][google.ads.googleads.v9.services.BiddingDataExclusionService.GetBiddingDataExclusion]. -message GetBiddingDataExclusionRequest { - // Required. The resource name of the data exclusion to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BiddingDataExclusion" - } - ]; -} - -// Request message for -// [BiddingDataExclusionService.MutateBiddingDataExclusions][google.ads.googleads.v9.services.BiddingDataExclusionService.MutateBiddingDataExclusions]. +// [BiddingDataExclusionService.MutateBiddingDataExclusions][google.ads.googleads.v12.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]; @@ -91,7 +71,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on a data exclusion. @@ -103,17 +83,19 @@ message BiddingDataExclusionOperation { oneof operation { // Create operation: No resource name is expected for the new data // exclusion. - google.ads.googleads.v9.resources.BiddingDataExclusion create = 1; + google.ads.googleads.v12.resources.BiddingDataExclusion create = 1; // Update operation: The data exclusion is expected to have a valid // resource name. - google.ads.googleads.v9.resources.BiddingDataExclusion update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BiddingDataExclusion" + }]; } } @@ -121,8 +103,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. @@ -132,10 +114,12 @@ message MutateBiddingDataExclusionsResponse { // The result for the data exclusion mutate. message MutateBiddingDataExclusionsResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.BiddingDataExclusion bidding_data_exclusion = 2; + google.ads.googleads.v12.resources.BiddingDataExclusion bidding_data_exclusion = 2; } diff --git a/google/ads/googleads/v9/services/bidding_seasonality_adjustment_service.proto b/google/ads/googleads/v12/services/bidding_seasonality_adjustment_service.proto similarity index 65% rename from google/ads/googleads/v9/services/bidding_seasonality_adjustment_service.proto rename to google/ads/googleads/v12/services/bidding_seasonality_adjustment_service.proto index 27dd20e2c..cf023c250 100644 --- a/google/ads/googleads/v9/services/bidding_seasonality_adjustment_service.proto +++ b/google/ads/googleads/v12/services/bidding_seasonality_adjustment_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/bidding_seasonality_adjustment.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/bidding_seasonality_adjustment.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; @@ -25,33 +25,25 @@ import "google/api/resource.proto"; import "google/protobuf/field_mask.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "BiddingSeasonalityAdjustmentServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to manage bidding seasonality adjustments. service BiddingSeasonalityAdjustmentService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested seasonality adjustment in full detail. - rpc GetBiddingSeasonalityAdjustment(GetBiddingSeasonalityAdjustmentRequest) returns (google.ads.googleads.v9.resources.BiddingSeasonalityAdjustment) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/biddingSeasonalityAdjustments/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes seasonality adjustments. // Operation statuses are returned. rpc MutateBiddingSeasonalityAdjustments(MutateBiddingSeasonalityAdjustmentsRequest) returns (MutateBiddingSeasonalityAdjustmentsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate" + post: "/v12/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -59,19 +51,7 @@ service BiddingSeasonalityAdjustmentService { } // Request message for -// [BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment][google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment]. -message GetBiddingSeasonalityAdjustmentRequest { - // Required. The resource name of the seasonality adjustment to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BiddingSeasonalityAdjustment" - } - ]; -} - -// Request message for -// [BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments][google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments]. +// [BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments][google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments]. message MutateBiddingSeasonalityAdjustmentsRequest { // Required. ID of the customer whose seasonality adjustments are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -91,7 +71,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on a seasonality adjustment. @@ -103,17 +83,19 @@ message BiddingSeasonalityAdjustmentOperation { oneof operation { // Create operation: No resource name is expected for the new seasonality // adjustment. - google.ads.googleads.v9.resources.BiddingSeasonalityAdjustment create = 1; + google.ads.googleads.v12.resources.BiddingSeasonalityAdjustment create = 1; // Update operation: The seasonality adjustment is expected to have a valid // resource name. - google.ads.googleads.v9.resources.BiddingSeasonalityAdjustment update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BiddingSeasonalityAdjustment" + }]; } } @@ -121,8 +103,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. @@ -132,10 +114,12 @@ message MutateBiddingSeasonalityAdjustmentsResponse { // The result for the seasonality adjustment mutate. message MutateBiddingSeasonalityAdjustmentsResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 2; + google.ads.googleads.v12.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 2; } diff --git a/google/ads/googleads/v9/services/bidding_strategy_service.proto b/google/ads/googleads/v12/services/bidding_strategy_service.proto similarity index 69% rename from google/ads/googleads/v9/services/bidding_strategy_service.proto rename to google/ads/googleads/v12/services/bidding_strategy_service.proto index 043bb65d0..f24a6c9f3 100644 --- a/google/ads/googleads/v9/services/bidding_strategy_service.proto +++ b/google/ads/googleads/v12/services/bidding_strategy_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/bidding_strategy.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "BiddingStrategyServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Bidding Strategy service. @@ -41,22 +41,6 @@ service BiddingStrategyService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested bidding strategy in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetBiddingStrategy(GetBiddingStrategyRequest) returns (google.ads.googleads.v9.resources.BiddingStrategy) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/biddingStrategies/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes bidding strategies. Operation statuses are // returned. // @@ -89,25 +73,14 @@ service BiddingStrategyService { // [StringLengthError]() rpc MutateBiddingStrategies(MutateBiddingStrategiesRequest) returns (MutateBiddingStrategiesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/biddingStrategies:mutate" + post: "/v12/customers/{customer_id=*}/biddingStrategies:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [BiddingStrategyService.GetBiddingStrategy][google.ads.googleads.v9.services.BiddingStrategyService.GetBiddingStrategy]. -message GetBiddingStrategyRequest { - // Required. The resource name of the bidding strategy to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BiddingStrategy" - } - ]; -} - -// Request message for [BiddingStrategyService.MutateBiddingStrategies][google.ads.googleads.v9.services.BiddingStrategyService.MutateBiddingStrategies]. +// Request message for [BiddingStrategyService.MutateBiddingStrategies][google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies]. message MutateBiddingStrategiesRequest { // Required. The ID of the customer whose bidding strategies are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -127,7 +100,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a bidding strategy. @@ -139,17 +112,19 @@ message BiddingStrategyOperation { oneof operation { // Create operation: No resource name is expected for the new bidding // strategy. - google.ads.googleads.v9.resources.BiddingStrategy create = 1; + google.ads.googleads.v12.resources.BiddingStrategy create = 1; // Update operation: The bidding strategy is expected to have a valid // resource name. - google.ads.googleads.v9.resources.BiddingStrategy update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BiddingStrategy" + }]; } } @@ -157,8 +132,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. @@ -168,10 +143,12 @@ message MutateBiddingStrategiesResponse { // The result for the bidding strategy mutate. message MutateBiddingStrategyResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.BiddingStrategy bidding_strategy = 2; + google.ads.googleads.v12.resources.BiddingStrategy bidding_strategy = 2; } diff --git a/google/ads/googleads/v9/services/billing_setup_service.proto b/google/ads/googleads/v12/services/billing_setup_service.proto similarity index 69% rename from google/ads/googleads/v9/services/billing_setup_service.proto rename to google/ads/googleads/v12/services/billing_setup_service.proto index eb6f5cfc4..ec74f432f 100644 --- a/google/ads/googleads/v9/services/billing_setup_service.proto +++ b/google/ads/googleads/v12/services/billing_setup_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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/billing_setup.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "BillingSetupServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the BillingSetup service. @@ -46,22 +46,6 @@ service BillingSetupService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns a billing setup. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetBillingSetup(GetBillingSetupRequest) returns (google.ads.googleads.v9.resources.BillingSetup) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/billingSetups/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates a billing setup, or cancels an existing billing setup. // // List of thrown errors: @@ -77,25 +61,13 @@ service BillingSetupService { // [RequestError]() rpc MutateBillingSetup(MutateBillingSetupRequest) returns (MutateBillingSetupResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/billingSetups:mutate" + post: "/v12/customers/{customer_id=*}/billingSetups:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for -// [BillingSetupService.GetBillingSetup][google.ads.googleads.v9.services.BillingSetupService.GetBillingSetup]. -message GetBillingSetupRequest { - // Required. The resource name of the billing setup to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BillingSetup" - } - ]; -} - // Request message for billing setup mutate operations. message MutateBillingSetupRequest { // Required. Id of the customer to apply the billing setup mutate operation to. @@ -113,13 +85,15 @@ message BillingSetupOperation { oneof operation { // Creates a billing setup. No resource name is expected for the new billing // setup. - google.ads.googleads.v9.resources.BillingSetup create = 2; + google.ads.googleads.v12.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; + string remove = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BillingSetup" + }]; } } @@ -132,5 +106,7 @@ message MutateBillingSetupResponse { // Result for a single billing setup mutate. message MutateBillingSetupResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/BillingSetup" + }]; } diff --git a/google/ads/googleads/v9/services/campaign_asset_service.proto b/google/ads/googleads/v12/services/campaign_asset_service.proto similarity index 67% rename from google/ads/googleads/v9/services/campaign_asset_service.proto rename to google/ads/googleads/v12/services/campaign_asset_service.proto index 1d44e1000..10e723c54 100644 --- a/google/ads/googleads/v9/services/campaign_asset_service.proto +++ b/google/ads/googleads/v12/services/campaign_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_asset.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignAssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignAsset service. @@ -41,22 +41,6 @@ service CampaignAssetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign asset in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignAsset(GetCampaignAssetRequest) returns (google.ads.googleads.v9.resources.CampaignAsset) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignAssets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign assets. Operation statuses are // returned. // @@ -75,25 +59,14 @@ service CampaignAssetService { // [RequestError]() rpc MutateCampaignAssets(MutateCampaignAssetsRequest) returns (MutateCampaignAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignAssets:mutate" + post: "/v12/customers/{customer_id=*}/campaignAssets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignAssetService.GetCampaignAsset][google.ads.googleads.v9.services.CampaignAssetService.GetCampaignAsset]. -message GetCampaignAssetRequest { - // Required. The resource name of the campaign asset to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignAsset" - } - ]; -} - -// Request message for [CampaignAssetService.MutateCampaignAssets][google.ads.googleads.v9.services.CampaignAssetService.MutateCampaignAssets]. +// Request message for [CampaignAssetService.MutateCampaignAssets][google.ads.googleads.v12.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]; @@ -113,7 +86,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign asset. @@ -125,17 +98,19 @@ message CampaignAssetOperation { oneof operation { // Create operation: No resource name is expected for the new campaign // asset. - google.ads.googleads.v9.resources.CampaignAsset create = 1; + google.ads.googleads.v12.resources.CampaignAsset create = 1; // Update operation: The campaign asset is expected to have a valid resource // name. - google.ads.googleads.v9.resources.CampaignAsset update = 3; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignAsset" + }]; } } @@ -143,8 +118,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. @@ -154,10 +129,12 @@ message MutateCampaignAssetsResponse { // The result for the campaign asset mutate. message MutateCampaignAssetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignAsset campaign_asset = 2; + google.ads.googleads.v12.resources.CampaignAsset campaign_asset = 2; } diff --git a/google/ads/googleads/v9/services/campaign_asset_set_service.proto b/google/ads/googleads/v12/services/campaign_asset_set_service.proto similarity index 72% rename from google/ads/googleads/v9/services/campaign_asset_set_service.proto rename to google/ads/googleads/v12/services/campaign_asset_set_service.proto index c1956d006..842623679 100644 --- a/google/ads/googleads/v9/services/campaign_asset_set_service.proto +++ b/google/ads/googleads/v12/services/campaign_asset_set_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_asset_set.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignAssetSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignAssetSet service. @@ -43,14 +44,14 @@ service CampaignAssetSetService { // returned. rpc MutateCampaignAssetSets(MutateCampaignAssetSetsRequest) returns (MutateCampaignAssetSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignAssetSets:mutate" + post: "/v12/customers/{customer_id=*}/campaignAssetSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignAssetSetService.MutateCampaignAssetSets][google.ads.googleads.v9.services.CampaignAssetSetService.MutateCampaignAssetSets]. +// Request message for [CampaignAssetSetService.MutateCampaignAssetSets][google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets]. message MutateCampaignAssetSetsRequest { // Required. The ID of the customer whose campaign asset sets are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -70,7 +71,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on a campaign asset set. @@ -79,12 +80,14 @@ message CampaignAssetSetOperation { oneof operation { // Create operation: No resource name is expected for the new campaign asset // set. - google.ads.googleads.v9.resources.CampaignAssetSet create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignAssetSet" + }]; } } @@ -95,18 +98,20 @@ 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; } // The result for the campaign asset set mutate. message MutateCampaignAssetSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignAssetSet campaign_asset_set = 2; + google.ads.googleads.v12.resources.CampaignAssetSet campaign_asset_set = 2; } diff --git a/google/ads/googleads/v9/services/campaign_bid_modifier_service.proto b/google/ads/googleads/v12/services/campaign_bid_modifier_service.proto similarity index 68% rename from google/ads/googleads/v9/services/campaign_bid_modifier_service.proto rename to google/ads/googleads/v12/services/campaign_bid_modifier_service.proto index 9f8b99740..b2d341c08 100644 --- a/google/ads/googleads/v9/services/campaign_bid_modifier_service.proto +++ b/google/ads/googleads/v12/services/campaign_bid_modifier_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_bid_modifier.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignBidModifierServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Bid Modifier service. @@ -41,22 +41,6 @@ service CampaignBidModifierService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign bid modifier in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignBidModifier(GetCampaignBidModifierRequest) returns (google.ads.googleads.v9.resources.CampaignBidModifier) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignBidModifiers/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign bid modifiers. // Operation statuses are returned. // @@ -85,26 +69,15 @@ service CampaignBidModifierService { // [StringLengthError]() rpc MutateCampaignBidModifiers(MutateCampaignBidModifiersRequest) returns (MutateCampaignBidModifiersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignBidModifiers:mutate" + post: "/v12/customers/{customer_id=*}/campaignBidModifiers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignBidModifierService.GetCampaignBidModifier][google.ads.googleads.v9.services.CampaignBidModifierService.GetCampaignBidModifier]. -message GetCampaignBidModifierRequest { - // Required. The resource name of the campaign bid modifier to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignBidModifier" - } - ]; -} - // Request message for -// [CampaignBidModifierService.MutateCampaignBidModifiers][google.ads.googleads.v9.services.CampaignBidModifierService.MutateCampaignBidModifiers]. +// [CampaignBidModifierService.MutateCampaignBidModifiers][google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers]. message MutateCampaignBidModifiersRequest { // Required. ID of the customer whose campaign bid modifiers are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -124,7 +97,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on a campaign bid modifier. @@ -136,17 +109,19 @@ message CampaignBidModifierOperation { oneof operation { // Create operation: No resource name is expected for the new campaign bid // modifier. - google.ads.googleads.v9.resources.CampaignBidModifier create = 1; + google.ads.googleads.v12.resources.CampaignBidModifier create = 1; // Update operation: The campaign bid modifier is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CampaignBidModifier update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignBidModifier" + }]; } } @@ -154,8 +129,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. @@ -165,10 +140,12 @@ message MutateCampaignBidModifiersResponse { // The result for the criterion mutate. message MutateCampaignBidModifierResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignBidModifier campaign_bid_modifier = 2; + google.ads.googleads.v12.resources.CampaignBidModifier campaign_bid_modifier = 2; } diff --git a/google/ads/googleads/v9/services/campaign_budget_service.proto b/google/ads/googleads/v12/services/campaign_budget_service.proto similarity index 68% rename from google/ads/googleads/v9/services/campaign_budget_service.proto rename to google/ads/googleads/v12/services/campaign_budget_service.proto index efd8d2c12..e6301118a 100644 --- a/google/ads/googleads/v9/services/campaign_budget_service.proto +++ b/google/ads/googleads/v12/services/campaign_budget_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_budget.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignBudgetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Budget service. @@ -41,22 +41,6 @@ service CampaignBudgetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested Campaign Budget in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignBudget(GetCampaignBudgetRequest) returns (google.ads.googleads.v9.resources.CampaignBudget) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignBudgets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign budgets. Operation statuses are // returned. // @@ -80,25 +64,14 @@ service CampaignBudgetService { // [StringLengthError]() rpc MutateCampaignBudgets(MutateCampaignBudgetsRequest) returns (MutateCampaignBudgetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignBudgets:mutate" + post: "/v12/customers/{customer_id=*}/campaignBudgets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignBudgetService.GetCampaignBudget][google.ads.googleads.v9.services.CampaignBudgetService.GetCampaignBudget]. -message GetCampaignBudgetRequest { - // Required. The resource name of the campaign budget to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignBudget" - } - ]; -} - -// Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v9.services.CampaignBudgetService.MutateCampaignBudgets]. +// Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v12.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]; @@ -118,7 +91,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign budget. @@ -129,17 +102,19 @@ message CampaignBudgetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new budget. - google.ads.googleads.v9.resources.CampaignBudget create = 1; + google.ads.googleads.v12.resources.CampaignBudget create = 1; // Update operation: The campaign budget is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CampaignBudget update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignBudget" + }]; } } @@ -147,8 +122,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. @@ -158,10 +133,12 @@ message MutateCampaignBudgetsResponse { // The result for the campaign budget mutate. message MutateCampaignBudgetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignBudget campaign_budget = 2; + google.ads.googleads.v12.resources.CampaignBudget campaign_budget = 2; } diff --git a/google/ads/googleads/v9/services/campaign_conversion_goal_service.proto b/google/ads/googleads/v12/services/campaign_conversion_goal_service.proto similarity index 76% rename from google/ads/googleads/v9/services/campaign_conversion_goal_service.proto rename to google/ads/googleads/v12/services/campaign_conversion_goal_service.proto index c425f6e61..355ec7d01 100644 --- a/google/ads/googleads/v9/services/campaign_conversion_goal_service.proto +++ b/google/ads/googleads/v12/services/campaign_conversion_goal_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. @@ -14,22 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/campaign_conversion_goal.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignConversionGoalServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignConversionGoal service. @@ -42,7 +43,7 @@ service CampaignConversionGoalService { // are returned. rpc MutateCampaignConversionGoals(MutateCampaignConversionGoalsRequest) returns (MutateCampaignConversionGoalsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignConversionGoals:mutate" + post: "/v12/customers/{customer_id=*}/campaignConversionGoals:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -50,7 +51,7 @@ service CampaignConversionGoalService { } // Request message for -// [CampaignConversionGoalService.MutateCampaignConversionGoals][google.ads.googleads.v9.services.CampaignConversionGoalService.MutateCampaignConversionGoals]. +// [CampaignConversionGoalService.MutateCampaignConversionGoals][google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals]. message MutateCampaignConversionGoalsRequest { // Required. The ID of the customer whose campaign conversion goals are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -72,7 +73,7 @@ message CampaignConversionGoalOperation { oneof operation { // Update operation: The customer conversion goal is expected to have a // valid resource name. - google.ads.googleads.v9.resources.CampaignConversionGoal update = 1; + google.ads.googleads.v12.resources.CampaignConversionGoal update = 1; } } @@ -85,5 +86,7 @@ message MutateCampaignConversionGoalsResponse { // The result for the campaign conversion goal mutate. message MutateCampaignConversionGoalResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignConversionGoal" + }]; } diff --git a/google/ads/googleads/v9/services/campaign_criterion_service.proto b/google/ads/googleads/v12/services/campaign_criterion_service.proto similarity index 69% rename from google/ads/googleads/v9/services/campaign_criterion_service.proto rename to google/ads/googleads/v12/services/campaign_criterion_service.proto index 6049d6ff8..16f7683bb 100644 --- a/google/ads/googleads/v9/services/campaign_criterion_service.proto +++ b/google/ads/googleads/v12/services/campaign_criterion_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_criterion.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignCriterionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Criterion service. @@ -41,22 +41,6 @@ service CampaignCriterionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested criterion in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignCriterion(GetCampaignCriterionRequest) returns (google.ads.googleads.v9.resources.CampaignCriterion) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignCriteria/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes criteria. Operation statuses are returned. // // List of thrown errors: @@ -91,25 +75,14 @@ service CampaignCriterionService { // [StringLengthError]() rpc MutateCampaignCriteria(MutateCampaignCriteriaRequest) returns (MutateCampaignCriteriaResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignCriteria:mutate" + post: "/v12/customers/{customer_id=*}/campaignCriteria:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignCriterionService.GetCampaignCriterion][google.ads.googleads.v9.services.CampaignCriterionService.GetCampaignCriterion]. -message GetCampaignCriterionRequest { - // Required. The resource name of the criterion to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignCriterion" - } - ]; -} - -// Request message for [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v9.services.CampaignCriterionService.MutateCampaignCriteria]. +// Request message for [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v12.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]; @@ -129,7 +102,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign criterion. @@ -140,17 +113,19 @@ message CampaignCriterionOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new criterion. - google.ads.googleads.v9.resources.CampaignCriterion create = 1; + google.ads.googleads.v12.resources.CampaignCriterion create = 1; // Update operation: The criterion is expected to have a valid resource // name. - google.ads.googleads.v9.resources.CampaignCriterion update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignCriterion" + }]; } } @@ -158,8 +133,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. @@ -169,10 +144,12 @@ message MutateCampaignCriteriaResponse { // The result for the criterion mutate. message MutateCampaignCriterionResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignCriterion campaign_criterion = 2; + google.ads.googleads.v12.resources.CampaignCriterion campaign_criterion = 2; } diff --git a/google/ads/googleads/v9/services/campaign_customizer_service.proto b/google/ads/googleads/v12/services/campaign_customizer_service.proto similarity index 72% rename from google/ads/googleads/v9/services/campaign_customizer_service.proto rename to google/ads/googleads/v12/services/campaign_customizer_service.proto index fbfb42a05..f2ba5e857 100644 --- a/google/ads/googleads/v9/services/campaign_customizer_service.proto +++ b/google/ads/googleads/v12/services/campaign_customizer_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_customizer.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignCustomizerServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignCustomizer service. @@ -43,7 +44,7 @@ service CampaignCustomizerService { // returned. rpc MutateCampaignCustomizers(MutateCampaignCustomizersRequest) returns (MutateCampaignCustomizersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignCustomizers:mutate" + post: "/v12/customers/{customer_id=*}/campaignCustomizers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service CampaignCustomizerService { } // Request message for -// [CampaignCustomizerService.MutateCampaignCustomizers][google.ads.googleads.v9.services.CampaignCustomizerService.MutateCampaignCustomizers]. +// [CampaignCustomizerService.MutateCampaignCustomizers][google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers]. message MutateCampaignCustomizersRequest { // Required. The ID of the customer whose campaign customizers are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -71,7 +72,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an customizer attribute. @@ -80,12 +81,14 @@ message CampaignCustomizerOperation { oneof operation { // Create operation: No resource name is expected for the new campaign // customizer - google.ads.googleads.v9.resources.CampaignCustomizer create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignCustomizer" + }]; } } @@ -96,18 +99,20 @@ message MutateCampaignCustomizersResponse { // 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; } // The result for the campaign customizer mutate. message MutateCampaignCustomizerResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignCustomizer campaign_customizer = 2; + google.ads.googleads.v12.resources.CampaignCustomizer campaign_customizer = 2; } diff --git a/google/ads/googleads/v9/services/campaign_draft_service.proto b/google/ads/googleads/v12/services/campaign_draft_service.proto similarity index 75% rename from google/ads/googleads/v9/services/campaign_draft_service.proto rename to google/ads/googleads/v12/services/campaign_draft_service.proto index 75b914c5f..140cb1794 100644 --- a/google/ads/googleads/v9/services/campaign_draft_service.proto +++ b/google/ads/googleads/v12/services/campaign_draft_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_draft.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/campaign_draft.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; @@ -26,14 +26,14 @@ import "google/longrunning/operations.proto"; import "google/protobuf/field_mask.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignDraftServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Draft service. @@ -42,22 +42,6 @@ service CampaignDraftService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign draft in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignDraft(GetCampaignDraftRequest) returns (google.ads.googleads.v9.resources.CampaignDraft) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignDrafts/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign drafts. Operation statuses are // returned. // @@ -74,7 +58,7 @@ service CampaignDraftService { // [RequestError]() rpc MutateCampaignDrafts(MutateCampaignDraftsRequest) returns (MutateCampaignDraftsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignDrafts:mutate" + post: "/v12/customers/{customer_id=*}/campaignDrafts:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -87,7 +71,7 @@ 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.v9.services.CampaignDraftService.ListCampaignDraftAsyncErrors] to view the list of + // [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors] to view the list of // error reasons. // // List of thrown errors: @@ -100,7 +84,7 @@ service CampaignDraftService { // [RequestError]() rpc PromoteCampaignDraft(PromoteCampaignDraftRequest) returns (google.longrunning.Operation) { option (google.api.http) = { - post: "/v9/{campaign_draft=customers/*/campaignDrafts/*}:promote" + post: "/v12/{campaign_draft=customers/*/campaignDrafts/*}:promote" body: "*" }; option (google.api.method_signature) = "campaign_draft"; @@ -123,24 +107,13 @@ service CampaignDraftService { // [RequestError]() rpc ListCampaignDraftAsyncErrors(ListCampaignDraftAsyncErrorsRequest) returns (ListCampaignDraftAsyncErrorsResponse) { option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors" + get: "/v12/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors" }; option (google.api.method_signature) = "resource_name"; } } -// Request message for [CampaignDraftService.GetCampaignDraft][google.ads.googleads.v9.services.CampaignDraftService.GetCampaignDraft]. -message GetCampaignDraftRequest { - // Required. The resource name of the campaign draft to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignDraft" - } - ]; -} - -// Request message for [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v9.services.CampaignDraftService.MutateCampaignDrafts]. +// Request message for [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v12.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]; @@ -160,13 +133,18 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } -// Request message for [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v9.services.CampaignDraftService.PromoteCampaignDraft]. +// Request message for [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v12.services.CampaignDraftService.PromoteCampaignDraft]. message PromoteCampaignDraftRequest { // Required. The resource name of the campaign draft to promote. - string campaign_draft = 1 [(google.api.field_behavior) = REQUIRED]; + string campaign_draft = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignDraft" + } + ]; // If true, the request is validated but no Long Running Operation is created. // Only errors are returned. @@ -182,17 +160,19 @@ message CampaignDraftOperation { oneof operation { // Create operation: No resource name is expected for the new campaign // draft. - google.ads.googleads.v9.resources.CampaignDraft create = 1; + google.ads.googleads.v12.resources.CampaignDraft create = 1; // Update operation: The campaign draft is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CampaignDraft update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignDraft" + }]; } } @@ -200,8 +180,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. @@ -211,15 +191,17 @@ message MutateCampaignDraftsResponse { // The result for the campaign draft mutate. message MutateCampaignDraftResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignDraft campaign_draft = 2; + google.ads.googleads.v12.resources.CampaignDraft campaign_draft = 2; } -// Request message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v9.services.CampaignDraftService.ListCampaignDraftAsyncErrors]. +// Request message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors]. message ListCampaignDraftAsyncErrorsRequest { // Required. The name of the campaign draft from which to retrieve the async errors. string resource_name = 1 [ @@ -241,7 +223,7 @@ message ListCampaignDraftAsyncErrorsRequest { int32 page_size = 3; } -// Response message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v9.services.CampaignDraftService.ListCampaignDraftAsyncErrors]. +// Response message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors]. message ListCampaignDraftAsyncErrorsResponse { // Details of the errors when performing the asynchronous operation. repeated google.rpc.Status errors = 1; diff --git a/google/ads/googleads/v9/services/campaign_extension_setting_service.proto b/google/ads/googleads/v12/services/campaign_extension_setting_service.proto similarity index 68% rename from google/ads/googleads/v9/services/campaign_extension_setting_service.proto rename to google/ads/googleads/v12/services/campaign_extension_setting_service.proto index f39232a12..f7032b8ca 100644 --- a/google/ads/googleads/v9/services/campaign_extension_setting_service.proto +++ b/google/ads/googleads/v12/services/campaign_extension_setting_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_extension_setting.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignExtensionSettingServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignExtensionSetting service. @@ -41,22 +41,6 @@ service CampaignExtensionSettingService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign extension setting in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignExtensionSetting(GetCampaignExtensionSettingRequest) returns (google.ads.googleads.v9.resources.CampaignExtensionSetting) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignExtensionSettings/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign extension settings. Operation // statuses are returned. // @@ -90,7 +74,7 @@ service CampaignExtensionSettingService { // [UrlFieldError]() rpc MutateCampaignExtensionSettings(MutateCampaignExtensionSettingsRequest) returns (MutateCampaignExtensionSettingsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignExtensionSettings:mutate" + post: "/v12/customers/{customer_id=*}/campaignExtensionSettings:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -98,19 +82,7 @@ service CampaignExtensionSettingService { } // Request message for -// [CampaignExtensionSettingService.GetCampaignExtensionSetting][google.ads.googleads.v9.services.CampaignExtensionSettingService.GetCampaignExtensionSetting]. -message GetCampaignExtensionSettingRequest { - // Required. The resource name of the campaign extension setting to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignExtensionSetting" - } - ]; -} - -// Request message for -// [CampaignExtensionSettingService.MutateCampaignExtensionSettings][google.ads.googleads.v9.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings]. +// [CampaignExtensionSettingService.MutateCampaignExtensionSettings][google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings]. message MutateCampaignExtensionSettingsRequest { // Required. The ID of the customer whose campaign extension settings are being // modified. @@ -132,7 +104,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign extension setting. @@ -144,17 +116,19 @@ message CampaignExtensionSettingOperation { oneof operation { // Create operation: No resource name is expected for the new campaign // extension setting. - google.ads.googleads.v9.resources.CampaignExtensionSetting create = 1; + google.ads.googleads.v12.resources.CampaignExtensionSetting create = 1; // Update operation: The campaign extension setting is expected to have a // valid resource name. - google.ads.googleads.v9.resources.CampaignExtensionSetting update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignExtensionSetting" + }]; } } @@ -162,8 +136,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. @@ -173,10 +147,12 @@ message MutateCampaignExtensionSettingsResponse { // The result for the campaign extension setting mutate. message MutateCampaignExtensionSettingResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignExtensionSetting campaign_extension_setting = 2; + google.ads.googleads.v12.resources.CampaignExtensionSetting campaign_extension_setting = 2; } diff --git a/google/ads/googleads/v9/services/campaign_feed_service.proto b/google/ads/googleads/v12/services/campaign_feed_service.proto similarity index 68% rename from google/ads/googleads/v9/services/campaign_feed_service.proto rename to google/ads/googleads/v12/services/campaign_feed_service.proto index e72851c1a..8aa4186e3 100644 --- a/google/ads/googleads/v9/services/campaign_feed_service.proto +++ b/google/ads/googleads/v12/services/campaign_feed_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_feed.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignFeedServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CampaignFeed service. @@ -41,22 +41,6 @@ service CampaignFeedService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign feed in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignFeed(GetCampaignFeedRequest) returns (google.ads.googleads.v9.resources.CampaignFeed) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignFeeds/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaign feeds. Operation statuses are // returned. // @@ -86,25 +70,14 @@ service CampaignFeedService { // [StringLengthError]() rpc MutateCampaignFeeds(MutateCampaignFeedsRequest) returns (MutateCampaignFeedsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignFeeds:mutate" + post: "/v12/customers/{customer_id=*}/campaignFeeds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignFeedService.GetCampaignFeed][google.ads.googleads.v9.services.CampaignFeedService.GetCampaignFeed]. -message GetCampaignFeedRequest { - // Required. The resource name of the campaign feed to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignFeed" - } - ]; -} - -// Request message for [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v9.services.CampaignFeedService.MutateCampaignFeeds]. +// Request message for [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v12.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]; @@ -124,7 +97,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign feed. @@ -135,17 +108,19 @@ message CampaignFeedOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new campaign feed. - google.ads.googleads.v9.resources.CampaignFeed create = 1; + google.ads.googleads.v12.resources.CampaignFeed create = 1; // Update operation: The campaign feed is expected to have a valid resource // name. - google.ads.googleads.v9.resources.CampaignFeed update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignFeed" + }]; } } @@ -153,8 +128,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. @@ -164,10 +139,12 @@ message MutateCampaignFeedsResponse { // The result for the campaign feed mutate. message MutateCampaignFeedResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignFeed campaign_feed = 2; + google.ads.googleads.v12.resources.CampaignFeed campaign_feed = 2; } diff --git a/google/ads/googleads/v12/services/campaign_group_service.proto b/google/ads/googleads/v12/services/campaign_group_service.proto new file mode 100644 index 000000000..30e294598 --- /dev/null +++ b/google/ads/googleads/v12/services/campaign_group_service.proto @@ -0,0 +1,129 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/campaign_group.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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "CampaignGroupServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the Campaign group service. + +// Service to manage campaign groups. +service CampaignGroupService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Creates, updates, or removes campaign groups. Operation statuses are + // returned. + rpc MutateCampaignGroups(MutateCampaignGroupsRequest) returns (MutateCampaignGroupsResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}/campaignGroups:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v12.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]; + + // 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.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; +} + +// A single operation (create, update, remove) on a campaign group. +message CampaignGroupOperation { + // FieldMask that determines which resource fields are modified in an update. + google.protobuf.FieldMask update_mask = 4; + + // The mutate operation. + oneof operation { + // Create operation: No resource name is expected for the new campaign + // group. + google.ads.googleads.v12.resources.CampaignGroup create = 1; + + // Update operation: The campaign group is expected to have a valid + // resource name. + google.ads.googleads.v12.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" + }]; + } +} + +// Response message for campaign group mutate. +message MutateCampaignGroupsResponse { + // All results for the mutate. + repeated MutateCampaignGroupResult 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 (for example, auth + // errors), we return an RPC level error. + google.rpc.Status partial_failure_error = 3; +} + +// The result for the campaign group mutate. +message MutateCampaignGroupResult { + // Required. Returned for successful operations. + string resource_name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignGroup" + } + ]; + + // 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.v12.resources.CampaignGroup campaign_group = 2; +} diff --git a/google/ads/googleads/v9/services/campaign_label_service.proto b/google/ads/googleads/v12/services/campaign_label_service.proto similarity index 67% rename from google/ads/googleads/v9/services/campaign_label_service.proto rename to google/ads/googleads/v12/services/campaign_label_service.proto index c493e8190..1a3598b76 100644 --- a/google/ads/googleads/v9/services/campaign_label_service.proto +++ b/google/ads/googleads/v12/services/campaign_label_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/campaign_label.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignLabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Label service. @@ -39,22 +39,6 @@ service CampaignLabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign-label relationship in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignLabel(GetCampaignLabelRequest) returns (google.ads.googleads.v9.resources.CampaignLabel) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignLabels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates and removes campaign-label relationships. // Operation statuses are returned. // @@ -72,25 +56,14 @@ service CampaignLabelService { // [RequestError]() rpc MutateCampaignLabels(MutateCampaignLabelsRequest) returns (MutateCampaignLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignLabels:mutate" + post: "/v12/customers/{customer_id=*}/campaignLabels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignLabelService.GetCampaignLabel][google.ads.googleads.v9.services.CampaignLabelService.GetCampaignLabel]. -message GetCampaignLabelRequest { - // Required. The resource name of the campaign-label relationship to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignLabel" - } - ]; -} - -// Request message for [CampaignLabelService.MutateCampaignLabels][google.ads.googleads.v9.services.CampaignLabelService.MutateCampaignLabels]. +// Request message for [CampaignLabelService.MutateCampaignLabels][google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels]. message MutateCampaignLabelsRequest { // Required. ID of the customer whose campaign-label relationships are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -115,13 +88,15 @@ message CampaignLabelOperation { oneof operation { // Create operation: No resource name is expected for the new campaign-label // relationship. - google.ads.googleads.v9.resources.CampaignLabel create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignLabel" + }]; } } @@ -129,8 +104,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. @@ -140,5 +115,7 @@ message MutateCampaignLabelsResponse { // The result for a campaign label mutate. message MutateCampaignLabelResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignLabel" + }]; } diff --git a/google/ads/googleads/v9/services/campaign_service.proto b/google/ads/googleads/v12/services/campaign_service.proto similarity index 70% rename from google/ads/googleads/v9/services/campaign_service.proto rename to google/ads/googleads/v12/services/campaign_service.proto index 5b7d380a4..c65f18489 100644 --- a/google/ads/googleads/v9/services/campaign_service.proto +++ b/google/ads/googleads/v12/services/campaign_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign service. @@ -41,22 +41,6 @@ service CampaignService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaign(GetCampaignRequest) returns (google.ads.googleads.v9.resources.Campaign) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaigns/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes campaigns. Operation statuses are returned. // // List of thrown errors: @@ -97,25 +81,14 @@ service CampaignService { // [UrlFieldError]() rpc MutateCampaigns(MutateCampaignsRequest) returns (MutateCampaignsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaigns:mutate" + post: "/v12/customers/{customer_id=*}/campaigns:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignService.GetCampaign][google.ads.googleads.v9.services.CampaignService.GetCampaign]. -message GetCampaignRequest { - // Required. The resource name of the campaign to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Campaign" - } - ]; -} - -// Request message for [CampaignService.MutateCampaigns][google.ads.googleads.v9.services.CampaignService.MutateCampaigns]. +// Request message for [CampaignService.MutateCampaigns][google.ads.googleads.v12.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]; @@ -135,7 +108,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a campaign. @@ -146,17 +119,19 @@ message CampaignOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new campaign. - google.ads.googleads.v9.resources.Campaign create = 1; + google.ads.googleads.v12.resources.Campaign create = 1; // Update operation: The campaign is expected to have a valid // resource name. - google.ads.googleads.v9.resources.Campaign update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Campaign" + }]; } } @@ -164,8 +139,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. @@ -175,9 +150,11 @@ message MutateCampaignsResponse { // The result for the campaign mutate. message MutateCampaignResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.Campaign campaign = 2; + google.ads.googleads.v12.resources.Campaign campaign = 2; } diff --git a/google/ads/googleads/v9/services/campaign_shared_set_service.proto b/google/ads/googleads/v12/services/campaign_shared_set_service.proto similarity index 67% rename from google/ads/googleads/v9/services/campaign_shared_set_service.proto rename to google/ads/googleads/v12/services/campaign_shared_set_service.proto index ca8ff8c3f..e1a441fc4 100644 --- a/google/ads/googleads/v9/services/campaign_shared_set_service.proto +++ b/google/ads/googleads/v12/services/campaign_shared_set_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/campaign_shared_set.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CampaignSharedSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Campaign Shared Set service. @@ -40,22 +40,6 @@ service CampaignSharedSetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested campaign shared set in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignSharedSet(GetCampaignSharedSetRequest) returns (google.ads.googleads.v9.resources.CampaignSharedSet) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignSharedSets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes campaign shared sets. Operation statuses are returned. // // List of thrown errors: @@ -83,25 +67,14 @@ service CampaignSharedSetService { // [StringLengthError]() rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest) returns (MutateCampaignSharedSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/campaignSharedSets:mutate" + post: "/v12/customers/{customer_id=*}/campaignSharedSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CampaignSharedSetService.GetCampaignSharedSet][google.ads.googleads.v9.services.CampaignSharedSetService.GetCampaignSharedSet]. -message GetCampaignSharedSetRequest { - // Required. The resource name of the campaign shared set to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignSharedSet" - } - ]; -} - -// Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v9.services.CampaignSharedSetService.MutateCampaignSharedSets]. +// Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets]. message MutateCampaignSharedSetsRequest { // Required. The ID of the customer whose campaign shared sets are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -121,7 +94,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an campaign shared set. @@ -130,13 +103,15 @@ message CampaignSharedSetOperation { oneof operation { // Create operation: No resource name is expected for the new campaign // shared set. - google.ads.googleads.v9.resources.CampaignSharedSet create = 1; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CampaignSharedSet" + }]; } } @@ -144,8 +119,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. @@ -155,10 +130,12 @@ message MutateCampaignSharedSetsResponse { // The result for the campaign shared set mutate. message MutateCampaignSharedSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CampaignSharedSet campaign_shared_set = 2; + google.ads.googleads.v12.resources.CampaignSharedSet campaign_shared_set = 2; } diff --git a/google/ads/googleads/v9/services/conversion_action_service.proto b/google/ads/googleads/v12/services/conversion_action_service.proto similarity index 67% rename from google/ads/googleads/v9/services/conversion_action_service.proto rename to google/ads/googleads/v12/services/conversion_action_service.proto index 3f5cd493e..5f53abb2c 100644 --- a/google/ads/googleads/v9/services/conversion_action_service.proto +++ b/google/ads/googleads/v12/services/conversion_action_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/conversion_action.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionActionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Conversion Action service. @@ -41,22 +41,6 @@ service ConversionActionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested conversion action. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetConversionAction(GetConversionActionRequest) returns (google.ads.googleads.v9.resources.ConversionAction) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/conversionActions/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates or removes conversion actions. Operation statuses are // returned. // @@ -79,25 +63,14 @@ service ConversionActionService { // [StringLengthError]() rpc MutateConversionActions(MutateConversionActionsRequest) returns (MutateConversionActionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/conversionActions:mutate" + post: "/v12/customers/{customer_id=*}/conversionActions:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [ConversionActionService.GetConversionAction][google.ads.googleads.v9.services.ConversionActionService.GetConversionAction]. -message GetConversionActionRequest { - // Required. The resource name of the conversion action to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ConversionAction" - } - ]; -} - -// Request message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v9.services.ConversionActionService.MutateConversionActions]. +// Request message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions]. message MutateConversionActionsRequest { // Required. The ID of the customer whose conversion actions are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -117,7 +90,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a conversion action. @@ -129,26 +102,28 @@ message ConversionActionOperation { oneof operation { // Create operation: No resource name is expected for the new conversion // action. - google.ads.googleads.v9.resources.ConversionAction create = 1; + google.ads.googleads.v12.resources.ConversionAction create = 1; // Update operation: The conversion action is expected to have a valid // resource name. - google.ads.googleads.v9.resources.ConversionAction update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/ConversionAction" + }]; } } -// Response message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v9.services.ConversionActionService.MutateConversionActions]. +// Response message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v12.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. @@ -158,10 +133,12 @@ message MutateConversionActionsResponse { // The result for the conversion action mutate. message MutateConversionActionResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ConversionAction conversion_action = 2; + google.ads.googleads.v12.resources.ConversionAction conversion_action = 2; } diff --git a/google/ads/googleads/v9/services/conversion_adjustment_upload_service.proto b/google/ads/googleads/v12/services/conversion_adjustment_upload_service.proto similarity index 84% rename from google/ads/googleads/v9/services/conversion_adjustment_upload_service.proto rename to google/ads/googleads/v12/services/conversion_adjustment_upload_service.proto index 12556b711..dfe8c247e 100644 --- a/google/ads/googleads/v9/services/conversion_adjustment_upload_service.proto +++ b/google/ads/googleads/v12/services/conversion_adjustment_upload_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/offline_user_data.proto"; -import "google/ads/googleads/v9/enums/conversion_adjustment_type.proto"; +import "google/ads/googleads/v12/common/offline_user_data.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionAdjustmentUploadServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to upload conversion adjustments. service ConversionAdjustmentUploadService { @@ -49,7 +49,7 @@ service ConversionAdjustmentUploadService { // [RequestError]() rpc UploadConversionAdjustments(UploadConversionAdjustmentsRequest) returns (UploadConversionAdjustmentsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:uploadConversionAdjustments" + post: "/v12/customers/{customer_id=*}:uploadConversionAdjustments" body: "*" }; option (google.api.method_signature) = "customer_id,conversion_adjustments,partial_failure"; @@ -57,7 +57,7 @@ service ConversionAdjustmentUploadService { } // Request message for -// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v9.services.ConversionAdjustmentUploadService.UploadConversionAdjustments]. +// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments]. message UploadConversionAdjustmentsRequest { // Required. The ID of the customer performing the upload. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -80,13 +80,12 @@ message UploadConversionAdjustmentsRequest { } // Response message for -// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v9.services.ConversionAdjustmentUploadService.UploadConversionAdjustments]. +// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v12.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 +116,11 @@ 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.v9.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5; + google.ads.googleads.v12.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 +135,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.v9.common.UserIdentifier user_identifiers = 10; + repeated google.ads.googleads.v12.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 +161,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 +174,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 +191,9 @@ 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.v9.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5; + google.ads.googleads.v12.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5; } diff --git a/google/ads/googleads/v9/services/conversion_custom_variable_service.proto b/google/ads/googleads/v12/services/conversion_custom_variable_service.proto similarity index 64% rename from google/ads/googleads/v9/services/conversion_custom_variable_service.proto rename to google/ads/googleads/v12/services/conversion_custom_variable_service.proto index f8e565232..0017703f9 100644 --- a/google/ads/googleads/v9/services/conversion_custom_variable_service.proto +++ b/google/ads/googleads/v12/services/conversion_custom_variable_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/conversion_custom_variable.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionCustomVariableServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Conversion Custom Variable service. @@ -41,22 +41,6 @@ service ConversionCustomVariableService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested conversion custom variable. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetConversionCustomVariable(GetConversionCustomVariableRequest) returns (google.ads.googleads.v9.resources.ConversionCustomVariable) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/conversionCustomVariables/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates conversion custom variables. Operation statuses are // returned. // @@ -71,7 +55,7 @@ service ConversionCustomVariableService { // [RequestError]() rpc MutateConversionCustomVariables(MutateConversionCustomVariablesRequest) returns (MutateConversionCustomVariablesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/conversionCustomVariables:mutate" + post: "/v12/customers/{customer_id=*}/conversionCustomVariables:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -79,19 +63,7 @@ service ConversionCustomVariableService { } // Request message for -// [ConversionCustomVariableService.GetConversionCustomVariable][google.ads.googleads.v9.services.ConversionCustomVariableService.GetConversionCustomVariable]. -message GetConversionCustomVariableRequest { - // Required. The resource name of the conversion custom variable to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ConversionCustomVariable" - } - ]; -} - -// Request message for -// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v9.services.ConversionCustomVariableService.MutateConversionCustomVariables]. +// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables]. message MutateConversionCustomVariablesRequest { // Required. The ID of the customer whose conversion custom variables are being // modified. @@ -113,7 +85,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update) on a conversion custom variable. @@ -125,21 +97,21 @@ message ConversionCustomVariableOperation { oneof operation { // Create operation: No resource name is expected for the new conversion // custom variable. - google.ads.googleads.v9.resources.ConversionCustomVariable create = 1; + google.ads.googleads.v12.resources.ConversionCustomVariable create = 1; // Update operation: The conversion custom variable is expected to have a // valid resource name. - google.ads.googleads.v9.resources.ConversionCustomVariable update = 2; + google.ads.googleads.v12.resources.ConversionCustomVariable update = 2; } } // Response message for -// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v9.services.ConversionCustomVariableService.MutateConversionCustomVariables]. +// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v12.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. @@ -149,10 +121,12 @@ message MutateConversionCustomVariablesResponse { // The result for the conversion custom variable mutate. message MutateConversionCustomVariableResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ConversionCustomVariable conversion_custom_variable = 2; + google.ads.googleads.v12.resources.ConversionCustomVariable conversion_custom_variable = 2; } diff --git a/google/ads/googleads/v9/services/conversion_goal_campaign_config_service.proto b/google/ads/googleads/v12/services/conversion_goal_campaign_config_service.proto similarity index 75% rename from google/ads/googleads/v9/services/conversion_goal_campaign_config_service.proto rename to google/ads/googleads/v12/services/conversion_goal_campaign_config_service.proto index cb47b21a4..ac3b112c0 100644 --- a/google/ads/googleads/v9/services/conversion_goal_campaign_config_service.proto +++ b/google/ads/googleads/v12/services/conversion_goal_campaign_config_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/conversion_goal_campaign_config.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionGoalCampaignConfigServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the ConversionGoalCampaignConfig service. @@ -43,7 +44,7 @@ service ConversionGoalCampaignConfigService { // statuses are returned. rpc MutateConversionGoalCampaignConfigs(MutateConversionGoalCampaignConfigsRequest) returns (MutateConversionGoalCampaignConfigsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate" + post: "/v12/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -66,7 +67,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } // A single operation (update) on a conversion goal campaign config. @@ -78,7 +79,7 @@ message ConversionGoalCampaignConfigOperation { oneof operation { // Update operation: The conversion goal campaign config is expected to have // a valid resource name. - google.ads.googleads.v9.resources.ConversionGoalCampaignConfig update = 1; + google.ads.googleads.v12.resources.ConversionGoalCampaignConfig update = 1; } } @@ -91,10 +92,12 @@ message MutateConversionGoalCampaignConfigsResponse { // The result for the conversion goal campaign config mutate. message MutateConversionGoalCampaignConfigResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 2; + google.ads.googleads.v12.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 2; } diff --git a/google/ads/googleads/v9/services/conversion_upload_service.proto b/google/ads/googleads/v12/services/conversion_upload_service.proto similarity index 80% rename from google/ads/googleads/v9/services/conversion_upload_service.proto rename to google/ads/googleads/v12/services/conversion_upload_service.proto index a5ce69b2e..3c6b4c22d 100644 --- a/google/ads/googleads/v9/services/conversion_upload_service.proto +++ b/google/ads/googleads/v12/services/conversion_upload_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/offline_user_data.proto"; +import "google/ads/googleads/v12/common/offline_user_data.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionUploadServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to upload conversions. service ConversionUploadService { @@ -50,7 +51,7 @@ service ConversionUploadService { // [RequestError]() rpc UploadClickConversions(UploadClickConversionsRequest) returns (UploadClickConversionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:uploadClickConversions" + post: "/v12/customers/{customer_id=*}:uploadClickConversions" body: "*" }; option (google.api.method_signature) = "customer_id,conversions,partial_failure"; @@ -68,14 +69,14 @@ service ConversionUploadService { // [RequestError]() rpc UploadCallConversions(UploadCallConversionsRequest) returns (UploadCallConversionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:uploadCallConversions" + post: "/v12/customers/{customer_id=*}:uploadCallConversions" body: "*" }; option (google.api.method_signature) = "customer_id,conversions,partial_failure"; } } -// Request message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v9.services.ConversionUploadService.UploadClickConversions]. +// Request message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions]. message UploadClickConversionsRequest { // Required. The ID of the customer performing the upload. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -95,14 +96,34 @@ 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.v9.services.ConversionUploadService.UploadClickConversions]. +// Response message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v12.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; @@ -113,7 +134,7 @@ message UploadClickConversionsResponse { repeated ClickConversionResult results = 2; } -// Request message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v9.services.ConversionUploadService.UploadCallConversions]. +// Request message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions]. message UploadCallConversionsRequest { // Required. The ID of the customer performing the upload. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -135,12 +156,12 @@ message UploadCallConversionsRequest { bool validate_only = 4; } -// Response message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v9.services.ConversionUploadService.UploadCallConversions]. +// Response message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v12.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; @@ -172,7 +193,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. @@ -200,18 +221,21 @@ 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.v9.common.UserIdentifier user_identifiers = 17; + repeated google.ads.googleads.v12.common.UserIdentifier user_identifiers = 17; + + // The environment this conversion was recorded on, for example, App or Web. + google.ads.googleads.v12.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. @@ -222,7 +246,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. @@ -263,13 +287,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.v9.common.UserIdentifier user_identifiers = 7; + repeated google.ads.googleads.v12.common.UserIdentifier user_identifiers = 7; } // Identifying information for a successfully processed CallConversionUpload. @@ -279,14 +303,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; } diff --git a/google/ads/googleads/v9/services/conversion_value_rule_service.proto b/google/ads/googleads/v12/services/conversion_value_rule_service.proto similarity index 66% rename from google/ads/googleads/v9/services/conversion_value_rule_service.proto rename to google/ads/googleads/v12/services/conversion_value_rule_service.proto index 6c47c9540..52780c595 100644 --- a/google/ads/googleads/v9/services/conversion_value_rule_service.proto +++ b/google/ads/googleads/v12/services/conversion_value_rule_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/conversion_value_rule.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Conversion Value Rule service. @@ -41,19 +41,11 @@ service ConversionValueRuleService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested conversion value rule. - rpc GetConversionValueRule(GetConversionValueRuleRequest) returns (google.ads.googleads.v9.resources.ConversionValueRule) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/conversionValueRules/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes conversion value rules. Operation statuses are // returned. rpc MutateConversionValueRules(MutateConversionValueRulesRequest) returns (MutateConversionValueRulesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/conversionValueRules:mutate" + post: "/v12/customers/{customer_id=*}/conversionValueRules:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -61,19 +53,7 @@ service ConversionValueRuleService { } // Request message for -// [ConversionValueRuleService.GetConversionValueRule][google.ads.googleads.v9.services.ConversionValueRuleService.GetConversionValueRule]. -message GetConversionValueRuleRequest { - // Required. The resource name of the conversion value rule to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ConversionValueRule" - } - ]; -} - -// Request message for -// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v9.services.ConversionValueRuleService.MutateConversionValueRules]. +// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules]. message MutateConversionValueRulesRequest { // Required. The ID of the customer whose conversion value rules are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -93,7 +73,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } // A single operation (create, update, remove) on a conversion value rule. @@ -105,40 +85,44 @@ message ConversionValueRuleOperation { oneof operation { // Create operation: No resource name is expected for the new conversion // value rule. - google.ads.googleads.v9.resources.ConversionValueRule create = 1; + google.ads.googleads.v12.resources.ConversionValueRule create = 1; // Update operation: The conversion value rule is expected to have a valid // resource name. - google.ads.googleads.v9.resources.ConversionValueRule update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/ConversionValueRule" + }]; } } // Response message for -// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v9.services.ConversionValueRuleService.MutateConversionValueRules]. +// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v12.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; } // The result for the conversion value rule mutate. message MutateConversionValueRuleResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ConversionValueRule conversion_value_rule = 2; + google.ads.googleads.v12.resources.ConversionValueRule conversion_value_rule = 2; } diff --git a/google/ads/googleads/v9/services/conversion_value_rule_set_service.proto b/google/ads/googleads/v12/services/conversion_value_rule_set_service.proto similarity index 66% rename from google/ads/googleads/v9/services/conversion_value_rule_set_service.proto rename to google/ads/googleads/v12/services/conversion_value_rule_set_service.proto index c3ef6b375..80f61519c 100644 --- a/google/ads/googleads/v9/services/conversion_value_rule_set_service.proto +++ b/google/ads/googleads/v12/services/conversion_value_rule_set_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/conversion_value_rule_set.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ConversionValueRuleSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Conversion Value Rule Set service. @@ -41,19 +41,11 @@ service ConversionValueRuleSetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested conversion value rule set. - rpc GetConversionValueRuleSet(GetConversionValueRuleSetRequest) returns (google.ads.googleads.v9.resources.ConversionValueRuleSet) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/conversionValueRuleSets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates or removes conversion value rule sets. Operation statuses // are returned. rpc MutateConversionValueRuleSets(MutateConversionValueRuleSetsRequest) returns (MutateConversionValueRuleSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/conversionValueRuleSets:mutate" + post: "/v12/customers/{customer_id=*}/conversionValueRuleSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -61,19 +53,7 @@ service ConversionValueRuleSetService { } // Request message for -// [ConversionValueRuleSetService.GetConversionValueRuleSet][google.ads.googleads.v9.services.ConversionValueRuleSetService.GetConversionValueRuleSet]. -message GetConversionValueRuleSetRequest { - // Required. The resource name of the conversion value rule set to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ConversionValueRuleSet" - } - ]; -} - -// Request message for -// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v9.services.ConversionValueRuleSetService.MutateConversionValueRuleSets]. +// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets]. message MutateConversionValueRuleSetsRequest { // Required. The ID of the customer whose conversion value rule sets are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -93,7 +73,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } // A single operation (create, update, remove) on a conversion value rule set. @@ -105,40 +85,44 @@ message ConversionValueRuleSetOperation { oneof operation { // Create operation: No resource name is expected for the new conversion // value rule set. - google.ads.googleads.v9.resources.ConversionValueRuleSet create = 1; + google.ads.googleads.v12.resources.ConversionValueRuleSet create = 1; // Update operation: The conversion value rule set is expected to have a // valid resource name. - google.ads.googleads.v9.resources.ConversionValueRuleSet update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/ConversionValueRuleSet" + }]; } } // Response message for -// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v9.services.ConversionValueRuleSetService.MutateConversionValueRuleSets]. +// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v12.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; } // The result for the conversion value rule set mutate. message MutateConversionValueRuleSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ConversionValueRuleSet conversion_value_rule_set = 2; + google.ads.googleads.v12.resources.ConversionValueRuleSet conversion_value_rule_set = 2; } diff --git a/google/ads/googleads/v9/services/custom_audience_service.proto b/google/ads/googleads/v12/services/custom_audience_service.proto similarity index 67% rename from google/ads/googleads/v9/services/custom_audience_service.proto rename to google/ads/googleads/v12/services/custom_audience_service.proto index 01de27406..a062eeaae 100644 --- a/google/ads/googleads/v9/services/custom_audience_service.proto +++ b/google/ads/googleads/v12/services/custom_audience_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/custom_audience.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomAudienceServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Custom Audience service. @@ -39,22 +39,6 @@ service CustomAudienceService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested custom audience in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomAudience(GetCustomAudienceRequest) returns (google.ads.googleads.v9.resources.CustomAudience) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customAudiences/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates custom audiences. Operation statuses are returned. // // List of thrown errors: @@ -73,25 +57,14 @@ service CustomAudienceService { // [RequestError]() rpc MutateCustomAudiences(MutateCustomAudiencesRequest) returns (MutateCustomAudiencesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customAudiences:mutate" + post: "/v12/customers/{customer_id=*}/customAudiences:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CustomAudienceService.GetCustomAudience][google.ads.googleads.v9.services.CustomAudienceService.GetCustomAudience]. -message GetCustomAudienceRequest { - // Required. The resource name of the custom audience to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomAudience" - } - ]; -} - -// Request message for [CustomAudienceService.MutateCustomAudiences][google.ads.googleads.v9.services.CustomAudienceService.MutateCustomAudiences]. +// Request message for [CustomAudienceService.MutateCustomAudiences][google.ads.googleads.v12.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]; @@ -113,17 +86,19 @@ message CustomAudienceOperation { oneof operation { // Create operation: No resource name is expected for the new custom // audience. - google.ads.googleads.v9.resources.CustomAudience create = 1; + google.ads.googleads.v12.resources.CustomAudience create = 1; // Update operation: The custom audience is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CustomAudience update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomAudience" + }]; } } @@ -136,5 +111,7 @@ message MutateCustomAudiencesResponse { // The result for the custom audience mutate. message MutateCustomAudienceResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomAudience" + }]; } diff --git a/google/ads/googleads/v9/services/custom_conversion_goal_service.proto b/google/ads/googleads/v12/services/custom_conversion_goal_service.proto similarity index 72% rename from google/ads/googleads/v9/services/custom_conversion_goal_service.proto rename to google/ads/googleads/v12/services/custom_conversion_goal_service.proto index 8eaa40bec..9772b2501 100644 --- a/google/ads/googleads/v9/services/custom_conversion_goal_service.proto +++ b/google/ads/googleads/v12/services/custom_conversion_goal_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/custom_conversion_goal.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomConversionGoalServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomConversionGoal service. @@ -43,7 +44,7 @@ service CustomConversionGoalService { // are returned. rpc MutateCustomConversionGoals(MutateCustomConversionGoalsRequest) returns (MutateCustomConversionGoalsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customConversionGoals:mutate" + post: "/v12/customers/{customer_id=*}/customConversionGoals:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service CustomConversionGoalService { } // Request message for -// [CustomConversionGoalService.MutateCustomConversionGoals][google.ads.googleads.v9.services.CustomConversionGoalService.MutateCustomConversionGoals]. +// [CustomConversionGoalService.MutateCustomConversionGoals][google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals]. message MutateCustomConversionGoalsRequest { // Required. The ID of the customer whose custom conversion goals are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -65,7 +66,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4; } // A single operation (create, remove) on a custom conversion goal. @@ -77,17 +78,19 @@ message CustomConversionGoalOperation { oneof operation { // Create operation: No resource name is expected for the new custom // conversion goal - google.ads.googleads.v9.resources.CustomConversionGoal create = 1; + google.ads.googleads.v12.resources.CustomConversionGoal create = 1; // Update operation: The custom conversion goal is expected to have a // valid resource name. - google.ads.googleads.v9.resources.CustomConversionGoal update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomConversionGoal" + }]; } } @@ -100,10 +103,12 @@ message MutateCustomConversionGoalsResponse { // The result for the custom conversion goal mutate. message MutateCustomConversionGoalResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomConversionGoal custom_conversion_goal = 2; + google.ads.googleads.v12.resources.CustomConversionGoal custom_conversion_goal = 2; } diff --git a/google/ads/googleads/v9/services/custom_interest_service.proto b/google/ads/googleads/v12/services/custom_interest_service.proto similarity index 65% rename from google/ads/googleads/v9/services/custom_interest_service.proto rename to google/ads/googleads/v12/services/custom_interest_service.proto index 4bb63934e..686e58ac2 100644 --- a/google/ads/googleads/v9/services/custom_interest_service.proto +++ b/google/ads/googleads/v12/services/custom_interest_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/custom_interest.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomInterestServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Custom Interest service. @@ -39,22 +39,6 @@ service CustomInterestService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested custom interest in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomInterest(GetCustomInterestRequest) returns (google.ads.googleads.v9.resources.CustomInterest) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customInterests/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates custom interests. Operation statuses are returned. // // List of thrown errors: @@ -71,25 +55,14 @@ service CustomInterestService { // [StringLengthError]() rpc MutateCustomInterests(MutateCustomInterestsRequest) returns (MutateCustomInterestsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customInterests:mutate" + post: "/v12/customers/{customer_id=*}/customInterests:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CustomInterestService.GetCustomInterest][google.ads.googleads.v9.services.CustomInterestService.GetCustomInterest]. -message GetCustomInterestRequest { - // Required. The resource name of the custom interest to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomInterest" - } - ]; -} - -// Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v9.services.CustomInterestService.MutateCustomInterests]. +// Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v12.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]; @@ -111,11 +84,11 @@ message CustomInterestOperation { oneof operation { // Create operation: No resource name is expected for the new custom // interest. - google.ads.googleads.v9.resources.CustomInterest create = 1; + google.ads.googleads.v12.resources.CustomInterest create = 1; // Update operation: The custom interest is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CustomInterest update = 2; + google.ads.googleads.v12.resources.CustomInterest update = 2; } } @@ -128,5 +101,7 @@ message MutateCustomInterestsResponse { // The result for the custom interest mutate. message MutateCustomInterestResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomInterest" + }]; } diff --git a/google/ads/googleads/v9/services/customer_asset_service.proto b/google/ads/googleads/v12/services/customer_asset_service.proto similarity index 67% rename from google/ads/googleads/v9/services/customer_asset_service.proto rename to google/ads/googleads/v12/services/customer_asset_service.proto index 0872691b2..c00bf60d3 100644 --- a/google/ads/googleads/v9/services/customer_asset_service.proto +++ b/google/ads/googleads/v12/services/customer_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer_asset.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerAssetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerAsset service. @@ -41,22 +41,6 @@ service CustomerAssetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested customer asset in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerAsset(GetCustomerAssetRequest) returns (google.ads.googleads.v9.resources.CustomerAsset) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerAssets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes customer assets. Operation statuses are // returned. // @@ -72,25 +56,14 @@ service CustomerAssetService { // [RequestError]() rpc MutateCustomerAssets(MutateCustomerAssetsRequest) returns (MutateCustomerAssetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerAssets:mutate" + post: "/v12/customers/{customer_id=*}/customerAssets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CustomerAssetService.GetCustomerAsset][google.ads.googleads.v9.services.CustomerAssetService.GetCustomerAsset]. -message GetCustomerAssetRequest { - // Required. The resource name of the customer asset to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerAsset" - } - ]; -} - -// Request message for [CustomerAssetService.MutateCustomerAssets][google.ads.googleads.v9.services.CustomerAssetService.MutateCustomerAssets]. +// Request message for [CustomerAssetService.MutateCustomerAssets][google.ads.googleads.v12.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]; @@ -110,7 +83,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a customer asset. @@ -122,17 +95,19 @@ message CustomerAssetOperation { oneof operation { // Create operation: No resource name is expected for the new customer // asset. - google.ads.googleads.v9.resources.CustomerAsset create = 1; + google.ads.googleads.v12.resources.CustomerAsset create = 1; // Update operation: The customer asset is expected to have a valid resource // name. - google.ads.googleads.v9.resources.CustomerAsset update = 3; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerAsset" + }]; } } @@ -140,8 +115,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. @@ -151,10 +126,12 @@ message MutateCustomerAssetsResponse { // The result for the customer asset mutate. message MutateCustomerAssetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomerAsset customer_asset = 2; + google.ads.googleads.v12.resources.CustomerAsset customer_asset = 2; } diff --git a/google/ads/googleads/v12/services/customer_asset_set_service.proto b/google/ads/googleads/v12/services/customer_asset_set_service.proto new file mode 100644 index 000000000..8afb43f0c --- /dev/null +++ b/google/ads/googleads/v12/services/customer_asset_set_service.proto @@ -0,0 +1,117 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "CustomerAssetSetServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::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: "/v12/customers/{customer_id=*}/customerAssetSets:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for [CustomerAssetSetService.MutateCustomerAssetSets][google.ads.googleads.v12.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.v12.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.v12.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.v12.resources.CustomerAssetSet customer_asset_set = 2; +} diff --git a/google/ads/googleads/v9/services/customer_client_link_service.proto b/google/ads/googleads/v12/services/customer_client_link_service.proto similarity index 65% rename from google/ads/googleads/v9/services/customer_client_link_service.proto rename to google/ads/googleads/v12/services/customer_client_link_service.proto index bd35ff246..1eac2d10d 100644 --- a/google/ads/googleads/v9/services/customer_client_link_service.proto +++ b/google/ads/googleads/v12/services/customer_client_link_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. @@ -14,45 +14,29 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_client_link.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerClientLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to manage customer client links. service CustomerClientLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested CustomerClientLink in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerClientLink(GetCustomerClientLinkRequest) returns (google.ads.googleads.v9.resources.CustomerClientLink) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerClientLinks/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates a customer client link. Operation statuses are returned. // // List of thrown errors: @@ -70,25 +54,14 @@ service CustomerClientLinkService { // [RequestError]() rpc MutateCustomerClientLink(MutateCustomerClientLinkRequest) returns (MutateCustomerClientLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerClientLinks:mutate" + post: "/v12/customers/{customer_id=*}/customerClientLinks:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for [CustomerClientLinkService.GetCustomerClientLink][google.ads.googleads.v9.services.CustomerClientLinkService.GetCustomerClientLink]. -message GetCustomerClientLinkRequest { - // Required. The resource name of the customer client link to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerClientLink" - } - ]; -} - -// Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v9.services.CustomerClientLinkService.MutateCustomerClientLink]. +// Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v12.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]; @@ -109,10 +82,10 @@ message CustomerClientLinkOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new link. - google.ads.googleads.v9.resources.CustomerClientLink create = 1; + google.ads.googleads.v12.resources.CustomerClientLink create = 1; // Update operation: The link is expected to have a valid resource name. - google.ads.googleads.v9.resources.CustomerClientLink update = 2; + google.ads.googleads.v12.resources.CustomerClientLink update = 2; } } @@ -125,5 +98,7 @@ message MutateCustomerClientLinkResponse { // The result for a single customer client link mutate. message MutateCustomerClientLinkResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerClientLink" + }]; } diff --git a/google/ads/googleads/v9/services/customer_conversion_goal_service.proto b/google/ads/googleads/v12/services/customer_conversion_goal_service.proto similarity index 76% rename from google/ads/googleads/v9/services/customer_conversion_goal_service.proto rename to google/ads/googleads/v12/services/customer_conversion_goal_service.proto index 656da7113..790085ab4 100644 --- a/google/ads/googleads/v9/services/customer_conversion_goal_service.proto +++ b/google/ads/googleads/v12/services/customer_conversion_goal_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. @@ -14,22 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_conversion_goal.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerConversionGoalServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerConversionGoal service. @@ -42,7 +43,7 @@ service CustomerConversionGoalService { // are returned. rpc MutateCustomerConversionGoals(MutateCustomerConversionGoalsRequest) returns (MutateCustomerConversionGoalsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerConversionGoals:mutate" + post: "/v12/customers/{customer_id=*}/customerConversionGoals:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -50,7 +51,7 @@ service CustomerConversionGoalService { } // Request message for -// [CustomerConversionGoalService.MutateCustomerConversionGoals][google.ads.googleads.v9.services.CustomerConversionGoalService.MutateCustomerConversionGoals]. +// [CustomerConversionGoalService.MutateCustomerConversionGoals][google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals]. message MutateCustomerConversionGoalsRequest { // Required. The ID of the customer whose customer conversion goals are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -72,7 +73,7 @@ message CustomerConversionGoalOperation { oneof operation { // Update operation: The customer conversion goal is expected to have a // valid resource name. - google.ads.googleads.v9.resources.CustomerConversionGoal update = 1; + google.ads.googleads.v12.resources.CustomerConversionGoal update = 1; } } @@ -85,5 +86,7 @@ message MutateCustomerConversionGoalsResponse { // The result for the customer conversion goal mutate. message MutateCustomerConversionGoalResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerConversionGoal" + }]; } diff --git a/google/ads/googleads/v9/services/customer_customizer_service.proto b/google/ads/googleads/v12/services/customer_customizer_service.proto similarity index 72% rename from google/ads/googleads/v9/services/customer_customizer_service.proto rename to google/ads/googleads/v12/services/customer_customizer_service.proto index 89cf41115..f1b3eb200 100644 --- a/google/ads/googleads/v9/services/customer_customizer_service.proto +++ b/google/ads/googleads/v12/services/customer_customizer_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. @@ -14,23 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer_customizer.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerCustomizerServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerCustomizer service. @@ -43,7 +44,7 @@ service CustomerCustomizerService { // returned. rpc MutateCustomerCustomizers(MutateCustomerCustomizersRequest) returns (MutateCustomerCustomizersResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/CustomerCustomizers:mutate" + post: "/v12/customers/{customer_id=*}/CustomerCustomizers:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -51,7 +52,7 @@ service CustomerCustomizerService { } // Request message for -// [CustomerCustomizerService.MutateCustomerCustomizers][google.ads.googleads.v9.services.CustomerCustomizerService.MutateCustomerCustomizers]. +// [CustomerCustomizerService.MutateCustomerCustomizers][google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers]. message MutateCustomerCustomizersRequest { // Required. The ID of the customer whose customer customizers are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -71,7 +72,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an customizer attribute. @@ -80,12 +81,14 @@ message CustomerCustomizerOperation { oneof operation { // Create operation: No resource name is expected for the new customer // customizer - google.ads.googleads.v9.resources.CustomerCustomizer create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerCustomizer" + }]; } } @@ -96,18 +99,20 @@ message MutateCustomerCustomizersResponse { // 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; } // The result for the customizer attribute mutate. message MutateCustomerCustomizerResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomerCustomizer customer_customizer = 2; + google.ads.googleads.v12.resources.CustomerCustomizer customer_customizer = 2; } diff --git a/google/ads/googleads/v9/services/customer_extension_setting_service.proto b/google/ads/googleads/v12/services/customer_extension_setting_service.proto similarity index 68% rename from google/ads/googleads/v9/services/customer_extension_setting_service.proto rename to google/ads/googleads/v12/services/customer_extension_setting_service.proto index 61350b9fe..3345b82b4 100644 --- a/google/ads/googleads/v9/services/customer_extension_setting_service.proto +++ b/google/ads/googleads/v12/services/customer_extension_setting_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer_extension_setting.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerExtensionSettingServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerExtensionSetting service. @@ -41,22 +41,6 @@ service CustomerExtensionSettingService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested customer extension setting in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerExtensionSetting(GetCustomerExtensionSettingRequest) returns (google.ads.googleads.v9.resources.CustomerExtensionSetting) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerExtensionSettings/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes customer extension settings. Operation // statuses are returned. // @@ -88,7 +72,7 @@ service CustomerExtensionSettingService { // [UrlFieldError]() rpc MutateCustomerExtensionSettings(MutateCustomerExtensionSettingsRequest) returns (MutateCustomerExtensionSettingsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerExtensionSettings:mutate" + post: "/v12/customers/{customer_id=*}/customerExtensionSettings:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -96,19 +80,7 @@ service CustomerExtensionSettingService { } // Request message for -// [CustomerExtensionSettingService.GetCustomerExtensionSetting][google.ads.googleads.v9.services.CustomerExtensionSettingService.GetCustomerExtensionSetting]. -message GetCustomerExtensionSettingRequest { - // Required. The resource name of the customer extension setting to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerExtensionSetting" - } - ]; -} - -// Request message for -// [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v9.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings]. +// [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings]. message MutateCustomerExtensionSettingsRequest { // Required. The ID of the customer whose customer extension settings are being // modified. @@ -130,7 +102,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a customer extension setting. @@ -142,17 +114,19 @@ message CustomerExtensionSettingOperation { oneof operation { // Create operation: No resource name is expected for the new customer // extension setting. - google.ads.googleads.v9.resources.CustomerExtensionSetting create = 1; + google.ads.googleads.v12.resources.CustomerExtensionSetting create = 1; // Update operation: The customer extension setting is expected to have a // valid resource name. - google.ads.googleads.v9.resources.CustomerExtensionSetting update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerExtensionSetting" + }]; } } @@ -160,8 +134,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. @@ -171,10 +145,12 @@ message MutateCustomerExtensionSettingsResponse { // The result for the customer extension setting mutate. message MutateCustomerExtensionSettingResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomerExtensionSetting customer_extension_setting = 2; + google.ads.googleads.v12.resources.CustomerExtensionSetting customer_extension_setting = 2; } diff --git a/google/ads/googleads/v9/services/customer_feed_service.proto b/google/ads/googleads/v12/services/customer_feed_service.proto similarity index 68% rename from google/ads/googleads/v9/services/customer_feed_service.proto rename to google/ads/googleads/v12/services/customer_feed_service.proto index cdd9a0d55..7160157d9 100644 --- a/google/ads/googleads/v9/services/customer_feed_service.proto +++ b/google/ads/googleads/v12/services/customer_feed_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer_feed.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerFeedServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerFeed service. @@ -41,22 +41,6 @@ service CustomerFeedService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested customer feed in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerFeed(GetCustomerFeedRequest) returns (google.ads.googleads.v9.resources.CustomerFeed) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerFeeds/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes customer feeds. Operation statuses are // returned. // @@ -85,25 +69,14 @@ service CustomerFeedService { // [StringLengthError]() rpc MutateCustomerFeeds(MutateCustomerFeedsRequest) returns (MutateCustomerFeedsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerFeeds:mutate" + post: "/v12/customers/{customer_id=*}/customerFeeds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CustomerFeedService.GetCustomerFeed][google.ads.googleads.v9.services.CustomerFeedService.GetCustomerFeed]. -message GetCustomerFeedRequest { - // Required. The resource name of the customer feed to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerFeed" - } - ]; -} - -// Request message for [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v9.services.CustomerFeedService.MutateCustomerFeeds]. +// Request message for [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v12.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]; @@ -123,7 +96,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on a customer feed. @@ -134,17 +107,19 @@ message CustomerFeedOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new customer feed. - google.ads.googleads.v9.resources.CustomerFeed create = 1; + google.ads.googleads.v12.resources.CustomerFeed create = 1; // Update operation: The customer feed is expected to have a valid resource // name. - google.ads.googleads.v9.resources.CustomerFeed update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerFeed" + }]; } } @@ -152,8 +127,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. @@ -163,10 +138,12 @@ message MutateCustomerFeedsResponse { // The result for the customer feed mutate. message MutateCustomerFeedResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomerFeed customer_feed = 2; + google.ads.googleads.v12.resources.CustomerFeed customer_feed = 2; } diff --git a/google/ads/googleads/v9/services/customer_label_service.proto b/google/ads/googleads/v12/services/customer_label_service.proto similarity index 67% rename from google/ads/googleads/v9/services/customer_label_service.proto rename to google/ads/googleads/v12/services/customer_label_service.proto index c19a19938..1fb87f008 100644 --- a/google/ads/googleads/v9/services/customer_label_service.proto +++ b/google/ads/googleads/v12/services/customer_label_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_label.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerLabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Customer Label service. @@ -39,22 +39,6 @@ service CustomerLabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested customer-label relationship in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerLabel(GetCustomerLabelRequest) returns (google.ads.googleads.v9.resources.CustomerLabel) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerLabels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates and removes customer-label relationships. // Operation statuses are returned. // @@ -70,25 +54,14 @@ service CustomerLabelService { // [RequestError]() rpc MutateCustomerLabels(MutateCustomerLabelsRequest) returns (MutateCustomerLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerLabels:mutate" + post: "/v12/customers/{customer_id=*}/customerLabels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [CustomerLabelService.GetCustomerLabel][google.ads.googleads.v9.services.CustomerLabelService.GetCustomerLabel]. -message GetCustomerLabelRequest { - // Required. The resource name of the customer-label relationship to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerLabel" - } - ]; -} - -// Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v9.services.CustomerLabelService.MutateCustomerLabels]. +// Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels]. message MutateCustomerLabelsRequest { // Required. ID of the customer whose customer-label relationships are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -113,13 +86,15 @@ message CustomerLabelOperation { oneof operation { // Create operation: No resource name is expected for the new customer-label // relationship. - google.ads.googleads.v9.resources.CustomerLabel create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerLabel" + }]; } } @@ -127,8 +102,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. @@ -138,5 +113,7 @@ message MutateCustomerLabelsResponse { // The result for a customer label mutate. message MutateCustomerLabelResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerLabel" + }]; } diff --git a/google/ads/googleads/v9/services/customer_manager_link_service.proto b/google/ads/googleads/v12/services/customer_manager_link_service.proto similarity index 72% rename from google/ads/googleads/v9/services/customer_manager_link_service.proto rename to google/ads/googleads/v12/services/customer_manager_link_service.proto index 70df4c0af..f9481dddc 100644 --- a/google/ads/googleads/v9/services/customer_manager_link_service.proto +++ b/google/ads/googleads/v12/services/customer_manager_link_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. @@ -14,46 +14,30 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_manager_link.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerManagerLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to manage customer-manager links. service CustomerManagerLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested CustomerManagerLink in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerManagerLink(GetCustomerManagerLinkRequest) returns (google.ads.googleads.v9.resources.CustomerManagerLink) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerManagerLinks/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - - // Creates or updates customer manager links. Operation statuses are returned. + // Updates customer manager links. Operation statuses are returned. // // List of thrown errors: // [AuthenticationError]() @@ -69,7 +53,7 @@ service CustomerManagerLinkService { // [RequestError]() rpc MutateCustomerManagerLink(MutateCustomerManagerLinkRequest) returns (MutateCustomerManagerLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerManagerLinks:mutate" + post: "/v12/customers/{customer_id=*}/customerManagerLinks:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -77,7 +61,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). // @@ -93,25 +77,14 @@ service CustomerManagerLinkService { // [RequestError]() rpc MoveManagerLink(MoveManagerLinkRequest) returns (MoveManagerLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerManagerLinks:moveManagerLink" + post: "/v12/customers/{customer_id=*}/customerManagerLinks:moveManagerLink" body: "*" }; option (google.api.method_signature) = "customer_id,previous_customer_manager_link,new_manager"; } } -// Request message for [CustomerManagerLinkService.GetCustomerManagerLink][google.ads.googleads.v9.services.CustomerManagerLinkService.GetCustomerManagerLink]. -message GetCustomerManagerLinkRequest { - // Required. The resource name of the CustomerManagerLink to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerManagerLink" - } - ]; -} - -// Request message for [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v9.services.CustomerManagerLinkService.MutateCustomerManagerLink]. +// Request message for [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink]. message MutateCustomerManagerLinkRequest { // Required. The ID of the customer whose customer manager links are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -124,7 +97,7 @@ message MutateCustomerManagerLinkRequest { bool validate_only = 3; } -// Request message for [CustomerManagerLinkService.MoveManagerLink][google.ads.googleads.v9.services.CustomerManagerLinkService.MoveManagerLink]. +// Request message for [CustomerManagerLinkService.MoveManagerLink][google.ads.googleads.v12.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]; @@ -155,7 +128,7 @@ message CustomerManagerLinkOperation { // The mutate operation. oneof operation { // Update operation: The link is expected to have a valid resource name. - google.ads.googleads.v9.resources.CustomerManagerLink update = 2; + google.ads.googleads.v12.resources.CustomerManagerLink update = 2; } } @@ -170,11 +143,15 @@ message MoveManagerLinkResponse { // Returned for successful operations. Represents a CustomerManagerLink // resource of the newly created link between client customer and new manager // customer. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerManagerLink" + }]; } // The result for the customer manager link mutate. message MutateCustomerManagerLinkResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerManagerLink" + }]; } diff --git a/google/ads/googleads/v9/services/customer_negative_criterion_service.proto b/google/ads/googleads/v12/services/customer_negative_criterion_service.proto similarity index 64% rename from google/ads/googleads/v9/services/customer_negative_criterion_service.proto rename to google/ads/googleads/v12/services/customer_negative_criterion_service.proto index 2ab4ee6fe..2261e442b 100644 --- a/google/ads/googleads/v9/services/customer_negative_criterion_service.proto +++ b/google/ads/googleads/v12/services/customer_negative_criterion_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer_negative_criterion.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerNegativeCriterionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Customer Negative Criterion service. @@ -40,22 +40,6 @@ service CustomerNegativeCriterionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested criterion in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerNegativeCriterion(GetCustomerNegativeCriterionRequest) returns (google.ads.googleads.v9.resources.CustomerNegativeCriterion) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerNegativeCriteria/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes criteria. Operation statuses are returned. // // List of thrown errors: @@ -71,7 +55,7 @@ service CustomerNegativeCriterionService { // [RequestError]() rpc MutateCustomerNegativeCriteria(MutateCustomerNegativeCriteriaRequest) returns (MutateCustomerNegativeCriteriaResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerNegativeCriteria:mutate" + post: "/v12/customers/{customer_id=*}/customerNegativeCriteria:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -79,19 +63,7 @@ service CustomerNegativeCriterionService { } // Request message for -// [CustomerNegativeCriterionService.GetCustomerNegativeCriterion][google.ads.googleads.v9.services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion]. -message GetCustomerNegativeCriterionRequest { - // Required. The resource name of the criterion to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerNegativeCriterion" - } - ]; -} - -// Request message for -// [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v9.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria]. +// [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v12.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]; @@ -111,7 +83,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create or remove) on a customer level negative criterion. @@ -119,13 +91,15 @@ message CustomerNegativeCriterionOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new criterion. - google.ads.googleads.v9.resources.CustomerNegativeCriterion create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerNegativeCriterion" + }]; } } @@ -133,8 +107,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. @@ -144,9 +118,11 @@ message MutateCustomerNegativeCriteriaResponse { // The result for the criterion mutate. message MutateCustomerNegativeCriteriaResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomerNegativeCriterion customer_negative_criterion = 2; + google.ads.googleads.v12.resources.CustomerNegativeCriterion customer_negative_criterion = 2; } diff --git a/google/ads/googleads/v9/services/customer_service.proto b/google/ads/googleads/v12/services/customer_service.proto similarity index 70% rename from google/ads/googleads/v9/services/customer_service.proto rename to google/ads/googleads/v12/services/customer_service.proto index 36d0a2dde..2d3bbbc47 100644 --- a/google/ads/googleads/v9/services/customer_service.proto +++ b/google/ads/googleads/v12/services/customer_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. @@ -14,25 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/access_role.proto"; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customer.proto"; +import "google/ads/googleads/v12/enums/access_role.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Customer service. @@ -41,22 +41,6 @@ service CustomerService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested customer in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomer(GetCustomerRequest) returns (google.ads.googleads.v9.resources.Customer) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Updates a customer. Operation statuses are returned. // // List of thrown errors: @@ -71,7 +55,7 @@ service CustomerService { // [UrlFieldError]() rpc MutateCustomer(MutateCustomerRequest) returns (MutateCustomerResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:mutate" + post: "/v12/customers/{customer_id=*}:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; @@ -89,7 +73,7 @@ service CustomerService { // [RequestError]() rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse) { option (google.api.http) = { - get: "/v9/customers:listAccessibleCustomers" + get: "/v12/customers:listAccessibleCustomers" }; } @@ -109,25 +93,14 @@ service CustomerService { // [TimeZoneError]() rpc CreateCustomerClient(CreateCustomerClientRequest) returns (CreateCustomerClientResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:createCustomerClient" + post: "/v12/customers/{customer_id=*}:createCustomerClient" body: "*" }; option (google.api.method_signature) = "customer_id,customer_client"; } } -// Request message for [CustomerService.GetCustomer][google.ads.googleads.v9.services.CustomerService.GetCustomer]. -message GetCustomerRequest { - // Required. The resource name of the customer to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Customer" - } - ]; -} - -// Request message for [CustomerService.MutateCustomer][google.ads.googleads.v9.services.CustomerService.MutateCustomer]. +// Request message for [CustomerService.MutateCustomer][google.ads.googleads.v12.services.CustomerService.MutateCustomer]. message MutateCustomerRequest { // Required. The ID of the customer being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -141,17 +114,17 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 6; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 6; } -// Request message for [CustomerService.CreateCustomerClient][google.ads.googleads.v9.services.CustomerService.CreateCustomerClient]. +// Request message for [CustomerService.CreateCustomerClient][google.ads.googleads.v12.services.CustomerService.CreateCustomerClient]. message CreateCustomerClientRequest { // 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.v9.resources.Customer customer_client = 2 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.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. @@ -159,7 +132,7 @@ message CreateCustomerClientRequest { // The proposed role of user on the created client customer. // Accessible only to customers on the allow-list. - google.ads.googleads.v9.enums.AccessRoleEnum.AccessRole access_role = 4; + google.ads.googleads.v12.enums.AccessRoleEnum.AccessRole access_role = 4; // If true, the request is validated but not executed. Only errors are // returned, not results. @@ -169,7 +142,7 @@ message CreateCustomerClientRequest { // A single update on a customer. message CustomerOperation { // Mutate operation. Only updates are supported for customer. - google.ads.googleads.v9.resources.Customer update = 1; + google.ads.googleads.v12.resources.Customer update = 1; // FieldMask that determines which resource fields are modified in an update. google.protobuf.FieldMask update_mask = 2; @@ -177,8 +150,11 @@ message CustomerOperation { // Response message for CreateCustomerClient mutate. message CreateCustomerClientResponse { - // The resource name of the newly created customer client. - string resource_name = 2; + // 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" + }]; // Link for inviting user to access the created customer. Accessible to // allowlisted customers only. @@ -194,19 +170,21 @@ message MutateCustomerResponse { // The result for the customer mutate. message MutateCustomerResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.Customer customer = 2; + google.ads.googleads.v12.resources.Customer customer = 2; } -// Request message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v9.services.CustomerService.ListAccessibleCustomers]. +// Request message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v12.services.CustomerService.ListAccessibleCustomers]. message ListAccessibleCustomersRequest { } -// Response message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v9.services.CustomerService.ListAccessibleCustomers]. +// Response message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v12.services.CustomerService.ListAccessibleCustomers]. message ListAccessibleCustomersResponse { // Resource name of customers directly accessible by the // user authenticating the call. diff --git a/google/ads/googleads/v9/services/customer_user_access_invitation_service.proto b/google/ads/googleads/v12/services/customer_user_access_invitation_service.proto similarity index 65% rename from google/ads/googleads/v9/services/customer_user_access_invitation_service.proto rename to google/ads/googleads/v12/services/customer_user_access_invitation_service.proto index 01c9cdbc7..9e0e96c72 100644 --- a/google/ads/googleads/v9/services/customer_user_access_invitation_service.proto +++ b/google/ads/googleads/v12/services/customer_user_access_invitation_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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_user_access_invitation.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerUserAccessInvitationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomerUserAccessInvitation service. @@ -39,22 +39,6 @@ service CustomerUserAccessInvitationService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested access invitation in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerUserAccessInvitation(GetCustomerUserAccessInvitationRequest) returns (google.ads.googleads.v9.resources.CustomerUserAccessInvitation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerUserAccessInvitations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes an access invitation. // // List of thrown errors: @@ -67,25 +51,13 @@ service CustomerUserAccessInvitationService { // [RequestError]() rpc MutateCustomerUserAccessInvitation(MutateCustomerUserAccessInvitationRequest) returns (MutateCustomerUserAccessInvitationResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerUserAccessInvitations:mutate" + post: "/v12/customers/{customer_id=*}/customerUserAccessInvitations:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for -// [CustomerUserAccessInvitation.GetCustomerUserAccessInvitation][] -message GetCustomerUserAccessInvitationRequest { - // Required. Resource name of the access invitation. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerUserAccessInvitation" - } - ]; -} - // Request message for // [CustomerUserAccessInvitation.MutateCustomerUserAccessInvitation][] message MutateCustomerUserAccessInvitationRequest { @@ -102,13 +74,15 @@ message CustomerUserAccessInvitationOperation { oneof operation { // Create operation: No resource name is expected for the new access // invitation. - google.ads.googleads.v9.resources.CustomerUserAccessInvitation create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerUserAccessInvitation" + }]; } } @@ -121,5 +95,7 @@ message MutateCustomerUserAccessInvitationResponse { // The result for the access invitation mutate. message MutateCustomerUserAccessInvitationResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerUserAccessInvitation" + }]; } diff --git a/google/ads/googleads/v9/services/customer_user_access_service.proto b/google/ads/googleads/v12/services/customer_user_access_service.proto similarity index 65% rename from google/ads/googleads/v9/services/customer_user_access_service.proto rename to google/ads/googleads/v12/services/customer_user_access_service.proto index 0b83b3f26..637787fe0 100644 --- a/google/ads/googleads/v9/services/customer_user_access_service.proto +++ b/google/ads/googleads/v12/services/customer_user_access_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. @@ -14,45 +14,29 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/customer_user_access.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerUserAccessServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // This service manages the permissions of a user on a given customer. service CustomerUserAccessService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the CustomerUserAccess in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerUserAccess(GetCustomerUserAccessRequest) returns (google.ads.googleads.v9.resources.CustomerUserAccess) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerUserAccesses/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Updates, removes permission of a user on a given customer. Operation // statuses are returned. // @@ -68,27 +52,15 @@ service CustomerUserAccessService { // [RequestError]() rpc MutateCustomerUserAccess(MutateCustomerUserAccessRequest) returns (MutateCustomerUserAccessResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customerUserAccesses:mutate" + post: "/v12/customers/{customer_id=*}/customerUserAccesses:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for -// [CustomerUserAccessService.GetCustomerUserAccess][google.ads.googleads.v9.services.CustomerUserAccessService.GetCustomerUserAccess]. -message GetCustomerUserAccessRequest { - // Required. Resource name of the customer user access. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerUserAccess" - } - ]; -} - // Mutate Request for -// [CustomerUserAccessService.MutateCustomerUserAccess][google.ads.googleads.v9.services.CustomerUserAccessService.MutateCustomerUserAccess]. +// [CustomerUserAccessService.MutateCustomerUserAccess][google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess]. message MutateCustomerUserAccessRequest { // Required. The ID of the customer being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -106,13 +78,15 @@ message CustomerUserAccessOperation { oneof operation { // Update operation: The customer user access is expected to have a valid // resource name. - google.ads.googleads.v9.resources.CustomerUserAccess update = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerUserAccess" + }]; } } @@ -125,5 +99,7 @@ message MutateCustomerUserAccessResponse { // The result for the customer user access mutate. message MutateCustomerUserAccessResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomerUserAccess" + }]; } diff --git a/google/ads/googleads/v9/services/customizer_attribute_service.proto b/google/ads/googleads/v12/services/customizer_attribute_service.proto similarity index 73% rename from google/ads/googleads/v9/services/customizer_attribute_service.proto rename to google/ads/googleads/v12/services/customizer_attribute_service.proto index db878c6e5..8f30e993d 100644 --- a/google/ads/googleads/v9/services/customizer_attribute_service.proto +++ b/google/ads/googleads/v12/services/customizer_attribute_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. @@ -14,24 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/customizer_attribute.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/customizer_attribute.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomizerAttributeServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the CustomizerAttribute service. @@ -44,7 +45,7 @@ service CustomizerAttributeService { // returned. rpc MutateCustomizerAttributes(MutateCustomizerAttributesRequest) returns (MutateCustomizerAttributesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/customizerAttributes:mutate" + post: "/v12/customers/{customer_id=*}/customizerAttributes:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -52,7 +53,7 @@ service CustomizerAttributeService { } // Request message for -// [CustomizerAttributeService.MutateCustomizerAttributes][google.ads.googleads.v9.services.CustomizerAttributeService.MutateCustomizerAttributes]. +// [CustomizerAttributeService.MutateCustomizerAttributes][google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes]. message MutateCustomizerAttributesRequest { // Required. The ID of the customer whose customizer attributes are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -72,7 +73,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an customizer attribute. @@ -84,12 +85,14 @@ message CustomizerAttributeOperation { oneof operation { // Create operation: No resource name is expected for the new customizer // attribute - google.ads.googleads.v9.resources.CustomizerAttribute create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/CustomizerAttribute" + }]; } } @@ -100,18 +103,20 @@ message MutateCustomizerAttributesResponse { // 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; } // The result for the customizer attribute mutate. message MutateCustomizerAttributeResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.CustomizerAttribute customizer_attribute = 2; + google.ads.googleads.v12.resources.CustomizerAttribute customizer_attribute = 2; } diff --git a/google/ads/googleads/v12/services/experiment_arm_service.proto b/google/ads/googleads/v12/services/experiment_arm_service.proto new file mode 100644 index 000000000..7fd0b4b67 --- /dev/null +++ b/google/ads/googleads/v12/services/experiment_arm_service.proto @@ -0,0 +1,134 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/experiment_arm.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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentArmServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the Experiment Arm service. + +// Service to manage experiment arms. +service ExperimentArmService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Creates, updates, or removes experiment arms. Operation statuses are + // returned. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [ExperimentArmError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc MutateExperimentArms(MutateExperimentArmsRequest) returns (MutateExperimentArmsResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}/experimentArms:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } +} + +// Request message for [ExperimentArmService.MutateExperimentArms][google.ads.googleads.v12.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]; + + // 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.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; +} + +// A single operation on an experiment arm. +message ExperimentArmOperation { + // FieldMask that determines which resource fields are modified in an update. + google.protobuf.FieldMask update_mask = 4; + + // The mutate operation. + oneof operation { + // Create operation + google.ads.googleads.v12.resources.ExperimentArm create = 1; + + // Update operation: The experiment arm is expected to have a valid + // resource name. + google.ads.googleads.v12.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" + }]; + } +} + +// Response message for experiment arm mutate. +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 (for example, auth + // errors), we return an RPC level error. + google.rpc.Status partial_failure_error = 1; + + // All results for the mutate. + repeated MutateExperimentArmResult results = 2; +} + +// The result for the experiment arm mutate. +message MutateExperimentArmResult { + // Returned for successful operations. + string resource_name = 1 [(google.api.resource_reference) = { + 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.v12.resources.ExperimentArm experiment_arm = 2; +} diff --git a/google/ads/googleads/v12/services/experiment_service.proto b/google/ads/googleads/v12/services/experiment_service.proto new file mode 100644 index 000000000..d68ab0001 --- /dev/null +++ b/google/ads/googleads/v12/services/experiment_service.proto @@ -0,0 +1,390 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/resources/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "ExperimentServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the Experiment service. + +// Service to manage experiments. +service ExperimentService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Creates, updates, or removes experiments. Operation statuses are returned. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [ExperimentError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc MutateExperiments(MutateExperimentsRequest) returns (MutateExperimentsResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}/experiments:mutate" + body: "*" + }; + option (google.api.method_signature) = "customer_id,operations"; + } + + // Immediately ends an 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]() + // [ExperimentError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc EndExperiment(EndExperimentRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post: "/v12/{experiment=customers/*/experiments/*}:endExperiment" + body: "*" + }; + option (google.api.method_signature) = "experiment"; + } + + // Returns all errors that occurred during the last Experiment update (either + // scheduling or promotion). + // Supports standard list paging. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc ListExperimentAsyncErrors(ListExperimentAsyncErrorsRequest) returns (ListExperimentAsyncErrorsResponse) { + option (google.api.http) = { + get: "/v12/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors" + }; + option (google.api.method_signature) = "resource_name"; + } + + // Graduates an experiment to a full campaign. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [ExperimentError]() + // [HeaderError]() + // [InternalError]() + // [MutateError]() + // [QuotaError]() + // [RequestError]() + rpc GraduateExperiment(GraduateExperimentRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post: "/v12/{experiment=customers/*/experiments/*}:graduateExperiment" + body: "*" + }; + option (google.api.method_signature) = "experiment,campaign_budget_mappings"; + } + + // Schedule an experiment. The in design campaign + // will be converted into a real campaign (called the experiment campaign) + // that will begin serving ads if successfully created. + // + // The experiment is scheduled immediately with status INITIALIZING. + // This method returns a long running operation that tracks the forking of the + // in design campaign. If the forking fails, a list of errors can be retrieved + // using the ListExperimentAsyncErrors method. The operation's + // metadata will be a string containing the resource name of the created + // experiment. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [ExperimentError]() + // [DatabaseError]() + // [DateError]() + // [DateRangeError]() + // [FieldError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RangeError]() + // [RequestError]() + rpc ScheduleExperiment(ScheduleExperimentRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v12/{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.v12.services.ScheduleExperimentMetadata" + }; + } + + // Promotes the trial campaign thus applying changes in the trial campaign + // to the base campaign. + // This method returns a long running operation that tracks the promotion of + // the experiment campaign. If it fails, a list of errors can be retrieved + // using the ListExperimentAsyncErrors method. The operation's + // metadata will be a string containing the resource name of the created + // experiment. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [ExperimentError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc PromoteExperiment(PromoteExperimentRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v12/{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.v12.services.PromoteExperimentMetadata" + }; + } +} + +// Request message for [ExperimentService.MutateExperiments][google.ads.googleads.v12.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]; + + // 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; +} + +// A single operation on an experiment. +message ExperimentOperation { + // FieldMask that determines which resource fields are modified in an update. + google.protobuf.FieldMask update_mask = 4; + + // The mutate operation. + oneof operation { + // Create operation + google.ads.googleads.v12.resources.Experiment create = 1; + + // Update operation: The experiment is expected to have a valid + // resource name. + google.ads.googleads.v12.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" + }]; + } +} + +// Response message for experiment mutate. +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 (for example, auth + // errors), we return an RPC level error. + google.rpc.Status partial_failure_error = 1; + + // All results for the mutate. + repeated MutateExperimentResult results = 2; +} + +// The result for the campaign experiment mutate. +message MutateExperimentResult { + // Returned for successful operations. + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + }]; +} + +// Request message for [ExperimentService.EndExperiment][google.ads.googleads.v12.services.ExperimentService.EndExperiment]. +message EndExperimentRequest { + // Required. The resource name of the campaign experiment to end. + string experiment = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; + + // If true, the request is validated but not executed. Only errors are + // returned, not results. + bool validate_only = 2; +} + +// Request message for +// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v12.services.ExperimentService.ListExperimentAsyncErrors]. +message ListExperimentAsyncErrorsRequest { + // Required. The name of the 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/Experiment" + } + ]; + + // 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. + // The maximum page size is 1000. + int32 page_size = 3; +} + +// Response message for +// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v12.services.ExperimentService.ListExperimentAsyncErrors]. +message ListExperimentAsyncErrorsResponse { + // 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; +} + +// Request message for [ExperimentService.GraduateExperiment][google.ads.googleads.v12.services.ExperimentService.GraduateExperiment]. +message GraduateExperimentRequest { + // Required. The experiment to be graduated. + string experiment = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; + + // 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]; + + // If true, the request is validated but not executed. Only errors are + // returned, not results. + bool validate_only = 3; +} + +// The mapping of experiment campaign and budget to be graduated. +message CampaignBudgetMapping { + // Required. The experiment campaign to graduate. + string experiment_campaign = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/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) = { + type: "googleads.googleapis.com/CampaignBudget" + } + ]; +} + +// Request message for [ExperimentService.ScheduleExperiment][google.ads.googleads.v12.services.ExperimentService.ScheduleExperiment]. +message ScheduleExperimentRequest { + // Required. The scheduled experiment. + string resource_name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; + + // If true, the request is validated but not executed. Only errors are + // returned, not results. + bool validate_only = 2; +} + +// The metadata of the scheduled experiment. +message ScheduleExperimentMetadata { + // Required. The scheduled experiment. + string experiment = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; +} + +// Request message for [ExperimentService.PromoteExperiment][google.ads.googleads.v12.services.ExperimentService.PromoteExperiment]. +message PromoteExperimentRequest { + // Required. The resource name of the experiment to promote. + string resource_name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; + + // If true, the request is validated but not executed. Only errors are + // returned, not results. + bool validate_only = 2; +} + +// The metadata of the promoted experiment. +message PromoteExperimentMetadata { + // Required. The promoted experiment. + string experiment = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/Experiment" + } + ]; +} diff --git a/google/ads/googleads/v9/services/extension_feed_item_service.proto b/google/ads/googleads/v12/services/extension_feed_item_service.proto similarity index 68% rename from google/ads/googleads/v9/services/extension_feed_item_service.proto rename to google/ads/googleads/v12/services/extension_feed_item_service.proto index 1186f7323..8bb8b73c3 100644 --- a/google/ads/googleads/v9/services/extension_feed_item_service.proto +++ b/google/ads/googleads/v12/services/extension_feed_item_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/extension_feed_item.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ExtensionFeedItemServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the ExtensionFeedItem service. @@ -41,22 +41,6 @@ service ExtensionFeedItemService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested extension feed item in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetExtensionFeedItem(GetExtensionFeedItemRequest) returns (google.ads.googleads.v9.resources.ExtensionFeedItem) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/extensionFeedItems/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes extension feed items. Operation // statuses are returned. // @@ -86,25 +70,14 @@ service ExtensionFeedItemService { // [UrlFieldError]() rpc MutateExtensionFeedItems(MutateExtensionFeedItemsRequest) returns (MutateExtensionFeedItemsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/extensionFeedItems:mutate" + post: "/v12/customers/{customer_id=*}/extensionFeedItems:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [ExtensionFeedItemService.GetExtensionFeedItem][google.ads.googleads.v9.services.ExtensionFeedItemService.GetExtensionFeedItem]. -message GetExtensionFeedItemRequest { - // Required. The resource name of the extension feed item to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ExtensionFeedItem" - } - ]; -} - -// Request message for [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v9.services.ExtensionFeedItemService.MutateExtensionFeedItems]. +// Request message for [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems]. message MutateExtensionFeedItemsRequest { // Required. The ID of the customer whose extension feed items are being // modified. @@ -125,7 +98,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an extension feed item. @@ -137,17 +110,19 @@ message ExtensionFeedItemOperation { oneof operation { // Create operation: No resource name is expected for the new extension // feed item. - google.ads.googleads.v9.resources.ExtensionFeedItem create = 1; + google.ads.googleads.v12.resources.ExtensionFeedItem create = 1; // Update operation: The extension feed item is expected to have a // valid resource name. - google.ads.googleads.v9.resources.ExtensionFeedItem update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/ExtensionFeedItem" + }]; } } @@ -155,8 +130,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. @@ -166,10 +141,12 @@ message MutateExtensionFeedItemsResponse { // The result for the extension feed item mutate. message MutateExtensionFeedItemResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.ExtensionFeedItem extension_feed_item = 2; + google.ads.googleads.v12.resources.ExtensionFeedItem extension_feed_item = 2; } diff --git a/google/ads/googleads/v9/services/feed_item_service.proto b/google/ads/googleads/v12/services/feed_item_service.proto similarity index 69% rename from google/ads/googleads/v9/services/feed_item_service.proto rename to google/ads/googleads/v12/services/feed_item_service.proto index a3cae8526..495205210 100644 --- a/google/ads/googleads/v9/services/feed_item_service.proto +++ b/google/ads/googleads/v12/services/feed_item_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/feed_item.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedItemServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the FeedItem service. @@ -41,22 +41,6 @@ service FeedItemService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed item in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedItem(GetFeedItemRequest) returns (google.ads.googleads.v9.resources.FeedItem) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedItems/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes feed items. Operation statuses are // returned. // @@ -88,25 +72,14 @@ service FeedItemService { // [UrlFieldError]() rpc MutateFeedItems(MutateFeedItemsRequest) returns (MutateFeedItemsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feedItems:mutate" + post: "/v12/customers/{customer_id=*}/feedItems:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedItemService.GetFeedItem][google.ads.googleads.v9.services.FeedItemService.GetFeedItem]. -message GetFeedItemRequest { - // Required. The resource name of the feed item to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedItem" - } - ]; -} - -// Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v9.services.FeedItemService.MutateFeedItems]. +// Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v12.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]; @@ -126,7 +99,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an feed item. @@ -137,17 +110,19 @@ message FeedItemOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new feed item. - google.ads.googleads.v9.resources.FeedItem create = 1; + google.ads.googleads.v12.resources.FeedItem create = 1; // Update operation: The feed item is expected to have a valid resource // name. - google.ads.googleads.v9.resources.FeedItem update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItem" + }]; } } @@ -155,8 +130,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. @@ -166,9 +141,11 @@ message MutateFeedItemsResponse { // The result for the feed item mutate. message MutateFeedItemResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.FeedItem feed_item = 2; + google.ads.googleads.v12.resources.FeedItem feed_item = 2; } diff --git a/google/ads/googleads/v9/services/feed_item_set_link_service.proto b/google/ads/googleads/v12/services/feed_item_set_link_service.proto similarity index 67% rename from google/ads/googleads/v9/services/feed_item_set_link_service.proto rename to google/ads/googleads/v12/services/feed_item_set_link_service.proto index e7797fb90..e18415a24 100644 --- a/google/ads/googleads/v9/services/feed_item_set_link_service.proto +++ b/google/ads/googleads/v12/services/feed_item_set_link_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/feed_item_set_link.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the FeedItemSetLink service. @@ -39,22 +39,6 @@ service FeedItemSetLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed item set link in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedItemSetLink(GetFeedItemSetLinkRequest) returns (google.ads.googleads.v9.resources.FeedItemSetLink) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedItemSetLinks/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes feed item set links. // // List of thrown errors: @@ -66,25 +50,14 @@ service FeedItemSetLinkService { // [RequestError]() rpc MutateFeedItemSetLinks(MutateFeedItemSetLinksRequest) returns (MutateFeedItemSetLinksResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feedItemSetLinks:mutate" + post: "/v12/customers/{customer_id=*}/feedItemSetLinks:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedItemSetLinkService.GetFeedItemSetLinks][]. -message GetFeedItemSetLinkRequest { - // Required. The resource name of the feed item set link to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedItemSetLink" - } - ]; -} - -// Request message for [FeedItemSetLinkService.MutateFeedItemSetLinks][google.ads.googleads.v9.services.FeedItemSetLinkService.MutateFeedItemSetLinks]. +// Request message for [FeedItemSetLinkService.MutateFeedItemSetLinks][google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks]. message MutateFeedItemSetLinksRequest { // Required. The ID of the customer whose feed item set links are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -109,13 +82,15 @@ message FeedItemSetLinkOperation { oneof operation { // Create operation: No resource name is expected for the // new feed item set link. - google.ads.googleads.v9.resources.FeedItemSetLink create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItemSetLink" + }]; } } @@ -126,13 +101,15 @@ 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; } // The result for the feed item set link mutate. message MutateFeedItemSetLinkResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItemSetLink" + }]; } diff --git a/google/ads/googleads/v9/services/feed_item_set_service.proto b/google/ads/googleads/v12/services/feed_item_set_service.proto similarity index 67% rename from google/ads/googleads/v9/services/feed_item_set_service.proto rename to google/ads/googleads/v12/services/feed_item_set_service.proto index 87e01b2a8..897968b24 100644 --- a/google/ads/googleads/v9/services/feed_item_set_service.proto +++ b/google/ads/googleads/v12/services/feed_item_set_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/feed_item_set.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedItemSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the FeedItemSet service. @@ -40,22 +40,6 @@ service FeedItemSetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed item set in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedItemSet(GetFeedItemSetRequest) returns (google.ads.googleads.v9.resources.FeedItemSet) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedItemSets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates or removes feed item sets. Operation statuses are // returned. // @@ -69,25 +53,14 @@ service FeedItemSetService { // [RequestError]() rpc MutateFeedItemSets(MutateFeedItemSetsRequest) returns (MutateFeedItemSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feedItemSets:mutate" + post: "/v12/customers/{customer_id=*}/feedItemSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedItemSetService.GetFeedItemSet][google.ads.googleads.v9.services.FeedItemSetService.GetFeedItemSet]. -message GetFeedItemSetRequest { - // Required. The resource name of the feed item set to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedItemSet" - } - ]; -} - -// Request message for [FeedItemSetService.MutateFeedItemSets][google.ads.googleads.v9.services.FeedItemSetService.MutateFeedItemSets]. +// Request message for [FeedItemSetService.MutateFeedItemSets][google.ads.googleads.v12.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]; @@ -114,16 +87,18 @@ message FeedItemSetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new feed item set - google.ads.googleads.v9.resources.FeedItemSet create = 1; + google.ads.googleads.v12.resources.FeedItemSet create = 1; // Update operation: The feed item set is expected to have a valid resource // name. - google.ads.googleads.v9.resources.FeedItemSet update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItemSet" + }]; } } @@ -134,13 +109,15 @@ 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; } // The result for the feed item set mutate. message MutateFeedItemSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItemSet" + }]; } diff --git a/google/ads/googleads/v9/services/feed_item_target_service.proto b/google/ads/googleads/v12/services/feed_item_target_service.proto similarity index 67% rename from google/ads/googleads/v9/services/feed_item_target_service.proto rename to google/ads/googleads/v12/services/feed_item_target_service.proto index 9d3647b09..c5e714568 100644 --- a/google/ads/googleads/v9/services/feed_item_target_service.proto +++ b/google/ads/googleads/v12/services/feed_item_target_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/feed_item_target.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedItemTargetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the FeedItemTarget service. @@ -40,22 +40,6 @@ service FeedItemTargetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed item targets in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedItemTarget(GetFeedItemTargetRequest) returns (google.ads.googleads.v9.resources.FeedItemTarget) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedItemTargets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes feed item targets. Operation statuses are returned. // // List of thrown errors: @@ -80,25 +64,14 @@ service FeedItemTargetService { // [StringLengthError]() rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feedItemTargets:mutate" + post: "/v12/customers/{customer_id=*}/feedItemTargets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedItemTargetService.GetFeedItemTarget][google.ads.googleads.v9.services.FeedItemTargetService.GetFeedItemTarget]. -message GetFeedItemTargetRequest { - // Required. The resource name of the feed item targets to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedItemTarget" - } - ]; -} - -// Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v9.services.FeedItemTargetService.MutateFeedItemTargets]. +// Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets]. message MutateFeedItemTargetsRequest { // Required. The ID of the customer whose feed item targets are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -114,7 +87,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; // If true, the request is validated but not executed. Only errors are // returned, not results. @@ -127,13 +100,15 @@ message FeedItemTargetOperation { oneof operation { // Create operation: No resource name is expected for the new feed item // target. - google.ads.googleads.v9.resources.FeedItemTarget create = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedItemTarget" + }]; } } @@ -141,8 +116,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. @@ -152,10 +127,12 @@ message MutateFeedItemTargetsResponse { // The result for the feed item target mutate. message MutateFeedItemTargetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.FeedItemTarget feed_item_target = 2; + google.ads.googleads.v12.resources.FeedItemTarget feed_item_target = 2; } diff --git a/google/ads/googleads/v9/services/feed_mapping_service.proto b/google/ads/googleads/v12/services/feed_mapping_service.proto similarity index 67% rename from google/ads/googleads/v9/services/feed_mapping_service.proto rename to google/ads/googleads/v12/services/feed_mapping_service.proto index 1e668132e..379d3794a 100644 --- a/google/ads/googleads/v9/services/feed_mapping_service.proto +++ b/google/ads/googleads/v12/services/feed_mapping_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/feed_mapping.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedMappingServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the FeedMapping service. @@ -40,22 +40,6 @@ service FeedMappingService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed mapping in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedMapping(GetFeedMappingRequest) returns (google.ads.googleads.v9.resources.FeedMapping) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedMappings/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes feed mappings. Operation statuses are // returned. // @@ -81,25 +65,14 @@ service FeedMappingService { // [StringLengthError]() rpc MutateFeedMappings(MutateFeedMappingsRequest) returns (MutateFeedMappingsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feedMappings:mutate" + post: "/v12/customers/{customer_id=*}/feedMappings:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedMappingService.GetFeedMapping][google.ads.googleads.v9.services.FeedMappingService.GetFeedMapping]. -message GetFeedMappingRequest { - // Required. The resource name of the feed mapping to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedMapping" - } - ]; -} - -// Request message for [FeedMappingService.MutateFeedMappings][google.ads.googleads.v9.services.FeedMappingService.MutateFeedMappings]. +// Request message for [FeedMappingService.MutateFeedMappings][google.ads.googleads.v12.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]; @@ -119,7 +92,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on a feed mapping. @@ -127,13 +100,15 @@ message FeedMappingOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new feed mapping. - google.ads.googleads.v9.resources.FeedMapping create = 1; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/FeedMapping" + }]; } } @@ -141,8 +116,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. @@ -152,10 +127,12 @@ message MutateFeedMappingsResponse { // The result for the feed mapping mutate. message MutateFeedMappingResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.FeedMapping feed_mapping = 2; + google.ads.googleads.v12.resources.FeedMapping feed_mapping = 2; } diff --git a/google/ads/googleads/v9/services/feed_service.proto b/google/ads/googleads/v12/services/feed_service.proto similarity index 70% rename from google/ads/googleads/v9/services/feed_service.proto rename to google/ads/googleads/v12/services/feed_service.proto index 9dc6f7e52..c83fb7665 100644 --- a/google/ads/googleads/v9/services/feed_service.proto +++ b/google/ads/googleads/v12/services/feed_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/feed.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "FeedServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Feed service. @@ -41,22 +41,6 @@ service FeedService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested feed in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeed(GetFeedRequest) returns (google.ads.googleads.v9.resources.Feed) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feeds/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes feeds. Operation statuses are // returned. // @@ -87,25 +71,14 @@ service FeedService { // [StringLengthError]() rpc MutateFeeds(MutateFeedsRequest) returns (MutateFeedsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/feeds:mutate" + post: "/v12/customers/{customer_id=*}/feeds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [FeedService.GetFeed][google.ads.googleads.v9.services.FeedService.GetFeed]. -message GetFeedRequest { - // Required. The resource name of the feed to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Feed" - } - ]; -} - -// Request message for [FeedService.MutateFeeds][google.ads.googleads.v9.services.FeedService.MutateFeeds]. +// Request message for [FeedService.MutateFeeds][google.ads.googleads.v12.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]; @@ -125,7 +98,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an feed. @@ -136,17 +109,19 @@ message FeedOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new feed. - google.ads.googleads.v9.resources.Feed create = 1; + google.ads.googleads.v12.resources.Feed create = 1; // Update operation: The feed is expected to have a valid resource // name. - google.ads.googleads.v9.resources.Feed update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Feed" + }]; } } @@ -154,8 +129,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. @@ -165,9 +140,11 @@ message MutateFeedsResponse { // The result for the feed mutate. message MutateFeedResult { // Returned for successful operations. - string resource_name = 1; + 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.v9.resources.Feed feed = 2; + google.ads.googleads.v12.resources.Feed feed = 2; } diff --git a/google/ads/googleads/v9/services/geo_target_constant_service.proto b/google/ads/googleads/v12/services/geo_target_constant_service.proto similarity index 65% rename from google/ads/googleads/v9/services/geo_target_constant_service.proto rename to google/ads/googleads/v12/services/geo_target_constant_service.proto index 000d67ef2..c3cb5cbca 100644 --- a/google/ads/googleads/v9/services/geo_target_constant_service.proto +++ b/google/ads/googleads/v12/services/geo_target_constant_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. @@ -14,22 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/geo_target_constant.proto"; +import "google/ads/googleads/v12/resources/geo_target_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "GeoTargetConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Geo target constant service. @@ -38,22 +36,6 @@ service GeoTargetConstantService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested geo target constant in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetGeoTargetConstant(GetGeoTargetConstantRequest) returns (google.ads.googleads.v9.resources.GeoTargetConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=geoTargetConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Returns GeoTargetConstant suggestions by location name or by resource name. // // List of thrown errors: @@ -66,25 +48,14 @@ service GeoTargetConstantService { // [RequestError]() rpc SuggestGeoTargetConstants(SuggestGeoTargetConstantsRequest) returns (SuggestGeoTargetConstantsResponse) { option (google.api.http) = { - post: "/v9/geoTargetConstants:suggest" + post: "/v12/geoTargetConstants:suggest" body: "*" }; } } -// Request message for [GeoTargetConstantService.GetGeoTargetConstant][google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant]. -message GetGeoTargetConstantRequest { - // Required. The resource name of the geo target constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/GeoTargetConstant" - } - ]; -} - // Request message for -// [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v9.services.GeoTargetConstantService.SuggestGeoTargetConstants]. +// [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants]. message SuggestGeoTargetConstantsRequest { // A list of location names. message LocationNames { @@ -116,7 +87,7 @@ message SuggestGeoTargetConstantsRequest { } } -// Response message for [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v9.services.GeoTargetConstantService.SuggestGeoTargetConstants]. +// Response message for [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants]. message SuggestGeoTargetConstantsResponse { // Geo target constant suggestions. repeated GeoTargetConstantSuggestion geo_target_constant_suggestions = 1; @@ -139,8 +110,8 @@ message GeoTargetConstantSuggestion { optional string search_term = 8; // The GeoTargetConstant result. - google.ads.googleads.v9.resources.GeoTargetConstant geo_target_constant = 4; + google.ads.googleads.v12.resources.GeoTargetConstant geo_target_constant = 4; // The list of parents of the geo target constant. - repeated google.ads.googleads.v9.resources.GeoTargetConstant geo_target_constant_parents = 5; + repeated google.ads.googleads.v12.resources.GeoTargetConstant geo_target_constant_parents = 5; } diff --git a/google/ads/googleads/v9/services/google_ads_field_service.proto b/google/ads/googleads/v12/services/google_ads_field_service.proto similarity index 80% rename from google/ads/googleads/v9/services/google_ads_field_service.proto rename to google/ads/googleads/v12/services/google_ads_field_service.proto index 4308514a6..45ece6708 100644 --- a/google/ads/googleads/v9/services/google_ads_field_service.proto +++ b/google/ads/googleads/v12/services/google_ads_field_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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/google_ads_field.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "GoogleAdsFieldServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the GoogleAdsFieldService. @@ -47,9 +47,9 @@ service GoogleAdsFieldService { // [InternalError]() // [QuotaError]() // [RequestError]() - rpc GetGoogleAdsField(GetGoogleAdsFieldRequest) returns (google.ads.googleads.v9.resources.GoogleAdsField) { + rpc GetGoogleAdsField(GetGoogleAdsFieldRequest) returns (google.ads.googleads.v12.resources.GoogleAdsField) { option (google.api.http) = { - get: "/v9/{resource_name=googleAdsFields/*}" + get: "/v12/{resource_name=googleAdsFields/*}" }; option (google.api.method_signature) = "resource_name"; } @@ -66,14 +66,14 @@ service GoogleAdsFieldService { // [RequestError]() rpc SearchGoogleAdsFields(SearchGoogleAdsFieldsRequest) returns (SearchGoogleAdsFieldsResponse) { option (google.api.http) = { - post: "/v9/googleAdsFields:search" + post: "/v12/googleAdsFields:search" body: "*" }; option (google.api.method_signature) = "query"; } } -// Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v9.services.GoogleAdsFieldService.GetGoogleAdsField]. +// Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField]. message GetGoogleAdsFieldRequest { // Required. The resource name of the field to get. string resource_name = 1 [ @@ -84,7 +84,7 @@ message GetGoogleAdsFieldRequest { ]; } -// Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v9.services.GoogleAdsFieldService.SearchGoogleAdsFields]. +// Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields]. message SearchGoogleAdsFieldsRequest { // Required. The query string. string query = 1 [(google.api.field_behavior) = REQUIRED]; @@ -100,10 +100,10 @@ message SearchGoogleAdsFieldsRequest { int32 page_size = 3; } -// Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v9.services.GoogleAdsFieldService.SearchGoogleAdsFields]. +// Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields]. message SearchGoogleAdsFieldsResponse { // The list of fields that matched the query. - repeated google.ads.googleads.v9.resources.GoogleAdsField results = 1; + repeated google.ads.googleads.v12.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/google/ads/googleads/v9/services/google_ads_service.proto b/google/ads/googleads/v12/services/google_ads_service.proto similarity index 53% rename from google/ads/googleads/v9/services/google_ads_service.proto rename to google/ads/googleads/v12/services/google_ads_service.proto index 91f8db248..400ae6b43 100644 --- a/google/ads/googleads/v9/services/google_ads_service.proto +++ b/google/ads/googleads/v12/services/google_ads_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. @@ -14,241 +14,255 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/common/metrics.proto"; -import "google/ads/googleads/v9/common/segments.proto"; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/enums/summary_row_setting.proto"; -import "google/ads/googleads/v9/resources/accessible_bidding_strategy.proto"; -import "google/ads/googleads/v9/resources/account_budget.proto"; -import "google/ads/googleads/v9/resources/account_budget_proposal.proto"; -import "google/ads/googleads/v9/resources/account_link.proto"; -import "google/ads/googleads/v9/resources/ad_group.proto"; -import "google/ads/googleads/v9/resources/ad_group_ad.proto"; -import "google/ads/googleads/v9/resources/ad_group_ad_asset_view.proto"; -import "google/ads/googleads/v9/resources/ad_group_ad_label.proto"; -import "google/ads/googleads/v9/resources/ad_group_asset.proto"; -import "google/ads/googleads/v9/resources/ad_group_audience_view.proto"; -import "google/ads/googleads/v9/resources/ad_group_bid_modifier.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion_customizer.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion_label.proto"; -import "google/ads/googleads/v9/resources/ad_group_criterion_simulation.proto"; -import "google/ads/googleads/v9/resources/ad_group_customizer.proto"; -import "google/ads/googleads/v9/resources/ad_group_extension_setting.proto"; -import "google/ads/googleads/v9/resources/ad_group_feed.proto"; -import "google/ads/googleads/v9/resources/ad_group_label.proto"; -import "google/ads/googleads/v9/resources/ad_group_simulation.proto"; -import "google/ads/googleads/v9/resources/ad_parameter.proto"; -import "google/ads/googleads/v9/resources/ad_schedule_view.proto"; -import "google/ads/googleads/v9/resources/age_range_view.proto"; -import "google/ads/googleads/v9/resources/asset.proto"; -import "google/ads/googleads/v9/resources/asset_field_type_view.proto"; -import "google/ads/googleads/v9/resources/asset_group.proto"; -import "google/ads/googleads/v9/resources/asset_group_asset.proto"; -import "google/ads/googleads/v9/resources/asset_group_listing_group_filter.proto"; -import "google/ads/googleads/v9/resources/asset_group_product_group_view.proto"; -import "google/ads/googleads/v9/resources/asset_set.proto"; -import "google/ads/googleads/v9/resources/asset_set_asset.proto"; -import "google/ads/googleads/v9/resources/batch_job.proto"; -import "google/ads/googleads/v9/resources/bidding_data_exclusion.proto"; -import "google/ads/googleads/v9/resources/bidding_seasonality_adjustment.proto"; -import "google/ads/googleads/v9/resources/bidding_strategy.proto"; -import "google/ads/googleads/v9/resources/bidding_strategy_simulation.proto"; -import "google/ads/googleads/v9/resources/billing_setup.proto"; -import "google/ads/googleads/v9/resources/call_view.proto"; -import "google/ads/googleads/v9/resources/campaign.proto"; -import "google/ads/googleads/v9/resources/campaign_asset.proto"; -import "google/ads/googleads/v9/resources/campaign_asset_set.proto"; -import "google/ads/googleads/v9/resources/campaign_audience_view.proto"; -import "google/ads/googleads/v9/resources/campaign_bid_modifier.proto"; -import "google/ads/googleads/v9/resources/campaign_budget.proto"; -import "google/ads/googleads/v9/resources/campaign_conversion_goal.proto"; -import "google/ads/googleads/v9/resources/campaign_criterion.proto"; -import "google/ads/googleads/v9/resources/campaign_criterion_simulation.proto"; -import "google/ads/googleads/v9/resources/campaign_customizer.proto"; -import "google/ads/googleads/v9/resources/campaign_draft.proto"; -import "google/ads/googleads/v9/resources/campaign_experiment.proto"; -import "google/ads/googleads/v9/resources/campaign_extension_setting.proto"; -import "google/ads/googleads/v9/resources/campaign_feed.proto"; -import "google/ads/googleads/v9/resources/campaign_label.proto"; -import "google/ads/googleads/v9/resources/campaign_shared_set.proto"; -import "google/ads/googleads/v9/resources/campaign_simulation.proto"; -import "google/ads/googleads/v9/resources/carrier_constant.proto"; -import "google/ads/googleads/v9/resources/change_event.proto"; -import "google/ads/googleads/v9/resources/change_status.proto"; -import "google/ads/googleads/v9/resources/click_view.proto"; -import "google/ads/googleads/v9/resources/combined_audience.proto"; -import "google/ads/googleads/v9/resources/conversion_action.proto"; -import "google/ads/googleads/v9/resources/conversion_custom_variable.proto"; -import "google/ads/googleads/v9/resources/conversion_goal_campaign_config.proto"; -import "google/ads/googleads/v9/resources/conversion_value_rule.proto"; -import "google/ads/googleads/v9/resources/conversion_value_rule_set.proto"; -import "google/ads/googleads/v9/resources/currency_constant.proto"; -import "google/ads/googleads/v9/resources/custom_audience.proto"; -import "google/ads/googleads/v9/resources/custom_conversion_goal.proto"; -import "google/ads/googleads/v9/resources/custom_interest.proto"; -import "google/ads/googleads/v9/resources/customer.proto"; -import "google/ads/googleads/v9/resources/customer_asset.proto"; -import "google/ads/googleads/v9/resources/customer_client.proto"; -import "google/ads/googleads/v9/resources/customer_client_link.proto"; -import "google/ads/googleads/v9/resources/customer_conversion_goal.proto"; -import "google/ads/googleads/v9/resources/customer_customizer.proto"; -import "google/ads/googleads/v9/resources/customer_extension_setting.proto"; -import "google/ads/googleads/v9/resources/customer_feed.proto"; -import "google/ads/googleads/v9/resources/customer_label.proto"; -import "google/ads/googleads/v9/resources/customer_manager_link.proto"; -import "google/ads/googleads/v9/resources/customer_negative_criterion.proto"; -import "google/ads/googleads/v9/resources/customer_user_access.proto"; -import "google/ads/googleads/v9/resources/customer_user_access_invitation.proto"; -import "google/ads/googleads/v9/resources/customizer_attribute.proto"; -import "google/ads/googleads/v9/resources/detail_placement_view.proto"; -import "google/ads/googleads/v9/resources/detailed_demographic.proto"; -import "google/ads/googleads/v9/resources/display_keyword_view.proto"; -import "google/ads/googleads/v9/resources/distance_view.proto"; -import "google/ads/googleads/v9/resources/domain_category.proto"; -import "google/ads/googleads/v9/resources/dynamic_search_ads_search_term_view.proto"; -import "google/ads/googleads/v9/resources/expanded_landing_page_view.proto"; -import "google/ads/googleads/v9/resources/extension_feed_item.proto"; -import "google/ads/googleads/v9/resources/feed.proto"; -import "google/ads/googleads/v9/resources/feed_item.proto"; -import "google/ads/googleads/v9/resources/feed_item_set.proto"; -import "google/ads/googleads/v9/resources/feed_item_set_link.proto"; -import "google/ads/googleads/v9/resources/feed_item_target.proto"; -import "google/ads/googleads/v9/resources/feed_mapping.proto"; -import "google/ads/googleads/v9/resources/feed_placeholder_view.proto"; -import "google/ads/googleads/v9/resources/gender_view.proto"; -import "google/ads/googleads/v9/resources/geo_target_constant.proto"; -import "google/ads/googleads/v9/resources/geographic_view.proto"; -import "google/ads/googleads/v9/resources/group_placement_view.proto"; -import "google/ads/googleads/v9/resources/hotel_group_view.proto"; -import "google/ads/googleads/v9/resources/hotel_performance_view.proto"; -import "google/ads/googleads/v9/resources/hotel_reconciliation.proto"; -import "google/ads/googleads/v9/resources/income_range_view.proto"; -import "google/ads/googleads/v9/resources/keyword_plan.proto"; -import "google/ads/googleads/v9/resources/keyword_plan_ad_group.proto"; -import "google/ads/googleads/v9/resources/keyword_plan_ad_group_keyword.proto"; -import "google/ads/googleads/v9/resources/keyword_plan_campaign.proto"; -import "google/ads/googleads/v9/resources/keyword_plan_campaign_keyword.proto"; -import "google/ads/googleads/v9/resources/keyword_theme_constant.proto"; -import "google/ads/googleads/v9/resources/keyword_view.proto"; -import "google/ads/googleads/v9/resources/label.proto"; -import "google/ads/googleads/v9/resources/landing_page_view.proto"; -import "google/ads/googleads/v9/resources/language_constant.proto"; -import "google/ads/googleads/v9/resources/life_event.proto"; -import "google/ads/googleads/v9/resources/location_view.proto"; -import "google/ads/googleads/v9/resources/managed_placement_view.proto"; -import "google/ads/googleads/v9/resources/media_file.proto"; -import "google/ads/googleads/v9/resources/mobile_app_category_constant.proto"; -import "google/ads/googleads/v9/resources/mobile_device_constant.proto"; -import "google/ads/googleads/v9/resources/offline_user_data_job.proto"; -import "google/ads/googleads/v9/resources/operating_system_version_constant.proto"; -import "google/ads/googleads/v9/resources/paid_organic_search_term_view.proto"; -import "google/ads/googleads/v9/resources/parental_status_view.proto"; -import "google/ads/googleads/v9/resources/product_bidding_category_constant.proto"; -import "google/ads/googleads/v9/resources/product_group_view.proto"; -import "google/ads/googleads/v9/resources/recommendation.proto"; -import "google/ads/googleads/v9/resources/remarketing_action.proto"; -import "google/ads/googleads/v9/resources/search_term_view.proto"; -import "google/ads/googleads/v9/resources/shared_criterion.proto"; -import "google/ads/googleads/v9/resources/shared_set.proto"; -import "google/ads/googleads/v9/resources/shopping_performance_view.proto"; -import "google/ads/googleads/v9/resources/smart_campaign_search_term_view.proto"; -import "google/ads/googleads/v9/resources/smart_campaign_setting.proto"; -import "google/ads/googleads/v9/resources/third_party_app_analytics_link.proto"; -import "google/ads/googleads/v9/resources/topic_constant.proto"; -import "google/ads/googleads/v9/resources/topic_view.proto"; -import "google/ads/googleads/v9/resources/user_interest.proto"; -import "google/ads/googleads/v9/resources/user_list.proto"; -import "google/ads/googleads/v9/resources/user_location_view.proto"; -import "google/ads/googleads/v9/resources/video.proto"; -import "google/ads/googleads/v9/resources/webpage_view.proto"; -import "google/ads/googleads/v9/services/ad_group_ad_label_service.proto"; -import "google/ads/googleads/v9/services/ad_group_ad_service.proto"; -import "google/ads/googleads/v9/services/ad_group_asset_service.proto"; -import "google/ads/googleads/v9/services/ad_group_bid_modifier_service.proto"; -import "google/ads/googleads/v9/services/ad_group_criterion_customizer_service.proto"; -import "google/ads/googleads/v9/services/ad_group_criterion_label_service.proto"; -import "google/ads/googleads/v9/services/ad_group_criterion_service.proto"; -import "google/ads/googleads/v9/services/ad_group_customizer_service.proto"; -import "google/ads/googleads/v9/services/ad_group_extension_setting_service.proto"; -import "google/ads/googleads/v9/services/ad_group_feed_service.proto"; -import "google/ads/googleads/v9/services/ad_group_label_service.proto"; -import "google/ads/googleads/v9/services/ad_group_service.proto"; -import "google/ads/googleads/v9/services/ad_parameter_service.proto"; -import "google/ads/googleads/v9/services/ad_service.proto"; -import "google/ads/googleads/v9/services/asset_group_asset_service.proto"; -import "google/ads/googleads/v9/services/asset_group_listing_group_filter_service.proto"; -import "google/ads/googleads/v9/services/asset_group_service.proto"; -import "google/ads/googleads/v9/services/asset_service.proto"; -import "google/ads/googleads/v9/services/asset_set_asset_service.proto"; -import "google/ads/googleads/v9/services/asset_set_service.proto"; -import "google/ads/googleads/v9/services/bidding_data_exclusion_service.proto"; -import "google/ads/googleads/v9/services/bidding_seasonality_adjustment_service.proto"; -import "google/ads/googleads/v9/services/bidding_strategy_service.proto"; -import "google/ads/googleads/v9/services/campaign_asset_service.proto"; -import "google/ads/googleads/v9/services/campaign_asset_set_service.proto"; -import "google/ads/googleads/v9/services/campaign_bid_modifier_service.proto"; -import "google/ads/googleads/v9/services/campaign_budget_service.proto"; -import "google/ads/googleads/v9/services/campaign_conversion_goal_service.proto"; -import "google/ads/googleads/v9/services/campaign_criterion_service.proto"; -import "google/ads/googleads/v9/services/campaign_customizer_service.proto"; -import "google/ads/googleads/v9/services/campaign_draft_service.proto"; -import "google/ads/googleads/v9/services/campaign_experiment_service.proto"; -import "google/ads/googleads/v9/services/campaign_extension_setting_service.proto"; -import "google/ads/googleads/v9/services/campaign_feed_service.proto"; -import "google/ads/googleads/v9/services/campaign_label_service.proto"; -import "google/ads/googleads/v9/services/campaign_service.proto"; -import "google/ads/googleads/v9/services/campaign_shared_set_service.proto"; -import "google/ads/googleads/v9/services/conversion_action_service.proto"; -import "google/ads/googleads/v9/services/conversion_custom_variable_service.proto"; -import "google/ads/googleads/v9/services/conversion_goal_campaign_config_service.proto"; -import "google/ads/googleads/v9/services/conversion_value_rule_service.proto"; -import "google/ads/googleads/v9/services/conversion_value_rule_set_service.proto"; -import "google/ads/googleads/v9/services/custom_conversion_goal_service.proto"; -import "google/ads/googleads/v9/services/customer_asset_service.proto"; -import "google/ads/googleads/v9/services/customer_conversion_goal_service.proto"; -import "google/ads/googleads/v9/services/customer_customizer_service.proto"; -import "google/ads/googleads/v9/services/customer_extension_setting_service.proto"; -import "google/ads/googleads/v9/services/customer_feed_service.proto"; -import "google/ads/googleads/v9/services/customer_label_service.proto"; -import "google/ads/googleads/v9/services/customer_negative_criterion_service.proto"; -import "google/ads/googleads/v9/services/customer_service.proto"; -import "google/ads/googleads/v9/services/customizer_attribute_service.proto"; -import "google/ads/googleads/v9/services/extension_feed_item_service.proto"; -import "google/ads/googleads/v9/services/feed_item_service.proto"; -import "google/ads/googleads/v9/services/feed_item_set_link_service.proto"; -import "google/ads/googleads/v9/services/feed_item_set_service.proto"; -import "google/ads/googleads/v9/services/feed_item_target_service.proto"; -import "google/ads/googleads/v9/services/feed_mapping_service.proto"; -import "google/ads/googleads/v9/services/feed_service.proto"; -import "google/ads/googleads/v9/services/keyword_plan_ad_group_keyword_service.proto"; -import "google/ads/googleads/v9/services/keyword_plan_ad_group_service.proto"; -import "google/ads/googleads/v9/services/keyword_plan_campaign_keyword_service.proto"; -import "google/ads/googleads/v9/services/keyword_plan_campaign_service.proto"; -import "google/ads/googleads/v9/services/keyword_plan_service.proto"; -import "google/ads/googleads/v9/services/label_service.proto"; -import "google/ads/googleads/v9/services/media_file_service.proto"; -import "google/ads/googleads/v9/services/remarketing_action_service.proto"; -import "google/ads/googleads/v9/services/shared_criterion_service.proto"; -import "google/ads/googleads/v9/services/shared_set_service.proto"; -import "google/ads/googleads/v9/services/smart_campaign_setting_service.proto"; -import "google/ads/googleads/v9/services/user_list_service.proto"; +package google.ads.googleads.v12.services; + +import "google/ads/googleads/v12/common/metrics.proto"; +import "google/ads/googleads/v12/common/segments.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/enums/summary_row_setting.proto"; +import "google/ads/googleads/v12/resources/accessible_bidding_strategy.proto"; +import "google/ads/googleads/v12/resources/account_budget.proto"; +import "google/ads/googleads/v12/resources/account_budget_proposal.proto"; +import "google/ads/googleads/v12/resources/account_link.proto"; +import "google/ads/googleads/v12/resources/ad_group.proto"; +import "google/ads/googleads/v12/resources/ad_group_ad.proto"; +import "google/ads/googleads/v12/resources/ad_group_ad_asset_combination_view.proto"; +import "google/ads/googleads/v12/resources/ad_group_ad_asset_view.proto"; +import "google/ads/googleads/v12/resources/ad_group_ad_label.proto"; +import "google/ads/googleads/v12/resources/ad_group_asset.proto"; +import "google/ads/googleads/v12/resources/ad_group_asset_set.proto"; +import "google/ads/googleads/v12/resources/ad_group_audience_view.proto"; +import "google/ads/googleads/v12/resources/ad_group_bid_modifier.proto"; +import "google/ads/googleads/v12/resources/ad_group_criterion.proto"; +import "google/ads/googleads/v12/resources/ad_group_criterion_customizer.proto"; +import "google/ads/googleads/v12/resources/ad_group_criterion_label.proto"; +import "google/ads/googleads/v12/resources/ad_group_criterion_simulation.proto"; +import "google/ads/googleads/v12/resources/ad_group_customizer.proto"; +import "google/ads/googleads/v12/resources/ad_group_extension_setting.proto"; +import "google/ads/googleads/v12/resources/ad_group_feed.proto"; +import "google/ads/googleads/v12/resources/ad_group_label.proto"; +import "google/ads/googleads/v12/resources/ad_group_simulation.proto"; +import "google/ads/googleads/v12/resources/ad_parameter.proto"; +import "google/ads/googleads/v12/resources/ad_schedule_view.proto"; +import "google/ads/googleads/v12/resources/age_range_view.proto"; +import "google/ads/googleads/v12/resources/asset.proto"; +import "google/ads/googleads/v12/resources/asset_field_type_view.proto"; +import "google/ads/googleads/v12/resources/asset_group.proto"; +import "google/ads/googleads/v12/resources/asset_group_asset.proto"; +import "google/ads/googleads/v12/resources/asset_group_listing_group_filter.proto"; +import "google/ads/googleads/v12/resources/asset_group_product_group_view.proto"; +import "google/ads/googleads/v12/resources/asset_group_signal.proto"; +import "google/ads/googleads/v12/resources/asset_set.proto"; +import "google/ads/googleads/v12/resources/asset_set_asset.proto"; +import "google/ads/googleads/v12/resources/asset_set_type_view.proto"; +import "google/ads/googleads/v12/resources/audience.proto"; +import "google/ads/googleads/v12/resources/batch_job.proto"; +import "google/ads/googleads/v12/resources/bidding_data_exclusion.proto"; +import "google/ads/googleads/v12/resources/bidding_seasonality_adjustment.proto"; +import "google/ads/googleads/v12/resources/bidding_strategy.proto"; +import "google/ads/googleads/v12/resources/bidding_strategy_simulation.proto"; +import "google/ads/googleads/v12/resources/billing_setup.proto"; +import "google/ads/googleads/v12/resources/call_view.proto"; +import "google/ads/googleads/v12/resources/campaign.proto"; +import "google/ads/googleads/v12/resources/campaign_asset.proto"; +import "google/ads/googleads/v12/resources/campaign_asset_set.proto"; +import "google/ads/googleads/v12/resources/campaign_audience_view.proto"; +import "google/ads/googleads/v12/resources/campaign_bid_modifier.proto"; +import "google/ads/googleads/v12/resources/campaign_budget.proto"; +import "google/ads/googleads/v12/resources/campaign_conversion_goal.proto"; +import "google/ads/googleads/v12/resources/campaign_criterion.proto"; +import "google/ads/googleads/v12/resources/campaign_criterion_simulation.proto"; +import "google/ads/googleads/v12/resources/campaign_customizer.proto"; +import "google/ads/googleads/v12/resources/campaign_draft.proto"; +import "google/ads/googleads/v12/resources/campaign_extension_setting.proto"; +import "google/ads/googleads/v12/resources/campaign_feed.proto"; +import "google/ads/googleads/v12/resources/campaign_group.proto"; +import "google/ads/googleads/v12/resources/campaign_label.proto"; +import "google/ads/googleads/v12/resources/campaign_shared_set.proto"; +import "google/ads/googleads/v12/resources/campaign_simulation.proto"; +import "google/ads/googleads/v12/resources/carrier_constant.proto"; +import "google/ads/googleads/v12/resources/change_event.proto"; +import "google/ads/googleads/v12/resources/change_status.proto"; +import "google/ads/googleads/v12/resources/click_view.proto"; +import "google/ads/googleads/v12/resources/combined_audience.proto"; +import "google/ads/googleads/v12/resources/conversion_action.proto"; +import "google/ads/googleads/v12/resources/conversion_custom_variable.proto"; +import "google/ads/googleads/v12/resources/conversion_goal_campaign_config.proto"; +import "google/ads/googleads/v12/resources/conversion_value_rule.proto"; +import "google/ads/googleads/v12/resources/conversion_value_rule_set.proto"; +import "google/ads/googleads/v12/resources/currency_constant.proto"; +import "google/ads/googleads/v12/resources/custom_audience.proto"; +import "google/ads/googleads/v12/resources/custom_conversion_goal.proto"; +import "google/ads/googleads/v12/resources/custom_interest.proto"; +import "google/ads/googleads/v12/resources/customer.proto"; +import "google/ads/googleads/v12/resources/customer_asset.proto"; +import "google/ads/googleads/v12/resources/customer_asset_set.proto"; +import "google/ads/googleads/v12/resources/customer_client.proto"; +import "google/ads/googleads/v12/resources/customer_client_link.proto"; +import "google/ads/googleads/v12/resources/customer_conversion_goal.proto"; +import "google/ads/googleads/v12/resources/customer_customizer.proto"; +import "google/ads/googleads/v12/resources/customer_extension_setting.proto"; +import "google/ads/googleads/v12/resources/customer_feed.proto"; +import "google/ads/googleads/v12/resources/customer_label.proto"; +import "google/ads/googleads/v12/resources/customer_manager_link.proto"; +import "google/ads/googleads/v12/resources/customer_negative_criterion.proto"; +import "google/ads/googleads/v12/resources/customer_user_access.proto"; +import "google/ads/googleads/v12/resources/customer_user_access_invitation.proto"; +import "google/ads/googleads/v12/resources/customizer_attribute.proto"; +import "google/ads/googleads/v12/resources/detail_placement_view.proto"; +import "google/ads/googleads/v12/resources/detailed_demographic.proto"; +import "google/ads/googleads/v12/resources/display_keyword_view.proto"; +import "google/ads/googleads/v12/resources/distance_view.proto"; +import "google/ads/googleads/v12/resources/domain_category.proto"; +import "google/ads/googleads/v12/resources/dynamic_search_ads_search_term_view.proto"; +import "google/ads/googleads/v12/resources/expanded_landing_page_view.proto"; +import "google/ads/googleads/v12/resources/experiment.proto"; +import "google/ads/googleads/v12/resources/experiment_arm.proto"; +import "google/ads/googleads/v12/resources/extension_feed_item.proto"; +import "google/ads/googleads/v12/resources/feed.proto"; +import "google/ads/googleads/v12/resources/feed_item.proto"; +import "google/ads/googleads/v12/resources/feed_item_set.proto"; +import "google/ads/googleads/v12/resources/feed_item_set_link.proto"; +import "google/ads/googleads/v12/resources/feed_item_target.proto"; +import "google/ads/googleads/v12/resources/feed_mapping.proto"; +import "google/ads/googleads/v12/resources/feed_placeholder_view.proto"; +import "google/ads/googleads/v12/resources/gender_view.proto"; +import "google/ads/googleads/v12/resources/geo_target_constant.proto"; +import "google/ads/googleads/v12/resources/geographic_view.proto"; +import "google/ads/googleads/v12/resources/group_placement_view.proto"; +import "google/ads/googleads/v12/resources/hotel_group_view.proto"; +import "google/ads/googleads/v12/resources/hotel_performance_view.proto"; +import "google/ads/googleads/v12/resources/hotel_reconciliation.proto"; +import "google/ads/googleads/v12/resources/income_range_view.proto"; +import "google/ads/googleads/v12/resources/keyword_plan.proto"; +import "google/ads/googleads/v12/resources/keyword_plan_ad_group.proto"; +import "google/ads/googleads/v12/resources/keyword_plan_ad_group_keyword.proto"; +import "google/ads/googleads/v12/resources/keyword_plan_campaign.proto"; +import "google/ads/googleads/v12/resources/keyword_plan_campaign_keyword.proto"; +import "google/ads/googleads/v12/resources/keyword_theme_constant.proto"; +import "google/ads/googleads/v12/resources/keyword_view.proto"; +import "google/ads/googleads/v12/resources/label.proto"; +import "google/ads/googleads/v12/resources/landing_page_view.proto"; +import "google/ads/googleads/v12/resources/language_constant.proto"; +import "google/ads/googleads/v12/resources/lead_form_submission_data.proto"; +import "google/ads/googleads/v12/resources/life_event.proto"; +import "google/ads/googleads/v12/resources/location_view.proto"; +import "google/ads/googleads/v12/resources/managed_placement_view.proto"; +import "google/ads/googleads/v12/resources/media_file.proto"; +import "google/ads/googleads/v12/resources/mobile_app_category_constant.proto"; +import "google/ads/googleads/v12/resources/mobile_device_constant.proto"; +import "google/ads/googleads/v12/resources/offline_user_data_job.proto"; +import "google/ads/googleads/v12/resources/operating_system_version_constant.proto"; +import "google/ads/googleads/v12/resources/paid_organic_search_term_view.proto"; +import "google/ads/googleads/v12/resources/parental_status_view.proto"; +import "google/ads/googleads/v12/resources/per_store_view.proto"; +import "google/ads/googleads/v12/resources/product_bidding_category_constant.proto"; +import "google/ads/googleads/v12/resources/product_group_view.proto"; +import "google/ads/googleads/v12/resources/recommendation.proto"; +import "google/ads/googleads/v12/resources/remarketing_action.proto"; +import "google/ads/googleads/v12/resources/search_term_view.proto"; +import "google/ads/googleads/v12/resources/shared_criterion.proto"; +import "google/ads/googleads/v12/resources/shared_set.proto"; +import "google/ads/googleads/v12/resources/shopping_performance_view.proto"; +import "google/ads/googleads/v12/resources/smart_campaign_search_term_view.proto"; +import "google/ads/googleads/v12/resources/smart_campaign_setting.proto"; +import "google/ads/googleads/v12/resources/third_party_app_analytics_link.proto"; +import "google/ads/googleads/v12/resources/topic_constant.proto"; +import "google/ads/googleads/v12/resources/topic_view.proto"; +import "google/ads/googleads/v12/resources/user_interest.proto"; +import "google/ads/googleads/v12/resources/user_list.proto"; +import "google/ads/googleads/v12/resources/user_location_view.proto"; +import "google/ads/googleads/v12/resources/video.proto"; +import "google/ads/googleads/v12/resources/webpage_view.proto"; +import "google/ads/googleads/v12/services/ad_group_ad_label_service.proto"; +import "google/ads/googleads/v12/services/ad_group_ad_service.proto"; +import "google/ads/googleads/v12/services/ad_group_asset_service.proto"; +import "google/ads/googleads/v12/services/ad_group_bid_modifier_service.proto"; +import "google/ads/googleads/v12/services/ad_group_criterion_customizer_service.proto"; +import "google/ads/googleads/v12/services/ad_group_criterion_label_service.proto"; +import "google/ads/googleads/v12/services/ad_group_criterion_service.proto"; +import "google/ads/googleads/v12/services/ad_group_customizer_service.proto"; +import "google/ads/googleads/v12/services/ad_group_extension_setting_service.proto"; +import "google/ads/googleads/v12/services/ad_group_feed_service.proto"; +import "google/ads/googleads/v12/services/ad_group_label_service.proto"; +import "google/ads/googleads/v12/services/ad_group_service.proto"; +import "google/ads/googleads/v12/services/ad_parameter_service.proto"; +import "google/ads/googleads/v12/services/ad_service.proto"; +import "google/ads/googleads/v12/services/asset_group_asset_service.proto"; +import "google/ads/googleads/v12/services/asset_group_listing_group_filter_service.proto"; +import "google/ads/googleads/v12/services/asset_group_service.proto"; +import "google/ads/googleads/v12/services/asset_group_signal_service.proto"; +import "google/ads/googleads/v12/services/asset_service.proto"; +import "google/ads/googleads/v12/services/asset_set_asset_service.proto"; +import "google/ads/googleads/v12/services/asset_set_service.proto"; +import "google/ads/googleads/v12/services/audience_service.proto"; +import "google/ads/googleads/v12/services/bidding_data_exclusion_service.proto"; +import "google/ads/googleads/v12/services/bidding_seasonality_adjustment_service.proto"; +import "google/ads/googleads/v12/services/bidding_strategy_service.proto"; +import "google/ads/googleads/v12/services/campaign_asset_service.proto"; +import "google/ads/googleads/v12/services/campaign_asset_set_service.proto"; +import "google/ads/googleads/v12/services/campaign_bid_modifier_service.proto"; +import "google/ads/googleads/v12/services/campaign_budget_service.proto"; +import "google/ads/googleads/v12/services/campaign_conversion_goal_service.proto"; +import "google/ads/googleads/v12/services/campaign_criterion_service.proto"; +import "google/ads/googleads/v12/services/campaign_customizer_service.proto"; +import "google/ads/googleads/v12/services/campaign_draft_service.proto"; +import "google/ads/googleads/v12/services/campaign_extension_setting_service.proto"; +import "google/ads/googleads/v12/services/campaign_feed_service.proto"; +import "google/ads/googleads/v12/services/campaign_group_service.proto"; +import "google/ads/googleads/v12/services/campaign_label_service.proto"; +import "google/ads/googleads/v12/services/campaign_service.proto"; +import "google/ads/googleads/v12/services/campaign_shared_set_service.proto"; +import "google/ads/googleads/v12/services/conversion_action_service.proto"; +import "google/ads/googleads/v12/services/conversion_custom_variable_service.proto"; +import "google/ads/googleads/v12/services/conversion_goal_campaign_config_service.proto"; +import "google/ads/googleads/v12/services/conversion_value_rule_service.proto"; +import "google/ads/googleads/v12/services/conversion_value_rule_set_service.proto"; +import "google/ads/googleads/v12/services/custom_conversion_goal_service.proto"; +import "google/ads/googleads/v12/services/customer_asset_service.proto"; +import "google/ads/googleads/v12/services/customer_conversion_goal_service.proto"; +import "google/ads/googleads/v12/services/customer_customizer_service.proto"; +import "google/ads/googleads/v12/services/customer_extension_setting_service.proto"; +import "google/ads/googleads/v12/services/customer_feed_service.proto"; +import "google/ads/googleads/v12/services/customer_label_service.proto"; +import "google/ads/googleads/v12/services/customer_negative_criterion_service.proto"; +import "google/ads/googleads/v12/services/customer_service.proto"; +import "google/ads/googleads/v12/services/customizer_attribute_service.proto"; +import "google/ads/googleads/v12/services/experiment_arm_service.proto"; +import "google/ads/googleads/v12/services/experiment_service.proto"; +import "google/ads/googleads/v12/services/extension_feed_item_service.proto"; +import "google/ads/googleads/v12/services/feed_item_service.proto"; +import "google/ads/googleads/v12/services/feed_item_set_link_service.proto"; +import "google/ads/googleads/v12/services/feed_item_set_service.proto"; +import "google/ads/googleads/v12/services/feed_item_target_service.proto"; +import "google/ads/googleads/v12/services/feed_mapping_service.proto"; +import "google/ads/googleads/v12/services/feed_service.proto"; +import "google/ads/googleads/v12/services/keyword_plan_ad_group_keyword_service.proto"; +import "google/ads/googleads/v12/services/keyword_plan_ad_group_service.proto"; +import "google/ads/googleads/v12/services/keyword_plan_campaign_keyword_service.proto"; +import "google/ads/googleads/v12/services/keyword_plan_campaign_service.proto"; +import "google/ads/googleads/v12/services/keyword_plan_service.proto"; +import "google/ads/googleads/v12/services/label_service.proto"; +import "google/ads/googleads/v12/services/media_file_service.proto"; +import "google/ads/googleads/v12/services/remarketing_action_service.proto"; +import "google/ads/googleads/v12/services/shared_criterion_service.proto"; +import "google/ads/googleads/v12/services/shared_set_service.proto"; +import "google/ads/googleads/v12/services/smart_campaign_setting_service.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "GoogleAdsServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the GoogleAdsService. @@ -272,7 +286,7 @@ service GoogleAdsService { // [RequestError]() rpc Search(SearchGoogleAdsRequest) returns (SearchGoogleAdsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/googleAds:search" + post: "/v12/customers/{customer_id=*}/googleAds:search" body: "*" }; option (google.api.method_signature) = "customer_id,query"; @@ -293,7 +307,7 @@ service GoogleAdsService { // [RequestError]() rpc SearchStream(SearchGoogleAdsStreamRequest) returns (stream SearchGoogleAdsStreamResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/googleAds:searchStream" + post: "/v12/customers/{customer_id=*}/googleAds:searchStream" body: "*" }; option (google.api.method_signature) = "customer_id,query"; @@ -318,7 +332,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 @@ -413,14 +427,14 @@ service GoogleAdsService { // [YoutubeVideoRegistrationError]() rpc Mutate(MutateGoogleAdsRequest) returns (MutateGoogleAdsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/googleAds:mutate" + post: "/v12/customers/{customer_id=*}/googleAds:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,mutate_operations"; } } -// Request message for [GoogleAdsService.Search][google.ads.googleads.v9.services.GoogleAdsService.Search]. +// Request message for [GoogleAdsService.Search][google.ads.googleads.v12.services.GoogleAdsService.Search]. message SearchGoogleAdsRequest { // Required. The ID of the customer being queried. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -450,10 +464,10 @@ 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.v9.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8; + google.ads.googleads.v12.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8; } -// Response message for [GoogleAdsService.Search][google.ads.googleads.v9.services.GoogleAdsService.Search]. +// Response message for [GoogleAdsService.Search][google.ads.googleads.v12.services.GoogleAdsService.Search]. message SearchGoogleAdsResponse { // The list of rows that matched the query. repeated GoogleAdsRow results = 1; @@ -477,7 +491,7 @@ message SearchGoogleAdsResponse { GoogleAdsRow summary_row = 6; } -// Request message for [GoogleAdsService.SearchStream][google.ads.googleads.v9.services.GoogleAdsService.SearchStream]. +// Request message for [GoogleAdsService.SearchStream][google.ads.googleads.v12.services.GoogleAdsService.SearchStream]. message SearchGoogleAdsStreamRequest { // Required. The ID of the customer being queried. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -488,10 +502,10 @@ 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.v9.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3; + google.ads.googleads.v12.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3; } -// Response message for [GoogleAdsService.SearchStream][google.ads.googleads.v9.services.GoogleAdsService.SearchStream]. +// Response message for [GoogleAdsService.SearchStream][google.ads.googleads.v12.services.GoogleAdsService.SearchStream]. message SearchGoogleAdsStreamResponse { // The list of rows that matched the query. repeated GoogleAdsRow results = 1; @@ -511,445 +525,475 @@ message SearchGoogleAdsStreamResponse { // A returned row from the query. message GoogleAdsRow { // The account budget in the query. - google.ads.googleads.v9.resources.AccountBudget account_budget = 42; + google.ads.googleads.v12.resources.AccountBudget account_budget = 42; // The account budget proposal referenced in the query. - google.ads.googleads.v9.resources.AccountBudgetProposal account_budget_proposal = 43; + google.ads.googleads.v12.resources.AccountBudgetProposal account_budget_proposal = 43; // The AccountLink referenced in the query. - google.ads.googleads.v9.resources.AccountLink account_link = 143; + google.ads.googleads.v12.resources.AccountLink account_link = 143; // The ad group referenced in the query. - google.ads.googleads.v9.resources.AdGroup ad_group = 3; + google.ads.googleads.v12.resources.AdGroup ad_group = 3; // The ad referenced in the query. - google.ads.googleads.v9.resources.AdGroupAd ad_group_ad = 16; + google.ads.googleads.v12.resources.AdGroupAd ad_group_ad = 16; + + // The ad group ad asset combination view in the query. + google.ads.googleads.v12.resources.AdGroupAdAssetCombinationView ad_group_ad_asset_combination_view = 193; // The ad group ad asset view in the query. - google.ads.googleads.v9.resources.AdGroupAdAssetView ad_group_ad_asset_view = 131; + google.ads.googleads.v12.resources.AdGroupAdAssetView ad_group_ad_asset_view = 131; // The ad group ad label referenced in the query. - google.ads.googleads.v9.resources.AdGroupAdLabel ad_group_ad_label = 120; + google.ads.googleads.v12.resources.AdGroupAdLabel ad_group_ad_label = 120; // The ad group asset referenced in the query. - google.ads.googleads.v9.resources.AdGroupAsset ad_group_asset = 154; + google.ads.googleads.v12.resources.AdGroupAsset ad_group_asset = 154; + + // The ad group asset set referenced in the query. + google.ads.googleads.v12.resources.AdGroupAssetSet ad_group_asset_set = 196; // The ad group audience view referenced in the query. - google.ads.googleads.v9.resources.AdGroupAudienceView ad_group_audience_view = 57; + google.ads.googleads.v12.resources.AdGroupAudienceView ad_group_audience_view = 57; // The bid modifier referenced in the query. - google.ads.googleads.v9.resources.AdGroupBidModifier ad_group_bid_modifier = 24; + google.ads.googleads.v12.resources.AdGroupBidModifier ad_group_bid_modifier = 24; // The criterion referenced in the query. - google.ads.googleads.v9.resources.AdGroupCriterion ad_group_criterion = 17; + google.ads.googleads.v12.resources.AdGroupCriterion ad_group_criterion = 17; // The ad group criterion customizer referenced in the query. - google.ads.googleads.v9.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 187; + google.ads.googleads.v12.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 187; // The ad group criterion label referenced in the query. - google.ads.googleads.v9.resources.AdGroupCriterionLabel ad_group_criterion_label = 121; + google.ads.googleads.v12.resources.AdGroupCriterionLabel ad_group_criterion_label = 121; // The ad group criterion simulation referenced in the query. - google.ads.googleads.v9.resources.AdGroupCriterionSimulation ad_group_criterion_simulation = 110; + google.ads.googleads.v12.resources.AdGroupCriterionSimulation ad_group_criterion_simulation = 110; // The ad group customizer referenced in the query. - google.ads.googleads.v9.resources.AdGroupCustomizer ad_group_customizer = 185; + google.ads.googleads.v12.resources.AdGroupCustomizer ad_group_customizer = 185; // The ad group extension setting referenced in the query. - google.ads.googleads.v9.resources.AdGroupExtensionSetting ad_group_extension_setting = 112; + google.ads.googleads.v12.resources.AdGroupExtensionSetting ad_group_extension_setting = 112; // The ad group feed referenced in the query. - google.ads.googleads.v9.resources.AdGroupFeed ad_group_feed = 67; + google.ads.googleads.v12.resources.AdGroupFeed ad_group_feed = 67; // The ad group label referenced in the query. - google.ads.googleads.v9.resources.AdGroupLabel ad_group_label = 115; + google.ads.googleads.v12.resources.AdGroupLabel ad_group_label = 115; // The ad group simulation referenced in the query. - google.ads.googleads.v9.resources.AdGroupSimulation ad_group_simulation = 107; + google.ads.googleads.v12.resources.AdGroupSimulation ad_group_simulation = 107; // The ad parameter referenced in the query. - google.ads.googleads.v9.resources.AdParameter ad_parameter = 130; + google.ads.googleads.v12.resources.AdParameter ad_parameter = 130; // The age range view referenced in the query. - google.ads.googleads.v9.resources.AgeRangeView age_range_view = 48; + google.ads.googleads.v12.resources.AgeRangeView age_range_view = 48; // The ad schedule view referenced in the query. - google.ads.googleads.v9.resources.AdScheduleView ad_schedule_view = 89; + google.ads.googleads.v12.resources.AdScheduleView ad_schedule_view = 89; // The domain category referenced in the query. - google.ads.googleads.v9.resources.DomainCategory domain_category = 91; + google.ads.googleads.v12.resources.DomainCategory domain_category = 91; // The asset referenced in the query. - google.ads.googleads.v9.resources.Asset asset = 105; + google.ads.googleads.v12.resources.Asset asset = 105; // The asset field type view referenced in the query. - google.ads.googleads.v9.resources.AssetFieldTypeView asset_field_type_view = 168; + google.ads.googleads.v12.resources.AssetFieldTypeView asset_field_type_view = 168; // The asset group asset referenced in the query. - google.ads.googleads.v9.resources.AssetGroupAsset asset_group_asset = 173; + google.ads.googleads.v12.resources.AssetGroupAsset asset_group_asset = 173; + + // The asset group signal referenced in the query. + google.ads.googleads.v12.resources.AssetGroupSignal asset_group_signal = 191; // The asset group listing group filter referenced in the query. - google.ads.googleads.v9.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 182; + google.ads.googleads.v12.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 182; // The asset group product group view referenced in the query. - google.ads.googleads.v9.resources.AssetGroupProductGroupView asset_group_product_group_view = 189; + google.ads.googleads.v12.resources.AssetGroupProductGroupView asset_group_product_group_view = 189; // The asset group referenced in the query. - google.ads.googleads.v9.resources.AssetGroup asset_group = 172; + google.ads.googleads.v12.resources.AssetGroup asset_group = 172; // The asset set asset referenced in the query. - google.ads.googleads.v9.resources.AssetSetAsset asset_set_asset = 180; + google.ads.googleads.v12.resources.AssetSetAsset asset_set_asset = 180; // The asset set referenced in the query. - google.ads.googleads.v9.resources.AssetSet asset_set = 179; + google.ads.googleads.v12.resources.AssetSet asset_set = 179; + + // The asset set type view referenced in the query. + google.ads.googleads.v12.resources.AssetSetTypeView asset_set_type_view = 197; // The batch job referenced in the query. - google.ads.googleads.v9.resources.BatchJob batch_job = 139; + google.ads.googleads.v12.resources.BatchJob batch_job = 139; // The bidding data exclusion referenced in the query. - google.ads.googleads.v9.resources.BiddingDataExclusion bidding_data_exclusion = 159; + google.ads.googleads.v12.resources.BiddingDataExclusion bidding_data_exclusion = 159; // The bidding seasonality adjustment referenced in the query. - google.ads.googleads.v9.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 160; + google.ads.googleads.v12.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 160; // The bidding strategy referenced in the query. - google.ads.googleads.v9.resources.BiddingStrategy bidding_strategy = 18; + google.ads.googleads.v12.resources.BiddingStrategy bidding_strategy = 18; // The bidding strategy simulation referenced in the query. - google.ads.googleads.v9.resources.BiddingStrategySimulation bidding_strategy_simulation = 158; + google.ads.googleads.v12.resources.BiddingStrategySimulation bidding_strategy_simulation = 158; // The billing setup referenced in the query. - google.ads.googleads.v9.resources.BillingSetup billing_setup = 41; + google.ads.googleads.v12.resources.BillingSetup billing_setup = 41; // The call view referenced in the query. - google.ads.googleads.v9.resources.CallView call_view = 152; + google.ads.googleads.v12.resources.CallView call_view = 152; // The campaign budget referenced in the query. - google.ads.googleads.v9.resources.CampaignBudget campaign_budget = 19; + google.ads.googleads.v12.resources.CampaignBudget campaign_budget = 19; // The campaign referenced in the query. - google.ads.googleads.v9.resources.Campaign campaign = 2; + google.ads.googleads.v12.resources.Campaign campaign = 2; // The campaign asset referenced in the query. - google.ads.googleads.v9.resources.CampaignAsset campaign_asset = 142; + google.ads.googleads.v12.resources.CampaignAsset campaign_asset = 142; // The campaign asset set referenced in the query. - google.ads.googleads.v9.resources.CampaignAssetSet campaign_asset_set = 181; + google.ads.googleads.v12.resources.CampaignAssetSet campaign_asset_set = 181; // The campaign audience view referenced in the query. - google.ads.googleads.v9.resources.CampaignAudienceView campaign_audience_view = 69; + google.ads.googleads.v12.resources.CampaignAudienceView campaign_audience_view = 69; // The campaign bid modifier referenced in the query. - google.ads.googleads.v9.resources.CampaignBidModifier campaign_bid_modifier = 26; + google.ads.googleads.v12.resources.CampaignBidModifier campaign_bid_modifier = 26; // The CampaignConversionGoal referenced in the query. - google.ads.googleads.v9.resources.CampaignConversionGoal campaign_conversion_goal = 175; + google.ads.googleads.v12.resources.CampaignConversionGoal campaign_conversion_goal = 175; // The campaign criterion referenced in the query. - google.ads.googleads.v9.resources.CampaignCriterion campaign_criterion = 20; + google.ads.googleads.v12.resources.CampaignCriterion campaign_criterion = 20; // The campaign criterion simulation referenced in the query. - google.ads.googleads.v9.resources.CampaignCriterionSimulation campaign_criterion_simulation = 111; + google.ads.googleads.v12.resources.CampaignCriterionSimulation campaign_criterion_simulation = 111; // The campaign customizer referenced in the query. - google.ads.googleads.v9.resources.CampaignCustomizer campaign_customizer = 186; + google.ads.googleads.v12.resources.CampaignCustomizer campaign_customizer = 186; // The campaign draft referenced in the query. - google.ads.googleads.v9.resources.CampaignDraft campaign_draft = 49; - - // The campaign experiment referenced in the query. - google.ads.googleads.v9.resources.CampaignExperiment campaign_experiment = 84; + google.ads.googleads.v12.resources.CampaignDraft campaign_draft = 49; // The campaign extension setting referenced in the query. - google.ads.googleads.v9.resources.CampaignExtensionSetting campaign_extension_setting = 113; + google.ads.googleads.v12.resources.CampaignExtensionSetting campaign_extension_setting = 113; // The campaign feed referenced in the query. - google.ads.googleads.v9.resources.CampaignFeed campaign_feed = 63; + google.ads.googleads.v12.resources.CampaignFeed campaign_feed = 63; + + // Campaign Group referenced in AWQL query. + google.ads.googleads.v12.resources.CampaignGroup campaign_group = 25; // The campaign label referenced in the query. - google.ads.googleads.v9.resources.CampaignLabel campaign_label = 108; + google.ads.googleads.v12.resources.CampaignLabel campaign_label = 108; // Campaign Shared Set referenced in AWQL query. - google.ads.googleads.v9.resources.CampaignSharedSet campaign_shared_set = 30; + google.ads.googleads.v12.resources.CampaignSharedSet campaign_shared_set = 30; // The campaign simulation referenced in the query. - google.ads.googleads.v9.resources.CampaignSimulation campaign_simulation = 157; + google.ads.googleads.v12.resources.CampaignSimulation campaign_simulation = 157; // The carrier constant referenced in the query. - google.ads.googleads.v9.resources.CarrierConstant carrier_constant = 66; + google.ads.googleads.v12.resources.CarrierConstant carrier_constant = 66; // The ChangeEvent referenced in the query. - google.ads.googleads.v9.resources.ChangeEvent change_event = 145; + google.ads.googleads.v12.resources.ChangeEvent change_event = 145; // The ChangeStatus referenced in the query. - google.ads.googleads.v9.resources.ChangeStatus change_status = 37; + google.ads.googleads.v12.resources.ChangeStatus change_status = 37; // The CombinedAudience referenced in the query. - google.ads.googleads.v9.resources.CombinedAudience combined_audience = 148; + google.ads.googleads.v12.resources.CombinedAudience combined_audience = 148; + + // The Audience referenced in the query. + google.ads.googleads.v12.resources.Audience audience = 190; // The conversion action referenced in the query. - google.ads.googleads.v9.resources.ConversionAction conversion_action = 103; + google.ads.googleads.v12.resources.ConversionAction conversion_action = 103; // The conversion custom variable referenced in the query. - google.ads.googleads.v9.resources.ConversionCustomVariable conversion_custom_variable = 153; + google.ads.googleads.v12.resources.ConversionCustomVariable conversion_custom_variable = 153; // The ConversionGoalCampaignConfig referenced in the query. - google.ads.googleads.v9.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 177; + google.ads.googleads.v12.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 177; // The conversion value rule referenced in the query. - google.ads.googleads.v9.resources.ConversionValueRule conversion_value_rule = 164; + google.ads.googleads.v12.resources.ConversionValueRule conversion_value_rule = 164; // The conversion value rule set referenced in the query. - google.ads.googleads.v9.resources.ConversionValueRuleSet conversion_value_rule_set = 165; + google.ads.googleads.v12.resources.ConversionValueRuleSet conversion_value_rule_set = 165; // The ClickView referenced in the query. - google.ads.googleads.v9.resources.ClickView click_view = 122; + google.ads.googleads.v12.resources.ClickView click_view = 122; // The currency constant referenced in the query. - google.ads.googleads.v9.resources.CurrencyConstant currency_constant = 134; + google.ads.googleads.v12.resources.CurrencyConstant currency_constant = 134; // The CustomAudience referenced in the query. - google.ads.googleads.v9.resources.CustomAudience custom_audience = 147; + google.ads.googleads.v12.resources.CustomAudience custom_audience = 147; // The CustomConversionGoal referenced in the query. - google.ads.googleads.v9.resources.CustomConversionGoal custom_conversion_goal = 176; + google.ads.googleads.v12.resources.CustomConversionGoal custom_conversion_goal = 176; // The CustomInterest referenced in the query. - google.ads.googleads.v9.resources.CustomInterest custom_interest = 104; + google.ads.googleads.v12.resources.CustomInterest custom_interest = 104; // The customer referenced in the query. - google.ads.googleads.v9.resources.Customer customer = 1; + google.ads.googleads.v12.resources.Customer customer = 1; // The customer asset referenced in the query. - google.ads.googleads.v9.resources.CustomerAsset customer_asset = 155; + google.ads.googleads.v12.resources.CustomerAsset customer_asset = 155; + + // The customer asset set referenced in the query. + google.ads.googleads.v12.resources.CustomerAssetSet customer_asset_set = 195; // The accessible bidding strategy referenced in the query. - google.ads.googleads.v9.resources.AccessibleBiddingStrategy accessible_bidding_strategy = 169; + google.ads.googleads.v12.resources.AccessibleBiddingStrategy accessible_bidding_strategy = 169; // The customer customizer referenced in the query. - google.ads.googleads.v9.resources.CustomerCustomizer customer_customizer = 184; + google.ads.googleads.v12.resources.CustomerCustomizer customer_customizer = 184; // The CustomerManagerLink referenced in the query. - google.ads.googleads.v9.resources.CustomerManagerLink customer_manager_link = 61; + google.ads.googleads.v12.resources.CustomerManagerLink customer_manager_link = 61; // The CustomerClientLink referenced in the query. - google.ads.googleads.v9.resources.CustomerClientLink customer_client_link = 62; + google.ads.googleads.v12.resources.CustomerClientLink customer_client_link = 62; // The CustomerClient referenced in the query. - google.ads.googleads.v9.resources.CustomerClient customer_client = 70; + google.ads.googleads.v12.resources.CustomerClient customer_client = 70; // The CustomerConversionGoal referenced in the query. - google.ads.googleads.v9.resources.CustomerConversionGoal customer_conversion_goal = 174; + google.ads.googleads.v12.resources.CustomerConversionGoal customer_conversion_goal = 174; // The customer extension setting referenced in the query. - google.ads.googleads.v9.resources.CustomerExtensionSetting customer_extension_setting = 114; + google.ads.googleads.v12.resources.CustomerExtensionSetting customer_extension_setting = 114; // The customer feed referenced in the query. - google.ads.googleads.v9.resources.CustomerFeed customer_feed = 64; + google.ads.googleads.v12.resources.CustomerFeed customer_feed = 64; // The customer label referenced in the query. - google.ads.googleads.v9.resources.CustomerLabel customer_label = 124; + google.ads.googleads.v12.resources.CustomerLabel customer_label = 124; // The customer negative criterion referenced in the query. - google.ads.googleads.v9.resources.CustomerNegativeCriterion customer_negative_criterion = 88; + google.ads.googleads.v12.resources.CustomerNegativeCriterion customer_negative_criterion = 88; // The CustomerUserAccess referenced in the query. - google.ads.googleads.v9.resources.CustomerUserAccess customer_user_access = 146; + google.ads.googleads.v12.resources.CustomerUserAccess customer_user_access = 146; // The CustomerUserAccessInvitation referenced in the query. - google.ads.googleads.v9.resources.CustomerUserAccessInvitation customer_user_access_invitation = 150; + google.ads.googleads.v12.resources.CustomerUserAccessInvitation customer_user_access_invitation = 150; // The customizer attribute referenced in the query. - google.ads.googleads.v9.resources.CustomizerAttribute customizer_attribute = 178; + google.ads.googleads.v12.resources.CustomizerAttribute customizer_attribute = 178; // The detail placement view referenced in the query. - google.ads.googleads.v9.resources.DetailPlacementView detail_placement_view = 118; + google.ads.googleads.v12.resources.DetailPlacementView detail_placement_view = 118; // The detailed demographic referenced in the query. - google.ads.googleads.v9.resources.DetailedDemographic detailed_demographic = 166; + google.ads.googleads.v12.resources.DetailedDemographic detailed_demographic = 166; // The display keyword view referenced in the query. - google.ads.googleads.v9.resources.DisplayKeywordView display_keyword_view = 47; + google.ads.googleads.v12.resources.DisplayKeywordView display_keyword_view = 47; // The distance view referenced in the query. - google.ads.googleads.v9.resources.DistanceView distance_view = 132; + google.ads.googleads.v12.resources.DistanceView distance_view = 132; // The dynamic search ads search term view referenced in the query. - google.ads.googleads.v9.resources.DynamicSearchAdsSearchTermView dynamic_search_ads_search_term_view = 106; + google.ads.googleads.v12.resources.DynamicSearchAdsSearchTermView dynamic_search_ads_search_term_view = 106; // The expanded landing page view referenced in the query. - google.ads.googleads.v9.resources.ExpandedLandingPageView expanded_landing_page_view = 128; + google.ads.googleads.v12.resources.ExpandedLandingPageView expanded_landing_page_view = 128; // The extension feed item referenced in the query. - google.ads.googleads.v9.resources.ExtensionFeedItem extension_feed_item = 85; + google.ads.googleads.v12.resources.ExtensionFeedItem extension_feed_item = 85; // The feed referenced in the query. - google.ads.googleads.v9.resources.Feed feed = 46; + google.ads.googleads.v12.resources.Feed feed = 46; // The feed item referenced in the query. - google.ads.googleads.v9.resources.FeedItem feed_item = 50; + google.ads.googleads.v12.resources.FeedItem feed_item = 50; // The feed item set referenced in the query. - google.ads.googleads.v9.resources.FeedItemSet feed_item_set = 149; + google.ads.googleads.v12.resources.FeedItemSet feed_item_set = 149; // The feed item set link referenced in the query. - google.ads.googleads.v9.resources.FeedItemSetLink feed_item_set_link = 151; + google.ads.googleads.v12.resources.FeedItemSetLink feed_item_set_link = 151; // The feed item target referenced in the query. - google.ads.googleads.v9.resources.FeedItemTarget feed_item_target = 116; + google.ads.googleads.v12.resources.FeedItemTarget feed_item_target = 116; // The feed mapping referenced in the query. - google.ads.googleads.v9.resources.FeedMapping feed_mapping = 58; + google.ads.googleads.v12.resources.FeedMapping feed_mapping = 58; // The feed placeholder view referenced in the query. - google.ads.googleads.v9.resources.FeedPlaceholderView feed_placeholder_view = 97; + google.ads.googleads.v12.resources.FeedPlaceholderView feed_placeholder_view = 97; // The gender view referenced in the query. - google.ads.googleads.v9.resources.GenderView gender_view = 40; + google.ads.googleads.v12.resources.GenderView gender_view = 40; // The geo target constant referenced in the query. - google.ads.googleads.v9.resources.GeoTargetConstant geo_target_constant = 23; + google.ads.googleads.v12.resources.GeoTargetConstant geo_target_constant = 23; // The geographic view referenced in the query. - google.ads.googleads.v9.resources.GeographicView geographic_view = 125; + google.ads.googleads.v12.resources.GeographicView geographic_view = 125; // The group placement view referenced in the query. - google.ads.googleads.v9.resources.GroupPlacementView group_placement_view = 119; + google.ads.googleads.v12.resources.GroupPlacementView group_placement_view = 119; // The hotel group view referenced in the query. - google.ads.googleads.v9.resources.HotelGroupView hotel_group_view = 51; + google.ads.googleads.v12.resources.HotelGroupView hotel_group_view = 51; // The hotel performance view referenced in the query. - google.ads.googleads.v9.resources.HotelPerformanceView hotel_performance_view = 71; + google.ads.googleads.v12.resources.HotelPerformanceView hotel_performance_view = 71; // The hotel reconciliation referenced in the query. - google.ads.googleads.v9.resources.HotelReconciliation hotel_reconciliation = 188; + google.ads.googleads.v12.resources.HotelReconciliation hotel_reconciliation = 188; // The income range view referenced in the query. - google.ads.googleads.v9.resources.IncomeRangeView income_range_view = 138; + google.ads.googleads.v12.resources.IncomeRangeView income_range_view = 138; // The keyword view referenced in the query. - google.ads.googleads.v9.resources.KeywordView keyword_view = 21; + google.ads.googleads.v12.resources.KeywordView keyword_view = 21; // The keyword plan referenced in the query. - google.ads.googleads.v9.resources.KeywordPlan keyword_plan = 32; + google.ads.googleads.v12.resources.KeywordPlan keyword_plan = 32; // The keyword plan campaign referenced in the query. - google.ads.googleads.v9.resources.KeywordPlanCampaign keyword_plan_campaign = 33; + google.ads.googleads.v12.resources.KeywordPlanCampaign keyword_plan_campaign = 33; // The keyword plan campaign keyword referenced in the query. - google.ads.googleads.v9.resources.KeywordPlanCampaignKeyword keyword_plan_campaign_keyword = 140; + google.ads.googleads.v12.resources.KeywordPlanCampaignKeyword keyword_plan_campaign_keyword = 140; // The keyword plan ad group referenced in the query. - google.ads.googleads.v9.resources.KeywordPlanAdGroup keyword_plan_ad_group = 35; + google.ads.googleads.v12.resources.KeywordPlanAdGroup keyword_plan_ad_group = 35; // The keyword plan ad group referenced in the query. - google.ads.googleads.v9.resources.KeywordPlanAdGroupKeyword keyword_plan_ad_group_keyword = 141; + google.ads.googleads.v12.resources.KeywordPlanAdGroupKeyword keyword_plan_ad_group_keyword = 141; // The keyword theme constant referenced in the query. - google.ads.googleads.v9.resources.KeywordThemeConstant keyword_theme_constant = 163; + google.ads.googleads.v12.resources.KeywordThemeConstant keyword_theme_constant = 163; // The label referenced in the query. - google.ads.googleads.v9.resources.Label label = 52; + google.ads.googleads.v12.resources.Label label = 52; // The landing page view referenced in the query. - google.ads.googleads.v9.resources.LandingPageView landing_page_view = 126; + google.ads.googleads.v12.resources.LandingPageView landing_page_view = 126; // The language constant referenced in the query. - google.ads.googleads.v9.resources.LanguageConstant language_constant = 55; + google.ads.googleads.v12.resources.LanguageConstant language_constant = 55; // The location view referenced in the query. - google.ads.googleads.v9.resources.LocationView location_view = 123; + google.ads.googleads.v12.resources.LocationView location_view = 123; // The managed placement view referenced in the query. - google.ads.googleads.v9.resources.ManagedPlacementView managed_placement_view = 53; + google.ads.googleads.v12.resources.ManagedPlacementView managed_placement_view = 53; // The media file referenced in the query. - google.ads.googleads.v9.resources.MediaFile media_file = 90; + google.ads.googleads.v12.resources.MediaFile media_file = 90; // The mobile app category constant referenced in the query. - google.ads.googleads.v9.resources.MobileAppCategoryConstant mobile_app_category_constant = 87; + google.ads.googleads.v12.resources.MobileAppCategoryConstant mobile_app_category_constant = 87; // The mobile device constant referenced in the query. - google.ads.googleads.v9.resources.MobileDeviceConstant mobile_device_constant = 98; + google.ads.googleads.v12.resources.MobileDeviceConstant mobile_device_constant = 98; // The offline user data job referenced in the query. - google.ads.googleads.v9.resources.OfflineUserDataJob offline_user_data_job = 137; + google.ads.googleads.v12.resources.OfflineUserDataJob offline_user_data_job = 137; // The operating system version constant referenced in the query. - google.ads.googleads.v9.resources.OperatingSystemVersionConstant operating_system_version_constant = 86; + google.ads.googleads.v12.resources.OperatingSystemVersionConstant operating_system_version_constant = 86; // The paid organic search term view referenced in the query. - google.ads.googleads.v9.resources.PaidOrganicSearchTermView paid_organic_search_term_view = 129; + google.ads.googleads.v12.resources.PaidOrganicSearchTermView paid_organic_search_term_view = 129; // The parental status view referenced in the query. - google.ads.googleads.v9.resources.ParentalStatusView parental_status_view = 45; + google.ads.googleads.v12.resources.ParentalStatusView parental_status_view = 45; + + // The per store view referenced in the query. + google.ads.googleads.v12.resources.PerStoreView per_store_view = 198; // The Product Bidding Category referenced in the query. - google.ads.googleads.v9.resources.ProductBiddingCategoryConstant product_bidding_category_constant = 109; + google.ads.googleads.v12.resources.ProductBiddingCategoryConstant product_bidding_category_constant = 109; // The product group view referenced in the query. - google.ads.googleads.v9.resources.ProductGroupView product_group_view = 54; + google.ads.googleads.v12.resources.ProductGroupView product_group_view = 54; // The recommendation referenced in the query. - google.ads.googleads.v9.resources.Recommendation recommendation = 22; + google.ads.googleads.v12.resources.Recommendation recommendation = 22; // The search term view referenced in the query. - google.ads.googleads.v9.resources.SearchTermView search_term_view = 68; + google.ads.googleads.v12.resources.SearchTermView search_term_view = 68; // The shared set referenced in the query. - google.ads.googleads.v9.resources.SharedCriterion shared_criterion = 29; + google.ads.googleads.v12.resources.SharedCriterion shared_criterion = 29; // The shared set referenced in the query. - google.ads.googleads.v9.resources.SharedSet shared_set = 27; + google.ads.googleads.v12.resources.SharedSet shared_set = 27; // The Smart campaign setting referenced in the query. - google.ads.googleads.v9.resources.SmartCampaignSetting smart_campaign_setting = 167; + google.ads.googleads.v12.resources.SmartCampaignSetting smart_campaign_setting = 167; // The shopping performance view referenced in the query. - google.ads.googleads.v9.resources.ShoppingPerformanceView shopping_performance_view = 117; + google.ads.googleads.v12.resources.ShoppingPerformanceView shopping_performance_view = 117; // The Smart campaign search term view referenced in the query. - google.ads.googleads.v9.resources.SmartCampaignSearchTermView smart_campaign_search_term_view = 170; + google.ads.googleads.v12.resources.SmartCampaignSearchTermView smart_campaign_search_term_view = 170; // The AccountLink referenced in the query. - google.ads.googleads.v9.resources.ThirdPartyAppAnalyticsLink third_party_app_analytics_link = 144; + google.ads.googleads.v12.resources.ThirdPartyAppAnalyticsLink third_party_app_analytics_link = 144; // The topic view referenced in the query. - google.ads.googleads.v9.resources.TopicView topic_view = 44; + google.ads.googleads.v12.resources.TopicView topic_view = 44; + + // The experiment referenced in the query. + google.ads.googleads.v12.resources.Experiment experiment = 133; + + // The experiment arm referenced in the query. + google.ads.googleads.v12.resources.ExperimentArm experiment_arm = 183; // The user interest referenced in the query. - google.ads.googleads.v9.resources.UserInterest user_interest = 59; + google.ads.googleads.v12.resources.UserInterest user_interest = 59; // The life event referenced in the query. - google.ads.googleads.v9.resources.LifeEvent life_event = 161; + google.ads.googleads.v12.resources.LifeEvent life_event = 161; // The user list referenced in the query. - google.ads.googleads.v9.resources.UserList user_list = 38; + google.ads.googleads.v12.resources.UserList user_list = 38; // The user location view referenced in the query. - google.ads.googleads.v9.resources.UserLocationView user_location_view = 135; + google.ads.googleads.v12.resources.UserLocationView user_location_view = 135; // The remarketing action referenced in the query. - google.ads.googleads.v9.resources.RemarketingAction remarketing_action = 60; + google.ads.googleads.v12.resources.RemarketingAction remarketing_action = 60; // The topic constant referenced in the query. - google.ads.googleads.v9.resources.TopicConstant topic_constant = 31; + google.ads.googleads.v12.resources.TopicConstant topic_constant = 31; // The video referenced in the query. - google.ads.googleads.v9.resources.Video video = 39; + google.ads.googleads.v12.resources.Video video = 39; // The webpage view referenced in the query. - google.ads.googleads.v9.resources.WebpageView webpage_view = 162; + google.ads.googleads.v12.resources.WebpageView webpage_view = 162; + + // The lead form user submission referenced in the query. + google.ads.googleads.v12.resources.LeadFormSubmissionData lead_form_submission_data = 192; // The metrics. - google.ads.googleads.v9.common.Metrics metrics = 4; + google.ads.googleads.v12.common.Metrics metrics = 4; // The segments. - google.ads.googleads.v9.common.Segments segments = 102; + google.ads.googleads.v12.common.Segments segments = 102; } -// Request message for [GoogleAdsService.Mutate][google.ads.googleads.v9.services.GoogleAdsService.Mutate]. +// Request message for [GoogleAdsService.Mutate][google.ads.googleads.v12.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]; @@ -970,16 +1014,16 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + // field. For example, MutateCampaignResult.campaign. + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } -// Response message for [GoogleAdsService.Mutate][google.ads.googleads.v9.services.GoogleAdsService.Mutate]. +// Response message for [GoogleAdsService.Mutate][google.ads.googleads.v12.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. @@ -1041,6 +1085,9 @@ message MutateOperation { // An asset group listing group filter mutate operation. AssetGroupListingGroupFilterOperation asset_group_listing_group_filter_operation = 78; + // An asset group signal mutate operation. + AssetGroupSignalOperation asset_group_signal_operation = 80; + // An asset group mutate operation. AssetGroupOperation asset_group_operation = 62; @@ -1050,6 +1097,9 @@ message MutateOperation { // An asset set mutate operation. AssetSetOperation asset_set_operation = 72; + // An audience mutate operation. + AudienceOperation audience_operation = 81; + // A bidding data exclusion mutate operation. BiddingDataExclusionOperation bidding_data_exclusion_operation = 58; @@ -1083,15 +1133,15 @@ message MutateOperation { // 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; // A campaign feed mutate operation. CampaignFeedOperation campaign_feed_operation = 27; + // A campaign group mutate operation. + CampaignGroupOperation campaign_group_operation = 9; + // A campaign label mutate operation. CampaignLabelOperation campaign_label_operation = 28; @@ -1126,7 +1176,7 @@ message MutateOperation { CustomerConversionGoalOperation customer_conversion_goal_operation = 66; // An customer customizer mutate operation. - CustomerCustomizerOperation customizer_customizer_operation = 74; + CustomerCustomizerOperation customer_customizer_operation = 79; // A customer extension setting mutate operation. CustomerExtensionSettingOperation customer_extension_setting_operation = 30; @@ -1146,6 +1196,12 @@ message MutateOperation { // An customizer attribute mutate operation. CustomizerAttributeOperation customizer_attribute_operation = 70; + // An experiment mutate operation. + ExperimentOperation experiment_operation = 82; + + // An experiment arm mutate operation. + ExperimentArmOperation experiment_arm_operation = 83; + // An extension feed item mutate operation. ExtensionFeedItemOperation extension_feed_item_operation = 36; @@ -1260,6 +1316,9 @@ message MutateOperationResponse { // The result for the asset group listing group filter mutate. MutateAssetGroupListingGroupFilterResult asset_group_listing_group_filter_result = 78; + // The result for the asset group signal mutate. + MutateAssetGroupSignalResult asset_group_signal_result = 79; + // The result for the asset group mutate. MutateAssetGroupResult asset_group_result = 62; @@ -1269,6 +1328,9 @@ message MutateOperationResponse { // The result for the asset set mutate. MutateAssetSetResult asset_set_result = 72; + // The result for the audience mutate. + MutateAudienceResult audience_result = 80; + // The result for the bidding data exclusion mutate. MutateBiddingDataExclusionsResult bidding_data_exclusion_result = 58; @@ -1302,15 +1364,15 @@ 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; // The result for the campaign feed mutate. MutateCampaignFeedResult campaign_feed_result = 27; + // The result for the campaign group mutate. + MutateCampaignGroupResult campaign_group_result = 9; + // The result for the campaign label mutate. MutateCampaignLabelResult campaign_label_result = 28; @@ -1365,6 +1427,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; diff --git a/google/ads/googleads/v9/services/invoice_service.proto b/google/ads/googleads/v12/services/invoice_service.proto similarity index 77% rename from google/ads/googleads/v9/services/invoice_service.proto rename to google/ads/googleads/v12/services/invoice_service.proto index ce8d3734e..93854872f 100644 --- a/google/ads/googleads/v9/services/invoice_service.proto +++ b/google/ads/googleads/v12/services/invoice_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. @@ -14,22 +14,22 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/month_of_year.proto"; -import "google/ads/googleads/v9/resources/invoice.proto"; +import "google/ads/googleads/v12/enums/month_of_year.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "InvoiceServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Invoice service. @@ -51,7 +51,7 @@ service InvoiceService { // [RequestError]() rpc ListInvoices(ListInvoicesRequest) returns (ListInvoicesResponse) { option (google.api.http) = { - get: "/v9/customers/{customer_id=*}/invoices" + get: "/v12/customers/{customer_id=*}/invoices" }; option (google.api.method_signature) = "customer_id,billing_setup,issue_year,issue_month"; } @@ -73,11 +73,11 @@ message ListInvoicesRequest { string issue_year = 3 [(google.api.field_behavior) = REQUIRED]; // Required. The issue month to retrieve invoices. - google.ads.googleads.v9.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [InvoiceService.ListInvoices][google.ads.googleads.v9.services.InvoiceService.ListInvoices]. +// Response message for [InvoiceService.ListInvoices][google.ads.googleads.v12.services.InvoiceService.ListInvoices]. message ListInvoicesResponse { // The list of invoices that match the billing setup and time period. - repeated google.ads.googleads.v9.resources.Invoice invoices = 1; + repeated google.ads.googleads.v12.resources.Invoice invoices = 1; } diff --git a/google/ads/googleads/v9/services/keyword_plan_ad_group_keyword_service.proto b/google/ads/googleads/v12/services/keyword_plan_ad_group_keyword_service.proto similarity index 70% rename from google/ads/googleads/v9/services/keyword_plan_ad_group_keyword_service.proto rename to google/ads/googleads/v12/services/keyword_plan_ad_group_keyword_service.proto index 5001b10db..0a9014de9 100644 --- a/google/ads/googleads/v9/services/keyword_plan_ad_group_keyword_service.proto +++ b/google/ads/googleads/v12/services/keyword_plan_ad_group_keyword_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/keyword_plan_ad_group_keyword.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupKeywordServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the keyword plan ad group keyword service. @@ -44,22 +44,6 @@ service KeywordPlanAdGroupKeywordService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested Keyword Plan ad group keyword in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordPlanAdGroupKeyword(GetKeywordPlanAdGroupKeywordRequest) returns (google.ads.googleads.v9.resources.KeywordPlanAdGroupKeyword) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordPlanAdGroupKeywords/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes Keyword Plan ad group keywords. Operation // statuses are returned. // @@ -78,7 +62,7 @@ service KeywordPlanAdGroupKeywordService { // [ResourceCountLimitExceededError]() rpc MutateKeywordPlanAdGroupKeywords(MutateKeywordPlanAdGroupKeywordsRequest) returns (MutateKeywordPlanAdGroupKeywordsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate" + post: "/v12/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -86,19 +70,7 @@ service KeywordPlanAdGroupKeywordService { } // Request message for -// [KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword][google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword]. -message GetKeywordPlanAdGroupKeywordRequest { - // Required. The resource name of the ad group keyword to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword" - } - ]; -} - -// Request message for -// [KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords][google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords]. +// [KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords][google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords]. message MutateKeywordPlanAdGroupKeywordsRequest { // Required. The ID of the customer whose Keyword Plan ad group keywords are being // modified. @@ -130,11 +102,11 @@ message KeywordPlanAdGroupKeywordOperation { oneof operation { // Create operation: No resource name is expected for the new Keyword Plan // ad group keyword. - google.ads.googleads.v9.resources.KeywordPlanAdGroupKeyword create = 1; + google.ads.googleads.v12.resources.KeywordPlanAdGroupKeyword create = 1; // Update operation: The Keyword Plan ad group keyword is expected to have a // valid resource name. - google.ads.googleads.v9.resources.KeywordPlanAdGroupKeyword update = 2; + google.ads.googleads.v12.resources.KeywordPlanAdGroupKeyword update = 2; // Remove operation: A resource name for the removed Keyword Plan ad group // keyword is expected, in this format: @@ -150,8 +122,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. @@ -161,5 +133,7 @@ message MutateKeywordPlanAdGroupKeywordsResponse { // The result for the Keyword Plan ad group keyword mutate. message MutateKeywordPlanAdGroupKeywordResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword" + }]; } diff --git a/google/ads/googleads/v9/services/keyword_plan_ad_group_service.proto b/google/ads/googleads/v12/services/keyword_plan_ad_group_service.proto similarity index 70% rename from google/ads/googleads/v9/services/keyword_plan_ad_group_service.proto rename to google/ads/googleads/v12/services/keyword_plan_ad_group_service.proto index a77967a1a..869c5ef62 100644 --- a/google/ads/googleads/v9/services/keyword_plan_ad_group_service.proto +++ b/google/ads/googleads/v12/services/keyword_plan_ad_group_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/keyword_plan_ad_group.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanAdGroupServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the keyword plan ad group service. @@ -40,22 +40,6 @@ service KeywordPlanAdGroupService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested Keyword Plan ad group in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordPlanAdGroup(GetKeywordPlanAdGroupRequest) returns (google.ads.googleads.v9.resources.KeywordPlanAdGroup) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordPlanAdGroups/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes Keyword Plan ad groups. Operation statuses are // returned. // @@ -76,25 +60,14 @@ service KeywordPlanAdGroupService { // [ResourceCountLimitExceededError]() rpc MutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest) returns (MutateKeywordPlanAdGroupsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/keywordPlanAdGroups:mutate" + post: "/v12/customers/{customer_id=*}/keywordPlanAdGroups:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [KeywordPlanAdGroupService.GetKeywordPlanAdGroup][google.ads.googleads.v9.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup]. -message GetKeywordPlanAdGroupRequest { - // Required. The resource name of the Keyword Plan ad group to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordPlanAdGroup" - } - ]; -} - -// Request message for [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v9.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups]. +// Request message for [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups]. message MutateKeywordPlanAdGroupsRequest { // Required. The ID of the customer whose Keyword Plan ad groups are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -123,11 +96,11 @@ message KeywordPlanAdGroupOperation { oneof operation { // Create operation: No resource name is expected for the new Keyword Plan // ad group. - google.ads.googleads.v9.resources.KeywordPlanAdGroup create = 1; + google.ads.googleads.v12.resources.KeywordPlanAdGroup create = 1; // Update operation: The Keyword Plan ad group is expected to have a valid // resource name. - google.ads.googleads.v9.resources.KeywordPlanAdGroup update = 2; + google.ads.googleads.v12.resources.KeywordPlanAdGroup update = 2; // Remove operation: A resource name for the removed Keyword Plan ad group // is expected, in this format: @@ -143,8 +116,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 @@ -155,5 +128,7 @@ message MutateKeywordPlanAdGroupsResponse { // The result for the Keyword Plan ad group mutate. message MutateKeywordPlanAdGroupResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/KeywordPlanAdGroup" + }]; } diff --git a/google/ads/googleads/v9/services/keyword_plan_campaign_keyword_service.proto b/google/ads/googleads/v12/services/keyword_plan_campaign_keyword_service.proto similarity index 70% rename from google/ads/googleads/v9/services/keyword_plan_campaign_keyword_service.proto rename to google/ads/googleads/v12/services/keyword_plan_campaign_keyword_service.proto index 0ff3934f2..26ac9c565 100644 --- a/google/ads/googleads/v9/services/keyword_plan_campaign_keyword_service.proto +++ b/google/ads/googleads/v12/services/keyword_plan_campaign_keyword_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/keyword_plan_campaign_keyword.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignKeywordServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the keyword plan campaign keyword service. @@ -43,22 +43,6 @@ service KeywordPlanCampaignKeywordService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested plan in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordPlanCampaignKeyword(GetKeywordPlanCampaignKeywordRequest) returns (google.ads.googleads.v9.resources.KeywordPlanCampaignKeyword) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordPlanCampaignKeywords/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes Keyword Plan campaign keywords. Operation // statuses are returned. // @@ -76,7 +60,7 @@ service KeywordPlanCampaignKeywordService { // [ResourceCountLimitExceededError]() rpc MutateKeywordPlanCampaignKeywords(MutateKeywordPlanCampaignKeywordsRequest) returns (MutateKeywordPlanCampaignKeywordsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate" + post: "/v12/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -84,19 +68,7 @@ service KeywordPlanCampaignKeywordService { } // Request message for -// [KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword][google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword]. -message GetKeywordPlanCampaignKeywordRequest { - // Required. The resource name of the plan to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordPlanCampaignKeyword" - } - ]; -} - -// Request message for -// [KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords][google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords]. +// [KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords][google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords]. message MutateKeywordPlanCampaignKeywordsRequest { // Required. The ID of the customer whose campaign keywords are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -127,11 +99,11 @@ message KeywordPlanCampaignKeywordOperation { oneof operation { // Create operation: No resource name is expected for the new Keyword Plan // campaign keyword. - google.ads.googleads.v9.resources.KeywordPlanCampaignKeyword create = 1; + google.ads.googleads.v12.resources.KeywordPlanCampaignKeyword create = 1; // Update operation: The Keyword Plan campaign keyword expected to have a // valid resource name. - google.ads.googleads.v9.resources.KeywordPlanCampaignKeyword update = 2; + google.ads.googleads.v12.resources.KeywordPlanCampaignKeyword update = 2; // Remove operation: A resource name for the removed Keyword Plan campaign // keywords expected in this format: @@ -147,8 +119,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. @@ -158,5 +130,7 @@ message MutateKeywordPlanCampaignKeywordsResponse { // The result for the Keyword Plan campaign keyword mutate. message MutateKeywordPlanCampaignKeywordResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/KeywordPlanCampaignKeyword" + }]; } diff --git a/google/ads/googleads/v9/services/keyword_plan_campaign_service.proto b/google/ads/googleads/v12/services/keyword_plan_campaign_service.proto similarity index 69% rename from google/ads/googleads/v9/services/keyword_plan_campaign_service.proto rename to google/ads/googleads/v12/services/keyword_plan_campaign_service.proto index 56ec51152..3e38b7adb 100644 --- a/google/ads/googleads/v9/services/keyword_plan_campaign_service.proto +++ b/google/ads/googleads/v12/services/keyword_plan_campaign_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/keyword_plan_campaign.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanCampaignServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the keyword plan campaign service. @@ -40,22 +40,6 @@ service KeywordPlanCampaignService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested Keyword Plan campaign in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordPlanCampaign(GetKeywordPlanCampaignRequest) returns (google.ads.googleads.v9.resources.KeywordPlanCampaign) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordPlanCampaigns/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes Keyword Plan campaigns. Operation statuses are // returned. // @@ -77,26 +61,15 @@ service KeywordPlanCampaignService { // [ResourceCountLimitExceededError]() rpc MutateKeywordPlanCampaigns(MutateKeywordPlanCampaignsRequest) returns (MutateKeywordPlanCampaignsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/keywordPlanCampaigns:mutate" + post: "/v12/customers/{customer_id=*}/keywordPlanCampaigns:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [KeywordPlanCampaignService.GetKeywordPlanCampaign][google.ads.googleads.v9.services.KeywordPlanCampaignService.GetKeywordPlanCampaign]. -message GetKeywordPlanCampaignRequest { - // Required. The resource name of the Keyword Plan campaign to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordPlanCampaign" - } - ]; -} - // Request message for -// [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v9.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns]. +// [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns]. message MutateKeywordPlanCampaignsRequest { // Required. The ID of the customer whose Keyword Plan campaigns are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -125,11 +98,11 @@ message KeywordPlanCampaignOperation { oneof operation { // Create operation: No resource name is expected for the new Keyword Plan // campaign. - google.ads.googleads.v9.resources.KeywordPlanCampaign create = 1; + google.ads.googleads.v12.resources.KeywordPlanCampaign create = 1; // Update operation: The Keyword Plan campaign is expected to have a valid // resource name. - google.ads.googleads.v9.resources.KeywordPlanCampaign update = 2; + google.ads.googleads.v12.resources.KeywordPlanCampaign update = 2; // Remove operation: A resource name for the removed Keyword Plan campaign // is expected, in this format: @@ -145,8 +118,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. @@ -156,5 +129,7 @@ message MutateKeywordPlanCampaignsResponse { // The result for the Keyword Plan campaign mutate. message MutateKeywordPlanCampaignResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/KeywordPlanCampaign" + }]; } diff --git a/google/ads/googleads/v12/services/keyword_plan_idea_service.proto b/google/ads/googleads/v12/services/keyword_plan_idea_service.proto new file mode 100644 index 000000000..0d502fa2c --- /dev/null +++ b/google/ads/googleads/v12/services/keyword_plan_idea_service.proto @@ -0,0 +1,353 @@ +// 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.v12.services; + +import "google/ads/googleads/v12/common/keyword_plan_common.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/enums/keyword_plan_keyword_annotation.proto"; +import "google/ads/googleads/v12/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.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; +option java_multiple_files = true; +option java_outer_classname = "KeywordPlanIdeaServiceProto"; +option java_package = "com.google.ads.googleads.v12.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; + +// Proto file describing the keyword plan idea service. + +// Service to generate keyword ideas. +service KeywordPlanIdeaService { + option (google.api.default_host) = "googleads.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + + // Returns a list of keyword ideas. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [CollectionSizeError]() + // [HeaderError]() + // [InternalError]() + // [KeywordPlanIdeaError]() + // [QuotaError]() + // [RequestError]() + rpc GenerateKeywordIdeas(GenerateKeywordIdeasRequest) returns (GenerateKeywordIdeaResponse) { + option (google.api.http) = { + post: "/v12/customers/{customer_id=*}:generateKeywordIdeas" + body: "*" + }; + } + + // Returns a list of keyword historical metrics. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [CollectionSizeError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc GenerateKeywordHistoricalMetrics(GenerateKeywordHistoricalMetricsRequest) returns (GenerateKeywordHistoricalMetricsResponse) { + option (google.api.http) = { + post: "/v12/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: "/v12/customers/{customer_id=*}:generateAdGroupThemes" + body: "*" + }; + } +} + +// Request message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v12.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. + // 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. 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. + // The default value is false. + bool include_adult_keywords = 10; + + // Token of the page to retrieve. If not specified, the first + // page of results will be returned. To request next page of results use the + // value obtained from `next_page_token` in the previous response. + // The request fields must match across pages. + string page_token = 12; + + // Number of results to retrieve in a single page. + // A maximum of 10,000 results may be returned, if the page_size + // exceeds this, it is ignored. + // If unspecified, at most 10,000 results will be returned. + // The server may decide to further limit the number of returned resources. + // If the response contains fewer than 10,000 results it may not be assumed + // as last page of results. + int32 page_size = 13; + + // Targeting network. + // If not set, Google Search And Partners Network will be used. + google.ads.googleads.v12.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9; + + // The keyword annotations to include in response. + repeated google.ads.googleads.v12.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17; + + // The aggregate fields to include in response. + google.ads.googleads.v12.common.KeywordPlanAggregateMetrics aggregate_metrics = 16; + + // The options for historical metrics data. + google.ads.googleads.v12.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 + // for example, cars, www.example.com/cars. + KeywordAndUrlSeed keyword_and_url_seed = 2; + + // A Keyword or phrase to generate ideas from, for example, cars. + KeywordSeed keyword_seed = 3; + + // A specific url to generate ideas from, for example, www.example.com/cars. + UrlSeed url_seed = 5; + + // The site to generate ideas from, for example, www.example.com. + SiteSeed site_seed = 11; + } +} + +// Keyword And Url Seed +message KeywordAndUrlSeed { + // The URL to crawl in order to generate keyword ideas. + optional string url = 3; + + // Requires at least one keyword. + repeated string keywords = 4; +} + +// Keyword Seed +message KeywordSeed { + // Requires at least one keyword. + repeated string keywords = 2; +} + +// Site Seed +message SiteSeed { + // The domain name of the site. If the customer requesting the ideas doesn't + // own the site provided only public information is returned. + optional string site = 2; +} + +// Url Seed +message UrlSeed { + // The URL to crawl in order to generate keyword ideas. + optional string url = 2; +} + +// Response message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordIdeas]. +message GenerateKeywordIdeaResponse { + // Results of generating keyword ideas. + repeated GenerateKeywordIdeaResult results = 1; + + // The aggregate metrics for all keyword ideas. + google.ads.googleads.v12.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 + // the next request. + // `next_page_token` is not returned for the last page. + string next_page_token = 2; + + // Total number of results available. + int64 total_size = 3; +} + +// The result of generating keyword ideas. +message GenerateKeywordIdeaResult { + // Text of the keyword idea. + // As in Keyword Plan historical metrics, this text may not be an actual + // keyword, but the canonical form of multiple keywords. + // See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService. + optional string text = 5; + + // The historical metrics for the keyword. + google.ads.googleads.v12.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3; + + // The annotations for the keyword. + // The annotation data is only provided if requested. + google.ads.googleads.v12.common.KeywordAnnotations keyword_annotations = 6; + + // The list of close variants from the requested keywords that + // are combined into this GenerateKeywordIdeaResult. See + // https://support.google.com/google-ads/answer/9342105 for the + // definition of "close variants". + repeated string close_variants = 7; +} + +// Request message for +// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics]. +message GenerateKeywordHistoricalMetricsRequest { + // The ID of the customer with the recommendation. + string customer_id = 1; + + // A list of keywords to get historical metrics. + // Not all inputs will be returned as a result of near-exact deduplication. + // For example, if stats for "car" and "cars" are requested, only "car" will + // be returned. + // 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.v12.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7; + + // The aggregate fields to include in response. + google.ads.googleads.v12.common.KeywordPlanAggregateMetrics aggregate_metrics = 8; + + // The options for historical metrics data. + google.ads.googleads.v12.common.HistoricalMetricsOptions historical_metrics_options = 3; +} + +// Response message for +// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v12.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.v12.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 2; +} + +// The result of generating keyword historical metrics. +message GenerateKeywordHistoricalMetricsResult { + // The text of the query associated with one or more keywords. + // Note that we de-dupe your keywords list, eliminating close variants + // before returning the keywords as text. For example, if your request + // originally contained the keywords "car" and "cars", the returned search + // query will only contain "cars". The list of de-duped queries will be + // included in close_variants field. + optional string text = 1; + + // The list of close variants from the requested keywords whose stats + // are combined into this GenerateKeywordHistoricalMetricsResult. + repeated string close_variants = 3; + + // The historical metrics for text and its close variants + google.ads.googleads.v12.common.KeywordPlanHistoricalMetrics keyword_metrics = 2; +} + +// Request message for +// [KeywordPlanIdeaService.GenerateAdGroupThemes][google.ads.googleads.v12.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.v12.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.v12.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/google/ads/googleads/v9/services/keyword_plan_service.proto b/google/ads/googleads/v12/services/keyword_plan_service.proto similarity index 81% rename from google/ads/googleads/v9/services/keyword_plan_service.proto rename to google/ads/googleads/v12/services/keyword_plan_service.proto index 96d13777f..2961ca07b 100644 --- a/google/ads/googleads/v9/services/keyword_plan_service.proto +++ b/google/ads/googleads/v12/services/keyword_plan_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/keyword_plan_common.proto"; -import "google/ads/googleads/v9/resources/keyword_plan.proto"; +import "google/ads/googleads/v12/common/keyword_plan_common.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordPlanServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the keyword plan service. @@ -41,22 +41,6 @@ service KeywordPlanService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested plan in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordPlan(GetKeywordPlanRequest) returns (google.ads.googleads.v9.resources.KeywordPlan) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordPlans/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes keyword plans. Operation statuses are // returned. // @@ -76,7 +60,7 @@ service KeywordPlanService { // [StringLengthError]() rpc MutateKeywordPlans(MutateKeywordPlansRequest) returns (MutateKeywordPlansResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/keywordPlans:mutate" + post: "/v12/customers/{customer_id=*}/keywordPlans:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -99,7 +83,7 @@ service KeywordPlanService { // [RequestError]() rpc GenerateForecastCurve(GenerateForecastCurveRequest) returns (GenerateForecastCurveResponse) { option (google.api.http) = { - post: "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve" + post: "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve" body: "*" }; option (google.api.method_signature) = "keyword_plan"; @@ -123,7 +107,7 @@ service KeywordPlanService { // [RequestError]() rpc GenerateForecastTimeSeries(GenerateForecastTimeSeriesRequest) returns (GenerateForecastTimeSeriesResponse) { option (google.api.http) = { - post: "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries" + post: "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries" body: "*" }; option (google.api.method_signature) = "keyword_plan"; @@ -141,7 +125,7 @@ service KeywordPlanService { // [RequestError]() rpc GenerateForecastMetrics(GenerateForecastMetricsRequest) returns (GenerateForecastMetricsResponse) { option (google.api.http) = { - post: "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics" + post: "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics" body: "*" }; option (google.api.method_signature) = "keyword_plan"; @@ -159,25 +143,14 @@ service KeywordPlanService { // [RequestError]() rpc GenerateHistoricalMetrics(GenerateHistoricalMetricsRequest) returns (GenerateHistoricalMetricsResponse) { option (google.api.http) = { - post: "/v9/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics" + post: "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics" body: "*" }; option (google.api.method_signature) = "keyword_plan"; } } -// Request message for [KeywordPlanService.GetKeywordPlan][google.ads.googleads.v9.services.KeywordPlanService.GetKeywordPlan]. -message GetKeywordPlanRequest { - // Required. The resource name of the plan to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordPlan" - } - ]; -} - -// Request message for [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v9.services.KeywordPlanService.MutateKeywordPlans]. +// Request message for [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v12.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]; @@ -205,11 +178,11 @@ message KeywordPlanOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new keyword plan. - google.ads.googleads.v9.resources.KeywordPlan create = 1; + google.ads.googleads.v12.resources.KeywordPlan create = 1; // Update operation: The keyword plan is expected to have a valid resource // name. - google.ads.googleads.v9.resources.KeywordPlan update = 2; + google.ads.googleads.v12.resources.KeywordPlan update = 2; // Remove operation: A resource name for the removed keyword plan is // expected in this format: @@ -225,8 +198,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. @@ -236,10 +209,12 @@ message MutateKeywordPlansResponse { // The result for the keyword plan mutate. message MutateKeywordPlansResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/KeywordPlan" + }]; } -// Request message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastCurve]. +// Request message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastCurve]. message GenerateForecastCurveRequest { // Required. The resource name of the keyword plan to be forecasted. string keyword_plan = 1 [ @@ -250,14 +225,14 @@ message GenerateForecastCurveRequest { ]; } -// Response message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastCurve]. +// Response message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v12.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.v9.services.KeywordPlanService.GenerateForecastTimeSeries]. +// Request message for [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastTimeSeries]. message GenerateForecastTimeSeriesRequest { // Required. The resource name of the keyword plan to be forecasted. string keyword_plan = 1 [ @@ -268,14 +243,14 @@ message GenerateForecastTimeSeriesRequest { ]; } -// Response message for [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastTimeSeries]. +// Response message for [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v12.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.v9.services.KeywordPlanService.GenerateForecastMetrics]. +// Request message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastMetrics]. message GenerateForecastMetricsRequest { // Required. The resource name of the keyword plan to be forecasted. string keyword_plan = 1 [ @@ -286,7 +261,7 @@ message GenerateForecastMetricsRequest { ]; } -// Response message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v9.services.KeywordPlanService.GenerateForecastMetrics]. +// Response message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastMetrics]. message GenerateForecastMetricsResponse { // List of campaign forecasts. // One maximum. @@ -396,7 +371,7 @@ message ForecastMetrics { optional int64 cost_micros = 11; } -// Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v9.services.KeywordPlanService.GenerateHistoricalMetrics]. +// Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v12.services.KeywordPlanService.GenerateHistoricalMetrics]. message GenerateHistoricalMetricsRequest { // Required. The resource name of the keyword plan of which historical metrics are // requested. @@ -408,19 +383,19 @@ message GenerateHistoricalMetricsRequest { ]; // The aggregate fields to include in response. - google.ads.googleads.v9.common.KeywordPlanAggregateMetrics aggregate_metrics = 2; + google.ads.googleads.v12.common.KeywordPlanAggregateMetrics aggregate_metrics = 2; // The options for historical metrics data. - google.ads.googleads.v9.common.HistoricalMetricsOptions historical_metrics_options = 3; + google.ads.googleads.v12.common.HistoricalMetricsOptions historical_metrics_options = 3; } -// Response message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v9.services.KeywordPlanService.GenerateHistoricalMetrics]. +// Response message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v12.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.v9.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 2; + google.ads.googleads.v12.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 2; } // A keyword historical metrics. @@ -442,5 +417,5 @@ message KeywordPlanKeywordHistoricalMetrics { // The historical metrics for the query associated with one or more // ad_group_keywords in the plan. - google.ads.googleads.v9.common.KeywordPlanHistoricalMetrics keyword_metrics = 2; + google.ads.googleads.v12.common.KeywordPlanHistoricalMetrics keyword_metrics = 2; } diff --git a/google/ads/googleads/v9/services/keyword_theme_constant_service.proto b/google/ads/googleads/v12/services/keyword_theme_constant_service.proto similarity index 58% rename from google/ads/googleads/v9/services/keyword_theme_constant_service.proto rename to google/ads/googleads/v12/services/keyword_theme_constant_service.proto index 7b95eebb3..d85388eb3 100644 --- a/google/ads/googleads/v9/services/keyword_theme_constant_service.proto +++ b/google/ads/googleads/v12/services/keyword_theme_constant_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. @@ -14,22 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/keyword_theme_constant.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "KeywordThemeConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Smart Campaign keyword theme constant service. @@ -38,14 +36,6 @@ service KeywordThemeConstantService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested keyword theme constant in full detail. - rpc GetKeywordThemeConstant(GetKeywordThemeConstantRequest) returns (google.ads.googleads.v9.resources.KeywordThemeConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=keywordThemeConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Returns KeywordThemeConstant suggestions by keyword themes. // // List of thrown errors: @@ -57,28 +47,17 @@ service KeywordThemeConstantService { // [RequestError]() rpc SuggestKeywordThemeConstants(SuggestKeywordThemeConstantsRequest) returns (SuggestKeywordThemeConstantsResponse) { option (google.api.http) = { - post: "/v9/keywordThemeConstants:suggest" + post: "/v12/keywordThemeConstants:suggest" body: "*" }; } } -// Request message for [KeywordThemeConstantService.GetKeywordThemeConstant][google.ads.googleads.v9.services.KeywordThemeConstantService.GetKeywordThemeConstant]. -message GetKeywordThemeConstantRequest { - // Required. The resource name of the keyword theme constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordThemeConstant" - } - ]; -} - // Request message for -// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v9.services.KeywordThemeConstantService.SuggestKeywordThemeConstants]. +// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v12.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 @@ -91,8 +70,8 @@ message SuggestKeywordThemeConstantsRequest { } // Response message for -// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v9.services.KeywordThemeConstantService.SuggestKeywordThemeConstants]. +// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants]. message SuggestKeywordThemeConstantsResponse { // Smart Campaign keyword theme suggestions. - repeated google.ads.googleads.v9.resources.KeywordThemeConstant keyword_theme_constants = 1; + repeated google.ads.googleads.v12.resources.KeywordThemeConstant keyword_theme_constants = 1; } diff --git a/google/ads/googleads/v9/services/label_service.proto b/google/ads/googleads/v12/services/label_service.proto similarity index 69% rename from google/ads/googleads/v9/services/label_service.proto rename to google/ads/googleads/v12/services/label_service.proto index cc4292c2a..6b6bfe427 100644 --- a/google/ads/googleads/v9/services/label_service.proto +++ b/google/ads/googleads/v12/services/label_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/label.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/label.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; @@ -25,36 +25,20 @@ import "google/api/resource.proto"; import "google/protobuf/field_mask.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "LabelServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to manage labels. service LabelService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested label in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetLabel(GetLabelRequest) returns (google.ads.googleads.v9.resources.Label) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/labels/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes labels. Operation statuses are returned. // // List of thrown errors: @@ -83,25 +67,14 @@ service LabelService { // [StringLengthError]() rpc MutateLabels(MutateLabelsRequest) returns (MutateLabelsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/labels:mutate" + post: "/v12/customers/{customer_id=*}/labels:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [LabelService.GetLabel][google.ads.googleads.v9.services.LabelService.GetLabel]. -message GetLabelRequest { - // Required. The resource name of the label to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Label" - } - ]; -} - -// Request message for [LabelService.MutateLabels][google.ads.googleads.v9.services.LabelService.MutateLabels]. +// Request message for [LabelService.MutateLabels][google.ads.googleads.v12.services.LabelService.MutateLabels]. message MutateLabelsRequest { // Required. ID of the customer whose labels are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -121,7 +94,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove, update) on a label. @@ -132,16 +105,18 @@ message LabelOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new label. - google.ads.googleads.v9.resources.Label create = 1; + google.ads.googleads.v12.resources.Label create = 1; // Update operation: The label is expected to have a valid resource name. - google.ads.googleads.v9.resources.Label update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Label" + }]; } } @@ -149,8 +124,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. @@ -160,9 +135,11 @@ message MutateLabelsResponse { // The result for a label mutate. message MutateLabelResult { // Returned for successful operations. - string resource_name = 1; + 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.v9.resources.Label label = 2; + google.ads.googleads.v12.resources.Label label = 2; } diff --git a/google/ads/googleads/v9/services/media_file_service.proto b/google/ads/googleads/v12/services/media_file_service.proto similarity index 67% rename from google/ads/googleads/v9/services/media_file_service.proto rename to google/ads/googleads/v12/services/media_file_service.proto index 28805a3b6..c052705e3 100644 --- a/google/ads/googleads/v9/services/media_file_service.proto +++ b/google/ads/googleads/v12/services/media_file_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/media_file.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "MediaFileServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Media File service. @@ -40,22 +40,6 @@ service MediaFileService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested media file in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetMediaFile(GetMediaFileRequest) returns (google.ads.googleads.v9.resources.MediaFile) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/mediaFiles/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates media files. Operation statuses are returned. // // List of thrown errors: @@ -82,25 +66,14 @@ service MediaFileService { // [StringLengthError]() rpc MutateMediaFiles(MutateMediaFilesRequest) returns (MutateMediaFilesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/mediaFiles:mutate" + post: "/v12/customers/{customer_id=*}/mediaFiles:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [MediaFileService.GetMediaFile][google.ads.googleads.v9.services.MediaFileService.GetMediaFile] -message GetMediaFileRequest { - // Required. The resource name of the media file to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/MediaFile" - } - ]; -} - -// Request message for [MediaFileService.MutateMediaFiles][google.ads.googleads.v9.services.MediaFileService.MutateMediaFiles] +// Request message for [MediaFileService.MutateMediaFiles][google.ads.googleads.v12.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]; @@ -120,7 +93,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation to create media file. @@ -128,7 +101,7 @@ message MediaFileOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new media file. - google.ads.googleads.v9.resources.MediaFile create = 1; + google.ads.googleads.v12.resources.MediaFile create = 1; } } @@ -136,8 +109,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. @@ -147,10 +120,12 @@ message MutateMediaFilesResponse { // The result for the media file mutate. message MutateMediaFileResult { // The resource name returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.MediaFile media_file = 2; + google.ads.googleads.v12.resources.MediaFile media_file = 2; } diff --git a/google/ads/googleads/v9/services/merchant_center_link_service.proto b/google/ads/googleads/v12/services/merchant_center_link_service.proto similarity index 75% rename from google/ads/googleads/v9/services/merchant_center_link_service.proto rename to google/ads/googleads/v12/services/merchant_center_link_service.proto index f966d95bc..a5d5aec9b 100644 --- a/google/ads/googleads/v9/services/merchant_center_link_service.proto +++ b/google/ads/googleads/v12/services/merchant_center_link_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. @@ -14,23 +14,23 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/merchant_center_link.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "MerchantCenterLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the MerchantCenterLink service. @@ -51,7 +51,7 @@ service MerchantCenterLinkService { // [RequestError]() rpc ListMerchantCenterLinks(ListMerchantCenterLinksRequest) returns (ListMerchantCenterLinksResponse) { option (google.api.http) = { - get: "/v9/customers/{customer_id=*}/merchantCenterLinks" + get: "/v12/customers/{customer_id=*}/merchantCenterLinks" }; option (google.api.method_signature) = "customer_id"; } @@ -65,9 +65,9 @@ service MerchantCenterLinkService { // [InternalError]() // [QuotaError]() // [RequestError]() - rpc GetMerchantCenterLink(GetMerchantCenterLinkRequest) returns (google.ads.googleads.v9.resources.MerchantCenterLink) { + rpc GetMerchantCenterLink(GetMerchantCenterLinkRequest) returns (google.ads.googleads.v12.resources.MerchantCenterLink) { option (google.api.http) = { - get: "/v9/{resource_name=customers/*/merchantCenterLinks/*}" + get: "/v12/{resource_name=customers/*/merchantCenterLinks/*}" }; option (google.api.method_signature) = "resource_name"; } @@ -84,27 +84,27 @@ service MerchantCenterLinkService { // [RequestError]() rpc MutateMerchantCenterLink(MutateMerchantCenterLinkRequest) returns (MutateMerchantCenterLinkResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/merchantCenterLinks:mutate" + post: "/v12/customers/{customer_id=*}/merchantCenterLinks:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operation"; } } -// Request message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v9.services.MerchantCenterLinkService.ListMerchantCenterLinks]. +// Request message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v12.services.MerchantCenterLinkService.ListMerchantCenterLinks]. message ListMerchantCenterLinksRequest { // 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.v9.services.MerchantCenterLinkService.ListMerchantCenterLinks]. +// Response message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v12.services.MerchantCenterLinkService.ListMerchantCenterLinks]. message ListMerchantCenterLinksResponse { // Merchant Center links available for the requested customer - repeated google.ads.googleads.v9.resources.MerchantCenterLink merchant_center_links = 1; + repeated google.ads.googleads.v12.resources.MerchantCenterLink merchant_center_links = 1; } -// Request message for [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v9.services.MerchantCenterLinkService.GetMerchantCenterLink]. +// Request message for [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v12.services.MerchantCenterLinkService.GetMerchantCenterLink]. message GetMerchantCenterLinkRequest { // Required. Resource name of the Merchant Center link. string resource_name = 1 [ @@ -115,7 +115,7 @@ message GetMerchantCenterLinkRequest { ]; } -// Request message for [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v9.services.MerchantCenterLinkService.MutateMerchantCenterLink]. +// Request message for [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v12.services.MerchantCenterLinkService.MutateMerchantCenterLink]. message MutateMerchantCenterLinkRequest { // Required. The ID of the customer being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -137,13 +137,15 @@ message MerchantCenterLinkOperation { oneof operation { // Update operation: The merchant center link is expected to have a valid // resource name. - google.ads.googleads.v9.resources.MerchantCenterLink update = 1; + google.ads.googleads.v12.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; + string remove = 2 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/MerchantCenterLink" + }]; } } @@ -156,5 +158,7 @@ message MutateMerchantCenterLinkResponse { // The result for the Merchant Center link mutate. message MutateMerchantCenterLinkResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/MerchantCenterLink" + }]; } diff --git a/google/ads/googleads/v9/services/offline_user_data_job_service.proto b/google/ads/googleads/v12/services/offline_user_data_job_service.proto similarity index 71% rename from google/ads/googleads/v9/services/offline_user_data_job_service.proto rename to google/ads/googleads/v12/services/offline_user_data_job_service.proto index d350ed4b6..efb48522b 100644 --- a/google/ads/googleads/v9/services/offline_user_data_job_service.proto +++ b/google/ads/googleads/v12/services/offline_user_data_job_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/offline_user_data.proto"; -import "google/ads/googleads/v9/resources/offline_user_data_job.proto"; +import "google/ads/googleads/v12/common/offline_user_data.proto"; +import "google/ads/googleads/v12/resources/offline_user_data_job.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/longrunning/operations.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "OfflineUserDataJobServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the OfflineUserDataJobService. @@ -56,28 +56,12 @@ service OfflineUserDataJobService { // [RequestError]() rpc CreateOfflineUserDataJob(CreateOfflineUserDataJobRequest) returns (CreateOfflineUserDataJobResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/offlineUserDataJobs:create" + post: "/v12/customers/{customer_id=*}/offlineUserDataJobs:create" body: "*" }; option (google.api.method_signature) = "customer_id,job"; } - // Returns the offline user data job. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetOfflineUserDataJob(GetOfflineUserDataJobRequest) returns (google.ads.googleads.v9.resources.OfflineUserDataJob) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/offlineUserDataJobs/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Adds operations to the offline user data job. // // List of thrown errors: @@ -93,7 +77,7 @@ service OfflineUserDataJobService { // [RequestError]() rpc AddOfflineUserDataJobOperations(AddOfflineUserDataJobOperationsRequest) returns (AddOfflineUserDataJobOperationsResponse) { option (google.api.http) = { - post: "/v9/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations" + post: "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations" body: "*" }; option (google.api.method_signature) = "resource_name,operations"; @@ -115,25 +99,25 @@ service OfflineUserDataJobService { // [RequestError]() rpc RunOfflineUserDataJob(RunOfflineUserDataJobRequest) returns (google.longrunning.Operation) { option (google.api.http) = { - post: "/v9/{resource_name=customers/*/offlineUserDataJobs/*}:run" + post: "/v12/{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.v9.resources.OfflineUserDataJobMetadata" + metadata_type: "google.ads.googleads.v12.resources.OfflineUserDataJobMetadata" }; } } // Request message for -// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v9.services.OfflineUserDataJobService.CreateOfflineUserDataJob]. +// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v12.services.OfflineUserDataJobService.CreateOfflineUserDataJob]. message CreateOfflineUserDataJobRequest { // 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.v9.resources.OfflineUserDataJob job = 2 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.resources.OfflineUserDataJob job = 2 [(google.api.field_behavior) = REQUIRED]; // If true, the request is validated but not executed. Only errors are // returned, not results. @@ -145,24 +129,15 @@ message CreateOfflineUserDataJobRequest { } // Response message for -// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v9.services.OfflineUserDataJobService.CreateOfflineUserDataJob]. +// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v12.services.OfflineUserDataJobService.CreateOfflineUserDataJob]. message CreateOfflineUserDataJobResponse { // The resource name of the OfflineUserDataJob. - string resource_name = 1; -} - -// Request message for [OfflineUserDataJobService.GetOfflineUserDataJob][google.ads.googleads.v9.services.OfflineUserDataJobService.GetOfflineUserDataJob]. -message GetOfflineUserDataJobRequest { - // Required. The resource name of the OfflineUserDataJob to get. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/OfflineUserDataJob" - } - ]; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/OfflineUserDataJob" + }]; } -// Request message for [OfflineUserDataJobService.RunOfflineUserDataJob][google.ads.googleads.v9.services.OfflineUserDataJobService.RunOfflineUserDataJob]. +// Request message for [OfflineUserDataJobService.RunOfflineUserDataJob][google.ads.googleads.v12.services.OfflineUserDataJobService.RunOfflineUserDataJob]. message RunOfflineUserDataJobRequest { // Required. The resource name of the OfflineUserDataJob to run. string resource_name = 1 [ @@ -178,7 +153,7 @@ message RunOfflineUserDataJobRequest { } // Request message for -// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v9.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations]. +// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v12.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations]. message AddOfflineUserDataJobOperationsRequest { // Required. The resource name of the OfflineUserDataJob. string resource_name = 1 [ @@ -210,11 +185,11 @@ message OfflineUserDataJobOperation { oneof operation { // Add the provided data to the transaction. Data cannot be retrieved after // being uploaded. - google.ads.googleads.v9.common.UserData create = 1; + google.ads.googleads.v12.common.UserData create = 1; // Remove the provided data from the transaction. Data cannot be retrieved // after being uploaded. - google.ads.googleads.v9.common.UserData remove = 2; + google.ads.googleads.v12.common.UserData remove = 2; // Remove all previously provided data. This is only supported for Customer // Match. @@ -223,12 +198,12 @@ message OfflineUserDataJobOperation { } // Response message for -// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v9.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations]. +// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v12.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/google/ads/googleads/v9/services/payments_account_service.proto b/google/ads/googleads/v12/services/payments_account_service.proto similarity index 77% rename from google/ads/googleads/v9/services/payments_account_service.proto rename to google/ads/googleads/v12/services/payments_account_service.proto index ad536d70e..b758400d9 100644 --- a/google/ads/googleads/v9/services/payments_account_service.proto +++ b/google/ads/googleads/v12/services/payments_account_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. @@ -14,21 +14,21 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/payments_account.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "PaymentsAccountServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the payments account service. @@ -52,7 +52,7 @@ service PaymentsAccountService { // [RequestError]() rpc ListPaymentsAccounts(ListPaymentsAccountsRequest) returns (ListPaymentsAccountsResponse) { option (google.api.http) = { - get: "/v9/customers/{customer_id=*}/paymentsAccounts" + get: "/v12/customers/{customer_id=*}/paymentsAccounts" }; option (google.api.method_signature) = "customer_id"; } @@ -64,8 +64,8 @@ message ListPaymentsAccountsRequest { string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v9.services.PaymentsAccountService.ListPaymentsAccounts]. +// Response message for [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts]. message ListPaymentsAccountsResponse { // The list of accessible payments accounts. - repeated google.ads.googleads.v9.resources.PaymentsAccount payments_accounts = 1; + repeated google.ads.googleads.v12.resources.PaymentsAccount payments_accounts = 1; } diff --git a/google/ads/googleads/v9/services/reach_plan_service.proto b/google/ads/googleads/v12/services/reach_plan_service.proto similarity index 66% rename from google/ads/googleads/v9/services/reach_plan_service.proto rename to google/ads/googleads/v12/services/reach_plan_service.proto index 57d8f0f12..ca0e2016b 100644 --- a/google/ads/googleads/v9/services/reach_plan_service.proto +++ b/google/ads/googleads/v12/services/reach_plan_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. @@ -14,26 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/common/dates.proto"; -import "google/ads/googleads/v9/enums/frequency_cap_time_unit.proto"; -import "google/ads/googleads/v9/enums/reach_plan_ad_length.proto"; -import "google/ads/googleads/v9/enums/reach_plan_age_range.proto"; -import "google/ads/googleads/v9/enums/reach_plan_network.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/common/dates.proto"; +import "google/ads/googleads/v12/enums/frequency_cap_time_unit.proto"; +import "google/ads/googleads/v12/enums/reach_plan_age_range.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ReachPlanServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the reach plan service. @@ -46,7 +45,7 @@ service ReachPlanService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the list of plannable locations (for example, countries & DMAs). + // Returns the list of plannable locations (for example, countries). // // List of thrown errors: // [AuthenticationError]() @@ -57,7 +56,7 @@ service ReachPlanService { // [RequestError]() rpc ListPlannableLocations(ListPlannableLocationsRequest) returns (ListPlannableLocationsResponse) { option (google.api.http) = { - post: "/v9:listPlannableLocations" + post: "/v12:listPlannableLocations" body: "*" }; } @@ -74,32 +73,12 @@ service ReachPlanService { // [RequestError]() rpc ListPlannableProducts(ListPlannableProductsRequest) returns (ListPlannableProductsResponse) { option (google.api.http) = { - post: "/v9:listPlannableProducts" + post: "/v12: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: "/v9/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: @@ -114,56 +93,54 @@ service ReachPlanService { // [RequestError]() rpc GenerateReachForecast(GenerateReachForecastRequest) returns (GenerateReachForecastResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:generateReachForecast" + post: "/v12/customers/{customer_id=*}:generateReachForecast" body: "*" }; option (google.api.method_signature) = "customer_id,campaign_duration,planned_products"; } } -// Request message for [ReachPlanService.ListPlannableLocations][google.ads.googleads.v9.services.ReachPlanService.ListPlannableLocations]. +// Request message for [ReachPlanService.ListPlannableLocations][google.ads.googleads.v12.services.ReachPlanService.ListPlannableLocations]. message ListPlannableLocationsRequest { } // The list of plannable locations. message ListPlannableLocationsResponse { - // The list of locations available for planning (Countries, DMAs, - // sub-countries). - // For locations like Countries and DMAs see - // https://developers.google.com/google-ads/api/reference/data/geotargets for - // more information. + // The list of locations available for planning. + // See + // https://developers.google.com/google-ads/api/reference/data/geotargets + // for sample locations. repeated PlannableLocation plannable_locations = 1; } -// A plannable location: a country, a DMA, a metro region, a tv region, -// a province. +// A plannable location: country, metro region, province, etc. message PlannableLocation { // The location identifier. optional string id = 4; - // The unique location name in english. + // The unique location name in English. optional string name = 5; - // The parent country, not present if location is a country. - // If present will always be a GeoTargetConstant ID. Additional information, + // 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.v9.services.ReachPlanService.ListPlannableLocations] or directly by accessing - // [GeoTargetConstantService.GetGeoTargetConstant][google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant]. + // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v12.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. optional string country_code = 7; // The location's type. Location types correspond to target_type returned by - // [GeoTargetConstantService.GetGeoTargetConstant][google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant]. + // searching location type in [GoogleAdsService.Search/SearchStream][]. optional string location_type = 8; } // 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.v9.services.ReachPlanService.ListPlannableLocations]. + // plannable location IDs use [ReachPlanService.ListPlannableLocations][google.ads.googleads.v12.services.ReachPlanService.ListPlannableLocations]. string plannable_location_id = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -175,8 +152,10 @@ message ListPlannableProductsResponse { // The metadata associated with an available plannable product. message ProductMetadata { - // The code associated with the ad product. E.g. BUMPER, TRUEVIEW_IN_STREAM - // To list the available plannable product codes use ListPlannableProducts. + // 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.v12.services.ReachPlanService.ListPlannableProducts]. optional string plannable_product_code = 4; // The name associated with the ad product. @@ -191,87 +170,25 @@ 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.v9.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_ranges = 1; + repeated google.ads.googleads.v12.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_ranges = 1; // Targetable genders for the ad product. - repeated google.ads.googleads.v9.common.GenderInfo genders = 2; + repeated google.ads.googleads.v12.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.v9.common.DeviceInfo devices = 3; + // GOOGLE_PREFERRED_BUMPER, and GOOGLE_PREFERRED_SHORT products. + repeated google.ads.googleads.v12.common.DeviceInfo devices = 3; // Targetable networks for the ad product. - repeated google.ads.googleads.v9.enums.ReachPlanNetworkEnum.ReachPlanNetwork networks = 4; -} - -// Request message for [ReachPlanService.GenerateProductMixIdeas][google.ads.googleads.v9.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.v9.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.v9.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 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.v12.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.v9.services.ReachPlanService.GenerateReachForecast]. +// Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v12.services.ReachPlanService.GenerateReachForecast]. message GenerateReachForecastRequest { // Required. The ID of the customer. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -283,17 +200,17 @@ message GenerateReachForecastRequest { // Required. Campaign duration. CampaignDuration campaign_duration = 3 [(google.api.field_behavior) = REQUIRED]; - // Desired cookie frequency cap that will 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. + // 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 that will 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 +219,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,7 +242,7 @@ 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; @@ -333,6 +250,13 @@ message GenerateReachForecastRequest { // 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]; + + // 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 +274,53 @@ message FrequencyCap { int32 impressions = 3 [(google.api.field_behavior) = REQUIRED]; // Required. The type of time unit. - google.ads.googleads.v9.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.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.v9.services.ReachPlanService.ListPlannableLocations]. + // The ID of the selected location. Plannable location IDs can be + // obtained from [ReachPlanService.ListPlannableLocations][google.ads.googleads.v12.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.v12.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.v9.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2; + google.ads.googleads.v12.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2; // Targeted genders. // An unset value is equivalent to targeting MALE and FEMALE. - repeated google.ads.googleads.v9.common.GenderInfo genders = 3; + repeated google.ads.googleads.v12.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.v9.services.ReachPlanService.ListPlannableProducts]. - repeated google.ads.googleads.v9.common.DeviceInfo devices = 4; + // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v12.services.ReachPlanService.ListPlannableProducts]. + repeated google.ads.googleads.v12.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.v9.services.ReachPlanService.ListPlannableProducts]. - google.ads.googleads.v9.enums.ReachPlanNetworkEnum.ReachPlanNetwork network = 5; + // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v12.services.ReachPlanService.ListPlannableProducts]. + google.ads.googleads.v12.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,21 +336,26 @@ message CampaignDuration { // date range must be <= 92 days long. // // This field cannot be combined with the duration_in_days field. - google.ads.googleads.v9.common.DateRange date_range = 3; + google.ads.googleads.v12.common.DateRange date_range = 3; } // A product being planned for reach. message PlannedProduct { // Required. Selected product for planning. - // The code associated with the ad product. E.g. Trueview, Bumper + // The code associated with the ad product (for example: Trueview, Bumper). // To list the available plannable product codes use - // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v9.services.ReachPlanService.ListPlannableProducts]. + // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v12.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. - // E.g. 1 000 000$ = 1 000 000 000 000 micros. + // 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.v12.services.ReachPlanService.ListPlannableProducts]. + AdvancedProductTargeting advanced_product_targeting = 5; } // Response message containing the generated reach curve. @@ -479,6 +427,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 +493,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 +547,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.v12.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/google/ads/googleads/v9/services/recommendation_service.proto b/google/ads/googleads/v12/services/recommendation_service.proto similarity index 67% rename from google/ads/googleads/v9/services/recommendation_service.proto rename to google/ads/googleads/v12/services/recommendation_service.proto index 58fa37a1c..f18da77bd 100644 --- a/google/ads/googleads/v9/services/recommendation_service.proto +++ b/google/ads/googleads/v12/services/recommendation_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. @@ -14,26 +14,25 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/extensions.proto"; -import "google/ads/googleads/v9/enums/keyword_match_type.proto"; -import "google/ads/googleads/v9/resources/ad.proto"; -import "google/ads/googleads/v9/resources/recommendation.proto"; +import "google/ads/googleads/v12/common/extensions.proto"; +import "google/ads/googleads/v12/enums/keyword_match_type.proto"; +import "google/ads/googleads/v12/resources/ad.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "RecommendationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Recommendation service. @@ -42,22 +41,6 @@ service RecommendationService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested recommendation in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetRecommendation(GetRecommendationRequest) returns (google.ads.googleads.v9.resources.Recommendation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/recommendations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Applies given recommendations with corresponding apply parameters. // // List of thrown errors: @@ -74,7 +57,7 @@ service RecommendationService { // [UrlFieldError]() rpc ApplyRecommendation(ApplyRecommendationRequest) returns (ApplyRecommendationResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/recommendations:apply" + post: "/v12/customers/{customer_id=*}/recommendations:apply" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; @@ -92,25 +75,14 @@ service RecommendationService { // [RequestError]() rpc DismissRecommendation(DismissRecommendationRequest) returns (DismissRecommendationResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/recommendations:dismiss" + post: "/v12/customers/{customer_id=*}/recommendations:dismiss" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [RecommendationService.GetRecommendation][google.ads.googleads.v9.services.RecommendationService.GetRecommendation]. -message GetRecommendationRequest { - // Required. The resource name of the recommendation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Recommendation" - } - ]; -} - -// Request message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v9.services.RecommendationService.ApplyRecommendation]. +// Request message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation]. message ApplyRecommendationRequest { // Required. The ID of the customer with the recommendation. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -137,11 +109,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.v9.resources.Ad ad = 1; + google.ads.googleads.v12.resources.Ad ad = 1; } // Parameters to use when applying keyword recommendation. @@ -150,7 +134,7 @@ message ApplyRecommendationOperation { optional string ad_group = 4; // The match type of the keyword. This is a required field. - google.ads.googleads.v9.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2; + google.ads.googleads.v12.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. @@ -181,19 +165,19 @@ 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.v9.common.CalloutFeedItem callout_extensions = 1; + repeated google.ads.googleads.v12.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.v9.common.CallFeedItem call_extensions = 1; + repeated google.ads.googleads.v12.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.v9.common.SitelinkFeedItem sitelink_extensions = 1; + repeated google.ads.googleads.v12.common.SitelinkFeedItem sitelink_extensions = 1; } // Parameters to use when applying move unused budget recommendation. @@ -203,14 +187,45 @@ message ApplyRecommendationOperation { optional int64 budget_micros_to_move = 2; } + // Parameters to use when applying a responsive search ad asset + // recommendation. + message ResponsiveSearchAdAssetParameters { + // Updated ad. The current ad's content will be replaced. + google.ads.googleads.v12.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.v12.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.v9.resources.Ad ad = 1 [(google.api.field_behavior) = REQUIRED]; + google.ads.googleads.v12.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. + message UseBroadMatchKeywordParameters { + // New budget amount to set for target budget resource. + optional int64 new_budget_amount_micros = 1; } // The resource name of the recommendation to apply. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Recommendation" + }]; // Parameters to use when applying the recommendation. oneof apply_parameters { @@ -246,28 +261,50 @@ message ApplyRecommendationOperation { // Parameters to use when applying a responsive search ad recommendation. ResponsiveSearchAdParameters responsive_search_ad = 11; + + // 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 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; } } -// Response message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v9.services.RecommendationService.ApplyRecommendation]. +// Response message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v12.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; } // The result of applying a recommendation. message ApplyRecommendationResult { // Returned for successful applies. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/Recommendation" + }]; } -// Request message for [RecommendationService.DismissRecommendation][google.ads.googleads.v9.services.RecommendationService.DismissRecommendation]. +// Request message for [RecommendationService.DismissRecommendation][google.ads.googleads.v12.services.RecommendationService.DismissRecommendation]. message DismissRecommendationRequest { // Operation to dismiss a single recommendation identified by resource_name. message DismissRecommendationOperation { @@ -290,7 +327,7 @@ message DismissRecommendationRequest { bool partial_failure = 2; } -// Response message for [RecommendationService.DismissRecommendation][google.ads.googleads.v9.services.RecommendationService.DismissRecommendation]. +// Response message for [RecommendationService.DismissRecommendation][google.ads.googleads.v12.services.RecommendationService.DismissRecommendation]. message DismissRecommendationResponse { // The result of dismissing a recommendation. message DismissRecommendationResult { @@ -303,7 +340,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/google/ads/googleads/v9/services/remarketing_action_service.proto b/google/ads/googleads/v12/services/remarketing_action_service.proto similarity index 66% rename from google/ads/googleads/v9/services/remarketing_action_service.proto rename to google/ads/googleads/v12/services/remarketing_action_service.proto index 5027ced29..b769dd9ee 100644 --- a/google/ads/googleads/v9/services/remarketing_action_service.proto +++ b/google/ads/googleads/v12/services/remarketing_action_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/remarketing_action.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "RemarketingActionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Remarketing Action service. @@ -40,22 +40,6 @@ service RemarketingActionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested remarketing action in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetRemarketingAction(GetRemarketingActionRequest) returns (google.ads.googleads.v9.resources.RemarketingAction) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/remarketingActions/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates remarketing actions. Operation statuses are returned. // // List of thrown errors: @@ -68,25 +52,14 @@ service RemarketingActionService { // [RequestError]() rpc MutateRemarketingActions(MutateRemarketingActionsRequest) returns (MutateRemarketingActionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/remarketingActions:mutate" + post: "/v12/customers/{customer_id=*}/remarketingActions:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [RemarketingActionService.GetRemarketingAction][google.ads.googleads.v9.services.RemarketingActionService.GetRemarketingAction]. -message GetRemarketingActionRequest { - // Required. The resource name of the remarketing action to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/RemarketingAction" - } - ]; -} - -// Request message for [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v9.services.RemarketingActionService.MutateRemarketingActions]. +// Request message for [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions]. message MutateRemarketingActionsRequest { // Required. The ID of the customer whose remarketing actions are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -114,11 +87,11 @@ message RemarketingActionOperation { oneof operation { // Create operation: No resource name is expected for the new remarketing // action. - google.ads.googleads.v9.resources.RemarketingAction create = 1; + google.ads.googleads.v12.resources.RemarketingAction create = 1; // Update operation: The remarketing action is expected to have a valid // resource name. - google.ads.googleads.v9.resources.RemarketingAction update = 2; + google.ads.googleads.v12.resources.RemarketingAction update = 2; } } @@ -126,8 +99,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. @@ -137,5 +110,7 @@ message MutateRemarketingActionsResponse { // The result for the remarketing action mutate. message MutateRemarketingActionResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/RemarketingAction" + }]; } diff --git a/google/ads/googleads/v9/services/shared_criterion_service.proto b/google/ads/googleads/v12/services/shared_criterion_service.proto similarity index 67% rename from google/ads/googleads/v9/services/shared_criterion_service.proto rename to google/ads/googleads/v12/services/shared_criterion_service.proto index 8432fbcc3..88a7c1736 100644 --- a/google/ads/googleads/v9/services/shared_criterion_service.proto +++ b/google/ads/googleads/v12/services/shared_criterion_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/shared_criterion.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "SharedCriterionServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Shared Criterion service. @@ -40,22 +40,6 @@ service SharedCriterionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested shared criterion in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetSharedCriterion(GetSharedCriterionRequest) returns (google.ads.googleads.v9.resources.SharedCriterion) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/sharedCriteria/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or removes shared criteria. Operation statuses are returned. // // List of thrown errors: @@ -81,25 +65,14 @@ service SharedCriterionService { // [StringLengthError]() rpc MutateSharedCriteria(MutateSharedCriteriaRequest) returns (MutateSharedCriteriaResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/sharedCriteria:mutate" + post: "/v12/customers/{customer_id=*}/sharedCriteria:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [SharedCriterionService.GetSharedCriterion][google.ads.googleads.v9.services.SharedCriterionService.GetSharedCriterion]. -message GetSharedCriterionRequest { - // Required. The resource name of the shared criterion to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/SharedCriterion" - } - ]; -} - -// Request message for [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v9.services.SharedCriterionService.MutateSharedCriteria]. +// Request message for [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v12.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]; @@ -119,7 +92,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, remove) on an shared criterion. @@ -128,13 +101,15 @@ message SharedCriterionOperation { oneof operation { // Create operation: No resource name is expected for the new shared // criterion. - google.ads.googleads.v9.resources.SharedCriterion create = 1; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/SharedCriterion" + }]; } } @@ -142,8 +117,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. @@ -153,10 +128,12 @@ message MutateSharedCriteriaResponse { // The result for the shared criterion mutate. message MutateSharedCriterionResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.SharedCriterion shared_criterion = 2; + google.ads.googleads.v12.resources.SharedCriterion shared_criterion = 2; } diff --git a/google/ads/googleads/v9/services/shared_set_service.proto b/google/ads/googleads/v12/services/shared_set_service.proto similarity index 69% rename from google/ads/googleads/v9/services/shared_set_service.proto rename to google/ads/googleads/v12/services/shared_set_service.proto index b81ff5d54..5400ad239 100644 --- a/google/ads/googleads/v9/services/shared_set_service.proto +++ b/google/ads/googleads/v12/services/shared_set_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/shared_set.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "SharedSetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Shared Set service. @@ -41,22 +41,6 @@ service SharedSetService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested shared set in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetSharedSet(GetSharedSetRequest) returns (google.ads.googleads.v9.resources.SharedSet) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/sharedSets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates, updates, or removes shared sets. Operation statuses are returned. // // List of thrown errors: @@ -85,25 +69,14 @@ service SharedSetService { // [StringLengthError]() rpc MutateSharedSets(MutateSharedSetsRequest) returns (MutateSharedSetsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/sharedSets:mutate" + post: "/v12/customers/{customer_id=*}/sharedSets:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [SharedSetService.GetSharedSet][google.ads.googleads.v9.services.SharedSetService.GetSharedSet]. -message GetSharedSetRequest { - // Required. The resource name of the shared set to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/SharedSet" - } - ]; -} - -// Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v9.services.SharedSetService.MutateSharedSets]. +// Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v12.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]; @@ -123,7 +96,7 @@ 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.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create, update, remove) on an shared set. @@ -134,17 +107,19 @@ message SharedSetOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new shared set. - google.ads.googleads.v9.resources.SharedSet create = 1; + google.ads.googleads.v12.resources.SharedSet create = 1; // Update operation: The shared set is expected to have a valid resource // name. - google.ads.googleads.v9.resources.SharedSet update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/SharedSet" + }]; } } @@ -152,8 +127,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. @@ -163,10 +138,12 @@ message MutateSharedSetsResponse { // The result for the shared set mutate. message MutateSharedSetResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + 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.v9.resources.SharedSet shared_set = 2; + google.ads.googleads.v12.resources.SharedSet shared_set = 2; } diff --git a/google/ads/googleads/v9/services/smart_campaign_setting_service.proto b/google/ads/googleads/v12/services/smart_campaign_setting_service.proto similarity index 66% rename from google/ads/googleads/v9/services/smart_campaign_setting_service.proto rename to google/ads/googleads/v12/services/smart_campaign_setting_service.proto index def5a47bf..3d242b1ea 100644 --- a/google/ads/googleads/v9/services/smart_campaign_setting_service.proto +++ b/google/ads/googleads/v12/services/smart_campaign_setting_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. @@ -14,10 +14,10 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/resources/smart_campaign_setting.proto"; +import "google/ads/googleads/v12/enums/response_content_type.proto"; +import "google/ads/googleads/v12/resources/smart_campaign_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "SmartCampaignSettingServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the Smart campaign setting service. @@ -41,35 +41,16 @@ service SmartCampaignSettingService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested Smart campaign setting in full detail. - rpc GetSmartCampaignSetting(GetSmartCampaignSettingRequest) returns (google.ads.googleads.v9.resources.SmartCampaignSetting) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/smartCampaignSettings/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Updates Smart campaign settings for campaigns. rpc MutateSmartCampaignSettings(MutateSmartCampaignSettingsRequest) returns (MutateSmartCampaignSettingsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/smartCampaignSettings:mutate" + post: "/v12/customers/{customer_id=*}/smartCampaignSettings:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [SmartCampaignSettingService.GetSmartCampaignSetting][google.ads.googleads.v9.services.SmartCampaignSettingService.GetSmartCampaignSetting]. -message GetSmartCampaignSettingRequest { - // Required. The resource name of the Smart campaign setting to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/SmartCampaignSetting" - } - ]; -} - // Request message for // [SmartCampaignSettingService.MutateSmartCampaignSetting][]. message MutateSmartCampaignSettingsRequest { @@ -91,14 +72,14 @@ message MutateSmartCampaignSettingsRequest { // The response content type setting. Determines whether the mutable resource // or just the resource name should be returned post mutation. - google.ads.googleads.v9.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; + google.ads.googleads.v12.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.v9.resources.SmartCampaignSetting update = 1; + google.ads.googleads.v12.resources.SmartCampaignSetting update = 1; // FieldMask that determines which resource fields are modified in an update. google.protobuf.FieldMask update_mask = 2; @@ -108,8 +89,8 @@ message SmartCampaignSettingOperation { 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. + // 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. @@ -119,10 +100,12 @@ message MutateSmartCampaignSettingsResponse { // The result for the Smart campaign setting mutate. message MutateSmartCampaignSettingResult { // Returned for successful operations. - string resource_name = 1; + 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.v9.resources.SmartCampaignSetting smart_campaign_setting = 2; + google.ads.googleads.v12.resources.SmartCampaignSetting smart_campaign_setting = 2; } diff --git a/google/ads/googleads/v9/services/smart_campaign_suggest_service.proto b/google/ads/googleads/v12/services/smart_campaign_suggest_service.proto similarity index 74% rename from google/ads/googleads/v9/services/smart_campaign_suggest_service.proto rename to google/ads/googleads/v12/services/smart_campaign_suggest_service.proto index a6d401e47..7a42f52f6 100644 --- a/google/ads/googleads/v9/services/smart_campaign_suggest_service.proto +++ b/google/ads/googleads/v12/services/smart_campaign_suggest_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. @@ -14,24 +14,24 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/ad_type_infos.proto"; -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/resources/keyword_theme_constant.proto"; +import "google/ads/googleads/v12/common/ad_type_infos.proto"; +import "google/ads/googleads/v12/common/criteria.proto"; +import "google/ads/googleads/v12/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"; -import "google/api/client.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "SmartCampaignSuggestServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Service to get suggestions for Smart Campaigns. service SmartCampaignSuggestService { @@ -41,7 +41,7 @@ service SmartCampaignSuggestService { // Returns BudgetOption suggestions. rpc SuggestSmartCampaignBudgetOptions(SuggestSmartCampaignBudgetOptionsRequest) returns (SuggestSmartCampaignBudgetOptionsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions" + post: "/v12/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions" body: "*" }; } @@ -50,7 +50,7 @@ service SmartCampaignSuggestService { // based on data points such as targeting and the business to advertise. rpc SuggestSmartCampaignAd(SuggestSmartCampaignAdRequest) returns (SuggestSmartCampaignAdResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:suggestSmartCampaignAd" + post: "/v12/customers/{customer_id=*}:suggestSmartCampaignAd" body: "*" }; } @@ -58,7 +58,7 @@ service SmartCampaignSuggestService { // Suggests keyword themes to advertise on. rpc SuggestKeywordThemes(SuggestKeywordThemesRequest) returns (SuggestKeywordThemesResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:suggestKeywordThemes" + post: "/v12/customers/{customer_id=*}:suggestKeywordThemes" body: "*" }; } @@ -93,7 +93,7 @@ message SmartCampaignSuggestionInfo { // A list of locations. message LocationList { // Required. Locations. - repeated google.ads.googleads.v9.common.LocationInfo locations = 1 [(google.api.field_behavior) = REQUIRED]; + repeated google.ads.googleads.v12.common.LocationInfo locations = 1 [(google.api.field_behavior) = REQUIRED]; } // A context that describes a business. @@ -110,11 +110,11 @@ message SmartCampaignSuggestionInfo { string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The business ad schedule. - repeated google.ads.googleads.v9.common.AdScheduleInfo ad_schedules = 6 [(google.api.field_behavior) = OPTIONAL]; + repeated google.ads.googleads.v12.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.v9.common.KeywordThemeInfo keyword_themes = 7 [(google.api.field_behavior) = OPTIONAL]; + repeated google.ads.googleads.v12.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. @@ -123,13 +123,15 @@ message SmartCampaignSuggestionInfo { // 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]; + // 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 +141,7 @@ message SmartCampaignSuggestionInfo { LocationList location_list = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. The targeting geo location by proximity. - google.ads.googleads.v9.common.ProximityInfo proximity = 5 [(google.api.field_behavior) = OPTIONAL]; + google.ads.googleads.v12.common.ProximityInfo proximity = 5 [(google.api.field_behavior) = OPTIONAL]; } } @@ -180,7 +182,7 @@ message SuggestSmartCampaignBudgetOptionsResponse { } // Request message for -// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestSmartCampaignAd]. +// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignAd]. message SuggestSmartCampaignAdRequest { // Required. The ID of the customer. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; @@ -193,32 +195,46 @@ message SuggestSmartCampaignAdRequest { } // Response message for -// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestSmartCampaignAd]. +// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignAd]. message SuggestSmartCampaignAdResponse { // Optional. Ad info includes 3 creative headlines and 2 creative descriptions. - google.ads.googleads.v9.common.SmartCampaignAdInfo ad_info = 1 [(google.api.field_behavior) = OPTIONAL]; + google.ads.googleads.v12.common.SmartCampaignAdInfo ad_info = 1 [(google.api.field_behavior) = OPTIONAL]; } // Request message for -// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestKeywordThemes]. +// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v12.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]; } // Response message for -// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v9.services.SmartCampaignSuggestService.SuggestKeywordThemes]. +// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v12.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.v12.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.v9.resources.KeywordThemeConstant keyword_themes = 1; + repeated KeywordTheme keyword_themes = 2; } diff --git a/google/ads/googleads/v9/services/third_party_app_analytics_link_service.proto b/google/ads/googleads/v12/services/third_party_app_analytics_link_service.proto similarity index 55% rename from google/ads/googleads/v9/services/third_party_app_analytics_link_service.proto rename to google/ads/googleads/v12/services/third_party_app_analytics_link_service.proto index f8aa59633..8fc326333 100644 --- a/google/ads/googleads/v9/services/third_party_app_analytics_link_service.proto +++ b/google/ads/googleads/v12/services/third_party_app_analytics_link_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. @@ -14,21 +14,20 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/third_party_app_analytics_link.proto"; import "google/api/annotations.proto"; -import "google/api/resource.proto"; import "google/api/client.proto"; +import "google/api/resource.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "ThirdPartyAppAnalyticsLinkServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // This service allows management of links between Google Ads and third party // app analytics. @@ -36,21 +35,6 @@ service ThirdPartyAppAnalyticsLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the third party app analytics link in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetThirdPartyAppAnalyticsLink(GetThirdPartyAppAnalyticsLinkRequest) returns (google.ads.googleads.v9.resources.ThirdPartyAppAnalyticsLink) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}" - }; - } - // Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be // provided to the third party when setting up app analytics. // @@ -63,23 +47,14 @@ service ThirdPartyAppAnalyticsLinkService { // [RequestError]() rpc RegenerateShareableLinkId(RegenerateShareableLinkIdRequest) returns (RegenerateShareableLinkIdResponse) { option (google.api.http) = { - post: "/v9/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId" + post: "/v12/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId" body: "*" }; } } // Request message for -// [ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink][google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink]. -message GetThirdPartyAppAnalyticsLinkRequest { - // Resource name of the third party app analytics link. - string resource_name = 1 [(google.api.resource_reference) = { - type: "googleads.googleapis.com/ThirdPartyAppAnalyticsLink" - }]; -} - -// Request message for -// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId]. +// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId]. message RegenerateShareableLinkIdRequest { // Resource name of the third party app analytics link. string resource_name = 1 [(google.api.resource_reference) = { @@ -88,7 +63,7 @@ message RegenerateShareableLinkIdRequest { } // Response message for -// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId]. +// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId]. message RegenerateShareableLinkIdResponse { } diff --git a/google/ads/googleads/v9/services/user_data_service.proto b/google/ads/googleads/v12/services/user_data_service.proto similarity index 66% rename from google/ads/googleads/v9/services/user_data_service.proto rename to google/ads/googleads/v12/services/user_data_service.proto index fe745908e..0b336493a 100644 --- a/google/ads/googleads/v9/services/user_data_service.proto +++ b/google/ads/googleads/v12/services/user_data_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. @@ -14,25 +14,30 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/common/offline_user_data.proto"; +import "google/ads/googleads/v12/common/offline_user_data.proto"; import "google/api/annotations.proto"; -import "google/api/field_behavior.proto"; import "google/api/client.proto"; +import "google/api/field_behavior.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "UserDataServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::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,13 +58,13 @@ service UserDataService { // [UserDataError]() rpc UploadUserData(UploadUserDataRequest) returns (UploadUserDataResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:uploadUserData" + post: "/v12/customers/{customer_id=*}:uploadUserData" body: "*" }; } } -// Request message for [UserDataService.UploadUserData][google.ads.googleads.v9.services.UserDataService.UploadUserData] +// Request message for [UserDataService.UploadUserData][google.ads.googleads.v12.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]; @@ -70,7 +75,7 @@ message UploadUserDataRequest { // Metadata of the request. oneof metadata { // Metadata for data updates to a Customer Match user list. - google.ads.googleads.v9.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 2; + google.ads.googleads.v12.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 2; } } @@ -79,17 +84,19 @@ 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.v9.common.UserData create = 1; + google.ads.googleads.v12.common.UserData create = 1; // The list of user data to be removed from the user list. - google.ads.googleads.v9.common.UserData remove = 2; + google.ads.googleads.v12.common.UserData remove = 2; } } -// Response message for [UserDataService.UploadUserData][google.ads.googleads.v9.services.UserDataService.UploadUserData] +// Response message for [UserDataService.UploadUserData][google.ads.googleads.v12.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/google/ads/googleads/v9/services/user_list_service.proto b/google/ads/googleads/v12/services/user_list_service.proto similarity index 70% rename from google/ads/googleads/v9/services/user_list_service.proto rename to google/ads/googleads/v12/services/user_list_service.proto index eaacfe159..15aa300d3 100644 --- a/google/ads/googleads/v9/services/user_list_service.proto +++ b/google/ads/googleads/v12/services/user_list_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. @@ -14,9 +14,9 @@ syntax = "proto3"; -package google.ads.googleads.v9.services; +package google.ads.googleads.v12.services; -import "google/ads/googleads/v9/resources/user_list.proto"; +import "google/ads/googleads/v12/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V12.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services"; option java_multiple_files = true; option java_outer_classname = "UserListServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; +option java_package = "com.google.ads.googleads.v12.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V12::Services"; // Proto file describing the User List service. @@ -40,22 +40,6 @@ service UserListService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - // Returns the requested user list. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetUserList(GetUserListRequest) returns (google.ads.googleads.v9.resources.UserList) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/userLists/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - // Creates or updates user lists. Operation statuses are returned. // // List of thrown errors: @@ -81,25 +65,14 @@ service UserListService { // [UserListError]() rpc MutateUserLists(MutateUserListsRequest) returns (MutateUserListsResponse) { option (google.api.http) = { - post: "/v9/customers/{customer_id=*}/userLists:mutate" + post: "/v12/customers/{customer_id=*}/userLists:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } -// Request message for [UserListService.GetUserList][google.ads.googleads.v9.services.UserListService.GetUserList]. -message GetUserListRequest { - // Required. The resource name of the user list to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/UserList" - } - ]; -} - -// Request message for [UserListService.MutateUserLists][google.ads.googleads.v9.services.UserListService.MutateUserLists]. +// Request message for [UserListService.MutateUserLists][google.ads.googleads.v12.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]; @@ -126,17 +99,19 @@ message UserListOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new user list. - google.ads.googleads.v9.resources.UserList create = 1; + google.ads.googleads.v12.resources.UserList create = 1; // Update operation: The user list is expected to have a valid resource // name. - google.ads.googleads.v9.resources.UserList update = 2; + google.ads.googleads.v12.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; + string remove = 3 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/UserList" + }]; } } @@ -144,8 +119,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. @@ -155,5 +130,7 @@ message MutateUserListsResponse { // The result for the user list mutate. message MutateUserListResult { // Returned for successful operations. - string resource_name = 1; + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/UserList" + }]; } diff --git a/google/ads/googleads/v9/common/asset_types.proto b/google/ads/googleads/v9/common/asset_types.proto deleted file mode 100644 index eb67517b9..000000000 --- a/google/ads/googleads/v9/common/asset_types.proto +++ /dev/null @@ -1,502 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.common; - -import "google/ads/googleads/v9/common/criteria.proto"; -import "google/ads/googleads/v9/common/feed_common.proto"; -import "google/ads/googleads/v9/enums/call_conversion_reporting_state.proto"; -import "google/ads/googleads/v9/enums/call_to_action_type.proto"; -import "google/ads/googleads/v9/enums/lead_form_call_to_action_type.proto"; -import "google/ads/googleads/v9/enums/lead_form_desired_intent.proto"; -import "google/ads/googleads/v9/enums/lead_form_field_user_input_type.proto"; -import "google/ads/googleads/v9/enums/lead_form_post_submit_call_to_action_type.proto"; -import "google/ads/googleads/v9/enums/mime_type.proto"; -import "google/ads/googleads/v9/enums/mobile_app_vendor.proto"; -import "google/ads/googleads/v9/enums/price_extension_price_qualifier.proto"; -import "google/ads/googleads/v9/enums/price_extension_price_unit.proto"; -import "google/ads/googleads/v9/enums/price_extension_type.proto"; -import "google/ads/googleads/v9/enums/promotion_extension_discount_modifier.proto"; -import "google/ads/googleads/v9/enums/promotion_extension_occasion.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Common"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/common;common"; -option java_multiple_files = true; -option java_outer_classname = "AssetTypesProto"; -option java_package = "com.google.ads.googleads.v9.common"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Common"; -option ruby_package = "Google::Ads::GoogleAds::V9::Common"; - -// Proto file containing info messages for specific asset types. - -// A YouTube asset. -message YoutubeVideoAsset { - // YouTube video id. This is the 11 character string value used in the - // YouTube video URL. - optional string youtube_video_id = 2; - - // YouTube video title. - string youtube_video_title = 3; -} - -// A MediaBundle asset. -message MediaBundleAsset { - // Media bundle (ZIP file) asset data. The format of the uploaded ZIP file - // depends on the ad field where it will be used. For more information on the - // format, see the documentation of the ad field where you plan on using the - // MediaBundleAsset. This field is mutate only. - optional bytes data = 2; -} - -// An Image asset. -message ImageAsset { - // The raw bytes data of an image. This field is mutate only. - optional bytes data = 5; - - // File size of the image asset in bytes. - optional int64 file_size = 6; - - // MIME type of the image asset. - google.ads.googleads.v9.enums.MimeTypeEnum.MimeType mime_type = 3; - - // Metadata for this image at its original size. - ImageDimension full_size = 4; -} - -// Metadata for an image at a certain size, either original or resized. -message ImageDimension { - // Height of the image. - optional int64 height_pixels = 4; - - // Width of the image. - optional int64 width_pixels = 5; - - // A URL that returns the image with this height and width. - optional string url = 6; -} - -// A Text asset. -message TextAsset { - // Text content of the text asset. - optional string text = 2; -} - -// A Lead Form asset. -message LeadFormAsset { - // Required. The name of the business being advertised. - string business_name = 10 [(google.api.field_behavior) = REQUIRED]; - - // Required. Pre-defined display text that encourages user to expand the form. - google.ads.googleads.v9.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. 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. - 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. - string privacy_policy_url = 14 [(google.api.field_behavior) = REQUIRED]; - - // Headline of text shown after form submission that describes how the - // advertiser will follow up with the user. - optional string post_submit_headline = 15; - - // Detailed description shown after form submission that describes how the - // advertiser will follow up with the user. - optional string post_submit_description = 16; - - // Ordered list of input fields. - repeated LeadFormField fields = 8; - - // Configured methods for collected lead data to be delivered to advertiser. - // Only one method typed as WebhookDelivery can be configured. - repeated LeadFormDeliveryMethod delivery_methods = 9; - - // Pre-defined display text that encourages user action after the form is - // submitted. - google.ads.googleads.v9.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.v9.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21; - - // Custom disclosure shown along with Google disclaimer on the lead form. - // Accessible to allowed customers only. - optional string custom_disclosure = 22; -} - -// 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.v9.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. - oneof answers { - // Answer configuration for a single choice question. Can be set only for - // pre-vetted question fields. Minimum of 2 answers required and maximum of - // 12 allowed. - LeadFormSingleChoiceAnswers single_choice_answers = 2; - } -} - -// Defines possible answers for a single choice question, usually presented as -// a single-choice drop-down list. -message LeadFormSingleChoiceAnswers { - // List of choices for a single question field. The order of entries defines - // UI order. Minimum of 2 answers required and maximum of 12 allowed. - repeated string answers = 1; -} - -// A configuration of how leads are delivered to the advertiser. -message LeadFormDeliveryMethod { - // Various subtypes of delivery. - oneof delivery_details { - // Webhook method of delivery. - WebhookDelivery webhook = 1; - } -} - -// Google notifies the advertiser of leads by making HTTP calls to an -// endpoint they specify. The requests contain JSON matching a schema that -// Google publishes as part of form ads documentation. -message WebhookDelivery { - // Webhook url specified by advertiser to send the lead. - optional string advertiser_webhook_url = 4; - - // Anti-spoofing secret set by the advertiser as part of the webhook payload. - optional string google_secret = 5; - - // The schema version that this delivery instance will use. - optional int64 payload_schema_version = 6; -} - -// 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 { - -} - -// A Promotion asset. -message PromotionAsset { - // Required. A freeform description of what the promotion is targeting. - string promotion_target = 1 [(google.api.field_behavior) = REQUIRED]; - - // A modifier for qualification of the discount. - google.ads.googleads.v9.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2; - - // Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd - // format. - string redemption_start_date = 7; - - // Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd - // format. - string redemption_end_date = 8; - - // 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.v9.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9; - - // The language of the promotion. - // Represented as BCP 47 language tag. - string language_code = 10; - - // Start date of when this asset is effective and can begin serving, in - // yyyy-MM-dd format. - string start_date = 11; - - // Last date of when this asset is effective and still serving, in yyyy-MM-dd - // format. - string end_date = 12; - - // 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 - // total. - repeated AdScheduleInfo ad_schedule_targets = 13; - - // Discount type, can be percentage off or amount off. - oneof discount_type { - // Percentage off discount in the promotion. 1,000,000 = 100%. - // Either this or money_amount_off is required. - int64 percent_off = 3; - - // Money amount off for discount in the promotion. - // Either this or percent_off is required. - Money money_amount_off = 4; - } - - // Promotion trigger. Can be by promotion code or promo by eligible order - // amount. - oneof promotion_trigger { - // A code the user should use in order to be eligible for the promotion. - string promotion_code = 5; - - // The amount the total order needs to be for the user to be eligible for - // the promotion. - Money orders_over_amount = 6; - } -} - -// A Callout asset. -message CalloutAsset { - // Required. The callout text. - // The length of this string should be between 1 and 25, inclusive. - string callout_text = 1 [(google.api.field_behavior) = REQUIRED]; - - // Start date of when this asset is effective and can begin serving, in - // yyyy-MM-dd format. - string start_date = 2; - - // Last date of when this asset is effective and still serving, in yyyy-MM-dd - // format. - string end_date = 3; - - // 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 - // total. - repeated AdScheduleInfo ad_schedule_targets = 4; -} - -// A Structured Snippet asset. -message StructuredSnippetAsset { - // Required. The header of the snippet. - // This string should be one of the predefined values at - // https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers - string header = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The values in the snippet. - // The size of this collection should be between 3 and 10, inclusive. - // The length of each value should be between 1 and 25 characters, inclusive. - repeated string values = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// A Sitelink asset. -message SitelinkAsset { - // Required. URL display text for the sitelink. - // The length of this string should be between 1 and 25, inclusive. - string link_text = 1 [(google.api.field_behavior) = REQUIRED]; - - // First line of the description for the sitelink. - // If set, the length should be between 1 and 35, inclusive, and description2 - // must also be set. - string description1 = 2; - - // Second line of the description for the sitelink. - // If set, the length should be between 1 and 35, inclusive, and description1 - // must also be set. - string description2 = 3; - - // Start date of when this asset is effective and can begin serving, in - // yyyy-MM-dd format. - string start_date = 4; - - // Last date of when this asset is effective and still serving, in yyyy-MM-dd - // format. - string end_date = 5; - - // 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 - // total. - repeated AdScheduleInfo ad_schedule_targets = 6; -} - -// A Page Feed asset. -message PageFeedAsset { - // Required. The webpage that advertisers want to target. - string page_url = 1 [(google.api.field_behavior) = REQUIRED]; - - // Labels used to group the page urls. - repeated string labels = 2; -} - -// 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. - 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. - string program_name = 3 [(google.api.field_behavior) = REQUIRED]; - - // Subject of study, e.g. Health. - string subject = 4; - - // Program description, e.g. Nursing Certification. - string program_description = 5; - - // School name, e.g. 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 - string address = 7; - - // Contextual keywords, e.g. Nursing certification, Health, Mountain View. - repeated string contextual_keywords = 8; - - // Android deep link, e.g. - // 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. - string ios_app_link = 11; - - // iOS app store ID. This is used to check if the user has the app installed - // on their device before deep linking. If this field is set, then the - // 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 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. - 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 - // "12345689" for iOS. - string app_id = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The application store that distributes this specific app. - google.ads.googleads.v9.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. - string link_text = 3 [(google.api.field_behavior) = REQUIRED]; - - // Start date of when this asset is effective and can begin serving, in - // yyyy-MM-dd format. - string start_date = 4; - - // Last date of when this asset is effective and still serving, in yyyy-MM-dd - // format. - string end_date = 5; -} - -// An asset representing a hotel callout. -message HotelCalloutAsset { - // Required. The text of the hotel callout asset. - // The length of this string should be between 1 and 25, inclusive. - string text = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The language of the hotel callout. - // Represented as BCP 47 language tag. - string language_code = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// A Call asset. -message CallAsset { - // 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' - 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.v9.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" - }]; - - // 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 - // total. - repeated AdScheduleInfo ad_schedule_targets = 5; -} - -// An asset representing a list of price offers. -message PriceAsset { - // Required. The type of the price asset. - google.ads.googleads.v9.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1 [(google.api.field_behavior) = REQUIRED]; - - // The price qualifier of the price asset. - google.ads.googleads.v9.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2; - - // Required. The language of the price asset. - // Represented as BCP 47 language tag. - string language_code = 3 [(google.api.field_behavior) = REQUIRED]; - - // The price offerings of the price asset. - // The size of this collection should be between 3 and 8, inclusive. - repeated PriceOffering price_offerings = 4; -} - -// A single price offering within a PriceAsset. -message PriceOffering { - // Required. The header of the price offering. - // The length of this string should be between 1 and 25, inclusive. - string header = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The description of the price offering. - // The length of this string should be between 1 and 25, inclusive. - string description = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The price value of the price offering. - Money price = 3 [(google.api.field_behavior) = REQUIRED]; - - // The price unit of the price offering. - google.ads.googleads.v9.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4; - - // Required. The final URL after all cross domain redirects. - string final_url = 5 [(google.api.field_behavior) = REQUIRED]; - - // The final mobile URL after all cross domain redirects. - string final_mobile_url = 6; -} - -// A call to action asset. -message CallToActionAsset { - // Call to action. - google.ads.googleads.v9.enums.CallToActionTypeEnum.CallToActionType call_to_action = 1; -} diff --git a/google/ads/googleads/v9/enums/campaign_experiment_status.proto b/google/ads/googleads/v9/enums/campaign_experiment_status.proto deleted file mode 100644 index 3febb5644..000000000 --- a/google/ads/googleads/v9/enums/campaign_experiment_status.proto +++ /dev/null @@ -1,77 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.enums; - -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; -option java_multiple_files = true; -option java_outer_classname = "CampaignExperimentStatusProto"; -option java_package = "com.google.ads.googleads.v9.enums"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::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/google/ads/googleads/v9/enums/campaign_experiment_traffic_split_type.proto b/google/ads/googleads/v9/enums/campaign_experiment_traffic_split_type.proto deleted file mode 100644 index b7c01172e..000000000 --- a/google/ads/googleads/v9/enums/campaign_experiment_traffic_split_type.proto +++ /dev/null @@ -1,53 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.enums; - -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; -option java_multiple_files = true; -option java_outer_classname = "CampaignExperimentTrafficSplitTypeProto"; -option java_package = "com.google.ads.googleads.v9.enums"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::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/google/ads/googleads/v9/enums/reach_plan_ad_length.proto b/google/ads/googleads/v9/enums/reach_plan_ad_length.proto deleted file mode 100644 index c21c757a0..000000000 --- a/google/ads/googleads/v9/enums/reach_plan_ad_length.proto +++ /dev/null @@ -1,53 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.enums; - -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Enums"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/enums;enums"; -option java_multiple_files = true; -option java_outer_classname = "ReachPlanAdLengthProto"; -option java_package = "com.google.ads.googleads.v9.enums"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Enums"; -option ruby_package = "Google::Ads::GoogleAds::V9::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/google/ads/googleads/v9/googleads_gapic.yaml b/google/ads/googleads/v9/googleads_gapic.yaml deleted file mode 100644 index 2a9f65a14..000000000 --- a/google/ads/googleads/v9/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.V9.Services - go: - package_name: google.golang.org/google/ads/googleads/v9/services - java: - package_name: com.google.ads.googleads.v9.services - nodejs: - package_name: v9.services - php: - package_name: Google\Ads\GoogleAds\V9\Services - python: - package_name: google.ads.googleads_v9.gapic.services - ruby: - package_name: Google::Ads::Googleads::V9::Services -interfaces: -- name: google.ads.googleads.v9.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/google/ads/googleads/v9/googleads_grpc_service_config.json b/google/ads/googleads/v9/googleads_grpc_service_config.json deleted file mode 100755 index f629b75e6..000000000 --- a/google/ads/googleads/v9/googleads_grpc_service_config.json +++ /dev/null @@ -1,474 +0,0 @@ -{ - "methodConfig": [ - { - "name": [ - { - "service": "google.ads.googleads.v9.services.AccessibleBiddingStrategyService" - }, - { - "service": "google.ads.googleads.v9.services.AccountBudgetProposalService" - }, - { - "service": "google.ads.googleads.v9.services.AccountBudgetService" - }, - { - "service": "google.ads.googleads.v9.services.AccountLinkService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupAdAssetViewService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupAdLabelService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupAdService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupAssetService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupAudienceViewService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupBidModifierService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupCriterionCustomizerService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupCriterionLabelService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupCriterionService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupCriterionSimulationService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupCustomizerService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupExtensionSettingService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupFeedService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupLabelService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupService" - }, - { - "service": "google.ads.googleads.v9.services.AdGroupSimulationService" - }, - { - "service": "google.ads.googleads.v9.services.AdParameterService" - }, - { - "service": "google.ads.googleads.v9.services.AdScheduleViewService" - }, - { - "service": "google.ads.googleads.v9.services.AdService" - }, - { - "service": "google.ads.googleads.v9.services.AgeRangeViewService" - }, - { - "service": "google.ads.googleads.v9.services.AssetFieldTypeViewService" - }, - { - "service": "google.ads.googleads.v9.services.AssetGroupAssetService" - }, - { - "service": "google.ads.googleads.v9.services.AssetGroupListingGroupFilterService" - }, - { - "service": "google.ads.googleads.v9.services.AssetGroupService" - }, - { - "service": "google.ads.googleads.v9.services.AssetService" - }, - { - "service": "google.ads.googleads.v9.services.AssetSetAssetService" - }, - { - "service": "google.ads.googleads.v9.services.AssetSetService" - }, - { - "service": "google.ads.googleads.v9.services.BatchJobService" - }, - { - "service": "google.ads.googleads.v9.services.BiddingDataExclusionService" - }, - { - "service": "google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService" - }, - { - "service": "google.ads.googleads.v9.services.BiddingStrategyService" - }, - { - "service": "google.ads.googleads.v9.services.BiddingStrategySimulationService" - }, - { - "service": "google.ads.googleads.v9.services.BillingSetupService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignAssetService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignAssetSetService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignAudienceViewService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignBidModifierService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignBudgetService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignConversionGoalService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignCriterionService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignCriterionSimulationService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignCustomizerService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignDraftService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignExperimentService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignExtensionSettingService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignFeedService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignLabelService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignSharedSetService" - }, - { - "service": "google.ads.googleads.v9.services.CampaignSimulationService" - }, - { - "service": "google.ads.googleads.v9.services.CarrierConstantService" - }, - { - "service": "google.ads.googleads.v9.services.ChangeStatusService" - }, - { - "service": "google.ads.googleads.v9.services.ClickViewService" - }, - { - "service": "google.ads.googleads.v9.services.CombinedAudienceService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionActionService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionAdjustmentUploadService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionCustomVariableService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionGoalCampaignConfigService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionUploadService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionValueRuleService" - }, - { - "service": "google.ads.googleads.v9.services.ConversionValueRuleSetService" - }, - { - "service": "google.ads.googleads.v9.services.CurrencyConstantService" - }, - { - "service": "google.ads.googleads.v9.services.CustomAudienceService" - }, - { - "service": "google.ads.googleads.v9.services.CustomConversionGoalService" - }, - { - "service": "google.ads.googleads.v9.services.CustomInterestService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerAssetService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerClientLinkService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerClientService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerConversionGoalService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerCustomizerService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerExtensionSettingService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerFeedService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerLabelService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerManagerLinkService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerNegativeCriterionService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerUserAccessInvitationService" - }, - { - "service": "google.ads.googleads.v9.services.CustomerUserAccessService" - }, - { - "service": "google.ads.googleads.v9.services.CustomizerAttributeService" - }, - { - "service": "google.ads.googleads.v9.services.DetailPlacementViewService" - }, - { - "service": "google.ads.googleads.v9.services.DetailedDemographicService" - }, - { - "service": "google.ads.googleads.v9.services.DisplayKeywordViewService" - }, - { - "service": "google.ads.googleads.v9.services.DistanceViewService" - }, - { - "service": "google.ads.googleads.v9.services.DomainCategoryService" - }, - { - "service": "google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService" - }, - { - "service": "google.ads.googleads.v9.services.ExpandedLandingPageViewService" - }, - { - "service": "google.ads.googleads.v9.services.ExtensionFeedItemService" - }, - { - "service": "google.ads.googleads.v9.services.FeedItemService" - }, - { - "service": "google.ads.googleads.v9.services.FeedItemSetLinkService" - }, - { - "service": "google.ads.googleads.v9.services.FeedItemSetService" - }, - { - "service": "google.ads.googleads.v9.services.FeedItemTargetService" - }, - { - "service": "google.ads.googleads.v9.services.FeedMappingService" - }, - { - "service": "google.ads.googleads.v9.services.FeedPlaceholderViewService" - }, - { - "service": "google.ads.googleads.v9.services.FeedService" - }, - { - "service": "google.ads.googleads.v9.services.GenderViewService" - }, - { - "service": "google.ads.googleads.v9.services.GeoTargetConstantService" - }, - { - "service": "google.ads.googleads.v9.services.GeographicViewService" - }, - { - "service": "google.ads.googleads.v9.services.GoogleAdsFieldService" - }, - { - "service": "google.ads.googleads.v9.services.GoogleAdsService" - }, - { - "service": "google.ads.googleads.v9.services.GroupPlacementViewService" - }, - { - "service": "google.ads.googleads.v9.services.HotelGroupViewService" - }, - { - "service": "google.ads.googleads.v9.services.HotelPerformanceViewService" - }, - { - "service": "google.ads.googleads.v9.services.IncomeRangeViewService" - }, - { - "service": "google.ads.googleads.v9.services.InvoiceService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanAdGroupService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanCampaignService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanIdeaService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordPlanService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordThemeConstantService" - }, - { - "service": "google.ads.googleads.v9.services.KeywordViewService" - }, - { - "service": "google.ads.googleads.v9.services.LabelService" - }, - { - "service": "google.ads.googleads.v9.services.LandingPageViewService" - }, - { - "service": "google.ads.googleads.v9.services.LanguageConstantService" - }, - { - "service": "google.ads.googleads.v9.services.LifeEventService" - }, - { - "service": "google.ads.googleads.v9.services.LocationViewService" - }, - { - "service": "google.ads.googleads.v9.services.ManagedPlacementViewService" - }, - { - "service": "google.ads.googleads.v9.services.MediaFileService" - }, - { - "service": "google.ads.googleads.v9.services.MerchantCenterLinkService" - }, - { - "service": "google.ads.googleads.v9.services.MobileAppCategoryConstantService" - }, - { - "service": "google.ads.googleads.v9.services.MobileDeviceConstantService" - }, - { - "service": "google.ads.googleads.v9.services.OfflineUserDataJobService" - }, - { - "service": "google.ads.googleads.v9.services.OperatingSystemVersionConstantService" - }, - { - "service": "google.ads.googleads.v9.services.PaidOrganicSearchTermViewService" - }, - { - "service": "google.ads.googleads.v9.services.ParentalStatusViewService" - }, - { - "service": "google.ads.googleads.v9.services.PaymentsAccountService" - }, - { - "service": "google.ads.googleads.v9.services.ProductBiddingCategoryConstantService" - }, - { - "service": "google.ads.googleads.v9.services.ProductGroupViewService" - }, - { - "service": "google.ads.googleads.v9.services.ReachPlanService" - }, - { - "service": "google.ads.googleads.v9.services.RecommendationService" - }, - { - "service": "google.ads.googleads.v9.services.RemarketingActionService" - }, - { - "service": "google.ads.googleads.v9.services.SearchTermViewService" - }, - { - "service": "google.ads.googleads.v9.services.SharedCriterionService" - }, - { - "service": "google.ads.googleads.v9.services.SharedSetService" - }, - { - "service": "google.ads.googleads.v9.services.ShoppingPerformanceViewService" - }, - { - "service": "google.ads.googleads.v9.services.SmartCampaignSearchTermViewService" - }, - { - "service": "google.ads.googleads.v9.services.SmartCampaignSettingService" - }, - { - "service": "google.ads.googleads.v9.services.SmartCampaignSuggestService" - }, - { - "service": "google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService" - }, - { - "service": "google.ads.googleads.v9.services.TopicConstantService" - }, - { - "service": "google.ads.googleads.v9.services.TopicViewService" - }, - { - "service": "google.ads.googleads.v9.services.UserDataService" - }, - { - "service": "google.ads.googleads.v9.services.UserInterestService" - }, - { - "service": "google.ads.googleads.v9.services.UserListService" - }, - { - "service": "google.ads.googleads.v9.services.UserLocationViewService" - }, - { - "service": "google.ads.googleads.v9.services.VideoService" - }, - { - "service": "google.ads.googleads.v9.services.WebpageViewService" - } - ], - "timeout": "3600s", - "retryPolicy": { - "initialBackoff": "5s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "UNAVAILABLE", - "DEADLINE_EXCEEDED" - ] - } - } - ] -} diff --git a/google/ads/googleads/v9/googleads_v9.yaml b/google/ads/googleads/v9/googleads_v9.yaml deleted file mode 100644 index 31d9d9240..000000000 --- a/google/ads/googleads/v9/googleads_v9.yaml +++ /dev/null @@ -1,1514 +0,0 @@ -type: google.api.Service -config_version: 3 -name: googleads.googleapis.com -title: Google Ads API - -apis: -- name: google.ads.googleads.v9.services.AccessibleBiddingStrategyService -- name: google.ads.googleads.v9.services.AccountBudgetProposalService -- name: google.ads.googleads.v9.services.AccountBudgetService -- name: google.ads.googleads.v9.services.AccountLinkService -- name: google.ads.googleads.v9.services.AdGroupAdAssetViewService -- name: google.ads.googleads.v9.services.AdGroupAdLabelService -- name: google.ads.googleads.v9.services.AdGroupAdService -- name: google.ads.googleads.v9.services.AdGroupAssetService -- name: google.ads.googleads.v9.services.AdGroupAudienceViewService -- name: google.ads.googleads.v9.services.AdGroupBidModifierService -- name: google.ads.googleads.v9.services.AdGroupCriterionCustomizerService -- name: google.ads.googleads.v9.services.AdGroupCriterionLabelService -- name: google.ads.googleads.v9.services.AdGroupCriterionService -- name: google.ads.googleads.v9.services.AdGroupCriterionSimulationService -- name: google.ads.googleads.v9.services.AdGroupCustomizerService -- name: google.ads.googleads.v9.services.AdGroupExtensionSettingService -- name: google.ads.googleads.v9.services.AdGroupFeedService -- name: google.ads.googleads.v9.services.AdGroupLabelService -- name: google.ads.googleads.v9.services.AdGroupService -- name: google.ads.googleads.v9.services.AdGroupSimulationService -- name: google.ads.googleads.v9.services.AdParameterService -- name: google.ads.googleads.v9.services.AdScheduleViewService -- name: google.ads.googleads.v9.services.AdService -- name: google.ads.googleads.v9.services.AgeRangeViewService -- name: google.ads.googleads.v9.services.AssetFieldTypeViewService -- name: google.ads.googleads.v9.services.AssetGroupAssetService -- name: google.ads.googleads.v9.services.AssetGroupListingGroupFilterService -- name: google.ads.googleads.v9.services.AssetGroupService -- name: google.ads.googleads.v9.services.AssetService -- name: google.ads.googleads.v9.services.AssetSetAssetService -- name: google.ads.googleads.v9.services.AssetSetService -- name: google.ads.googleads.v9.services.BatchJobService -- name: google.ads.googleads.v9.services.BiddingDataExclusionService -- name: google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService -- name: google.ads.googleads.v9.services.BiddingStrategyService -- name: google.ads.googleads.v9.services.BiddingStrategySimulationService -- name: google.ads.googleads.v9.services.BillingSetupService -- name: google.ads.googleads.v9.services.CampaignAssetService -- name: google.ads.googleads.v9.services.CampaignAssetSetService -- name: google.ads.googleads.v9.services.CampaignAudienceViewService -- name: google.ads.googleads.v9.services.CampaignBidModifierService -- name: google.ads.googleads.v9.services.CampaignBudgetService -- name: google.ads.googleads.v9.services.CampaignConversionGoalService -- name: google.ads.googleads.v9.services.CampaignCriterionService -- name: google.ads.googleads.v9.services.CampaignCriterionSimulationService -- name: google.ads.googleads.v9.services.CampaignCustomizerService -- name: google.ads.googleads.v9.services.CampaignDraftService -- name: google.ads.googleads.v9.services.CampaignExperimentService -- name: google.ads.googleads.v9.services.CampaignExtensionSettingService -- name: google.ads.googleads.v9.services.CampaignFeedService -- name: google.ads.googleads.v9.services.CampaignLabelService -- name: google.ads.googleads.v9.services.CampaignService -- name: google.ads.googleads.v9.services.CampaignSharedSetService -- name: google.ads.googleads.v9.services.CampaignSimulationService -- name: google.ads.googleads.v9.services.CarrierConstantService -- name: google.ads.googleads.v9.services.ChangeStatusService -- name: google.ads.googleads.v9.services.ClickViewService -- name: google.ads.googleads.v9.services.CombinedAudienceService -- name: google.ads.googleads.v9.services.ConversionActionService -- name: google.ads.googleads.v9.services.ConversionAdjustmentUploadService -- name: google.ads.googleads.v9.services.ConversionCustomVariableService -- name: google.ads.googleads.v9.services.ConversionGoalCampaignConfigService -- name: google.ads.googleads.v9.services.ConversionUploadService -- name: google.ads.googleads.v9.services.ConversionValueRuleService -- name: google.ads.googleads.v9.services.ConversionValueRuleSetService -- name: google.ads.googleads.v9.services.CurrencyConstantService -- name: google.ads.googleads.v9.services.CustomAudienceService -- name: google.ads.googleads.v9.services.CustomConversionGoalService -- name: google.ads.googleads.v9.services.CustomInterestService -- name: google.ads.googleads.v9.services.CustomerAssetService -- name: google.ads.googleads.v9.services.CustomerClientLinkService -- name: google.ads.googleads.v9.services.CustomerClientService -- name: google.ads.googleads.v9.services.CustomerConversionGoalService -- name: google.ads.googleads.v9.services.CustomerCustomizerService -- name: google.ads.googleads.v9.services.CustomerExtensionSettingService -- name: google.ads.googleads.v9.services.CustomerFeedService -- name: google.ads.googleads.v9.services.CustomerLabelService -- name: google.ads.googleads.v9.services.CustomerManagerLinkService -- name: google.ads.googleads.v9.services.CustomerNegativeCriterionService -- name: google.ads.googleads.v9.services.CustomerService -- name: google.ads.googleads.v9.services.CustomerUserAccessInvitationService -- name: google.ads.googleads.v9.services.CustomerUserAccessService -- name: google.ads.googleads.v9.services.CustomizerAttributeService -- name: google.ads.googleads.v9.services.DetailPlacementViewService -- name: google.ads.googleads.v9.services.DetailedDemographicService -- name: google.ads.googleads.v9.services.DisplayKeywordViewService -- name: google.ads.googleads.v9.services.DistanceViewService -- name: google.ads.googleads.v9.services.DomainCategoryService -- name: google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService -- name: google.ads.googleads.v9.services.ExpandedLandingPageViewService -- name: google.ads.googleads.v9.services.ExtensionFeedItemService -- name: google.ads.googleads.v9.services.FeedItemService -- name: google.ads.googleads.v9.services.FeedItemSetLinkService -- name: google.ads.googleads.v9.services.FeedItemSetService -- name: google.ads.googleads.v9.services.FeedItemTargetService -- name: google.ads.googleads.v9.services.FeedMappingService -- name: google.ads.googleads.v9.services.FeedPlaceholderViewService -- name: google.ads.googleads.v9.services.FeedService -- name: google.ads.googleads.v9.services.GenderViewService -- name: google.ads.googleads.v9.services.GeoTargetConstantService -- name: google.ads.googleads.v9.services.GeographicViewService -- name: google.ads.googleads.v9.services.GoogleAdsFieldService -- name: google.ads.googleads.v9.services.GoogleAdsService -- name: google.ads.googleads.v9.services.GroupPlacementViewService -- name: google.ads.googleads.v9.services.HotelGroupViewService -- name: google.ads.googleads.v9.services.HotelPerformanceViewService -- name: google.ads.googleads.v9.services.IncomeRangeViewService -- name: google.ads.googleads.v9.services.InvoiceService -- name: google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService -- name: google.ads.googleads.v9.services.KeywordPlanAdGroupService -- name: google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService -- name: google.ads.googleads.v9.services.KeywordPlanCampaignService -- name: google.ads.googleads.v9.services.KeywordPlanIdeaService -- name: google.ads.googleads.v9.services.KeywordPlanService -- name: google.ads.googleads.v9.services.KeywordThemeConstantService -- name: google.ads.googleads.v9.services.KeywordViewService -- name: google.ads.googleads.v9.services.LabelService -- name: google.ads.googleads.v9.services.LandingPageViewService -- name: google.ads.googleads.v9.services.LanguageConstantService -- name: google.ads.googleads.v9.services.LifeEventService -- name: google.ads.googleads.v9.services.LocationViewService -- name: google.ads.googleads.v9.services.ManagedPlacementViewService -- name: google.ads.googleads.v9.services.MediaFileService -- name: google.ads.googleads.v9.services.MerchantCenterLinkService -- name: google.ads.googleads.v9.services.MobileAppCategoryConstantService -- name: google.ads.googleads.v9.services.MobileDeviceConstantService -- name: google.ads.googleads.v9.services.OfflineUserDataJobService -- name: google.ads.googleads.v9.services.OperatingSystemVersionConstantService -- name: google.ads.googleads.v9.services.PaidOrganicSearchTermViewService -- name: google.ads.googleads.v9.services.ParentalStatusViewService -- name: google.ads.googleads.v9.services.PaymentsAccountService -- name: google.ads.googleads.v9.services.ProductBiddingCategoryConstantService -- name: google.ads.googleads.v9.services.ProductGroupViewService -- name: google.ads.googleads.v9.services.ReachPlanService -- name: google.ads.googleads.v9.services.RecommendationService -- name: google.ads.googleads.v9.services.RemarketingActionService -- name: google.ads.googleads.v9.services.SearchTermViewService -- name: google.ads.googleads.v9.services.SharedCriterionService -- name: google.ads.googleads.v9.services.SharedSetService -- name: google.ads.googleads.v9.services.ShoppingPerformanceViewService -- name: google.ads.googleads.v9.services.SmartCampaignSearchTermViewService -- name: google.ads.googleads.v9.services.SmartCampaignSettingService -- name: google.ads.googleads.v9.services.SmartCampaignSuggestService -- name: google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService -- name: google.ads.googleads.v9.services.TopicConstantService -- name: google.ads.googleads.v9.services.TopicViewService -- name: google.ads.googleads.v9.services.UserDataService -- name: google.ads.googleads.v9.services.UserInterestService -- name: google.ads.googleads.v9.services.UserListService -- name: google.ads.googleads.v9.services.UserLocationViewService -- name: google.ads.googleads.v9.services.VideoService -- name: google.ads.googleads.v9.services.WebpageViewService - -types: -- name: google.ads.googleads.v9.errors.GoogleAdsFailure -- name: google.ads.googleads.v9.resources.BatchJob.BatchJobMetadata -- name: google.ads.googleads.v9.services.CreateCampaignExperimentMetadata - -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.v9.services.AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AccountBudgetProposalService.GetAccountBudgetProposal - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AccountBudgetProposalService.MutateAccountBudgetProposal - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AccountBudgetService.GetAccountBudget - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.AccountLinkService.*' - deadline: 600.0 - - selector: google.ads.googleads.v9.services.AdGroupAdAssetViewService.GetAdGroupAdAssetView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAdLabelService.GetAdGroupAdLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAdLabelService.MutateAdGroupAdLabels - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAdService.GetAdGroupAd - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAdService.MutateAdGroupAds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAssetService.GetAdGroupAsset - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAssetService.MutateAdGroupAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupAudienceViewService.GetAdGroupAudienceView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupBidModifierService.GetAdGroupBidModifier - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupBidModifierService.MutateAdGroupBidModifiers - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionService.GetAdGroupCriterion - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionService.MutateAdGroupCriteria - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupCustomizerService.MutateAdGroupCustomizers - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupFeedService.GetAdGroupFeed - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupFeedService.MutateAdGroupFeeds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupLabelService.GetAdGroupLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupLabelService.MutateAdGroupLabels - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupService.GetAdGroup - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupService.MutateAdGroups - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdGroupSimulationService.GetAdGroupSimulation - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdParameterService.GetAdParameter - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdParameterService.MutateAdParameters - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdScheduleViewService.GetAdScheduleView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdService.GetAd - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AdService.MutateAds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AgeRangeViewService.GetAgeRangeView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetFieldTypeViewService.GetAssetFieldTypeView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetGroupAssetService.GetAssetGroupAsset - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetGroupAssetService.MutateAssetGroupAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetGroupService.GetAssetGroup - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetGroupService.MutateAssetGroups - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetService.GetAsset - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetService.MutateAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetSetAssetService.MutateAssetSetAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.AssetSetService.MutateAssetSets - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.BatchJobService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingDataExclusionService.GetBiddingDataExclusion - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingDataExclusionService.MutateBiddingDataExclusions - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingStrategyService.GetBiddingStrategy - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingStrategyService.MutateBiddingStrategies - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BiddingStrategySimulationService.GetBiddingStrategySimulation - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BillingSetupService.GetBillingSetup - deadline: 60.0 - - selector: google.ads.googleads.v9.services.BillingSetupService.MutateBillingSetup - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignAssetService.GetCampaignAsset - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignAssetService.MutateCampaignAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignAssetSetService.MutateCampaignAssetSets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignAudienceViewService.GetCampaignAudienceView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignBidModifierService.GetCampaignBidModifier - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignBidModifierService.MutateCampaignBidModifiers - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignBudgetService.GetCampaignBudget - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignBudgetService.MutateCampaignBudgets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignConversionGoalService.MutateCampaignConversionGoals - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignCriterionService.GetCampaignCriterion - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignCriterionService.MutateCampaignCriteria - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignCustomizerService.MutateCampaignCustomizers - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.CampaignDraftService.*' - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.CampaignExperimentService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignExtensionSettingService.GetCampaignExtensionSetting - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignFeedService.GetCampaignFeed - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignFeedService.MutateCampaignFeeds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignLabelService.GetCampaignLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignLabelService.MutateCampaignLabels - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignService.GetCampaign - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignService.MutateCampaigns - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignSharedSetService.GetCampaignSharedSet - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignSharedSetService.MutateCampaignSharedSets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CampaignSimulationService.GetCampaignSimulation - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CarrierConstantService.GetCarrierConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ChangeStatusService.GetChangeStatus - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ClickViewService.GetClickView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CombinedAudienceService.GetCombinedAudience - deadline: 600.0 - - selector: google.ads.googleads.v9.services.ConversionActionService.GetConversionAction - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionActionService.MutateConversionActions - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionAdjustmentUploadService.UploadConversionAdjustments - deadline: 600.0 - - selector: google.ads.googleads.v9.services.ConversionCustomVariableService.GetConversionCustomVariable - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionCustomVariableService.MutateConversionCustomVariables - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionUploadService.UploadCallConversions - deadline: 600.0 - - selector: google.ads.googleads.v9.services.ConversionUploadService.UploadClickConversions - deadline: 600.0 - - selector: google.ads.googleads.v9.services.ConversionValueRuleService.GetConversionValueRule - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionValueRuleService.MutateConversionValueRules - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionValueRuleSetService.GetConversionValueRuleSet - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ConversionValueRuleSetService.MutateConversionValueRuleSets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CurrencyConstantService.GetCurrencyConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomAudienceService.GetCustomAudience - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomAudienceService.MutateCustomAudiences - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomConversionGoalService.MutateCustomConversionGoals - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomInterestService.GetCustomInterest - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomInterestService.MutateCustomInterests - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerAssetService.GetCustomerAsset - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerAssetService.MutateCustomerAssets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerClientLinkService.GetCustomerClientLink - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerClientLinkService.MutateCustomerClientLink - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerClientService.GetCustomerClient - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerConversionGoalService.MutateCustomerConversionGoals - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerCustomizerService.MutateCustomerCustomizers - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerExtensionSettingService.GetCustomerExtensionSetting - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerFeedService.GetCustomerFeed - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerFeedService.MutateCustomerFeeds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerLabelService.GetCustomerLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerLabelService.MutateCustomerLabels - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.CustomerManagerLinkService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.CustomerService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.CustomerUserAccessInvitationService.GetCustomerUserAccessInvitation - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomerUserAccessService.GetCustomerUserAccess - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomerUserAccessService.MutateCustomerUserAccess - deadline: 600.0 - - selector: google.ads.googleads.v9.services.CustomizerAttributeService.MutateCustomizerAttributes - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DetailPlacementViewService.GetDetailPlacementView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DetailedDemographicService.GetDetailedDemographic - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DisplayKeywordViewService.GetDisplayKeywordView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DistanceViewService.GetDistanceView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DomainCategoryService.GetDomainCategory - deadline: 60.0 - - selector: google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ExpandedLandingPageViewService.GetExpandedLandingPageView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ExtensionFeedItemService.GetExtensionFeedItem - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ExtensionFeedItemService.MutateExtensionFeedItems - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemService.GetFeedItem - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemService.MutateFeedItems - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemSetLinkService.GetFeedItemSetLink - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemSetLinkService.MutateFeedItemSetLinks - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemSetService.GetFeedItemSet - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemSetService.MutateFeedItemSets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemTargetService.GetFeedItemTarget - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedItemTargetService.MutateFeedItemTargets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedMappingService.GetFeedMapping - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedMappingService.MutateFeedMappings - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedPlaceholderViewService.GetFeedPlaceholderView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedService.GetFeed - deadline: 60.0 - - selector: google.ads.googleads.v9.services.FeedService.MutateFeeds - deadline: 60.0 - - selector: google.ads.googleads.v9.services.GenderViewService.GetGenderView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.GeoTargetConstantService.SuggestGeoTargetConstants - deadline: 60.0 - - selector: google.ads.googleads.v9.services.GeographicViewService.GetGeographicView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.GoogleAdsFieldService.GetGoogleAdsField - deadline: 600.0 - - selector: google.ads.googleads.v9.services.GoogleAdsFieldService.SearchGoogleAdsFields - deadline: 600.0 - - selector: google.ads.googleads.v9.services.GoogleAdsService.Mutate - deadline: 600.0 - - selector: google.ads.googleads.v9.services.GoogleAdsService.Search - deadline: 3600.0 - - selector: google.ads.googleads.v9.services.GoogleAdsService.SearchStream - deadline: 3600.0 - - selector: google.ads.googleads.v9.services.GroupPlacementViewService.GetGroupPlacementView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.HotelGroupViewService.GetHotelGroupView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.HotelPerformanceViewService.GetHotelPerformanceView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.IncomeRangeViewService.GetIncomeRangeView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.InvoiceService.ListInvoices - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignService.GetKeywordPlanCampaign - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanIdeaService.GenerateKeywordIdeas - deadline: 600.0 - - selector: 'google.ads.googleads.v9.services.KeywordPlanService.*' - deadline: 600.0 - - selector: google.ads.googleads.v9.services.KeywordPlanService.GetKeywordPlan - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordPlanService.MutateKeywordPlans - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordThemeConstantService.GetKeywordThemeConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordThemeConstantService.SuggestKeywordThemeConstants - deadline: 60.0 - - selector: google.ads.googleads.v9.services.KeywordViewService.GetKeywordView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LabelService.GetLabel - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LabelService.MutateLabels - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LandingPageViewService.GetLandingPageView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LanguageConstantService.GetLanguageConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LifeEventService.GetLifeEvent - deadline: 60.0 - - selector: google.ads.googleads.v9.services.LocationViewService.GetLocationView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ManagedPlacementViewService.GetManagedPlacementView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.MediaFileService.GetMediaFile - deadline: 60.0 - - selector: google.ads.googleads.v9.services.MediaFileService.MutateMediaFiles - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.MerchantCenterLinkService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.MobileDeviceConstantService.GetMobileDeviceConstant - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.OfflineUserDataJobService.*' - deadline: 600.0 - - selector: google.ads.googleads.v9.services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ParentalStatusViewService.GetParentalStatusView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.PaymentsAccountService.ListPaymentsAccounts - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ProductGroupViewService.GetProductGroupView - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.ReachPlanService.*' - deadline: 600.0 - - selector: 'google.ads.googleads.v9.services.RecommendationService.*' - deadline: 600.0 - - selector: google.ads.googleads.v9.services.RemarketingActionService.GetRemarketingAction - deadline: 60.0 - - selector: google.ads.googleads.v9.services.RemarketingActionService.MutateRemarketingActions - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SearchTermViewService.GetSearchTermView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SharedCriterionService.GetSharedCriterion - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SharedCriterionService.MutateSharedCriteria - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SharedSetService.GetSharedSet - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SharedSetService.MutateSharedSets - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ShoppingPerformanceViewService.GetShoppingPerformanceView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SmartCampaignSettingService.GetSmartCampaignSetting - deadline: 60.0 - - selector: google.ads.googleads.v9.services.SmartCampaignSettingService.MutateSmartCampaignSettings - deadline: 60.0 - - selector: 'google.ads.googleads.v9.services.SmartCampaignSuggestService.*' - deadline: 60.0 - - selector: google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink - deadline: 600.0 - - selector: google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId - deadline: 600.0 - - selector: google.ads.googleads.v9.services.TopicConstantService.GetTopicConstant - deadline: 60.0 - - selector: google.ads.googleads.v9.services.TopicViewService.GetTopicView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.UserDataService.UploadUserData - deadline: 600.0 - - selector: google.ads.googleads.v9.services.UserInterestService.GetUserInterest - deadline: 60.0 - - selector: google.ads.googleads.v9.services.UserListService.GetUserList - deadline: 60.0 - - selector: google.ads.googleads.v9.services.UserListService.MutateUserLists - deadline: 60.0 - - selector: google.ads.googleads.v9.services.UserLocationViewService.GetUserLocationView - deadline: 60.0 - - selector: google.ads.googleads.v9.services.VideoService.GetVideo - deadline: 60.0 - - selector: google.ads.googleads.v9.services.WebpageViewService.GetWebpageView - deadline: 60.0 - - selector: 'google.longrunning.Operations.*' - deadline: 60.0 - -http: - rules: - - selector: google.longrunning.Operations.CancelOperation - post: '/v9/{name=customers/*/operations/*}:cancel' - body: '*' - - selector: google.longrunning.Operations.DeleteOperation - delete: '/v9/{name=customers/*/operations/*}' - - selector: google.longrunning.Operations.GetOperation - get: '/v9/{name=customers/*/operations/*}' - - selector: google.longrunning.Operations.ListOperations - get: '/v9/{name=customers/*/operations}' - - selector: google.longrunning.Operations.WaitOperation - post: '/v9/{name=customers/*/operations/*}:wait' - body: '*' - -authentication: - rules: - - selector: google.ads.googleads.v9.services.AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AccountBudgetProposalService.GetAccountBudgetProposal - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AccountBudgetProposalService.MutateAccountBudgetProposal - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AccountBudgetService.GetAccountBudget - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.AccountLinkService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAdAssetViewService.GetAdGroupAdAssetView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAdLabelService.GetAdGroupAdLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAdLabelService.MutateAdGroupAdLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAdService.GetAdGroupAd - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAdService.MutateAdGroupAds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAssetService.GetAdGroupAsset - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAssetService.MutateAdGroupAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupAudienceViewService.GetAdGroupAudienceView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupBidModifierService.GetAdGroupBidModifier - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupBidModifierService.MutateAdGroupBidModifiers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionService.GetAdGroupCriterion - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionService.MutateAdGroupCriteria - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupCustomizerService.MutateAdGroupCustomizers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupFeedService.GetAdGroupFeed - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupFeedService.MutateAdGroupFeeds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupLabelService.GetAdGroupLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupLabelService.MutateAdGroupLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupService.GetAdGroup - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupService.MutateAdGroups - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdGroupSimulationService.GetAdGroupSimulation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdParameterService.GetAdParameter - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdParameterService.MutateAdParameters - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdScheduleViewService.GetAdScheduleView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdService.GetAd - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AdService.MutateAds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AgeRangeViewService.GetAgeRangeView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetFieldTypeViewService.GetAssetFieldTypeView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetGroupAssetService.GetAssetGroupAsset - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetGroupAssetService.MutateAssetGroupAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetGroupService.GetAssetGroup - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetGroupService.MutateAssetGroups - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetService.GetAsset - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetService.MutateAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetSetAssetService.MutateAssetSetAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.AssetSetService.MutateAssetSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.BatchJobService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingDataExclusionService.GetBiddingDataExclusion - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingDataExclusionService.MutateBiddingDataExclusions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingStrategyService.GetBiddingStrategy - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingStrategyService.MutateBiddingStrategies - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BiddingStrategySimulationService.GetBiddingStrategySimulation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BillingSetupService.GetBillingSetup - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.BillingSetupService.MutateBillingSetup - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignAssetService.GetCampaignAsset - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignAssetService.MutateCampaignAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignAssetSetService.MutateCampaignAssetSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignAudienceViewService.GetCampaignAudienceView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignBidModifierService.GetCampaignBidModifier - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignBidModifierService.MutateCampaignBidModifiers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignBudgetService.GetCampaignBudget - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignBudgetService.MutateCampaignBudgets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignConversionGoalService.MutateCampaignConversionGoals - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignCriterionService.GetCampaignCriterion - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignCriterionService.MutateCampaignCriteria - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignCustomizerService.MutateCampaignCustomizers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.CampaignDraftService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.CampaignExperimentService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignExtensionSettingService.GetCampaignExtensionSetting - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignFeedService.GetCampaignFeed - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignFeedService.MutateCampaignFeeds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignLabelService.GetCampaignLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignLabelService.MutateCampaignLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignService.GetCampaign - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignService.MutateCampaigns - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignSharedSetService.GetCampaignSharedSet - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignSharedSetService.MutateCampaignSharedSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CampaignSimulationService.GetCampaignSimulation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CarrierConstantService.GetCarrierConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ChangeStatusService.GetChangeStatus - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ClickViewService.GetClickView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CombinedAudienceService.GetCombinedAudience - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionActionService.GetConversionAction - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionActionService.MutateConversionActions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionAdjustmentUploadService.UploadConversionAdjustments - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionCustomVariableService.GetConversionCustomVariable - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionCustomVariableService.MutateConversionCustomVariables - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionUploadService.UploadCallConversions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionUploadService.UploadClickConversions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionValueRuleService.GetConversionValueRule - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionValueRuleService.MutateConversionValueRules - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionValueRuleSetService.GetConversionValueRuleSet - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ConversionValueRuleSetService.MutateConversionValueRuleSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CurrencyConstantService.GetCurrencyConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomAudienceService.GetCustomAudience - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomAudienceService.MutateCustomAudiences - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomConversionGoalService.MutateCustomConversionGoals - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomInterestService.GetCustomInterest - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomInterestService.MutateCustomInterests - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerAssetService.GetCustomerAsset - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerAssetService.MutateCustomerAssets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerClientLinkService.GetCustomerClientLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerClientLinkService.MutateCustomerClientLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerClientService.GetCustomerClient - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerConversionGoalService.MutateCustomerConversionGoals - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerCustomizerService.MutateCustomerCustomizers - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerExtensionSettingService.GetCustomerExtensionSetting - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerFeedService.GetCustomerFeed - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerFeedService.MutateCustomerFeeds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerLabelService.GetCustomerLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerLabelService.MutateCustomerLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.CustomerManagerLinkService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.CustomerService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerUserAccessInvitationService.GetCustomerUserAccessInvitation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerUserAccessService.GetCustomerUserAccess - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomerUserAccessService.MutateCustomerUserAccess - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.CustomizerAttributeService.MutateCustomizerAttributes - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DetailPlacementViewService.GetDetailPlacementView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DetailedDemographicService.GetDetailedDemographic - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DisplayKeywordViewService.GetDisplayKeywordView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DistanceViewService.GetDistanceView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DomainCategoryService.GetDomainCategory - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ExpandedLandingPageViewService.GetExpandedLandingPageView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ExtensionFeedItemService.GetExtensionFeedItem - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ExtensionFeedItemService.MutateExtensionFeedItems - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemService.GetFeedItem - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemService.MutateFeedItems - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemSetLinkService.GetFeedItemSetLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemSetLinkService.MutateFeedItemSetLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemSetService.GetFeedItemSet - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemSetService.MutateFeedItemSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemTargetService.GetFeedItemTarget - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedItemTargetService.MutateFeedItemTargets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedMappingService.GetFeedMapping - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedMappingService.MutateFeedMappings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedPlaceholderViewService.GetFeedPlaceholderView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedService.GetFeed - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.FeedService.MutateFeeds - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GenderViewService.GetGenderView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GeoTargetConstantService.GetGeoTargetConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GeoTargetConstantService.SuggestGeoTargetConstants - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GeographicViewService.GetGeographicView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GoogleAdsFieldService.GetGoogleAdsField - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GoogleAdsFieldService.SearchGoogleAdsFields - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.GoogleAdsService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.GroupPlacementViewService.GetGroupPlacementView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.HotelGroupViewService.GetHotelGroupView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.HotelPerformanceViewService.GetHotelPerformanceView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.IncomeRangeViewService.GetIncomeRangeView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.InvoiceService.ListInvoices - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignService.GetKeywordPlanCampaign - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordPlanIdeaService.GenerateKeywordIdeas - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.KeywordPlanService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordThemeConstantService.GetKeywordThemeConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordThemeConstantService.SuggestKeywordThemeConstants - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.KeywordViewService.GetKeywordView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LabelService.GetLabel - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LabelService.MutateLabels - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LandingPageViewService.GetLandingPageView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LanguageConstantService.GetLanguageConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LifeEventService.GetLifeEvent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.LocationViewService.GetLocationView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ManagedPlacementViewService.GetManagedPlacementView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.MediaFileService.GetMediaFile - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.MediaFileService.MutateMediaFiles - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.MerchantCenterLinkService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.MobileDeviceConstantService.GetMobileDeviceConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.OfflineUserDataJobService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ParentalStatusViewService.GetParentalStatusView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.PaymentsAccountService.ListPaymentsAccounts - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ProductGroupViewService.GetProductGroupView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.ReachPlanService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.RecommendationService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.RemarketingActionService.GetRemarketingAction - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.RemarketingActionService.MutateRemarketingActions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SearchTermViewService.GetSearchTermView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SharedCriterionService.GetSharedCriterion - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SharedCriterionService.MutateSharedCriteria - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SharedSetService.GetSharedSet - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SharedSetService.MutateSharedSets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ShoppingPerformanceViewService.GetShoppingPerformanceView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SmartCampaignSettingService.GetSmartCampaignSetting - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.SmartCampaignSettingService.MutateSmartCampaignSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: 'google.ads.googleads.v9.services.SmartCampaignSuggestService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.TopicConstantService.GetTopicConstant - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.TopicViewService.GetTopicView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.UserDataService.UploadUserData - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.UserInterestService.GetUserInterest - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.UserListService.GetUserList - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.UserListService.MutateUserLists - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.UserLocationViewService.GetUserLocationView - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.VideoService.GetVideo - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/adwords - - selector: google.ads.googleads.v9.services.WebpageViewService.GetWebpageView - 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/google/ads/googleads/v9/resources/asset.proto b/google/ads/googleads/v9/resources/asset.proto deleted file mode 100644 index ba0bb340e..000000000 --- a/google/ads/googleads/v9/resources/asset.proto +++ /dev/null @@ -1,156 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/common/asset_types.proto"; -import "google/ads/googleads/v9/common/custom_parameter.proto"; -import "google/ads/googleads/v9/common/policy.proto"; -import "google/ads/googleads/v9/enums/asset_type.proto"; -import "google/ads/googleads/v9/enums/policy_approval_status.proto"; -import "google/ads/googleads/v9/enums/policy_review_status.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; -option java_multiple_files = true; -option java_outer_classname = "AssetProto"; -option java_package = "com.google.ads.googleads.v9.resources"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::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.v9.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.v9.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.v9.common.YoutubeVideoAsset youtube_video_asset = 5 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. A media bundle asset. - google.ads.googleads.v9.common.MediaBundleAsset media_bundle_asset = 6 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. An image asset. - google.ads.googleads.v9.common.ImageAsset image_asset = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. A text asset. - google.ads.googleads.v9.common.TextAsset text_asset = 8 [(google.api.field_behavior) = IMMUTABLE]; - - // A lead form asset. - google.ads.googleads.v9.common.LeadFormAsset lead_form_asset = 9; - - // A book on google asset. - google.ads.googleads.v9.common.BookOnGoogleAsset book_on_google_asset = 10; - - // A promotion asset. - google.ads.googleads.v9.common.PromotionAsset promotion_asset = 15; - - // A callout asset. - google.ads.googleads.v9.common.CalloutAsset callout_asset = 20; - - // A structured snippet asset. - google.ads.googleads.v9.common.StructuredSnippetAsset structured_snippet_asset = 21; - - // A sitelink asset. - google.ads.googleads.v9.common.SitelinkAsset sitelink_asset = 22; - - // A page feed asset. - google.ads.googleads.v9.common.PageFeedAsset page_feed_asset = 23; - - // A dynamic education asset. - google.ads.googleads.v9.common.DynamicEducationAsset dynamic_education_asset = 24; - - // A mobile app asset. - google.ads.googleads.v9.common.MobileAppAsset mobile_app_asset = 25; - - // A hotel callout asset. - google.ads.googleads.v9.common.HotelCalloutAsset hotel_callout_asset = 26; - - // A call asset. - google.ads.googleads.v9.common.CallAsset call_asset = 27; - - // A price asset. - google.ads.googleads.v9.common.PriceAsset price_asset = 28; - - // Immutable. A call to action asset. - google.ads.googleads.v9.common.CallToActionAsset call_to_action_asset = 29 [(google.api.field_behavior) = IMMUTABLE]; - } -} - -// Contains policy information for an asset. -message AssetPolicySummary { - // Output only. The list of policy findings for this asset. - repeated google.ads.googleads.v9.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.v9.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.v9.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} diff --git a/google/ads/googleads/v9/resources/campaign_experiment.proto b/google/ads/googleads/v9/resources/campaign_experiment.proto deleted file mode 100644 index 1d831e74f..000000000 --- a/google/ads/googleads/v9/resources/campaign_experiment.proto +++ /dev/null @@ -1,121 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/enums/campaign_experiment_status.proto"; -import "google/ads/googleads/v9/enums/campaign_experiment_traffic_split_type.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; -option java_multiple_files = true; -option java_outer_classname = "CampaignExperimentProto"; -option java_package = "com.google.ads.googleads.v9.resources"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::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.v9.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.v9.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/google/ads/googleads/v9/resources/feed_mapping.proto b/google/ads/googleads/v9/resources/feed_mapping.proto deleted file mode 100644 index 6b6b906a8..000000000 --- a/google/ads/googleads/v9/resources/feed_mapping.proto +++ /dev/null @@ -1,189 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.resources; - -import "google/ads/googleads/v9/enums/ad_customizer_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/affiliate_location_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/app_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/call_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/callout_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/custom_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/dsa_page_feed_criterion_field.proto"; -import "google/ads/googleads/v9/enums/education_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/feed_mapping_criterion_type.proto"; -import "google/ads/googleads/v9/enums/feed_mapping_status.proto"; -import "google/ads/googleads/v9/enums/flight_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/hotel_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/image_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/job_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/local_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/location_extension_targeting_criterion_field.proto"; -import "google/ads/googleads/v9/enums/location_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/message_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/placeholder_type.proto"; -import "google/ads/googleads/v9/enums/price_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/promotion_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/real_estate_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/sitelink_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/structured_snippet_placeholder_field.proto"; -import "google/ads/googleads/v9/enums/travel_placeholder_field.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/api/annotations.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Resources"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/resources;resources"; -option java_multiple_files = true; -option java_outer_classname = "FeedMappingProto"; -option java_package = "com.google.ads.googleads.v9.resources"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Resources"; -option ruby_package = "Google::Ads::GoogleAds::V9::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.v9.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.v9.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.v9.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.v9.enums.SitelinkPlaceholderFieldEnum.SitelinkPlaceholderField sitelink_field = 3 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Call Placeholder Fields. - google.ads.googleads.v9.enums.CallPlaceholderFieldEnum.CallPlaceholderField call_field = 4 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. App Placeholder Fields. - google.ads.googleads.v9.enums.AppPlaceholderFieldEnum.AppPlaceholderField app_field = 5 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. Location Placeholder Fields. This field is read-only. - google.ads.googleads.v9.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.v9.enums.AffiliateLocationPlaceholderFieldEnum.AffiliateLocationPlaceholderField affiliate_location_field = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. Callout Placeholder Fields. - google.ads.googleads.v9.enums.CalloutPlaceholderFieldEnum.CalloutPlaceholderField callout_field = 8 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Structured Snippet Placeholder Fields. - google.ads.googleads.v9.enums.StructuredSnippetPlaceholderFieldEnum.StructuredSnippetPlaceholderField structured_snippet_field = 9 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Message Placeholder Fields. - google.ads.googleads.v9.enums.MessagePlaceholderFieldEnum.MessagePlaceholderField message_field = 10 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Price Placeholder Fields. - google.ads.googleads.v9.enums.PricePlaceholderFieldEnum.PricePlaceholderField price_field = 11 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Promotion Placeholder Fields. - google.ads.googleads.v9.enums.PromotionPlaceholderFieldEnum.PromotionPlaceholderField promotion_field = 12 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Ad Customizer Placeholder Fields - google.ads.googleads.v9.enums.AdCustomizerPlaceholderFieldEnum.AdCustomizerPlaceholderField ad_customizer_field = 13 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Dynamic Search Ad Page Feed Fields. - google.ads.googleads.v9.enums.DsaPageFeedCriterionFieldEnum.DsaPageFeedCriterionField dsa_page_feed_field = 14 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Location Target Fields. - google.ads.googleads.v9.enums.LocationExtensionTargetingCriterionFieldEnum.LocationExtensionTargetingCriterionField location_extension_targeting_field = 15 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Education Placeholder Fields - google.ads.googleads.v9.enums.EducationPlaceholderFieldEnum.EducationPlaceholderField education_field = 16 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Flight Placeholder Fields - google.ads.googleads.v9.enums.FlightPlaceholderFieldEnum.FlightPlaceholderField flight_field = 17 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Custom Placeholder Fields - google.ads.googleads.v9.enums.CustomPlaceholderFieldEnum.CustomPlaceholderField custom_field = 18 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Hotel Placeholder Fields - google.ads.googleads.v9.enums.HotelPlaceholderFieldEnum.HotelPlaceholderField hotel_field = 19 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Real Estate Placeholder Fields - google.ads.googleads.v9.enums.RealEstatePlaceholderFieldEnum.RealEstatePlaceholderField real_estate_field = 20 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Travel Placeholder Fields - google.ads.googleads.v9.enums.TravelPlaceholderFieldEnum.TravelPlaceholderField travel_field = 21 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Local Placeholder Fields - google.ads.googleads.v9.enums.LocalPlaceholderFieldEnum.LocalPlaceholderField local_field = 22 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Job Placeholder Fields - google.ads.googleads.v9.enums.JobPlaceholderFieldEnum.JobPlaceholderField job_field = 23 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Image Placeholder Fields - google.ads.googleads.v9.enums.ImagePlaceholderFieldEnum.ImagePlaceholderField image_field = 26 [(google.api.field_behavior) = IMMUTABLE]; - } -} diff --git a/google/ads/googleads/v9/services/accessible_bidding_strategy_service.proto b/google/ads/googleads/v9/services/accessible_bidding_strategy_service.proto deleted file mode 100644 index dd8a77055..000000000 --- a/google/ads/googleads/v9/services/accessible_bidding_strategy_service.proto +++ /dev/null @@ -1,58 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/accessible_bidding_strategy.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AccessibleBiddingStrategyServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Service to read accessible bidding strategies. -service AccessibleBiddingStrategyService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested accessible bidding strategy in full detail. - rpc GetAccessibleBiddingStrategy(GetAccessibleBiddingStrategyRequest) returns (google.ads.googleads.v9.resources.AccessibleBiddingStrategy) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/accessibleBiddingStrategies/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy][google.ads.googleads.v9.services.AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy]. -message GetAccessibleBiddingStrategyRequest { - // Required. The resource name of the accessible bidding strategy to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AccessibleBiddingStrategy" - } - ]; -} diff --git a/google/ads/googleads/v9/services/account_budget_service.proto b/google/ads/googleads/v9/services/account_budget_service.proto deleted file mode 100644 index bd8808101..000000000 --- a/google/ads/googleads/v9/services/account_budget_service.proto +++ /dev/null @@ -1,70 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/account_budget.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AccountBudgetServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AccountBudget service. - -// A service for fetching an account-level budget. -// -// Account-level budgets are mutated by creating proposal resources. -service AccountBudgetService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns an account-level budget in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAccountBudget(GetAccountBudgetRequest) returns (google.ads.googleads.v9.resources.AccountBudget) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/accountBudgets/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [AccountBudgetService.GetAccountBudget][google.ads.googleads.v9.services.AccountBudgetService.GetAccountBudget]. -message GetAccountBudgetRequest { - // Required. The resource name of the account-level budget to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AccountBudget" - } - ]; -} diff --git a/google/ads/googleads/v9/services/ad_group_ad_asset_view_service.proto b/google/ads/googleads/v9/services/ad_group_ad_asset_view_service.proto deleted file mode 100644 index 0f1b263cc..000000000 --- a/google/ads/googleads/v9/services/ad_group_ad_asset_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/ad_group_ad_asset_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AdGroupAdAssetViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the ad group ad asset view service. - -// Service to fetch ad group ad asset views. -service AdGroupAdAssetViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested ad group ad asset view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupAdAssetView(GetAdGroupAdAssetViewRequest) returns (google.ads.googleads.v9.resources.AdGroupAdAssetView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupAdAssetViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AdGroupAdAssetViewService.GetAdGroupAdAssetView][google.ads.googleads.v9.services.AdGroupAdAssetViewService.GetAdGroupAdAssetView]. -message GetAdGroupAdAssetViewRequest { - // Required. The resource name of the ad group ad asset view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupAdAssetView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/ad_group_audience_view_service.proto b/google/ads/googleads/v9/services/ad_group_audience_view_service.proto deleted file mode 100644 index b90af3854..000000000 --- a/google/ads/googleads/v9/services/ad_group_audience_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/ad_group_audience_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AdGroupAudienceViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AdGroup Audience View service. - -// Service to manage ad group audience views. -service AdGroupAudienceViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested ad group audience view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupAudienceView(GetAdGroupAudienceViewRequest) returns (google.ads.googleads.v9.resources.AdGroupAudienceView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupAudienceViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AdGroupAudienceViewService.GetAdGroupAudienceView][google.ads.googleads.v9.services.AdGroupAudienceViewService.GetAdGroupAudienceView]. -message GetAdGroupAudienceViewRequest { - // Required. The resource name of the ad group audience view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupAudienceView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/ad_group_criterion_simulation_service.proto b/google/ads/googleads/v9/services/ad_group_criterion_simulation_service.proto deleted file mode 100644 index 97051e3da..000000000 --- a/google/ads/googleads/v9/services/ad_group_criterion_simulation_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/ad_group_criterion_simulation.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AdGroupCriterionSimulationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AdGroupCriterionSimulation service. - -// Service to fetch ad group criterion simulations. -service AdGroupCriterionSimulationService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested ad group criterion simulation in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupCriterionSimulation(GetAdGroupCriterionSimulationRequest) returns (google.ads.googleads.v9.resources.AdGroupCriterionSimulation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupCriterionSimulations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation][google.ads.googleads.v9.services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation]. -message GetAdGroupCriterionSimulationRequest { - // Required. The resource name of the ad group criterion simulation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupCriterionSimulation" - } - ]; -} diff --git a/google/ads/googleads/v9/services/ad_group_simulation_service.proto b/google/ads/googleads/v9/services/ad_group_simulation_service.proto deleted file mode 100644 index 32f891689..000000000 --- a/google/ads/googleads/v9/services/ad_group_simulation_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/ad_group_simulation.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AdGroupSimulationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AdGroupSimulation service. - -// Service to fetch ad group simulations. -service AdGroupSimulationService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested ad group simulation in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdGroupSimulation(GetAdGroupSimulationRequest) returns (google.ads.googleads.v9.resources.AdGroupSimulation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adGroupSimulations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AdGroupSimulationService.GetAdGroupSimulation][google.ads.googleads.v9.services.AdGroupSimulationService.GetAdGroupSimulation]. -message GetAdGroupSimulationRequest { - // Required. The resource name of the ad group simulation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdGroupSimulation" - } - ]; -} diff --git a/google/ads/googleads/v9/services/ad_schedule_view_service.proto b/google/ads/googleads/v9/services/ad_schedule_view_service.proto deleted file mode 100644 index 64a9dd966..000000000 --- a/google/ads/googleads/v9/services/ad_schedule_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/ad_schedule_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AdScheduleViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AdSchedule View service. - -// Service to fetch ad schedule views. -service AdScheduleViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested ad schedule view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAdScheduleView(GetAdScheduleViewRequest) returns (google.ads.googleads.v9.resources.AdScheduleView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/adScheduleViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AdScheduleViewService.GetAdScheduleView][google.ads.googleads.v9.services.AdScheduleViewService.GetAdScheduleView]. -message GetAdScheduleViewRequest { - // Required. The resource name of the ad schedule view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AdScheduleView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/age_range_view_service.proto b/google/ads/googleads/v9/services/age_range_view_service.proto deleted file mode 100644 index 901fd7781..000000000 --- a/google/ads/googleads/v9/services/age_range_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/age_range_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AgeRangeViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Age Range View service. - -// Service to manage age range views. -service AgeRangeViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested age range view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetAgeRangeView(GetAgeRangeViewRequest) returns (google.ads.googleads.v9.resources.AgeRangeView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/ageRangeViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AgeRangeViewService.GetAgeRangeView][google.ads.googleads.v9.services.AgeRangeViewService.GetAgeRangeView]. -message GetAgeRangeViewRequest { - // Required. The resource name of the age range view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AgeRangeView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/asset_field_type_view_service.proto b/google/ads/googleads/v9/services/asset_field_type_view_service.proto deleted file mode 100644 index 627e8346f..000000000 --- a/google/ads/googleads/v9/services/asset_field_type_view_service.proto +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/asset_field_type_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "AssetFieldTypeViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the AssetFieldTypeView service. - -// Service to fetch asset field type views. -service AssetFieldTypeViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested asset field type view in full detail. - rpc GetAssetFieldTypeView(GetAssetFieldTypeViewRequest) returns (google.ads.googleads.v9.resources.AssetFieldTypeView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/assetFieldTypeViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [AssetFieldTypeViewService.GetAssetFieldTypeView][google.ads.googleads.v9.services.AssetFieldTypeViewService.GetAssetFieldTypeView]. -message GetAssetFieldTypeViewRequest { - // Required. The resource name of the asset field type view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/AssetFieldTypeView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/bidding_strategy_simulation_service.proto b/google/ads/googleads/v9/services/bidding_strategy_simulation_service.proto deleted file mode 100644 index a6637a249..000000000 --- a/google/ads/googleads/v9/services/bidding_strategy_simulation_service.proto +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/bidding_strategy_simulation.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "BiddingStrategySimulationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the BiddingStrategySimulation service. - -// Service to fetch bidding strategy simulations. -service BiddingStrategySimulationService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested bidding strategy simulation in full detail. - rpc GetBiddingStrategySimulation(GetBiddingStrategySimulationRequest) returns (google.ads.googleads.v9.resources.BiddingStrategySimulation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/biddingStrategySimulations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [BiddingStrategySimulationService.GetBiddingStrategySimulation][google.ads.googleads.v9.services.BiddingStrategySimulationService.GetBiddingStrategySimulation]. -message GetBiddingStrategySimulationRequest { - // Required. The resource name of the bidding strategy simulation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/BiddingStrategySimulation" - } - ]; -} diff --git a/google/ads/googleads/v9/services/campaign_audience_view_service.proto b/google/ads/googleads/v9/services/campaign_audience_view_service.proto deleted file mode 100644 index 15f24521a..000000000 --- a/google/ads/googleads/v9/services/campaign_audience_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/campaign_audience_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CampaignAudienceViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Campaign Audience View service. - -// Service to manage campaign audience views. -service CampaignAudienceViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested campaign audience view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignAudienceView(GetCampaignAudienceViewRequest) returns (google.ads.googleads.v9.resources.CampaignAudienceView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignAudienceViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CampaignAudienceViewService.GetCampaignAudienceView][google.ads.googleads.v9.services.CampaignAudienceViewService.GetCampaignAudienceView]. -message GetCampaignAudienceViewRequest { - // Required. The resource name of the campaign audience view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignAudienceView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/campaign_criterion_simulation_service.proto b/google/ads/googleads/v9/services/campaign_criterion_simulation_service.proto deleted file mode 100644 index 0b773be27..000000000 --- a/google/ads/googleads/v9/services/campaign_criterion_simulation_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/campaign_criterion_simulation.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CampaignCriterionSimulationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the CampaignCriterionSimulation service. - -// Service to fetch campaign criterion simulations. -service CampaignCriterionSimulationService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested campaign criterion simulation in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignCriterionSimulation(GetCampaignCriterionSimulationRequest) returns (google.ads.googleads.v9.resources.CampaignCriterionSimulation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignCriterionSimulations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [CampaignCriterionSimulationService.GetCampaignCriterionSimulation][google.ads.googleads.v9.services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation]. -message GetCampaignCriterionSimulationRequest { - // Required. The resource name of the campaign criterion simulation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignCriterionSimulation" - } - ]; -} diff --git a/google/ads/googleads/v9/services/campaign_experiment_service.proto b/google/ads/googleads/v9/services/campaign_experiment_service.proto deleted file mode 100644 index 22198a4df..000000000 --- a/google/ads/googleads/v9/services/campaign_experiment_service.proto +++ /dev/null @@ -1,382 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/enums/response_content_type.proto"; -import "google/ads/googleads/v9/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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CampaignExperimentServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::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"; - - // Returns the requested campaign experiment in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCampaignExperiment(GetCampaignExperimentRequest) returns (google.ads.googleads.v9.resources.CampaignExperiment) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignExperiments/*}" - }; - option (google.api.method_signature) = "resource_name"; - } - - // 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: "/v9/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.v9.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: "/v9/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: "/v9/{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: "/v9/{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: "/v9/{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: "/v9/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CampaignExperimentService.GetCampaignExperiment][google.ads.googleads.v9.services.CampaignExperimentService.GetCampaignExperiment]. -message GetCampaignExperimentRequest { - // Required. The resource name of the campaign experiment to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignExperiment" - } - ]; -} - -// Request message for [CampaignExperimentService.MutateCampaignExperiments][google.ads.googleads.v9.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.v9.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.v9.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; - } -} - -// 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; - - // 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.v9.resources.CampaignExperiment campaign_experiment = 2; -} - -// Request message for [CampaignExperimentService.CreateCampaignExperiment][google.ads.googleads.v9.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.v9.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.v9.services.CampaignExperimentService.GraduateCampaignExperiment]. -message GraduateCampaignExperimentRequest { - // Required. The resource name of the campaign experiment to graduate. - string campaign_experiment = 1 [(google.api.field_behavior) = REQUIRED]; - - // 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.v9.services.CampaignExperimentService.PromoteCampaignExperiment]. -message PromoteCampaignExperimentRequest { - // Required. The resource name of the campaign experiment to promote. - string campaign_experiment = 1 [(google.api.field_behavior) = REQUIRED]; - - // 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.v9.services.CampaignExperimentService.EndCampaignExperiment]. -message EndCampaignExperimentRequest { - // Required. The resource name of the campaign experiment to end. - string campaign_experiment = 1 [(google.api.field_behavior) = REQUIRED]; - - // 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.v9.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.v9.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/google/ads/googleads/v9/services/campaign_simulation_service.proto b/google/ads/googleads/v9/services/campaign_simulation_service.proto deleted file mode 100644 index 92833873e..000000000 --- a/google/ads/googleads/v9/services/campaign_simulation_service.proto +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/campaign_simulation.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CampaignSimulationServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the CampaignSimulation service. - -// Service to fetch campaign simulations. -service CampaignSimulationService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested campaign simulation in full detail. - rpc GetCampaignSimulation(GetCampaignSimulationRequest) returns (google.ads.googleads.v9.resources.CampaignSimulation) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/campaignSimulations/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [CampaignSimulationService.GetCampaignSimulation][google.ads.googleads.v9.services.CampaignSimulationService.GetCampaignSimulation]. -message GetCampaignSimulationRequest { - // Required. The resource name of the campaign simulation to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CampaignSimulation" - } - ]; -} diff --git a/google/ads/googleads/v9/services/carrier_constant_service.proto b/google/ads/googleads/v9/services/carrier_constant_service.proto deleted file mode 100644 index 1047cf870..000000000 --- a/google/ads/googleads/v9/services/carrier_constant_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/carrier_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CarrierConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the carrier constant service. - -// Service to fetch carrier constants. -service CarrierConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested carrier constant in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCarrierConstant(GetCarrierConstantRequest) returns (google.ads.googleads.v9.resources.CarrierConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=carrierConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CarrierConstantService.GetCarrierConstant][google.ads.googleads.v9.services.CarrierConstantService.GetCarrierConstant]. -message GetCarrierConstantRequest { - // Required. Resource name of the carrier constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CarrierConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/change_status_service.proto b/google/ads/googleads/v9/services/change_status_service.proto deleted file mode 100644 index 55056554b..000000000 --- a/google/ads/googleads/v9/services/change_status_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/change_status.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ChangeStatusServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Change Status service. - -// Service to fetch change statuses. -service ChangeStatusService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested change status in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetChangeStatus(GetChangeStatusRequest) returns (google.ads.googleads.v9.resources.ChangeStatus) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/changeStatus/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for '[ChangeStatusService.GetChangeStatus][google.ads.googleads.v9.services.ChangeStatusService.GetChangeStatus]'. -message GetChangeStatusRequest { - // Required. The resource name of the change status to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ChangeStatus" - } - ]; -} diff --git a/google/ads/googleads/v9/services/click_view_service.proto b/google/ads/googleads/v9/services/click_view_service.proto deleted file mode 100644 index 125674328..000000000 --- a/google/ads/googleads/v9/services/click_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/click_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ClickViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the ClickView service. - -// Service to fetch click views. -service ClickViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested click view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetClickView(GetClickViewRequest) returns (google.ads.googleads.v9.resources.ClickView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/clickViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [ClickViewService.GetClickView][google.ads.googleads.v9.services.ClickViewService.GetClickView]. -message GetClickViewRequest { - // Required. The resource name of the click view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ClickView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/combined_audience_service.proto b/google/ads/googleads/v9/services/combined_audience_service.proto deleted file mode 100644 index d5bf1503a..000000000 --- a/google/ads/googleads/v9/services/combined_audience_service.proto +++ /dev/null @@ -1,69 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/combined_audience.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CombinedAudienceServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Combined Audience service. - -// Service to manage combined audiences. This service can be used to list all -// your combined audiences with metadata, but won't show the structure and -// components of the combined audience. -service CombinedAudienceService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested combined audience in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCombinedAudience(GetCombinedAudienceRequest) returns (google.ads.googleads.v9.resources.CombinedAudience) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/combinedAudiences/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CombinedAudienceService.GetCombinedAudience][google.ads.googleads.v9.services.CombinedAudienceService.GetCombinedAudience]. -message GetCombinedAudienceRequest { - // Required. The resource name of the combined audience to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CombinedAudience" - } - ]; -} diff --git a/google/ads/googleads/v9/services/currency_constant_service.proto b/google/ads/googleads/v9/services/currency_constant_service.proto deleted file mode 100644 index c00ccd428..000000000 --- a/google/ads/googleads/v9/services/currency_constant_service.proto +++ /dev/null @@ -1,65 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/currency_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CurrencyConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Service to fetch currency constants. -service CurrencyConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested currency constant. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCurrencyConstant(GetCurrencyConstantRequest) returns (google.ads.googleads.v9.resources.CurrencyConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=currencyConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CurrencyConstantService.GetCurrencyConstant][google.ads.googleads.v9.services.CurrencyConstantService.GetCurrencyConstant]. -message GetCurrencyConstantRequest { - // Required. Resource name of the currency constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CurrencyConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/customer_client_service.proto b/google/ads/googleads/v9/services/customer_client_service.proto deleted file mode 100644 index c70ed5922..000000000 --- a/google/ads/googleads/v9/services/customer_client_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/customer_client.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "CustomerClientServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Customer Client service. - -// Service to get clients in a customer's hierarchy. -service CustomerClientService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested client in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetCustomerClient(GetCustomerClientRequest) returns (google.ads.googleads.v9.resources.CustomerClient) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/customerClients/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [CustomerClientService.GetCustomerClient][google.ads.googleads.v9.services.CustomerClientService.GetCustomerClient]. -message GetCustomerClientRequest { - // Required. The resource name of the client to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/CustomerClient" - } - ]; -} diff --git a/google/ads/googleads/v9/services/detail_placement_view_service.proto b/google/ads/googleads/v9/services/detail_placement_view_service.proto deleted file mode 100644 index d5d9b6ae7..000000000 --- a/google/ads/googleads/v9/services/detail_placement_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/detail_placement_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DetailPlacementViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Detail Placement View service. - -// Service to fetch Detail Placement views. -service DetailPlacementViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Detail Placement view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetDetailPlacementView(GetDetailPlacementViewRequest) returns (google.ads.googleads.v9.resources.DetailPlacementView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/detailPlacementViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [DetailPlacementViewService.GetDetailPlacementView][google.ads.googleads.v9.services.DetailPlacementViewService.GetDetailPlacementView]. -message GetDetailPlacementViewRequest { - // Required. The resource name of the Detail Placement view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DetailPlacementView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/detailed_demographic_service.proto b/google/ads/googleads/v9/services/detailed_demographic_service.proto deleted file mode 100644 index 5fbc8af46..000000000 --- a/google/ads/googleads/v9/services/detailed_demographic_service.proto +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/detailed_demographic.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DetailedDemographicServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the detailed demographic service - -// Service to fetch Google Ads Detailed Demographics. -service DetailedDemographicService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested detailed demographic in full detail. - rpc GetDetailedDemographic(GetDetailedDemographicRequest) returns (google.ads.googleads.v9.resources.DetailedDemographic) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/detailedDemographics/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [DetailedDemographicService.GetDetailedDemographic][google.ads.googleads.v9.services.DetailedDemographicService.GetDetailedDemographic]. -message GetDetailedDemographicRequest { - // Required. Resource name of the DetailedDemographic to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DetailedDemographic" - } - ]; -} diff --git a/google/ads/googleads/v9/services/display_keyword_view_service.proto b/google/ads/googleads/v9/services/display_keyword_view_service.proto deleted file mode 100644 index e242ac793..000000000 --- a/google/ads/googleads/v9/services/display_keyword_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/display_keyword_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DisplayKeywordViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Display Keyword View service. - -// Service to manage display keyword views. -service DisplayKeywordViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested display keyword view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetDisplayKeywordView(GetDisplayKeywordViewRequest) returns (google.ads.googleads.v9.resources.DisplayKeywordView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/displayKeywordViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [DisplayKeywordViewService.GetDisplayKeywordView][google.ads.googleads.v9.services.DisplayKeywordViewService.GetDisplayKeywordView]. -message GetDisplayKeywordViewRequest { - // Required. The resource name of the display keyword view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DisplayKeywordView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/distance_view_service.proto b/google/ads/googleads/v9/services/distance_view_service.proto deleted file mode 100644 index 625e06b5b..000000000 --- a/google/ads/googleads/v9/services/distance_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/distance_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DistanceViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Distance View service. - -// Service to fetch distance views. -service DistanceViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the attributes of the requested distance view. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetDistanceView(GetDistanceViewRequest) returns (google.ads.googleads.v9.resources.DistanceView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/distanceViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [DistanceViewService.GetDistanceView][google.ads.googleads.v9.services.DistanceViewService.GetDistanceView]. -message GetDistanceViewRequest { - // Required. The resource name of the distance view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DistanceView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/domain_category_service.proto b/google/ads/googleads/v9/services/domain_category_service.proto deleted file mode 100644 index f7680b3a7..000000000 --- a/google/ads/googleads/v9/services/domain_category_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/domain_category.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DomainCategoryServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the DomainCategory Service. - -// Service to fetch domain categories. -service DomainCategoryService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested domain category. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetDomainCategory(GetDomainCategoryRequest) returns (google.ads.googleads.v9.resources.DomainCategory) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/domainCategories/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [DomainCategoryService.GetDomainCategory][google.ads.googleads.v9.services.DomainCategoryService.GetDomainCategory]. -message GetDomainCategoryRequest { - // Required. Resource name of the domain category to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DomainCategory" - } - ]; -} diff --git a/google/ads/googleads/v9/services/dynamic_search_ads_search_term_view_service.proto b/google/ads/googleads/v9/services/dynamic_search_ads_search_term_view_service.proto deleted file mode 100644 index 723bcf7f3..000000000 --- a/google/ads/googleads/v9/services/dynamic_search_ads_search_term_view_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/dynamic_search_ads_search_term_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "DynamicSearchAdsSearchTermViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Dynamic Search Ads Search Term View service. - -// Service to fetch dynamic search ads views. -service DynamicSearchAdsSearchTermViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested dynamic search ads search term view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetDynamicSearchAdsSearchTermView(GetDynamicSearchAdsSearchTermViewRequest) returns (google.ads.googleads.v9.resources.DynamicSearchAdsSearchTermView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/dynamicSearchAdsSearchTermViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView][google.ads.googleads.v9.services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView]. -message GetDynamicSearchAdsSearchTermViewRequest { - // Required. The resource name of the dynamic search ads search term view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/DynamicSearchAdsSearchTermView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/expanded_landing_page_view_service.proto b/google/ads/googleads/v9/services/expanded_landing_page_view_service.proto deleted file mode 100644 index 197efec52..000000000 --- a/google/ads/googleads/v9/services/expanded_landing_page_view_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/expanded_landing_page_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ExpandedLandingPageViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the expanded landing page view service. - -// Service to fetch expanded landing page views. -service ExpandedLandingPageViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested expanded landing page view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetExpandedLandingPageView(GetExpandedLandingPageViewRequest) returns (google.ads.googleads.v9.resources.ExpandedLandingPageView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/expandedLandingPageViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [ExpandedLandingPageViewService.GetExpandedLandingPageView][google.ads.googleads.v9.services.ExpandedLandingPageViewService.GetExpandedLandingPageView]. -message GetExpandedLandingPageViewRequest { - // Required. The resource name of the expanded landing page view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ExpandedLandingPageView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/feed_placeholder_view_service.proto b/google/ads/googleads/v9/services/feed_placeholder_view_service.proto deleted file mode 100644 index 3ece6a71c..000000000 --- a/google/ads/googleads/v9/services/feed_placeholder_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/feed_placeholder_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "FeedPlaceholderViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the FeedPlaceholderView service. - -// Service to fetch feed placeholder views. -service FeedPlaceholderViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested feed placeholder view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetFeedPlaceholderView(GetFeedPlaceholderViewRequest) returns (google.ads.googleads.v9.resources.FeedPlaceholderView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/feedPlaceholderViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [FeedPlaceholderViewService.GetFeedPlaceholderView][google.ads.googleads.v9.services.FeedPlaceholderViewService.GetFeedPlaceholderView]. -message GetFeedPlaceholderViewRequest { - // Required. The resource name of the feed placeholder view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/FeedPlaceholderView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/gender_view_service.proto b/google/ads/googleads/v9/services/gender_view_service.proto deleted file mode 100644 index d7653376f..000000000 --- a/google/ads/googleads/v9/services/gender_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/gender_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "GenderViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Gender View service. - -// Service to manage gender views. -service GenderViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested gender view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetGenderView(GetGenderViewRequest) returns (google.ads.googleads.v9.resources.GenderView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/genderViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [GenderViewService.GetGenderView][google.ads.googleads.v9.services.GenderViewService.GetGenderView]. -message GetGenderViewRequest { - // Required. The resource name of the gender view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/GenderView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/geographic_view_service.proto b/google/ads/googleads/v9/services/geographic_view_service.proto deleted file mode 100644 index 49aceac4a..000000000 --- a/google/ads/googleads/v9/services/geographic_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/geographic_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "GeographicViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the GeographicViewService. - -// Service to manage geographic views. -service GeographicViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested geographic view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetGeographicView(GetGeographicViewRequest) returns (google.ads.googleads.v9.resources.GeographicView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/geographicViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [GeographicViewService.GetGeographicView][google.ads.googleads.v9.services.GeographicViewService.GetGeographicView]. -message GetGeographicViewRequest { - // Required. The resource name of the geographic view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/GeographicView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/group_placement_view_service.proto b/google/ads/googleads/v9/services/group_placement_view_service.proto deleted file mode 100644 index bd8dda949..000000000 --- a/google/ads/googleads/v9/services/group_placement_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/group_placement_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "GroupPlacementViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Group Placement View service. - -// Service to fetch Group Placement views. -service GroupPlacementViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Group Placement view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetGroupPlacementView(GetGroupPlacementViewRequest) returns (google.ads.googleads.v9.resources.GroupPlacementView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/groupPlacementViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [GroupPlacementViewService.GetGroupPlacementView][google.ads.googleads.v9.services.GroupPlacementViewService.GetGroupPlacementView]. -message GetGroupPlacementViewRequest { - // Required. The resource name of the Group Placement view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/GroupPlacementView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/hotel_group_view_service.proto b/google/ads/googleads/v9/services/hotel_group_view_service.proto deleted file mode 100644 index a11973374..000000000 --- a/google/ads/googleads/v9/services/hotel_group_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/hotel_group_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "HotelGroupViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Hotel Group View Service. - -// Service to manage Hotel Group Views. -service HotelGroupViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Hotel Group View in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetHotelGroupView(GetHotelGroupViewRequest) returns (google.ads.googleads.v9.resources.HotelGroupView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/hotelGroupViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [HotelGroupViewService.GetHotelGroupView][google.ads.googleads.v9.services.HotelGroupViewService.GetHotelGroupView]. -message GetHotelGroupViewRequest { - // Required. Resource name of the Hotel Group View to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/HotelGroupView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/hotel_performance_view_service.proto b/google/ads/googleads/v9/services/hotel_performance_view_service.proto deleted file mode 100644 index 6b516ca57..000000000 --- a/google/ads/googleads/v9/services/hotel_performance_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/hotel_performance_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "HotelPerformanceViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Hotel Performance View Service. - -// Service to manage Hotel Performance Views. -service HotelPerformanceViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Hotel Performance View in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetHotelPerformanceView(GetHotelPerformanceViewRequest) returns (google.ads.googleads.v9.resources.HotelPerformanceView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/hotelPerformanceView}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [HotelPerformanceViewService.GetHotelPerformanceView][google.ads.googleads.v9.services.HotelPerformanceViewService.GetHotelPerformanceView]. -message GetHotelPerformanceViewRequest { - // Required. Resource name of the Hotel Performance View to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/HotelPerformanceView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/income_range_view_service.proto b/google/ads/googleads/v9/services/income_range_view_service.proto deleted file mode 100644 index 9bc978a4f..000000000 --- a/google/ads/googleads/v9/services/income_range_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/income_range_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "IncomeRangeViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Income Range View service. - -// Service to manage income range views. -service IncomeRangeViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested income range view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetIncomeRangeView(GetIncomeRangeViewRequest) returns (google.ads.googleads.v9.resources.IncomeRangeView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/incomeRangeViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [IncomeRangeViewService.GetIncomeRangeView][google.ads.googleads.v9.services.IncomeRangeViewService.GetIncomeRangeView]. -message GetIncomeRangeViewRequest { - // Required. The resource name of the income range view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/IncomeRangeView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/keyword_plan_idea_service.proto b/google/ads/googleads/v9/services/keyword_plan_idea_service.proto deleted file mode 100644 index 32f32634d..000000000 --- a/google/ads/googleads/v9/services/keyword_plan_idea_service.proto +++ /dev/null @@ -1,181 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/common/keyword_plan_common.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_keyword_annotation.proto"; -import "google/ads/googleads/v9/enums/keyword_plan_network.proto"; -import "google/api/annotations.proto"; -import "google/api/client.proto"; - -option csharp_namespace = "Google.Ads.GoogleAds.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "KeywordPlanIdeaServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the keyword plan idea service. - -// Service to generate keyword ideas. -service KeywordPlanIdeaService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns a list of keyword ideas. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [CollectionSizeError]() - // [HeaderError]() - // [InternalError]() - // [KeywordPlanIdeaError]() - // [QuotaError]() - // [RequestError]() - rpc GenerateKeywordIdeas(GenerateKeywordIdeasRequest) returns (GenerateKeywordIdeaResponse) { - option (google.api.http) = { - post: "/v9/customers/{customer_id=*}:generateKeywordIdeas" - body: "*" - }; - } -} - -// Request message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v9.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 - optional string language = 14; - - // The resource names of the location to target. - // Max 10 - repeated string geo_target_constants = 15; - - // If true, adult keywords will be included in response. - // The default value is false. - bool include_adult_keywords = 10; - - // Token of the page to retrieve. If not specified, the first - // page of results will be returned. To request next page of results use the - // value obtained from `next_page_token` in the previous response. - // The request fields must match across pages. - string page_token = 12; - - // Number of results to retrieve in a single page. - // A maximum of 10,000 results may be returned, if the page_size - // exceeds this, it is ignored. - // If unspecified, at most 10,000 results will be returned. - // The server may decide to further limit the number of returned resources. - // If the response contains fewer than 10,000 results it may not be assumed - // as last page of results. - int32 page_size = 13; - - // Targeting network. - google.ads.googleads.v9.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9; - - // The keyword annotations to include in response. - repeated google.ads.googleads.v9.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17; - - // The aggregate fields to include in response. - google.ads.googleads.v9.common.KeywordPlanAggregateMetrics aggregate_metrics = 16; - - // The options for historical metrics data. - google.ads.googleads.v9.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. - KeywordAndUrlSeed keyword_and_url_seed = 2; - - // A Keyword or phrase to generate ideas from, e.g. cars. - KeywordSeed keyword_seed = 3; - - // A specific url to generate ideas from, e.g. www.example.com/cars. - UrlSeed url_seed = 5; - - // The site to generate ideas from, e.g. www.example.com. - SiteSeed site_seed = 11; - } -} - -// Keyword And Url Seed -message KeywordAndUrlSeed { - // The URL to crawl in order to generate keyword ideas. - optional string url = 3; - - // Requires at least one keyword. - repeated string keywords = 4; -} - -// Keyword Seed -message KeywordSeed { - // Requires at least one keyword. - repeated string keywords = 2; -} - -// Site Seed -message SiteSeed { - // The domain name of the site. If the customer requesting the ideas doesn't - // own the site provided only public information is returned. - optional string site = 2; -} - -// Url Seed -message UrlSeed { - // The URL to crawl in order to generate keyword ideas. - optional string url = 2; -} - -// Response message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v9.services.KeywordPlanIdeaService.GenerateKeywordIdeas]. -message GenerateKeywordIdeaResponse { - // Results of generating keyword ideas. - repeated GenerateKeywordIdeaResult results = 1; - - // The aggregate metrics for all keyword ideas. - google.ads.googleads.v9.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 - // the next request. - // `next_page_token` is not returned for the last page. - string next_page_token = 2; - - // Total number of results available. - int64 total_size = 3; -} - -// The result of generating keyword ideas. -message GenerateKeywordIdeaResult { - // Text of the keyword idea. - // As in Keyword Plan historical metrics, this text may not be an actual - // keyword, but the canonical form of multiple keywords. - // See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService. - optional string text = 5; - - // The historical metrics for the keyword. - google.ads.googleads.v9.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3; - - // The annotations for the keyword. - // The annotation data is only provided if requested. - google.ads.googleads.v9.common.KeywordAnnotations keyword_annotations = 6; -} diff --git a/google/ads/googleads/v9/services/keyword_view_service.proto b/google/ads/googleads/v9/services/keyword_view_service.proto deleted file mode 100644 index 2fdb8a0d9..000000000 --- a/google/ads/googleads/v9/services/keyword_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/keyword_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "KeywordViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Keyword View service. - -// Service to manage keyword views. -service KeywordViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested keyword view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetKeywordView(GetKeywordViewRequest) returns (google.ads.googleads.v9.resources.KeywordView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/keywordViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [KeywordViewService.GetKeywordView][google.ads.googleads.v9.services.KeywordViewService.GetKeywordView]. -message GetKeywordViewRequest { - // Required. The resource name of the keyword view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/KeywordView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/landing_page_view_service.proto b/google/ads/googleads/v9/services/landing_page_view_service.proto deleted file mode 100644 index 591c8b026..000000000 --- a/google/ads/googleads/v9/services/landing_page_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/landing_page_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "LandingPageViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the landing page view service. - -// Service to fetch landing page views. -service LandingPageViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested landing page view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetLandingPageView(GetLandingPageViewRequest) returns (google.ads.googleads.v9.resources.LandingPageView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/landingPageViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [LandingPageViewService.GetLandingPageView][google.ads.googleads.v9.services.LandingPageViewService.GetLandingPageView]. -message GetLandingPageViewRequest { - // Required. The resource name of the landing page view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/LandingPageView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/language_constant_service.proto b/google/ads/googleads/v9/services/language_constant_service.proto deleted file mode 100644 index 001365eb6..000000000 --- a/google/ads/googleads/v9/services/language_constant_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/language_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "LanguageConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the language constant service. - -// Service to fetch language constants. -service LanguageConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested language constant. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetLanguageConstant(GetLanguageConstantRequest) returns (google.ads.googleads.v9.resources.LanguageConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=languageConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [LanguageConstantService.GetLanguageConstant][google.ads.googleads.v9.services.LanguageConstantService.GetLanguageConstant]. -message GetLanguageConstantRequest { - // Required. Resource name of the language constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/LanguageConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/life_event_service.proto b/google/ads/googleads/v9/services/life_event_service.proto deleted file mode 100644 index e1ce55f87..000000000 --- a/google/ads/googleads/v9/services/life_event_service.proto +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/life_event.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "LifeEventServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the life event service - -// Service to fetch Google Ads Life Events. -service LifeEventService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested life event in full detail. - rpc GetLifeEvent(GetLifeEventRequest) returns (google.ads.googleads.v9.resources.LifeEvent) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/lifeEvents/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [LifeEventService.GetLifeEvent][google.ads.googleads.v9.services.LifeEventService.GetLifeEvent]. -message GetLifeEventRequest { - // Required. Resource name of the LifeEvent to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/LifeEvent" - } - ]; -} diff --git a/google/ads/googleads/v9/services/location_view_service.proto b/google/ads/googleads/v9/services/location_view_service.proto deleted file mode 100644 index 8ff56254d..000000000 --- a/google/ads/googleads/v9/services/location_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/location_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "LocationViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Location View service. - -// Service to fetch location views. -service LocationViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested location view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetLocationView(GetLocationViewRequest) returns (google.ads.googleads.v9.resources.LocationView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/locationViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [LocationViewService.GetLocationView][google.ads.googleads.v9.services.LocationViewService.GetLocationView]. -message GetLocationViewRequest { - // Required. The resource name of the location view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/LocationView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/managed_placement_view_service.proto b/google/ads/googleads/v9/services/managed_placement_view_service.proto deleted file mode 100644 index ea4727d3e..000000000 --- a/google/ads/googleads/v9/services/managed_placement_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/managed_placement_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ManagedPlacementViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Managed Placement View service. - -// Service to manage Managed Placement views. -service ManagedPlacementViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Managed Placement view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetManagedPlacementView(GetManagedPlacementViewRequest) returns (google.ads.googleads.v9.resources.ManagedPlacementView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/managedPlacementViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [ManagedPlacementViewService.GetManagedPlacementView][google.ads.googleads.v9.services.ManagedPlacementViewService.GetManagedPlacementView]. -message GetManagedPlacementViewRequest { - // Required. The resource name of the Managed Placement View to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ManagedPlacementView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/mobile_app_category_constant_service.proto b/google/ads/googleads/v9/services/mobile_app_category_constant_service.proto deleted file mode 100644 index 470f24f1b..000000000 --- a/google/ads/googleads/v9/services/mobile_app_category_constant_service.proto +++ /dev/null @@ -1,66 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/mobile_app_category_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "MobileAppCategoryConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Service to fetch mobile app category constants. -service MobileAppCategoryConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested mobile app category constant. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetMobileAppCategoryConstant(GetMobileAppCategoryConstantRequest) returns (google.ads.googleads.v9.resources.MobileAppCategoryConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=mobileAppCategoryConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [MobileAppCategoryConstantService.GetMobileAppCategoryConstant][google.ads.googleads.v9.services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant]. -message GetMobileAppCategoryConstantRequest { - // Required. Resource name of the mobile app category constant to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/MobileAppCategoryConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/mobile_device_constant_service.proto b/google/ads/googleads/v9/services/mobile_device_constant_service.proto deleted file mode 100644 index 1c9923d03..000000000 --- a/google/ads/googleads/v9/services/mobile_device_constant_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/mobile_device_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "MobileDeviceConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the mobile device constant service. - -// Service to fetch mobile device constants. -service MobileDeviceConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested mobile device constant in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetMobileDeviceConstant(GetMobileDeviceConstantRequest) returns (google.ads.googleads.v9.resources.MobileDeviceConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=mobileDeviceConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [MobileDeviceConstantService.GetMobileDeviceConstant][google.ads.googleads.v9.services.MobileDeviceConstantService.GetMobileDeviceConstant]. -message GetMobileDeviceConstantRequest { - // Required. Resource name of the mobile device to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/MobileDeviceConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/operating_system_version_constant_service.proto b/google/ads/googleads/v9/services/operating_system_version_constant_service.proto deleted file mode 100644 index f17ec617f..000000000 --- a/google/ads/googleads/v9/services/operating_system_version_constant_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/operating_system_version_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "OperatingSystemVersionConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the OS version constant service - -// Service to fetch Operating System Version constants. -service OperatingSystemVersionConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested OS version constant in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetOperatingSystemVersionConstant(GetOperatingSystemVersionConstantRequest) returns (google.ads.googleads.v9.resources.OperatingSystemVersionConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=operatingSystemVersionConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant][google.ads.googleads.v9.services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant]. -message GetOperatingSystemVersionConstantRequest { - // Required. Resource name of the OS version to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/OperatingSystemVersionConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/paid_organic_search_term_view_service.proto b/google/ads/googleads/v9/services/paid_organic_search_term_view_service.proto deleted file mode 100644 index 22445f87f..000000000 --- a/google/ads/googleads/v9/services/paid_organic_search_term_view_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/paid_organic_search_term_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "PaidOrganicSearchTermViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Paid Organic Search Term View service. - -// Service to fetch paid organic search term views. -service PaidOrganicSearchTermViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested paid organic search term view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetPaidOrganicSearchTermView(GetPaidOrganicSearchTermViewRequest) returns (google.ads.googleads.v9.resources.PaidOrganicSearchTermView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/paidOrganicSearchTermViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView][google.ads.googleads.v9.services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView]. -message GetPaidOrganicSearchTermViewRequest { - // Required. The resource name of the paid organic search term view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/PaidOrganicSearchTermView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/parental_status_view_service.proto b/google/ads/googleads/v9/services/parental_status_view_service.proto deleted file mode 100644 index cc42ace46..000000000 --- a/google/ads/googleads/v9/services/parental_status_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/parental_status_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ParentalStatusViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Parental Status View service. - -// Service to manage parental status views. -service ParentalStatusViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested parental status view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetParentalStatusView(GetParentalStatusViewRequest) returns (google.ads.googleads.v9.resources.ParentalStatusView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/parentalStatusViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [ParentalStatusViewService.GetParentalStatusView][google.ads.googleads.v9.services.ParentalStatusViewService.GetParentalStatusView]. -message GetParentalStatusViewRequest { - // Required. The resource name of the parental status view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ParentalStatusView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/product_bidding_category_constant_service.proto b/google/ads/googleads/v9/services/product_bidding_category_constant_service.proto deleted file mode 100644 index 5073bb454..000000000 --- a/google/ads/googleads/v9/services/product_bidding_category_constant_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/product_bidding_category_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ProductBiddingCategoryConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Product Bidding Category constant service - -// Service to fetch Product Bidding Categories. -service ProductBiddingCategoryConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Product Bidding Category in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetProductBiddingCategoryConstant(GetProductBiddingCategoryConstantRequest) returns (google.ads.googleads.v9.resources.ProductBiddingCategoryConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=productBiddingCategoryConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant][google.ads.googleads.v9.services.ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant]. -message GetProductBiddingCategoryConstantRequest { - // Required. Resource name of the Product Bidding Category to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ProductBiddingCategoryConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/product_group_view_service.proto b/google/ads/googleads/v9/services/product_group_view_service.proto deleted file mode 100644 index f6bdf30a9..000000000 --- a/google/ads/googleads/v9/services/product_group_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/product_group_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ProductGroupViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the ProductGroup View service. - -// Service to manage product group views. -service ProductGroupViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested product group view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetProductGroupView(GetProductGroupViewRequest) returns (google.ads.googleads.v9.resources.ProductGroupView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/productGroupViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [ProductGroupViewService.GetProductGroupView][google.ads.googleads.v9.services.ProductGroupViewService.GetProductGroupView]. -message GetProductGroupViewRequest { - // Required. The resource name of the product group view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ProductGroupView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/search_term_view_service.proto b/google/ads/googleads/v9/services/search_term_view_service.proto deleted file mode 100644 index 8c03584ca..000000000 --- a/google/ads/googleads/v9/services/search_term_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/search_term_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "SearchTermViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Search Term View service. - -// Service to manage search term views. -service SearchTermViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the attributes of the requested search term view. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetSearchTermView(GetSearchTermViewRequest) returns (google.ads.googleads.v9.resources.SearchTermView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/searchTermViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [SearchTermViewService.GetSearchTermView][google.ads.googleads.v9.services.SearchTermViewService.GetSearchTermView]. -message GetSearchTermViewRequest { - // Required. The resource name of the search term view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/SearchTermView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/shopping_performance_view_service.proto b/google/ads/googleads/v9/services/shopping_performance_view_service.proto deleted file mode 100644 index c90492e5e..000000000 --- a/google/ads/googleads/v9/services/shopping_performance_view_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/shopping_performance_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "ShoppingPerformanceViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the ShoppingPerformanceView service. - -// Service to fetch Shopping performance views. -service ShoppingPerformanceViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested Shopping performance view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetShoppingPerformanceView(GetShoppingPerformanceViewRequest) returns (google.ads.googleads.v9.resources.ShoppingPerformanceView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/shoppingPerformanceView}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [ShoppingPerformanceViewService.GetShoppingPerformanceView][google.ads.googleads.v9.services.ShoppingPerformanceViewService.GetShoppingPerformanceView]. -message GetShoppingPerformanceViewRequest { - // Required. The resource name of the Shopping performance view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/ShoppingPerformanceView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/smart_campaign_search_term_view_service.proto b/google/ads/googleads/v9/services/smart_campaign_search_term_view_service.proto deleted file mode 100644 index 7799a36af..000000000 --- a/google/ads/googleads/v9/services/smart_campaign_search_term_view_service.proto +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/smart_campaign_search_term_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "SmartCampaignSearchTermViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Smart Campaign Search Term View service. - -// Service to manage Smart campaign search term views. -service SmartCampaignSearchTermViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the attributes of the requested Smart campaign search term view. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetSmartCampaignSearchTermView(GetSmartCampaignSearchTermViewRequest) returns (google.ads.googleads.v9.resources.SmartCampaignSearchTermView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/smartCampaignSearchTermViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for -// [SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView][google.ads.googleads.v9.services.SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView]. -message GetSmartCampaignSearchTermViewRequest { - // Required. The resource name of the Smart campaign search term view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/SmartCampaignSearchTermView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/topic_constant_service.proto b/google/ads/googleads/v9/services/topic_constant_service.proto deleted file mode 100644 index aaa80ec24..000000000 --- a/google/ads/googleads/v9/services/topic_constant_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/topic_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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "TopicConstantServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Topic constant service - -// Service to fetch topic constants. -service TopicConstantService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested topic constant in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetTopicConstant(GetTopicConstantRequest) returns (google.ads.googleads.v9.resources.TopicConstant) { - option (google.api.http) = { - get: "/v9/{resource_name=topicConstants/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [TopicConstantService.GetTopicConstant][google.ads.googleads.v9.services.TopicConstantService.GetTopicConstant]. -message GetTopicConstantRequest { - // Required. Resource name of the Topic to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/TopicConstant" - } - ]; -} diff --git a/google/ads/googleads/v9/services/topic_view_service.proto b/google/ads/googleads/v9/services/topic_view_service.proto deleted file mode 100644 index 0b8b76072..000000000 --- a/google/ads/googleads/v9/services/topic_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/topic_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "TopicViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Topic View service. - -// Service to manage topic views. -service TopicViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested topic view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetTopicView(GetTopicViewRequest) returns (google.ads.googleads.v9.resources.TopicView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/topicViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [TopicViewService.GetTopicView][google.ads.googleads.v9.services.TopicViewService.GetTopicView]. -message GetTopicViewRequest { - // Required. The resource name of the topic view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/TopicView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/user_interest_service.proto b/google/ads/googleads/v9/services/user_interest_service.proto deleted file mode 100644 index e455b9da0..000000000 --- a/google/ads/googleads/v9/services/user_interest_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/user_interest.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "UserInterestServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the user interest service - -// Service to fetch Google Ads User Interest. -service UserInterestService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested user interest in full detail - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetUserInterest(GetUserInterestRequest) returns (google.ads.googleads.v9.resources.UserInterest) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/userInterests/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [UserInterestService.GetUserInterest][google.ads.googleads.v9.services.UserInterestService.GetUserInterest]. -message GetUserInterestRequest { - // Required. Resource name of the UserInterest to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/UserInterest" - } - ]; -} diff --git a/google/ads/googleads/v9/services/user_location_view_service.proto b/google/ads/googleads/v9/services/user_location_view_service.proto deleted file mode 100644 index 808549628..000000000 --- a/google/ads/googleads/v9/services/user_location_view_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/user_location_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "UserLocationViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the UserLocationView service. - -// Service to manage user location views. -service UserLocationViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested user location view in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetUserLocationView(GetUserLocationViewRequest) returns (google.ads.googleads.v9.resources.UserLocationView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/userLocationViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [UserLocationViewService.GetUserLocationView][google.ads.googleads.v9.services.UserLocationViewService.GetUserLocationView]. -message GetUserLocationViewRequest { - // Required. The resource name of the user location view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/UserLocationView" - } - ]; -} diff --git a/google/ads/googleads/v9/services/video_service.proto b/google/ads/googleads/v9/services/video_service.proto deleted file mode 100644 index 49b0a33d4..000000000 --- a/google/ads/googleads/v9/services/video_service.proto +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/video.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "VideoServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Video service. - -// Service to manage videos. -service VideoService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested video in full detail. - // - // List of thrown errors: - // [AuthenticationError]() - // [AuthorizationError]() - // [HeaderError]() - // [InternalError]() - // [QuotaError]() - // [RequestError]() - rpc GetVideo(GetVideoRequest) returns (google.ads.googleads.v9.resources.Video) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/videos/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [VideoService.GetVideo][google.ads.googleads.v9.services.VideoService.GetVideo]. -message GetVideoRequest { - // Required. The resource name of the video to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/Video" - } - ]; -} diff --git a/google/ads/googleads/v9/services/webpage_view_service.proto b/google/ads/googleads/v9/services/webpage_view_service.proto deleted file mode 100644 index a8f6937c6..000000000 --- a/google/ads/googleads/v9/services/webpage_view_service.proto +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2021 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.ads.googleads.v9.services; - -import "google/ads/googleads/v9/resources/webpage_view.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.V9.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v9/services;services"; -option java_multiple_files = true; -option java_outer_classname = "WebpageViewServiceProto"; -option java_package = "com.google.ads.googleads.v9.services"; -option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V9\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V9::Services"; - -// Proto file describing the Webpage View service. - -// Service to manage webpage views. -service WebpageViewService { - option (google.api.default_host) = "googleads.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; - - // Returns the requested webpage view in full detail. - rpc GetWebpageView(GetWebpageViewRequest) returns (google.ads.googleads.v9.resources.WebpageView) { - option (google.api.http) = { - get: "/v9/{resource_name=customers/*/webpageViews/*}" - }; - option (google.api.method_signature) = "resource_name"; - } -} - -// Request message for [WebpageViewService.GetWebpageView][google.ads.googleads.v9.services.WebpageViewService.GetWebpageView]. -message GetWebpageViewRequest { - // Required. The resource name of the webpage view to fetch. - string resource_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "googleads.googleapis.com/WebpageView" - } - ]; -} diff --git a/google/ads/searchads360/v0/BUILD.bazel b/google/ads/searchads360/v0/BUILD.bazel new file mode 100644 index 000000000..d76ae9ede --- /dev/null +++ b/google/ads/searchads360/v0/BUILD.bazel @@ -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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +package(default_visibility = ["//visibility:public"]) + +exports_files(glob(["*.yaml"]) + ["searchads360_grpc_service_config.json"]) + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") +load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") + + +proto_library( + name = "searchads360_proto", + srcs = [], + deps = [ + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/ads/searchads360/v0/common:common_proto", + "//google/ads/searchads360/v0/resources:resources_proto", + "//google/ads/searchads360/v0/services:services_proto", + ], +) + +proto_library_with_info( + name = "searchads360_proto_with_info", + deps = [ + ":searchads360_proto", + ], +) + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", +) + +java_gapic_library( + name = "searchads360_java_gapic", + srcs = [ + ":searchads360_proto_with_info", + ], + grpc_service_config = ":searchads360_grpc_service_config.json", + deps = [ + "//google/ads/searchads360/v0/enums:enums_java_proto", + "//google/ads/searchads360/v0/common:common_java_proto", + "//google/ads/searchads360/v0/resources:resources_java_proto", + "//google/ads/searchads360/v0/services:services_java_proto", + "//google/ads/searchads360/v0/services:services_java_grpc", + ], +) + +java_gapic_test( + name = "searchads360_java_gapic_suite", + test_classes = [ + "com.google.ads.searchads360.v0.services.SearchAds360ServiceClientTest", + ], + runtime_deps = [":searchads360_java_gapic_test"], +) + +java_gapic_assembly_gradle_pkg( + name = "searchads360-java", + deps = [ + ":searchads360_java_gapic", + "//google/ads/searchads360/v0:searchads360_proto", + "//google/ads/searchads360/v0/enums:enums_java_proto", + "//google/ads/searchads360/v0/common:common_java_proto", + "//google/ads/searchads360/v0/resources:resources_java_proto", + "//google/ads/searchads360/v0/services:services_java_proto", + "//google/ads/searchads360/v0/services:services_java_grpc", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", +) + +py_gapic_library( + name = "searchads360_py_gapic", + srcs = [":searchads360_proto_with_info"], + grpc_service_config = "searchads360_grpc_service_config.json", + opt_args = [ + "old-naming", + "lazy-import", + "python-gapic-name=searchads360", + "python-gapic-templates=ads-templates" + ], +) + +py_gapic_assembly_pkg( + name = "searchads360-py", + deps = [ + ":searchads360_py_gapic", + "//google/ads/searchads360/v0:searchads360_proto", + "//google/ads/searchads360/v0/enums:enums_py_proto", + "//google/ads/searchads360/v0/common:common_py_proto", + "//google/ads/searchads360/v0/resources:resources_py_proto", + "//google/ads/searchads360/v0/services:services_py_proto", + "//google/ads/searchads360/v0/services:services_py_grpc", + ], +) \ No newline at end of file diff --git a/google/ads/searchads360/v0/common/BUILD.bazel b/google/ads/searchads360/v0/common/BUILD.bazel new file mode 100644 index 000000000..77782684f --- /dev/null +++ b/google/ads/searchads360/v0/common/BUILD.bazel @@ -0,0 +1,101 @@ +# 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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +package(default_visibility = ["//visibility:public"]) + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") + +proto_library( + name = "common_proto", + srcs = glob(["*.proto"]), + deps = [ + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/api:resource_proto", + "@com_google_protobuf//:wrappers_proto", + ], +) + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_grpc_library", + "java_proto_library", +) + +java_proto_library( + name = "common_java_proto", + deps = [":common_proto"], +) + +java_grpc_library( + name = "common_java_grpc", + srcs = [":common_proto"], + deps = [":common_java_proto"], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +moved_proto_library( + name = "common_moved_proto", + srcs = [":common_proto"], + deps = [ + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/api:resource_proto", + "@com_google_protobuf//:wrappers_proto", + ], +) + +py_proto_library( + name = "common_py_proto", + deps = [":common_moved_proto"], +) + +py_grpc_library( + name = "common_py_grpc", + srcs = [":common_moved_proto"], + deps = [":common_py_proto"], +) + +############################################################################## +# C# +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", +) + +csharp_proto_library( + name = "common_csharp_proto", + deps = [":common_proto"], +) + +csharp_grpc_library( + name = "common_csharp_grpc", + srcs = [":common_proto"], + deps = [":common_csharp_proto"], +) \ No newline at end of file diff --git a/google/ads/searchads360/v0/common/bidding.proto b/google/ads/searchads360/v0/common/bidding.proto new file mode 100644 index 000000000..7135be478 --- /dev/null +++ b/google/ads/searchads360/v0/common/bidding.proto @@ -0,0 +1,203 @@ +// 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.searchads360.v0.common; + +import "google/ads/searchads360/v0/enums/target_impression_share_location.proto"; +import "google/protobuf/wrappers.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "BiddingProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing bidding schemes. + +// 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. +// +// 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 { + // Whether bids are to be enhanced based on conversion optimizer data. + optional bool enhanced_cpc_enabled = 2; +} + +// Manual impression-based bidding where user pays per thousand impressions. +message ManualCpm { + +} + +// An automated bidding strategy to help get the most conversions for your +// campaigns while spending your budget. +message MaximizeConversions { + // 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. + int64 cpc_bid_ceiling_micros = 2; + + // Minimum 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. + 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 +// campaigns while spending your budget. +message MaximizeConversionValue { + // 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. + optional double target_roas = 2; + + // 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. + int64 cpc_bid_ceiling_micros = 3; + + // Minimum 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. + int64 cpc_bid_floor_micros = 4; +} + +// An automated bid strategy that sets bids to help get as many conversions as +// possible at the target cost-per-acquisition (CPA) you set. +message TargetCpa { + // 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 = 4; + + // Maximum bid limit that can be set by the bid strategy. + // The limit applies to all keywords managed by the strategy. + // This should only be set for portfolio bid strategies. + optional int64 cpc_bid_ceiling_micros = 5; + + // Minimum bid limit that can be set by the bid strategy. + // The limit applies to all keywords managed by the strategy. + // This should only be set for portfolio bid strategies. + optional int64 cpc_bid_floor_micros = 6; +} + +// 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 { + +} + +// An automated bidding strategy that sets bids so that a certain percentage of +// search ads are shown at the top of the first page (or other targeted +// location). +message TargetImpressionShare { + // The targeted location on the search results page. + google.ads.searchads360.v0.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1; + + // 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. + // This is a required field entered by the advertiser that sets the ceiling + // and specified in local micros. + optional int64 cpc_bid_ceiling_micros = 5; +} + +// An automated bidding strategy that sets bids based on the target fraction of +// auctions where the advertiser should outrank a specific competitor. +// This strategy is deprecated. +message TargetOutrankShare { + // Maximum bid limit that can be set by the bid strategy. + // The limit applies to all keywords managed by the strategy. + google.protobuf.Int64Value cpc_bid_ceiling_micros = 3; +} + +// An automated bidding strategy that helps you maximize revenue while +// averaging a specific target return on ad spend (ROAS). +message TargetRoas { + // 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; + + // Maximum bid limit that can be set by the bid strategy. + // The limit applies to all keywords managed by the strategy. + // This should only be set for portfolio bid strategies. + optional int64 cpc_bid_ceiling_micros = 5; + + // Minimum bid limit that can be set by the bid strategy. + // The limit applies to all keywords managed by the strategy. + // This should only be set for portfolio bid strategies. + optional int64 cpc_bid_floor_micros = 6; +} + +// An automated bid strategy that sets your bids to help get as many clicks +// as possible within your budget. +message TargetSpend { + // The spend target under which to maximize clicks. + // A TargetSpend bidder will attempt to spend the smaller of this value + // or the natural throttling spend amount. + // If not specified, the budget is used as the spend target. + // 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 = 3 [deprecated = true]; + + // 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 = 4; +} + +// A bidding strategy where bids are a fraction of the advertised price for +// some good or service. +message PercentCpc { + // Maximum bid limit that can be set by the bid strategy. This is + // an optional field entered by the advertiser and specified in local micros. + // Note: A zero value is interpreted in the same way as having bid_ceiling + // undefined. + optional int64 cpc_bid_ceiling_micros = 3; + + // Adjusts the bid for each auction upward or downward, depending on the + // likelihood of a conversion. Individual bids may exceed + // cpc_bid_ceiling_micros, but the average bid amount for a campaign should + // not. + optional bool enhanced_cpc_enabled = 4; +} diff --git a/google/ads/searchads360/v0/common/criteria.proto b/google/ads/searchads360/v0/common/criteria.proto new file mode 100644 index 000000000..1fe597db4 --- /dev/null +++ b/google/ads/searchads360/v0/common/criteria.proto @@ -0,0 +1,143 @@ +// 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.searchads360.v0.common; + +import "google/ads/searchads360/v0/enums/age_range_type.proto"; +import "google/ads/searchads360/v0/enums/device.proto"; +import "google/ads/searchads360/v0/enums/gender_type.proto"; +import "google/ads/searchads360/v0/enums/keyword_match_type.proto"; +import "google/ads/searchads360/v0/enums/listing_group_type.proto"; +import "google/ads/searchads360/v0/enums/location_group_radius_units.proto"; +import "google/ads/searchads360/v0/enums/webpage_condition_operand.proto"; +import "google/ads/searchads360/v0/enums/webpage_condition_operator.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "CriteriaProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing criteria types. + +// A keyword criterion. +message KeywordInfo { + // The text of the keyword (at most 80 characters and 10 words). + optional string text = 3; + + // The match type of the keyword. + google.ads.searchads360.v0.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2; +} + +// A location criterion. +message LocationInfo { + // The geo target constant resource name. + optional string geo_target_constant = 2; +} + +// A device criterion. +message DeviceInfo { + // Type of the device. + google.ads.searchads360.v0.enums.DeviceEnum.Device type = 1; +} + +// A listing group criterion. +message ListingGroupInfo { + // Type of the listing group. + google.ads.searchads360.v0.enums.ListingGroupTypeEnum.ListingGroupType type = 1; +} + +// An age range criterion. +message AgeRangeInfo { + // Type of the age range. + google.ads.searchads360.v0.enums.AgeRangeTypeEnum.AgeRangeType type = 1; +} + +// A gender criterion. +message GenderInfo { + // Type of the gender. + google.ads.searchads360.v0.enums.GenderTypeEnum.GenderType type = 1; +} + +// A language criterion. +message LanguageInfo { + // The language constant resource name. + optional string language_constant = 2; +} + +// Represents a criterion for targeting webpages of an advertiser's website. +message WebpageInfo { + // The name of the criterion that is defined by this parameter. The name value + // will be used for identifying, sorting and filtering criteria with this type + // of parameters. + // + // This field is required for CREATE operations and is prohibited on UPDATE + // operations. + optional string criterion_name = 3; + + // Conditions, or logical expressions, for webpage targeting. The list of + // webpage targeting conditions are and-ed together when evaluated + // 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. + repeated WebpageConditionInfo conditions = 2; + + // Website criteria coverage percentage. This is the computed percentage + // of website coverage based on the website target, negative website target + // and negative keywords in the ad group and campaign. For instance, when + // coverage returns as 1, it indicates it has 100% coverage. This field is + // read-only. + double coverage_percentage = 4; +} + +// Logical expression for targeting webpages of an advertiser's website. +message WebpageConditionInfo { + // Operand of webpage targeting condition. + google.ads.searchads360.v0.enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1; + + // Operator of webpage targeting condition. + google.ads.searchads360.v0.enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2; + + // Argument of webpage targeting condition. + optional string argument = 4; +} + +// A radius around a list of locations specified through a feed. +message LocationGroupInfo { + // Geo target constant(s) restricting the scope of the geographic area within + // the feed. Currently only one geo target constant is allowed. + repeated string geo_target_constants = 6; + + // Distance in units specifying the radius around targeted locations. + // This is required and must be set in CREATE operations. + 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.searchads360.v0.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. + repeated string feed_item_sets = 8; +} diff --git a/google/ads/searchads360/v0/common/custom_parameter.proto b/google/ads/searchads360/v0/common/custom_parameter.proto new file mode 100644 index 000000000..22facac93 --- /dev/null +++ b/google/ads/searchads360/v0/common/custom_parameter.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.ads.searchads360.v0.common; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "CustomParameterProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing CustomParameter and operation + +// A mapping that can be used by custom parameter tags in a +// `tracking_url_template`, `final_urls`, or `mobile_final_urls`. +message CustomParameter { + // The key matching the parameter tag name. + optional string key = 3; + + // The value to be substituted. + optional string value = 4; +} diff --git a/google/ads/searchads360/v0/common/frequency_cap.proto b/google/ads/searchads360/v0/common/frequency_cap.proto new file mode 100644 index 000000000..d8b67bcb9 --- /dev/null +++ b/google/ads/searchads360/v0/common/frequency_cap.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.ads.searchads360.v0.common; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "FrequencyCapProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing frequency caps. + +// A rule specifying the maximum number of times an ad (or some set of ads) can +// be shown to a user over a particular time period. +message FrequencyCapEntry { + +} diff --git a/google/ads/searchads360/v0/common/metrics.proto b/google/ads/searchads360/v0/common/metrics.proto new file mode 100644 index 000000000..ed989da74 --- /dev/null +++ b/google/ads/searchads360/v0/common/metrics.proto @@ -0,0 +1,354 @@ +// 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.searchads360.v0.common; + +import "google/ads/searchads360/v0/enums/interaction_event_type.proto"; +import "google/ads/searchads360/v0/enums/quality_score_bucket.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "MetricsProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing metrics. + +// Metrics data. +message Metrics { + // The percent of your ad impressions that are shown as the very first ad + // above the organic search results. + optional double absolute_top_impression_percentage = 183; + + // All conversions from interactions (as oppose to view through conversions) + // divided by the number of ad interactions. + optional double all_conversions_from_interactions_rate = 191; + + // The value of all conversions. + optional double all_conversions_value = 192; + + // The value of all conversions. When this column is selected with date, the + // values in date column means the conversion date. Details for the + // by_conversion_date columns are available at + // https://support.google.com/sa360/answer/9250611. + double all_conversions_value_by_conversion_date = 240; + + // The total number of conversions. This includes all conversions regardless + // of the value of include_in_conversions_metric. + optional double all_conversions = 193; + + // The total number of conversions. This includes all conversions regardless + // of the value of include_in_conversions_metric. When this column is selected + // with date, the values in date column means the conversion date. Details for + // the by_conversion_date columns are available at + // https://support.google.com/sa360/answer/9250611. + double all_conversions_by_conversion_date = 241; + + // The value of all conversions divided by the total cost of ad interactions + // (such as clicks for text ads or views for video ads). + optional double all_conversions_value_per_cost = 194; + + // 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; + + // The value of all conversions from interactions divided by the total number + // of interactions. + optional double all_conversions_from_interactions_value_per_interaction = 197; + + // 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; + + // 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; + + // The total cost of all clicks divided by the total number of clicks + // received. + optional double average_cpc = 204; + + // Average cost-per-thousand impressions (CPM). + optional double average_cpm = 206; + + // The number of clicks. + optional int64 clicks = 131; + + // The estimated percent of times that your ad was eligible to show + // on the Display Network but didn't because your budget was too low. + // Note: Content budget lost impression share is reported in the range of 0 + // to 0.9. Any value above 0.9 is reported as 0.9001. + optional double content_budget_lost_impression_share = 159; + + // The impressions you've received on the Display Network divided + // by the estimated number of impressions you were eligible to receive. + // Note: Content impression share is reported in the range of 0.1 to 1. Any + // value below 0.1 is reported as 0.0999. + optional double content_impression_share = 160; + + // The estimated percentage of impressions on the Display Network + // that your ads didn't receive due to poor Ad Rank. + // Note: Content rank lost impression share is reported in the range of 0 + // to 0.9. Any value above 0.9 is reported as 0.9001. + optional double content_rank_lost_impression_share = 163; + + // Average biddable conversions (from interaction) per conversion eligible + // interaction. Shows how often, on average, an ad interaction leads to a + // biddable conversion. + optional double conversions_from_interactions_rate = 284; + + // The value of client account conversions. This only + // includes conversion actions which + // include_in_client_account_conversions_metric attribute is set to true. If + // you use conversion-based bidding, your bid strategies will optimize for + // these conversions. + optional double client_account_conversions_value = 165; + + // The sum of biddable conversions value by conversion date. When this + // column is selected with date, the values in date column means the + // conversion date. + double conversions_value_by_conversion_date = 283; + + // The value of biddable conversion divided by the total cost of conversion + // eligible interactions. + optional double conversions_value_per_cost = 288; + + // The value of 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 conversions_from_interactions_value_per_interaction = 167; + + // The number of client account conversions. This only + // includes conversion actions which + // include_in_client_account_conversions_metric attribute is set to true. If + // you use conversion-based bidding, your bid strategies will optimize for + // these conversions. + optional double client_account_conversions = 168; + + // The sum of conversions by conversion date for biddable conversion types. + // Can be fractional due to attribution modeling. When this column is selected + // with date, the values in date column means the conversion date. + double conversions_by_conversion_date = 282; + + // The sum of your cost-per-click (CPC) and cost-per-thousand impressions + // (CPM) costs during this period. + optional int64 cost_micros = 169; + + // The cost of ad interactions divided by all conversions. + optional double cost_per_all_conversions = 170; + + // Average conversion eligible cost per biddable conversion. + optional double cost_per_conversion = 286; + + // The cost of ad interactions divided by current model attributed + // conversions. 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 cost_per_current_model_attributed_conversion = 172; + + // Conversions from when a customer clicks on an ad on one device, + // then converts on a different device or browser. + // Cross-device conversions are already included in all_conversions. + optional double cross_device_conversions = 173; + + // The sum of the value of cross-device conversions. + optional double cross_device_conversions_value = 253; + + // The number of clicks your ad receives (Clicks) divided by the number + // of times your ad is shown (Impressions). + optional double ctr = 174; + + // The number of conversions. 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 conversions = 251; + + // The sum of conversion values for the conversions included in the + // "conversions" field. This metric is useful only if you entered a value for + // your conversion actions. + optional double conversions_value = 252; + + // The creative historical quality score. + google.ads.searchads360.v0.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; + + // The quality of historical landing page experience. + google.ads.searchads360.v0.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.searchads360.v0.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83; + + // Count of how often your ad has appeared on a search results page or + // website on the Google Network. + optional int64 impressions = 221; + + // How often people interact with your ad after it is shown to them. + // This is the number of interactions divided by the number of times your ad + // is shown. + optional double interaction_rate = 222; + + // The number of interactions. + // An interaction is the main user action associated with an ad format-clicks + // for text and shopping ads, views for video ads, and so on. + optional int64 interactions = 223; + + // The types of payable and free interactions. + repeated google.ads.searchads360.v0.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. + optional double invalid_click_rate = 224; + + // Number of clicks Google considers illegitimate and doesn't charge you for. + optional int64 invalid_clicks = 225; + + // The percentage of mobile clicks that go to a mobile-friendly page. + optional double mobile_friendly_clicks_percentage = 229; + + // The percentage of the customer's Shopping or Search ad impressions that are + // shown in the most prominent Shopping position. See + // https://support.google.com/sa360/answer/9566729 + // for details. Any value below 0.1 is reported as 0.0999. + optional double search_absolute_top_impression_share = 136; + + // The number estimating how often your ad wasn't the very first ad above the + // organic search results due to a low budget. Note: Search + // budget lost absolute top impression share is reported in the range of 0 to + // 0.9. Any value above 0.9 is reported as 0.9001. + optional double search_budget_lost_absolute_top_impression_share = 137; + + // The estimated percent of times that your ad was eligible to show on the + // Search Network but didn't because your budget was too low. Note: Search + // budget lost impression share is reported in the range of 0 to 0.9. Any + // value above 0.9 is reported as 0.9001. + optional double search_budget_lost_impression_share = 138; + + // The number estimating how often your ad didn't show anywhere above the + // organic search results due to a low budget. Note: Search + // budget lost top impression share is reported in the range of 0 to 0.9. Any + // value above 0.9 is reported as 0.9001. + optional double search_budget_lost_top_impression_share = 139; + + // The number of clicks you've received on the Search Network + // divided by the estimated number of clicks you were eligible to receive. + // Note: Search click share is reported in the range of 0.1 to 1. Any value + // below 0.1 is reported as 0.0999. + optional double search_click_share = 140; + + // The impressions you've received divided by the estimated number of + // impressions you were eligible to receive on the Search Network for search + // terms that matched your keywords exactly (or were close variants of your + // keyword), regardless of your keyword match types. Note: Search exact match + // impression share is reported in the range of 0.1 to 1. Any value below 0.1 + // is reported as 0.0999. + optional double search_exact_match_impression_share = 141; + + // The impressions you've received on the Search Network divided + // by the estimated number of impressions you were eligible to receive. + // Note: Search impression share is reported in the range of 0.1 to 1. Any + // value below 0.1 is reported as 0.0999. + optional double search_impression_share = 142; + + // The number estimating how often your ad wasn't the very first ad above the + // organic search results due to poor Ad Rank. + // Note: Search rank lost absolute top impression share is reported in the + // range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. + optional double search_rank_lost_absolute_top_impression_share = 143; + + // The estimated percentage of impressions on the Search Network + // that your ads didn't receive due to poor Ad Rank. + // Note: Search rank lost impression share is reported in the range of 0 to + // 0.9. Any value above 0.9 is reported as 0.9001. + optional double search_rank_lost_impression_share = 144; + + // The number estimating how often your ad didn't show anywhere above the + // organic search results due to poor Ad Rank. + // Note: Search rank lost top impression share is reported in the range of 0 + // to 0.9. Any value above 0.9 is reported as 0.9001. + optional double search_rank_lost_top_impression_share = 145; + + // The impressions you've received in the top location (anywhere above the + // organic search results) compared to the estimated number of impressions you + // were eligible to receive in the top location. + // Note: Search top impression share is reported in the range of 0.1 to 1. Any + // value below 0.1 is reported as 0.0999. + optional double search_top_impression_share = 146; + + // The percent of your ad impressions that are shown anywhere above the + // organic search results. + optional double top_impression_percentage = 148; + + // The value of all conversions divided by the number of all conversions. + optional double value_per_all_conversions = 150; + + // The value of all conversions divided by the number of all conversions. When + // this column is selected with date, the values in date column means the + // conversion date. Details for the by_conversion_date columns are available + // at https://support.google.com/sa360/answer/9250611. + optional double value_per_all_conversions_by_conversion_date = 244; + + // The value of biddable conversion divided by the number of biddable + // conversions. Shows how much, on average, each of the biddable conversions + // is worth. + optional double value_per_conversion = 287; + + // Biddable conversions value by conversion date divided by biddable + // conversions by conversion date. Shows how much, on average, each of the + // biddable conversions is worth (by conversion date). When this column is + // selected with date, the values in date column means the conversion date. + optional double value_per_conversions_by_conversion_date = 285; + + // 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 (for example, + // clicking on) another ad. + optional int64 client_account_view_through_conversions = 155; +} diff --git a/google/ads/searchads360/v0/common/real_time_bidding_setting.proto b/google/ads/searchads360/v0/common/real_time_bidding_setting.proto new file mode 100644 index 000000000..a3de35e95 --- /dev/null +++ b/google/ads/searchads360/v0/common/real_time_bidding_setting.proto @@ -0,0 +1,35 @@ +// 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.searchads360.v0.common; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "RealTimeBiddingSettingProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing RealTimeBiddingSetting + +// Settings for Real-Time Bidding, a feature only available for campaigns +// targeting the Ad Exchange network. +message RealTimeBiddingSetting { + // Whether the campaign is opted in to real-time bidding. + optional bool opt_in = 2; +} diff --git a/google/ads/searchads360/v0/common/segments.proto b/google/ads/searchads360/v0/common/segments.proto new file mode 100644 index 000000000..a1286f984 --- /dev/null +++ b/google/ads/searchads360/v0/common/segments.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.searchads360.v0.common; + +import "google/ads/searchads360/v0/enums/conversion_action_category.proto"; +import "google/ads/searchads360/v0/enums/day_of_week.proto"; +import "google/ads/searchads360/v0/enums/device.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "SegmentsProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing segment only fields. + +// Segment only fields. +message Segments { + // Resource name of the conversion action. + optional string conversion_action = 146 [(google.api.resource_reference) = { + type: "searchads360.googleapis.com/ConversionAction" + }]; + + // Conversion action category. + google.ads.searchads360.v0.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_category = 53; + + // Conversion action name. + optional string conversion_action_name = 114; + + // Date to which metrics apply. + // yyyy-MM-dd format, for example, 2018-04-17. + optional string date = 79; + + // Day of the week, for example, MONDAY. + google.ads.searchads360.v0.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5; + + // Device to which metrics apply. + google.ads.searchads360.v0.enums.DeviceEnum.Device device = 1; + + // Month as represented by the date of the first day of a month. Formatted as + // yyyy-MM-dd. + optional string month = 90; + + // Quarter as represented by the date of the first day of a quarter. + // 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; + + // Week as defined as Monday through Sunday, and represented by the date of + // Monday. Formatted as yyyy-MM-dd. + optional string week = 130; + + // Year, formatted as yyyy. + optional int32 year = 131; +} diff --git a/google/ads/searchads360/v0/common/value.proto b/google/ads/searchads360/v0/common/value.proto new file mode 100644 index 000000000..8ccf32a00 --- /dev/null +++ b/google/ads/searchads360/v0/common/value.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.searchads360.v0.common; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Common"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/common;common"; +option java_multiple_files = true; +option java_outer_classname = "ValueProto"; +option java_package = "com.google.ads.searchads360.v0.common"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Common"; +option ruby_package = "Google::Ads::SearchAds360::V0::Common"; + +// Proto file describing value types. + +// A generic data container. +message Value { + // A value. + oneof value { + // A boolean. + bool boolean_value = 1; + + // An int64. + int64 int64_value = 2; + + // A float. + float float_value = 3; + + // A double. + double double_value = 4; + + // A string. + string string_value = 5; + } +} diff --git a/google/ads/searchads360/v0/enums/BUILD.bazel b/google/ads/searchads360/v0/enums/BUILD.bazel new file mode 100644 index 000000000..805908854 --- /dev/null +++ b/google/ads/searchads360/v0/enums/BUILD.bazel @@ -0,0 +1,95 @@ +# 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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +package(default_visibility = ["//visibility:public"]) + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") + +proto_library( + name = "enums_proto", + srcs = glob(["*.proto"]), + deps = [ + ], +) + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_grpc_library", + "java_proto_library", +) + +java_proto_library( + name = "enums_java_proto", + deps = [":enums_proto"], +) + +java_grpc_library( + name = "enums_java_grpc", + srcs = [":enums_proto"], + deps = [":enums_java_proto"], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +moved_proto_library( + name = "enums_moved_proto", + srcs = [":enums_proto"], + deps = [ + ], +) + +py_proto_library( + name = "enums_py_proto", + deps = [":enums_moved_proto"], +) + +py_grpc_library( + name = "enums_py_grpc", + srcs = [":enums_moved_proto"], + deps = [":enums_py_proto"], +) + +############################################################################## +# C# +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", +) + +csharp_proto_library( + name = "enums_csharp_proto", + deps = [":enums_proto"], +) + +csharp_grpc_library( + name = "enums_csharp_grpc", + srcs = [":enums_proto"], + deps = [":enums_csharp_proto"], +) \ No newline at end of file diff --git a/google/ads/searchads360/v0/enums/account_status.proto b/google/ads/searchads360/v0/enums/account_status.proto new file mode 100644 index 000000000..9008097eb --- /dev/null +++ b/google/ads/searchads360/v0/enums/account_status.proto @@ -0,0 +1,57 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AccountStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing account status. + +// Container for enum describing possible statuses of an account. +message AccountStatusEnum { + // Possible statuses of an account. + enum AccountStatus { + // Default value. + UNSPECIFIED = 0; + + // Unknown value. + UNKNOWN = 1; + + // Account is able to serve ads. + ENABLED = 2; + + // Account is deactivated by the user. + PAUSED = 3; + + // Account is deactivated by an internal process. + SUSPENDED = 4; + + // Account is irrevocably deactivated. + REMOVED = 5; + + // Account is still in the process of setup, not ENABLED yet. + DRAFT = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/account_type.proto b/google/ads/searchads360/v0/enums/account_type.proto new file mode 100644 index 000000000..4f43a65eb --- /dev/null +++ b/google/ads/searchads360/v0/enums/account_type.proto @@ -0,0 +1,66 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AccountTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing engine account types. + +// Container for enum describing engine account types. +message AccountTypeEnum { + // Possible engine account types. + enum AccountType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Baidu account. + BAIDU = 2; + + // Engine track account. + ENGINE_TRACK = 3; + + // Facebook account. + FACEBOOK = 4; + + // Facebook account managed through gateway. + FACEBOOK_GATEWAY = 5; + + // Google Ads account. + GOOGLE_ADS = 6; + + // Microsoft Advertising account. + MICROSOFT = 7; + + // Search Ads 360 manager account. + SEARCH_ADS_360 = 8; + + // Yahoo Japan account. + YAHOO_JAPAN = 9; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto b/google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto new file mode 100644 index 000000000..43c96c70f --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupAdRotationModeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing ad group ad rotation mode. + +// Container for enum describing possible ad rotation modes of ads within an +// ad group. +message AdGroupAdRotationModeEnum { + // The possible ad rotation modes of an ad group. + enum AdGroupAdRotationMode { + // The ad rotation mode has not been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // Optimize ad group ads based on clicks or conversions. + OPTIMIZE = 2; + + // Rotate evenly forever. + ROTATE_FOREVER = 3; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_group_criterion_engine_status.proto b/google/ads/searchads360/v0/enums/ad_group_criterion_engine_status.proto new file mode 100644 index 000000000..d85dfa2e0 --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_group_criterion_engine_status.proto @@ -0,0 +1,104 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupCriterionEngineStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing engine status for the ad_group_criterion. + +// Container for enum describing possible AdGroupCriterion engine statuses. +message AdGroupCriterionEngineStatusEnum { + // Enumerates AdGroupCriterion engine statuses. + enum AdGroupCriterionEngineStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Deprecated. Do not use. + AD_GROUP_CRITERION_ELIGIBLE = 2 [deprecated = true]; + + // Baidu: Bid or quality too low to be displayed. + AD_GROUP_CRITERION_INAPPROPRIATE_FOR_CAMPAIGN = 3; + + // Baidu: Bid or quality too low for mobile, but eligible to display for + // desktop. + AD_GROUP_CRITERION_INVALID_MOBILE_SEARCH = 4; + + // Baidu: Bid or quality too low for desktop, but eligible to display for + // mobile. + AD_GROUP_CRITERION_INVALID_PC_SEARCH = 5; + + // Baidu: Bid or quality too low to be displayed. + AD_GROUP_CRITERION_INVALID_SEARCH = 6; + + // Baidu: Paused by Baidu due to low search volume. + AD_GROUP_CRITERION_LOW_SEARCH_VOLUME = 7; + + // Baidu: Mobile URL in process to be reviewed. + AD_GROUP_CRITERION_MOBILE_URL_UNDER_REVIEW = 8; + + // Baidu: The landing page for one device is invalid, while the landing + // page for the other device is valid. + AD_GROUP_CRITERION_PARTIALLY_INVALID = 9; + + // Baidu: Keyword has been created and paused by Baidu account management, + // and is now ready for you to activate it. + AD_GROUP_CRITERION_TO_BE_ACTIVATED = 10; + + // Baidu: In process to be reviewed by Baidu. Gemini: Criterion under + // review. + AD_GROUP_CRITERION_UNDER_REVIEW = 11; + + // Baidu: Criterion to be reviewed. + AD_GROUP_CRITERION_NOT_REVIEWED = 12; + + // Deprecated. Do not use. Previously used by Gemini + AD_GROUP_CRITERION_ON_HOLD = 13 [deprecated = true]; + + // Y!J : Criterion pending review + AD_GROUP_CRITERION_PENDING_REVIEW = 14; + + // Criterion has been paused. + AD_GROUP_CRITERION_PAUSED = 15; + + // Criterion has been removed. + AD_GROUP_CRITERION_REMOVED = 16; + + // Criterion has been approved. + AD_GROUP_CRITERION_APPROVED = 17; + + // Criterion has been disapproved. + AD_GROUP_CRITERION_DISAPPROVED = 18; + + // Criterion is active and serving. + AD_GROUP_CRITERION_SERVING = 19; + + // Criterion has been paused since the account is paused. + AD_GROUP_CRITERION_ACCOUNT_PAUSED = 20; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_group_criterion_status.proto b/google/ads/searchads360/v0/enums/ad_group_criterion_status.proto new file mode 100644 index 000000000..c0ecc98fd --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_group_criterion_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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupCriterionStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing AdGroupCriterion statuses. + +// Message describing AdGroupCriterion statuses. +message AdGroupCriterionStatusEnum { + // The possible statuses of an AdGroupCriterion. + enum AdGroupCriterionStatus { + // No value has been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // The ad group criterion is enabled. + ENABLED = 2; + + // The ad group criterion is paused. + PAUSED = 3; + + // The ad group criterion is removed. + REMOVED = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_group_status.proto b/google/ads/searchads360/v0/enums/ad_group_status.proto new file mode 100644 index 000000000..4784bc42d --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_group_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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing ad group status. + +// Container for enum describing possible statuses of an ad group. +message AdGroupStatusEnum { + // The possible statuses of an ad group. + enum AdGroupStatus { + // 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 ad group is enabled. + ENABLED = 2; + + // The ad group is paused. + PAUSED = 3; + + // The ad group is removed. + REMOVED = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_group_type.proto b/google/ads/searchads360/v0/enums/ad_group_type.proto new file mode 100644 index 000000000..22c672d2c --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_group_type.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing ad group types. + +// Defines types of an ad group, specific to a particular campaign channel +// type. This type drives validations that restrict which entities can be +// added to the ad group. +message AdGroupTypeEnum { + // Enum listing the possible types of an ad group. + enum AdGroupType { + // The type has not been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // The default ad group type for Search campaigns. + SEARCH_STANDARD = 2; + + // The default ad group type for Display campaigns. + DISPLAY_STANDARD = 3; + + // The ad group type for Shopping campaigns serving standard product ads. + SHOPPING_PRODUCT_ADS = 4; + + // The type for ad groups that are limited to serving Showcase or Merchant + // ads in Shopping results. + SHOPPING_SHOWCASE_ADS = 5; + + // The default ad group type for Hotel campaigns. + HOTEL_ADS = 6; + + // The type for ad groups in Smart Shopping campaigns. + SHOPPING_SMART_ADS = 7; + + // Short unskippable in-stream video ads. + VIDEO_BUMPER = 8; + + // TrueView (skippable) in-stream video ads. + VIDEO_TRUE_VIEW_IN_STREAM = 9; + + // TrueView in-display video ads. + VIDEO_TRUE_VIEW_IN_DISPLAY = 10; + + // Unskippable in-stream video ads. + VIDEO_NON_SKIPPABLE_IN_STREAM = 11; + + // Outstream video ads. + VIDEO_OUTSTREAM = 12; + + // Ad group type for Dynamic Search Ads ad groups. + SEARCH_DYNAMIC_ADS = 13; + + // The type for ad groups in Shopping Comparison Listing campaigns. + SHOPPING_COMPARISON_LISTING_ADS = 14; + + // The ad group type for Promoted Hotel ad groups. + PROMOTED_HOTEL_ADS = 15; + + // Video responsive ad groups. + VIDEO_RESPONSIVE = 16; + + // Video efficient reach ad groups. + VIDEO_EFFICIENT_REACH = 17; + + // Ad group type for Smart campaigns. + SMART_CAMPAIGN_ADS = 18; + } + + +} diff --git a/google/ads/searchads360/v0/enums/ad_serving_optimization_status.proto b/google/ads/searchads360/v0/enums/ad_serving_optimization_status.proto new file mode 100644 index 000000000..4e665794f --- /dev/null +++ b/google/ads/searchads360/v0/enums/ad_serving_optimization_status.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdServingOptimizationStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing ad serving statuses. + +// Possible ad serving statuses of a campaign. +message AdServingOptimizationStatusEnum { + // Enum describing possible serving statuses. + enum AdServingOptimizationStatus { + // No value has been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // Ad serving is optimized based on CTR for the campaign. + OPTIMIZE = 2; + + // Ad serving is optimized based on CTR * Conversion for the campaign. If + // the campaign is not in the conversion optimizer bidding strategy, it will + // default to OPTIMIZED. + CONVERSION_OPTIMIZE = 3; + + // Ads are rotated evenly for 90 days, then optimized for clicks. + ROTATE = 4; + + // Show lower performing ads more evenly with higher performing ads, and do + // not optimize. + ROTATE_INDEFINITELY = 5; + + // Ad serving optimization status is not available. + UNAVAILABLE = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/advertising_channel_sub_type.proto b/google/ads/searchads360/v0/enums/advertising_channel_sub_type.proto new file mode 100644 index 000000000..ff051173c --- /dev/null +++ b/google/ads/searchads360/v0/enums/advertising_channel_sub_type.proto @@ -0,0 +1,99 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdvertisingChannelSubTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing advertising channel subtypes. + +// An immutable specialization of an Advertising Channel. +message AdvertisingChannelSubTypeEnum { + // Enum describing the different channel subtypes. + enum AdvertisingChannelSubType { + // Not specified. + UNSPECIFIED = 0; + + // Used as a return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Mobile app campaigns for Search. + SEARCH_MOBILE_APP = 2; + + // Mobile app campaigns for Display. + DISPLAY_MOBILE_APP = 3; + + // AdWords express campaigns for search. + SEARCH_EXPRESS = 4; + + // AdWords Express campaigns for display. + DISPLAY_EXPRESS = 5; + + // Smart Shopping campaigns. + SHOPPING_SMART_ADS = 6; + + // Gmail Ad campaigns. + DISPLAY_GMAIL_AD = 7; + + // Smart display campaigns. + DISPLAY_SMART_CAMPAIGN = 8; + + // Video Outstream campaigns. + VIDEO_OUTSTREAM = 9; + + // Video TrueView for Action campaigns. + VIDEO_ACTION = 10; + + // Video campaigns with non-skippable video ads. + VIDEO_NON_SKIPPABLE = 11; + + // 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; + + // App Campaign for engagement, focused on driving re-engagement with the + // app across several of Google's top properties including Search, YouTube, + // and the Google Display Network. + APP_CAMPAIGN_FOR_ENGAGEMENT = 13; + + // Campaigns specialized for local advertising. + LOCAL_CAMPAIGN = 14; + + // Shopping Comparison Listing campaigns. + SHOPPING_COMPARISON_LISTING_ADS = 15; + + // Standard Smart campaigns. + SMART_CAMPAIGN = 16; + + // Video campaigns with sequence video ads. + VIDEO_SEQUENCE = 17; + + // App Campaign for pre registration, specialized for advertising mobile + // app pre-registration, that targets multiple advertising channels across + // Google Play, YouTube and Display Network. + APP_CAMPAIGN_FOR_PRE_REGISTRATION = 18; + } + + +} diff --git a/google/ads/searchads360/v0/enums/advertising_channel_type.proto b/google/ads/searchads360/v0/enums/advertising_channel_type.proto new file mode 100644 index 000000000..4b5972b4a --- /dev/null +++ b/google/ads/searchads360/v0/enums/advertising_channel_type.proto @@ -0,0 +1,77 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AdvertisingChannelTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing advertising channel types + +// The channel type a campaign may target to serve on. +message AdvertisingChannelTypeEnum { + // Enum describing the various advertising channel types. + enum AdvertisingChannelType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Search Network. Includes display bundled, and Search+ campaigns. + SEARCH = 2; + + // Google Display Network only. + DISPLAY = 3; + + // Shopping campaigns serve on the shopping property + // and on google.com search results. + SHOPPING = 4; + + // Hotel Ads campaigns. + HOTEL = 5; + + // Video campaigns. + VIDEO = 6; + + // App Campaigns, and App Campaigns for Engagement, that run + // across multiple channels. + MULTI_CHANNEL = 7; + + // Local ads campaigns. + LOCAL = 8; + + // Smart campaigns. + SMART = 9; + + // Performance Max campaigns. + PERFORMANCE_MAX = 10; + + // Local services campaigns. + LOCAL_SERVICES = 11; + + // Discovery campaigns. + DISCOVERY = 12; + } + + +} diff --git a/google/ads/searchads360/v0/enums/age_range_type.proto b/google/ads/searchads360/v0/enums/age_range_type.proto new file mode 100644 index 000000000..e801b31ed --- /dev/null +++ b/google/ads/searchads360/v0/enums/age_range_type.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AgeRangeTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::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 (for example, between 18 and 24 years + // old). + enum AgeRangeType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Between 18 and 24 years old. + AGE_RANGE_18_24 = 503001; + + // Between 25 and 34 years old. + AGE_RANGE_25_34 = 503002; + + // Between 35 and 44 years old. + AGE_RANGE_35_44 = 503003; + + // Between 45 and 54 years old. + AGE_RANGE_45_54 = 503004; + + // Between 55 and 64 years old. + AGE_RANGE_55_64 = 503005; + + // 65 years old and beyond. + AGE_RANGE_65_UP = 503006; + + // Undetermined age range. + AGE_RANGE_UNDETERMINED = 503999; + } + + +} diff --git a/google/ads/searchads360/v0/enums/asset_field_type.proto b/google/ads/searchads360/v0/enums/asset_field_type.proto new file mode 100644 index 000000000..71de45776 --- /dev/null +++ b/google/ads/searchads360/v0/enums/asset_field_type.proto @@ -0,0 +1,118 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AssetFieldTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing asset type. + +// Container for enum describing the possible placements of an asset. +message AssetFieldTypeEnum { + // Enum describing the possible placements of an asset. + enum AssetFieldType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The asset is linked for use as a headline. + HEADLINE = 2; + + // The asset is linked for use as a description. + DESCRIPTION = 3; + + // The asset is linked for use as mandatory ad text. + MANDATORY_AD_TEXT = 4; + + // The asset is linked for use as a marketing image. + MARKETING_IMAGE = 5; + + // The asset is linked for use as a media bundle. + MEDIA_BUNDLE = 6; + + // The asset is linked for use as a YouTube video. + YOUTUBE_VIDEO = 7; + + // The asset is linked to indicate that a hotels campaign is "Book on + // Google" enabled. + BOOK_ON_GOOGLE = 8; + + // The asset is linked for use as a Lead Form extension. + LEAD_FORM = 9; + + // The asset is linked for use as a Promotion extension. + PROMOTION = 10; + + // The asset is linked for use as a Callout extension. + CALLOUT = 11; + + // The asset is linked for use as a Structured Snippet extension. + STRUCTURED_SNIPPET = 12; + + // The asset is linked for use as a Sitelink extension. + SITELINK = 13; + + // The asset is linked for use as a Mobile App extension. + MOBILE_APP = 14; + + // The asset is linked for use as a Hotel Callout extension. + HOTEL_CALLOUT = 15; + + // The asset is linked for use as a Call extension. + CALL = 16; + + // The asset is linked for use as a Price extension. + PRICE = 24; + + // The asset is linked for use as a long headline. + LONG_HEADLINE = 17; + + // The asset is linked for use as a business name. + BUSINESS_NAME = 18; + + // The asset is linked for use as a square marketing image. + SQUARE_MARKETING_IMAGE = 19; + + // The asset is linked for use as a portrait marketing image. + PORTRAIT_MARKETING_IMAGE = 20; + + // The asset is linked for use as a logo. + LOGO = 21; + + // The asset is linked for use as a landscape logo. + LANDSCAPE_LOGO = 22; + + // The asset is linked for use as a non YouTube logo. + VIDEO = 23; + + // 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; + } + + +} diff --git a/google/ads/searchads360/v0/enums/attribution_model.proto b/google/ads/searchads360/v0/enums/attribution_model.proto new file mode 100644 index 000000000..0e37d3941 --- /dev/null +++ b/google/ads/searchads360/v0/enums/attribution_model.proto @@ -0,0 +1,70 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "AttributionModelProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Container for enum representing the attribution model that describes how to +// distribute credit for a particular conversion across potentially many prior +// interactions. +message AttributionModelEnum { + // The attribution model that describes how to distribute credit for a + // particular conversion across potentially many prior interactions. + enum AttributionModel { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Uses external attribution. + EXTERNAL = 100; + + // Attributes all credit for a conversion to its last click. + GOOGLE_ADS_LAST_CLICK = 101; + + // Attributes all credit for a conversion to its first click using Google + // Search attribution. + GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK = 102; + + // Attributes credit for a conversion equally across all of its clicks using + // Google Search attribution. + GOOGLE_SEARCH_ATTRIBUTION_LINEAR = 103; + + // Attributes exponentially more credit for a conversion to its more recent + // clicks using Google Search attribution (half-life is 1 week). + GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY = 104; + + // Attributes 40% of the credit for a conversion to its first and last + // clicks. Remaining 20% is evenly distributed across all other clicks. This + // uses Google Search attribution. + GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED = 105; + + // Flexible model that uses machine learning to determine the appropriate + // distribution of credit among clicks using Google Search attribution. + GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN = 106; + } + + +} diff --git a/google/ads/searchads360/v0/enums/bidding_strategy_status.proto b/google/ads/searchads360/v0/enums/bidding_strategy_status.proto new file mode 100644 index 000000000..ef941e5f6 --- /dev/null +++ b/google/ads/searchads360/v0/enums/bidding_strategy_status.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BiddingStrategyStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing BiddingStrategy statuses. + +// Message describing BiddingStrategy statuses. +message BiddingStrategyStatusEnum { + // The possible statuses of a BiddingStrategy. + enum BiddingStrategyStatus { + // No value has been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // The bidding strategy is enabled. + ENABLED = 2; + + // The bidding strategy is removed. + REMOVED = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/bidding_strategy_system_status.proto b/google/ads/searchads360/v0/enums/bidding_strategy_system_status.proto new file mode 100644 index 000000000..656e6cfa8 --- /dev/null +++ b/google/ads/searchads360/v0/enums/bidding_strategy_system_status.proto @@ -0,0 +1,139 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BiddingStrategySystemStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::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/google/ads/searchads360/v0/enums/bidding_strategy_type.proto b/google/ads/searchads360/v0/enums/bidding_strategy_type.proto new file mode 100644 index 000000000..dab1802ca --- /dev/null +++ b/google/ads/searchads360/v0/enums/bidding_strategy_type.proto @@ -0,0 +1,121 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BiddingStrategyTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing bidding schemes. + +// Container for enum describing possible bidding strategy types. +message BiddingStrategyTypeEnum { + // Enum describing possible bidding strategy types. + enum BiddingStrategyType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Commission is an automatic bidding strategy in which the advertiser pays + // a certain portion of the conversion value. + COMMISSION = 16; + + // Enhanced CPC is 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. + ENHANCED_CPC = 2; + + // Used for return value only. Indicates that a campaign does not have a + // bidding strategy. This prevents the campaign from serving. For example, + // a campaign may be attached to a manager bidding strategy and the serving + // account is subsequently unlinked from the manager account. In this case + // the campaign will automatically be detached from the now inaccessible + // manager bidding strategy and transition to the INVALID bidding strategy + // 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; + + // Manual impression based bidding + // where user pays per thousand impressions. + MANUAL_CPM = 4; + + // A bidding strategy that pays a configurable amount per video view. + MANUAL_CPV = 13; + + // A bidding strategy that automatically maximizes number of conversions + // given a daily budget. + MAXIMIZE_CONVERSIONS = 10; + + // An automated bidding strategy that automatically sets bids to maximize + // revenue while spending your budget. + MAXIMIZE_CONVERSION_VALUE = 11; + + // Page-One Promoted bidding scheme, which sets max cpc bids to + // target impressions on page one or page one promoted slots on google.com. + // This enum value is deprecated. + PAGE_ONE_PROMOTED = 5; + + // Percent Cpc is bidding strategy where bids are a fraction of the + // advertised price for some good or service. + PERCENT_CPC = 12; + + // Target CPA is an automated bid strategy that sets bids + // to help get as many conversions as possible + // at the target cost-per-acquisition (CPA) you set. + TARGET_CPA = 6; + + // Target CPM is an automated bid strategy that sets bids to help get + // as many impressions as possible at the target cost per one thousand + // impressions (CPM) you set. + TARGET_CPM = 14; + + // An automated bidding strategy that sets bids so that a certain percentage + // of search ads are shown at the top of the first page (or other targeted + // location). + TARGET_IMPRESSION_SHARE = 15; + + // Target Outrank Share is an automated bidding strategy that sets bids + // based on the target fraction of auctions where the advertiser + // should outrank a specific competitor. + // This enum value is deprecated. + TARGET_OUTRANK_SHARE = 7; + + // Target ROAS is an automated bidding strategy + // that helps you maximize revenue while averaging + // a specific target Return On Average Spend (ROAS). + TARGET_ROAS = 8; + + // Target Spend is an automated bid strategy that sets your bids + // to help get as many clicks as possible within your budget. + TARGET_SPEND = 9; + } + + +} diff --git a/google/ads/searchads360/v0/enums/budget_delivery_method.proto b/google/ads/searchads360/v0/enums/budget_delivery_method.proto new file mode 100644 index 000000000..32683f1d6 --- /dev/null +++ b/google/ads/searchads360/v0/enums/budget_delivery_method.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BudgetDeliveryMethodProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing Budget delivery methods. + +// Message describing Budget delivery methods. A delivery method determines the +// rate at which the Budget is spent. +message BudgetDeliveryMethodEnum { + // Possible delivery methods of a Budget. + enum BudgetDeliveryMethod { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The budget server will throttle serving evenly across + // the entire time period. + STANDARD = 2; + + // The budget server will not throttle serving, + // and ads will serve as fast as possible. + ACCELERATED = 3; + } + + +} diff --git a/google/ads/searchads360/v0/enums/budget_period.proto b/google/ads/searchads360/v0/enums/budget_period.proto new file mode 100644 index 000000000..2503350dc --- /dev/null +++ b/google/ads/searchads360/v0/enums/budget_period.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BudgetPeriodProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing Budget delivery methods. + +// Message describing Budget period. +message BudgetPeriodEnum { + // Possible period of a Budget. + enum BudgetPeriod { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Daily budget. + DAILY = 2; + + // Fixed daily budget. + FIXED_DAILY = 4; + + // Custom budget, added back in V5. + // Custom bugdet can be used with total_amount to specify lifetime budget + // limit. + CUSTOM_PERIOD = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/campaign_serving_status.proto b/google/ads/searchads360/v0/enums/campaign_serving_status.proto new file mode 100644 index 000000000..cfe38040c --- /dev/null +++ b/google/ads/searchads360/v0/enums/campaign_serving_status.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CampaignServingStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing Campaign serving statuses. + +// Message describing Campaign serving statuses. +message CampaignServingStatusEnum { + // Possible serving statuses of a campaign. + enum CampaignServingStatus { + // No value has been specified. + UNSPECIFIED = 0; + + // The received value is not known in this version. + // + // This is a response-only value. + UNKNOWN = 1; + + // Serving. + SERVING = 2; + + // None. + NONE = 3; + + // Ended. + ENDED = 4; + + // Pending. + PENDING = 5; + + // Suspended. + SUSPENDED = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/campaign_status.proto b/google/ads/searchads360/v0/enums/campaign_status.proto new file mode 100644 index 000000000..7eb39a878 --- /dev/null +++ b/google/ads/searchads360/v0/enums/campaign_status.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CampaignStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing campaign status. + +// Container for enum describing possible statuses of a campaign. +message CampaignStatusEnum { + // Possible statuses of a campaign. + enum CampaignStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Campaign is active and can show ads. + ENABLED = 2; + + // Campaign has been paused by the user. + PAUSED = 3; + + // Campaign has been removed. + REMOVED = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/conversion_action_category.proto b/google/ads/searchads360/v0/enums/conversion_action_category.proto new file mode 100644 index 000000000..5d79a166d --- /dev/null +++ b/google/ads/searchads360/v0/enums/conversion_action_category.proto @@ -0,0 +1,117 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionActionCategoryProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Container for enum describing the category of conversions that are associated +// with a ConversionAction. +message ConversionActionCategoryEnum { + // The category of conversions that are associated with a ConversionAction. + enum ConversionActionCategory { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Default category. + DEFAULT = 2; + + // User visiting a page. + PAGE_VIEW = 3; + + // Purchase, sales, or "order placed" event. + PURCHASE = 4; + + // Signup user action. + SIGNUP = 5; + + // Lead-generating action. + LEAD = 6; + + // Software download action (as for an app). + DOWNLOAD = 7; + + // The addition of items to a shopping cart or bag on an advertiser site. + ADD_TO_CART = 8; + + // When someone enters the checkout flow on an advertiser site. + BEGIN_CHECKOUT = 9; + + // The start of a paid subscription for a product or service. + SUBSCRIBE_PAID = 10; + + // A call to indicate interest in an advertiser's offering. + PHONE_CALL_LEAD = 11; + + // A lead conversion imported from an external source into Google Ads. + IMPORTED_LEAD = 12; + + // A submission of a form on an advertiser site indicating business + // interest. + SUBMIT_LEAD_FORM = 13; + + // A booking of an appointment with an advertiser's business. + BOOK_APPOINTMENT = 14; + + // A quote or price estimate request. + REQUEST_QUOTE = 15; + + // A search for an advertiser's business location with intention to visit. + GET_DIRECTIONS = 16; + + // A click to an advertiser's partner's site. + OUTBOUND_CLICK = 17; + + // A call, SMS, email, chat or other type of contact to an advertiser. + CONTACT = 18; + + // A website engagement event such as long site time or a Google Analytics + // (GA) Smart Goal. Intended to be used for GA, Firebase, GA Gold goal + // imports. + ENGAGEMENT = 19; + + // A visit to a physical store location. + STORE_VISIT = 20; + + // A sale occurring in a physical store. + STORE_SALE = 21; + + // A lead conversion imported from an external source into Google Ads, + // that has been further qualified by the advertiser (marketing/sales team). + // In the lead-to-sale journey, advertisers get leads, then act on them + // by reaching out to the consumer. If the consumer is interested and + // may end up buying their product, the advertiser marks such leads as + // "qualified leads". + QUALIFIED_LEAD = 22; + + // A lead conversion imported from an external source into Google Ads, that + // has further completed a chosen stage as defined by the lead gen + // advertiser. + CONVERTED_LEAD = 23; + } + + +} diff --git a/google/ads/searchads360/v0/enums/conversion_action_status.proto b/google/ads/searchads360/v0/enums/conversion_action_status.proto new file mode 100644 index 000000000..da9669afc --- /dev/null +++ b/google/ads/searchads360/v0/enums/conversion_action_status.proto @@ -0,0 +1,52 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionActionStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing conversion action status. + +// Container for enum describing possible statuses of a conversion action. +message ConversionActionStatusEnum { + // Possible statuses of a conversion action. + enum ConversionActionStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Conversions will be recorded. + ENABLED = 2; + + // Conversions will not be recorded. + REMOVED = 3; + + // Conversions will not be recorded and the conversion action will not + // appear in the UI. + HIDDEN = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/conversion_action_type.proto b/google/ads/searchads360/v0/enums/conversion_action_type.proto new file mode 100644 index 000000000..86b8c2f03 --- /dev/null +++ b/google/ads/searchads360/v0/enums/conversion_action_type.proto @@ -0,0 +1,173 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionActionTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing conversion action type. + +// Container for enum describing possible types of a conversion action. +message ConversionActionTypeEnum { + // Possible types of a conversion action. + enum ConversionActionType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Conversions that occur when a user clicks on an ad's call extension. + AD_CALL = 2; + + // Conversions that occur when a user on a mobile device clicks a phone + // number. + CLICK_TO_CALL = 3; + + // Conversions that occur when a user downloads a mobile app from the Google + // Play Store. + GOOGLE_PLAY_DOWNLOAD = 4; + + // Conversions that occur when a user makes a purchase in an app through + // Android billing. + GOOGLE_PLAY_IN_APP_PURCHASE = 5; + + // Call conversions that are tracked by the advertiser and uploaded. + UPLOAD_CALLS = 6; + + // Conversions that are tracked by the advertiser and uploaded with + // attributed clicks. + UPLOAD_CLICKS = 7; + + // Conversions that occur on a webpage. + WEBPAGE = 8; + + // Conversions that occur when a user calls a dynamically-generated phone + // number from an advertiser's website. + WEBSITE_CALL = 9; + + // Store Sales conversion based on first-party or third-party merchant + // data uploads. + // Only customers on the allowlist can use store sales direct upload types. + STORE_SALES_DIRECT_UPLOAD = 10; + + // Store Sales conversion based on first-party or third-party merchant + // data uploads and/or from in-store purchases using cards from payment + // networks. + // Only customers on the allowlist can use store sales types. + // Read only. + STORE_SALES = 11; + + // Android app first open conversions tracked through Firebase. + FIREBASE_ANDROID_FIRST_OPEN = 12; + + // Android app in app purchase conversions tracked through Firebase. + FIREBASE_ANDROID_IN_APP_PURCHASE = 13; + + // Android app custom conversions tracked through Firebase. + FIREBASE_ANDROID_CUSTOM = 14; + + // iOS app first open conversions tracked through Firebase. + FIREBASE_IOS_FIRST_OPEN = 15; + + // iOS app in app purchase conversions tracked through Firebase. + FIREBASE_IOS_IN_APP_PURCHASE = 16; + + // iOS app custom conversions tracked through Firebase. + FIREBASE_IOS_CUSTOM = 17; + + // 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 through Third Party App + // Analytics. + THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE = 19; + + // Android app custom conversions tracked through Third Party App Analytics. + THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM = 20; + + // 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 through Third Party App + // Analytics. + THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE = 22; + + // 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 + // Google Play Store. Read only. + ANDROID_APP_PRE_REGISTRATION = 24; + + // Conversions that track all Google Play downloads which aren't tracked + // by an app-specific type. Read only. + ANDROID_INSTALLS_ALL_OTHER_APPS = 25; + + // Floodlight activity that counts the number of times that users have + // visited a particular webpage after seeing or clicking on one of + // an advertiser's ads. Read only. + FLOODLIGHT_ACTION = 26; + + // Floodlight activity that tracks the number of sales made or the number + // of items purchased. Can also capture the total value of each sale. + // Read only. + FLOODLIGHT_TRANSACTION = 27; + + // Conversions that track local actions from Google's products and + // services after interacting with an ad. Read only. + GOOGLE_HOSTED = 28; + + // Conversions reported when a user submits a lead form. Read only. + LEAD_FORM_SUBMIT = 29; + + // Conversions that come from Salesforce. Read only. + SALESFORCE = 30; + + // Conversions imported from Search Ads 360 Floodlight data. Read only. + SEARCH_ADS_360 = 31; + + // Call conversions that occur on Smart campaign Ads without call tracking + // setup, using Smart campaign custom criteria. Read only. + SMART_CAMPAIGN_AD_CLICKS_TO_CALL = 32; + + // The user clicks on a call element within Google Maps. Smart campaign + // only. Read only. + SMART_CAMPAIGN_MAP_CLICKS_TO_CALL = 33; + + // The user requests directions to a business location within Google Maps. + // Smart campaign only. Read only. + SMART_CAMPAIGN_MAP_DIRECTIONS = 34; + + // Call conversions that occur on Smart campaign Ads with call tracking + // setup, using Smart campaign custom criteria. Read only. + SMART_CAMPAIGN_TRACKED_CALLS = 35; + + // Conversions that occur when a user visits an advertiser's retail store. + // Read only. + STORE_VISITS = 36; + } + + +} diff --git a/google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto b/google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto new file mode 100644 index 000000000..a96780427 --- /dev/null +++ b/google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto @@ -0,0 +1,56 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ConversionTrackingStatusEnumProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Container for enum representing the conversion tracking status of the +// customer. +message ConversionTrackingStatusEnum { + // Conversion Tracking status of the customer. + enum ConversionTrackingStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Customer does not use any conversion tracking. + NOT_CONVERSION_TRACKED = 2; + + // The conversion actions are created and managed by this customer. + CONVERSION_TRACKING_MANAGED_BY_SELF = 3; + + // The conversion actions are created and managed by the manager specified + // in the request's `login-customer-id`. + CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER = 4; + + // The conversion actions are created and managed by a manager different + // from the customer or manager specified in the request's + // `login-customer-id`. + CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/criterion_type.proto b/google/ads/searchads360/v0/enums/criterion_type.proto new file mode 100644 index 000000000..892dc5a67 --- /dev/null +++ b/google/ads/searchads360/v0/enums/criterion_type.proto @@ -0,0 +1,147 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CriterionTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing criteria types. + +// The possible types of a criterion. +message CriterionTypeEnum { + // Enum describing possible criterion types. + enum CriterionType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Keyword, for example, 'mars cruise'. + KEYWORD = 2; + + // Placement, also known as Website, for example, 'www.flowers4sale.com' + PLACEMENT = 3; + + // Mobile application categories to target. + MOBILE_APP_CATEGORY = 4; + + // Mobile applications to target. + MOBILE_APPLICATION = 5; + + // Devices to target. + DEVICE = 6; + + // Locations to target. + LOCATION = 7; + + // Listing groups to target. + LISTING_GROUP = 8; + + // Ad Schedule. + AD_SCHEDULE = 9; + + // Age range. + AGE_RANGE = 10; + + // Gender. + GENDER = 11; + + // Income Range. + INCOME_RANGE = 12; + + // Parental status. + PARENTAL_STATUS = 13; + + // YouTube Video. + YOUTUBE_VIDEO = 14; + + // YouTube Channel. + YOUTUBE_CHANNEL = 15; + + // User list. + USER_LIST = 16; + + // Proximity. + PROXIMITY = 17; + + // A topic target on the display network (for example, "Pets & Animals"). + TOPIC = 18; + + // Listing scope to target. + LISTING_SCOPE = 19; + + // Language. + LANGUAGE = 20; + + // IpBlock. + IP_BLOCK = 21; + + // Content Label for category exclusion. + CONTENT_LABEL = 22; + + // Carrier. + CARRIER = 23; + + // A category the user is interested in. + USER_INTEREST = 24; + + // Webpage criterion for dynamic search ads. + WEBPAGE = 25; + + // Operating system version. + OPERATING_SYSTEM_VERSION = 26; + + // App payment model. + APP_PAYMENT_MODEL = 27; + + // Mobile device. + MOBILE_DEVICE = 28; + + // Custom affinity. + CUSTOM_AFFINITY = 29; + + // Custom intent. + CUSTOM_INTENT = 30; + + // Location group. + LOCATION_GROUP = 31; + + // Custom audience + CUSTOM_AUDIENCE = 32; + + // Combined audience + COMBINED_AUDIENCE = 33; + + // Smart Campaign keyword theme + KEYWORD_THEME = 34; + + // Audience + AUDIENCE = 35; + + // Google Local Services (GLS) Service ID. + LOCAL_SERVICE_ID = 37; + } + + +} diff --git a/google/ads/searchads360/v0/enums/custom_column_value_type.proto b/google/ads/searchads360/v0/enums/custom_column_value_type.proto new file mode 100644 index 000000000..5af0a589e --- /dev/null +++ b/google/ads/searchads360/v0/enums/custom_column_value_type.proto @@ -0,0 +1,54 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CustomColumnValueTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing custom column value type. + +// The value type of custom columns. +message CustomColumnValueTypeEnum { + // Enum containing possible custom column value types. + enum CustomColumnValueType { + // Not specified. + UNSPECIFIED = 0; + + // Unknown. + UNKNOWN = 1; + + // The custom column value is a string. + STRING = 2; + + // The custom column value is an int64 number. + INT64 = 3; + + // The custom column value is a double number. + DOUBLE = 4; + + // The custom column value is a boolean. + BOOLEAN = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/customer_status.proto b/google/ads/searchads360/v0/enums/customer_status.proto new file mode 100644 index 000000000..bf66992bb --- /dev/null +++ b/google/ads/searchads360/v0/enums/customer_status.proto @@ -0,0 +1,56 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "CustomerStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Container for enum describing possible statuses of a customer. +message CustomerStatusEnum { + // Possible statuses of a customer. + enum CustomerStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Indicates an active account able to serve ads. + ENABLED = 2; + + // Indicates a canceled account unable to serve ads. + // Can be reactivated by an admin user. + CANCELED = 3; + + // Indicates a suspended account unable to serve ads. + // May only be activated by Google support. + SUSPENDED = 4; + + // Indicates a closed account unable to serve ads. + // Test account will also have CLOSED status. + // Status is permanent and may not be reopened. + CLOSED = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/data_driven_model_status.proto b/google/ads/searchads360/v0/enums/data_driven_model_status.proto new file mode 100644 index 000000000..74935d6ff --- /dev/null +++ b/google/ads/searchads360/v0/enums/data_driven_model_status.proto @@ -0,0 +1,60 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "DataDrivenModelStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing data-driven model status. + +// Container for enum indicating data driven model status. +message DataDrivenModelStatusEnum { + // Enumerates data driven model statuses. + enum DataDrivenModelStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The data driven model is available. + AVAILABLE = 2; + + // The data driven model is stale. It hasn't been updated for at least 7 + // days. It is still being used, but will become expired if it does not get + // updated for 30 days. + STALE = 3; + + // The data driven model expired. It hasn't been updated for at least 30 + // days and cannot be used. Most commonly this is because there hasn't been + // the required number of events in a recent 30-day period. + EXPIRED = 4; + + // The data driven model has never been generated. Most commonly this is + // because there has never been the required number of events in any 30-day + // period. + NEVER_GENERATED = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/day_of_week.proto b/google/ads/searchads360/v0/enums/day_of_week.proto new file mode 100644 index 000000000..cb9b277ac --- /dev/null +++ b/google/ads/searchads360/v0/enums/day_of_week.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "DayOfWeekProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing days of week. + +// Container for enumeration of days of the week, for example, "Monday". +message DayOfWeekEnum { + // Enumerates days of the week, for example, "Monday". + enum DayOfWeek { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // Monday. + MONDAY = 2; + + // Tuesday. + TUESDAY = 3; + + // Wednesday. + WEDNESDAY = 4; + + // Thursday. + THURSDAY = 5; + + // Friday. + FRIDAY = 6; + + // Saturday. + SATURDAY = 7; + + // Sunday. + SUNDAY = 8; + } + + +} diff --git a/google/ads/searchads360/v0/enums/device.proto b/google/ads/searchads360/v0/enums/device.proto new file mode 100644 index 000000000..a97c14c46 --- /dev/null +++ b/google/ads/searchads360/v0/enums/device.proto @@ -0,0 +1,57 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "DeviceProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing devices. + +// Container for enumeration of Google Ads devices available for targeting. +message DeviceEnum { + // Enumerates Google Ads devices available for targeting. + enum Device { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // Mobile devices with full browsers. + MOBILE = 2; + + // Tablets with full browsers. + TABLET = 3; + + // Computers. + DESKTOP = 4; + + // Smart TVs and game consoles. + CONNECTED_TV = 6; + + // Other device types. + OTHER = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/gender_type.proto b/google/ads/searchads360/v0/enums/gender_type.proto new file mode 100644 index 000000000..74e0195bf --- /dev/null +++ b/google/ads/searchads360/v0/enums/gender_type.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "GenderTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing gender types. + +// Container for enum describing the type of demographic genders. +message GenderTypeEnum { + // The type of demographic genders (for example, female). + enum GenderType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Male. + MALE = 10; + + // Female. + FEMALE = 11; + + // Undetermined gender. + UNDETERMINED = 20; + } + + +} diff --git a/google/ads/searchads360/v0/enums/interaction_event_type.proto b/google/ads/searchads360/v0/enums/interaction_event_type.proto new file mode 100644 index 000000000..b340b5ffa --- /dev/null +++ b/google/ads/searchads360/v0/enums/interaction_event_type.proto @@ -0,0 +1,60 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "InteractionEventTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing types of payable and free interactions. + +// Container for enum describing types of payable and free interactions. +message InteractionEventTypeEnum { + // Enum describing possible types of payable and free interactions. + enum InteractionEventType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Click to site. In most cases, this interaction navigates to an external + // location, usually the advertiser's landing page. This is also the default + // InteractionEventType for click events. + CLICK = 2; + + // The user's expressed intent to engage with the ad in-place. + ENGAGEMENT = 3; + + // User viewed a video ad. + VIDEO_VIEW = 4; + + // The default InteractionEventType for ad conversion events. + // This is used when an ad conversion row does NOT indicate + // 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/google/ads/searchads360/v0/enums/keyword_match_type.proto b/google/ads/searchads360/v0/enums/keyword_match_type.proto new file mode 100644 index 000000000..3b5d45e0b --- /dev/null +++ b/google/ads/searchads360/v0/enums/keyword_match_type.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "KeywordMatchTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing Keyword match types. + +// Message describing Keyword match types. +message KeywordMatchTypeEnum { + // Possible Keyword match types. + enum KeywordMatchType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Exact match. + EXACT = 2; + + // Phrase match. + PHRASE = 3; + + // Broad match. + BROAD = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/listing_group_type.proto b/google/ads/searchads360/v0/enums/listing_group_type.proto new file mode 100644 index 000000000..094b37387 --- /dev/null +++ b/google/ads/searchads360/v0/enums/listing_group_type.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ListingGroupTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing listing groups. + +// Container for enum describing the type of the listing group. +message ListingGroupTypeEnum { + // The type of the listing group. + enum ListingGroupType { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Subdivision of products along some listing dimension. These nodes + // are not used by serving to target listing entries, but is purely + // to define the structure of the tree. + SUBDIVISION = 2; + + // Listing group unit that defines a bid. + UNIT = 3; + } + + +} diff --git a/google/ads/searchads360/v0/enums/location_group_radius_units.proto b/google/ads/searchads360/v0/enums/location_group_radius_units.proto new file mode 100644 index 000000000..0ad59b44b --- /dev/null +++ b/google/ads/searchads360/v0/enums/location_group_radius_units.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "LocationGroupRadiusUnitsProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::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 (for example, MILES) + enum LocationGroupRadiusUnits { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Meters + METERS = 2; + + // Miles + MILES = 3; + + // Milli Miles + MILLI_MILES = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/manager_link_status.proto b/google/ads/searchads360/v0/enums/manager_link_status.proto new file mode 100644 index 000000000..85695a92d --- /dev/null +++ b/google/ads/searchads360/v0/enums/manager_link_status.proto @@ -0,0 +1,57 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "ManagerLinkStatusProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Container for enum describing possible status of a manager and client link. +message ManagerLinkStatusEnum { + // Possible statuses of a link. + enum ManagerLinkStatus { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Indicates current in-effect relationship + ACTIVE = 2; + + // Indicates terminated relationship + INACTIVE = 3; + + // Indicates relationship has been requested by manager, but the client + // hasn't accepted yet. + PENDING = 4; + + // Relationship was requested by the manager, but the client has refused. + REFUSED = 5; + + // Indicates relationship has been requested by manager, but manager + // canceled it. + CANCELED = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/negative_geo_target_type.proto b/google/ads/searchads360/v0/enums/negative_geo_target_type.proto new file mode 100644 index 000000000..113c530ad --- /dev/null +++ b/google/ads/searchads360/v0/enums/negative_geo_target_type.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "NegativeGeoTargetTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing negative geo target types. + +// Container for enum describing possible negative geo target types. +message NegativeGeoTargetTypeEnum { + // The possible negative geo target types. + enum NegativeGeoTargetType { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // Specifies that a user is excluded from seeing the ad if they + // are in, or show interest in, advertiser's excluded locations. + PRESENCE_OR_INTEREST = 4; + + // Specifies that a user is excluded from seeing the ad if they + // are in advertiser's excluded locations. + PRESENCE = 5; + } + + +} diff --git a/google/ads/searchads360/v0/enums/optimization_goal_type.proto b/google/ads/searchads360/v0/enums/optimization_goal_type.proto new file mode 100644 index 000000000..0a3cfab35 --- /dev/null +++ b/google/ads/searchads360/v0/enums/optimization_goal_type.proto @@ -0,0 +1,56 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "OptimizationGoalTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing optimization goal type. + +// Container for enum describing the type of optimization goal. +message OptimizationGoalTypeEnum { + // The type of optimization goal + enum OptimizationGoalType { + // Not specified. + UNSPECIFIED = 0; + + // Used as a return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Optimize for call clicks. Call click conversions are times people + // selected 'Call' to contact a store after viewing an ad. + CALL_CLICKS = 2; + + // Optimize for driving directions. Driving directions conversions are + // times people selected 'Get directions' to navigate to a store after + // viewing an ad. + DRIVING_DIRECTIONS = 3; + + // Optimize for pre-registration. Pre-registration conversions are the + // number of pre-registration signups to receive a notification when the app + // is released. + APP_PRE_REGISTRATION = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/positive_geo_target_type.proto b/google/ads/searchads360/v0/enums/positive_geo_target_type.proto new file mode 100644 index 000000000..952c974f7 --- /dev/null +++ b/google/ads/searchads360/v0/enums/positive_geo_target_type.proto @@ -0,0 +1,56 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "PositiveGeoTargetTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing positive geo target types. + +// Container for enum describing possible positive geo target types. +message PositiveGeoTargetTypeEnum { + // The possible positive geo target types. + enum PositiveGeoTargetType { + // Not specified. + UNSPECIFIED = 0; + + // The value is unknown in this version. + UNKNOWN = 1; + + // Specifies that an ad is triggered if the user is in, + // or shows interest in, advertiser's targeted locations. + PRESENCE_OR_INTEREST = 5; + + // Specifies that an ad is triggered if the user + // searches for advertiser's targeted locations. + // This can only be used with Search and standard + // Shopping campaigns. + SEARCH_INTEREST = 6; + + // Specifies that an ad is triggered if the user is in + // or regularly in advertiser's targeted locations. + PRESENCE = 7; + } + + +} diff --git a/google/ads/searchads360/v0/enums/quality_score_bucket.proto b/google/ads/searchads360/v0/enums/quality_score_bucket.proto new file mode 100644 index 000000000..f2e009f2d --- /dev/null +++ b/google/ads/searchads360/v0/enums/quality_score_bucket.proto @@ -0,0 +1,51 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "QualityScoreBucketProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing quality score buckets. + +// The relative performance compared to other advertisers. +message QualityScoreBucketEnum { + // Enum listing the possible quality score buckets. + enum QualityScoreBucket { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Quality of the creative is below average. + BELOW_AVERAGE = 2; + + // Quality of the creative is average. + AVERAGE = 3; + + // Quality of the creative is above average. + ABOVE_AVERAGE = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/search_ads360_field_category.proto b/google/ads/searchads360/v0/enums/search_ads360_field_category.proto new file mode 100644 index 000000000..c38572bbe --- /dev/null +++ b/google/ads/searchads360/v0/enums/search_ads360_field_category.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SearchAds360FieldCategoryProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing SearchAds360Field categories. + +// Container for enum that determines if the described artifact is a resource +// or a field, and if it is a field, when it segments search queries. +message SearchAds360FieldCategoryEnum { + // The category of the artifact. + enum SearchAds360FieldCategory { + // Unspecified + UNSPECIFIED = 0; + + // Unknown + UNKNOWN = 1; + + // The described artifact is a resource. + RESOURCE = 2; + + // The described artifact is a field and is an attribute of a resource. + // Including a resource attribute field in a query may segment the query if + // the resource to which it is attributed segments the resource found in + // the FROM clause. + ATTRIBUTE = 3; + + // The described artifact is a field and always segments search queries. + SEGMENT = 5; + + // The described artifact is a field and is a metric. It never segments + // search queries. + METRIC = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/search_ads360_field_data_type.proto b/google/ads/searchads360/v0/enums/search_ads360_field_data_type.proto new file mode 100644 index 000000000..21c40cc42 --- /dev/null +++ b/google/ads/searchads360/v0/enums/search_ads360_field_data_type.proto @@ -0,0 +1,100 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SearchAds360FieldDataTypeProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing SearchAds360Field data types. + +// Container holding the various data types. +message SearchAds360FieldDataTypeEnum { + // These are the various types a SearchAds360Service artifact may take on. + enum SearchAds360FieldDataType { + // Unspecified + UNSPECIFIED = 0; + + // Unknown + UNKNOWN = 1; + + // Maps to google.protobuf.BoolValue + // + // Applicable operators: =, != + BOOLEAN = 2; + + // Maps to google.protobuf.StringValue. It can be compared using the set of + // operators specific to dates however. + // + // Applicable operators: =, <, >, <=, >=, BETWEEN, DURING, and IN + DATE = 3; + + // Maps to google.protobuf.DoubleValue + // + // Applicable operators: =, !=, <, >, IN, NOT IN + DOUBLE = 4; + + // Maps to an enum. It's specific definition can be found at type_url. + // + // Applicable operators: =, !=, IN, NOT IN + ENUM = 5; + + // Maps to google.protobuf.FloatValue + // + // Applicable operators: =, !=, <, >, IN, NOT IN + FLOAT = 6; + + // Maps to google.protobuf.Int32Value + // + // Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN + INT32 = 7; + + // Maps to google.protobuf.Int64Value + // + // Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN + INT64 = 8; + + // Maps to a protocol buffer message type. The data type's details can be + // found in type_url. + // + // No operators work with MESSAGE fields. + MESSAGE = 9; + + // Maps to google.protobuf.StringValue. Represents the resource name + // (unique id) of a resource or one of its foreign keys. + // + // No operators work with RESOURCE_NAME fields. + RESOURCE_NAME = 10; + + // Maps to google.protobuf.StringValue. + // + // Applicable operators: =, !=, LIKE, NOT LIKE, IN, NOT IN + STRING = 11; + + // Maps to google.protobuf.UInt64Value + // + // Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN + UINT64 = 12; + } + + +} diff --git a/google/ads/searchads360/v0/enums/summary_row_setting.proto b/google/ads/searchads360/v0/enums/summary_row_setting.proto new file mode 100644 index 000000000..bda63b006 --- /dev/null +++ b/google/ads/searchads360/v0/enums/summary_row_setting.proto @@ -0,0 +1,52 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "SummaryRowSettingProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing summary row setting. + +// Indicates summary row setting in request parameter. +message SummaryRowSettingEnum { + // Enum describing return summary row settings. + enum SummaryRowSetting { + // Not specified. + UNSPECIFIED = 0; + + // Represent unknown values of return summary row. + UNKNOWN = 1; + + // Do not return summary row. + NO_SUMMARY_ROW = 2; + + // Return summary row along with results. The summary row will be returned + // in the last batch alone (last batch will contain no results). + SUMMARY_ROW_WITH_RESULTS = 3; + + // Return summary row only and return no results. + SUMMARY_ROW_ONLY = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/target_impression_share_location.proto b/google/ads/searchads360/v0/enums/target_impression_share_location.proto new file mode 100644 index 000000000..e405412f5 --- /dev/null +++ b/google/ads/searchads360/v0/enums/target_impression_share_location.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "TargetImpressionShareLocationProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing target impression share goal. + +// Container for enum describing where on the first search results page the +// automated bidding system should target impressions for the +// TargetImpressionShare bidding strategy. +message TargetImpressionShareLocationEnum { + // Enum describing possible goals. + enum TargetImpressionShareLocation { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Any location on the web page. + ANYWHERE_ON_PAGE = 2; + + // Top box of ads. + TOP_OF_PAGE = 3; + + // Top slot in the top box of ads. + ABSOLUTE_TOP_OF_PAGE = 4; + } + + +} diff --git a/google/ads/searchads360/v0/enums/webpage_condition_operand.proto b/google/ads/searchads360/v0/enums/webpage_condition_operand.proto new file mode 100644 index 000000000..6bc6ebdeb --- /dev/null +++ b/google/ads/searchads360/v0/enums/webpage_condition_operand.proto @@ -0,0 +1,57 @@ +// 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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "WebpageConditionOperandProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing webpage condition operand. + +// Container for enum describing webpage condition operand in webpage criterion. +message WebpageConditionOperandEnum { + // The webpage condition operand in webpage criterion. + enum WebpageConditionOperand { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Operand denoting a webpage URL targeting condition. + URL = 2; + + // Operand denoting a webpage category targeting condition. + CATEGORY = 3; + + // Operand denoting a webpage title targeting condition. + PAGE_TITLE = 4; + + // Operand denoting a webpage content targeting condition. + PAGE_CONTENT = 5; + + // Operand denoting a webpage custom label targeting condition. + CUSTOM_LABEL = 6; + } + + +} diff --git a/google/ads/searchads360/v0/enums/webpage_condition_operator.proto b/google/ads/searchads360/v0/enums/webpage_condition_operator.proto new file mode 100644 index 000000000..244e8bfba --- /dev/null +++ b/google/ads/searchads360/v0/enums/webpage_condition_operator.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.searchads360.v0.enums; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "WebpageConditionOperatorProto"; +option java_package = "com.google.ads.searchads360.v0.enums"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums"; +option ruby_package = "Google::Ads::SearchAds360::V0::Enums"; + +// Proto file describing webpage condition operator. + +// Container for enum describing webpage condition operator in webpage +// criterion. +message WebpageConditionOperatorEnum { + // The webpage condition operator in webpage criterion. + enum WebpageConditionOperator { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // The argument web condition is equal to the compared web condition. + EQUALS = 2; + + // The argument web condition is part of the compared web condition. + CONTAINS = 3; + } + + +} diff --git a/google/ads/searchads360/v0/resources/BUILD.bazel b/google/ads/searchads360/v0/resources/BUILD.bazel new file mode 100644 index 000000000..d70657029 --- /dev/null +++ b/google/ads/searchads360/v0/resources/BUILD.bazel @@ -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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +package(default_visibility = ["//visibility:public"]) + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") + +proto_library( + name = "resources_proto", + srcs = glob(["*.proto"]), + deps = [ + "//google/ads/searchads360/v0/common:common_proto", + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + ], +) + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_grpc_library", + "java_proto_library", +) + +java_proto_library( + name = "resources_java_proto", + deps = [":resources_proto"], +) + +java_grpc_library( + name = "resources_java_grpc", + srcs = [":resources_proto"], + deps = [":resources_java_proto"], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +moved_proto_library( + name = "resources_moved_proto", + srcs = [":resources_proto"], + deps = [ + "//google/ads/searchads360/v0/common:common_proto", + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + ], +) + +py_proto_library( + name = "resources_py_proto", + deps = [":resources_moved_proto"], +) + +py_grpc_library( + name = "resources_py_grpc", + srcs = [":resources_moved_proto"], + deps = [":resources_py_proto"], +) + +############################################################################## +# C# +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", +) + +csharp_proto_library( + name = "resources_csharp_proto", + deps = [":resources_proto"], +) + +csharp_grpc_library( + name = "resources_csharp_grpc", + srcs = [":resources_proto"], + deps = [":resources_csharp_proto"], +) \ No newline at end of file diff --git a/google/ads/searchads360/v0/resources/ad_group.proto b/google/ads/searchads360/v0/resources/ad_group.proto new file mode 100644 index 000000000..b3f60c516 --- /dev/null +++ b/google/ads/searchads360/v0/resources/ad_group.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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto"; +import "google/ads/searchads360/v0/enums/ad_group_status.proto"; +import "google/ads/searchads360/v0/enums/ad_group_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ad group resource. + +// An ad group. +message AdGroup { + option (google.api.resource) = { + type: "searchads360.googleapis.com/AdGroup" + pattern: "customers/{customer_id}/adGroups/{ad_group_id}" + }; + + // Immutable. The resource name of the ad group. + // Ad group resource names have the form: + // + // `customers/{customer_id}/adGroups/{ad_group_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroup" + } + ]; + + // Output only. The ID of the ad group. + optional int64 id = 34 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The name of the ad group. + // + // This field is required and should not be empty when creating new ad + // groups. + // + // It must contain fewer than 255 UTF-8 full-width characters. + // + // 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 = 35; + + // The status of the ad group. + google.ads.searchads360.v0.enums.AdGroupStatusEnum.AdGroupStatus status = 5; + + // Immutable. The type of the ad group. + google.ads.searchads360.v0.enums.AdGroupTypeEnum.AdGroupType type = 12 [(google.api.field_behavior) = IMMUTABLE]; + + // The ad rotation mode of the ad group. + google.ads.searchads360.v0.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22; + + // The maximum CPC (cost-per-click) bid. + optional int64 cpc_bid_micros = 39; +} diff --git a/google/ads/searchads360/v0/resources/ad_group_bid_modifier.proto b/google/ads/searchads360/v0/resources/ad_group_bid_modifier.proto new file mode 100644 index 000000000..4a81bb5d1 --- /dev/null +++ b/google/ads/searchads360/v0/resources/ad_group_bid_modifier.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.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupBidModifierProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ad group bid modifier resource. + +// Represents an ad group bid modifier. +message AdGroupBidModifier { + option (google.api.resource) = { + type: "searchads360.googleapis.com/AdGroupBidModifier" + pattern: "customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}" + }; + + // Immutable. The resource name of the ad group bid modifier. + // Ad group bid modifier resource names have the form: + // + // `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupBidModifier" + } + ]; + + // The modifier for the bid when the criterion matches. The modifier must be + // in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. + // Use 0 to opt out of a Device type. + optional double bid_modifier = 15; +} diff --git a/google/ads/searchads360/v0/resources/ad_group_criterion.proto b/google/ads/searchads360/v0/resources/ad_group_criterion.proto new file mode 100644 index 000000000..f982711ed --- /dev/null +++ b/google/ads/searchads360/v0/resources/ad_group_criterion.proto @@ -0,0 +1,139 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/common/criteria.proto"; +import "google/ads/searchads360/v0/enums/ad_group_criterion_engine_status.proto"; +import "google/ads/searchads360/v0/enums/ad_group_criterion_status.proto"; +import "google/ads/searchads360/v0/enums/criterion_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdGroupCriterionProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ad group criterion resource. + +// An ad group criterion. +message AdGroupCriterion { + option (google.api.resource) = { + type: "searchads360.googleapis.com/AdGroupCriterion" + pattern: "customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}" + }; + + // A container for ad group criterion quality information. + message QualityInfo { + // Output only. The quality score. + // + // 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]; + } + + // Immutable. The resource name of the ad group criterion. + // Ad group criterion resource names have the form: + // + // `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroupCriterion" + } + ]; + + // Output only. The ID of the criterion. + optional int64 criterion_id = 56 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The status of the criterion. + // + // This is the status of the ad group criterion entity, set by the client. + // Note: UI reports may incorporate additional information that affects + // whether a criterion is eligible to run. In some cases a criterion that's + // REMOVED in the API can still show as enabled in the UI. + // For example, campaigns by default show to users of all age ranges unless + // 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.searchads360.v0.enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3; + + // Output only. Information regarding the quality of the criterion. + QualityInfo quality_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Immutable. The ad group to which the criterion belongs. + optional string ad_group = 57 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/AdGroup" + } + ]; + + // Output only. The type of the criterion. + google.ads.searchads360.v0.enums.CriterionTypeEnum.CriterionType type = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The modifier for the bid when the criterion matches. The modifier must be + // in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. + optional double bid_modifier = 61; + + // The CPC (cost-per-click) bid. + optional int64 cpc_bid_micros = 62; + + // Output only. The effective CPC (cost-per-click) bid. + optional int64 effective_cpc_bid_micros = 66 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The list of possible final URLs after all cross-domain redirects for the + // ad. + repeated string final_urls = 70; + + // Output only. The Engine Status for ad group criterion. + optional google.ads.searchads360.v0.enums.AdGroupCriterionEngineStatusEnum.AdGroupCriterionEngineStatus engine_status = 80 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // URL template for appending params to final URL. + optional string final_url_suffix = 72; + + // The URL template for constructing a tracking URL. + optional string tracking_url_template = 73; + + // Output only. The datetime when this ad group criterion was last modified. The datetime + // is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. + string last_modified_time = 78 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The ad group criterion. + // + // Exactly one must be set. + oneof criterion { + // Immutable. Keyword. + google.ads.searchads360.v0.common.KeywordInfo keyword = 27 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Listing group. + google.ads.searchads360.v0.common.ListingGroupInfo listing_group = 32 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Age range. + google.ads.searchads360.v0.common.AgeRangeInfo age_range = 36 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Gender. + google.ads.searchads360.v0.common.GenderInfo gender = 37 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Webpage + google.ads.searchads360.v0.common.WebpageInfo webpage = 46 [(google.api.field_behavior) = IMMUTABLE]; + } +} diff --git a/google/ads/searchads360/v0/resources/bidding_strategy.proto b/google/ads/searchads360/v0/resources/bidding_strategy.proto new file mode 100644 index 000000000..d9ab1ee6a --- /dev/null +++ b/google/ads/searchads360/v0/resources/bidding_strategy.proto @@ -0,0 +1,146 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/common/bidding.proto"; +import "google/ads/searchads360/v0/enums/bidding_strategy_status.proto"; +import "google/ads/searchads360/v0/enums/bidding_strategy_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "BiddingStrategyProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the BiddingStrategy resource + +// A bidding strategy. +message BiddingStrategy { + option (google.api.resource) = { + type: "searchads360.googleapis.com/BiddingStrategy" + pattern: "customers/{customer_id}/biddingStrategies/{bidding_strategy_id}" + }; + + // Immutable. The resource name of the bidding strategy. + // Bidding strategy resource names have the form: + // + // `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/BiddingStrategy" + } + ]; + + // Output only. The ID of the bidding strategy. + optional int64 id = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The name of the bidding strategy. + // All bidding strategies within an account must be named distinctly. + // + // The length of this string should be between 1 and 255, inclusive, + // in UTF-8 bytes, (trimmed). + optional string name = 17; + + // Output only. The status of the bidding strategy. + // + // This field is read-only. + google.ads.searchads360.v0.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.searchads360.v0.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // 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 + // customers, this field cannot be set; all strategies in a serving customer + // implicitly use the serving customer's currency. In all cases the + // 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). + // + // For bidding strategies in manager customers, this is the currency set by + // the advertiser when creating the strategy. For serving customers, this is + // the customer's currency_code. + // + // 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]; + + // 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]; + + // 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]; + + // The bidding scheme. + // + // Only one can be set. + oneof scheme { + // 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.searchads360.v0.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.searchads360.v0.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.searchads360.v0.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.searchads360.v0.common.TargetCpa target_cpa = 9; + + // A bidding strategy that automatically optimizes towards a chosen + // percentage of impressions. + google.ads.searchads360.v0.common.TargetImpressionShare target_impression_share = 48; + + // A bidding strategy that sets bids based on the target fraction of + // auctions where the advertiser should outrank a specific competitor. + // This field is deprecated. Creating a new bidding strategy with this + // field or attaching bidding strategies with this field to a campaign will + // fail. Mutates to strategies that already have this scheme populated are + // allowed. + google.ads.searchads360.v0.common.TargetOutrankShare target_outrank_share = 10; + + // A bidding strategy that helps you maximize revenue while averaging a + // specific target Return On Ad Spend (ROAS). + google.ads.searchads360.v0.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.searchads360.v0.common.TargetSpend target_spend = 12; + } +} diff --git a/google/ads/searchads360/v0/resources/campaign.proto b/google/ads/searchads360/v0/resources/campaign.proto new file mode 100644 index 000000000..3b654b942 --- /dev/null +++ b/google/ads/searchads360/v0/resources/campaign.proto @@ -0,0 +1,363 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/common/bidding.proto"; +import "google/ads/searchads360/v0/common/custom_parameter.proto"; +import "google/ads/searchads360/v0/common/frequency_cap.proto"; +import "google/ads/searchads360/v0/common/real_time_bidding_setting.proto"; +import "google/ads/searchads360/v0/enums/ad_serving_optimization_status.proto"; +import "google/ads/searchads360/v0/enums/advertising_channel_sub_type.proto"; +import "google/ads/searchads360/v0/enums/advertising_channel_type.proto"; +import "google/ads/searchads360/v0/enums/asset_field_type.proto"; +import "google/ads/searchads360/v0/enums/bidding_strategy_system_status.proto"; +import "google/ads/searchads360/v0/enums/bidding_strategy_type.proto"; +import "google/ads/searchads360/v0/enums/campaign_serving_status.proto"; +import "google/ads/searchads360/v0/enums/campaign_status.proto"; +import "google/ads/searchads360/v0/enums/negative_geo_target_type.proto"; +import "google/ads/searchads360/v0/enums/optimization_goal_type.proto"; +import "google/ads/searchads360/v0/enums/positive_geo_target_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CampaignProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Campaign resource. + +// A campaign. +message Campaign { + option (google.api.resource) = { + type: "searchads360.googleapis.com/Campaign" + pattern: "customers/{customer_id}/campaigns/{campaign_id}" + }; + + // The network settings for the campaign. + message NetworkSettings { + // Whether ads will be served with google.com search results. + optional bool target_google_search = 5; + + // Whether ads will be served on partner sites in the Google Search Network + // (requires `target_google_search` to also be `true`). + optional bool target_search_network = 6; + + // Whether ads will be served on specified placements in the Google Display + // Network. Placements are specified using the Placement criterion. + optional bool target_content_network = 7; + + // Whether ads will be served on the Google Partner Network. + // This is available only to some select Google partner accounts. + optional bool target_partner_search_network = 8; + } + + // The setting for controlling Dynamic Search Ads (DSA). + message DynamicSearchAdsSetting { + // 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, for example, + // "en". + string language_code = 7 [(google.api.field_behavior) = REQUIRED]; + + // Whether the campaign uses advertiser supplied URLs exclusively. + optional bool use_supplied_urls_only = 8; + } + + // The setting for Shopping campaigns. Defines the universe of products that + // can be advertised by the campaign, and how this campaign interacts with + // other Shopping campaigns. + message ShoppingSetting { + // Immutable. ID of the Merchant Center account. + // This field is required for create operations. This field is immutable for + // Shopping campaigns. + optional int64 merchant_id = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // Sales country of products to include in the campaign. + // + 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 + // 2, inclusive. + // This field is optional for Smart Shopping campaigns, but must be equal to + // 3 if set. + optional int32 campaign_priority = 7; + + // Whether to include local products. + optional bool enable_local = 8; + + // Immutable. Whether to target Vehicle Listing inventory. + bool use_vehicle_inventory = 9 [(google.api.field_behavior) = IMMUTABLE]; + } + + // 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]; + } + + // Represents a collection of settings related to ads geotargeting. + message GeoTargetTypeSetting { + // The setting used for positive geotargeting in this particular campaign. + google.ads.searchads360.v0.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1; + + // The setting used for negative geotargeting in this particular campaign. + google.ads.searchads360.v0.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2; + } + + // Selective optimization setting for this campaign, which includes a set of + // conversion actions to optimize this campaign towards. + message SelectiveOptimization { + // The selected set of conversion actions for optimizing this campaign. + repeated string conversion_actions = 2 [(google.api.resource_reference) = { + type: "searchads360.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.searchads360.v0.enums.OptimizationGoalTypeEnum.OptimizationGoalType optimization_goal_types = 1; + } + + // Immutable. The resource name of the campaign. + // Campaign resource names have the form: + // + // `customers/{customer_id}/campaigns/{campaign_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Campaign" + } + ]; + + // Output only. The ID of the campaign. + optional int64 id = 59 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The name of the campaign. + // + // This field is required and should not be empty when creating new + // campaigns. + // + // 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 = 58; + + // The status of the campaign. + // + // When a new campaign is added, the status defaults to ENABLED. + google.ads.searchads360.v0.enums.CampaignStatusEnum.CampaignStatus status = 5; + + // Output only. The ad serving status of the campaign. + google.ads.searchads360.v0.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.searchads360.v0.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The ad serving optimization status of the campaign. + google.ads.searchads360.v0.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`. + // + // This field is required and should not be empty when creating new + // campaigns. + // + // Can be set only when creating campaigns. + // After the campaign is created, the field can not be changed. + google.ads.searchads360.v0.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.searchads360.v0.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.searchads360.v0.common.CustomParameter url_custom_parameters = 12; + + // Settings for Real-Time Bidding, a feature only available for campaigns + // targeting the Ad Exchange network. + google.ads.searchads360.v0.common.RealTimeBiddingSetting real_time_bidding_setting = 39; + + // The network settings for the campaign. + NetworkSettings network_settings = 14; + + // The setting for controlling Dynamic Search Ads (DSA). + DynamicSearchAdsSetting dynamic_search_ads_setting = 33; + + // The setting for controlling Shopping campaigns. + ShoppingSetting shopping_setting = 36; + + // The setting for ads geotargeting. + GeoTargetTypeSetting geo_target_type_setting = 47; + + // Output only. The resource names of labels attached to this campaign. + repeated string labels = 61 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CampaignLabel" + } + ]; + + // The budget of the campaign. + optional string campaign_budget = 62 [(google.api.resource_reference) = { + type: "searchads360.googleapis.com/CampaignBudget" + }]; + + // Output only. The type of bidding strategy. + // + // A bidding strategy can be created by setting either the bidding scheme to + // create a standard bidding strategy or the `bidding_strategy` field to + // create a portfolio bidding strategy. + // + // This field is read-only. + google.ads.searchads360.v0.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The date when campaign started in serving customer's timezone in YYYY-MM-DD + // format. + optional string start_date = 63; + + // The last day of the campaign in serving customer's timezone in YYYY-MM-DD + // 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 + // with parallel tracking. + optional string final_url_suffix = 65; + + // A list that limits how often each user will see this campaign's ads. + repeated google.ads.searchads360.v0.common.FrequencyCapEntry frequency_caps = 40; + + // Selective optimization setting for this campaign, which includes a set of + // conversion actions to optimize this campaign towards. + SelectiveOptimization selective_optimization = 45; + + // Optimization goal setting for this campaign, which includes a set of + // optimization goal types. + OptimizationGoalSetting optimization_goal_setting = 54; + + // Output only. Campaign-level settings for tracking information. + TrackingSetting tracking_setting = 46 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. ID of the campaign in the external engine account. This field is for + // non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu + // etc. For Google Ads entity, use "campaign.id" instead. + string engine_id = 68 [(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.searchads360.v0.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69; + + // Output only. Timestamp of the campaign's creation time, formatted in ISO 8601. + string create_time = 79 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The datetime when this campaign was last modified. The datetime is in the + // customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. + string last_modified_time = 70 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // 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 + // advertiser's Google Merchant Center or business data feeds are targeted. + // If opted in (false), the entire domain will be targeted. This field can + // only be set for Performance Max campaigns, where the default value is + // false. + optional bool url_expansion_opt_out = 72; + + // The bidding strategy for the campaign. + // + // 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: "searchads360.googleapis.com/BiddingStrategy" + }]; + + // 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.searchads360.v0.common.ManualCpa manual_cpa = 74; + + // Standard Manual CPC bidding strategy. + // Manual click-based bidding where user pays per click. + google.ads.searchads360.v0.common.ManualCpc manual_cpc = 24; + + // Standard Manual CPM bidding strategy. + // Manual impression-based bidding where user pays per thousand + // impressions. + google.ads.searchads360.v0.common.ManualCpm manual_cpm = 25; + + // Standard Maximize Conversions bidding strategy that automatically + // maximizes number of conversions while spending your budget. + google.ads.searchads360.v0.common.MaximizeConversions maximize_conversions = 30; + + // Standard Maximize Conversion Value bidding strategy that automatically + // sets bids to maximize revenue while spending your budget. + google.ads.searchads360.v0.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.searchads360.v0.common.TargetCpa target_cpa = 26; + + // Target Impression Share bidding strategy. An automated bidding strategy + // that sets bids to achieve a chosen percentage of impressions. + google.ads.searchads360.v0.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.searchads360.v0.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.searchads360.v0.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.searchads360.v0.common.PercentCpc percent_cpc = 34; + + // A bidding strategy that automatically optimizes cost per thousand + // impressions. + google.ads.searchads360.v0.common.TargetCpm target_cpm = 41; + } +} diff --git a/google/ads/searchads360/v0/resources/campaign_budget.proto b/google/ads/searchads360/v0/resources/campaign_budget.proto new file mode 100644 index 000000000..596567950 --- /dev/null +++ b/google/ads/searchads360/v0/resources/campaign_budget.proto @@ -0,0 +1,66 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/budget_delivery_method.proto"; +import "google/ads/searchads360/v0/enums/budget_period.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CampaignBudgetProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Budget resource. + +// A campaign budget. +message CampaignBudget { + option (google.api.resource) = { + type: "searchads360.googleapis.com/CampaignBudget" + pattern: "customers/{customer_id}/campaignBudgets/{budget_id}" + }; + + // Immutable. The resource name of the campaign budget. + // Campaign budget resource names have the form: + // + // `customers/{customer_id}/campaignBudgets/{campaign_budget_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CampaignBudget" + } + ]; + + // The amount of the budget, in the local currency for the account. + // Amount is specified in micros, where one million is equivalent to one + // currency unit. Monthly spend is capped at 30.4 times this amount. + optional int64 amount_micros = 21; + + // 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.searchads360.v0.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7; + + // Immutable. Period over which to spend the budget. Defaults to DAILY if not specified. + google.ads.searchads360.v0.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(google.api.field_behavior) = IMMUTABLE]; +} diff --git a/google/ads/searchads360/v0/resources/campaign_criterion.proto b/google/ads/searchads360/v0/resources/campaign_criterion.proto new file mode 100644 index 000000000..a6bcbcaf0 --- /dev/null +++ b/google/ads/searchads360/v0/resources/campaign_criterion.proto @@ -0,0 +1,90 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/common/criteria.proto"; +import "google/ads/searchads360/v0/enums/criterion_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CampaignCriterionProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Campaign Criterion resource. + +// A campaign criterion. +message CampaignCriterion { + option (google.api.resource) = { + type: "searchads360.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: "searchads360.googleapis.com/CampaignCriterion" + } + ]; + + // 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.searchads360.v0.enums.CriterionTypeEnum.CriterionType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The campaign criterion. + // + // Exactly one must be set. + oneof criterion { + // Immutable. Location. + google.ads.searchads360.v0.common.LocationInfo location = 12 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Device. + google.ads.searchads360.v0.common.DeviceInfo device = 13 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Language. + google.ads.searchads360.v0.common.LanguageInfo language = 26 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Location Group + google.ads.searchads360.v0.common.LocationGroupInfo location_group = 34 [(google.api.field_behavior) = IMMUTABLE]; + } +} diff --git a/google/ads/searchads360/v0/resources/conversion_action.proto b/google/ads/searchads360/v0/resources/conversion_action.proto new file mode 100644 index 000000000..02a873ecc --- /dev/null +++ b/google/ads/searchads360/v0/resources/conversion_action.proto @@ -0,0 +1,164 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/attribution_model.proto"; +import "google/ads/searchads360/v0/enums/conversion_action_category.proto"; +import "google/ads/searchads360/v0/enums/conversion_action_status.proto"; +import "google/ads/searchads360/v0/enums/conversion_action_type.proto"; +import "google/ads/searchads360/v0/enums/data_driven_model_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "ConversionActionProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Conversion Action resource. + +// A conversion action. +message ConversionAction { + option (google.api.resource) = { + type: "searchads360.googleapis.com/ConversionAction" + pattern: "customers/{customer_id}/conversionActions/{conversion_type_id}" + }; + + // Settings related to this conversion action's attribution model. + message AttributionModelSettings { + // The attribution model type of this conversion action. + google.ads.searchads360.v0.enums.AttributionModelEnum.AttributionModel attribution_model = 1; + + // Output only. The status of the data-driven attribution model for the conversion + // action. + google.ads.searchads360.v0.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 + // conversion action. + message ValueSettings { + // The value to use when conversion events for this conversion action are + // sent with an invalid, disallowed or missing value, or when + // this conversion action is configured to always use the default value. + optional double default_value = 4; + + // The currency code to use when conversion events for this conversion + // action are sent with an invalid or missing currency code, or when this + // conversion action is configured to always use the default value. + optional string default_currency_code = 5; + + // Controls whether the default value and default currency code are used in + // place of the value and currency code specified in conversion events for + // this conversion action. + optional bool always_use_default_value = 6; + } + + // Settings related to a Floodlight conversion action. + message FloodlightSettings { + // Output only. String used to identify a Floodlight activity group when reporting + // conversions. + string activity_group_tag = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. String used to identify a Floodlight activity when reporting conversions. + string activity_tag = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. ID of the Floodlight activity in DoubleClick Campaign Manager (DCM). + int64 activity_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Immutable. The resource name of the conversion action. + // Conversion action resource names have the form: + // + // `customers/{customer_id}/conversionActions/{conversion_action_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/ConversionAction" + } + ]; + + // Output only. The ID of the conversion action. + optional int64 id = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The name of the conversion action. + // + // This field is required and should not be empty when creating new + // conversion actions. + optional string name = 22; + + // Output only. Timestamp of the Floodlight activity's creation, formatted in ISO 8601. + string creation_time = 33 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The status of this conversion action for conversion event accrual. + google.ads.searchads360.v0.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4; + + // Immutable. The type of this conversion action. + google.ads.searchads360.v0.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // If a conversion action's primary_for_goal bit is false, the conversion + // action is non-biddable for all campaigns regardless of their customer + // conversion goal or campaign conversion goal. + // However, custom conversion goals do not respect primary_for_goal, so if + // a campaign has a custom conversion goal configured with a + // 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 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.searchads360.v0.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. + optional string owner_customer = 23 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Customer" + } + ]; + + // Whether this conversion action should be included in the + // "client_account_conversions" metric. + optional bool include_in_client_account_conversions_metric = 24; + + // Output only. Whether this conversion action should be included in the "conversions" + // metric. + optional bool include_in_conversions_metric = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The maximum number of days that may elapse between an interaction + // (for example, a click) and a conversion event. + optional int64 click_through_lookback_window_days = 25; + + // Settings related to the value for conversion events associated with this + // conversion action. + ValueSettings value_settings = 11; + + // Settings related to this conversion action's attribution model. + AttributionModelSettings attribution_model_settings = 13; + + // App ID for an app conversion action. + optional string app_id = 28; + + // Output only. Floodlight settings for Floodlight conversion types. + FloodlightSettings floodlight_settings = 29 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/custom_column.proto b/google/ads/searchads360/v0/resources/custom_column.proto new file mode 100644 index 000000000..a9631bd8e --- /dev/null +++ b/google/ads/searchads360/v0/resources/custom_column.proto @@ -0,0 +1,80 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/custom_column_value_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CustomColumnProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Custom Column resource. + +// A custom column. +// See Search Ads 360 custom column at +// https://support.google.com/sa360/answer/9633916 +message CustomColumn { + option (google.api.resource) = { + type: "searchads360.googleapis.com/CustomColumn" + pattern: "customers/{customer_id}/customColumns/{custom_column_id}" + }; + + // Immutable. The resource name of the custom column. + // Custom column resource names have the form: + // + // `customers/{customer_id}/customColumns/{custom_column_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CustomColumn" + } + ]; + + // Output only. ID of the custom column. + int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. User-defined name of the custom column. + string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. User-defined description of the custom column. + string description = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The type of the result value of the custom column. + google.ads.searchads360.v0.enums.CustomColumnValueTypeEnum.CustomColumnValueType value_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. True when the custom column is referring to one or more attributes. + bool references_attributes = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. True when the custom column is referring to one or more metrics. + bool references_metrics = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. True when the custom column is available to be used in the query of + // SearchAds360Service.Search and SearchAds360Service.SearchStream. + bool queryable = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The list of the referenced system columns of this custom column. + // For example, A custom column "sum of impressions and clicks" has referenced + // system columns of {"metrics.clicks", "metrics.impressions"}. + repeated string referenced_system_columns = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/customer.proto b/google/ads/searchads360/v0/resources/customer.proto new file mode 100644 index 000000000..08624588a --- /dev/null +++ b/google/ads/searchads360/v0/resources/customer.proto @@ -0,0 +1,158 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/account_status.proto"; +import "google/ads/searchads360/v0/enums/account_type.proto"; +import "google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto"; +import "google/ads/searchads360/v0/enums/customer_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CustomerProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Customer resource. + +// A customer. +message Customer { + option (google.api.resource) = { + type: "searchads360.googleapis.com/Customer" + pattern: "customers/{customer_id}" + }; + + // Immutable. The resource name of the customer. + // Customer resource names have the form: + // + // `customers/{customer_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Customer" + } + ]; + + // Output only. The ID of the customer. + optional int64 id = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional, non-unique descriptive name of the customer. + optional string descriptive_name = 20; + + // Immutable. The currency in which the account operates. + // A subset of the currency codes from the ISO 4217 standard is + // supported. + optional string currency_code = 21 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. The local timezone ID of the customer. + optional string time_zone = 22 [(google.api.field_behavior) = IMMUTABLE]; + + // The URL template for constructing a tracking URL out of parameters. + optional string tracking_url_template = 23; + + // The URL template for appending params to the final URL + 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 is a manager. + optional bool manager = 27 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Conversion tracking setting for a customer. + ConversionTrackingSetting conversion_tracking_setting = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo + // Japan, Baidu, Facebook, Engine Track, etc. + google.ads.searchads360.v0.enums.AccountTypeEnum.AccountType account_type = 31 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer. + DoubleClickCampaignManagerSetting double_click_campaign_manager_setting = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Account status, for example, Enabled, Paused, Removed, etc. + google.ads.searchads360.v0.enums.AccountStatusEnum.AccountStatus account_status = 33 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The datetime when this customer was last modified. The datetime is in the + // customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. + string last_modified_time = 34 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. ID of the account in the external engine account. + string engine_id = 35 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The status of the customer. + google.ads.searchads360.v0.enums.CustomerStatusEnum.CustomerStatus status = 36 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// A collection of customer-wide settings related to Search Ads 360 Conversion +// Tracking. +message ConversionTrackingSetting { + // 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 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 google_ads_cross_account_conversion_tracking_id = 4 [(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. + optional int64 cross_account_conversion_tracking_id = 37 [(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]; + + // 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.searchads360.v0.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]; + + // 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]; +} + +// DoubleClick Campaign Manager (DCM) setting for a manager customer. +message DoubleClickCampaignManagerSetting { + // Output only. ID of the Campaign Manager advertiser associated with this customer. + int64 advertiser_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. ID of the Campaign Manager network associated with this customer. + int64 network_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time zone of the Campaign Manager network associated with this customer in + // IANA Time Zone Database format, such as America/New_York. + string time_zone = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/customer_client.proto b/google/ads/searchads360/v0/resources/customer_client.proto new file mode 100644 index 000000000..89df35a44 --- /dev/null +++ b/google/ads/searchads360/v0/resources/customer_client.proto @@ -0,0 +1,104 @@ +// 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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/customer_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CustomerClientProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the CustomerClient resource. + +// A link between the given customer and a client customer. CustomerClients only +// exist for manager customers. All direct and indirect client customers are +// included, as well as the manager itself. +message CustomerClient { + option (google.api.resource) = { + type: "searchads360.googleapis.com/CustomerClient" + pattern: "customers/{customer_id}/customerClients/{client_external_customer_id}" + }; + + // Output only. The resource name of the customer client. + // CustomerClient resource names have the form: + // `customers/{customer_id}/customerClients/{client_customer_id}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CustomerClient" + } + ]; + + // Output only. The resource name of the client-customer which is linked to + // the given customer. Read only. + optional string client_customer = 12 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Customer" + } + ]; + + // Output only. Specifies whether this is a hidden account. + // + // 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. + 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, 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. + optional bool test_account = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Identifies if the client is a manager. Read only. + 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]; + + // 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: + // + // `customers/{customer_id}/labels/{label_id}` + repeated string applied_labels = 21 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Label" + } + ]; + + // Output only. The status of the client customer. Read only. + google.ads.searchads360.v0.enums.CustomerStatusEnum.CustomerStatus status = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/resources/customer_manager_link.proto b/google/ads/searchads360/v0/resources/customer_manager_link.proto new file mode 100644 index 000000000..6cccf51a0 --- /dev/null +++ b/google/ads/searchads360/v0/resources/customer_manager_link.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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/manager_link_status.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "CustomerManagerLinkProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the CustomerManagerLink resource. + +// Represents customer-manager link relationship. +message CustomerManagerLink { + option (google.api.resource) = { + type: "searchads360.googleapis.com/CustomerManagerLink" + pattern: "customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}" + }; + + // Immutable. Name of the resource. + // CustomerManagerLink resource names have the form: + // `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}` + string resource_name = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CustomerManagerLink" + } + ]; + + // Output only. The manager customer linked to the customer. + optional string manager_customer = 6 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/Customer" + } + ]; + + // 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]; + + // Status of the link between the customer and the manager. + google.ads.searchads360.v0.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5; +} diff --git a/google/ads/searchads360/v0/resources/keyword_view.proto b/google/ads/searchads360/v0/resources/keyword_view.proto new file mode 100644 index 000000000..243aa3c2b --- /dev/null +++ b/google/ads/searchads360/v0/resources/keyword_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.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "KeywordViewProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the keyword view resource. + +// A keyword view. +message KeywordView { + option (google.api.resource) = { + type: "searchads360.googleapis.com/KeywordView" + pattern: "customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}" + }; + + // Output only. The resource name of the keyword view. + // Keyword view resource names have the form: + // + // `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/KeywordView" + } + ]; +} diff --git a/google/ads/searchads360/v0/resources/product_group_view.proto b/google/ads/searchads360/v0/resources/product_group_view.proto new file mode 100644 index 000000000..4fc2c313d --- /dev/null +++ b/google/ads/searchads360/v0/resources/product_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.searchads360.v0.resources; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "ProductGroupViewProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the ProductGroup View resource. + +// A product group view. +message ProductGroupView { + option (google.api.resource) = { + type: "searchads360.googleapis.com/ProductGroupView" + pattern: "customers/{customer_id}/productGroupViews/{adgroup_id}~{criterion_id}" + }; + + // Output only. The resource name of the product group view. + // Product group view resource names have the form: + // + // `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/ProductGroupView" + } + ]; +} diff --git a/google/ads/searchads360/v0/resources/search_ads360_field.proto b/google/ads/searchads360/v0/resources/search_ads360_field.proto new file mode 100644 index 000000000..88dcf931c --- /dev/null +++ b/google/ads/searchads360/v0/resources/search_ads360_field.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.searchads360.v0.resources; + +import "google/ads/searchads360/v0/enums/search_ads360_field_category.proto"; +import "google/ads/searchads360/v0/enums/search_ads360_field_data_type.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "SearchAds360FieldProto"; +option java_package = "com.google.ads.searchads360.v0.resources"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; +option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; + +// Proto file describing the Search Ads 360 Field resource. + +// A field or resource (artifact) used by SearchAds360Service. +message SearchAds360Field { + option (google.api.resource) = { + type: "searchads360.googleapis.com/SearchAds360Field" + pattern: "searchAds360Fields/{search_ads_360_field}" + }; + + // Output only. The resource name of the artifact. + // Artifact resource names have the form: + // + // `SearchAds360Fields/{name}` + string resource_name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/SearchAds360Field" + } + ]; + + // Output only. The name of the artifact. + optional string name = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The category of the artifact. + google.ads.searchads360.v0.enums.SearchAds360FieldCategoryEnum.SearchAds360FieldCategory category = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the artifact can be used in a SELECT clause in search + // queries. + optional bool selectable = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the artifact can be used in a WHERE clause in search + // 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. + 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 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]; + + // 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. + 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. + // + // 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.searchads360.v0.enums.SearchAds360FieldDataTypeEnum.SearchAds360FieldDataType 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]; + + // Output only. Whether the field artifact is repeated. + optional bool is_repeated = 31 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/searchads360/v0/searchads360_grpc_service_config.json b/google/ads/searchads360/v0/searchads360_grpc_service_config.json new file mode 100644 index 000000000..4c9b2571b --- /dev/null +++ b/google/ads/searchads360/v0/searchads360_grpc_service_config.json @@ -0,0 +1,27 @@ +{ + "methodConfig": [ + { + "name": [ + { + "service": "google.ads.searchads360.v0.services.CustomColumnService" + }, + { + "service": "google.ads.searchads360.v0.services.SearchAds360FieldService" + }, + { + "service": "google.ads.searchads360.v0.services.SearchAds360Service" + } + ], + "timeout": "3600s", + "retryPolicy": { + "initialBackoff": "5s", + "maxBackoff": "60s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": [ + "UNAVAILABLE", + "DEADLINE_EXCEEDED" + ] + } + } + ] +} diff --git a/google/ads/searchads360/v0/searchads360_v0.yaml b/google/ads/searchads360/v0/searchads360_v0.yaml new file mode 100644 index 000000000..bf098136b --- /dev/null +++ b/google/ads/searchads360/v0/searchads360_v0.yaml @@ -0,0 +1,56 @@ +type: google.api.Service +config_version: 3 +name: searchads360.googleapis.com +title: Search Ads 360 Reporting API + +apis: +- name: google.ads.searchads360.v0.services.CustomColumnService +- name: google.ads.searchads360.v0.services.SearchAds360FieldService +- name: google.ads.searchads360.v0.services.SearchAds360Service + +documentation: + summary: |- + The Search Ads 360 API allows developers to automate downloading reports + from Search Ads 360. + +backend: + rules: + - selector: google.ads.searchads360.v0.services.CustomColumnService.GetCustomColumn + deadline: 600.0 + - selector: google.ads.searchads360.v0.services.CustomColumnService.ListCustomColumns + deadline: 600.0 + - selector: google.ads.searchads360.v0.services.SearchAds360FieldService.GetSearchAds360Field + deadline: 600.0 + - selector: google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields + deadline: 600.0 + - selector: google.ads.searchads360.v0.services.SearchAds360Service.Search + deadline: 3600.0 + - selector: google.ads.searchads360.v0.services.SearchAds360Service.SearchStream + deadline: 3600.0 + +authentication: + rules: + - selector: google.ads.searchads360.v0.services.CustomColumnService.GetCustomColumn + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch + - selector: google.ads.searchads360.v0.services.CustomColumnService.ListCustomColumns + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch + - selector: google.ads.searchads360.v0.services.SearchAds360FieldService.GetSearchAds360Field + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch + - selector: google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch + - selector: google.ads.searchads360.v0.services.SearchAds360Service.Search + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch + - selector: google.ads.searchads360.v0.services.SearchAds360Service.SearchStream + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/doubleclicksearch diff --git a/google/ads/searchads360/v0/services/BUILD.bazel b/google/ads/searchads360/v0/services/BUILD.bazel new file mode 100644 index 000000000..ce918f2ce --- /dev/null +++ b/google/ads/searchads360/v0/services/BUILD.bazel @@ -0,0 +1,111 @@ +# 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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +package(default_visibility = ["//visibility:public"]) + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") + +proto_library( + name = "services_proto", + srcs = glob(["*.proto"]), + deps = [ + "//google/ads/searchads360/v0/common:common_proto", + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/ads/searchads360/v0/resources:resources_proto", + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "@com_google_protobuf//:field_mask_proto", + ], +) + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_grpc_library", + "java_proto_library", +) + +java_proto_library( + name = "services_java_proto", + deps = [":services_proto"], +) + +java_grpc_library( + name = "services_java_grpc", + srcs = [":services_proto"], + deps = [":services_java_proto"], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +moved_proto_library( + name = "services_moved_proto", + srcs = [":services_proto"], + deps = [ + "//google/ads/searchads360/v0/common:common_proto", + "//google/ads/searchads360/v0/enums:enums_proto", + "//google/ads/searchads360/v0/resources:resources_proto", + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "@com_google_protobuf//:field_mask_proto", + ], +) + +py_proto_library( + name = "services_py_proto", + deps = [":services_moved_proto"], +) + +py_grpc_library( + name = "services_py_grpc", + srcs = [":services_moved_proto"], + deps = [":services_py_proto"], +) + +############################################################################## +# C# +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", +) + +csharp_proto_library( + name = "services_csharp_proto", + deps = [":services_proto"], +) + +csharp_grpc_library( + name = "services_csharp_grpc", + srcs = [":services_proto"], + deps = [":services_csharp_proto"], +) \ No newline at end of file diff --git a/google/ads/searchads360/v0/services/custom_column_service.proto b/google/ads/searchads360/v0/services/custom_column_service.proto new file mode 100644 index 000000000..0944d89ba --- /dev/null +++ b/google/ads/searchads360/v0/services/custom_column_service.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.searchads360.v0.services; + +import "google/ads/searchads360/v0/resources/custom_column.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.SearchAds360.V0.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/services;services"; +option java_multiple_files = true; +option java_outer_classname = "CustomColumnServiceProto"; +option java_package = "com.google.ads.searchads360.v0.services"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Services"; +option ruby_package = "Google::Ads::SearchAds360::V0::Services"; + +// Proto file describing the Custom Column service. + +// Service to manage custom columns. +service CustomColumnService { + option (google.api.default_host) = "searchads360.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/doubleclicksearch"; + + // Returns the requested custom column in full detail. + rpc GetCustomColumn(GetCustomColumnRequest) returns (google.ads.searchads360.v0.resources.CustomColumn) { + option (google.api.http) = { + get: "/v0/{resource_name=customers/*/customColumns/*}" + }; + option (google.api.method_signature) = "resource_name"; + } + + // Returns all the custom columns associated with the customer in full detail. + rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse) { + option (google.api.http) = { + get: "/v0/customers/{customer_id=*}/customColumns" + }; + option (google.api.method_signature) = "customer_id"; + } +} + +// Request message for [CustomColumnService.GetCustomColumn][google.ads.searchads360.v0.services.CustomColumnService.GetCustomColumn]. +message GetCustomColumnRequest { + // Required. The resource name of the custom column to fetch. + string resource_name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/CustomColumn" + } + ]; +} + +// Request message for [CustomColumnService.ListCustomColumns][google.ads.searchads360.v0.services.CustomColumnService.ListCustomColumns] +message ListCustomColumnsRequest { + // Required. The ID of the customer to apply the CustomColumn list operation to. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for fetching all custom columns associated with a customer. +message ListCustomColumnsResponse { + // The CustomColumns owned by the provided customer. + repeated google.ads.searchads360.v0.resources.CustomColumn custom_columns = 1; +} diff --git a/google/ads/searchads360/v0/services/search_ads360_field_service.proto b/google/ads/searchads360/v0/services/search_ads360_field_service.proto new file mode 100644 index 000000000..1032b9d22 --- /dev/null +++ b/google/ads/searchads360/v0/services/search_ads360_field_service.proto @@ -0,0 +1,115 @@ +// 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.searchads360.v0.services; + +import "google/ads/searchads360/v0/resources/search_ads360_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.SearchAds360.V0.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/services;services"; +option java_multiple_files = true; +option java_outer_classname = "SearchAds360FieldServiceProto"; +option java_package = "com.google.ads.searchads360.v0.services"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Services"; +option ruby_package = "Google::Ads::SearchAds360::V0::Services"; + +// Proto file describing the SearchAds360FieldService. + +// Service to fetch Search Ads 360 API fields. +service SearchAds360FieldService { + option (google.api.default_host) = "searchads360.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/doubleclicksearch"; + + // Returns just the requested field. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (google.ads.searchads360.v0.resources.SearchAds360Field) { + option (google.api.http) = { + get: "/v0/{resource_name=searchAds360Fields/*}" + }; + option (google.api.method_signature) = "resource_name"; + } + + // Returns all fields that match the search query. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QueryError]() + // [QuotaError]() + // [RequestError]() + rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse) { + option (google.api.http) = { + post: "/v0/searchAds360Fields:search" + body: "*" + }; + option (google.api.method_signature) = "query"; + } +} + +// Request message for [SearchAds360FieldService.GetSearchAds360Field][google.ads.searchads360.v0.services.SearchAds360FieldService.GetSearchAds360Field]. +message GetSearchAds360FieldRequest { + // Required. The resource name of the field to get. + string resource_name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "searchads360.googleapis.com/SearchAds360Field" + } + ]; +} + +// Request message for [SearchAds360FieldService.SearchSearchAds360Fields][google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields]. +message SearchSearchAds360FieldsRequest { + // Required. The query string. + string query = 1 [(google.api.field_behavior) = REQUIRED]; + + // 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 too large a page is requested, the server may decide to further + // limit the number of returned resources. + int32 page_size = 3; +} + +// Response message for [SearchAds360FieldService.SearchSearchAds360Fields][google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields]. +message SearchSearchAds360FieldsResponse { + // The list of fields that matched the query. + repeated google.ads.searchads360.v0.resources.SearchAds360Field 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. + // `next_page_token` is not returned for the last page. + string next_page_token = 2; + + // Total number of results that match the query ignoring the LIMIT clause. + int64 total_results_count = 3; +} diff --git a/google/ads/searchads360/v0/services/search_ads360_service.proto b/google/ads/searchads360/v0/services/search_ads360_service.proto new file mode 100644 index 000000000..16dad927f --- /dev/null +++ b/google/ads/searchads360/v0/services/search_ads360_service.proto @@ -0,0 +1,254 @@ +// 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.searchads360.v0.services; + +import "google/ads/searchads360/v0/common/metrics.proto"; +import "google/ads/searchads360/v0/common/segments.proto"; +import "google/ads/searchads360/v0/common/value.proto"; +import "google/ads/searchads360/v0/enums/summary_row_setting.proto"; +import "google/ads/searchads360/v0/resources/ad_group.proto"; +import "google/ads/searchads360/v0/resources/ad_group_bid_modifier.proto"; +import "google/ads/searchads360/v0/resources/ad_group_criterion.proto"; +import "google/ads/searchads360/v0/resources/bidding_strategy.proto"; +import "google/ads/searchads360/v0/resources/campaign.proto"; +import "google/ads/searchads360/v0/resources/campaign_budget.proto"; +import "google/ads/searchads360/v0/resources/campaign_criterion.proto"; +import "google/ads/searchads360/v0/resources/conversion_action.proto"; +import "google/ads/searchads360/v0/resources/customer.proto"; +import "google/ads/searchads360/v0/resources/customer_client.proto"; +import "google/ads/searchads360/v0/resources/customer_manager_link.proto"; +import "google/ads/searchads360/v0/resources/keyword_view.proto"; +import "google/ads/searchads360/v0/resources/product_group_view.proto"; +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/protobuf/field_mask.proto"; + +option csharp_namespace = "Google.Ads.SearchAds360.V0.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/services;services"; +option java_multiple_files = true; +option java_outer_classname = "SearchAds360ServiceProto"; +option java_package = "com.google.ads.searchads360.v0.services"; +option objc_class_prefix = "GASA360"; +option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Services"; +option ruby_package = "Google::Ads::SearchAds360::V0::Services"; + +// Proto file describing the SearchAds360Service. + +// Service to fetch data and metrics across resources. +service SearchAds360Service { + option (google.api.default_host) = "searchads360.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/doubleclicksearch"; + + // Returns all rows that match the search query. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QueryError]() + // [QuotaError]() + // [RequestError]() + rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response) { + option (google.api.http) = { + post: "/v0/customers/{customer_id=*}/searchAds360:search" + body: "*" + }; + option (google.api.method_signature) = "customer_id,query"; + } + + // Returns all rows that match the search stream query. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QueryError]() + // [QuotaError]() + // [RequestError]() + rpc SearchStream(SearchSearchAds360StreamRequest) returns (stream SearchSearchAds360StreamResponse) { + option (google.api.http) = { + post: "/v0/customers/{customer_id=*}/searchAds360:searchStream" + body: "*" + }; + option (google.api.method_signature) = "customer_id,query"; + } +} + +// Request message for [SearchAds360Service.Search][google.ads.searchads360.v0.services.SearchAds360Service.Search]. +message SearchSearchAds360Request { + // Required. The ID of the customer being queried. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The query string. + string query = 2 [(google.api.field_behavior) = REQUIRED]; + + // 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 = 3; + + // Number of elements to retrieve in a single page. + // When too large a page is requested, the server may decide to + // further limit the number of returned resources. + int32 page_size = 4; + + // If true, the request is validated but not executed. + bool validate_only = 5; + + // If true, the total number of results that match the query ignoring the + // LIMIT clause will be included in the response. + // Default is false. + bool return_total_results_count = 7; + + // 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.searchads360.v0.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8; +} + +// Response message for [SearchAds360Service.Search][google.ads.searchads360.v0.services.SearchAds360Service.Search]. +message SearchSearchAds360Response { + // The list of rows that matched the query. + repeated SearchAds360Row 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. `next_page_token` is not returned for the last + // page. + string next_page_token = 2; + + // Total number of results that match the query ignoring the LIMIT + // clause. + int64 total_results_count = 3; + + // FieldMask that represents what fields were requested by the user. + google.protobuf.FieldMask field_mask = 5; + + // Summary row that contains summary of metrics in results. + // Summary of metrics means aggregation of metrics across all results, + // here aggregation could be sum, average, rate, etc. + SearchAds360Row summary_row = 6; + + // The headers of the custom columns in the results. + repeated CustomColumnHeader custom_column_headers = 7; +} + +// Request message for [SearchAds360Service.SearchStream][google.ads.searchads360.v0.services.SearchAds360Service.SearchStream]. +message SearchSearchAds360StreamRequest { + // Required. The ID of the customer being queried. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The query string. + string query = 2 [(google.api.field_behavior) = REQUIRED]; + + // The number of rows that are returned in each stream response batch. + // When too large batch is requested, the server may decide to further limit + // the number of returned rows. + int32 batch_size = 4; + + // 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.searchads360.v0.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3; +} + +// Response message for [SearchAds360Service.SearchStream][google.ads.searchads360.v0.services.SearchAds360Service.SearchStream]. +message SearchSearchAds360StreamResponse { + // The list of rows that matched the query. + repeated SearchAds360Row results = 1; + + // FieldMask that represents what fields were requested by the user. + google.protobuf.FieldMask field_mask = 2; + + // Summary row that contains summary of metrics in results. + // Summary of metrics means aggregation of metrics across all results, + // here aggregation could be sum, average, rate, etc. + SearchAds360Row summary_row = 3; + + // The headers of the custom columns in the results. + repeated CustomColumnHeader custom_column_headers = 5; + + // The unique id of the request that is used for debugging purposes. + string request_id = 4; +} + +// A returned row from the query. +message SearchAds360Row { + // The ad group referenced in the query. + google.ads.searchads360.v0.resources.AdGroup ad_group = 3; + + // The bid modifier referenced in the query. + google.ads.searchads360.v0.resources.AdGroupBidModifier ad_group_bid_modifier = 24; + + // The criterion referenced in the query. + google.ads.searchads360.v0.resources.AdGroupCriterion ad_group_criterion = 17; + + // The bidding strategy referenced in the query. + google.ads.searchads360.v0.resources.BiddingStrategy bidding_strategy = 18; + + // The campaign budget referenced in the query. + google.ads.searchads360.v0.resources.CampaignBudget campaign_budget = 19; + + // The campaign referenced in the query. + google.ads.searchads360.v0.resources.Campaign campaign = 2; + + // The campaign criterion referenced in the query. + google.ads.searchads360.v0.resources.CampaignCriterion campaign_criterion = 20; + + // The conversion action referenced in the query. + google.ads.searchads360.v0.resources.ConversionAction conversion_action = 103; + + // The customer referenced in the query. + google.ads.searchads360.v0.resources.Customer customer = 1; + + // The CustomerManagerLink referenced in the query. + google.ads.searchads360.v0.resources.CustomerManagerLink customer_manager_link = 61; + + // The CustomerClient referenced in the query. + google.ads.searchads360.v0.resources.CustomerClient customer_client = 70; + + // The keyword view referenced in the query. + google.ads.searchads360.v0.resources.KeywordView keyword_view = 21; + + // The product group view referenced in the query. + google.ads.searchads360.v0.resources.ProductGroupView product_group_view = 54; + + // The metrics. + google.ads.searchads360.v0.common.Metrics metrics = 4; + + // The segments. + google.ads.searchads360.v0.common.Segments segments = 102; + + // The custom columns. + repeated google.ads.searchads360.v0.common.Value custom_columns = 156; +} + +// Message for custom column header. +message CustomColumnHeader { + // The custom column ID. + int64 id = 1; + + // The user defined name of the custom column. + string name = 2; + + // True when the custom column references metrics. + bool references_metrics = 3; +} diff --git a/google/analytics/admin/v1alpha/BUILD.bazel b/google/analytics/admin/v1alpha/BUILD.bazel index 47c65d60c..c654fc9fb 100644 --- a/google/analytics/admin/v1alpha/BUILD.bazel +++ b/google/analytics/admin/v1alpha/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( srcs = [":admin_proto_with_info"], gapic_yaml = "analyticsadmin_gapic.yaml", grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", test_deps = [ ":admin_java_grpc", @@ -135,6 +136,7 @@ go_gapic_library( grpc_service_config = "admin_grpc_service_config.json", importpath = "google.golang.org/google/analytics/admin/v1alpha;admin", metadata = True, + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -175,6 +177,7 @@ py_gapic_library( name = "admin_py_gapic", srcs = [":admin_proto"], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -225,7 +228,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "admin_grpc_service_config.json", package = "google.analytics.admin.v1alpha", + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -302,6 +309,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-analytics-admin-v1alpha", ], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Analytics Admin API allows for programmatic access to the Google Analytics App+Web configuration data. You can use the Google Analytics Admin API to manage accounts and App+Web properties.", ruby_cloud_title = "Google Analytics Admin V1alpha", service_yaml = "analyticsadmin_v1alpha.yaml", @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin_v1alpha.yaml", deps = [ ":admin_csharp_grpc", diff --git a/google/analytics/admin/v1beta/BUILD.bazel b/google/analytics/admin/v1beta/BUILD.bazel index 3184ca8f3..cc5b7e46b 100644 --- a/google/analytics/admin/v1beta/BUILD.bazel +++ b/google/analytics/admin/v1beta/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":admin_proto_with_info"], gapic_yaml = None, grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", test_deps = [ ":admin_java_grpc", @@ -132,6 +133,7 @@ go_gapic_library( grpc_service_config = "admin_grpc_service_config.json", importpath = "google.golang.org/google/analytics/admin/v1beta;admin", metadata = True, + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", transport = "grpc+rest", deps = [ @@ -171,6 +173,7 @@ py_gapic_library( name = "admin_py_gapic", srcs = [":admin_proto"], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", transport = "grpc+rest", ) @@ -219,7 +222,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -252,7 +257,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "admin_grpc_service_config.json", package = "google.analytics.admin.v1beta", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-analytics-admin-v1beta", ], grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", deps = [ ":admin_ruby_grpc", @@ -337,6 +345,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsadmin.yaml", deps = [ ":admin_csharp_grpc", diff --git a/google/analytics/data/v1alpha/BUILD.bazel b/google/analytics/data/v1alpha/BUILD.bazel index f1adcb879..e580f6420 100644 --- a/google/analytics/data/v1alpha/BUILD.bazel +++ b/google/analytics/data/v1alpha/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "data_proto", @@ -39,18 +70,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "data_java_proto", deps = [":data_proto"], @@ -67,6 +86,7 @@ java_gapic_library( srcs = [":data_proto_with_info"], gapic_yaml = None, grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", test_deps = [ ":data_java_grpc", @@ -90,6 +110,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-analytics-data-v1alpha-java", + include_samples = True, transport = "grpc+rest", deps = [ ":data_java_gapic", @@ -99,17 +120,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "data_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -126,6 +136,7 @@ go_gapic_library( grpc_service_config = "analytics_data_grpc_service_config.json", importpath = "google.golang.org/google/analytics/data/v1alpha;data", metadata = True, + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -152,20 +163,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "data_py_gapic", srcs = [":data_proto"], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", transport = "grpc+rest", ) @@ -188,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "data_php_proto", deps = [":data_proto"], @@ -214,7 +205,9 @@ php_gapic_library( name = "data_php_gapic", srcs = [":data_proto_with_info"], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":data_php_grpc", ":data_php_proto", @@ -231,15 +224,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "data_nodejs_gapic", package_name = "@google-cloud/data", @@ -247,7 +231,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "analytics_data_grpc_service_config.json", package = "google.analytics.data.v1alpha", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -259,17 +245,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "data_ruby_proto", deps = [":data_proto"], @@ -288,6 +263,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-analytics-data-v1alpha", ], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":data_ruby_grpc", ":data_ruby_proto", @@ -304,17 +280,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "data_csharp_proto", deps = [":data_proto"], @@ -331,6 +296,7 @@ csharp_gapic_library( srcs = [":data_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1alpha.yaml", deps = [ ":data_csharp_grpc", @@ -348,15 +314,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "data_cc_proto", deps = [":data_proto"], diff --git a/google/analytics/data/v1beta/BUILD.bazel b/google/analytics/data/v1beta/BUILD.bazel index 1ad3cb2ff..b5719c8b5 100644 --- a/google/analytics/data/v1beta/BUILD.bazel +++ b/google/analytics/data/v1beta/BUILD.bazel @@ -66,13 +66,17 @@ java_grpc_library( java_gapic_library( name = "data_java_gapic", srcs = [":data_proto_with_info"], + gapic_yaml = None, grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "analyticsdata_v1beta.yaml", test_deps = [ ":data_java_grpc", ], transport = "grpc+rest", deps = [ ":data_java_proto", + "//google/api:api_java_proto", ], ) @@ -88,6 +92,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-analytics-data-v1beta-java", + include_samples = True, transport = "grpc+rest", deps = [ ":data_java_gapic", @@ -124,6 +129,7 @@ go_gapic_library( grpc_service_config = "analytics_data_grpc_service_config.json", importpath = "google.golang.org/google/analytics/data/v1beta;data", metadata = True, + rest_numeric_enums = True, service_yaml = "analyticsdata_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -163,7 +169,11 @@ py_gapic_library( name = "data_py_gapic", srcs = [":data_proto"], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "analyticsdata_v1beta.yaml", transport = "grpc+rest", + deps = [ + ], ) py_test( @@ -210,6 +220,9 @@ php_gapic_library( name = "data_php_gapic", srcs = [":data_proto_with_info"], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "analyticsdata_v1beta.yaml", + transport = "grpc+rest", deps = [ ":data_php_grpc", ":data_php_proto", @@ -242,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "analytics_data_grpc_service_config.json", package = "google.analytics.data.v1beta", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -280,16 +295,18 @@ ruby_cloud_gapic_library( name = "data_ruby_gapic", srcs = [":data_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-analytics-data-v1beta", - "ruby-cloud-env-prefix=ANALYTICS_DATA", - "ruby-cloud-product-url=https://developers.google.com/analytics/devguides/reporting/data/v1", "ruby-cloud-api-id=analyticsdata.googleapis.com", "ruby-cloud-api-shortname=analyticsdata", + "ruby-cloud-env-prefix=ANALYTICS_DATA", + "ruby-cloud-gem-name=google-analytics-data-v1beta", + "ruby-cloud-product-url=https://developers.google.com/analytics/devguides/reporting/data/v1", "ruby-cloud-service-override=BetaAnalyticsData=AnalyticsData", ], grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Google Analytics Data API provides programmatic methods to access report data in Google Analytics 4 (GA4) properties. Google Analytics 4 helps you understand how people use your web, iOS, or Android app.", ruby_cloud_title = "Google Analytics Data V1beta", + service_yaml = "analyticsdata_v1beta.yaml", deps = [ ":data_ruby_grpc", ":data_ruby_proto", @@ -333,6 +350,7 @@ csharp_gapic_library( srcs = [":data_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "analytics_data_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "analyticsdata_v1beta.yaml", deps = [ ":data_csharp_grpc", @@ -353,4 +371,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "data_cc_proto", + deps = [":data_proto"], +) + +cc_grpc_library( + name = "data_cc_grpc", + srcs = [":data_proto"], + grpc_only = True, + deps = [":data_cc_proto"], +) diff --git a/google/analytics/data/v1beta/analytics_data_api.proto b/google/analytics/data/v1beta/analytics_data_api.proto index b32577e76..e5ee72cca 100644 --- a/google/analytics/data/v1beta/analytics_data_api.proto +++ b/google/analytics/data/v1beta/analytics_data_api.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. @@ -41,6 +41,10 @@ service BetaAnalyticsData { // measurements of user activity on your property, such as active users or // event count. Dimensions break down metrics across some common criteria, // such as country or event name. + // + // For a guide to constructing requests & understanding responses, see + // [Creating a + // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). rpc RunReport(RunReportRequest) returns (RunReportResponse) { option (google.api.http) = { post: "/v1beta/{property=properties/*}:runReport" @@ -95,9 +99,15 @@ service BetaAnalyticsData { option (google.api.method_signature) = "name"; } - // The Google Analytics Realtime API returns a customized report of realtime - // event data for your property. These reports show events and usage from the - // last 30 minutes. + // Returns a customized report of realtime event data for your property. + // Events appear in realtime reports seconds after they have been sent to + // the Google Analytics. Realtime reports show events and usage data for the + // periods of time ranging from the present moment to 30 minutes ago (up to + // 60 minutes for Google Analytics 360 properties). + // + // For a guide to constructing realtime requests & understanding responses, + // see [Creating a Realtime + // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). rpc RunRealtimeReport(RunRealtimeReportRequest) returns (RunRealtimeReportResponse) { option (google.api.http) = { post: "/v1beta/{property=properties/*}:runRealtimeReport" @@ -219,8 +229,8 @@ message RunReportRequest { // for examples. Metrics cannot be used in this filter. FilterExpression dimension_filter = 5; - // The filter clause of metrics. Applied at post aggregation phase, similar to - // SQL having-clause. Dimensions cannot be used in this filter. + // The filter clause of metrics. Applied after aggregating the report's rows, + // similar to SQL having-clause. Dimensions cannot be used in this filter. FilterExpression metric_filter = 6; // The row count of the start row. The first row is counted as row 0. @@ -542,13 +552,11 @@ message RunRealtimeReportRequest { // The metrics requested and displayed. repeated Metric metrics = 3; - // The filter clause of dimensions. Dimensions must be requested to be used in - // this filter. Metrics cannot be used in this filter. + // The filter clause of dimensions. Metrics cannot be used in this filter. FilterExpression dimension_filter = 4; // The filter clause of metrics. Applied at post aggregation phase, similar to - // SQL having-clause. Metrics must be requested to be used in this filter. - // Dimensions cannot be used in this filter. + // SQL having-clause. Dimensions cannot be used in this filter. FilterExpression metric_filter = 5; // The number of rows to return. If unspecified, 10,000 rows are returned. The diff --git a/google/analytics/data/v1beta/analytics_data_grpc_service_config.json b/google/analytics/data/v1beta/analytics_data_grpc_service_config.json index 336935108..8e1908cbf 100644 --- a/google/analytics/data/v1beta/analytics_data_grpc_service_config.json +++ b/google/analytics/data/v1beta/analytics_data_grpc_service_config.json @@ -1,7 +1,7 @@ { "methodConfig": [ { - "name": [{"service": "google.analytics.data.v1beta.BetaAnalyticsData"}], + "name": [{ "service": "google.analytics.data.v1beta.BetaAnalyticsData" }], "timeout": "60s", "retryPolicy": { "maxAttempts": 5, @@ -32,6 +32,14 @@ { "service": "google.analytics.data.v1beta.BetaAnalyticsData", "method": "RunRealtimeReport" + }, + { + "service": "google.analytics.data.v1beta.BetaAnalyticsData", + "method": "GetMetadata" + }, + { + "service": "google.analytics.data.v1beta.BetaAnalyticsData", + "method": "CheckCompatibility" } ], "timeout": "60s" diff --git a/google/analytics/data/v1beta/data.proto b/google/analytics/data/v1beta/data.proto index a33d45538..6c6431b97 100644 --- a/google/analytics/data/v1beta/data.proto +++ b/google/analytics/data/v1beta/data.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. @@ -52,8 +52,8 @@ message MinuteRange { // // If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics // properties can request up to the last 30 minutes of event data - // (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request - // up to the last 60 minutes of event data (`startMinutesAgo <= 59`). + // (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to + // the last 60 minutes of event data (`startMinutesAgo <= 59`). optional int32 start_minutes_ago = 1; // The inclusive end minute for the query as a number of minutes before now. @@ -63,8 +63,8 @@ message MinuteRange { // // If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics // properties can request any minute in the last 30 minutes of event data - // (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request - // any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). + // (`endMinutesAgo <= 29`), and 360 Analytics properties can request any + // minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). optional int32 end_minutes_ago = 2; // Assigns a name to this minute range. The dimension `dateRange` is valued to @@ -76,7 +76,7 @@ message MinuteRange { // Dimensions are attributes of your data. For example, the dimension city // indicates the city from which an event originates. Dimension values in report -// responses are strings; for example, city could be "Paris" or "New York". +// responses are strings; for example, the city could be "Paris" or "New York". // Requests are allowed up to 9 dimensions. message Dimension { // The name of the dimension. See the [API @@ -168,9 +168,8 @@ message Metric { bool invisible = 3; } -// To express dimension or metric filters. -// The fields in the same FilterExpression need to be either all dimensions or -// all metrics. +// To express dimension or metric filters. The fields in the same +// FilterExpression need to be either all dimensions or all metrics. message FilterExpression { // Specify one type of filter expression for `FilterExpression`. oneof expr { @@ -183,9 +182,8 @@ message FilterExpression { // The FilterExpression is NOT of not_expression. FilterExpression not_expression = 3; - // A primitive filter. - // All fields in filter in same FilterExpression needs to be either all - // dimensions or metrics. + // A primitive filter. In the same FilterExpression, all of the filter's + // field names need to be either all dimensions or all metrics. Filter filter = 4; } } @@ -217,10 +215,10 @@ message Filter { // Contains the string value. CONTAINS = 4; - // Full regular expression match with the string value. + // Full match for the regular expression with the string value. FULL_REGEXP = 5; - // Partial regular expression match with the string value. + // Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6; } @@ -283,8 +281,12 @@ message Filter { NumericValue to_value = 2; } - // The dimension name or metric name. Must be a name defined in dimensions - // or metrics. + // The dimension name or metric name. + // + // In most methods, dimensions & metrics can be used for the first time in + // this field. However in a RunPivotReportRequest, this field must be + // additionally specified by name in the RunPivotReportRequest's dimensions or + // metrics. string field_name = 1; // Specify one type of filter for `Filter`. @@ -303,7 +305,9 @@ message Filter { } } -// The sort options. +// Order bys define how rows will be sorted in the response. For example, +// ordering rows by descending event count is one ordering, and ordering rows by +// the event name string is a different ordering. message OrderBy { // Sorts by metric values. message MetricOrderBy { @@ -604,6 +608,16 @@ message ResponseMetaData { // If empty reason is specified, the report is empty for this reason. optional string empty_reason = 7; + + // If `subjectToThresholding` is true, this report is subject to thresholding + // and only returns data that meets the minimum aggregation thresholds. It is + // possible for a request to be subject to thresholding thresholding and no + // data is absent from the report, and this happens when all data is above the + // thresholds. To learn more, see [Data + // thresholds](https://support.google.com/analytics/answer/9383630) and [About + // Demographics and + // Interests](https://support.google.com/analytics/answer/2799357). + optional bool subject_to_thresholding = 8; } // Describes a dimension column in the report. Dimensions requested in a report @@ -732,8 +746,8 @@ message PropertyQuota { // Standard Analytics Properties can use up to 5,000 tokens per hour; // Analytics 360 Properties can use 50,000 tokens per hour. An API request - // consumes a single number of tokens, and that number is deducted from both - // the hourly and daily quotas. + // consumes a single number of tokens, and that number is deducted from all of + // the hourly, daily, and per project hourly quotas. QuotaStatus tokens_per_hour = 2; // Standard Analytics Properties can send up to 10 concurrent requests; @@ -750,6 +764,14 @@ message PropertyQuota { // is individually counted for this quota if the request contains potentially // thresholded dimensions. QuotaStatus potentially_thresholded_requests_per_hour = 5; + + // Analytics Properties can use up to 25% of their tokens per project per + // hour. This amounts to standard Analytics Properties can use up to 1,250 + // tokens per project per hour, and Analytics 360 Properties can use 12,500 + // tokens per project per hour. An API request consumes a single number of + // tokens, and that number is deducted from all of the hourly, daily, and per + // project hourly quotas. + QuotaStatus tokens_per_project_per_hour = 6; } // Current state for a particular quota group. diff --git a/google/api/BUILD.bazel b/google/api/BUILD.bazel index ebb9ba812..567b0ee4e 100644 --- a/google/api/BUILD.bazel +++ b/google/api/BUILD.bazel @@ -40,7 +40,9 @@ proto_library( name = "client_proto", srcs = ["client.proto"], deps = [ + ":launch_stage_proto", "@com_google_protobuf//:descriptor_proto", + "@com_google_protobuf//:duration_proto", ], ) @@ -197,6 +199,7 @@ proto_library( ":auth_proto", ":backend_proto", ":billing_proto", + ":client_proto", ":context_proto", ":control_proto", ":documentation_proto", @@ -352,12 +355,14 @@ go_proto_library( ":resource_proto", ":routing_proto", ], + deps = [":api_go_proto"], ) go_proto_library( name = "client_go_proto", importpath = "google.golang.org/genproto/googleapis/api/annotations;annotations", protos = [":client_proto"], + deps = [":api_go_proto"], ) go_proto_library( @@ -396,9 +401,6 @@ go_proto_library( protos = [ ":launch_stage_proto", ], - deps = [ - ":annotations_go_proto", - ], ) go_proto_library( diff --git a/google/api/apikeys/v2/BUILD.bazel b/google/api/apikeys/v2/BUILD.bazel index b2b71c0fe..70d8e2a37 100644 --- a/google/api/apikeys/v2/BUILD.bazel +++ b/google/api/apikeys/v2/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":apikeys_proto_with_info"], gapic_yaml = None, grpc_service_config = "apikeys_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", test_deps = [ ":apikeys_java_grpc", @@ -132,13 +133,14 @@ go_gapic_library( grpc_service_config = "apikeys_grpc_service_config.json", importpath = "cloud.google.com/go/api/apikeys/apiv2;apikeys", metadata = True, + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", transport = "grpc+rest", deps = [ ":apikeys_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +181,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=api_keys", ], + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", transport = "grpc+rest", deps = [], @@ -228,7 +231,9 @@ php_gapic_library( name = "apikeys_php_gapic", srcs = [":apikeys_proto_with_info"], grpc_service_config = "apikeys_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", + transport = "grpc+rest", deps = [ ":apikeys_php_grpc", ":apikeys_php_proto", @@ -261,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "apikeys_grpc_service_config.json", package = "google.api.apikeys.v2", + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/api-keys/", ], grpc_service_config = "apikeys_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "An API key is a simple encrypted string that you can use when calling Google Cloud APIs. The API Keys service manages the API keys associated with developer projects.", ruby_cloud_title = "API Keys V2", service_yaml = "apikeys_v2.yaml", @@ -351,6 +359,7 @@ csharp_gapic_library( srcs = [":apikeys_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "apikeys_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apikeys_v2.yaml", deps = [ ":apikeys_csharp_grpc", diff --git a/google/api/auth.proto b/google/api/auth.proto index 54026e1a5..21a8ce1b0 100644 --- a/google/api/auth.proto +++ b/google/api/auth.proto @@ -84,6 +84,9 @@ message JwtLocation { // Specifies URL query parameter name to extract JWT token. string query = 2; + + // Specifies cookie name to extract JWT token. + string cookie = 4; } // The value prefix. The value format is "value_prefix{token}" @@ -152,11 +155,12 @@ message AuthProvider { // Implement authorizationUrl of securityDefinitions in OpenAPI spec. string authorization_url = 5; - // Defines the locations to extract the JWT. + // Defines the locations to extract the JWT. For now it is only used by the + // Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] + // (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) // - // JWT locations can be either from HTTP headers or URL query parameters. - // The rule is that the first match wins. The checking order is: checking - // all headers first, then URL query parameters. + // JWT locations can be one of HTTP headers, URL query parameters or + // cookies. The rule is that the first match wins. // // If not specified, default to use following 3 locations: // 1) Authorization: Bearer diff --git a/google/api/backend.proto b/google/api/backend.proto index da3878698..1a3b705f6 100644 --- a/google/api/backend.proto +++ b/google/api/backend.proto @@ -120,9 +120,8 @@ message BackendRule { // varies based on the request protocol and deployment environment. double deadline = 3; - // Minimum deadline in seconds needed for this method. Calls having deadline - // value lower than this will be rejected. - double min_deadline = 4; + // Deprecated, do not use. + double min_deadline = 4 [deprecated = true]; // The number of seconds to wait for the completion of a long running // operation. The default is no deadline. diff --git a/google/api/client.proto b/google/api/client.proto index 3b3fd0c40..227ccf3a5 100644 --- a/google/api/client.proto +++ b/google/api/client.proto @@ -16,7 +16,9 @@ syntax = "proto3"; package google.api; +import "google/api/launch_stage.proto"; import "google/protobuf/descriptor.proto"; +import "google/protobuf/duration.proto"; option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations"; option java_multiple_files = true; @@ -97,3 +99,251 @@ extend google.protobuf.ServiceOptions { // } string oauth_scopes = 1050; } + +// Required information for every language. +message CommonLanguageSettings { + // Link to automatically generated reference documentation. Example: + // https://cloud.google.com/nodejs/docs/reference/asset/latest + string reference_docs_uri = 1 [deprecated = true]; + + // The destination where API teams want this client library to be published. + repeated ClientLibraryDestination destinations = 2; +} + +// Details about how and where to publish client libraries. +message ClientLibrarySettings { + // Version of the API to apply these settings to. + string version = 1; + + // Launch stage of this version of the API. + LaunchStage launch_stage = 2; + + // When using transport=rest, the client request will encode enums as + // numbers rather than strings. + bool rest_numeric_enums = 3; + + // Settings for legacy Java features, supported in the Service YAML. + JavaSettings java_settings = 21; + + // Settings for C++ client libraries. + CppSettings cpp_settings = 22; + + // Settings for PHP client libraries. + PhpSettings php_settings = 23; + + // Settings for Python client libraries. + PythonSettings python_settings = 24; + + // Settings for Node client libraries. + NodeSettings node_settings = 25; + + // Settings for .NET client libraries. + DotnetSettings dotnet_settings = 26; + + // Settings for Ruby client libraries. + RubySettings ruby_settings = 27; + + // Settings for Go client libraries. + GoSettings go_settings = 28; +} + +// This message configures the settings for publishing [Google Cloud Client +// libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) +// generated from the service config. +message Publishing { + // A list of API method settings, e.g. the behavior for methods that use the + // long-running operation pattern. + repeated MethodSettings method_settings = 2; + + // Link to a place that API users can report issues. Example: + // https://issuetracker.google.com/issues/new?component=190865&template=1161103 + string new_issue_uri = 101; + + // Link to product home page. Example: + // https://cloud.google.com/asset-inventory/docs/overview + string documentation_uri = 102; + + // Used as a tracking tag when collecting data about the APIs developer + // relations artifacts like docs, packages delivered to package managers, + // etc. Example: "speech". + string api_short_name = 103; + + // GitHub label to apply to issues and pull requests opened for this API. + string github_label = 104; + + // GitHub teams to be added to CODEOWNERS in the directory in GitHub + // containing source code for the client libraries for this API. + repeated string codeowner_github_teams = 105; + + // A prefix used in sample code when demarking regions to be included in + // documentation. + string doc_tag_prefix = 106; + + // For whom the client library is being published. + ClientLibraryOrganization organization = 107; + + // Client library settings. If the same version string appears multiple + // times in this list, then the last one wins. Settings from earlier + // settings with the same version string are discarded. + repeated ClientLibrarySettings library_settings = 109; +} + +// Settings for Java client libraries. +message JavaSettings { + // The package name to use in Java. Clobbers the java_package option + // set in the protobuf. This should be used **only** by APIs + // who have already set the language_settings.java.package_name" field + // in gapic.yaml. API teams should use the protobuf java_package option + // where possible. + // + // Example of a YAML configuration:: + // + // publishing: + // java_settings: + // library_package: com.google.cloud.pubsub.v1 + string library_package = 1; + + // Configure the Java class name to use instead of the service's for its + // corresponding generated GAPIC client. Keys are fully-qualified + // service names as they appear in the protobuf (including the full + // the language_settings.java.interface_names" field in gapic.yaml. API + // teams should otherwise use the service name as it appears in the + // protobuf. + // + // Example of a YAML configuration:: + // + // publishing: + // java_settings: + // service_class_names: + // - google.pubsub.v1.Publisher: TopicAdmin + // - google.pubsub.v1.Subscriber: SubscriptionAdmin + map service_class_names = 2; + + // Some settings. + CommonLanguageSettings common = 3; +} + +// Settings for C++ client libraries. +message CppSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Php client libraries. +message PhpSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Python client libraries. +message PythonSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Node client libraries. +message NodeSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Dotnet client libraries. +message DotnetSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Ruby client libraries. +message RubySettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Settings for Go client libraries. +message GoSettings { + // Some settings. + CommonLanguageSettings common = 1; +} + +// Describes the generator configuration for a method. +message MethodSettings { + // Describes settings to use when generating API methods that use the + // long-running operation pattern. + // All default values below are from those used in the client library + // generators (e.g. + // [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + message LongRunning { + // Initial delay after which the first poll request will be made. + // Default value: 5 seconds. + google.protobuf.Duration initial_poll_delay = 1; + + // Multiplier to gradually increase delay between subsequent polls until it + // reaches max_poll_delay. + // Default value: 1.5. + float poll_delay_multiplier = 2; + + // Maximum time between two subsequent poll requests. + // Default value: 45 seconds. + google.protobuf.Duration max_poll_delay = 3; + + // Total polling timeout. + // Default value: 5 minutes. + google.protobuf.Duration total_poll_timeout = 4; + } + + // The fully qualified name of the method, for which the options below apply. + // This is used to find the method to apply the options. + string selector = 1; + + // Describes settings to use for long-running operations when generating + // API methods for RPCs. Complements RPCs that use the annotations in + // google/longrunning/operations.proto. + // + // Example of a YAML configuration:: + // + // publishing: + // method_behavior: + // - selector: CreateAdDomain + // long_running: + // initial_poll_delay: + // seconds: 60 # 1 minute + // poll_delay_multiplier: 1.5 + // max_poll_delay: + // seconds: 360 # 6 minutes + // total_poll_timeout: + // seconds: 54000 # 90 minutes + LongRunning long_running = 2; +} + +// The organization for which the client libraries are being published. +// Affects the url where generated docs are published, etc. +enum ClientLibraryOrganization { + // Not useful. + CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0; + + // Google Cloud Platform Org. + CLOUD = 1; + + // Ads (Advertising) Org. + ADS = 2; + + // Photos Org. + PHOTOS = 3; + + // Street View Org. + STREET_VIEW = 4; +} + +// To where should client libraries be published? +enum ClientLibraryDestination { + // Client libraries will neither be generated nor published to package + // managers. + CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0; + + // Generate the client library in a repo under github.com/googleapis, + // but don't publish it to package managers. + GITHUB = 10; + + // Publish the library to package managers like nuget.org and npmjs.com. + PACKAGE_MANAGER = 20; +} diff --git a/google/api/control.proto b/google/api/control.proto index 6eb1958e3..5e14dee30 100644 --- a/google/api/control.proto +++ b/google/api/control.proto @@ -22,11 +22,15 @@ option java_outer_classname = "ControlProto"; option java_package = "com.google.api"; option objc_class_prefix = "GAPI"; -// Selects and configures the service controller used by the service. The -// service controller handles features like abuse, quota, billing, logging, -// monitoring, etc. +// Selects and configures the service controller used by the service. +// +// Example: +// +// control: +// environment: servicecontrol.googleapis.com message Control { - // The service control environment to use. If empty, no control plane - // feature (like quota and billing) will be enabled. + // The service controller environment to use. If empty, no control plane + // feature (like quota and billing) will be enabled. The recommended value for + // most services is servicecontrol.googleapis.com string environment = 1; } diff --git a/google/api/documentation.proto b/google/api/documentation.proto index 7288169be..d15562db5 100644 --- a/google/api/documentation.proto +++ b/google/api/documentation.proto @@ -78,8 +78,10 @@ option objc_class_prefix = "GAPI"; // The directive `suppress_warning` does not directly affect documentation // and is documented together with service config validation. message Documentation { - // A short summary of what the service does. Can only be provided by - // plain text. + // A short description of what the service does. The summary must be plain + // text. It becomes the overview of the service displayed in Google Cloud + // Console. + // NOTE: This field is equivalent to the standard field `description`. string summary = 1; // The top level pages for the documentation set. @@ -117,15 +119,18 @@ message Documentation { // A documentation rule provides information about individual API elements. message DocumentationRule { - // The selector is a comma-separated list of patterns. Each pattern is a - // qualified name of the element which may end in "*", indicating a wildcard. - // Wildcards are only allowed at the end and for a whole component of the - // qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A - // wildcard will match one or more components. To specify a default for all - // applicable elements, the whole pattern "*" is used. + // The selector is a comma-separated list of patterns for any element such as + // a method, a field, an enum value. Each pattern is a qualified name of the + // element which may end in "*", indicating a wildcard. Wildcards are only + // allowed at the end and for a whole component of the qualified name, + // i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match + // one or more components. To specify a default for all applicable elements, + // the whole pattern "*" is used. string selector = 1; - // Description of the selected API(s). + // Description of the selected proto element (e.g. a message, a method, a + // 'service' definition, or a field). Defaults to leading & trailing comments + // taken from the proto source definition of the proto element. string description = 2; // Deprecation description of the selected element(s). It can be provided if @@ -153,7 +158,8 @@ message Page { string name = 1; // The Markdown content of the page. You can use (== include {path} - // ==) to include content from a Markdown file. + // ==) to include content from a Markdown file. The content can be + // used to produce the documentation page such as HTML format page. string content = 2; // Subpages of this page. The order of subpages specified here will be diff --git a/google/api/endpoint.proto b/google/api/endpoint.proto index a434e8e74..3b9f6a16c 100644 --- a/google/api/endpoint.proto +++ b/google/api/endpoint.proto @@ -22,21 +22,26 @@ option java_outer_classname = "EndpointProto"; option java_package = "com.google.api"; option objc_class_prefix = "GAPI"; -// `Endpoint` describes a network endpoint of a service that serves a set of +// `Endpoint` describes a network address of a service that serves a set of // APIs. It is commonly known as a service endpoint. A service may expose // any number of service endpoints, and all service endpoints share the same // service definition, such as quota limits and monitoring metrics. // -// Example service configuration: +// Example: // +// type: google.api.Service // name: library-example.googleapis.com // endpoints: -// # Below entry makes 'google.example.library.v1.Library' -// # API be served from endpoint address library-example.googleapis.com. -// # It also allows HTTP OPTIONS calls to be passed to the backend, for -// # it to decide whether the subsequent cross-origin request is -// # allowed to proceed. +// # Declares network address `https://library-example.googleapis.com` +// # for service `library-example.googleapis.com`. The `https` scheme +// # is implicit for all service endpoints. Other schemes may be +// # supported in the future. // - name: library-example.googleapis.com +// allow_cors: false +// - name: content-staging-library-example.googleapis.com +// # Allows HTTP OPTIONS calls to be passed to the API frontend, for it +// # to decide whether the subsequent cross-origin request is allowed +// # to proceed. // allow_cors: true message Endpoint { // The canonical name of this endpoint. @@ -45,8 +50,8 @@ message Endpoint { // Unimplemented. Dot not use. // // DEPRECATED: This field is no longer supported. Instead of using aliases, - // please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended - // aliases. + // please specify multiple [google.api.Endpoint][google.api.Endpoint] for each + // of the intended aliases. // // Additional names that this endpoint will be hosted on. repeated string aliases = 2 [deprecated = true]; diff --git a/google/api/error_reason.proto b/google/api/error_reason.proto index 393c808be..3b1d0e212 100644 --- a/google/api/error_reason.proto +++ b/google/api/error_reason.proto @@ -394,4 +394,142 @@ enum ErrorReason { // } // } ACCESS_TOKEN_TYPE_UNSUPPORTED = 19; + + // The request is denied because the request doesn't have any authentication + // credentials. For more information regarding the supported authentication + // strategies for Google Cloud APIs, see + // https://cloud.google.com/docs/authentication. + // + // Example of an ErrorInfo when the request is to the Cloud Storage API + // without any authentication credentials. + // + // { "reason": "CREDENTIALS_MISSING", + // "domain": "googleapis.com", + // "metadata": { + // "service": "storage.googleapis.com", + // "method": "google.storage.v1.Storage.GetObject" + // } + // } + CREDENTIALS_MISSING = 20; + + // The request is denied because the provided project owning the resource + // which acts as the [API + // consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is + // invalid. It may be in a bad format or empty. + // + // Example of an ErrorInfo when the request is to the Cloud Functions API, + // but the offered resource project in the request in a bad format which can't + // perform the ListFunctions method. + // + // { "reason": "RESOURCE_PROJECT_INVALID", + // "domain": "googleapis.com", + // "metadata": { + // "service": "cloudfunctions.googleapis.com", + // "method": + // "google.cloud.functions.v1.CloudFunctionsService.ListFunctions" + // } + // } + RESOURCE_PROJECT_INVALID = 21; + + // The request is denied because the provided session cookie is missing, + // invalid or failed to decode. + // + // Example of an ErrorInfo when the request is calling Cloud Storage service + // with a SID cookie which can't be decoded. + // + // { "reason": "SESSION_COOKIE_INVALID", + // "domain": "googleapis.com", + // "metadata": { + // "service": "storage.googleapis.com", + // "method": "google.storage.v1.Storage.GetObject", + // "cookie": "SID" + // } + // } + SESSION_COOKIE_INVALID = 23; + + // The request is denied because the user is from a Google Workspace customer + // that blocks their users from accessing a particular service. + // + // Example scenario: https://support.google.com/a/answer/9197205?hl=en + // + // Example of an ErrorInfo when access to Google Cloud Storage service is + // blocked by the Google Workspace administrator: + // + // { "reason": "USER_BLOCKED_BY_ADMIN", + // "domain": "googleapis.com", + // "metadata": { + // "service": "storage.googleapis.com", + // "method": "google.storage.v1.Storage.GetObject", + // } + // } + USER_BLOCKED_BY_ADMIN = 24; + + // The request is denied because the resource service usage is restricted + // by administrators according to the organization policy constraint. + // For more information see + // https://cloud.google.com/resource-manager/docs/organization-policy/restricting-services. + // + // Example of an ErrorInfo when access to Google Cloud Storage service is + // restricted by Resource Usage Restriction policy: + // + // { "reason": "RESOURCE_USAGE_RESTRICTION_VIOLATED", + // "domain": "googleapis.com", + // "metadata": { + // "consumer": "projects/project-123", + // "service": "storage.googleapis.com" + // } + // } + RESOURCE_USAGE_RESTRICTION_VIOLATED = 25; + + // Unimplemented. Do not use. + // + // The request is denied because it contains unsupported system parameters in + // URL query parameters or HTTP headers. For more information, + // see https://cloud.google.com/apis/docs/system-parameters + // + // Example of an ErrorInfo when access "pubsub.googleapis.com" service with + // a request header of "x-goog-user-ip": + // + // { "reason": "SYSTEM_PARAMETER_UNSUPPORTED", + // "domain": "googleapis.com", + // "metadata": { + // "service": "pubsub.googleapis.com" + // "parameter": "x-goog-user-ip" + // } + // } + SYSTEM_PARAMETER_UNSUPPORTED = 26; + + // The request is denied because it violates Org Restriction: the requested + // resource does not belong to allowed organizations specified in + // "X-Goog-Allowed-Resources" header. + // + // Example of an ErrorInfo when accessing a GCP resource that is restricted by + // Org Restriction for "pubsub.googleapis.com" service. + // + // { + // reason: "ORG_RESTRICTION_VIOLATION" + // domain: "googleapis.com" + // metadata { + // "consumer":"projects/123456" + // "service": "pubsub.googleapis.com" + // } + // } + ORG_RESTRICTION_VIOLATION = 27; + + // The request is denied because "X-Goog-Allowed-Resources" header is in a bad + // format. + // + // Example of an ErrorInfo when + // accessing "pubsub.googleapis.com" service with an invalid + // "X-Goog-Allowed-Resources" request header. + // + // { + // reason: "ORG_RESTRICTION_HEADER_INVALID" + // domain: "googleapis.com" + // metadata { + // "consumer":"projects/123456" + // "service": "pubsub.googleapis.com" + // } + // } + ORG_RESTRICTION_HEADER_INVALID = 28; } diff --git a/google/api/expr/v1alpha1/syntax.proto b/google/api/expr/v1alpha1/syntax.proto index c234a02e3..8219ba689 100644 --- a/google/api/expr/v1alpha1/syntax.proto +++ b/google/api/expr/v1alpha1/syntax.proto @@ -104,6 +104,14 @@ message Expr { message CreateList { // The elements part of the list. repeated Expr elements = 1; + + // The indices within the elements list which are marked as optional + // elements. + // + // When an optional-typed value is present, the value it contains + // is included in the list. If the optional-typed value is absent, the list + // element is omitted from the CreateList result. + repeated int32 optional_indices = 2; } // A map or message creation expression. diff --git a/google/api/launch_stage.proto b/google/api/launch_stage.proto index cca8419a9..6524db575 100644 --- a/google/api/launch_stage.proto +++ b/google/api/launch_stage.proto @@ -23,7 +23,7 @@ option java_package = "com.google.api"; option objc_class_prefix = "GAPI"; // The launch stage as defined by [Google Cloud Platform -// Launch Stages](http://cloud.google.com/terms/launch-stages). +// Launch Stages](https://cloud.google.com/terms/launch-stages). enum LaunchStage { // Do not use this default value. LAUNCH_STAGE_UNSPECIFIED = 0; @@ -45,7 +45,7 @@ enum LaunchStage { // for widespread use. By Alpha, all significant design issues are resolved // and we are in the process of verifying functionality. Alpha customers // need to apply for access, agree to applicable terms, and have their - // projects allowlisted. Alpha releases don’t have to be feature complete, + // projects allowlisted. Alpha releases don't have to be feature complete, // no SLAs are provided, and there are no technical support obligations, but // they will be far enough along that customers can actually use them in // test environments or for limited-use tests -- just like they would in @@ -64,7 +64,7 @@ enum LaunchStage { GA = 4; // Deprecated features are scheduled to be shut down and removed. For more - // information, see the “Deprecation Policy” section of our [Terms of + // information, see the "Deprecation Policy" section of our [Terms of // Service](https://cloud.google.com/terms/) // and the [Google Cloud Platform Subject to the Deprecation // Policy](https://cloud.google.com/terms/deprecation) documentation. diff --git a/google/api/metric.proto b/google/api/metric.proto index aadc19677..c206666f6 100644 --- a/google/api/metric.proto +++ b/google/api/metric.proto @@ -31,23 +31,6 @@ option objc_class_prefix = "GAPI"; // existing data unusable. // message MetricDescriptor { - // Additional annotations that can be used to guide the usage of a metric. - message MetricDescriptorMetadata { - // Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead. - LaunchStage launch_stage = 1 [deprecated = true]; - - // The sampling period of metric data points. For metrics which are written - // periodically, consecutive data points are stored at this time interval, - // excluding data loss due to errors. Metrics with a higher granularity have - // a smaller sampling period. - google.protobuf.Duration sample_period = 2; - - // The delay of data points caused by ingestion. Data points older than this - // age are guaranteed to be ingested and available to be read, excluding - // data loss due to errors. - google.protobuf.Duration ingest_delay = 3; - } - // The kind of measurement. It describes how the data is reported. // For information on setting the start time and end time based on // the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval]. @@ -95,6 +78,23 @@ message MetricDescriptor { MONEY = 6; } + // Additional annotations that can be used to guide the usage of a metric. + message MetricDescriptorMetadata { + // Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead. + LaunchStage launch_stage = 1 [deprecated = true]; + + // The sampling period of metric data points. For metrics which are written + // periodically, consecutive data points are stored at this time interval, + // excluding data loss due to errors. Metrics with a higher granularity have + // a smaller sampling period. + google.protobuf.Duration sample_period = 2; + + // The delay of data points caused by ingestion. Data points older than this + // age are guaranteed to be ingested and available to be read, excluding + // data loss due to errors. + google.protobuf.Duration ingest_delay = 3; + } + // The resource name of the metric descriptor. string name = 1; diff --git a/google/api/monitored_resource.proto b/google/api/monitored_resource.proto index bd5be4e4e..8b97baa10 100644 --- a/google/api/monitored_resource.proto +++ b/google/api/monitored_resource.proto @@ -48,6 +48,10 @@ message MonitoredResourceDescriptor { // Required. The monitored resource type. For example, the type // `"cloudsql_database"` represents databases in Google Cloud SQL. + // For a list of types, see [Monitoring resource + // types](https://cloud.google.com/monitoring/api/resources) + // and [Logging resource + // types](https://cloud.google.com/logging/docs/api/v2/resource-list). string type = 1; // Optional. A concise name for the monitored resource type that might be @@ -77,15 +81,18 @@ message MonitoredResourceDescriptor { // its attributes according to the schema. For example, a particular Compute // Engine VM instance could be represented by the following object, because the // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for `"gce_instance"` has labels -// `"instance_id"` and `"zone"`: +// `"project_id"`, `"instance_id"` and `"zone"`: // // { "type": "gce_instance", -// "labels": { "instance_id": "12345678901234", +// "labels": { "project_id": "my-project", +// "instance_id": "12345678901234", // "zone": "us-central1-a" }} message MonitoredResource { // Required. The monitored resource type. This field must match // the `type` field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For // example, the type of a Compute Engine VM instance is `gce_instance`. + // Some descriptors include the service name in the type; for example, + // the type of a Datastream stream is `datastream.googleapis.com/Stream`. string type = 1; // Required. Values for all of the labels listed in the associated monitored diff --git a/google/api/quota.proto b/google/api/quota.proto index dae89de30..3272cdae5 100644 --- a/google/api/quota.proto +++ b/google/api/quota.proto @@ -44,10 +44,10 @@ option objc_class_prefix = "GAPI"; // STANDARD: 10000 // // -// # The metric rules bind all methods to the read_calls metric, -// # except for the UpdateBook and DeleteBook methods. These two methods -// # are mapped to the write_calls metric, with the UpdateBook method -// # consuming at twice rate as the DeleteBook method. +// (The metric rules bind all methods to the read_calls metric, +// except for the UpdateBook and DeleteBook methods. These two methods +// are mapped to the write_calls metric, with the UpdateBook method +// consuming at twice rate as the DeleteBook method.) // metric_rules: // - selector: "*" // metric_costs: @@ -74,10 +74,10 @@ option objc_class_prefix = "GAPI"; // // message Quota { - // List of `QuotaLimit` definitions for the service. + // List of QuotaLimit definitions for the service. repeated QuotaLimit limits = 3; - // List of `MetricRule` definitions, each one mapping a selected method to one + // List of MetricRule definitions, each one mapping a selected method to one // or more metrics. repeated MetricRule metric_rules = 4; } diff --git a/google/api/service.proto b/google/api/service.proto index 7cae8a944..a90186342 100644 --- a/google/api/service.proto +++ b/google/api/service.proto @@ -19,6 +19,7 @@ package google.api; import "google/api/auth.proto"; import "google/api/backend.proto"; import "google/api/billing.proto"; +import "google/api/client.proto"; import "google/api/context.proto"; import "google/api/control.proto"; import "google/api/documentation.proto"; @@ -43,11 +44,12 @@ option java_outer_classname = "ServiceProto"; option java_package = "com.google.api"; option objc_class_prefix = "GAPI"; -// `Service` is the root object of Google service configuration schema. It -// describes basic information about a service, such as the name and the -// title, and delegates other aspects to sub-sections. Each sub-section is -// either a proto message or a repeated proto message that configures a -// specific aspect, such as auth. See each proto message definition for details. +// `Service` is the root object of Google API service configuration (service +// config). It describes the basic information about a logical service, +// such as the service name and the user-facing title, and delegates other +// aspects to sub-sections. Each sub-section is either a proto message or a +// repeated proto message that configures a specific aspect, such as auth. +// For more information, see each proto message definition. // // Example: // @@ -56,6 +58,16 @@ option objc_class_prefix = "GAPI"; // title: Google Calendar API // apis: // - name: google.calendar.v3.Calendar +// +// visibility: +// rules: +// - selector: "google.calendar.v3.*" +// restriction: PREVIEW +// backend: +// rules: +// - selector: "google.calendar.v3.*" +// address: calendar.example.com +// // authentication: // providers: // - id: google_calendar_auth @@ -72,7 +84,8 @@ message Service { // of the service also owns the DNS name. string name = 1; - // The product title for this service. + // The product title for this service, it is the name displayed in Google + // Cloud Console. string title = 2; // The Google project that owns this service. @@ -92,19 +105,19 @@ message Service { repeated google.protobuf.Api apis = 3; // A list of all proto message types included in this API service. - // Types referenced directly or indirectly by the `apis` are - // automatically included. Messages which are not referenced but - // shall be included, such as types used by the `google.protobuf.Any` type, - // should be listed here by name. Example: + // Types referenced directly or indirectly by the `apis` are automatically + // included. Messages which are not referenced but shall be included, such as + // types used by the `google.protobuf.Any` type, should be listed here by + // name by the configuration author. Example: // // types: // - name: google.protobuf.Int32 repeated google.protobuf.Type types = 4; - // A list of all enum types included in this API service. Enums - // referenced directly or indirectly by the `apis` are automatically - // included. Enums which are not referenced but shall be included - // should be listed here by name. Example: + // A list of all enum types included in this API service. Enums referenced + // directly or indirectly by the `apis` are automatically included. Enums + // which are not referenced but shall be included should be listed here by + // name by the configuration author. Example: // // enums: // - name: google.someapi.v1.SomeEnum @@ -164,9 +177,14 @@ message Service { // Output only. The source information for this configuration if available. SourceInfo source_info = 37; + // Settings for [Google Cloud Client + // libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + // generated from APIs defined as protocol buffers. + Publishing publishing = 45; + // Obsolete. Do not use. // // This field has no semantic meaning. The service config compiler always // sets this field to `3`. - google.protobuf.UInt32Value config_version = 20 [deprecated = true]; + google.protobuf.UInt32Value config_version = 20; } diff --git a/google/api/serviceconfig.yaml b/google/api/serviceconfig.yaml index 054295e4f..f7b0fcadb 100644 --- a/google/api/serviceconfig.yaml +++ b/google/api/serviceconfig.yaml @@ -15,6 +15,7 @@ types: - name: google.api.MonitoredResourceMetadata - name: google.api.ResourceDescriptor - name: google.api.ResourceReference +- name: google.api.RoutingRule - name: google.api.Service - name: google.api.Visibility diff --git a/google/api/servicecontrol/v1/BUILD.bazel b/google/api/servicecontrol/v1/BUILD.bazel index a603fe7fe..65e16f71c 100644 --- a/google/api/servicecontrol/v1/BUILD.bazel +++ b/google/api/servicecontrol/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "servicecontrol_proto", @@ -51,18 +82,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "servicecontrol_java_proto", deps = [":servicecontrol_proto"], @@ -78,6 +97,7 @@ java_gapic_library( name = "servicecontrol_java_gapic", srcs = [":servicecontrol_proto_with_info"], grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":servicecontrol_java_grpc", ], @@ -101,6 +121,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-api-servicecontrol-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":servicecontrol_java_gapic", @@ -110,17 +131,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "servicecontrol_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -140,6 +150,7 @@ go_gapic_library( grpc_service_config = "servicecontrol_grpc_service_config.json", importpath = "cloud.google.com/go/api/servicecontrol/apiv1;servicecontrol", metadata = True, + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", transport = "grpc+rest", deps = [ @@ -166,16 +177,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "servicecontrol_py_gapic", srcs = [":servicecontrol_proto"], @@ -185,6 +186,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-service-control", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -206,17 +208,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_php_proto", deps = [":servicecontrol_proto"], @@ -232,7 +223,9 @@ php_gapic_library( name = "servicecontrol_php_gapic", srcs = [":servicecontrol_proto_with_info"], grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", + transport = "grpc+rest", deps = [ ":servicecontrol_php_grpc", ":servicecontrol_php_proto", @@ -249,15 +242,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "servicecontrol_nodejs_gapic", package_name = "@google-cloud/service-control", @@ -265,7 +249,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "servicecontrol_grpc_service_config.json", package = "google.api.servicecontrol.v1", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", + transport = "grpc+rest", deps = [], ) @@ -279,17 +265,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_ruby_proto", deps = [":servicecontrol_proto"], @@ -312,6 +287,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/service-infrastructure/docs/overview/", ], grpc_service_config = "servicecontrol_grpc_service_config.json", + 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", deps = [ @@ -330,17 +306,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_csharp_proto", deps = [":servicecontrol_proto"], @@ -357,6 +322,7 @@ csharp_gapic_library( srcs = [":servicecontrol_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", deps = [ ":servicecontrol_csharp_grpc", @@ -374,15 +340,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "servicecontrol_cc_proto", deps = [":servicecontrol_proto"], diff --git a/google/api/servicecontrol/v2/BUILD.bazel b/google/api/servicecontrol/v2/BUILD.bazel index 8fec05fb7..f905d8c4b 100644 --- a/google/api/servicecontrol/v2/BUILD.bazel +++ b/google/api/servicecontrol/v2/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "servicecontrol_proto", @@ -39,18 +70,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "servicecontrol_java_proto", deps = [":servicecontrol_proto"], @@ -67,6 +86,7 @@ java_gapic_library( srcs = [":servicecontrol_proto_with_info"], gapic_yaml = None, grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", test_deps = [ ":servicecontrol_java_grpc", @@ -91,6 +111,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-api-servicecontrol-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":servicecontrol_java_gapic", @@ -100,17 +121,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "servicecontrol_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -129,6 +139,7 @@ go_gapic_library( grpc_service_config = "servicecontrol_grpc_service_config.json", importpath = "cloud.google.com/go/api/servicecontrol/apiv2;servicecontrol", metadata = True, + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", transport = "grpc+rest", deps = [ @@ -154,16 +165,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "servicecontrol_py_gapic", srcs = [":servicecontrol_proto"], @@ -173,6 +174,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-service-control", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -194,17 +196,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_php_proto", deps = [":servicecontrol_proto"], @@ -220,7 +211,9 @@ php_gapic_library( name = "servicecontrol_php_gapic", srcs = [":servicecontrol_proto_with_info"], grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", + transport = "grpc+rest", deps = [ ":servicecontrol_php_grpc", ":servicecontrol_php_proto", @@ -237,15 +230,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "servicecontrol_nodejs_gapic", package_name = "@google-cloud/servicecontrol", @@ -253,7 +237,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "servicecontrol_grpc_service_config.json", package = "google.api.servicecontrol.v2", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", + transport = "grpc+rest", deps = [], ) @@ -265,17 +251,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_ruby_proto", deps = [":servicecontrol_proto"], @@ -298,6 +273,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/service-infrastructure/docs/overview/", ], grpc_service_config = "servicecontrol_grpc_service_config.json", + 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", deps = [ @@ -316,17 +292,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicecontrol_csharp_proto", deps = [":servicecontrol_proto"], @@ -343,6 +308,7 @@ csharp_gapic_library( srcs = [":servicecontrol_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "servicecontrol_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicecontrol.yaml", deps = [ ":servicecontrol_csharp_grpc", @@ -360,15 +326,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "servicecontrol_cc_proto", deps = [":servicecontrol_proto"], diff --git a/google/api/servicemanagement/v1/BUILD.bazel b/google/api/servicemanagement/v1/BUILD.bazel index 3e2431097..5a9137005 100644 --- a/google/api/servicemanagement/v1/BUILD.bazel +++ b/google/api/servicemanagement/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "servicemanagement_proto", @@ -44,18 +75,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "servicemanagement_java_proto", deps = [":servicemanagement_proto"], @@ -72,6 +91,7 @@ java_gapic_library( srcs = [":servicemanagement_proto_with_info"], gapic_yaml = "servicemanagement_gapic.yaml", grpc_service_config = "servicemanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicemanagement_v1.yaml", test_deps = [ ":servicemanagement_java_grpc", @@ -95,6 +115,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-api-servicemanagement-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":servicemanagement_java_gapic", @@ -104,17 +125,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "servicemanagement_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -134,14 +144,15 @@ go_gapic_library( grpc_service_config = "servicemanagement_grpc_service_config.json", importpath = "cloud.google.com/go/api/servicemanagement/apiv1;servicemanagement", metadata = True, + rest_numeric_enums = True, service_yaml = "servicemanagement_v1.yaml", transport = "grpc+rest", deps = [ ":servicemanagement_go_proto", "//google/api:serviceconfig_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -164,16 +175,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "servicemanagement_py_gapic", srcs = [":servicemanagement_proto"], @@ -183,6 +184,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-service-management", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -204,17 +206,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicemanagement_php_proto", deps = [":servicemanagement_proto"], @@ -230,7 +221,9 @@ php_gapic_library( name = "servicemanagement_php_gapic", srcs = [":servicemanagement_proto_with_info"], grpc_service_config = "servicemanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicemanagement_v1.yaml", + transport = "grpc+rest", deps = [ ":servicemanagement_php_grpc", ":servicemanagement_php_proto", @@ -247,15 +240,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "servicemanagement_nodejs_gapic", package_name = "@google-cloud/service-management", @@ -263,7 +247,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "servicemanagement_grpc_service_config.json", package = "google.api.servicemanagement.v1", + rest_numeric_enums = True, service_yaml = "servicemanagement_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -275,17 +261,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicemanagement_ruby_proto", deps = [":servicemanagement_proto"], @@ -308,6 +283,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/service-infrastructure/docs/overview/", ], grpc_service_config = "servicemanagement_grpc_service_config.json", + 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", deps = [ @@ -326,17 +302,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "servicemanagement_csharp_proto", deps = [":servicemanagement_proto"], @@ -353,6 +318,7 @@ csharp_gapic_library( srcs = [":servicemanagement_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "servicemanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicemanagement_v1.yaml", deps = [ ":servicemanagement_csharp_grpc", @@ -370,15 +336,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "servicemanagement_cc_proto", deps = [":servicemanagement_proto"], diff --git a/google/api/serviceusage/v1/BUILD.bazel b/google/api/serviceusage/v1/BUILD.bazel index 8c25c297f..07c6885ab 100644 --- a/google/api/serviceusage/v1/BUILD.bazel +++ b/google/api/serviceusage/v1/BUILD.bazel @@ -9,14 +9,41 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "serviceusage_proto", @@ -47,18 +74,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "serviceusage_java_proto", deps = [":serviceusage_proto"], @@ -74,6 +89,7 @@ java_gapic_library( name = "serviceusage_java_gapic", srcs = [":serviceusage_proto_with_info"], grpc_service_config = "serviceusage_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":serviceusage_java_grpc", ], @@ -95,6 +111,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-api-serviceusage-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":serviceusage_java_gapic", @@ -143,8 +160,8 @@ java_gapic_assembly_gradle_pkg( # deps = [ # ":serviceusage_go_proto", # "//google/longrunning:longrunning_go_proto", -# "@com_google_cloud_go//longrunning/autogen:go_default_library", -# "@com_google_cloud_go//longrunning:go_default_library", +# "@com_google_cloud_go_longrunning//autogen:go_default_library", +# "@com_google_cloud_go_longrunning//:go_default_library", # ], # ) @@ -166,16 +183,6 @@ java_gapic_assembly_gradle_pkg( # ], # ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "serviceusage_py_gapic", srcs = [":serviceusage_proto"], @@ -185,6 +192,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=service_usage", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -206,17 +214,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_php_proto", deps = [":serviceusage_proto"], @@ -232,7 +229,9 @@ php_gapic_library( name = "serviceusage_php_gapic", srcs = [":serviceusage_proto_with_info"], grpc_service_config = "serviceusage_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "serviceusage_v1.yaml", + transport = "grpc+rest", deps = [ ":serviceusage_php_grpc", ":serviceusage_php_proto", @@ -249,15 +248,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "serviceusage_nodejs_gapic", package_name = "@google-cloud/service-usage", @@ -265,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "serviceusage_grpc_service_config.json", package = "google.api.serviceusage.v1", + rest_numeric_enums = True, service_yaml = "serviceusage_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,17 +269,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_ruby_proto", deps = [":serviceusage_proto"], @@ -310,6 +291,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=serviceusage", ], grpc_service_config = "serviceusage_grpc_service_config.json", + 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", deps = [ @@ -328,17 +310,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_csharp_proto", deps = [":serviceusage_proto"], @@ -355,6 +326,7 @@ csharp_gapic_library( srcs = [":serviceusage_proto_with_info"], 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", deps = [ ":serviceusage_csharp_grpc", @@ -372,15 +344,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "serviceusage_cc_proto", deps = [":serviceusage_proto"], diff --git a/google/api/serviceusage/v1beta1/BUILD.bazel b/google/api/serviceusage/v1beta1/BUILD.bazel index 56d11deca..f604ae790 100644 --- a/google/api/serviceusage/v1beta1/BUILD.bazel +++ b/google/api/serviceusage/v1beta1/BUILD.bazel @@ -9,14 +9,42 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "serviceusage_proto", @@ -49,18 +77,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "serviceusage_java_proto", deps = [":serviceusage_proto"], @@ -76,6 +92,7 @@ java_gapic_library( name = "serviceusage_java_gapic", srcs = [":serviceusage_proto_with_info"], grpc_service_config = "serviceusage_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":serviceusage_java_grpc", ], @@ -97,6 +114,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-api-serviceusage-v1beta1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":serviceusage_java_gapic", @@ -106,17 +124,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "serviceusage_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -136,13 +143,14 @@ go_gapic_library( grpc_service_config = "serviceusage_grpc_service_config.json", importpath = "cloud.google.com/go/api/serviceusage/apiv1beta1;serviceusage", metadata = True, + rest_numeric_enums = True, service_yaml = "serviceusage_v1beta1.yaml", transport = "grpc+rest", deps = [ ":serviceusage_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -164,19 +172,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "serviceusage_py_gapic", srcs = [":serviceusage_proto"], grpc_service_config = "serviceusage_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -199,17 +199,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_php_proto", deps = [":serviceusage_proto"], @@ -225,7 +214,9 @@ php_gapic_library( name = "serviceusage_php_gapic", srcs = [":serviceusage_proto_with_info"], grpc_service_config = "serviceusage_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "serviceusage_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":serviceusage_php_grpc", ":serviceusage_php_proto", @@ -242,15 +233,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "serviceusage_nodejs_gapic", package_name = "@google-cloud/service-usage", @@ -258,7 +240,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "serviceusage_grpc_service_config.json", package = "google.api.serviceusage.v1beta1", + rest_numeric_enums = True, service_yaml = "serviceusage_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -270,17 +254,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_ruby_proto", deps = [":serviceusage_proto"], @@ -303,6 +276,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=serviceusage", ], grpc_service_config = "serviceusage_grpc_service_config.json", + 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", deps = [ @@ -321,17 +295,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "serviceusage_csharp_proto", deps = [":serviceusage_proto"], @@ -348,6 +311,7 @@ csharp_gapic_library( srcs = [":serviceusage_proto_with_info"], 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_v1beta1.yaml", deps = [ ":serviceusage_csharp_grpc", diff --git a/google/api/visibility.proto b/google/api/visibility.proto index bde48dd20..0be4581d1 100644 --- a/google/api/visibility.proto +++ b/google/api/visibility.proto @@ -55,16 +55,17 @@ extend google.protobuf.ServiceOptions { google.api.VisibilityRule api_visibility = 72295727; } -// `Visibility` defines restrictions for the visibility of service -// elements. Restrictions are specified using visibility labels -// (e.g., PREVIEW) that are elsewhere linked to users and projects. +// `Visibility` restricts service consumer's access to service elements, +// such as whether an application can call a visibility-restricted method. +// The restriction is expressed by applying visibility labels on service +// elements. The visibility labels are elsewhere linked to service consumers. // -// Users and projects can have access to more than one visibility label. The -// effective visibility for multiple labels is the union of each label's -// elements, plus any unrestricted elements. +// A service can define multiple visibility labels, but a service consumer +// should be granted at most one visibility label. Multiple visibility +// labels for a single service consumer are not supported. // -// If an element and its parents have no restrictions, visibility is -// unconditionally granted. +// If an element and all its parents have no visibility label, its visibility +// is unconditionally granted. // // Example: // @@ -89,7 +90,8 @@ message Visibility { message VisibilityRule { // Selects methods, messages, fields, enums, etc. to which this rule applies. // - // Refer to [selector][google.api.DocumentationRule.selector] for syntax details. + // Refer to [selector][google.api.DocumentationRule.selector] for syntax + // details. string selector = 1; // A comma-separated list of visibility labels that apply to the `selector`. diff --git a/google/appengine/logging/v1/BUILD.bazel b/google/appengine/logging/v1/BUILD.bazel index 2ea7513bf..71007e905 100644 --- a/google/appengine/logging/v1/BUILD.bazel +++ b/google/appengine/logging/v1/BUILD.bazel @@ -75,6 +75,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=appengine_logging", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/appengine/v1/BUILD.bazel b/google/appengine/v1/BUILD.bazel index 37463b636..aac92a8a2 100644 --- a/google/appengine/v1/BUILD.bazel +++ b/google/appengine/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "appengine_proto", @@ -59,18 +90,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "appengine_java_proto", deps = [":appengine_proto"], @@ -86,6 +105,7 @@ java_gapic_library( name = "appengine_java_gapic", srcs = [":appengine_proto_with_info"], grpc_service_config = "appengine_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":appengine_java_grpc", ], @@ -121,6 +141,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-appengine-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":appengine_java_gapic", @@ -130,17 +151,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "appengine_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -158,13 +168,14 @@ go_gapic_library( grpc_service_config = "appengine_grpc_service_config.json", importpath = "cloud.google.com/go/appengine/apiv1;appengine", metadata = True, + rest_numeric_enums = True, service_yaml = "appengine_v1.yaml", transport = "grpc+rest", deps = [ ":appengine_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -187,16 +198,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "appengine_py_gapic", srcs = [":appengine_proto"], @@ -206,6 +207,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=appengine_admin", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -227,17 +229,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "appengine_php_proto", deps = [":appengine_proto"], @@ -253,7 +244,9 @@ php_gapic_library( name = "appengine_php_gapic", srcs = [":appengine_proto_with_info"], grpc_service_config = "appengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "appengine_v1.yaml", + transport = "grpc+rest", deps = [ ":appengine_php_grpc", ":appengine_php_proto", @@ -270,15 +263,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "appengine_nodejs_gapic", package_name = "@google-cloud/appengine-admin", @@ -286,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "appengine_grpc_service_config.json", package = "google.appengine.v1", + rest_numeric_enums = True, service_yaml = "appengine_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -298,17 +284,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "appengine_ruby_proto", deps = [":appengine_proto"], @@ -330,6 +305,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-id=appengine.googleapis.com", "ruby-cloud-api-shortname=appengine", ], + 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", deps = [ @@ -348,17 +324,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "appengine_csharp_proto", deps = [":appengine_proto"], @@ -375,6 +340,7 @@ csharp_gapic_library( srcs = [":appengine_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "appengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "appengine_v1.yaml", deps = [ ":appengine_csharp_grpc", @@ -392,15 +358,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "appengine_cc_proto", deps = [":appengine_proto"], diff --git a/google/apps/alertcenter/v1beta1/BUILD.bazel b/google/apps/alertcenter/v1beta1/BUILD.bazel index d83f6f71e..7b2e6c27a 100644 --- a/google/apps/alertcenter/v1beta1/BUILD.bazel +++ b/google/apps/alertcenter/v1beta1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "alertcenter_proto", @@ -42,18 +71,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "alertcenter_java_proto", deps = [":alertcenter_proto"], @@ -69,6 +86,7 @@ java_gapic_library( name = "alertcenter_java_gapic", srcs = [":alertcenter_proto_with_info"], grpc_service_config = "alertcenter_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":alertcenter_java_grpc", ], @@ -90,6 +108,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-apps-alertcenter-v1beta1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":alertcenter_java_gapic", @@ -99,17 +118,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "alertcenter_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -127,6 +135,7 @@ go_gapic_library( grpc_service_config = "alertcenter_grpc_service_config.json", importpath = "google.golang.org/google/apps/alertcenter/v1beta1;alertcenter", metadata = True, + rest_numeric_enums = True, service_yaml = "alertcenter.yaml", transport = "grpc+rest", deps = [ @@ -152,20 +161,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "alertcenter_py_gapic", srcs = [":alertcenter_proto"], grpc_service_config = "alertcenter_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -187,17 +187,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "alertcenter_php_proto", deps = [":alertcenter_proto"], @@ -213,7 +202,9 @@ php_gapic_library( name = "alertcenter_php_gapic", srcs = [":alertcenter_proto_with_info"], grpc_service_config = "alertcenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "alertcenter.yaml", + transport = "grpc+rest", deps = [ ":alertcenter_php_grpc", ":alertcenter_php_proto", @@ -230,15 +221,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "alertcenter_nodejs_gapic", package_name = "@google-cloud/alertcenter", @@ -246,7 +228,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "alertcenter_grpc_service_config.json", package = "google.apps.alertcenter.v1beta1", + rest_numeric_enums = True, service_yaml = "alertcenter.yaml", + transport = "grpc+rest", deps = [], ) @@ -258,17 +242,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "alertcenter_ruby_proto", deps = [":alertcenter_proto"], @@ -287,6 +260,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-apps-alertcenter-v1beta1", ], grpc_service_config = "alertcenter_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":alertcenter_ruby_grpc", ":alertcenter_ruby_proto", @@ -303,17 +277,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "alertcenter_csharp_proto", deps = [":alertcenter_proto"], @@ -330,6 +293,7 @@ csharp_gapic_library( srcs = [":alertcenter_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "alertcenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "alertcenter.yaml", deps = [ ":alertcenter_csharp_grpc", diff --git a/google/apps/drive/activity/v2/BUILD.bazel b/google/apps/drive/activity/v2/BUILD.bazel index d25367d1b..b2d1846b5 100644 --- a/google/apps/drive/activity/v2/BUILD.bazel +++ b/google/apps/drive/activity/v2/BUILD.bazel @@ -72,7 +72,7 @@ java_gapic_library( srcs = [":activity_proto_with_info"], gapic_yaml = None, grpc_service_config = "driveactivity_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", test_deps = [ ":activity_java_grpc", @@ -133,7 +133,7 @@ go_gapic_library( grpc_service_config = "driveactivity_grpc_service_config.json", importpath = "google.golang.org/google/apps/drive/activity/v2;activity", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", transport = "grpc+rest", deps = [ @@ -173,7 +173,7 @@ py_gapic_library( name = "activity_py_gapic", srcs = [":activity_proto"], grpc_service_config = "driveactivity_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", transport = "grpc", deps = [ @@ -224,8 +224,9 @@ php_gapic_library( name = "activity_php_gapic", srcs = [":activity_proto_with_info"], grpc_service_config = "driveactivity_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", + transport = "grpc+rest", deps = [ ":activity_php_grpc", ":activity_php_proto", @@ -258,8 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "driveactivity_grpc_service_config.json", package = "google.apps.drive.activity.v2", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -298,7 +300,7 @@ ruby_cloud_gapic_library( srcs = [":activity_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-apps-drive-activity-v2"], grpc_service_config = "driveactivity_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", deps = [ ":activity_ruby_grpc", @@ -343,7 +345,7 @@ csharp_gapic_library( srcs = [":activity_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "driveactivity_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "driveactivity_v2.yaml", deps = [ ":activity_csharp_grpc", diff --git a/google/apps/drive/labels/v2/BUILD.bazel b/google/apps/drive/labels/v2/BUILD.bazel new file mode 100644 index 000000000..cddce245a --- /dev/null +++ b/google/apps/drive/labels/v2/BUILD.bazel @@ -0,0 +1,393 @@ +# 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 = "labels_proto", + srcs = [ + "common.proto", + "error_details.proto", + "exception_detail.proto", + "field.proto", + "label.proto", + "label_permission.proto", + "label_service.proto", + "requests.proto", + ], + deps = [ + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "//google/type:color_proto", + "//google/type:date_proto", + "@com_google_protobuf//:timestamp_proto", + ], +) + +proto_library_with_info( + name = "labels_proto_with_info", + deps = [ + ":labels_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 = "labels_java_proto", + deps = [":labels_proto"], +) + +java_grpc_library( + name = "labels_java_grpc", + srcs = [":labels_proto"], + deps = [":labels_java_proto"], +) + +java_gapic_library( + name = "labels_java_gapic", + srcs = [":labels_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + test_deps = [ + ":labels_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":labels_java_proto", + "//google/api:api_java_proto", + ], +) + +java_gapic_test( + name = "labels_java_gapic_test_suite", + test_classes = [ + "com.google.apps.drive.labels.v2.LabelServiceClientHttpJsonTest", + "com.google.apps.drive.labels.v2.LabelServiceClientTest", + ], + runtime_deps = [":labels_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-drive-labels-v2-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":labels_java_gapic", + ":labels_java_grpc", + ":labels_java_proto", + ":labels_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 = "labels_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/apps/drive/labels/v2", + protos = [":labels_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/type:color_go_proto", + "//google/type:date_go_proto", + ], +) + +go_gapic_library( + name = "labels_go_gapic", + srcs = [":labels_proto_with_info"], + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + importpath = "google.golang.org/google/apps/drive/labels/v2;labels", + metadata = True, + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + transport = "grpc+rest", + deps = [ + ":labels_go_proto", + ], +) + +go_test( + name = "labels_go_gapic_test", + srcs = [":labels_go_gapic_srcjar_test"], + embed = [":labels_go_gapic"], + importpath = "google.golang.org/google/apps/drive/labels/v2", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-drive-labels-v2-go", + deps = [ + ":labels_go_gapic", + ":labels_go_gapic_srcjar-metadata.srcjar", + ":labels_go_gapic_srcjar-test.srcjar", + ":labels_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "labels_py_gapic", + srcs = [":labels_proto"], + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + transport = "grpc+rest", + deps = [], +) + +py_test( + name = "labels_py_gapic_test", + srcs = [ + "labels_py_gapic_pytest.py", + "labels_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":labels_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "drive-labels-v2-py", + deps = [ + ":labels_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 = "labels_php_proto", + deps = [":labels_proto"], +) + +php_grpc_library( + name = "labels_php_grpc", + srcs = [":labels_proto"], + deps = [":labels_php_proto"], +) + +php_gapic_library( + name = "labels_php_gapic", + srcs = [":labels_proto_with_info"], + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + transport = "grpc+rest", + deps = [ + ":labels_php_grpc", + ":labels_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2-php", + deps = [ + ":labels_php_gapic", + ":labels_php_grpc", + ":labels_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "labels_nodejs_gapic", + package_name = "@google-cloud/labels", + src = ":labels_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + package = "google.apps.drive.labels.v2", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "drive-labels-v2-nodejs", + deps = [ + ":labels_nodejs_gapic", + ":labels_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 = "labels_ruby_proto", + deps = [":labels_proto"], +) + +ruby_grpc_library( + name = "labels_ruby_grpc", + srcs = [":labels_proto"], + deps = [":labels_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "labels_ruby_gapic", + srcs = [":labels_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-drive-labels-v2", + ], + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + deps = [ + ":labels_ruby_grpc", + ":labels_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2-ruby", + deps = [ + ":labels_ruby_gapic", + ":labels_ruby_grpc", + ":labels_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 = "labels_csharp_proto", + deps = [":labels_proto"], +) + +csharp_grpc_library( + name = "labels_csharp_grpc", + srcs = [":labels_proto"], + deps = [":labels_csharp_proto"], +) + +csharp_gapic_library( + name = "labels_csharp_gapic", + srcs = [":labels_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "drivelabels_v2_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2.yaml", + deps = [ + ":labels_csharp_grpc", + ":labels_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2-csharp", + deps = [ + ":labels_csharp_gapic", + ":labels_csharp_grpc", + ":labels_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "labels_cc_proto", + deps = [":labels_proto"], +) + +cc_grpc_library( + name = "labels_cc_grpc", + srcs = [":labels_proto"], + grpc_only = True, + deps = [":labels_cc_proto"], +) diff --git a/google/apps/drive/labels/v2/common.proto b/google/apps/drive/labels/v2/common.proto new file mode 100644 index 000000000..ca3a82e8a --- /dev/null +++ b/google/apps/drive/labels/v2/common.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.apps.drive.labels.v2; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/type/color.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "CommonProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "people.googleapis.com/Person" + pattern: "persons/{person}" +}; + +// The lifecycle state of an object, such as label, field, or choice. The +// lifecycle enforces the following transitions: +// +// * `UNPUBLISHED_DRAFT` (starting state) +// * `UNPUBLISHED_DRAFT` -> `PUBLISHED` +// * `UNPUBLISHED_DRAFT` -> (Deleted) +// * `PUBLISHED` -> `DISABLED` +// * `DISABLED` -> `PUBLISHED` +// * `DISABLED` -> (Deleted) +// +// The published and disabled states have some distinct characteristics: +// +// * Published—Some kinds of changes might be made to an object in this state, +// in which case `has_unpublished_changes` will be true. Also, some kinds of +// changes are not permitted. Generally, any change that would invalidate or +// cause new restrictions on existing metadata related to the label are +// rejected. +// * Disabled—When disabled, the configured `DisabledPolicy` takes effect. +message Lifecycle { + // The policy that governs how to treat a disabled label, field, or selection + // choice in different contexts. + message DisabledPolicy { + // Whether to hide this disabled object in the search menu for Drive items. + // + // * When `false`, the object is generally shown in the UI as disabled but + // it appears in the search results when searching for Drive items. + // * When `true`, the object is generally hidden in the UI when + // searching for Drive items. + bool hide_in_search = 1; + + // Whether to show this disabled object in the apply menu on Drive items. + // + // * When `true`, the object is generally shown in the UI as disabled + // and is unselectable. + // * When `false`, the object is generally hidden in the UI. + bool show_in_apply = 2; + } + + // The state of the object associated with this lifecycle. + enum State { + // Unknown State. + STATE_UNSPECIFIED = 0; + + // The initial state of an object. Once published, the object can never + // return to this state. Once an object is published, certain kinds of + // changes are no longer permitted. + UNPUBLISHED_DRAFT = 1; + + // The object has been published. The object might have unpublished draft + // changes as indicated by `has_unpublished_changes`. + PUBLISHED = 2; + + // The object has been published and has since been disabled. The object + // might have unpublished draft changes as indicated by + // `has_unpublished_changes`. + DISABLED = 3; + + // The object has been deleted. + DELETED = 4; + } + + // Output only. The state of the object associated with this lifecycle. + State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the object associated with this lifecycle has + // unpublished changes. + bool has_unpublished_changes = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The policy that governs how to show a disabled label, field, or selection + // choice. + DisabledPolicy disabled_policy = 3; +} + +// Information about a user. +message UserInfo { + // The identifier for this user that can be used with the People API to get + // more information. + // For example, people/12345678. + string person = 1 [ + (google.api.resource_reference) = { type: "people.googleapis.com/Person" } + ]; +} + +// Badge status of the label. +message BadgeConfig { + // The color of the badge. When not specified, no badge is rendered. + // The background, foreground, and solo (light and dark mode) colors set here + // are changed in the Drive UI into the closest recommended supported color. + google.type.Color color = 1; + + // Override the default global priority of this badge. + // When set to 0, the default priority heuristic is used. + int64 priority_override = 2; +} + +// The color derived from BadgeConfig and changed to the closest recommended +// supported color. +message BadgeColors { + // Output only. Badge background that pairs with the foreground. + google.type.Color background_color = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Badge foreground that pairs with the background. + google.type.Color foreground_color = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Color that can be used for text without a background. + google.type.Color solo_color = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Contains information about whether a label component should be considered +// locked. +message LockStatus { + // Output only. Indicates whether this label component is the (direct) target + // of a LabelLock. A label component can be implicitly locked even if it's + // not the direct target of a LabelLock, in which case this field is set to + // false. + bool locked = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2/drivelabels_v2.yaml b/google/apps/drive/labels/v2/drivelabels_v2.yaml new file mode 100644 index 000000000..f72affcc0 --- /dev/null +++ b/google/apps/drive/labels/v2/drivelabels_v2.yaml @@ -0,0 +1,17 @@ +type: google.api.Service +config_version: 3 +name: drivelabels.googleapis.com +title: Drive Labels API + +apis: +- name: google.apps.drive.labels.v2.LabelService + +documentation: + summary: An API for managing Drive Labels + +backend: + rules: + - selector: google.apps.drive.labels.v2.LabelService.GetLabel + deadline: 20.0 + - selector: google.apps.drive.labels.v2.LabelService.ListLabels + deadline: 20.0 diff --git a/google/apps/drive/labels/v2/drivelabels_v2_grpc_service_config.json b/google/apps/drive/labels/v2/drivelabels_v2_grpc_service_config.json new file mode 100644 index 000000000..0036e1856 --- /dev/null +++ b/google/apps/drive/labels/v2/drivelabels_v2_grpc_service_config.json @@ -0,0 +1,16 @@ +{ + "methodConfig": [{ + "name": [ + { "service": "google.apps.drive.labels.v2.LabelService.", "method": "ListLabels" }, + { "service": "google.apps.drive.labels.v2.LabelService.", "method": "GetLabel" } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }] +} \ No newline at end of file diff --git a/google/apps/drive/labels/v2/error_details.proto b/google/apps/drive/labels/v2/error_details.proto new file mode 100644 index 000000000..4d3d24672 --- /dev/null +++ b/google/apps/drive/labels/v2/error_details.proto @@ -0,0 +1,138 @@ +// 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.apps.drive.labels.v2; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "ErrorDetailsProto"; +option java_package = "com.google.apps.drive.labels.v2"; + +// Describes violations in a request to create or update a Label or its +// Fields. +message InvalidArgument { + // Describes the Field in which the violation occurred. + message FieldViolation { + // Possible reasons a field is invalid. + enum Reason { + // Unknown reason. + REASON_UNSPECIFIED = 0; + + // The referenced field is required. + FIELD_REQUIRED = 1; + + // The referenced value was invalid. + INVALID_VALUE = 2; + + // The specified numeric value is out of the allowed range. + VALUE_OUT_OF_RANGE = 3; + + // The specified string value was too long. + STRING_VALUE_TOO_LONG = 4; + + // The number of entries exceeded the maximum. + MAX_ENTRIES_EXCEEDED = 5; + + // The specified field is not found in the Label. + FIELD_NOT_FOUND = 6; + + // The specified choice is not found in the Field. + CHOICE_NOT_FOUND = 7; + } + + // The path to the field where this violation occurred. This path is + // specified using `FieldMask` format: + // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + string field = 1; + + // The detailed reason for this FieldViolation. + Reason reason = 2; + + // A message that describes the violation. This message is intended to + // be shown to end users, and is localized into the requesting user's + // preferred language. + string display_message = 3; + } + + // Describes all violations in a client request. + repeated FieldViolation field_violations = 1; +} + +// Describes what preconditions have failed. +message PreconditionFailure { + // Specific failure reason. + message Violation { + // The possible reasons a the violation occurred. + enum Reason { + // Unknown violation type. + REASON_UNSPECIFIED = 0; + + // This Resource cannot be Disabled. Only Published resources can be + // Disabled. + CANNOT_DISABLE = 1; + + // This Resource cannot be Enabled. Only Disabled resources can be + // Enabled. + CANNOT_ENABLE = 2; + + // This Resource cannot be Published. Only Draft or Disabled resources + // can be Published. + CANNOT_PUBLISH = 3; + + // This Resource cannot be Unpublished. Once published, resources may + // not be set in "Draft" state. + CANNOT_UNPUBLISH = 4; + + // This Resource cannot be Deleted. Only Disabled resources + // can be Deleted. + CANNOT_DELETE = 5; + + // The request modified a range in a Field, but the new range does + // not include the previous range. When this error happens, `field` points + // at the Field where the violation occurred. + CANNOT_RESTRICT_RANGE = 6; + + // The specified change cannot be made to published Resources. + CANNOT_CHANGE_PUBLISHED_FIELD = 7; + + // The customer cannot create new labels because the maximum number + // of labels for the customer has been reached. + CANNOT_CREATE_MORE_LABELS = 8; + + // The Field type cannot be changed because the Field has been published. + CANNOT_CHANGE_PUBLISHED_FIELD_TYPE = 9; + + // The Label component is locked and cannot be modified + CANNOT_MODIFY_LOCKED_COMPONENT = 10; + } + + // The path to the field where this violation occurred. This path is + // specified using `FieldMask` format: + // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + string field = 1; + + // The type of this violation. + Reason reason = 2; + + // A message that describes the violation. This message is intended to + // be shown to end users, and is localized into the requesting user's + // preferred language. + string display_message = 3; + } + + // Describes all violations in a client request. + repeated Violation violation = 1; +} diff --git a/google/apps/drive/labels/v2/exception_detail.proto b/google/apps/drive/labels/v2/exception_detail.proto new file mode 100644 index 000000000..85ed24c7b --- /dev/null +++ b/google/apps/drive/labels/v2/exception_detail.proto @@ -0,0 +1,117 @@ +// 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.apps.drive.labels.v2; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "ExceptionDetailProto"; +option java_package = "com.google.apps.drive.labels.v2"; + +// Every ExceptionType maps to one and only one Exception class. This allows +// internal clients to identify the exact server exception that caused the +// error for debugging and logging purposes. +// Add new ExceptionTypes to EXCEPTION_TYPE_TO_ERROR_CODE_MAP in +// j/c/g/apps/boq/metadata/model/service/exceptions/CategoryExceptionHelper +enum ExceptionType { + // Unknown ExceptionType. + EXCEPTION_TYPE_UNSPECIFIED = 0; + + // The required field is missing. + FIELD_REQUIRED = 1; + + // Unable to create a metamodel with the given ID because it already exists. + METAMODEL_ALREADY_EXISTS = 2; + + // Metamodel was not found + METAMODEL_NOT_FOUND = 3; + + // Metamodel state transition isn't allowed. + ILLEGAL_METAMODEL_STATE_TRANSITION = 4; + + // Metamodel deprecation policy is invalid. + INVALID_METAMODEL_DEPRECATION_POLICY = 5; + + // Cannot delete a metamodel due to the pending deprecation policy. + METAMODEL_DELETION_DENIED_UNTIL = 6; + + // A Field value is invalid. + INVALID_FIELD = 7; + + // Precondition failed when updating a metamodel + METAMODEL_PRECONDITION_FAILED = 8; + + // Multiple fields had the same key. + DUPLICATE_FIELD_KEY = 9; + + // Removing a field from a Metamodel (e.g. a published Metamodel) is not + // permitted. + ILLEGAL_FIELD_REMOVAL = 10; + + // Cannot specify field options for a different field type. + ILLEGAL_FIELD_OPTIONS_FOR_FIELD = 11; + + // Some changes are not supported + UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL = 12; + + // Cannot change the metamodel state in an update + ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE = 13; + + // The page token is expired + PAGE_TOKEN_EXPIRED = 14; + + // The user is not authorized to make the request. + NOT_AUTHORIZED = 15; + + // Illegal field state transition + ILLEGAL_FIELD_STATE_TRANSITION = 16; + + // Illegal choice set option state transition + ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION = 17; + + // Invalid choice set options + INVALID_CHOICE_SET_OPTIONS = 18; + + // Invalid field key + INVALID_FIELD_KEY = 19; + + // A specified property on a field is outside the allowed range. + INVALID_FIELD_PROPERTY_RANGE = 20; + + // A localized string wasn't valid. This may be because the locale is invalid, + // its missing a default value, or the translation is empty for a set locale. + INVALID_LOCALIZED_STRING = 21; + + // cannot change a property on a published field + ILLEGAL_CHANGE_TO_PUBLISHED_FIELD = 22; + + // A field update is not inclusive of the previous value + INVALID_FIELD_UPDATE_NOT_INCLUSIVE = 23; + + // A field update is not inclusive of the previous value + INVALID_CHOICE_SET_STATE = 24; + + // An unknown error occurred + INTERNAL_SERVER_ERROR = 500; +} + +// Normalized internal-only message that identifies the exact exception that +// caused the error on the server. +message ExceptionDetail { + // The type of exception that occurred. + // required + ExceptionType error_type = 1; +} diff --git a/google/apps/drive/labels/v2/field.proto b/google/apps/drive/labels/v2/field.proto new file mode 100644 index 000000000..975381e7b --- /dev/null +++ b/google/apps/drive/labels/v2/field.proto @@ -0,0 +1,382 @@ +// 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.apps.drive.labels.v2; + +import "google/api/field_behavior.proto"; +import "google/apps/drive/labels/v2/common.proto"; +import "google/protobuf/timestamp.proto"; +import "google/type/date.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "FieldProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; + +// Defines a field that has a display name, data type, and other +// configuration options. This field defines the kind of metadata that may be +// set on a Drive item. +message Field { + // The basic properties of the field. + message Properties { + // Required. The display text to show in the UI identifying this field. + string display_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Whether the field should be marked as required. + bool required = 2; + + // Input only. Insert or move this field before the indicated field. If + // empty, the field is placed at the end of the list. + string insert_before_field = 3 [(google.api.field_behavior) = INPUT_ONLY]; + } + + // UI display hints for rendering a field. + message DisplayHints { + // Whether the field should be shown as required in the UI. + bool required = 1; + + // Whether the field should be shown in the UI as disabled. + bool disabled = 2; + + // This field should be hidden in the search menu when searching for Drive + // items. + bool hidden_in_search = 3; + + // This field should be shown in the apply menu when applying values to a + // Drive item. + bool shown_in_apply = 4; + } + + // The capabilities related to this field when editing the field. + message SchemaCapabilities { + // Whether the user can change this field. + bool can_update = 1; + + // Whether the user can delete this field. + // The user must have permission and the field must be deprecated. + bool can_delete = 2; + + // Whether the user can disable this field. + // The user must have permission and this field must not already be + // disabled. + bool can_disable = 3; + + // Whether the user can enable this field. + // The user must have permission and this field must be disabled. + bool can_enable = 4; + } + + // The capabilities related to this field on applied metadata. + message AppliedCapabilities { + // Whether the user can read related applied metadata on items. + bool can_read = 1; + + // Whether the user can search for Drive items referencing this field. + bool can_search = 2; + + // Whether the user can set this field on Drive items. + bool can_write = 3; + } + + // Options for a multi-valued variant of an associated field type. + message ListOptions { + // Maximum number of entries permitted. + int32 max_entries = 1; + } + + // Options for the Text field type. + message TextOptions { + // Output only. The minimum valid length of values for the text field. + int32 min_length = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The maximum valid length of values for the text field. + int32 max_length = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the Integer field type. + message IntegerOptions { + // Output only. The minimum valid value for the integer field. + int64 min_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The maximum valid value for the integer field. + int64 max_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the date field type. + message DateOptions { + // Localized date format options. + enum DateFormat { + // Date format unspecified. + DATE_FORMAT_UNSPECIFIED = 0; + + // Includes full month name. + // For example, January 12, 1999 + // (MMMM d, y) + LONG_DATE = 1; + + // Short, numeric, representation. + // For example, 12/13/99 + // (M/d/yy) + SHORT_DATE = 2; + } + + // Localized date formatting option. Field values are rendered in + // this format according to their locale. + DateFormat date_format_type = 1; + + // Output only. ICU date format. + string date_format = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Minimum valid value (year, month, day). + google.type.Date min_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Maximum valid value (year, month, day). + google.type.Date max_value = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the selection field type. + message SelectionOptions { + // Selection field choice. + message Choice { + // Basic properties of the choice. + message Properties { + // Required. The display text to show in the UI identifying this field. + string display_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The description of this label. + string description = 2; + + // The badge configuration for this choice. When set, the + // label that owns this choice is considered a "badged label". + BadgeConfig badge_config = 3; + + // Input only. Insert or move this choice before the indicated choice. + // If empty, the choice is placed at the end of the list. + string insert_before_choice = 4 + [(google.api.field_behavior) = INPUT_ONLY]; + } + + // UI display hints for rendering an option. + message DisplayHints { + // Whether the option should be shown in the UI as disabled. + bool disabled = 1; + + // This option should be hidden in the search menu when searching for + // Drive items. + bool hidden_in_search = 2; + + // This option should be shown in the apply menu when applying values to + // a Drive item. + bool shown_in_apply = 3; + + // The colors to use for the badge. Changed to Google Material colors + // based on the chosen `properties.badge_config.color`. + BadgeColors badge_colors = 4; + + // The dark-mode color to use for the badge. Changed to Google Material + // colors based on the chosen `properties.badge_config.color`. + BadgeColors dark_badge_colors = 5; + + // The priority of this badge. Used to compare and sort between multiple + // badges. A lower number means the badge should be shown first. + // When a badging configuration is not present, this will be 0. + // Otherwise, this will be set to `BadgeConfig.priority_override` or the + // default heuristic which prefers creation date of the label, and field + // and option priority. + int64 badge_priority = 6; + } + + // The capabilities related to this choice when editing the choice. + message SchemaCapabilities { + // Whether the user can update this choice. + bool can_update = 1; + + // Whether the user can delete this choice. + bool can_delete = 2; + + // Whether the user can disable this choice. + bool can_disable = 3; + + // Whether the user can enable this choice. + bool can_enable = 4; + } + + // The capabilities related to this choice on applied metadata. + message AppliedCapabilities { + // Whether the user can read related applied metadata on items. + bool can_read = 1; + + // Whether the user can use this choice in search queries. + bool can_search = 2; + + // Whether the user can select this choice on an item. + bool can_select = 3; + } + + // The unique value of the choice. + // This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`. + string id = 1; + + // Basic properties of the choice. + Properties properties = 2; + + // Output only. Lifecycle of the choice. + Lifecycle lifecycle = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering a choice. + DisplayHints display_hints = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this option when editing the + // option. + SchemaCapabilities schema_capabilities = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this choice on applied + // metadata. + AppliedCapabilities applied_capabilities = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this choice. + UserInfo creator = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was created. + google.protobuf.Timestamp create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who updated this choice last. + UserInfo updater = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was updated last. + google.protobuf.Timestamp update_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this choice. This value has no + // meaning when the choice is not published. + UserInfo publisher = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was published. This value has no + // meaning when the choice is not published. + google.protobuf.Timestamp publish_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this choice. This value has no + // meaning when the option is not disabled. + UserInfo disabler = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was disabled. This value has no + // meaning when the choice is not disabled. + google.protobuf.Timestamp disable_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The LockStatus of this choice. + LockStatus lock_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // When specified, indicates this field supports a list of values. + // Once the field is published, this cannot be changed. + ListOptions list_options = 1; + + // The options available for this selection field. + // The list order is consistent, and modified with `insert_before_choice`. + repeated Choice choices = 2; + } + + // Options for the user field type. + message UserOptions { + // When specified, indicates that this field supports a list of values. + // Once the field is published, this cannot be changed. + ListOptions list_options = 1; + } + + // The data type and options of this field. + // Once published, the data type cannot be changed. + oneof type { + // Text field options. + TextOptions text_options = 16; + + // Integer field options. + IntegerOptions integer_options = 18; + + // Date field options. + DateOptions date_options = 19; + + // Selection field options. + SelectionOptions selection_options = 20; + + // User field options. + UserOptions user_options = 21; + } + + // Output only. The key of a field, unique within a label or library. + // + // This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The key to use when constructing Drive search queries to find + // files based on values defined for this field on files. + // For example, "`{query_key}` > 2001-01-01". + string query_key = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The basic properties of the field. + Properties properties = 3; + + // Output only. The lifecycle of this field. + Lifecycle lifecycle = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering a field. + DisplayHints display_hints = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities this user has when editing this field. + SchemaCapabilities schema_capabilities = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities this user has on this field and its value + // when the label is applied on Drive items. + AppliedCapabilities applied_capabilities = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this field. + UserInfo creator = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was created. + google.protobuf.Timestamp create_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who modified this field. + UserInfo updater = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was updated. + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this field. This value has no meaning + // when the field is not published. + UserInfo publisher = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this field. This value has no meaning + // when the field is not disabled. + UserInfo disabler = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was disabled. This value has no meaning + // when the field is not disabled. + google.protobuf.Timestamp disable_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The LockStatus of this field. + LockStatus lock_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2/label.proto b/google/apps/drive/labels/v2/label.proto new file mode 100644 index 000000000..4ff29bcbf --- /dev/null +++ b/google/apps/drive/labels/v2/label.proto @@ -0,0 +1,224 @@ +// 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.apps.drive.labels.v2; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/apps/drive/labels/v2/common.proto"; +import "google/apps/drive/labels/v2/field.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "cloudidentity.googleapis.com/Customer" + pattern: "customers/{customer}" +}; + +// A label defines a taxonomy that can be applied to Drive items in order to +// organize and search across items. Labels can be simple strings, or can +// contain fields that describe additional metadata that can be further used to +// organize and search Drive items. +message Label { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/Label" + pattern: "labels/{id}" + }; + + // Basic properties of the label. + message Properties { + // Required. Title of the label. + string title = 1 [(google.api.field_behavior) = REQUIRED]; + + // The description of the label. + string description = 2; + } + + // UI display hints for rendering the label. + message DisplayHints { + // Whether the label should be shown in the UI as disabled. + bool disabled = 1; + + // This label should be hidden in the search menu when searching for Drive + // items. + bool hidden_in_search = 2; + + // This label should be shown in the apply menu when applying values to a + // Drive item. + bool shown_in_apply = 3; + + // Order to display label in a list. + int64 priority = 4; + } + + // The capabilities a user has on this label's applied metadata. + message AppliedCapabilities { + // Whether the user can read applied metadata related to this label. + bool can_read = 1; + + // Whether the user can apply this label to items. + bool can_apply = 2; + + // Whether the user can remove this label from items. + bool can_remove = 3; + } + + // The capabilities related to this label when editing the label. + message SchemaCapabilities { + // Whether the user can change this label. + bool can_update = 1; + + // Whether the user can delete this label. + // The user must have permission and the label must be disabled. + bool can_delete = 2; + + // Whether the user can disable this label. + // The user must have permission and this label must not already be + // disabled. + bool can_disable = 3; + + // Whether the user can enable this label. + // The user must have permission and this label must be disabled. + bool can_enable = 4; + } + + // Behavior of this label when it's applied to Drive items. + message AppliedLabelPolicy { + // Indicates how the applied label and field values should be copied when + // a Drive item is copied. + enum CopyMode { + // Copy mode unspecified. + COPY_MODE_UNSPECIFIED = 0; + + // The applied label and field values are not copied by default when + // the Drive item it's applied to is copied. + DO_NOT_COPY = 1; + + // The applied label and field values are always copied when the + // Drive item it's applied to is copied. + // Only admins can use this mode. + ALWAYS_COPY = 2; + + // The applied label and field values are copied if the + // label is appliable by the user making the copy. + COPY_APPLIABLE = 3; + } + + // Indicates how the applied label and field values should be copied when + // a Drive item is copied. + CopyMode copy_mode = 1; + } + + // The type of this label. + enum LabelType { + // Unknown label type. + LABEL_TYPE_UNSPECIFIED = 0; + + // Shared labels may be shared with users to apply to Drive items. + SHARED = 1; + + // Admin-owned label. Only creatable and editable by admins. Supports some + // additional admin-only features. + ADMIN = 2; + } + + // Output only. Resource name of the label. Will be in the form of either: + // `labels/{id}` or `labels/{id}@{revision_id}` depending on the request. + // See `id` and `revision_id` below. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Globally unique identifier of this label. ID makes up part of + // the label `name`, but unlike `name`, ID is consistent between revisions. + // Matches the regex: `([a-zA-Z0-9])+` + string id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Revision ID of the label. Revision ID might be part of the + // label `name` depending on the request issued. A new revision is created + // whenever revisioned properties of a label are changed. Matches the regex: + // `([a-zA-Z0-9])+` + string revision_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The type of label. + LabelType label_type = 4 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The user who created this label. + UserInfo creator = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was created. + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this label revision. + UserInfo revision_creator = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label revision was created. + google.protobuf.Timestamp revision_create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this label. This value has no meaning + // when the label is not published. + UserInfo publisher = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was published. This value has no meaning + // when the label is not published. + google.protobuf.Timestamp publish_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this label. This value has no meaning + // when the label is not disabled. + UserInfo disabler = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was disabled. This value has no meaning + // when the label is not disabled. + google.protobuf.Timestamp disable_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The basic properties of the label. + Properties properties = 14 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The lifecycle state of the label including whether it's + // published, deprecated, and has draft changes. + Lifecycle lifecycle = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering the label. + DisplayHints display_hints = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this label on applied metadata. + AppliedCapabilities applied_capabilities = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities the user has on this label. + SchemaCapabilities schema_capabilities = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Behavior of this label when it's applied to Drive items. + AppliedLabelPolicy applied_label_policy = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // List of fields in descending priority order. + repeated Field fields = 20; + + // Custom URL to present to users to allow them to learn more about this label + // and how it should be used. + string learn_more_uri = 21; + + // Output only. The LockStatus of this label. + LockStatus lock_status = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2/label_permission.proto b/google/apps/drive/labels/v2/label_permission.proto new file mode 100644 index 000000000..f424e29b8 --- /dev/null +++ b/google/apps/drive/labels/v2/label_permission.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.apps.drive.labels.v2; + +import "google/api/resource.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelPermissionProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "groups.googleapis.com/Group" + pattern: "groups/{group}" +}; + +// The permission that applies to a principal (user, group, audience) on a +// label. +message LabelPermission { + // Roles are concentric with subsequent role. + enum LabelRole { + // Unknown role. + LABEL_ROLE_UNSPECIFIED = 0; + + // A reader can read the label and associated metadata applied to Drive + // items. + READER = 1; + + // An applier can write associated metadata on Drive items in which they + // also have write access to. Implies `READER`. + APPLIER = 2; + + // An organizer can pin this label in shared drives they manage + // and add new appliers to the label. + ORGANIZER = 3; + + // Editors can make any update including deleting the label which + // also deletes the associated Drive item metadata. Implies `APPLIER`. + EDITOR = 4; + } +} diff --git a/google/apps/drive/labels/v2/label_service.proto b/google/apps/drive/labels/v2/label_service.proto new file mode 100644 index 000000000..82e73df07 --- /dev/null +++ b/google/apps/drive/labels/v2/label_service.proto @@ -0,0 +1,57 @@ +// 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.apps.drive.labels.v2; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/apps/drive/labels/v2/label.proto"; +import "google/apps/drive/labels/v2/requests.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelServiceProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; + +// Manage metadata taxonomies based on Labels and Fields that may be used within +// Google Drive to organize and find files using custom metadata. +service LabelService { + option (google.api.default_host) = "drivelabels.googleapis.com"; + + // List labels. + rpc ListLabels(ListLabelsRequest) returns (ListLabelsResponse) { + option (google.api.http) = { + get: "/v2/labels" + }; + } + + // Get a label by its resource name. + // Resource name may be any of: + // + // * `labels/{id}` - See `labels/{id}@latest` + // * `labels/{id}@latest` - Gets the latest revision of the label. + // * `labels/{id}@published` - Gets the current published revision of the + // label. + // * `labels/{id}@{revision_id}` - Gets the label at the specified revision + // ID. + rpc GetLabel(GetLabelRequest) returns (Label) { + option (google.api.http) = { + get: "/v2/{name=labels/*}" + }; + option (google.api.method_signature) = "name"; + } +} diff --git a/google/apps/drive/labels/v2/requests.proto b/google/apps/drive/labels/v2/requests.proto new file mode 100644 index 000000000..7c01f01bc --- /dev/null +++ b/google/apps/drive/labels/v2/requests.proto @@ -0,0 +1,117 @@ +// 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.apps.drive.labels.v2; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/apps/drive/labels/v2/label.proto"; +import "google/apps/drive/labels/v2/label_permission.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2;labels"; +option java_multiple_files = true; +option java_outer_classname = "RequestsProto"; +option java_package = "com.google.apps.drive.labels.v2"; +option objc_class_prefix = "DLBL"; + +// Resource view that can be applied to label responses. The default value +// `LABEL_VIEW_BASIC` implies the field mask: + // `name,id,revision_id,label_type,properties.*`\ +enum LabelView { +// Implies the field mask: +// `name,id,revision_id,label_type,properties.*` +LABEL_VIEW_BASIC = 0; + +// All possible fields. +LABEL_VIEW_FULL = 1; +} + +// Request to get a label by resource name. +message GetLabelRequest { + // Required. Label resource name. + // + // May be any of: + // + // * `labels/{id}` (equivalent to labels/{id}@latest) + // * `labels/{id}@latest` + // * `labels/{id}@published` + // * `labels/{id}@{revision_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // verifies that the user is an admin for the label before allowing access. + bool use_admin_access = 2; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language are used. + string language_code = 3; + + // When specified, only certain fields belonging to the indicated view are + // returned. + LabelView view = 4; +} + +// Request to list labels available to the current user. +message ListLabelsRequest { + oneof access { + // Set to `true` in order to use the user's admin credentials. This will + // return all Labels within the customer. + bool use_admin_access = 3; + + // Specifies the level of access the user must have on the returned Labels. + // The minimum role a user must have on a label. + // Defaults to `READER`. + LabelPermission.LabelRole minimum_role = 4; + } + + // Whether to include only published labels in the results. + // + // * When `true`, only the current published label revisions are returned. + // Disabled labels are included. Returned label resource names + // reference the published revision (`labels/{id}/{revision_id}`). + // * When `false`, the current label revisions are returned, which might not + // be published. Returned label resource names don't reference a specific + // revision (`labels/{id}`). + bool published_only = 1; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language are used. + string language_code = 5; + + // Maximum number of labels to return per page. Default: 50. Max: 200. + int32 page_size = 6; + + // The token of the page to return. + string page_token = 7; + + // When specified, only certain fields belonging to the indicated view are + // returned. + LabelView view = 8; +} + +// Response for listing Labels. +message ListLabelsResponse { + // Labels. + repeated Label labels = 1; + + // The token of the next page in the response. + string next_page_token = 2; +} diff --git a/google/apps/drive/labels/v2beta/BUILD.bazel b/google/apps/drive/labels/v2beta/BUILD.bazel new file mode 100644 index 000000000..f2bb1da18 --- /dev/null +++ b/google/apps/drive/labels/v2beta/BUILD.bazel @@ -0,0 +1,398 @@ +# 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 = "labels_proto", + srcs = [ + "common.proto", + "error_details.proto", + "exception_detail.proto", + "field.proto", + "label.proto", + "label_limits.proto", + "label_lock.proto", + "label_permission.proto", + "label_service.proto", + "requests.proto", + "user_capabilities.proto", + ], + deps = [ + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "//google/type:color_proto", + "//google/type:date_proto", + "@com_google_protobuf//:empty_proto", + "@com_google_protobuf//:field_mask_proto", + "@com_google_protobuf//:timestamp_proto", + ], +) + +proto_library_with_info( + name = "labels_proto_with_info", + deps = [ + ":labels_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 = "labels_java_proto", + deps = [":labels_proto"], +) + +java_grpc_library( + name = "labels_java_grpc", + srcs = [":labels_proto"], + deps = [":labels_java_proto"], +) + +java_gapic_library( + name = "labels_java_gapic", + srcs = [":labels_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + test_deps = [ + ":labels_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":labels_java_proto", + "//google/api:api_java_proto", + ], +) + +java_gapic_test( + name = "labels_java_gapic_test_suite", + test_classes = [ + "com.google.apps.drive.labels.v2beta.LabelServiceClientHttpJsonTest", + "com.google.apps.drive.labels.v2beta.LabelServiceClientTest", + ], + runtime_deps = [":labels_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-drive-labels-v2beta-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":labels_java_gapic", + ":labels_java_grpc", + ":labels_java_proto", + ":labels_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 = "labels_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta", + protos = [":labels_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/type:color_go_proto", + "//google/type:date_go_proto", + ], +) + +go_gapic_library( + name = "labels_go_gapic", + srcs = [":labels_proto_with_info"], + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + importpath = "google.golang.org/google/apps/drive/labels/v2beta;labels", + metadata = True, + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + transport = "grpc+rest", + deps = [ + ":labels_go_proto", + ], +) + +go_test( + name = "labels_go_gapic_test", + srcs = [":labels_go_gapic_srcjar_test"], + embed = [":labels_go_gapic"], + importpath = "google.golang.org/google/apps/drive/labels/v2beta", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-drive-labels-v2beta-go", + deps = [ + ":labels_go_gapic", + ":labels_go_gapic_srcjar-metadata.srcjar", + ":labels_go_gapic_srcjar-test.srcjar", + ":labels_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "labels_py_gapic", + srcs = [":labels_proto"], + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + transport = "grpc+rest", + deps = [], +) + +py_test( + name = "labels_py_gapic_test", + srcs = [ + "labels_py_gapic_pytest.py", + "labels_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":labels_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "drive-labels-v2beta-py", + deps = [ + ":labels_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 = "labels_php_proto", + deps = [":labels_proto"], +) + +php_grpc_library( + name = "labels_php_grpc", + srcs = [":labels_proto"], + deps = [":labels_php_proto"], +) + +php_gapic_library( + name = "labels_php_gapic", + srcs = [":labels_proto_with_info"], + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + transport = "grpc+rest", + deps = [ + ":labels_php_grpc", + ":labels_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2beta-php", + deps = [ + ":labels_php_gapic", + ":labels_php_grpc", + ":labels_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "labels_nodejs_gapic", + package_name = "@google-cloud/labels", + src = ":labels_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + package = "google.apps.drive.labels.v2beta", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "drive-labels-v2beta-nodejs", + deps = [ + ":labels_nodejs_gapic", + ":labels_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 = "labels_ruby_proto", + deps = [":labels_proto"], +) + +ruby_grpc_library( + name = "labels_ruby_grpc", + srcs = [":labels_proto"], + deps = [":labels_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "labels_ruby_gapic", + srcs = [":labels_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-drive-labels-v2beta", + ], + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + deps = [ + ":labels_ruby_grpc", + ":labels_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2beta-ruby", + deps = [ + ":labels_ruby_gapic", + ":labels_ruby_grpc", + ":labels_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 = "labels_csharp_proto", + deps = [":labels_proto"], +) + +csharp_grpc_library( + name = "labels_csharp_grpc", + srcs = [":labels_proto"], + deps = [":labels_csharp_proto"], +) + +csharp_gapic_library( + name = "labels_csharp_gapic", + srcs = [":labels_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "drivelabels_v2beta_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "drivelabels_v2beta.yaml", + deps = [ + ":labels_csharp_grpc", + ":labels_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-drive-labels-v2beta-csharp", + deps = [ + ":labels_csharp_gapic", + ":labels_csharp_grpc", + ":labels_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "labels_cc_proto", + deps = [":labels_proto"], +) + +cc_grpc_library( + name = "labels_cc_grpc", + srcs = [":labels_proto"], + grpc_only = True, + deps = [":labels_cc_proto"], +) diff --git a/google/apps/drive/labels/v2beta/common.proto b/google/apps/drive/labels/v2beta/common.proto new file mode 100644 index 000000000..345a04b13 --- /dev/null +++ b/google/apps/drive/labels/v2beta/common.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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/type/color.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "CommonProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "people.googleapis.com/Person" + pattern: "persons/{person}" +}; + +// The lifecycle state of an object, such as label, field, or choice. The +// lifecycle enforces the following transitions: +// +// * `UNPUBLISHED_DRAFT` (starting state) +// * `UNPUBLISHED_DRAFT` -> `PUBLISHED` +// * `UNPUBLISHED_DRAFT` -> (Deleted) +// * `PUBLISHED` -> `DISABLED` +// * `DISABLED` -> `PUBLISHED` +// * `DISABLED` -> (Deleted) +// +// The published and disabled states have some distinct characteristics: +// +// * Published—Some kinds of changes might be made to an object in this state, +// in which case `has_unpublished_changes` will be true. Also, some kinds of +// changes are not permitted. Generally, any change that would invalidate or +// cause new restrictions on existing metadata related to the label are +// rejected. +// * Disabled—When disabled, the configured `DisabledPolicy` takes effect. +message Lifecycle { + // The policy that governs how to treat a disabled label, field, or selection + // choice in different contexts. + message DisabledPolicy { + // Whether to hide this disabled object in the search menu for Drive items. + // + // * When `false`, the object is generally shown in the UI as disabled but + // it appears in the search results when searching for Drive items. + // * When `true`, the object is generally hidden in the UI when + // searching for Drive items. + bool hide_in_search = 1; + + // Whether to show this disabled object in the apply menu on Drive items. + // + // * When `true`, the object is generally shown in the UI as disabled + // and is unselectable. + // * When `false`, the object is generally hidden in the UI. + bool show_in_apply = 2; + } + + // The state of the object associated with this lifecycle. + enum State { + // Unknown State. + STATE_UNSPECIFIED = 0; + + // The initial state of an object. Once published, the object can never + // return to this state. Once an object is published, certain kinds of + // changes are no longer permitted. + UNPUBLISHED_DRAFT = 1; + + // The object has been published. The object might have unpublished draft + // changes as indicated by `has_unpublished_changes`. + PUBLISHED = 2; + + // The object has been published and has since been disabled. The object + // might have unpublished draft changes as indicated by + // `has_unpublished_changes`. + DISABLED = 3; + + // The object has been deleted. + DELETED = 4; + } + + // Output only. The state of the object associated with this lifecycle. + State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the object associated with this lifecycle has + // unpublished changes. + bool has_unpublished_changes = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The policy that governs how to show a disabled label, field, or selection + // choice. + DisabledPolicy disabled_policy = 3; +} + +// Information about a user. +message UserInfo { + // The identifier for this user that can be used with the People API to get + // more information. + // For example, people/12345678. + string person = 1 [ + (google.api.resource_reference) = { type: "people.googleapis.com/Person" } + ]; +} + +// Badge status of the label. +message BadgeConfig { + // The color of the badge. When not specified, no badge is rendered. + // The background, foreground, and solo (light and dark mode) colors set here + // are changed in the Drive UI into the closest recommended supported color. + google.type.Color color = 1; + + // Override the default global priority of this badge. + // When set to 0, the default priority heuristic is used. + int64 priority_override = 2; +} + +// The color derived from BadgeConfig and changed to the closest recommended +// supported color. +message BadgeColors { + // Output only. Badge background that pairs with the foreground. + google.type.Color background_color = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Badge foreground that pairs with the background. + google.type.Color foreground_color = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Color that can be used for text without a background. + google.type.Color solo_color = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Contains information about whether a label component should be considered +// locked. +message LockStatus { + // Output only. Indicates whether this label component is the (direct) target + // of a LabelLock. A label component can be implicitly locked even if it's + // not the direct target of a LabelLock, in which case this field is set to + // false. + bool locked = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2beta/drivelabels_v2beta.yaml b/google/apps/drive/labels/v2beta/drivelabels_v2beta.yaml new file mode 100644 index 000000000..660d7447d --- /dev/null +++ b/google/apps/drive/labels/v2beta/drivelabels_v2beta.yaml @@ -0,0 +1,15 @@ +type: google.api.Service +config_version: 3 +name: drivelabels.googleapis.com +title: Drive Labels API + +apis: +- name: google.apps.drive.labels.v2beta.LabelService + +documentation: + summary: An API for managing Drive Labels + +backend: + rules: + - selector: 'google.apps.drive.labels.v2beta.LabelService.*' + deadline: 20.0 diff --git a/google/apps/drive/labels/v2beta/drivelabels_v2beta_grpc_service_config.json b/google/apps/drive/labels/v2beta/drivelabels_v2beta_grpc_service_config.json new file mode 100644 index 000000000..d2774e6c9 --- /dev/null +++ b/google/apps/drive/labels/v2beta/drivelabels_v2beta_grpc_service_config.json @@ -0,0 +1,37 @@ +{ + "methodConfig": [{ + "name": [ + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "GetUserCapabilities" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "ListLabels" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "GetLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "GetLabelLimits" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "ListLabelPermissions" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "ListLabelLocks" } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }, + { + "name": [ + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "CreateLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "DeltaUpdateLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "UpdateLabelCopyMode" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "PublishLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "DisableLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "EnableLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "DeleteLabel" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "CreateLabelPermission" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "UpdateLabelPermission" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "DeleteLabelPermission" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "BatchUpdateLabelPermissions" }, + { "service": "google.apps.drive.labels.v2beta.LabelService.", "method": "BatchDeleteLabelPermissions" } + ], + "timeout": "60s" + }] +} \ No newline at end of file diff --git a/google/apps/drive/labels/v2beta/error_details.proto b/google/apps/drive/labels/v2beta/error_details.proto new file mode 100644 index 000000000..561a4af18 --- /dev/null +++ b/google/apps/drive/labels/v2beta/error_details.proto @@ -0,0 +1,138 @@ +// 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.apps.drive.labels.v2beta; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "ErrorDetailsProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; + +// Describes violations in a request to create or update a Label or its +// Fields. +message InvalidArgument { + // Describes the Field in which the violation occurred. + message FieldViolation { + // Possible reasons a field is invalid. + enum Reason { + // Unknown reason. + REASON_UNSPECIFIED = 0; + + // The referenced field is required. + FIELD_REQUIRED = 1; + + // The referenced value was invalid. + INVALID_VALUE = 2; + + // The specified numeric value is out of the allowed range. + VALUE_OUT_OF_RANGE = 3; + + // The specified string value was too long. + STRING_VALUE_TOO_LONG = 4; + + // The number of entries exceeded the maximum. + MAX_ENTRIES_EXCEEDED = 5; + + // The specified field is not found in the Label. + FIELD_NOT_FOUND = 6; + + // The specified choice is not found in the Field. + CHOICE_NOT_FOUND = 7; + } + + // The path to the field where this violation occurred. This path is + // specified using `FieldMask` format: + // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + string field = 1; + + // The detailed reason for this FieldViolation. + Reason reason = 2; + + // A message that describes the violation. This message is intended to + // be shown to end users, and is localized into the requesting user's + // preferred language. + string display_message = 3; + } + + // Describes all violations in a client request. + repeated FieldViolation field_violations = 1; +} + +// Describes what preconditions have failed. +message PreconditionFailure { + // Specific failure reason. + message Violation { + // The possible reasons a the violation occurred. + enum Reason { + // Unknown violation type. + REASON_UNSPECIFIED = 0; + + // This Resource cannot be Disabled. Only Published resources can be + // Disabled. + CANNOT_DISABLE = 1; + + // This Resource cannot be Enabled. Only Disabled resources can be + // Enabled. + CANNOT_ENABLE = 2; + + // This Resource cannot be Published. Only Draft or Disabled resources + // can be Published. + CANNOT_PUBLISH = 3; + + // This Resource cannot be Unpublished. Once published, resources may + // not be set in "Draft" state. + CANNOT_UNPUBLISH = 4; + + // This Resource cannot be Deleted. Only Disabled resources + // can be Deleted. + CANNOT_DELETE = 5; + + // The request modified a range in a Field, but the new range does + // not include the previous range. When this error happens, `field` points + // at the Field where the violation occurred. + CANNOT_RESTRICT_RANGE = 6; + + // The specified change cannot be made to published Resources. + CANNOT_CHANGE_PUBLISHED_FIELD = 7; + + // The customer cannot create new labels because the maximum number + // of labels for the customer has been reached. + CANNOT_CREATE_MORE_LABELS = 8; + + // The Field type cannot be changed because the Field has been published. + CANNOT_CHANGE_PUBLISHED_FIELD_TYPE = 9; + + // The Label component is locked and cannot be modified + CANNOT_MODIFY_LOCKED_COMPONENT = 10; + } + + // The path to the field where this violation occurred. This path is + // specified using `FieldMask` format: + // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + string field = 1; + + // The type of this violation. + Reason reason = 2; + + // A message that describes the violation. This message is intended to + // be shown to end users, and is localized into the requesting user's + // preferred language. + string display_message = 3; + } + + // Describes all violations in a client request. + repeated Violation violation = 1; +} diff --git a/google/apps/drive/labels/v2beta/exception_detail.proto b/google/apps/drive/labels/v2beta/exception_detail.proto new file mode 100644 index 000000000..289e44468 --- /dev/null +++ b/google/apps/drive/labels/v2beta/exception_detail.proto @@ -0,0 +1,117 @@ +// 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.apps.drive.labels.v2beta; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "ExceptionDetailProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; + +// Every ExceptionType maps to one and only one Exception class. This allows +// internal clients to identify the exact server exception that caused the +// error for debugging and logging purposes. +// Add new ExceptionTypes to EXCEPTION_TYPE_TO_ERROR_CODE_MAP in +// j/c/g/apps/boq/metadata/model/service/exceptions/CategoryExceptionHelper +enum ExceptionType { + // Unknown ExceptionType. + EXCEPTION_TYPE_UNSPECIFIED = 0; + + // The required field is missing. + FIELD_REQUIRED = 1; + + // Unable to create a metamodel with the given ID because it already exists. + METAMODEL_ALREADY_EXISTS = 2; + + // Metamodel was not found + METAMODEL_NOT_FOUND = 3; + + // Metamodel state transition isn't allowed. + ILLEGAL_METAMODEL_STATE_TRANSITION = 4; + + // Metamodel deprecation policy is invalid. + INVALID_METAMODEL_DEPRECATION_POLICY = 5; + + // Cannot delete a metamodel due to the pending deprecation policy. + METAMODEL_DELETION_DENIED_UNTIL = 6; + + // A Field value is invalid. + INVALID_FIELD = 7; + + // Precondition failed when updating a metamodel + METAMODEL_PRECONDITION_FAILED = 8; + + // Multiple fields had the same key. + DUPLICATE_FIELD_KEY = 9; + + // Removing a field from a Metamodel (e.g. a published Metamodel) is not + // permitted. + ILLEGAL_FIELD_REMOVAL = 10; + + // Cannot specify field options for a different field type. + ILLEGAL_FIELD_OPTIONS_FOR_FIELD = 11; + + // Some changes are not supported + UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL = 12; + + // Cannot change the metamodel state in an update + ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE = 13; + + // The page token is expired + PAGE_TOKEN_EXPIRED = 14; + + // The user is not authorized to make the request. + NOT_AUTHORIZED = 15; + + // Illegal field state transition + ILLEGAL_FIELD_STATE_TRANSITION = 16; + + // Illegal choice set option state transition + ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION = 17; + + // Invalid choice set options + INVALID_CHOICE_SET_OPTIONS = 18; + + // Invalid field key + INVALID_FIELD_KEY = 19; + + // A specified property on a field is outside the allowed range. + INVALID_FIELD_PROPERTY_RANGE = 20; + + // A localized string wasn't valid. This may be because the locale is invalid, + // its missing a default value, or the translation is empty for a set locale. + INVALID_LOCALIZED_STRING = 21; + + // cannot change a property on a published field + ILLEGAL_CHANGE_TO_PUBLISHED_FIELD = 22; + + // A field update is not inclusive of the previous value + INVALID_FIELD_UPDATE_NOT_INCLUSIVE = 23; + + // A field update is not inclusive of the previous value + INVALID_CHOICE_SET_STATE = 24; + + // An unknown error occurred + INTERNAL_SERVER_ERROR = 500; +} + +// Normalized internal-only message that identifies the exact exception that +// caused the error on the server. +message ExceptionDetail { + // The type of exception that occurred. + // required + ExceptionType error_type = 1; +} diff --git a/google/apps/drive/labels/v2beta/field.proto b/google/apps/drive/labels/v2beta/field.proto new file mode 100644 index 000000000..da3dd2991 --- /dev/null +++ b/google/apps/drive/labels/v2beta/field.proto @@ -0,0 +1,391 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/apps/drive/labels/v2beta/common.proto"; +import "google/protobuf/timestamp.proto"; +import "google/type/date.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "FieldProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// Defines a field that has a display name, data type, and other +// configuration options. This field defines the kind of metadata that may be +// set on a Drive item. +message Field { + // The basic properties of the field. + message Properties { + // Required. The display text to show in the UI identifying this field. + string display_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Whether the field should be marked as required. + bool required = 2; + + // Input only. Insert or move this field before the indicated field. If + // empty, the field is placed at the end of the list. + string insert_before_field = 3 [(google.api.field_behavior) = INPUT_ONLY]; + } + + // UI display hints for rendering a field. + message DisplayHints { + // Whether the field should be shown as required in the UI. + bool required = 1; + + // Whether the field should be shown in the UI as disabled. + bool disabled = 2; + + // This field should be hidden in the search menu when searching for Drive + // items. + bool hidden_in_search = 3; + + // This field should be shown in the apply menu when applying values to a + // Drive item. + bool shown_in_apply = 4; + } + + // The capabilities related to this field when editing the field. + message SchemaCapabilities { + // Whether the user can change this field. + bool can_update = 1; + + // Whether the user can delete this field. + // The user must have permission and the field must be deprecated. + bool can_delete = 2; + + // Whether the user can disable this field. + // The user must have permission and this field must not already be + // disabled. + bool can_disable = 3; + + // Whether the user can enable this field. + // The user must have permission and this field must be disabled. + bool can_enable = 4; + } + + // The capabilities related to this field on applied metadata. + message AppliedCapabilities { + // Whether the user can read related applied metadata on items. + bool can_read = 1; + + // Whether the user can search for Drive items referencing this field. + bool can_search = 2; + + // Whether the user can set this field on Drive items. + bool can_write = 3; + } + + // Options for a multi-valued variant of an associated field type. + message ListOptions { + // Maximum number of entries permitted. + int32 max_entries = 1; + } + + // Options for the Text field type. + message TextOptions { + // Output only. The minimum valid length of values for the text field. + int32 min_length = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The maximum valid length of values for the text field. + int32 max_length = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options the Long Text field type. + message LongTextOptions { + // Output only. The minimum valid length of values for the text field. + int32 min_length = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The maximum valid length of values for the text field. + int32 max_length = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the Integer field type. + message IntegerOptions { + // Output only. The minimum valid value for the integer field. + int64 min_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The maximum valid value for the integer field. + int64 max_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the date field type. + message DateOptions { + // Localized date format options. + enum DateFormat { + // Date format unspecified. + DATE_FORMAT_UNSPECIFIED = 0; + + // Includes full month name. + // For example, January 12, 1999 + // (MMMM d, y) + LONG_DATE = 1; + + // Short, numeric, representation. + // For example, 12/13/99 + // (M/d/yy) + SHORT_DATE = 2; + } + + // Localized date formatting option. Field values are rendered in + // this format according to their locale. + DateFormat date_format_type = 1; + + // Output only. ICU date format. + string date_format = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Minimum valid value (year, month, day). + google.type.Date min_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Maximum valid value (year, month, day). + google.type.Date max_value = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Options for the selection field type. + message SelectionOptions { + // Selection field choice. + message Choice { + // Basic properties of the choice. + message Properties { + // Required. The display text to show in the UI identifying this field. + string display_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The description of this label. + string description = 2; + + // The badge configuration for this choice. When set, the + // label that owns this choice is considered a "badged label". + BadgeConfig badge_config = 3; + + // Input only. Insert or move this choice before the indicated choice. + // If empty, the choice is placed at the end of the list. + string insert_before_choice = 4 + [(google.api.field_behavior) = INPUT_ONLY]; + } + + // UI display hints for rendering an option. + message DisplayHints { + // Whether the option should be shown in the UI as disabled. + bool disabled = 1; + + // This option should be hidden in the search menu when searching for + // Drive items. + bool hidden_in_search = 2; + + // This option should be shown in the apply menu when applying values to + // a Drive item. + bool shown_in_apply = 3; + + // The colors to use for the badge. Changed to Google Material colors + // based on the chosen `properties.badge_config.color`. + BadgeColors badge_colors = 4; + + // The dark-mode color to use for the badge. Changed to Google Material + // colors based on the chosen `properties.badge_config.color`. + BadgeColors dark_badge_colors = 5; + + // The priority of this badge. Used to compare and sort between multiple + // badges. A lower number means the badge should be shown first. + // When a badging configuration is not present, this will be 0. + // Otherwise, this will be set to `BadgeConfig.priority_override` or the + // default heuristic which prefers creation date of the label, and field + // and option priority. + int64 badge_priority = 6; + } + + // The capabilities related to this choice when editing the choice. + message SchemaCapabilities { + // Whether the user can update this choice. + bool can_update = 1; + + // Whether the user can delete this choice. + bool can_delete = 2; + + // Whether the user can disable this choice. + bool can_disable = 3; + + // Whether the user can enable this choice. + bool can_enable = 4; + } + + // The capabilities related to this choice on applied metadata. + message AppliedCapabilities { + // Whether the user can read related applied metadata on items. + bool can_read = 1; + + // Whether the user can use this choice in search queries. + bool can_search = 2; + + // Whether the user can select this choice on an item. + bool can_select = 3; + } + + // The unique value of the choice. + // This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`. + string id = 1; + + // Basic properties of the choice. + Properties properties = 2; + + // Output only. Lifecycle of the choice. + Lifecycle lifecycle = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering a choice. + DisplayHints display_hints = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this option when editing the + // option. + SchemaCapabilities schema_capabilities = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this choice on applied + // metadata. + AppliedCapabilities applied_capabilities = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this choice. + UserInfo creator = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was created. + google.protobuf.Timestamp create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who updated this choice last. + UserInfo updater = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was updated last. + google.protobuf.Timestamp update_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this choice. This value has no + // meaning when the choice is not published. + UserInfo publisher = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was published. This value has no + // meaning when the choice is not published. + google.protobuf.Timestamp publish_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this choice. This value has no + // meaning when the option is not disabled. + UserInfo disabler = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this choice was disabled. This value has no + // meaning when the choice is not disabled. + google.protobuf.Timestamp disable_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The LockStatus of this choice. + LockStatus lock_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // When specified, indicates this field supports a list of values. + // Once the field is published, this cannot be changed. + ListOptions list_options = 1; + + // The options available for this selection field. + // The list order is consistent, and modified with `insert_before_choice`. + repeated Choice choices = 2; + } + + // Options for the user field type. + message UserOptions { + // When specified, indicates that this field supports a list of values. + // Once the field is published, this cannot be changed. + ListOptions list_options = 1; + } + + // The data type and options of this field. + // Once published, the data type cannot be changed. + oneof type { + // Text field options. + TextOptions text_options = 16; + + // Integer field options. + IntegerOptions integer_options = 18; + + // Date field options. + DateOptions date_options = 19; + + // Selection field options. + SelectionOptions selection_options = 20; + + // User field options. + UserOptions user_options = 21; + } + + // Output only. The key of a field, unique within a label or library. + // + // This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The key to use when constructing Drive search queries to find + // files based on values defined for this field on files. + // For example, "`{query_key}` > 2001-01-01". + string query_key = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The basic properties of the field. + Properties properties = 3; + + // Output only. The lifecycle of this field. + Lifecycle lifecycle = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering a field. + DisplayHints display_hints = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities this user has when editing this field. + SchemaCapabilities schema_capabilities = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities this user has on this field and its value + // when the label is applied on Drive items. + AppliedCapabilities applied_capabilities = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this field. + UserInfo creator = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was created. + google.protobuf.Timestamp create_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who modified this field. + UserInfo updater = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was updated. + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this field. This value has no meaning + // when the field is not published. + UserInfo publisher = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this field. This value has no meaning + // when the field is not disabled. + UserInfo disabler = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this field was disabled. This value has no meaning + // when the field is not disabled. + google.protobuf.Timestamp disable_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The LockStatus of this field. + LockStatus lock_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2beta/label.proto b/google/apps/drive/labels/v2beta/label.proto new file mode 100644 index 000000000..939c77984 --- /dev/null +++ b/google/apps/drive/labels/v2beta/label.proto @@ -0,0 +1,224 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/apps/drive/labels/v2beta/common.proto"; +import "google/apps/drive/labels/v2beta/field.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "cloudidentity.googleapis.com/Customer" + pattern: "customers/{customer}" +}; + +// A label defines a taxonomy that can be applied to Drive items in order to +// organize and search across items. Labels can be simple strings, or can +// contain fields that describe additional metadata that can be further used to +// organize and search Drive items. +message Label { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/Label" + pattern: "labels/{id}" + }; + + // Basic properties of the label. + message Properties { + // Required. Title of the label. + string title = 1 [(google.api.field_behavior) = REQUIRED]; + + // The description of the label. + string description = 2; + } + + // UI display hints for rendering the label. + message DisplayHints { + // Whether the label should be shown in the UI as disabled. + bool disabled = 1; + + // This label should be hidden in the search menu when searching for Drive + // items. + bool hidden_in_search = 2; + + // This label should be shown in the apply menu when applying values to a + // Drive item. + bool shown_in_apply = 3; + + // Order to display label in a list. + int64 priority = 4; + } + + // The capabilities a user has on this label's applied metadata. + message AppliedCapabilities { + // Whether the user can read applied metadata related to this label. + bool can_read = 1; + + // Whether the user can apply this label to items. + bool can_apply = 2; + + // Whether the user can remove this label from items. + bool can_remove = 3; + } + + // The capabilities related to this label when editing the label. + message SchemaCapabilities { + // Whether the user can change this label. + bool can_update = 1; + + // Whether the user can delete this label. + // The user must have permission and the label must be disabled. + bool can_delete = 2; + + // Whether the user can disable this label. + // The user must have permission and this label must not already be + // disabled. + bool can_disable = 3; + + // Whether the user can enable this label. + // The user must have permission and this label must be disabled. + bool can_enable = 4; + } + + // Behavior of this label when it's applied to Drive items. + message AppliedLabelPolicy { + // Indicates how the applied label and field values should be copied when + // a Drive item is copied. + enum CopyMode { + // Copy mode unspecified. + COPY_MODE_UNSPECIFIED = 0; + + // The applied label and field values are not copied by default when + // the Drive item it's applied to is copied. + DO_NOT_COPY = 1; + + // The applied label and field values are always copied when the + // Drive item it's applied to is copied. + // Only admins can use this mode. + ALWAYS_COPY = 2; + + // The applied label and field values are copied if the + // label is appliable by the user making the copy. + COPY_APPLIABLE = 3; + } + + // Indicates how the applied label and field values should be copied when + // a Drive item is copied. + CopyMode copy_mode = 1; + } + + // The type of this label. + enum LabelType { + // Unknown label type. + LABEL_TYPE_UNSPECIFIED = 0; + + // Shared labels may be shared with users to apply to Drive items. + SHARED = 1; + + // Admin-owned label. Only creatable and editable by admins. Supports some + // additional admin-only features. + ADMIN = 2; + } + + // Output only. Resource name of the label. Will be in the form of either: + // `labels/{id}` or `labels/{id}@{revision_id}` depending on the request. + // See `id` and `revision_id` below. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Globally unique identifier of this label. ID makes up part of + // the label `name`, but unlike `name`, ID is consistent between revisions. + // Matches the regex: `([a-zA-Z0-9])+` + string id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Revision ID of the label. Revision ID might be part of the + // label `name` depending on the request issued. A new revision is created + // whenever revisioned properties of a label are changed. Matches the regex: + // `([a-zA-Z0-9])+` + string revision_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The type of label. + LabelType label_type = 4 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The user who created this label. + UserInfo creator = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was created. + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who created this label revision. + UserInfo revision_creator = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label revision was created. + google.protobuf.Timestamp revision_create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who published this label. This value has no meaning + // when the label is not published. + UserInfo publisher = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was published. This value has no meaning + // when the label is not published. + google.protobuf.Timestamp publish_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user who disabled this label. This value has no meaning + // when the label is not disabled. + UserInfo disabler = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time this label was disabled. This value has no meaning + // when the label is not disabled. + google.protobuf.Timestamp disable_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The basic properties of the label. + Properties properties = 14 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The lifecycle state of the label including whether it's + // published, deprecated, and has draft changes. + Lifecycle lifecycle = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. UI display hints for rendering the label. + DisplayHints display_hints = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities related to this label on applied metadata. + AppliedCapabilities applied_capabilities = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The capabilities the user has on this label. + SchemaCapabilities schema_capabilities = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Behavior of this label when it's applied to Drive items. + AppliedLabelPolicy applied_label_policy = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // List of fields in descending priority order. + repeated Field fields = 20; + + // Custom URL to present to users to allow them to learn more about this label + // and how it should be used. + string learn_more_uri = 21; + + // Output only. The LockStatus of this label. + LockStatus lock_status = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2beta/label_limits.proto b/google/apps/drive/labels/v2beta/label_limits.proto new file mode 100644 index 000000000..e29481685 --- /dev/null +++ b/google/apps/drive/labels/v2beta/label_limits.proto @@ -0,0 +1,155 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/resource.proto"; +import "google/type/date.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelLimitsProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// Label constraints governing the structure of a Label; such as, the maximum +// number of Fields allowed and maximum length of the label title. +message LabelLimits { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/LabelLimits" + pattern: "limits/label" + }; + + // Resource name. + string name = 1; + + // The maximum number of characters allowed for the title. + int32 max_title_length = 2; + + // The maximum number of characters allowed for the description. + int32 max_description_length = 3; + + // The maximum number of Fields allowed within the label. + int32 max_fields = 4; + + // The maximum number of published Fields that can be deleted. + int32 max_deleted_fields = 5; + + // The maximum number of draft revisions that will be kept before deleting + // old drafts. + int32 max_draft_revisions = 6; + + // The limits for Fields. + FieldLimits field_limits = 7; +} + +// Field constants governing the structure of a Field; such as, the maximum +// title length, minimum and maximum field values or length, etc. +message FieldLimits { + // Max length for the id. + int32 max_id_length = 1; + + // Limits for Field title. + int32 max_display_name_length = 2; + + // Limits for Field description, also called help text. + int32 max_description_length = 3; + + // The relevant limits for the specified Field.Type. + // Text Field limits. + TextLimits text_limits = 4; + + // Long text Field limits. + LongTextLimits long_text_limits = 5; + + // Integer Field limits. + IntegerLimits integer_limits = 6; + + // Date Field limits. + DateLimits date_limits = 7; + + // User Field limits. + UserLimits user_limits = 8; + + // Selection Field limits. + SelectionLimits selection_limits = 9; +} + +// Limits for list-variant of a Field type. +message ListLimits { + // Maximum number of values allowed for the Field type. + int32 max_entries = 1; +} + +// Limits for text Field type. +message TextLimits { + // Minimum length allowed for a text Field type. + int32 min_length = 1; + + // Maximum length allowed for a text Field type. + int32 max_length = 2; +} + +// Limits for long text Field type. +message LongTextLimits { + // Minimum length allowed for a long text Field type. + int32 min_length = 1; + + // Maximum length allowed for a long text Field type. + int32 max_length = 2; +} + +// Limits for integer Field type. +message IntegerLimits { + // Minimum value for an integer Field type. + int64 min_value = 1; + + // Maximum value for an integer Field type. + int64 max_value = 2; +} + +// Limits for date Field type. +message DateLimits { + // Minimum value for the date Field type. + google.type.Date min_value = 1; + + // Maximum value for the date Field type. + google.type.Date max_value = 2; +} + +// Limits for selection Field type. +message SelectionLimits { + // Limits for list-variant of a Field type. + ListLimits list_limits = 1; + + // Maximum ID length for a selection options. + int32 max_id_length = 2; + + // Maximum length for display name. + int32 max_display_name_length = 3; + + // The max number of choices. + int32 max_choices = 4; + + // Maximum number of deleted choices. + int32 max_deleted_choices = 5; +} + +// Limits for Field.Type.USER. +message UserLimits { + // Limits for list-variant of a Field type. + ListLimits list_limits = 1; +} diff --git a/google/apps/drive/labels/v2beta/label_lock.proto b/google/apps/drive/labels/v2beta/label_lock.proto new file mode 100644 index 000000000..5b658de00 --- /dev/null +++ b/google/apps/drive/labels/v2beta/label_lock.proto @@ -0,0 +1,87 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/apps/drive/labels/v2beta/common.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelLockProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// A Lock that can be applied to a Label, Field, or Choice. +message LabelLock { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/LabelLock" + pattern: "labels/{label}/locks/{lock}" + }; + + // A description of a user's capabilities on a LabelLock. + message Capabilities { + // True if the user is authorized to view the policy. + bool can_view_policy = 1; + } + + // A description of a LabelLock's state. + enum State { + // Unknown state. + STATE_UNSPECIFIED = 0; + + // The LabelLock is active and is being enforced by the server. + ACTIVE = 1; + + // The LabelLock is being deleted. The LabelLock will continue to be + // enforced by the server until it has been fully removed. + DELETING = 2; + } + + // Output only. Resource name of this LabelLock. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The ID of the Field that should be locked. Empty if the whole + // Label should be locked. + string field_id = 2; + + // The ID of the Selection Field Choice that should be locked. If present, + // `field_id` must also be present. + string choice_id = 3; + + // Output only. The time this LabelLock was created. + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user whose credentials were used to create the LabelLock. + // This will not be present if no user was responsible for creating the + // LabelLock. + UserInfo creator = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A timestamp indicating when this LabelLock was scheduled for + // deletion. This will be present only if this LabelLock is in the DELETING + // state. + google.protobuf.Timestamp delete_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The user's capabilities on this LabelLock. + Capabilities capabilities = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. This LabelLock's state. + State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/drive/labels/v2beta/label_permission.proto b/google/apps/drive/labels/v2beta/label_permission.proto new file mode 100644 index 000000000..56ace7f4f --- /dev/null +++ b/google/apps/drive/labels/v2beta/label_permission.proto @@ -0,0 +1,95 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/resource.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelPermissionProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; +option (google.api.resource_definition) = { + type: "groups.googleapis.com/Group" + pattern: "groups/{group}" +}; + +// The permission that applies to a principal (user, group, audience) on a +// label. +message LabelPermission { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/LabelPermission" + pattern: "labels/{label}/permissions/{permission}" + }; + + // Roles are concentric with subsequent role. + enum LabelRole { + // Unknown role. + LABEL_ROLE_UNSPECIFIED = 0; + + // A reader can read the label and associated metadata applied to Drive + // items. + READER = 1; + + // An applier can write associated metadata on Drive items in which they + // also have write access to. Implies `READER`. + APPLIER = 2; + + // An organizer can pin this label in shared drives they manage + // and add new appliers to the label. + ORGANIZER = 3; + + // Editors can make any update including deleting the label which + // also deletes the associated Drive item metadata. Implies `APPLIER`. + EDITOR = 4; + } + + // The principal this permission applies to. Must be either an email, user, + // group, or audience. + // Example: + // * people/12345 + // * groups/45678 + // * audiences/default + oneof principal { + // Person resource name. + string person = 3 [ + (google.api.resource_reference) = { type: "people.googleapis.com/Person" } + ]; + + // Group resource name. + string group = 4 [ + (google.api.resource_reference) = { type: "groups.googleapis.com/Group" } + ]; + + // Audience to grant a role to. The magic value of `audiences/default` may + // be used to apply the role to the default audience in the context of the + // organization that owns the Label. + string audience = 5; + } + + // Resource name of this permission. + string name = 1; + + // Specifies the email address for a user or group pricinpal. Not populated + // for audience principals. User and Group permissions may only be inserted + // using email address. On update requests, if email address is specified, + // no principal should be specified. + string email = 2; + + // The role the principal should have. + LabelRole role = 6; +} diff --git a/google/apps/drive/labels/v2beta/label_service.proto b/google/apps/drive/labels/v2beta/label_service.proto new file mode 100644 index 000000000..327c6d566 --- /dev/null +++ b/google/apps/drive/labels/v2beta/label_service.proto @@ -0,0 +1,274 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/apps/drive/labels/v2beta/label.proto"; +import "google/apps/drive/labels/v2beta/label_limits.proto"; +import "google/apps/drive/labels/v2beta/label_permission.proto"; +import "google/apps/drive/labels/v2beta/requests.proto"; +import "google/apps/drive/labels/v2beta/user_capabilities.proto"; +import "google/protobuf/empty.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "LabelServiceProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// Manage metadata taxonomies based on Labels and Fields that may be used within +// Google Drive to organize and find files using custom metadata. +service LabelService { + option (google.api.default_host) = "drivelabels.googleapis.com"; + + // Gets the user capabilities. + rpc GetUserCapabilities(GetUserCapabilitiesRequest) + returns (UserCapabilities) { + option (google.api.http) = { + get: "/v2beta/{name=users/*/capabilities}" + }; + option (google.api.method_signature) = "name"; + } + + // List labels. + rpc ListLabels(ListLabelsRequest) returns (ListLabelsResponse) { + option (google.api.http) = { + get: "/v2beta/labels" + }; + } + + // Get a label by its resource name. + // Resource name may be any of: + // + // * `labels/{id}` - See `labels/{id}@latest` + // * `labels/{id}@latest` - Gets the latest revision of the label. + // * `labels/{id}@published` - Gets the current published revision of the + // label. + // * `labels/{id}@{revision_id}` - Gets the label at the specified revision + // ID. + rpc GetLabel(GetLabelRequest) returns (Label) { + option (google.api.http) = { + get: "/v2beta/{name=labels/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Get the constraints on the structure of a Label; such as, the maximum + // number of Fields allowed and maximum length of the label title. + rpc GetLabelLimits(GetLabelLimitsRequest) returns (LabelLimits) { + option (google.api.http) = { + get: "/v2beta/limits/label" + }; + } + + // Creates a new Label. + rpc CreateLabel(CreateLabelRequest) returns (Label) { + option (google.api.http) = { + post: "/v2beta/labels" + body: "label" + }; + option (google.api.method_signature) = "label"; + } + + // Updates a single Label by applying a set of update requests resulting in a + // new draft revision. The batch update is all-or-nothing: If any of the + // update requests are invalid, no changes are applied. The resulting draft + // revision must be published before the changes may be used with Drive Items. + rpc DeltaUpdateLabel(DeltaUpdateLabelRequest) + returns (DeltaUpdateLabelResponse) { + option (google.api.http) = { + post: "/v2beta/{name=labels/*}:delta" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do + // not require publishing, and take effect immediately. + rpc UpdateLabelCopyMode(UpdateLabelCopyModeRequest) returns (Label) { + option (google.api.http) = { + post: "/v2beta/{name=labels/*}:updateLabelCopyMode" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Publish all draft changes to the Label. Once published, the Label may not + // return to its draft state. See + // `google.apps.drive.labels.v2.Lifecycle` for more information. + // + // Publishing a Label will result in a new published revision. All previous + // draft revisions will be deleted. Previous published revisions will be kept + // but are subject to automated deletion as needed. + // + // Once published, some changes are no longer permitted. Generally, any change + // that would invalidate or cause new restrictions on existing metadata + // related to the Label will be rejected. For example, the following changes + // to a Label will be rejected after the Label is published: + // * The label cannot be directly deleted. It must be disabled first, then + // deleted. + // * Field.FieldType cannot be changed. + // * Changes to Field validation options cannot reject something that was + // previously accepted. + // * Reducing the max entries. + rpc PublishLabel(PublishLabelRequest) returns (Label) { + option (google.api.http) = { + post: "/v2beta/{name=labels/*}:publish" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Disable a published Label. + // Disabling a Label will result in a new disabled published revision based on + // the current published revision. If there is a draft revision, a new + // disabled draft revision will be created based on the latest draft revision. + // Older draft revisions will be deleted. + // + // Once disabled, a label may be deleted with `DeleteLabel`. + rpc DisableLabel(DisableLabelRequest) returns (Label) { + option (google.api.http) = { + post: "/v2beta/{name=labels/*}:disable" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Enable a disabled Label and restore it to its published state. + // This will result in a new published revision based on the current disabled + // published revision. If there is an existing disabled draft revision, a new + // revision will be created based on that draft and will be enabled. + rpc EnableLabel(EnableLabelRequest) returns (Label) { + option (google.api.http) = { + post: "/v2beta/{name=labels/*}:enable" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Permanently deletes a Label and related metadata on Drive Items. + // + // Once deleted, the Label and related Drive item metadata will be deleted. + // Only draft Labels, and disabled Labels may be deleted. + rpc DeleteLabel(DeleteLabelRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v2beta/{name=labels/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists a Label's permissions. + rpc ListLabelPermissions(ListLabelPermissionsRequest) + returns (ListLabelPermissionsResponse) { + option (google.api.http) = { + get: "/v2beta/{parent=labels/*}/permissions" + additional_bindings { + get: "/v2beta/{parent=labels/*/revisions/*}/permissions" + } + }; + option (google.api.method_signature) = "parent"; + } + + // Updates a Label's permissions. If a permission for the indicated principal + // doesn't exist, a new Label Permission is created, otherwise the existing + // permission is updated. Permissions affect the Label resource as a whole, + // are not revisioned, and do not require publishing. + rpc CreateLabelPermission(CreateLabelPermissionRequest) + returns (LabelPermission) { + option (google.api.http) = { + post: "/v2beta/{parent=labels/*}/permissions" + body: "label_permission" + additional_bindings { + post: "/v2beta/{parent=labels/*/revisions/*}/permissions" + body: "label_permission" + } + }; + option (google.api.method_signature) = "parent,label_permission"; + } + + // Updates a Label's permissions. If a permission for the indicated principal + // doesn't exist, a new Label Permission is created, otherwise the existing + // permission is updated. Permissions affect the Label resource as a whole, + // are not revisioned, and do not require publishing. + rpc UpdateLabelPermission(UpdateLabelPermissionRequest) + returns (LabelPermission) { + option (google.api.http) = { + patch: "/v2beta/{parent=labels/*}/permissions" + body: "label_permission" + additional_bindings { + patch: "/v2beta/{parent=labels/*/revisions/*}/permissions" + body: "label_permission" + } + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes a Label's permission. Permissions affect the Label resource as a + // whole, are not revisioned, and do not require publishing. + rpc DeleteLabelPermission(DeleteLabelPermissionRequest) + returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v2beta/{name=labels/*/permissions/*}" + additional_bindings { + delete: "/v2beta/{name=labels/*/revisions/*/permissions/*}" + } + }; + option (google.api.method_signature) = "name"; + } + + // Updates Label permissions. If a permission for the + // indicated principal doesn't exist, a new Label Permission is created, + // otherwise the existing permission is updated. Permissions affect the Label + // resource as a whole, are not revisioned, and do not require publishing. + rpc BatchUpdateLabelPermissions(BatchUpdateLabelPermissionsRequest) + returns (BatchUpdateLabelPermissionsResponse) { + option (google.api.http) = { + post: "/v2beta/{parent=labels/*}/permissions:batchUpdate" + body: "*" + additional_bindings { + post: "/v2beta/{parent=labels/*/revisions/*}/permissions:batchUpdate" + body: "*" + } + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes Label permissions. Permissions affect the Label resource as a + // whole, are not revisioned, and do not require publishing. + rpc BatchDeleteLabelPermissions(BatchDeleteLabelPermissionsRequest) + returns (google.protobuf.Empty) { + option (google.api.http) = { + post: "/v2beta/{parent=labels/*}/permissions:batchDelete" + body: "*" + additional_bindings { + post: "/v2beta/{parent=labels/*/revisions/*}/permissions:batchDelete" + body: "*" + } + }; + option (google.api.method_signature) = "parent"; + } + + // Lists the LabelLocks on a Label. + rpc ListLabelLocks(ListLabelLocksRequest) returns (ListLabelLocksResponse) { + option (google.api.http) = { + get: "/v2beta/{parent=labels/*}/locks" + additional_bindings { get: "/v2beta/{parent=labels/*/revisions/*}/locks" } + }; + option (google.api.method_signature) = "parent"; + } +} diff --git a/google/apps/drive/labels/v2beta/requests.proto b/google/apps/drive/labels/v2beta/requests.proto new file mode 100644 index 000000000..736b87598 --- /dev/null +++ b/google/apps/drive/labels/v2beta/requests.proto @@ -0,0 +1,809 @@ +// 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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/apps/drive/labels/v2beta/common.proto"; +import "google/apps/drive/labels/v2beta/field.proto"; +import "google/apps/drive/labels/v2beta/label.proto"; +import "google/apps/drive/labels/v2beta/label_lock.proto"; +import "google/apps/drive/labels/v2beta/label_permission.proto"; +import "google/protobuf/field_mask.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "RequestsProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// Resource view that can be applied to label responses. The default value +// `LABEL_VIEW_BASIC` implies the field mask: + // `name,id,revision_id,label_type,properties.*`\ +enum LabelView { +// Implies the field mask: +// `name,id,revision_id,label_type,properties.*` +LABEL_VIEW_BASIC = 0; + +// All possible fields. +LABEL_VIEW_FULL = 1; +} + +// Provides control over how write requests are executed. When not specified, +// the last write wins. +message WriteControl { + // Determines the revision of the label to write to and how the request + // should behave if that revision is not the current revision of the + // label. + oneof control { + // The [revision_id][google.apps.drive.labels.v1.Label.revision_id] of the + // label that the write request will be applied to. If this is not the + // latest revision of the label, the request will not be processed and will + // return a 400 Bad Request error. + string required_revision_id = 1; + } +} + +// Request to get the capabilities for a user. +message GetUserCapabilitiesRequest { + // Required. The resource name of the user. Only "users/me/capabilities" is + // supported. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/UserCapabilities" + } + ]; +} + +// Request to create a Label. +message CreateLabelRequest { + // Required. The label to create. + Label label = 1 [(google.api.field_behavior) = REQUIRED]; + + // Set to `true` in order to use the user's admin privileges. The server + // will verify the user is an admin before allowing access. + bool use_admin_access = 2; + + // The BCP-47 language code to use for evaluating localized Field labels in + // response. When not specified, values in the default configured language + // will be used. + string language_code = 3; +} + +// Request to get a label by resource name. +message GetLabelRequest { + // Required. Label resource name. + // + // May be any of: + // + // * `labels/{id}` (equivalent to labels/{id}@latest) + // * `labels/{id}@latest` + // * `labels/{id}@published` + // * `labels/{id}@{revision_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // verifies that the user is an admin for the label before allowing access. + bool use_admin_access = 2; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language are used. + string language_code = 3; + + // When specified, only certain fields belonging to the indicated view are + // returned. + LabelView view = 4; +} + +// The set of requests for updating aspects of a Label. If any request is not +// valid, no requests will be applied. +message DeltaUpdateLabelRequest { + // A single kind of update to apply to a Label. + message Request { + // The kind of update. Exactly one Field is required. + oneof kind { + // Updates the Label properties. + UpdateLabelPropertiesRequest update_label = 1; + + // Creates a new Field. + CreateFieldRequest create_field = 2; + + // Updates basic properties of a Field. + UpdateFieldPropertiesRequest update_field = 3; + + // Update Field type and/or type options. + UpdateFieldTypeRequest update_field_type = 4; + + // Enables the Field. + EnableFieldRequest enable_field = 5; + + // Disables the Field. + DisableFieldRequest disable_field = 6; + + // Deletes a Field from the label. + DeleteFieldRequest delete_field = 7; + + // Creates Choice within a Selection field. + CreateSelectionChoiceRequest create_selection_choice = 8; + + // Update a Choice properties within a Selection Field. + UpdateSelectionChoicePropertiesRequest + update_selection_choice_properties = 9; + + // Enable a Choice within a Selection Field. + EnableSelectionChoiceRequest enable_selection_choice = 10; + + // Disable a Choice within a Selection Field. + DisableSelectionChoiceRequest disable_selection_choice = 11; + + // Delete a Choice within a Selection Field. + DeleteSelectionChoiceRequest delete_selection_choice = 12; + } + } + + // Updates basic properties of a Label. + message UpdateLabelPropertiesRequest { + // The fields that should be updated. At least one field must be specified. + // The root `label_properties` is implied and should not be specified. A + // single `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. Label properties to update. + Label.Properties properties = 2 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to disable the Field. + message DisableFieldRequest { + // The fields that should be updated. At least one field must be specified. + // The root `disabled_policy` is implied and should not be specified. A + // single `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. Key of the Field to disable. + string id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Field Disabled Policy. + Lifecycle.DisabledPolicy disabled_policy = 3 + [(google.api.field_behavior) = REQUIRED]; + } + + // Request to enable the Field. + message EnableFieldRequest { + // Required. ID of the Field to enable. + string id = 1 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to delete the Field. + message DeleteFieldRequest { + // Required. ID of the Field to delete. + string id = 1 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to create a Field within a Label. + message CreateFieldRequest { + // Required. Field to create. + Field field = 1 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to update Field properties. + message UpdateFieldPropertiesRequest { + // The fields that should be updated. At least one field must be specified. + // The root `properties` is implied and should not be specified. A single + // `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. The Field to update. + string id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Basic Field properties. + Field.Properties properties = 3 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to change the type of a Field. + message UpdateFieldTypeRequest { + oneof type_options { + // Update field to Text. + Field.TextOptions text_options = 3; + + // Update field to Long Text. + Field.LongTextOptions long_text_options = 4; + + // Update field to Integer. + Field.IntegerOptions integer_options = 5; + + // Update field to Date. + Field.DateOptions date_options = 6; + + // Update field to Selection. + Field.SelectionOptions selection_options = 7; + + // Update field to User. + Field.UserOptions user_options = 8; + } + + // The fields that should be updated. At least one field must be specified. + // The root of `type_options` is implied and should not be specified. A + // single `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. The Field to update. + string id = 2 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to create a Selection Choice. + message CreateSelectionChoiceRequest { + // Required. The Selection Field in which a Choice will be created. + string field_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Choice to create. + Field.SelectionOptions.Choice choice = 2 + [(google.api.field_behavior) = REQUIRED]; + } + + // Request to update a Choice properties. + message UpdateSelectionChoicePropertiesRequest { + // The fields that should be updated. At least one field must be specified. + // The root `properties` is implied and should not be specified. A single + // `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. The Selection Field to update. + string field_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Choice to update. + string id = 3 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Choice properties to update. + Field.SelectionOptions.Choice.Properties properties = 4 + [(google.api.field_behavior) = REQUIRED]; + } + + // Request to delete a Choice. + message DeleteSelectionChoiceRequest { + // Required. The Selection Field from which a Choice will be deleted. + string field_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Choice to delete. + string id = 2 [(google.api.field_behavior) = REQUIRED]; + } + + // Request to disable a Choice. + message DisableSelectionChoiceRequest { + // The fields that should be updated. At least one field must be specified. + // The root `disabled_policy` is implied and should not be specified. A + // single `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. The Selection Field in which a Choice will be disabled. + string field_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Choice to disable. + string id = 3 [(google.api.field_behavior) = REQUIRED]; + + // Required. The disabled policy to update. + Lifecycle.DisabledPolicy disabled_policy = 4 + [(google.api.field_behavior) = REQUIRED]; + } + + // Request to enable a Choice. + message EnableSelectionChoiceRequest { + // Required. The Selection Field in which a Choice will be enabled. + string field_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Choice to enable. + string id = 2 [(google.api.field_behavior) = REQUIRED]; + } + + // Required. The resource name of the Label to update. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Provides control over how write requests are executed. + WriteControl write_control = 2; + + // A list of updates to apply to the Label. + // Requests will be applied in the order they are specified. + repeated Request requests = 3; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 4; + + // When specified, only certain fields belonging to the indicated view will be + // returned. + LabelView view = 5; + + // The BCP-47 language code to use for evaluating localized Field labels when + // `include_label_in_response` is `true`. + string language_code = 6; +} + +// Response for Label update. +message DeltaUpdateLabelResponse { + // A single response from an update. + message Response { + // The response for the corresponding request. + oneof response { + // Updated basic properties of a Label. + UpdateLabelPropertiesResponse update_label = 1; + + // Creates a new Field. + CreateFieldResponse create_field = 2; + + // Updates basic properties of a Field. + UpdateFieldPropertiesResponse update_field = 3; + + // Update Field type and/or type options. + UpdateFieldTypeResponse update_field_type = 4; + + // Enables Field. + EnableFieldResponse enable_field = 5; + + // Disables Field. + DisableFieldResponse disable_field = 6; + + // Deletes a Field from the label. + DeleteFieldResponse delete_field = 7; + + // Creates a new selection list option to add to a Selection Field. + CreateSelectionChoiceResponse create_selection_choice = 8; + + // Updates a Choice within a Selection Field. + UpdateSelectionChoicePropertiesResponse + update_selection_choice_properties = 9; + + // Enables a Choice within a Selection Field. + EnableSelectionChoiceResponse enable_selection_choice = 10; + + // Disables a Choice within a Selection Field. + DisableSelectionChoiceResponse disable_selection_choice = 11; + + // Deletes a Choice from a Selection Field. + DeleteSelectionChoiceResponse delete_selection_choice = 12; + } + } + + // Response following update to Label properties. + message UpdateLabelPropertiesResponse {} + + // Response following Field create. + message CreateFieldResponse { + // The field of the created field. When left blank in a create request, + // a key will be autogenerated and can be identified here. + string id = 1; + + // The priority of the created field. The priority may change from what + // was specified to assure contiguous priorities between fields (1-n). + int32 priority = 2; + } + + // Response following update to Field properties. + message UpdateFieldPropertiesResponse { + // The priority of the updated field. The priority may change from what + // was specified to assure contiguous priorities between fields (1-n). + int32 priority = 1; + } + + // Response following update to Field type. + message UpdateFieldTypeResponse {} + + // Response following Field enable. + message EnableFieldResponse {} + + // Response following Field disable. + message DisableFieldResponse {} + + // Response following Field delete. + message DeleteFieldResponse {} + + // Response following Selection Choice create. + message CreateSelectionChoiceResponse { + // The server-generated id of the field. + string field_id = 1; + + // The server-generated ID of the created choice within the Field + string id = 2; + } + + // Response following update to Selection Choice properties. + message UpdateSelectionChoicePropertiesResponse { + // The priority of the updated choice. The priority may change from what + // was specified to assure contiguous priorities between choices (1-n). + int32 priority = 1; + } + + // Response following Choice enable. + message EnableSelectionChoiceResponse {} + + // Response following Choice disable. + message DisableSelectionChoiceResponse {} + + // Response following Choice delete. + message DeleteSelectionChoiceResponse {} + + // The reply of the updates. This maps 1:1 with the updates, although + // responses to some requests may be empty. + repeated Response responses = 1; + + // The label after updates were applied. This is only set if + // [BatchUpdateLabelResponse2.include_label_in_response] is `true` and there + // were no errors. + Label updated_label = 6; +} + +// Request to update the `CopyMode` of the given Label. Changes to this policy +// are not revisioned, do not require publishing, and take effect immediately. + // \ +message UpdateLabelCopyModeRequest { +// Required. The resource name of the Label to update. +string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { type: "drivelabels.googleapis.com/Label" } +]; + +// Required. Indicates how the applied Label, and Field values should be copied +// when a Drive item is copied. +Label.AppliedLabelPolicy.CopyMode copy_mode = 2 + [(google.api.field_behavior) = REQUIRED]; + +// Set to `true` in order to use the user's admin credentials. The server +// will verify the user is an admin for the Label before allowing access. +bool use_admin_access = 3; + +// The BCP-47 language code to use for evaluating localized field labels. +// When not specified, values in the default configured language will be used. +string language_code = 4; + +// When specified, only certain fields belonging to the indicated view will be +// returned. +LabelView view = 5; +} + +// Request to get the limits for a Label. +message GetLabelLimitsRequest { + // Required. Label revision resource name + // Must be: "limits/label" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; +} + +// Request to list labels available to the current user. +message ListLabelsRequest { + oneof access { + // Set to `true` in order to use the user's admin credentials. This will + // return all Labels within the customer. + bool use_admin_access = 3; + + // Specifies the level of access the user must have on the returned Labels. + // The minimum role a user must have on a label. + // Defaults to `READER`. + LabelPermission.LabelRole minimum_role = 4; + } + + // Whether to include only published labels in the results. + // + // * When `true`, only the current published label revisions are returned. + // Disabled labels are included. Returned label resource names + // reference the published revision (`labels/{id}/{revision_id}`). + // * When `false`, the current label revisions are returned, which might not + // be published. Returned label resource names don't reference a specific + // revision (`labels/{id}`). + bool published_only = 1; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language are used. + string language_code = 5; + + // Maximum number of labels to return per page. Default: 50. Max: 200. + int32 page_size = 6; + + // The token of the page to return. + string page_token = 7; + + // When specified, only certain fields belonging to the indicated view are + // returned. + LabelView view = 8; +} + +// Response for listing Labels. +message ListLabelsResponse { + // Labels. + repeated Label labels = 1; + + // The token of the next page in the response. + string next_page_token = 2; +} + +// Creates or updates a permission on the Label. Permissions affect the Label +// resource as a whole, are not revisioned, and do not require publishing. +message CreateLabelPermissionRequest { + // Required. The parent Label resource name on the Label Permission is + // created. Format: labels/{label} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Required. The permission to create or update on the Label. + LabelPermission label_permission = 2 [(google.api.field_behavior) = REQUIRED]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 3; +} + +// Request to list the permissions on a Label. +message ListLabelPermissionsRequest { + // Required. The parent Label resource name on which Label Permission are + // listed. Format: labels/{label} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server will + // verify the user is an admin for the Label before allowing access. + bool use_admin_access = 2; + + // Maximum number of permissions to return per page. Default: 50. Max: 200. + int32 page_size = 3; + + // The token of the page to return. + string page_token = 4; +} + +// Response for listing the permissions on a Label. +message ListLabelPermissionsResponse { + // Label permissions. + repeated LabelPermission label_permissions = 1; + + // The token of the next page in the response. + string next_page_token = 2; +} + +// Updates a Label Permission. Permissions affect the Label resource as a whole, +// are not revisioned, and do not require publishing. +message UpdateLabelPermissionRequest { + // Required. The parent Label resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Required. The permission to create or update on the Label. + LabelPermission label_permission = 2 [(google.api.field_behavior) = REQUIRED]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 3; +} + +// Deletes a Label Permission. Permissions affect the Label resource as a whole, +// are not revisioned, and do not require publishing. +message DeleteLabelPermissionRequest { + // Required. Label Permission resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/LabelPermission" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 2; +} + +// Updates one or more Label Permissions. +message BatchUpdateLabelPermissionsRequest { + // Required. The parent Label resource name shared by all permissions being + // updated. Format: labels/{label} If this is set, the parent field in the + // UpdateLabelPermissionRequest messages must either be empty or match this + // field. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Required. The request message specifying the resources to update. + repeated UpdateLabelPermissionRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + // If this is set, the use_admin_access field in the + // UpdateLabelPermissionRequest messages must either be empty or match this + // field. + bool use_admin_access = 3; +} + +// Response for updating one or more Label Permissions. +message BatchUpdateLabelPermissionsResponse { + // Required. Permissions updated. + repeated LabelPermission permissions = 1 + [(google.api.field_behavior) = REQUIRED]; +} + +// Deletes one of more Label Permissions. +message BatchDeleteLabelPermissionsRequest { + // Required. The request message specifying the resources to update. + repeated DeleteLabelPermissionRequest requests = 1 + [(google.api.field_behavior) = REQUIRED]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + // If this is set, the use_admin_access field in the + // DeleteLabelPermissionRequest messages must either be empty or match this + // field. + bool use_admin_access = 2; + + // Required. The parent Label resource name shared by all permissions being + // deleted. Format: labels/{label} If this is set, the parent field in the + // UpdateLabelPermissionRequest messages must either be empty or match this + // field. + string parent = 3 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; +} + +// Request to deprecate a published Label. +message DisableLabelRequest { + // The fields that should be updated. At least one field must be specified. + // The root `disabled_policy` is implied and should not be specified. A + // single `*` can be used as short-hand for updating every field. + google.protobuf.FieldMask update_mask = 1; + + // Required. Label resource name. + string name = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 3; + + // Provides control over how write requests are executed. Defaults to unset, + // which means last write wins. + WriteControl write_control = 4; + + // Disabled policy to use. + Lifecycle.DisabledPolicy disabled_policy = 5; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language will be used. + string language_code = 6; +} + +// Request to publish a label. +message PublishLabelRequest { + // Required. Label resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 2; + + // Provides control over how write requests are executed. Defaults to unset, + // which means last write wins. + WriteControl write_control = 3; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language will be used. + string language_code = 4; +} + +// Request to enable a label. +message EnableLabelRequest { + // Required. Label resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 2; + + // Provides control over how write requests are executed. Defaults to unset, + // which means last write wins. + WriteControl write_control = 3; + + // The BCP-47 language code to use for evaluating localized field labels. + // When not specified, values in the default configured language will be used. + string language_code = 4; +} + +// Request to delete a label. +message DeleteLabelRequest { + // Required. Label resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Set to `true` in order to use the user's admin credentials. The server + // will verify the user is an admin for the Label before allowing access. + bool use_admin_access = 2; + + // Provides control over how write requests are executed. Defaults to unset, + // which means last write wins. + WriteControl write_control = 3; +} + +// A request to list the LabelLocks on a Label. +message ListLabelLocksRequest { + // Required. Label on which Locks are applied. + // Format: labels/{label} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "drivelabels.googleapis.com/Label" + } + ]; + + // Maximum number of Locks to return per page. Default: 100. Max: 200. + int32 page_size = 2; + + // The token of the page to return. + string page_token = 3; +} + +// The response to a ListLabelLocksRequest. +message ListLabelLocksResponse { + // LabelLocks. + repeated LabelLock label_locks = 1; + + // The token of the next page in the response. + string next_page_token = 2; +} diff --git a/google/apps/drive/labels/v2beta/user_capabilities.proto b/google/apps/drive/labels/v2beta/user_capabilities.proto new file mode 100644 index 000000000..a661ce6b5 --- /dev/null +++ b/google/apps/drive/labels/v2beta/user_capabilities.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.apps.drive.labels.v2beta; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; + +option go_package = "google.golang.org/genproto/googleapis/apps/drive/labels/v2beta;labels"; +option java_multiple_files = true; +option java_outer_classname = "UserCapabilitiesProto"; +option java_package = "com.google.apps.drive.labels.v2beta"; +option objc_class_prefix = "DLBL"; + +// The capabilities of a user. +message UserCapabilities { + option (google.api.resource) = { + type: "drivelabels.googleapis.com/UserCapabilities" + pattern: "users/{id}/capabilities" + }; + + // Output only. Resource name for the user capabilities. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the user is allowed access to the label manager. + bool can_access_label_manager = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the user is an administrator for the shared labels + // feature. + bool can_administrate_labels = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the user is allowed to create new shared labels. + bool can_create_shared_labels = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the user is allowed to create new admin labels. + bool can_create_admin_labels = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/apps/market/v2/BUILD.bazel b/google/apps/market/v2/BUILD.bazel index 32b1c8cdd..639a28593 100644 --- a/google/apps/market/v2/BUILD.bazel +++ b/google/apps/market/v2/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "marketplace_proto", @@ -38,18 +67,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "marketplace_java_proto", deps = [":marketplace_proto"], @@ -65,6 +82,7 @@ java_gapic_library( name = "marketplace_java_gapic", srcs = [":marketplace_proto_with_info"], grpc_service_config = "service_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":marketplace_java_grpc", ], @@ -90,6 +108,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-hosted-marketplace-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":marketplace_java_gapic", @@ -99,17 +118,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "marketplace_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -126,6 +134,7 @@ go_gapic_library( grpc_service_config = "service_grpc_service_config.json", importpath = "google.golang.org/ccc/hosted/marketplace/v2;marketplace", metadata = True, + rest_numeric_enums = True, service_yaml = "appsmarket_v2.yaml", deps = [ ":marketplace_go_proto", @@ -150,20 +159,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "marketplace_py_gapic", srcs = [":marketplace_proto"], grpc_service_config = "service_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -185,17 +185,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "marketplace_php_proto", deps = [":marketplace_proto"], @@ -211,6 +200,8 @@ php_gapic_library( name = "marketplace_php_gapic", srcs = [":marketplace_proto_with_info"], grpc_service_config = "service_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":marketplace_php_grpc", ":marketplace_php_proto", @@ -227,15 +218,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "marketplace_nodejs_gapic", package_name = "@google-cloud/marketplace", @@ -243,7 +225,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "service_grpc_service_config.json", package = "ccc.hosted.marketplace.v2", + rest_numeric_enums = True, service_yaml = "appsmarket_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -255,17 +239,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "marketplace_ruby_proto", deps = [":marketplace_proto"], @@ -284,6 +257,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-hosted-marketplace-v2", ], grpc_service_config = "service_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":marketplace_ruby_grpc", ":marketplace_ruby_proto", @@ -300,17 +274,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "marketplace_csharp_proto", deps = [":marketplace_proto"], @@ -327,6 +290,7 @@ csharp_gapic_library( srcs = [":marketplace_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "service_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "appsmarket_v2.yaml", deps = [ ":marketplace_csharp_grpc", diff --git a/google/apps/script/type/BUILD.bazel b/google/apps/script/type/BUILD.bazel index 619630a68..898b31236 100644 --- a/google/apps/script/type/BUILD.bazel +++ b/google/apps/script/type/BUILD.bazel @@ -17,11 +17,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -73,31 +70,45 @@ go_proto_library( protos = [":type_proto"], ) -moved_proto_library( - name = "type_moved_proto", - srcs = [":type_proto"], - deps = [ - "@com_google_protobuf//:struct_proto", - "@com_google_protobuf//:wrappers_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "type_py_proto", - deps = [":type_moved_proto"], + deps = [":type_proto"], ) -py_proto_library( - name = "type_py_original_proto", - deps = [":type_proto"], +py_gapic_library( + name = "type_py_gapic", + srcs = [":type_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "type_py_grpc", - srcs = [":type_moved_proto"], - deps = [":type_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "type-py", + deps = [ + ":type_py_gapic", + "//google/apps/script/type/calendar:calendar_py_gapic", + "//google/apps/script/type/docs:docs_py_gapic", + "//google/apps/script/type/drive:drive_py_gapic", + "//google/apps/script/type/gmail:gmail_py_gapic", + "//google/apps/script/type/sheets:sheets_py_gapic", + "//google/apps/script/type/slides:slides_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "type_php_proto", deps = [":type_proto"], diff --git a/google/apps/script/type/calendar/BUILD.bazel b/google/apps/script/type/calendar/BUILD.bazel index 7e70f9707..afda2f0c2 100644 --- a/google/apps/script/type/calendar/BUILD.bazel +++ b/google/apps/script/type/calendar/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -74,31 +71,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "calendar_moved_proto", - srcs = [":calendar_proto"], - deps = [ - "//google/api:field_behavior_proto", - "//google/apps/script/type:type_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "calendar_py_proto", - deps = [":calendar_moved_proto"], + deps = [":calendar_proto"], ) -py_proto_library( - name = "calendar_py_original_proto", - deps = [":calendar_proto"], +py_gapic_library( + name = "calendar_py_gapic", + srcs = [":calendar_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "calendar_py_grpc", - srcs = [":calendar_moved_proto"], - deps = [":calendar_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "calendar-gapic", + deps = [ + ":calendar_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "calendar_php_proto", deps = [":calendar_proto"], diff --git a/google/apps/script/type/docs/BUILD.bazel b/google/apps/script/type/docs/BUILD.bazel index e82d088e8..ae9815b8a 100644 --- a/google/apps/script/type/docs/BUILD.bazel +++ b/google/apps/script/type/docs/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -74,31 +71,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "docs_moved_proto", - srcs = [":docs_proto"], - deps = [ - "//google/api:field_behavior_proto", - "//google/apps/script/type:type_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "docs_py_proto", - deps = [":docs_moved_proto"], + deps = [":docs_proto"], ) -py_proto_library( - name = "docs_py_original_proto", - deps = [":docs_proto"], +py_gapic_library( + name = "docs_py_gapic", + srcs = [":docs_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "docs_py_grpc", - srcs = [":docs_moved_proto"], - deps = [":docs_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "docs-gapic", + deps = [ + ":docs_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "docs_php_proto", deps = [":docs_proto"], diff --git a/google/apps/script/type/drive/BUILD.bazel b/google/apps/script/type/drive/BUILD.bazel index 817fd1226..9031c9e7e 100644 --- a/google/apps/script/type/drive/BUILD.bazel +++ b/google/apps/script/type/drive/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -72,30 +69,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "drive_moved_proto", - srcs = [":drive_proto"], - deps = [ - "//google/apps/script/type:type_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "drive_py_proto", - deps = [":drive_moved_proto"], + deps = [":drive_proto"], ) -py_proto_library( - name = "drive_py_original_proto", - deps = [":drive_proto"], +py_gapic_library( + name = "drive_py_gapic", + srcs = [":drive_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "drive_py_grpc", - srcs = [":drive_moved_proto"], - deps = [":drive_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "drive-gapic", + deps = [ + ":drive_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "drive_php_proto", deps = [":drive_proto"], diff --git a/google/apps/script/type/gmail/BUILD.bazel b/google/apps/script/type/gmail/BUILD.bazel index b5d48c4ff..ad90a72f1 100644 --- a/google/apps/script/type/gmail/BUILD.bazel +++ b/google/apps/script/type/gmail/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -73,31 +70,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "gmail_moved_proto", - srcs = [":gmail_proto"], - deps = [ - "//google/apps/script/type:type_proto", - "@com_google_protobuf//:struct_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "gmail_py_proto", - deps = [":gmail_moved_proto"], + deps = [":gmail_proto"], ) -py_proto_library( - name = "gmail_py_original_proto", - deps = [":gmail_proto"], +py_gapic_library( + name = "gmail_py_gapic", + srcs = [":gmail_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "gmail_py_grpc", - srcs = [":gmail_moved_proto"], - deps = [":gmail_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "gmail-gapic", + deps = [ + ":gmail_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "gmail_php_proto", deps = [":gmail_proto"], diff --git a/google/apps/script/type/sheets/BUILD.bazel b/google/apps/script/type/sheets/BUILD.bazel index d85c73842..b5177bdda 100644 --- a/google/apps/script/type/sheets/BUILD.bazel +++ b/google/apps/script/type/sheets/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -74,31 +71,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "sheets_moved_proto", - srcs = [":sheets_proto"], - deps = [ - "//google/api:field_behavior_proto", - "//google/apps/script/type:type_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "sheets_py_proto", - deps = [":sheets_moved_proto"], + deps = [":sheets_proto"], ) -py_proto_library( - name = "sheets_py_original_proto", - deps = [":sheets_proto"], +py_gapic_library( + name = "sheets_py_gapic", + srcs = [":sheets_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "sheets_py_grpc", - srcs = [":sheets_moved_proto"], - deps = [":sheets_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "sheets-gapic", + deps = [ + ":sheets_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "sheets_php_proto", deps = [":sheets_proto"], diff --git a/google/apps/script/type/slides/BUILD.bazel b/google/apps/script/type/slides/BUILD.bazel index 37d8ff599..1d1472247 100644 --- a/google/apps/script/type/slides/BUILD.bazel +++ b/google/apps/script/type/slides/BUILD.bazel @@ -16,11 +16,8 @@ load( "java_gapic_assembly_gradle_pkg", "java_grpc_library", "java_proto_library", - "moved_proto_library", "php_grpc_library", "php_proto_library", - "py_grpc_library", - "py_proto_library", "ruby_grpc_library", "ruby_proto_library", ) @@ -74,31 +71,39 @@ go_proto_library( ], ) -moved_proto_library( - name = "slides_moved_proto", - srcs = [":slides_proto"], - deps = [ - "//google/api:field_behavior_proto", - "//google/apps/script/type:type_proto", - ], +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", ) py_proto_library( name = "slides_py_proto", - deps = [":slides_moved_proto"], + deps = [":slides_proto"], ) -py_proto_library( - name = "slides_py_original_proto", - deps = [":slides_proto"], +py_gapic_library( + name = "slides_py_gapic", + srcs = [":slides_proto"], + rest_numeric_enums = False, + transport = "grpc", ) -py_grpc_library( - name = "slides_py_grpc", - srcs = [":slides_moved_proto"], - deps = [":slides_py_proto"], +# Open Source Packages +py_gapic_assembly_pkg( + name = "slides-gapic", + deps = [ + ":slides_py_gapic", + ], ) +############################################################################## +# PHP +############################################################################## php_proto_library( name = "slides_php_proto", deps = [":slides_proto"], diff --git a/google/area120/tables/v1alpha1/BUILD.bazel b/google/area120/tables/v1alpha1/BUILD.bazel index 3c635126c..5538a550d 100644 --- a/google/area120/tables/v1alpha1/BUILD.bazel +++ b/google/area120/tables/v1alpha1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "tables_proto", @@ -42,18 +71,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "tables_java_proto", deps = [":tables_proto"], @@ -70,6 +87,7 @@ java_gapic_library( srcs = [":tables_proto_with_info"], gapic_yaml = "language_gapic.yaml", grpc_service_config = "tables_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":tables_java_grpc", ], @@ -91,6 +109,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-area120-tables-v1alpha1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":tables_java_gapic", @@ -100,17 +119,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "tables_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -126,6 +134,7 @@ go_gapic_library( srcs = [":tables_proto_with_info"], grpc_service_config = "tables_grpc_service_config.json", importpath = "google.golang.org/google/area120/tables/v1alpha1;tables", + rest_numeric_enums = True, service_yaml = "area120tables_v1alpha1.yaml", transport = "grpc+rest", deps = [ @@ -150,20 +159,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "tables_py_gapic", srcs = [":tables_proto"], grpc_service_config = "tables_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -185,17 +185,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "tables_php_proto", deps = [":tables_proto"], @@ -211,6 +200,8 @@ php_gapic_library( name = "tables_php_gapic", srcs = [":tables_proto_with_info"], grpc_service_config = "tables_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":tables_php_grpc", ":tables_php_proto", @@ -227,15 +218,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "tables_nodejs_gapic", package_name = "@google/area120-tables", @@ -243,7 +225,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "tables_grpc_service_config.json", package = "google.area120.tables.v1alpha1", + rest_numeric_enums = True, service_yaml = "area120tables_v1alpha1.yaml", + transport = "grpc+rest", deps = [], ) @@ -255,17 +239,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "tables_ruby_proto", deps = [":tables_proto"], @@ -288,6 +261,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=area120tables", ], grpc_service_config = "tables_grpc_service_config.json", + 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", deps = [ @@ -306,17 +280,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "tables_csharp_proto", deps = [":tables_proto"], @@ -333,6 +296,7 @@ csharp_gapic_library( srcs = [":tables_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "tables_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "area120tables_v1alpha1.yaml", deps = [ ":tables_csharp_grpc", diff --git a/google/bigtable/admin/v2/BUILD.bazel b/google/bigtable/admin/v2/BUILD.bazel index 8ec078912..e4caac487 100644 --- a/google/bigtable/admin/v2/BUILD.bazel +++ b/google/bigtable/admin/v2/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "admin_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "admin_java_proto", deps = [":admin_proto"], @@ -70,6 +89,7 @@ java_gapic_library( srcs = [":admin_proto_with_info"], gapic_yaml = "bigtableadmin_gapic.yaml", grpc_service_config = "bigtableadmin_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":admin_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -93,6 +113,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-bigtable-admin-v2-java", + include_samples = True, transport = "grpc", deps = [ ":admin_java_gapic", @@ -102,17 +123,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "admin_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -131,14 +141,15 @@ go_gapic_library( srcs = [":admin_proto_with_info"], grpc_service_config = "bigtableadmin_grpc_service_config.json", importpath = "cloud.google.com/go/bigtable/admin/apiv2;admin", + rest_numeric_enums = True, service_yaml = "bigtableadmin_v2.yaml", transport = "grpc", deps = [ ":admin_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", + "@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", ], ) @@ -160,16 +171,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "bigtable_admin_py_gapic", srcs = [":admin_proto"], @@ -179,6 +180,7 @@ py_gapic_library( "python-gapic-name=bigtable_admin", "autogen-snippets=False", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -203,17 +205,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_php_proto", deps = [":admin_proto"], @@ -229,7 +220,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], gapic_yaml = "bigtableadmin_gapic.yaml", + rest_numeric_enums = True, service_yaml = "bigtableadmin_v2.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -246,15 +239,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "admin_nodejs_gapic", package_name = "@google-cloud/bigtable", @@ -263,7 +247,9 @@ nodejs_gapic_library( grpc_service_config = "bigtableadmin_grpc_service_config.json", main_service = "bigtable", package = "google.bigtable.admin.v2", + rest_numeric_enums = True, service_yaml = "bigtableadmin_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -275,17 +261,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_ruby_proto", deps = [":admin_proto"], @@ -309,6 +284,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-bigtable", ], grpc_service_config = "bigtableadmin_grpc_service_config.json", + 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", deps = [ @@ -327,17 +303,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_csharp_proto", deps = [":admin_proto"], @@ -354,6 +319,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigtableadmin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigtableadmin_v2.yaml", deps = [ ":admin_csharp_grpc", @@ -371,18 +337,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -# -# PLEASE DO NOT DELETE -# These rules are not auto-generated, but they are used by OSS C++ projects. -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "admin_cc_proto", deps = [":admin_proto"], diff --git a/google/bigtable/v2/BUILD.bazel b/google/bigtable/v2/BUILD.bazel index 795632754..d27e04bd0 100644 --- a/google/bigtable/v2/BUILD.bazel +++ b/google/bigtable/v2/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "bigtable_proto", @@ -37,18 +68,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "bigtable_java_proto", deps = [":bigtable_proto"], @@ -65,6 +84,7 @@ java_gapic_library( srcs = [":bigtable_proto_with_info"], gapic_yaml = "bigtable_gapic.yaml", grpc_service_config = "bigtable_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":bigtable_java_grpc", ], @@ -85,6 +105,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-bigtable-v2-java", + include_samples = True, transport = "grpc", deps = [ ":bigtable_java_gapic", @@ -94,17 +115,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "bigtable_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -121,6 +131,7 @@ go_gapic_library( srcs = [":bigtable_proto_with_info"], grpc_service_config = "bigtable_grpc_service_config.json", importpath = "cloud.google.com/go/bigtable/apiv2;bigtable", + rest_numeric_enums = True, service_yaml = "bigtable_v2.yaml", transport = "grpc", deps = [ @@ -145,16 +156,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "bigtable_py_gapic", srcs = [":bigtable_proto"], @@ -163,6 +164,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "autogen-snippets=False", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -183,17 +185,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "bigtable_php_proto", deps = [":bigtable_proto"], @@ -208,7 +199,9 @@ php_grpc_library( php_gapic_library( name = "bigtable_php_gapic", srcs = [":bigtable_proto_with_info"], + rest_numeric_enums = True, service_yaml = "bigtable_v2.yaml", + transport = "grpc+rest", deps = [ ":bigtable_php_grpc", ":bigtable_php_proto", @@ -225,15 +218,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "bigtable_nodejs_gapic", package_name = "@google-cloud/bigtable", @@ -243,7 +227,9 @@ nodejs_gapic_library( handwritten_layer = True, main_service = "bigtable", package = "google.bigtable.v2", + rest_numeric_enums = True, service_yaml = "bigtable_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -255,17 +241,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "bigtable_ruby_proto", deps = [":bigtable_proto"], @@ -288,6 +263,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=bigtable", ], grpc_service_config = "bigtable_grpc_service_config.json", + 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", deps = [ @@ -306,17 +282,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "bigtable_csharp_proto", deps = [":bigtable_proto"], @@ -333,6 +298,7 @@ csharp_gapic_library( srcs = [":bigtable_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigtable_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigtable_v2.yaml", deps = [ ":bigtable_csharp_grpc", @@ -350,15 +316,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "bigtable_cc_proto", deps = [":bigtable_proto"], diff --git a/google/bigtable/v2/bigtable.proto b/google/bigtable/v2/bigtable.proto index 090c60eb7..955a05611 100644 --- a/google/bigtable/v2/bigtable.proto +++ b/google/bigtable/v2/bigtable.proto @@ -68,7 +68,9 @@ 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"; @@ -78,8 +80,7 @@ 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" }; @@ -88,7 +89,9 @@ 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"; @@ -106,11 +109,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,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 @@ -126,15 +130,16 @@ 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: "*" @@ -144,12 +149,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. @@ -164,7 +169,9 @@ 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"; @@ -175,8 +182,7 @@ 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: "*" @@ -186,11 +192,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,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"; } } @@ -208,12 +215,9 @@ message ReadRowsRequest { // RequestStats embedded message unset in the response. REQUEST_STATS_NONE = 1; - // Include stats related to the efficiency of the read. - REQUEST_STATS_EFFICIENCY = 2; - // Include the full set of available RequestStats in the response, // applicable to this read. - REQUEST_STATS_FULL = 3; + REQUEST_STATS_FULL = 2; } // Required. The unique name of the table from which to read. @@ -384,8 +388,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, @@ -401,14 +405,16 @@ 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 { @@ -417,14 +423,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) = { @@ -465,8 +471,9 @@ 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, @@ -479,8 +486,7 @@ 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 @@ -513,9 +519,8 @@ 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) = { @@ -533,8 +538,9 @@ 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, @@ -547,15 +553,13 @@ 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. diff --git a/google/bigtable/v2/request_stats.proto b/google/bigtable/v2/request_stats.proto index 101603504..f650abe09 100644 --- a/google/bigtable/v2/request_stats.proto +++ b/google/bigtable/v2/request_stats.proto @@ -27,13 +27,23 @@ option php_namespace = "Google\\Cloud\\Bigtable\\V2"; option ruby_package = "Google::Cloud::Bigtable::V2"; // -// Messages related to RequestStats, part of the Slow Queries feature, that can +// Messages related to RequestStats, part of the Query Stats feature, that can // help understand the performance of requests. - -// ReadIteratorStats captures information about the iteration of rows or cells +// +// The layout of requests below is as follows: +// * RequestStats serves as the top-level container for statistics and +// measures related to Bigtable requests. This common object is returned as +// part of methods in the Data API. +// * RequestStats contains multiple *views* of related data, chosen by an +// option in the source Data API method. The view that is returned is +// designed to have all submessages (and their submessages, and so on) +// filled-in, to provide a comprehensive selection of statistics and +// measures related to the requested view. + +// ReadIterationStats captures information about the iteration of rows or cells // over the course of a read, e.g. how many results were scanned in a read // operation versus the results returned. -message ReadIteratorStats { +message ReadIterationStats { // The rows seen (scanned) as part of the request. This includes the count of // rows returned, as captured below. int64 rows_seen_count = 1; @@ -47,9 +57,6 @@ message ReadIteratorStats { // The cells returned as part of the request. int64 cells_returned_count = 4; - - // The deletes seen as part of the request. - int64 deletes_seen_count = 5; } // RequestLatencyStats provides a measurement of the latency of the request as @@ -66,29 +73,23 @@ message RequestLatencyStats { // (https://cloud.google.com/bigtable/docs/monitoring-instance) as this value // needs to be sent in the response before the latency measurement including // that transmission is finalized. + // + // Note: This value includes the end-to-end latency of contacting nodes in + // the targeted cluster, e.g. measuring from when the first byte arrives at + // the frontend server, to when this value is sent back as the last value in + // the response, including any latency incurred by contacting nodes, waiting + // for results from nodes, and finally sending results from nodes back to the + // caller. google.protobuf.Duration frontend_server_latency = 1; } -// ReadEfficiencyStats captures information about the efficiency of a read. -message ReadEfficiencyStats { +// FullReadStatsView captures all known information about a read. +message FullReadStatsView { // Iteration stats describe how efficient the read is, e.g. comparing // rows seen vs. rows returned or cells seen vs cells returned can provide an // indication of read efficiency (the higher the ratio of seen to retuned the // better). - ReadIteratorStats read_iterator_stats = 1; - - // Request latency stats describe the time taken to complete a request, from - // the server side. - RequestLatencyStats request_latency_stats = 2; -} - -// AllReadStats captures all known information about a read. -message AllReadStats { - // Iteration stats describe how efficient the read is, e.g. comparing - // rows seen vs. rows returned or cells seen vs cells returned can provide an - // indication of read efficiency (the higher the ratio of seen to retuned the - // better). - ReadIteratorStats read_iterator_stats = 1; + ReadIterationStats read_iteration_stats = 1; // Request latency stats describe the time taken to complete a request, from // the server side. @@ -104,14 +105,9 @@ message RequestStats { // based on the requested view. // // See the messages above for additional context. - oneof stats { - // Available with the - // ReadRowsRequest.RequestStatsView.REQUEST_STATS_EFFICIENCY view, see - // package google.bigtable.v2. - ReadEfficiencyStats read_efficiency_stats = 1; - + oneof stats_view { // Available with the ReadRowsRequest.RequestStatsView.REQUEST_STATS_FULL // view, see package google.bigtable.v2. - AllReadStats all_read_stats = 2; + FullReadStatsView full_read_stats_view = 1; } } diff --git a/google/chromeos/moblab/v1beta1/BUILD.bazel b/google/chromeos/moblab/v1beta1/BUILD.bazel index 3cafac1d3..f3f4b2507 100644 --- a/google/chromeos/moblab/v1beta1/BUILD.bazel +++ b/google/chromeos/moblab/v1beta1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "moblab_proto", @@ -43,18 +72,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "moblab_java_proto", deps = [":moblab_proto"], @@ -71,6 +88,7 @@ java_gapic_library( srcs = [":moblab_proto_with_info"], gapic_yaml = "chromeosmoblab_gapic.yaml", grpc_service_config = "moblab_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosmoblab_v1beta1.yaml", test_deps = [ ":moblab_java_grpc", @@ -94,6 +112,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-chromeos-moblab-v1beta1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":moblab_java_gapic", @@ -103,17 +122,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "moblab_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -131,13 +139,14 @@ go_gapic_library( grpc_service_config = "moblab_grpc_service_config.json", importpath = "google.golang.org/google/chromeos/moblab/v1beta1;moblab", metadata = True, + rest_numeric_enums = True, service_yaml = "chromeosmoblab_v1beta1.yaml", transport = "grpc+rest", deps = [ ":moblab_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -159,20 +168,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "moblab_py_gapic", srcs = [":moblab_proto"], grpc_service_config = "moblab_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -194,17 +194,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "moblab_php_proto", deps = [":moblab_proto"], @@ -220,7 +209,9 @@ php_gapic_library( name = "moblab_php_gapic", srcs = [":moblab_proto_with_info"], grpc_service_config = "moblab_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosmoblab_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":moblab_php_grpc", ":moblab_php_proto", @@ -237,15 +228,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "moblab_nodejs_gapic", package_name = "@google-cloud/moblab", @@ -253,7 +235,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "moblab_grpc_service_config.json", package = "google.chromeos.moblab.v1beta1", + rest_numeric_enums = True, service_yaml = "chromeosmoblab_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -265,17 +249,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "moblab_ruby_proto", deps = [":moblab_proto"], @@ -292,6 +265,7 @@ ruby_cloud_gapic_library( srcs = [":moblab_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-chromeos-moblab-v1beta1"], grpc_service_config = "moblab_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":moblab_ruby_grpc", ":moblab_ruby_proto", @@ -308,17 +282,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "moblab_csharp_proto", deps = [":moblab_proto"], @@ -335,6 +298,7 @@ csharp_gapic_library( srcs = [":moblab_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "moblab_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosmoblab_v1beta1.yaml", deps = [ ":moblab_csharp_grpc", diff --git a/google/chromeos/uidetection/v1/BUILD.bazel b/google/chromeos/uidetection/v1/BUILD.bazel index 2e8855f24..1af86c343 100644 --- a/google/chromeos/uidetection/v1/BUILD.bazel +++ b/google/chromeos/uidetection/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "uidetection_proto", @@ -38,18 +69,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "uidetection_java_proto", deps = [":uidetection_proto"], @@ -66,6 +85,7 @@ java_gapic_library( srcs = [":uidetection_proto_with_info"], gapic_yaml = None, grpc_service_config = "ui_detection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosuidetection_v1.yaml", test_deps = [ ":uidetection_java_grpc", @@ -89,6 +109,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-chromeos-uidetection-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":uidetection_java_gapic", @@ -98,17 +119,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "uidetection_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -125,6 +135,7 @@ go_gapic_library( grpc_service_config = "ui_detection_grpc_service_config.json", importpath = "google.golang.org/google/chromeos/uidetection/v1;uidetection", metadata = True, + rest_numeric_enums = True, service_yaml = "chromeosuidetection_v1.yaml", transport = "grpc+rest", deps = [ @@ -150,20 +161,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "uidetection_py_gapic", srcs = [":uidetection_proto"], grpc_service_config = "ui_detection_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -185,17 +187,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "uidetection_php_proto", deps = [":uidetection_proto"], @@ -211,7 +202,9 @@ php_gapic_library( name = "uidetection_php_gapic", srcs = [":uidetection_proto_with_info"], grpc_service_config = "ui_detection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosuidetection_v1.yaml", + transport = "grpc+rest", deps = [ ":uidetection_php_grpc", ":uidetection_php_proto", @@ -228,15 +221,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "uidetection_nodejs_gapic", package_name = "@google-cloud/uidetection", @@ -244,7 +228,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "ui_detection_grpc_service_config.json", package = "google.chromeos.uidetection.v1", + rest_numeric_enums = True, service_yaml = "chromeosuidetection_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -256,17 +242,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "uidetection_ruby_proto", deps = [":uidetection_proto"], @@ -285,6 +260,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-chromeos-uidetection-v1", ], grpc_service_config = "ui_detection_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":uidetection_ruby_grpc", ":uidetection_ruby_proto", @@ -301,17 +277,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "uidetection_csharp_proto", deps = [":uidetection_proto"], @@ -328,6 +293,7 @@ csharp_gapic_library( srcs = [":uidetection_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "ui_detection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "chromeosuidetection_v1.yaml", deps = [ ":uidetection_csharp_grpc", @@ -345,15 +311,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "uidetection_cc_proto", deps = [":uidetection_proto"], diff --git a/google/cloud/accessapproval/v1/BUILD.bazel b/google/cloud/accessapproval/v1/BUILD.bazel index 558bd178c..ce86c6478 100644 --- a/google/cloud/accessapproval/v1/BUILD.bazel +++ b/google/cloud/accessapproval/v1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":accessapproval_proto_with_info"], gapic_yaml = "accessapproval_gapic.yaml", grpc_service_config = "accessapproval_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":accessapproval_java_grpc", ], @@ -127,6 +128,7 @@ go_gapic_library( srcs = [":accessapproval_proto_with_info"], grpc_service_config = "accessapproval_grpc_service_config.json", importpath = "cloud.google.com/go/accessapproval/apiv1;accessapproval", + rest_numeric_enums = True, service_yaml = "accessapproval_v1.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-access-approval", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -215,6 +218,8 @@ php_gapic_library( name = "accessapproval_php_gapic", srcs = [":accessapproval_proto_with_info"], grpc_service_config = "accessapproval_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":accessapproval_php_grpc", ":accessapproval_php_proto", @@ -247,7 +252,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "accessapproval_grpc_service_config.json", package = "google.cloud.accessapproval.v1", + rest_numeric_enums = True, service_yaml = "accessapproval_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -292,6 +299,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=accessapproval", ], grpc_service_config = "accessapproval_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "An API for controlling access to data by Google personnel.", ruby_cloud_title = "Access Approval V1", deps = [ @@ -337,6 +345,7 @@ csharp_gapic_library( srcs = [":accessapproval_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "accessapproval_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "accessapproval_v1.yaml", deps = [ ":accessapproval_csharp_grpc", diff --git a/google/cloud/aiplatform/v1/BUILD.bazel b/google/cloud/aiplatform/v1/BUILD.bazel index 2fb56baa1..a2b2c4da6 100644 --- a/google/cloud/aiplatform/v1/BUILD.bazel +++ b/google/cloud/aiplatform/v1/BUILD.bazel @@ -173,12 +173,14 @@ java_gapic_library( srcs = [":aiplatform_proto_with_info"], gapic_yaml = "aiplatform_gapic.yaml", grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1.yaml", test_deps = [ ":aiplatform_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ] + _JAVA_PROTO_SUBPACKAGE_DEPS, + transport = "grpc", deps = [ ":aiplatform_java_proto", "//google/api:api_java_proto", @@ -212,6 +214,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-aiplatform-v1-java", + transport = "grpc", deps = [ ":aiplatform_java_gapic", ":aiplatform_java_grpc", @@ -251,15 +254,17 @@ go_gapic_library( grpc_service_config = "aiplatform_grpc_service_config.json", importpath = "cloud.google.com/go/aiplatform/apiv1;aiplatform", metadata = True, + rest_numeric_enums = False, service_yaml = "aiplatform_v1.yaml", + transport = "grpc", deps = [ ":aiplatform_go_proto", "//google/api:httpbody_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", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -304,6 +309,7 @@ py_gapic_library( name = "aiplatform_py_gapic", srcs = [":aiplatform_proto"], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1.yaml", transport = "grpc", deps = [ @@ -355,7 +361,9 @@ php_gapic_library( name = "aiplatform_php_gapic", srcs = [":aiplatform_proto_with_info"], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1.yaml", + transport = "grpc+rest", deps = [ ":aiplatform_php_grpc", ":aiplatform_php_proto", @@ -388,7 +396,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "aiplatform_grpc_service_config.json", package = "google.cloud.aiplatform.v1", + rest_numeric_enums = False, service_yaml = "aiplatform_v1.yaml", + transport = "grpc", deps = [], ) @@ -434,6 +444,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=AiPlatform=AIPlatform", ], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "Vertex AI enables data scientists, developers, and AI newcomers to create custom machine learning models specific to their business needs by leveraging Google's state-of-the-art transfer learning and innovative AI research.", ruby_cloud_title = "Vertex AI V1", service_yaml = "aiplatform_v1.yaml", diff --git a/google/cloud/aiplatform/v1/aiplatform_v1.yaml b/google/cloud/aiplatform/v1/aiplatform_v1.yaml index 2ece033b3..049ab20b6 100644 --- a/google/cloud/aiplatform/v1/aiplatform_v1.yaml +++ b/google/cloud/aiplatform/v1/aiplatform_v1.yaml @@ -133,9 +133,7 @@ backend: deadline: 60.0 - selector: 'google.cloud.aiplatform.v1.EndpointService.*' deadline: 60.0 - - selector: google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues - deadline: 60.0 - - selector: google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues + - selector: 'google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.*' deadline: 60.0 - selector: 'google.cloud.aiplatform.v1.FeaturestoreService.*' deadline: 60.0 @@ -513,11 +511,7 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform - - selector: google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues + - selector: 'google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.*' oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/aiplatform/v1/annotation_spec.proto b/google/cloud/aiplatform/v1/annotation_spec.proto index 3082e3ee9..582eb109b 100644 --- a/google/cloud/aiplatform/v1/annotation_spec.proto +++ b/google/cloud/aiplatform/v1/annotation_spec.proto @@ -39,7 +39,7 @@ message AnnotationSpec { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the AnnotationSpec. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1/artifact.proto b/google/cloud/aiplatform/v1/artifact.proto index d7ef997ad..be52fcc63 100644 --- a/google/cloud/aiplatform/v1/artifact.proto +++ b/google/cloud/aiplatform/v1/artifact.proto @@ -101,6 +101,7 @@ message Artifact { string schema_version = 15; // Properties of the Artifact. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 16; diff --git a/google/cloud/aiplatform/v1/batch_prediction_job.proto b/google/cloud/aiplatform/v1/batch_prediction_job.proto index 21568cee0..4673b09fd 100644 --- a/google/cloud/aiplatform/v1/batch_prediction_job.proto +++ b/google/cloud/aiplatform/v1/batch_prediction_job.proto @@ -204,6 +204,15 @@ message BatchPredictionJob { // must be provided. BatchDedicatedResources dedicated_resources = 7; + // The service account that the DeployedModel's container runs as. If not + // specified, a system generated one will be used, which + // has minimal permissions and the custom container, if used, may not have + // enough permission to access other Google Cloud resources. + // + // Users deploying the Model must have the `iam.serviceAccounts.actAs` + // 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). @@ -248,7 +257,7 @@ message BatchPredictionJob { // Output only. Partial failures encountered. // For example, single files that can't be read. // This field never exceeds 20 entries. - // Status details fields contain standard GCP error details. + // Status details fields contain standard Google Cloud error details. 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. diff --git a/google/cloud/aiplatform/v1/context.proto b/google/cloud/aiplatform/v1/context.proto index b602a5504..1055ea93d 100644 --- a/google/cloud/aiplatform/v1/context.proto +++ b/google/cloud/aiplatform/v1/context.proto @@ -86,6 +86,7 @@ message Context { string schema_version = 14; // Properties of the Context. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/google/cloud/aiplatform/v1/custom_job.proto b/google/cloud/aiplatform/v1/custom_job.proto index af3de68b7..31ed742fc 100644 --- a/google/cloud/aiplatform/v1/custom_job.proto +++ b/google/cloud/aiplatform/v1/custom_job.proto @@ -49,7 +49,7 @@ message CustomJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the CustomJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1/data_labeling_job.proto b/google/cloud/aiplatform/v1/data_labeling_job.proto index f136190ba..45d176e9b 100644 --- a/google/cloud/aiplatform/v1/data_labeling_job.proto +++ b/google/cloud/aiplatform/v1/data_labeling_job.proto @@ -45,7 +45,7 @@ message DataLabelingJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the DataLabelingJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a DataLabelingJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1/dataset.proto b/google/cloud/aiplatform/v1/dataset.proto index 6c686986a..ae14e7bf6 100644 --- a/google/cloud/aiplatform/v1/dataset.proto +++ b/google/cloud/aiplatform/v1/dataset.proto @@ -42,12 +42,12 @@ message Dataset { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the Dataset. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; - // Optional. The description of the Dataset. - string description = 16 [(google.api.field_behavior) = OPTIONAL]; + // 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. @@ -88,6 +88,11 @@ message Dataset { // 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 + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Describes the location from where we import data into a Dataset, together @@ -112,6 +117,15 @@ message ImportDataConfig { // 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. + 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 diff --git a/google/cloud/aiplatform/v1/dataset_service.proto b/google/cloud/aiplatform/v1/dataset_service.proto index c26f60e33..4a59848d9 100644 --- a/google/cloud/aiplatform/v1/dataset_service.proto +++ b/google/cloud/aiplatform/v1/dataset_service.proto @@ -127,6 +127,13 @@ service DatasetService { option (google.api.method_signature) = "parent"; } + // Searches DataItems in a Dataset. + 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) { option (google.api.http) = { @@ -368,6 +375,135 @@ message ListDataItemsResponse { string next_page_token = 2; } +// 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. + string saved_query = 1 [(google.api.field_behavior) = REQUIRED]; + + // A comma-separated list of annotation fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. Must also + // specify saved_query. + string order_by = 2; + } + + oneof order { + // A comma-separated list of data item fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. + string order_by_data_item = 12; + + // Expression that allows ranking results based on annotation's property. + OrderByAnnotation order_by_annotation = 13; + } + + // Required. The resource name of the Dataset from which to search DataItems. + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}` + string dataset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Dataset" + } + ]; + + // The resource name of a SavedQuery(annotation set in UI). + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + // All of the search will be done in the context of this SavedQuery. + string saved_query = 2 [ + deprecated = true, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/SavedQuery" + } + ]; + + // The resource name of a DataLabelingJob. + // Format: + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + // If this field is set, all of the search will be done in the context of + // this DataLabelingJob. + string data_labeling_job = 3; + + // An expression for filtering the DataItem that will be returned. + // + // * `data_item_id` - for = or !=. + // * `labeled` - for = or !=. + // * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + // have at least one annotation with annotation_spec_id = + // `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + // + // For example: + // + // * `data_item=1` + // * `has_annotation(5)` + string data_item_filter = 4; + + // An expression for filtering the Annotations that will be returned per + // DataItem. + // * `annotation_spec_id` - for = or !=. + string annotations_filter = 5 [deprecated = true]; + + // An expression that specifies what Annotations will be returned per + // DataItem. Annotations satisfied either of the conditions will be returned. + // * `annotation_spec_id` - for = or !=. + // Must specify `saved_query_id=` - saved query id that annotations should + // belong to. + repeated string annotation_filters = 11; + + // 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 + // DataItemView. The maximum value is 1000. If not set, the maximum value will + // be used. + int32 annotations_limit = 7; + + // Requested page size. Server may return fewer results than requested. + // Default and maximum page size is 100. + int32 page_size = 8; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + string order_by = 9 [deprecated = true]; + + // 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. + string page_token = 10; +} + +// 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. + string next_page_token = 2; +} + +// A container for a single DataItem and Annotations on it. +message DataItemView { + // The DataItem. + DataItem data_item = 1; + + // The Annotations on the DataItem. If too many Annotations should be returned + // for the DataItem, this field will be truncated per annotations_limit in + // request. If it was, then the has_truncated_annotations will be set to true. + repeated Annotation annotations = 2; + + // True if and only if the Annotations field has been truncated. It happens if + // more Annotations for this DataItem met the request's annotation_filter than + // are allowed to be returned by annotations_limit. + // Note that if Annotations field is not being returned due to field mask, + // then this field will not be set to true no matter how many Annotations are + // there. + bool has_truncated_annotations = 3; +} + // Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries]. message ListSavedQueriesRequest { // Required. The resource name of the Dataset to list SavedQueries from. diff --git a/google/cloud/aiplatform/v1/endpoint.proto b/google/cloud/aiplatform/v1/endpoint.proto index 6d48f8f22..39a3f5007 100644 --- a/google/cloud/aiplatform/v1/endpoint.proto +++ b/google/cloud/aiplatform/v1/endpoint.proto @@ -44,7 +44,7 @@ message Endpoint { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Endpoint. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1/execution.proto b/google/cloud/aiplatform/v1/execution.proto index a2b7c2b90..0d9dcea5a 100644 --- a/google/cloud/aiplatform/v1/execution.proto +++ b/google/cloud/aiplatform/v1/execution.proto @@ -107,6 +107,7 @@ message Execution { string schema_version = 14; // Properties of the Execution. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/google/cloud/aiplatform/v1/featurestore.proto b/google/cloud/aiplatform/v1/featurestore.proto index 4c8a72f59..46b19f60e 100644 --- a/google/cloud/aiplatform/v1/featurestore.proto +++ b/google/cloud/aiplatform/v1/featurestore.proto @@ -116,8 +116,10 @@ message Featurestore { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Config for online storage resources. If unset, the featurestore will - // not have an online store and cannot be used for online serving. + // 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. diff --git a/google/cloud/aiplatform/v1/featurestore_online_service.proto b/google/cloud/aiplatform/v1/featurestore_online_service.proto index 915c4c3fb..bf9fa7190 100644 --- a/google/cloud/aiplatform/v1/featurestore_online_service.proto +++ b/google/cloud/aiplatform/v1/featurestore_online_service.proto @@ -58,6 +58,55 @@ service FeaturestoreOnlineServingService { }; option (google.api.method_signature) = "entity_type"; } + + // Writes Feature values of one or more entities of an EntityType. + // + // 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) { + option (google.api.http) = { + post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues" + body: "*" + }; + option (google.api.method_signature) = "entity_type,payloads"; + } +} + +// 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/ + // {featurestore}/entityTypes/{entityType}`. For example, + // for a machine learning model predicting user clicks on a website, an + // EntityType ID could be `user`. + string entity_type = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/EntityType" + } + ]; + + // 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. +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 + // years (1825 days) and no later than one year (366 days) in the future. + map feature_values = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues]. +message WriteFeatureValuesResponse { + } // Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues]. diff --git a/google/cloud/aiplatform/v1/featurestore_service.proto b/google/cloud/aiplatform/v1/featurestore_service.proto index 516092ee1..930d45c19 100644 --- a/google/cloud/aiplatform/v1/featurestore_service.proto +++ b/google/cloud/aiplatform/v1/featurestore_service.proto @@ -614,6 +614,11 @@ message BatchReadFeatureValuesRequest { // specifying entity IDs in the EntityType in // [BatchReadFeatureValuesRequest.request][] . 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. + // Timestamp, if present, must not have higher than millisecond precision. + google.protobuf.Timestamp start_time = 11 [(google.api.field_behavior) = OPTIONAL]; } // Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues]. @@ -898,7 +903,7 @@ message CreateFeatureRequest { // 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 60 characters, and valid characters are + // This value may be up to 128 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. // // The value must be unique within an EntityType. @@ -1191,6 +1196,9 @@ message ImportFeatureValuesOperationMetadata { // Number of Feature values that have been imported by the operation. int64 imported_feature_value_count = 3; + // The source URI from where Feature values are imported. + repeated string source_uris = 4; + // The number of rows in input source that weren't imported due to either // * Not having any featureValues. // * Having a null entityId. diff --git a/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto b/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto index dfe173dcc..77dc1ec53 100644 --- a/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto +++ b/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto @@ -46,7 +46,7 @@ message HyperparameterTuningJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the HyperparameterTuningJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1/index.proto b/google/cloud/aiplatform/v1/index.proto index 69fde66a7..28022afce 100644 --- a/google/cloud/aiplatform/v1/index.proto +++ b/google/cloud/aiplatform/v1/index.proto @@ -57,7 +57,7 @@ message Index { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Index. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1/index_endpoint.proto b/google/cloud/aiplatform/v1/index_endpoint.proto index 9f1e9941b..a5e36557e 100644 --- a/google/cloud/aiplatform/v1/index_endpoint.proto +++ b/google/cloud/aiplatform/v1/index_endpoint.proto @@ -85,7 +85,7 @@ message IndexEndpoint { // are mutually exclusive. // // [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - // projects/{project}/global/networks/{network}. + // `projects/{project}/global/networks/{network}`. // Where {project} is a project number, as in '12345', and {network} is // network name. string network = 9 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/aiplatform/v1/job_service.proto b/google/cloud/aiplatform/v1/job_service.proto index 7e987dfde..cf9e9abd2 100644 --- a/google/cloud/aiplatform/v1/job_service.proto +++ b/google/cloud/aiplatform/v1/job_service.proto @@ -816,7 +816,7 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { // 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 affect in this case. + // 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; diff --git a/google/cloud/aiplatform/v1/metadata_service.proto b/google/cloud/aiplatform/v1/metadata_service.proto index e1dd4fcc0..683f8ebd9 100644 --- a/google/cloud/aiplatform/v1/metadata_service.proto +++ b/google/cloud/aiplatform/v1/metadata_service.proto @@ -556,7 +556,8 @@ message ListArtifactsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -750,7 +751,8 @@ message ListContextsRequest { // ``` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1048,7 +1050,9 @@ message ListExecutionsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. + // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1310,7 +1314,8 @@ message QueryArtifactLineageSubgraphRequest { // For example: `metadata.field_1.number_value = 10.0` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 3; diff --git a/google/cloud/aiplatform/v1/model.proto b/google/cloud/aiplatform/v1/model.proto index f34fad6ed..767570187 100644 --- a/google/cloud/aiplatform/v1/model.proto +++ b/google/cloud/aiplatform/v1/model.proto @@ -118,9 +118,9 @@ message Model { // User provided version aliases so that a model version can be referenced via // alias (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_alias} + // `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` // instead of auto-generated version id (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_id}). + // `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. // The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from // version_id. A default version alias will be created for the first version // of the model, and there must be exactly one default version alias for a @@ -134,7 +134,7 @@ message Model { 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 be consist of any UTF-8 + // 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]; @@ -332,6 +332,11 @@ message Model { // 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. 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 diff --git a/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto b/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto index 87252239d..25983312e 100644 --- a/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto +++ b/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto @@ -96,7 +96,7 @@ message ModelDeploymentMonitoringJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the ModelDeploymentMonitoringJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a ModelDeploymentMonitoringJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1/model_service.proto b/google/cloud/aiplatform/v1/model_service.proto index 9ea6c56c4..b20d32d31 100644 --- a/google/cloud/aiplatform/v1/model_service.proto +++ b/google/cloud/aiplatform/v1/model_service.proto @@ -218,6 +218,15 @@ message UploadModelRequest { // Required. The Model to create. Model model = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The user-provided custom service account to use to do the model + // upload. If empty, [Vertex AI Service + // Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + // will be used. Users uploading the Model must have the + // `iam.serviceAccounts.actAs` permission on this service account. Also, this + // account must belong to the project specified in the `parent` field and have + // all necessary read permissions. + string service_account = 6 [(google.api.field_behavior) = OPTIONAL]; } // Details of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation. diff --git a/google/cloud/aiplatform/v1/operation.proto b/google/cloud/aiplatform/v1/operation.proto index da7c5dcc2..cd27fcc56 100644 --- a/google/cloud/aiplatform/v1/operation.proto +++ b/google/cloud/aiplatform/v1/operation.proto @@ -33,7 +33,7 @@ message GenericOperationMetadata { // Output only. Partial failures encountered. // E.g. single files that couldn't be read. // This field should never exceed 20 entries. - // Status details field will contain standard GCP error details. + // Status details field will contain standard Google Cloud error details. repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was created. diff --git a/google/cloud/aiplatform/v1/pipeline_job.proto b/google/cloud/aiplatform/v1/pipeline_job.proto index 656a385b9..d424f09ed 100644 --- a/google/cloud/aiplatform/v1/pipeline_job.proto +++ b/google/cloud/aiplatform/v1/pipeline_job.proto @@ -54,8 +54,8 @@ message PipelineJob { message InputArtifact { oneof kind { // Artifact resource id from MLMD. Which is the last portion of an - // artifact resource - // name(projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}). + // artifact resource name: + // `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. // The artifact must stay within the same project, location and default // metadatastore as the pipeline. string artifact_id = 1; @@ -103,7 +103,7 @@ message PipelineJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // The display name of the Pipeline. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2; @@ -168,8 +168,8 @@ message PipelineJob { // network name. // // Private services access must already be configured for the network. - // Pipeline job will apply the network configuration to the GCP resources - // being launched, if applied, such as Vertex AI + // Pipeline job will apply the network configuration to the Google Cloud + // 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) = { @@ -337,6 +337,17 @@ message PipelineTaskExecutorDetail { type: "aiplatform.googleapis.com/CustomJob" } ]; + + // 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]; + + // 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]; } // The detailed info for a custom job executor. diff --git a/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel b/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel index c34bac4e2..9aaf07fb7 100644 --- a/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel +++ b/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel @@ -102,6 +102,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1.schema.predict", "python-gapic-name=instance", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel b/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel index 371fe2b9f..7ce198545 100644 --- a/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel +++ b/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel @@ -99,6 +99,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1.schema.predict", "python-gapic-name=params", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel b/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel index 7e9de2de2..64ffb8ef2 100644 --- a/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel +++ b/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel @@ -111,6 +111,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1.schema.predict", # Replace with the current version "python-gapic-name=prediction", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel b/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel index 848375765..eb5fa85bf 100644 --- a/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel +++ b/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel @@ -107,6 +107,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1.schema.trainingjob", "python-gapic-name=definition", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1/specialist_pool.proto b/google/cloud/aiplatform/v1/specialist_pool.proto index 0e620e6a1..442874716 100644 --- a/google/cloud/aiplatform/v1/specialist_pool.proto +++ b/google/cloud/aiplatform/v1/specialist_pool.proto @@ -43,7 +43,7 @@ message SpecialistPool { string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The user-defined name of the SpecialistPool. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // This field should be unique on project-level. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1/tensorboard.proto b/google/cloud/aiplatform/v1/tensorboard.proto index 84a245d90..8a19066ac 100644 --- a/google/cloud/aiplatform/v1/tensorboard.proto +++ b/google/cloud/aiplatform/v1/tensorboard.proto @@ -30,7 +30,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; option ruby_package = "Google::Cloud::AIPlatform::V1"; // Tensorboard is a physical database that stores users' training metrics. -// A default Tensorboard is provided in each region of a GCP project. +// A default Tensorboard is provided in each region of a Google Cloud project. // If needed users can also create extra Tensorboards in their projects. message Tensorboard { option (google.api.resource) = { diff --git a/google/cloud/aiplatform/v1/tensorboard_service.proto b/google/cloud/aiplatform/v1/tensorboard_service.proto index ed81dd1f2..ec59778bd 100644 --- a/google/cloud/aiplatform/v1/tensorboard_service.proto +++ b/google/cloud/aiplatform/v1/tensorboard_service.proto @@ -467,7 +467,7 @@ message GetTensorboardExperimentRequest { message ListTensorboardExperimentsRequest { // Required. The resource name of the Tensorboard to list TensorboardExperiments. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -605,7 +605,7 @@ message GetTensorboardRunRequest { message ReadTensorboardBlobDataRequest { // Required. The resource name of the TensorboardTimeSeries to list Blobs. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string time_series = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -627,7 +627,7 @@ message ReadTensorboardBlobDataResponse { message ListTensorboardRunsRequest { // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -767,7 +767,7 @@ message GetTensorboardTimeSeriesRequest { message ListTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/aiplatform/v1/training_pipeline.proto b/google/cloud/aiplatform/v1/training_pipeline.proto index a0de8cf40..ef5f35398 100644 --- a/google/cloud/aiplatform/v1/training_pipeline.proto +++ b/google/cloud/aiplatform/v1/training_pipeline.proto @@ -290,6 +290,9 @@ message InputDataConfig { // 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. + bool persist_ml_use_assignment = 11; } // Assigns the input data to training, validation, and test sets as per the diff --git a/google/cloud/aiplatform/v1/user_action_reference.proto b/google/cloud/aiplatform/v1/user_action_reference.proto index bf4c9f933..102dac6d4 100644 --- a/google/cloud/aiplatform/v1/user_action_reference.proto +++ b/google/cloud/aiplatform/v1/user_action_reference.proto @@ -31,13 +31,13 @@ message UserActionReference { // For API calls that return a long running operation. // Resource name of the long running operation. // Format: - // 'projects/{project}/locations/{location}/operations/{operation}' + // `projects/{project}/locations/{location}/operations/{operation}` string operation = 1; // For API calls that start a LabelingJob. // Resource name of the LabelingJob. // Format: - // 'projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}' + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string data_labeling_job = 2; } diff --git a/google/cloud/aiplatform/v1beta1/BUILD.bazel b/google/cloud/aiplatform/v1beta1/BUILD.bazel index ae11c9d6e..53fa404f9 100644 --- a/google/cloud/aiplatform/v1beta1/BUILD.bazel +++ b/google/cloud/aiplatform/v1beta1/BUILD.bazel @@ -169,12 +169,14 @@ java_gapic_library( srcs = [":aiplatform_proto_with_info"], gapic_yaml = None, grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1beta1.yaml", test_deps = [ ":aiplatform_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ] + _JAVA_GRPC_SUBPACKAGE_DEPS, + transport = "grpc", deps = [ ":aiplatform_java_proto", "//google/api:api_java_proto", @@ -208,6 +210,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-aiplatform-v1beta1-java", + transport = "grpc", deps = [ ":aiplatform_java_gapic", ":aiplatform_java_grpc", @@ -248,15 +251,17 @@ go_gapic_library( grpc_service_config = "aiplatform_grpc_service_config.json", importpath = "cloud.google.com/go/aiplatform/apiv1beta1;aiplatform", metadata = True, + rest_numeric_enums = False, service_yaml = "aiplatform_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":aiplatform_go_proto", "//google/api:httpbody_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", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -301,6 +306,7 @@ py_gapic_library( name = "aiplatform_py_gapic", srcs = [":aiplatform_proto"], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1beta1.yaml", transport = "grpc", deps = [ @@ -352,7 +358,9 @@ php_gapic_library( name = "aiplatform_php_gapic", srcs = [":aiplatform_proto_with_info"], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "aiplatform_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":aiplatform_php_grpc", ":aiplatform_php_proto", @@ -385,7 +393,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "aiplatform_grpc_service_config.json", package = "google.cloud.aiplatform.v1beta1", + rest_numeric_enums = False, service_yaml = "aiplatform_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -424,6 +434,7 @@ ruby_cloud_gapic_library( srcs = [":aiplatform_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-aiplatform-v1beta1"], grpc_service_config = "aiplatform_grpc_service_config.json", + rest_numeric_enums = False, deps = [ ":aiplatform_ruby_grpc", ":aiplatform_ruby_proto", diff --git a/google/cloud/aiplatform/v1beta1/accelerator_type.proto b/google/cloud/aiplatform/v1beta1/accelerator_type.proto index af624cb73..4d4c3b8f0 100644 --- a/google/cloud/aiplatform/v1beta1/accelerator_type.proto +++ b/google/cloud/aiplatform/v1beta1/accelerator_type.proto @@ -47,6 +47,9 @@ enum AcceleratorType { // Nvidia Tesla A100 GPU. NVIDIA_TESLA_A100 = 8; + // Nvidia A2 Ultra GPU. + NVIDIA_A100_80GB = 9; + // TPU v2. TPU_V2 = 6; diff --git a/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml b/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml index 4d4e07546..41fce9d80 100644 --- a/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml +++ b/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml @@ -257,10 +257,12 @@ http: - post: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel' + - post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel' + - post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel' - post: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:cancel' @@ -319,10 +321,12 @@ http: - delete: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}' + - delete: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}' + - delete: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/operations/*}' - delete: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}' @@ -382,10 +386,12 @@ http: - get: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}' + - get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}' + - get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/operations/*}' - get: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}' @@ -444,10 +450,12 @@ http: - get: '/v1beta1/{name=projects/*/locations/*/migratableResources/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/models/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations' + - get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations' + - get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/tensorboards/*}/operations' - get: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}/operations' @@ -506,10 +514,12 @@ http: - post: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait' + - post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait' + - post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/operations/*}:wait' - post: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:wait' diff --git a/google/cloud/aiplatform/v1beta1/annotation_spec.proto b/google/cloud/aiplatform/v1beta1/annotation_spec.proto index 5d4c5664e..bb5738ebc 100644 --- a/google/cloud/aiplatform/v1beta1/annotation_spec.proto +++ b/google/cloud/aiplatform/v1beta1/annotation_spec.proto @@ -39,7 +39,7 @@ message AnnotationSpec { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the AnnotationSpec. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1beta1/artifact.proto b/google/cloud/aiplatform/v1beta1/artifact.proto index 378afb3f7..daab79bb3 100644 --- a/google/cloud/aiplatform/v1beta1/artifact.proto +++ b/google/cloud/aiplatform/v1beta1/artifact.proto @@ -101,6 +101,7 @@ message Artifact { string schema_version = 15; // Properties of the Artifact. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 16; diff --git a/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto b/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto index 63fb0d9d0..39b2af831 100644 --- a/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto +++ b/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto @@ -73,6 +73,91 @@ message BatchPredictionJob { string instances_format = 1 [(google.api.field_behavior) = REQUIRED]; } + // 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.v1beta1.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.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. + // * 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.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 + // 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.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. + // * 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.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. + // + // 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.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. + // + // 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. @@ -183,6 +268,10 @@ message BatchPredictionJob { // [instance_schema_uri][google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] @@ -209,7 +298,7 @@ message BatchPredictionJob { // The service account that the DeployedModel's container runs as. If not // specified, a system generated one will be used, which // has minimal permissions and the custom container, if used, may not have - // enough permission to access other GCP resources. + // enough permission to access other Google Cloud resources. // // Users deploying the Model must have the `iam.serviceAccounts.actAs` // permission on this service account. @@ -259,7 +348,7 @@ message BatchPredictionJob { // Output only. Partial failures encountered. // For example, single files that can't be read. // This field never exceeds 20 entries. - // Status details fields contain standard GCP error details. + // Status details fields contain standard Google Cloud error details. 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. diff --git a/google/cloud/aiplatform/v1beta1/context.proto b/google/cloud/aiplatform/v1beta1/context.proto index 7f81ce4c0..9f4c90c6e 100644 --- a/google/cloud/aiplatform/v1beta1/context.proto +++ b/google/cloud/aiplatform/v1beta1/context.proto @@ -86,6 +86,7 @@ message Context { string schema_version = 14; // Properties of the Context. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/google/cloud/aiplatform/v1beta1/custom_job.proto b/google/cloud/aiplatform/v1beta1/custom_job.proto index 24d384ff6..d6cd91f71 100644 --- a/google/cloud/aiplatform/v1beta1/custom_job.proto +++ b/google/cloud/aiplatform/v1beta1/custom_job.proto @@ -49,7 +49,7 @@ message CustomJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the CustomJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1beta1/data_labeling_job.proto b/google/cloud/aiplatform/v1beta1/data_labeling_job.proto index 3a7160a56..0e65f1993 100644 --- a/google/cloud/aiplatform/v1beta1/data_labeling_job.proto +++ b/google/cloud/aiplatform/v1beta1/data_labeling_job.proto @@ -45,7 +45,7 @@ message DataLabelingJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the DataLabelingJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a DataLabelingJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1beta1/dataset.proto b/google/cloud/aiplatform/v1beta1/dataset.proto index 5d1f197f4..04b3a67b7 100644 --- a/google/cloud/aiplatform/v1beta1/dataset.proto +++ b/google/cloud/aiplatform/v1beta1/dataset.proto @@ -42,12 +42,12 @@ message Dataset { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the Dataset. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; - // Optional. The description of the Dataset. - string description = 16 [(google.api.field_behavior) = OPTIONAL]; + // 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. @@ -88,6 +88,11 @@ message Dataset { // 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 + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Describes the location from where we import data into a Dataset, together @@ -112,6 +117,15 @@ message ImportDataConfig { // 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 + // [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. + 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 diff --git a/google/cloud/aiplatform/v1beta1/dataset_service.proto b/google/cloud/aiplatform/v1beta1/dataset_service.proto index 3be59c059..a93ca3905 100644 --- a/google/cloud/aiplatform/v1beta1/dataset_service.proto +++ b/google/cloud/aiplatform/v1beta1/dataset_service.proto @@ -127,6 +127,13 @@ service DatasetService { option (google.api.method_signature) = "parent"; } + // Searches DataItems in a Dataset. + 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) { option (google.api.http) = { @@ -368,6 +375,135 @@ message ListDataItemsResponse { string next_page_token = 2; } +// 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. + string saved_query = 1 [(google.api.field_behavior) = REQUIRED]; + + // A comma-separated list of annotation fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. Must also + // specify saved_query. + string order_by = 2; + } + + oneof order { + // A comma-separated list of data item fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. + string order_by_data_item = 12; + + // Expression that allows ranking results based on annotation's property. + OrderByAnnotation order_by_annotation = 13; + } + + // Required. The resource name of the Dataset from which to search DataItems. + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}` + string dataset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Dataset" + } + ]; + + // The resource name of a SavedQuery(annotation set in UI). + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + // All of the search will be done in the context of this SavedQuery. + string saved_query = 2 [ + deprecated = true, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/SavedQuery" + } + ]; + + // The resource name of a DataLabelingJob. + // Format: + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + // If this field is set, all of the search will be done in the context of + // this DataLabelingJob. + string data_labeling_job = 3; + + // An expression for filtering the DataItem that will be returned. + // + // * `data_item_id` - for = or !=. + // * `labeled` - for = or !=. + // * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + // have at least one annotation with annotation_spec_id = + // `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + // + // For example: + // + // * `data_item=1` + // * `has_annotation(5)` + string data_item_filter = 4; + + // An expression for filtering the Annotations that will be returned per + // DataItem. + // * `annotation_spec_id` - for = or !=. + string annotations_filter = 5 [deprecated = true]; + + // An expression that specifies what Annotations will be returned per + // DataItem. Annotations satisfied either of the conditions will be returned. + // * `annotation_spec_id` - for = or !=. + // Must specify `saved_query_id=` - saved query id that annotations should + // belong to. + repeated string annotation_filters = 11; + + // 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 + // DataItemView. The maximum value is 1000. If not set, the maximum value will + // be used. + int32 annotations_limit = 7; + + // Requested page size. Server may return fewer results than requested. + // Default and maximum page size is 100. + int32 page_size = 8; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + string order_by = 9 [deprecated = true]; + + // 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. + string page_token = 10; +} + +// 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. + string next_page_token = 2; +} + +// A container for a single DataItem and Annotations on it. +message DataItemView { + // The DataItem. + DataItem data_item = 1; + + // The Annotations on the DataItem. If too many Annotations should be returned + // for the DataItem, this field will be truncated per annotations_limit in + // request. If it was, then the has_truncated_annotations will be set to true. + repeated Annotation annotations = 2; + + // True if and only if the Annotations field has been truncated. It happens if + // more Annotations for this DataItem met the request's annotation_filter than + // are allowed to be returned by annotations_limit. + // Note that if Annotations field is not being returned due to field mask, + // then this field will not be set to true no matter how many Annotations are + // there. + bool has_truncated_annotations = 3; +} + // Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries]. message ListSavedQueriesRequest { // Required. The resource name of the Dataset to list SavedQueries from. diff --git a/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto b/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto index 2249e655c..e273a1552 100644 --- a/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto +++ b/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto @@ -39,7 +39,7 @@ message DeploymentResourcePool { // Output only. The resource name of the DeploymentResourcePool. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `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. diff --git a/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto b/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto index 11eddf67c..1c02d761d 100644 --- a/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto +++ b/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto @@ -92,7 +92,7 @@ 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} + // created. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -122,7 +122,7 @@ message CreateDeploymentResourcePoolOperationMetadata { message GetDeploymentResourcePoolRequest { // Required. The name of the DeploymentResourcePool to retrieve. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -134,7 +134,7 @@ message GetDeploymentResourcePoolRequest { // Request message for ListDeploymentResourcePools method. message ListDeploymentResourcePoolsRequest { // Required. The parent Location which owns this collection of DeploymentResourcePools. - // Format: projects/{project}/locations/{location} + // Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -175,7 +175,7 @@ message UpdateDeploymentResourcePoolOperationMetadata { message DeleteDeploymentResourcePoolRequest { // Required. The name of the DeploymentResourcePool to delete. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -188,7 +188,7 @@ message DeleteDeploymentResourcePoolRequest { message QueryDeployedModelsRequest { // Required. The name of the target DeploymentResourcePool to query. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string deployment_resource_pool = 1 [(google.api.field_behavior) = REQUIRED]; // The maximum number of DeployedModels to return. The service may return @@ -216,4 +216,11 @@ message QueryDeployedModelsResponse { // References to the DeployedModels that share the specified // deploymentResourcePool. repeated DeployedModelRef deployed_model_refs = 3; + + // The total number of DeployedModels on this DeploymentResourcePool. + int32 total_deployed_model_count = 4; + + // The total number of Endpoints that have DeployedModels on this + // DeploymentResourcePool. + int32 total_endpoint_count = 5; } diff --git a/google/cloud/aiplatform/v1beta1/endpoint.proto b/google/cloud/aiplatform/v1beta1/endpoint.proto index 0236e532f..4ff0ebb81 100644 --- a/google/cloud/aiplatform/v1beta1/endpoint.proto +++ b/google/cloud/aiplatform/v1beta1/endpoint.proto @@ -44,7 +44,7 @@ message Endpoint { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Endpoint. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; @@ -149,7 +149,7 @@ message DeployedModel { // The resource name of the shared DeploymentResourcePool to deploy on. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string shared_resources = 17 [(google.api.resource_reference) = { type: "aiplatform.googleapis.com/DeploymentResourcePool" }]; diff --git a/google/cloud/aiplatform/v1beta1/entity_type.proto b/google/cloud/aiplatform/v1beta1/entity_type.proto index 14f762bac..9bb2cdf09 100644 --- a/google/cloud/aiplatform/v1beta1/entity_type.proto +++ b/google/cloud/aiplatform/v1beta1/entity_type.proto @@ -83,4 +83,11 @@ message EntityType { // analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is // disabled. 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. + // The Feature Store offline storage periodically removes obsolete feature + // values older than `offline_storage_ttl_days` since the feature generation + // time. If unset (or explicitly set to 0), default to 4000 days TTL. + int32 offline_storage_ttl_days = 10 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/google/cloud/aiplatform/v1beta1/execution.proto b/google/cloud/aiplatform/v1beta1/execution.proto index 74395db99..281b2a193 100644 --- a/google/cloud/aiplatform/v1beta1/execution.proto +++ b/google/cloud/aiplatform/v1beta1/execution.proto @@ -107,6 +107,7 @@ message Execution { string schema_version = 14; // Properties of the Execution. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/google/cloud/aiplatform/v1beta1/featurestore.proto b/google/cloud/aiplatform/v1beta1/featurestore.proto index f5ece8f20..3a3026e77 100644 --- a/google/cloud/aiplatform/v1beta1/featurestore.proto +++ b/google/cloud/aiplatform/v1beta1/featurestore.proto @@ -116,13 +116,24 @@ message Featurestore { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Config for online storage resources. If unset, the featurestore will - // not have an online store and cannot be used for online serving. + // 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 + 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. EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/aiplatform/v1beta1/featurestore_service.proto b/google/cloud/aiplatform/v1beta1/featurestore_service.proto index 56df4670f..5db9e02bf 100644 --- a/google/cloud/aiplatform/v1beta1/featurestore_service.proto +++ b/google/cloud/aiplatform/v1beta1/featurestore_service.proto @@ -442,6 +442,7 @@ message UpdateFeaturestoreRequest { // * `labels` // * `online_serving_config.fixed_node_count` // * `online_serving_config.scaling` + // * `online_storage_ttl_days` google.protobuf.FieldMask update_mask = 2; } @@ -637,6 +638,11 @@ message BatchReadFeatureValuesRequest { // specifying entity IDs in the EntityType in // [BatchReadFeatureValuesRequest.request][] . 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. + // Timestamp, if present, must not have higher than millisecond precision. + google.protobuf.Timestamp start_time = 11 [(google.api.field_behavior) = OPTIONAL]; } // Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues]. @@ -883,6 +889,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` google.protobuf.FieldMask update_mask = 2; } @@ -921,7 +928,7 @@ message CreateFeatureRequest { // 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 60 characters, and valid characters are + // This value may be up to 128 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. // // The value must be unique within an EntityType. @@ -1214,6 +1221,9 @@ message ImportFeatureValuesOperationMetadata { // Number of Feature values that have been imported by the operation. int64 imported_feature_value_count = 3; + // The source URI from where Feature values are imported. + repeated string source_uris = 4; + // The number of rows in input source that weren't imported due to either // * Not having any featureValues. // * Having a null entityId. @@ -1275,7 +1285,10 @@ message DeleteFeatureValuesRequest { // Message to select time range and feature. // Values of the selected feature generated within an inclusive time range - // will be deleted. + // 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. diff --git a/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto b/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto index 4e994e1e7..587680bc3 100644 --- a/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto +++ b/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto @@ -46,7 +46,7 @@ message HyperparameterTuningJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the HyperparameterTuningJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1beta1/index.proto b/google/cloud/aiplatform/v1beta1/index.proto index f0e3c67a0..9e010542e 100644 --- a/google/cloud/aiplatform/v1beta1/index.proto +++ b/google/cloud/aiplatform/v1beta1/index.proto @@ -57,7 +57,7 @@ message Index { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Index. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // 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]; diff --git a/google/cloud/aiplatform/v1beta1/index_endpoint.proto b/google/cloud/aiplatform/v1beta1/index_endpoint.proto index 3f8fa62b2..ba443ca38 100644 --- a/google/cloud/aiplatform/v1beta1/index_endpoint.proto +++ b/google/cloud/aiplatform/v1beta1/index_endpoint.proto @@ -85,7 +85,7 @@ message IndexEndpoint { // are mutually exclusive. // // [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - // projects/{project}/global/networks/{network}. + // `projects/{project}/global/networks/{network}`. // Where {project} is a project number, as in '12345', and {network} is // network name. string network = 9 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/aiplatform/v1beta1/job_service.proto b/google/cloud/aiplatform/v1beta1/job_service.proto index 68492a64c..9095e1e28 100644 --- a/google/cloud/aiplatform/v1beta1/job_service.proto +++ b/google/cloud/aiplatform/v1beta1/job_service.proto @@ -816,7 +816,7 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { // 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 affect in this case. + // 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; diff --git a/google/cloud/aiplatform/v1beta1/metadata_service.proto b/google/cloud/aiplatform/v1beta1/metadata_service.proto index abdcb600c..9e1767a09 100644 --- a/google/cloud/aiplatform/v1beta1/metadata_service.proto +++ b/google/cloud/aiplatform/v1beta1/metadata_service.proto @@ -556,7 +556,8 @@ message ListArtifactsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -750,7 +751,8 @@ message ListContextsRequest { // ``` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1048,7 +1050,9 @@ message ListExecutionsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. + // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1310,7 +1314,8 @@ message QueryArtifactLineageSubgraphRequest { // For example: `metadata.field_1.number_value = 10.0` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 3; diff --git a/google/cloud/aiplatform/v1beta1/model.proto b/google/cloud/aiplatform/v1beta1/model.proto index 9e408aebd..7b5f9f0a0 100644 --- a/google/cloud/aiplatform/v1beta1/model.proto +++ b/google/cloud/aiplatform/v1beta1/model.proto @@ -118,9 +118,9 @@ message Model { // User provided version aliases so that a model version can be referenced via // alias (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_alias} + // `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` // instead of auto-generated version id (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_id}). + // `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. // The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from // version_id. A default version alias will be created for the first version // of the model, and there must be exactly one default version alias for a @@ -134,7 +134,7 @@ message Model { 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 be consist of any UTF-8 + // 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]; @@ -332,6 +332,11 @@ message Model { // 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. 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 diff --git a/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto b/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto index 0446c1cc2..e8b94d1d1 100644 --- a/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto +++ b/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto @@ -96,7 +96,7 @@ message ModelDeploymentMonitoringJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the ModelDeploymentMonitoringJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a ModelDeploymentMonitoringJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1beta1/model_service.proto b/google/cloud/aiplatform/v1beta1/model_service.proto index 1af9d4b48..9fad50db7 100644 --- a/google/cloud/aiplatform/v1beta1/model_service.proto +++ b/google/cloud/aiplatform/v1beta1/model_service.proto @@ -232,6 +232,15 @@ message UploadModelRequest { // Required. The Model to create. Model model = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The user-provided custom service account to use to do the model + // upload. If empty, [Vertex AI Service + // Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + // will be used. Users uploading the Model must have the + // `iam.serviceAccounts.actAs` permission on this service account. Also, this + // account must belong to the project specified in the `parent` field and have + // all necessary read permissions. + string service_account = 6 [(google.api.field_behavior) = OPTIONAL]; } // Details of [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] operation. diff --git a/google/cloud/aiplatform/v1beta1/operation.proto b/google/cloud/aiplatform/v1beta1/operation.proto index 04e04b201..4a6d0edf2 100644 --- a/google/cloud/aiplatform/v1beta1/operation.proto +++ b/google/cloud/aiplatform/v1beta1/operation.proto @@ -33,7 +33,7 @@ message GenericOperationMetadata { // Output only. Partial failures encountered. // E.g. single files that couldn't be read. // This field should never exceed 20 entries. - // Status details field will contain standard GCP error details. + // Status details field will contain standard Google Cloud error details. repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was created. diff --git a/google/cloud/aiplatform/v1beta1/pipeline_job.proto b/google/cloud/aiplatform/v1beta1/pipeline_job.proto index cb450ee56..8ecf60844 100644 --- a/google/cloud/aiplatform/v1beta1/pipeline_job.proto +++ b/google/cloud/aiplatform/v1beta1/pipeline_job.proto @@ -54,8 +54,8 @@ message PipelineJob { message InputArtifact { oneof kind { // Artifact resource id from MLMD. Which is the last portion of an - // artifact resource - // name(projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}). + // artifact resource name: + // `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. // The artifact must stay within the same project, location and default // metadatastore as the pipeline. string artifact_id = 1; @@ -103,7 +103,7 @@ message PipelineJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // The display name of the Pipeline. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2; @@ -168,8 +168,8 @@ message PipelineJob { // network name. // // Private services access must already be configured for the network. - // Pipeline job will apply the network configuration to the GCP resources - // being launched, if applied, such as Vertex AI + // Pipeline job will apply the network configuration to the Google Cloud + // 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) = { @@ -337,6 +337,17 @@ message PipelineTaskExecutorDetail { type: "aiplatform.googleapis.com/CustomJob" } ]; + + // 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 + // 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]; } // The detailed info for a custom job executor. diff --git a/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel b/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel index d34fa576c..ce6db4d5c 100644 --- a/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel +++ b/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel @@ -102,6 +102,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1beta1.schema.predict", "python-gapic-name=instance", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel b/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel index c6aff45a6..1dcc830a2 100644 --- a/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel +++ b/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel @@ -99,6 +99,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1beta1.schema.predict", "python-gapic-name=params", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel b/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel index ec39be0ad..1f8af1aa0 100644 --- a/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel +++ b/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel @@ -113,6 +113,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1beta1.schema.predict", "python-gapic-name=prediction", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel b/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel index 367757634..e9573e757 100644 --- a/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel +++ b/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel @@ -109,6 +109,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.aiplatform.v1beta1.schema.trainingjob", "python-gapic-name=definition", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/aiplatform/v1beta1/specialist_pool.proto b/google/cloud/aiplatform/v1beta1/specialist_pool.proto index 49be7b793..cb35f9da2 100644 --- a/google/cloud/aiplatform/v1beta1/specialist_pool.proto +++ b/google/cloud/aiplatform/v1beta1/specialist_pool.proto @@ -43,7 +43,7 @@ message SpecialistPool { string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The user-defined name of the SpecialistPool. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // This field should be unique on project-level. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/aiplatform/v1beta1/tensorboard.proto b/google/cloud/aiplatform/v1beta1/tensorboard.proto index 640e636e5..32f7adddb 100644 --- a/google/cloud/aiplatform/v1beta1/tensorboard.proto +++ b/google/cloud/aiplatform/v1beta1/tensorboard.proto @@ -30,7 +30,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // Tensorboard is a physical database that stores users' training metrics. -// A default Tensorboard is provided in each region of a GCP project. +// A default Tensorboard is provided in each region of a Google Cloud project. // If needed users can also create extra Tensorboards in their projects. message Tensorboard { option (google.api.resource) = { diff --git a/google/cloud/aiplatform/v1beta1/tensorboard_service.proto b/google/cloud/aiplatform/v1beta1/tensorboard_service.proto index 629e5d793..6cbfe7e7f 100644 --- a/google/cloud/aiplatform/v1beta1/tensorboard_service.proto +++ b/google/cloud/aiplatform/v1beta1/tensorboard_service.proto @@ -465,7 +465,7 @@ message GetTensorboardExperimentRequest { message ListTensorboardExperimentsRequest { // Required. The resource name of the Tensorboard to list TensorboardExperiments. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -603,7 +603,7 @@ message GetTensorboardRunRequest { message ReadTensorboardBlobDataRequest { // Required. The resource name of the TensorboardTimeSeries to list Blobs. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string time_series = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -625,7 +625,7 @@ message ReadTensorboardBlobDataResponse { message ListTensorboardRunsRequest { // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -765,7 +765,7 @@ message GetTensorboardTimeSeriesRequest { message ListTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/aiplatform/v1beta1/training_pipeline.proto b/google/cloud/aiplatform/v1beta1/training_pipeline.proto index 138fbc3c8..cf7af508c 100644 --- a/google/cloud/aiplatform/v1beta1/training_pipeline.proto +++ b/google/cloud/aiplatform/v1beta1/training_pipeline.proto @@ -290,6 +290,9 @@ message InputDataConfig { // 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. + bool persist_ml_use_assignment = 11; } // Assigns the input data to training, validation, and test sets as per the diff --git a/google/cloud/aiplatform/v1beta1/user_action_reference.proto b/google/cloud/aiplatform/v1beta1/user_action_reference.proto index 3d4633b59..4ecf45989 100644 --- a/google/cloud/aiplatform/v1beta1/user_action_reference.proto +++ b/google/cloud/aiplatform/v1beta1/user_action_reference.proto @@ -31,13 +31,13 @@ message UserActionReference { // For API calls that return a long running operation. // Resource name of the long running operation. // Format: - // 'projects/{project}/locations/{location}/operations/{operation}' + // `projects/{project}/locations/{location}/operations/{operation}` string operation = 1; // For API calls that start a LabelingJob. // Resource name of the LabelingJob. // Format: - // 'projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}' + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string data_labeling_job = 2; } diff --git a/google/cloud/apigateway/v1/BUILD.bazel b/google/cloud/apigateway/v1/BUILD.bazel index fa9f70349..287cfce30 100644 --- a/google/cloud/apigateway/v1/BUILD.bazel +++ b/google/cloud/apigateway/v1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( name = "apigateway_java_gapic", srcs = [":apigateway_proto_with_info"], grpc_service_config = "apigateway_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":apigateway_java_grpc", ], @@ -129,13 +130,14 @@ go_gapic_library( grpc_service_config = "apigateway_grpc_service_config.json", importpath = "cloud.google.com/go/apigateway/apiv1;apigateway", metadata = True, + rest_numeric_enums = True, service_yaml = "apigateway_v1.yaml", transport = "grpc+rest", deps = [ ":apigateway_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -172,6 +174,7 @@ py_gapic_library( srcs = [":apigateway_proto"], grpc_service_config = "apigateway_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-api-gateway"], + rest_numeric_enums = True, transport = "grpc", ) @@ -219,7 +222,9 @@ php_gapic_library( name = "apigateway_php_gapic", srcs = [":apigateway_proto_with_info"], grpc_service_config = "apigateway_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigateway_v1.yaml", + transport = "grpc+rest", deps = [ ":apigateway_php_grpc", ":apigateway_php_proto", @@ -252,7 +257,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "apigateway_grpc_service_config.json", package = "google.cloud.apigateway.v1", + rest_numeric_enums = True, service_yaml = "apigateway_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -297,6 +304,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=apigateway", ], grpc_service_config = "apigateway_grpc_service_config.json", + 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", deps = [ @@ -342,6 +350,7 @@ csharp_gapic_library( srcs = [":apigateway_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "apigateway_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigateway_v1.yaml", deps = [ ":apigateway_csharp_grpc", diff --git a/google/cloud/apigeeconnect/v1/BUILD.bazel b/google/cloud/apigeeconnect/v1/BUILD.bazel index fd6db762e..ba6b5cbb3 100644 --- a/google/cloud/apigeeconnect/v1/BUILD.bazel +++ b/google/cloud/apigeeconnect/v1/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( name = "apigeeconnect_java_gapic", srcs = [":apigeeconnect_proto_with_info"], grpc_service_config = "connection_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":apigeeconnect_java_grpc", ], @@ -130,6 +131,7 @@ go_gapic_library( grpc_service_config = "connection_grpc_service_config.json", importpath = "cloud.google.com/go/apigeeconnect/apiv1;apigeeconnect", metadata = True, + rest_numeric_enums = True, service_yaml = "apigeeconnect_v1.yaml", deps = [ ":apigeeconnect_go_proto", @@ -170,6 +172,7 @@ py_gapic_library( srcs = [":apigeeconnect_proto"], grpc_service_config = "connection_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-apigee-connect"], + rest_numeric_enums = True, transport = "grpc", ) @@ -217,7 +220,9 @@ php_gapic_library( name = "apigeeconnect_php_gapic", srcs = [":apigeeconnect_proto_with_info"], grpc_service_config = "connection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigeeconnect_v1.yaml", + transport = "grpc+rest", deps = [ ":apigeeconnect_php_grpc", ":apigeeconnect_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "connection_grpc_service_config.json", package = "google.cloud.apigeeconnect.v1", + rest_numeric_enums = True, service_yaml = "apigeeconnect_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=apigeeconnect", ], grpc_service_config = "connection_grpc_service_config.json", + 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", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":apigeeconnect_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "connection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigeeconnect_v1.yaml", deps = [ ":apigeeconnect_csharp_grpc", diff --git a/google/cloud/apigeeregistry/v1/BUILD.bazel b/google/cloud/apigeeregistry/v1/BUILD.bazel index 5f5b69c48..3274768d9 100644 --- a/google/cloud/apigeeregistry/v1/BUILD.bazel +++ b/google/cloud/apigeeregistry/v1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":apigeeregistry_proto_with_info"], gapic_yaml = None, grpc_service_config = "apigeeregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", test_deps = [ ":apigeeregistry_java_grpc", @@ -144,6 +145,7 @@ go_gapic_library( grpc_service_config = "apigeeregistry_grpc_service_config.json", importpath = "cloud.google.com/go/apigeeregistry/apiv1;apigeeregistry", metadata = True, + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", deps = [ ":apigeeregistry_go_proto", @@ -151,8 +153,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -193,6 +195,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=apigee_registry", ], + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", transport = "grpc+rest", ) @@ -244,7 +247,9 @@ php_gapic_library( name = "apigeeregistry_php_gapic", srcs = [":apigeeregistry_proto_with_info"], grpc_service_config = "apigeeregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", + transport = "grpc+rest", deps = [ ":apigeeregistry_php_grpc", ":apigeeregistry_php_proto", @@ -277,7 +282,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "apigeeregistry_grpc_service_config.json", package = "google.cloud.apigeeregistry.v1", + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -321,6 +328,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/apigee/docs/api-hub/get-started-registry-api/", ], grpc_service_config = "apigeeregistry_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Apigee Registry API allows teams to upload and share machine-readable descriptions of APIs that are in use and in development. These descriptions include API specifications in standard formats like OpenAPI, the Google API Discovery Service Format, and the Protocol Buffers Language. These API specifications can be used by tools like linters, browsers, documentation generators, test runners, proxies, and API client and server generators. The Registry API itself can be seen as a machine-readable enterprise API catalog designed to back online directories, portals, and workflow managers.", ruby_cloud_title = "Apigee Registry V1", service_yaml = "apigeeregistry_v1.yaml", @@ -367,6 +375,7 @@ csharp_gapic_library( srcs = [":apigeeregistry_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "apigeeregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "apigeeregistry_v1.yaml", deps = [ ":apigeeregistry_csharp_grpc", diff --git a/google/cloud/asset/v1/BUILD.bazel b/google/cloud/asset/v1/BUILD.bazel index 74a1a28c9..cc6280646 100644 --- a/google/cloud/asset/v1/BUILD.bazel +++ b/google/cloud/asset/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "asset_java_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":asset_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -139,14 +140,15 @@ go_gapic_library( srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", importpath = "cloud.google.com/go/asset/apiv1;asset", + rest_numeric_enums = True, service_yaml = "cloudasset_v1.yaml", transport = "grpc+rest", deps = [ ":asset_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", @@ -184,6 +186,7 @@ py_gapic_library( name = "asset_py_gapic", srcs = [":asset_proto"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/cloud/orgpolicy/v1:orgpolicy_py_original_proto", @@ -239,7 +242,9 @@ php_gapic_library( name = "asset_php_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudasset_v1.yaml", + transport = "grpc+rest", deps = [ ":asset_php_grpc", ":asset_php_proto", @@ -272,7 +277,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudasset_grpc_service_config.json", package = "google.cloud.asset.v1", + rest_numeric_enums = True, service_yaml = "cloudasset_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -322,6 +329,7 @@ ruby_cloud_gapic_library( "ruby-cloud-extra-dependencies=google-identity-access_context_manager-v1=> 0.0|< 2.a;google-cloud-os_config-v1=> 0.0|< 2.a", ], grpc_service_config = "cloudasset_grpc_service_config.json", + 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", deps = [ @@ -367,6 +375,7 @@ csharp_gapic_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", + rest_numeric_enums = True, service_yaml = "cloudasset_v1.yaml", deps = [ ":asset_csharp_grpc", diff --git a/google/cloud/asset/v1/asset_service.proto b/google/cloud/asset/v1/asset_service.proto index 1c3432729..9e13d0662 100644 --- a/google/cloud/asset/v1/asset_service.proto +++ b/google/cloud/asset/v1/asset_service.proto @@ -41,20 +41,18 @@ 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" @@ -82,8 +80,7 @@ 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" }; @@ -136,8 +133,7 @@ service AssetService { // 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" }; @@ -148,8 +144,7 @@ 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" }; @@ -158,8 +153,7 @@ 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" }; @@ -169,14 +163,12 @@ 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: "*" @@ -237,8 +229,7 @@ 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" }; @@ -255,8 +246,7 @@ 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/*}" }; @@ -264,8 +254,7 @@ 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" }; @@ -276,8 +265,7 @@ service AssetService { // 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. @@ -324,8 +312,7 @@ 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: @@ -347,10 +334,8 @@ 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; @@ -368,11 +353,11 @@ message ExportAssetsResponse { // 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) = { @@ -501,8 +486,7 @@ 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. @@ -524,8 +508,9 @@ 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]; @@ -539,7 +524,9 @@ 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" + } ]; } @@ -558,8 +545,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. @@ -568,8 +555,7 @@ 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 { @@ -579,7 +565,9 @@ 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" + } ]; } @@ -804,8 +792,7 @@ 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 @@ -842,9 +829,8 @@ 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. // @@ -877,7 +863,11 @@ message SearchAllResourcesRequest { // and its value is "prod". // * `labels.env:*` to find Cloud resources that have a label "env". // * `kmsKey:key` to find Cloud resources encrypted with a customer-managed - // encryption key whose name contains the word "key". + // 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 // relationships with "instance-group-1" in the related resource name. // * `relationships:INSTANCE_TO_INSTANCEGROUP` to find compute instances that @@ -906,8 +896,8 @@ message SearchAllResourcesRequest { // 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: @@ -922,22 +912,21 @@ 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,22 +936,21 @@ message SearchAllResourcesRequest { // * displayName // * description // * location - // * kmsKey // * createTime // * updateTime // * state // * parentFullResourceName // * parentAssetType // - // All the other fields such as repeated fields (e.g., `networkTags`), map - // fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`) - // are not supported. + // All the other fields such as repeated fields (e.g., `networkTags`, + // `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g., + // `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): @@ -978,7 +966,9 @@ message SearchAllResourcesRequest { // * tagValueIds // * labels // * networkTags - // * kmsKey + // * kmsKey (This field is deprecated. Please use the `kmsKeys` field to + // retrieve KMS key information.) + // * kmsKeys // * createTime // * updateTime // * state @@ -990,8 +980,7 @@ 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. @@ -1008,9 +997,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. // @@ -1066,22 +1055,20 @@ 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: @@ -1098,9 +1085,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 @@ -1173,10 +1160,9 @@ 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][]. @@ -1187,31 +1173,28 @@ 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. // - // 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 resource 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 @@ -1224,21 +1207,21 @@ 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 @@ -1266,8 +1249,7 @@ 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. @@ -1281,8 +1263,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 @@ -1296,12 +1278,10 @@ 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]; @@ -1310,16 +1290,13 @@ 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: // @@ -1339,8 +1316,7 @@ 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 @@ -1350,26 +1326,22 @@ 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. @@ -1384,11 +1356,9 @@ 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; } @@ -1396,8 +1366,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. @@ -1425,15 +1395,13 @@ 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]. @@ -1444,8 +1412,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. @@ -1470,12 +1438,10 @@ 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: // @@ -1495,15 +1461,14 @@ 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 { @@ -1518,11 +1483,8 @@ 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; } } @@ -1539,18 +1501,15 @@ 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. @@ -1564,11 +1523,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) = { @@ -1576,13 +1535,13 @@ 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]-/. @@ -1609,8 +1568,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, @@ -1628,9 +1587,8 @@ 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]; @@ -1665,14 +1623,12 @@ 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 @@ -1764,13 +1720,12 @@ 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 @@ -1780,8 +1735,10 @@ message QueryAssetsOutputConfig { // overwrites the entire table or all the partitions data. // * WRITE_APPEND: If the table or partition already exists, BigQuery // appends the data to the table or the latest partition. - // * WRITE_EMPTY: If the table already exists and contains data, an error is - // returned. + // * WRITE_EMPTY: If the table already exists and contains data, a + // 'duplicate' error is returned in the job result. + // + // The default value is WRITE_EMPTY. string write_disposition = 3; } @@ -1809,13 +1766,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. @@ -1828,11 +1785,10 @@ 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) @@ -1851,15 +1807,13 @@ 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. @@ -1871,8 +1825,7 @@ 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. @@ -1959,8 +1912,7 @@ 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. // @@ -1975,7 +1927,9 @@ 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] @@ -1985,65 +1939,53 @@ 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; } diff --git a/google/cloud/asset/v1/assets.proto b/google/cloud/asset/v1/assets.proto index 83a23693a..8f22b5031 100644 --- a/google/cloud/asset/v1/assets.proto +++ b/google/cloud/asset/v1/assets.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.asset.v1; +import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/orgpolicy/v1/orgpolicy.proto"; import "google/cloud/osconfig/v1/inventory.proto"; @@ -150,8 +151,7 @@ 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 @@ -282,8 +282,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` // @@ -306,7 +306,7 @@ message RelatedAsset { } // A result of Resource Search, containing information of a cloud resource. -// Next ID: 29 +// Next ID: 31 message ResourceSearchResult { // The full resource name of this resource. Example: // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. @@ -316,15 +316,15 @@ message ResourceSearchResult { // // To search against the `name`: // - // * use a field query. Example: `name:instance1` - // * use a free text query. Example: `instance1` + // * Use a field query. Example: `name:instance1` + // * Use a free text query. Example: `instance1` string name = 1; // The type of this resource. Example: `compute.googleapis.com/Disk`. // // To search against the `asset_type`: // - // * specify the `asset_type` field in your search request. + // * Specify the `asset_type` field in your search request. string asset_type = 2; // The project that this resource belongs to, in the form of @@ -333,9 +333,9 @@ message ResourceSearchResult { // // To search against `project`: // - // * use a field query. Example: `project:12345` - // * use a free text query. Example: `12345` - // * specify the `scope` field as this project in your search request. + // * Use a field query. Example: `project:12345` + // * Use a free text query. Example: `12345` + // * Specify the `scope` field as this project in your search request. string project = 3; // The folder(s) that this resource belongs to, in the form of @@ -344,9 +344,9 @@ message ResourceSearchResult { // // To search against `folders`: // - // * use a field query. Example: `folders:(123 OR 456)` - // * use a free text query. Example: `123` - // * specify the `scope` field as this folder in your search request. + // * Use a field query. Example: `folders:(123 OR 456)` + // * Use a free text query. Example: `123` + // * Specify the `scope` field as this folder in your search request. repeated string folders = 17; // The organization that this resource belongs to, in the form of @@ -355,9 +355,9 @@ message ResourceSearchResult { // // To search against `organization`: // - // * use a field query. Example: `organization:123` - // * use a free text query. Example: `123` - // * specify the `scope` field as this organization in your search request. + // * Use a field query. Example: `organization:123` + // * Use a free text query. Example: `123` + // * Specify the `scope` field as this organization in your search request. string organization = 18; // The display name of this resource. This field is available only when the @@ -365,8 +365,8 @@ message ResourceSearchResult { // // To search against the `display_name`: // - // * use a field query. Example: `displayName:"My Instance"` - // * use a free text query. Example: `"My Instance"` + // * Use a field query. Example: `displayName:"My Instance"` + // * Use a free text query. Example: `"My Instance"` string display_name = 4; // One or more paragraphs of text description of this resource. Maximum length @@ -375,8 +375,8 @@ message ResourceSearchResult { // // To search against the `description`: // - // * use a field query. Example: `description:"important instance"` - // * use a free text query. Example: `"important instance"` + // * Use a field query. Example: `description:"important instance"` + // * Use a free text query. Example: `"important instance"` string description = 5; // Location can be `global`, regional like `us-east1`, or zonal like @@ -385,8 +385,8 @@ message ResourceSearchResult { // // To search against the `location`: // - // * use a field query. Example: `location:us-west*` - // * use a free text query. Example: `us-west*` + // * Use a field query. Example: `location:us-west*` + // * Use a free text query. Example: `us-west*` string location = 6; // Labels associated with this resource. See [Labelling and grouping GCP @@ -396,11 +396,11 @@ message ResourceSearchResult { // // To search against the `labels`: // - // * use a field query: + // * Use a field query: // - query on any label's key or value. Example: `labels:prod` // - query by a given label. Example: `labels.env:prod` // - query by a given label's existence. Example: `labels.env:*` - // * use a free text query. Example: `prod` + // * Use a free text query. Example: `prod` map labels = 7; // Network tags associated with this resource. Like labels, network tags are a @@ -411,22 +411,41 @@ message ResourceSearchResult { // // To search against the `network_tags`: // - // * use a field query. Example: `networkTags:internal` - // * use a free text query. Example: `internal` + // * Use a field query. Example: `networkTags:internal` + // * Use a free text query. Example: `internal` repeated string network_tags = 8; // The Cloud KMS // [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) // name or // [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) - // name. This field is available only when the resource's Protobuf contains - // it. + // 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 + // 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. // // To search against the `kms_key`: // - // * use a field query. Example: `kmsKey:key` - // * use a free text query. Example: `key` - string kms_key = 10; + // * Use a field query. Example: `kmsKey:key` + // * Use a free text query. Example: `key` + string kms_key = 10 [deprecated = true]; + + // The Cloud KMS + // [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) + // names or + // [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) + // names. This field is available only when the resource's Protobuf contains + // it. + // + // To search against the `kms_keys`: + // + // * Use a field query. Example: `kmsKeys:key` + // * Use a free text query. Example: `key` + repeated string kms_keys = 28; // The create timestamp of this resource, at which the resource was created. // The granularity is in seconds. Timestamp.nanos will always be 0. This field @@ -434,7 +453,7 @@ message ResourceSearchResult { // // To search against `create_time`: // - // * use a field query. + // * Use a field query. // - value in seconds since unix epoch. Example: `createTime > 1609459200` // - value in date string. Example: `createTime > 2021-01-01` // - value in date-time string (must be quoted). Example: `createTime > @@ -448,7 +467,7 @@ message ResourceSearchResult { // // To search against `update_time`: // - // * use a field query. + // * Use a field query. // - value in seconds since unix epoch. Example: `updateTime < 1609459200` // - value in date string. Example: `updateTime < 2021-01-01` // - value in date-time string (must be quoted). Example: `updateTime < @@ -473,8 +492,8 @@ message ResourceSearchResult { // // To search against the `state`: // - // * use a field query. Example: `state:RUNNING` - // * use a free text query. Example: `RUNNING` + // * Use a field query. Example: `state:RUNNING` + // * Use a free text query. Example: `RUNNING` string state = 13; // The additional searchable attributes of this resource. The attributes may @@ -493,7 +512,7 @@ message ResourceSearchResult { // // To search against the `additional_attributes`: // - // * use a free text query to match the attributes values. Example: to search + // * Use a free text query to match the attributes values. Example: to search // `additional_attributes = { dnsName: "foobar" }`, you can issue a query // `foobar`. google.protobuf.Struct additional_attributes = 9; @@ -501,9 +520,9 @@ message ResourceSearchResult { // The full resource name of this resource's parent, if it has one. // To search against the `parent_full_resource_name`: // - // * use a field query. Example: + // * Use a field query. Example: // `parentFullResourceName:"project-name"` - // * use a free text query. Example: + // * Use a free text query. Example: // `project-name` string parent_full_resource_name = 19; @@ -536,12 +555,12 @@ message ResourceSearchResult { // TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. // To search against the `tagKeys`: // - // * use a field query. Example: + // * Use a field query. Example: // - `tagKeys:"123456789/env*"` // - `tagKeys="123456789/env"` // - `tagKeys:"env"` // - // * use a free text query. Example: + // * Use a free text query. Example: // - `env` repeated string tag_keys = 23; @@ -549,24 +568,24 @@ message ResourceSearchResult { // {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. // To search against the `tagValues`: // - // * use a field query. Example: + // * Use a field query. Example: // - `tagValues:"env"` // - `tagValues:"env/prod"` // - `tagValues:"123456789/env/prod*"` // - `tagValues="123456789/env/prod"` // - // * use a free text query. Example: + // * Use a free text query. Example: // - `prod` repeated string tag_values = 25; // TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. // To search against the `tagValueIds`: // - // * use a field query. Example: + // * Use a field query. Example: // - `tagValueIds:"456"` // - `tagValueIds="tagValues/456"` // - // * use a free text query. Example: + // * Use a free text query. Example: // - `456` repeated string tag_value_ids = 26; @@ -574,9 +593,9 @@ message ResourceSearchResult { // // To search against the `parent_asset_type`: // - // * use a field query. Example: + // * Use a field query. Example: // `parentAssetType:"cloudresourcemanager.googleapis.com/Project"` - // * use a free text query. Example: + // * Use a free text query. Example: // `cloudresourcemanager.googleapis.com/Project` string parent_asset_type = 103; } @@ -857,10 +876,8 @@ 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; @@ -879,41 +896,32 @@ 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. 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/google/cloud/asset/v1p1beta1/BUILD.bazel b/google/cloud/asset/v1p1beta1/BUILD.bazel index 7cc8aac78..f8abfd014 100644 --- a/google/cloud/asset/v1p1beta1/BUILD.bazel +++ b/google/cloud/asset/v1p1beta1/BUILD.bazel @@ -58,6 +58,7 @@ java_gapic_library( name = "asset_java_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":asset_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -118,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", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p1beta1.yaml", transport = "grpc+rest", deps = [ @@ -157,6 +159,7 @@ py_gapic_library( name = "asset_py_gapic", srcs = [":asset_proto"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -206,6 +209,8 @@ php_gapic_library( name = "asset_php_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":asset_php_grpc", ":asset_php_proto", @@ -238,7 +243,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudasset_grpc_service_config.json", package = "google.cloud.asset.v1p1beta1", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -276,6 +283,7 @@ ruby_cloud_gapic_library( name = "asset_ruby_gapic", srcs = [":asset_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p1beta1"], + rest_numeric_enums = True, deps = [ ":asset_ruby_grpc", ":asset_ruby_proto", @@ -319,6 +327,7 @@ csharp_gapic_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", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p1beta1.yaml", deps = [ ":asset_csharp_grpc", diff --git a/google/cloud/asset/v1p2beta1/BUILD.bazel b/google/cloud/asset/v1p2beta1/BUILD.bazel index bc42348e5..6b222428a 100644 --- a/google/cloud/asset/v1p2beta1/BUILD.bazel +++ b/google/cloud/asset/v1p2beta1/BUILD.bazel @@ -65,6 +65,7 @@ java_gapic_library( name = "asset_java_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":asset_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -126,14 +127,15 @@ go_gapic_library( srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", importpath = "cloud.google.com/go/asset/apiv1p2beta1;asset", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p2beta1.yaml", transport = "grpc+rest", deps = [ ":asset_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -170,6 +172,7 @@ py_gapic_library( name = "asset_py_gapic", srcs = [":asset_proto"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -219,6 +222,8 @@ php_gapic_library( name = "asset_php_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":asset_php_grpc", ":asset_php_proto", @@ -251,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudasset_grpc_service_config.json", package = "google.cloud.asset.v1p2beta1", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p2beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -289,6 +296,7 @@ ruby_cloud_gapic_library( name = "asset_ruby_gapic", srcs = [":asset_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p2beta1"], + rest_numeric_enums = True, deps = [ ":asset_ruby_grpc", ":asset_ruby_proto", diff --git a/google/cloud/asset/v1p5beta1/BUILD.bazel b/google/cloud/asset/v1p5beta1/BUILD.bazel index 64bbc1b6c..da53417e4 100644 --- a/google/cloud/asset/v1p5beta1/BUILD.bazel +++ b/google/cloud/asset/v1p5beta1/BUILD.bazel @@ -64,6 +64,7 @@ java_gapic_library( name = "asset_java_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":asset_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -126,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", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p5beta1.yaml", transport = "grpc+rest", deps = [ @@ -165,6 +167,7 @@ py_gapic_library( name = "asset_py_gapic", srcs = [":asset_proto"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/cloud/orgpolicy/v1:orgpolicy_py_original_proto", @@ -218,6 +221,8 @@ php_grpc_library( php_gapic_library( name = "asset_php_gapic", srcs = [":asset_proto_with_info"], + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":asset_php_grpc", ":asset_php_proto", @@ -249,7 +254,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], gapic_yaml = "cloudasset_gapic.yaml", package = "google.cloud.asset.v1p5beta1", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p5beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -287,6 +294,7 @@ ruby_cloud_gapic_library( name = "asset_ruby_gapic", srcs = [":asset_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p5beta1"], + rest_numeric_enums = True, deps = [ ":asset_ruby_grpc", ":asset_ruby_proto", diff --git a/google/cloud/asset/v1p7beta1/BUILD.bazel b/google/cloud/asset/v1p7beta1/BUILD.bazel index 926cd0d75..d302d1966 100644 --- a/google/cloud/asset/v1p7beta1/BUILD.bazel +++ b/google/cloud/asset/v1p7beta1/BUILD.bazel @@ -9,14 +9,40 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "asset_proto", @@ -50,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "asset_java_proto", deps = [":asset_proto"], @@ -77,10 +91,12 @@ java_gapic_library( name = "asset_java_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":asset_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":asset_java_proto", "//google/iam/v1:iam_java_proto", @@ -98,7 +114,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-asset-v1p7beta1-java", - transport = "grpc+rest", + include_samples = True, + transport = "grpc", deps = [ ":asset_java_gapic", ":asset_java_grpc", @@ -107,17 +124,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "asset_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -139,13 +145,15 @@ go_gapic_library( grpc_service_config = "cloudasset_grpc_service_config.json", importpath = "cloud.google.com/go/asset/apiv1p7beta1;asset", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudasset_v1p7beta1.yaml", + transport = "grpc", deps = [ ":asset_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -169,19 +177,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "asset_py_gapic", srcs = [":asset_proto"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -204,17 +204,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "asset_php_proto", deps = [":asset_proto"], @@ -230,6 +219,8 @@ php_gapic_library( name = "asset_php_gapic", srcs = [":asset_proto_with_info"], grpc_service_config = "cloudasset_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":asset_php_grpc", ":asset_php_proto", @@ -246,15 +237,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "asset_nodejs_gapic", package_name = "@google-cloud/asset", @@ -262,7 +244,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudasset_grpc_service_config.json", package = "google.cloud.asset.v1p7beta1", + rest_numeric_enums = True, service_yaml = "cloudasset_v1p7beta1.yaml", + transport = "grpc", deps = [], ) @@ -274,17 +258,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "asset_ruby_proto", deps = [":asset_proto"], @@ -300,6 +273,7 @@ ruby_cloud_gapic_library( name = "asset_ruby_gapic", srcs = [":asset_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p7beta1"], + rest_numeric_enums = True, deps = [ ":asset_ruby_grpc", ":asset_ruby_proto", @@ -316,17 +290,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "asset_csharp_proto", deps = [":asset_proto"], diff --git a/google/cloud/assuredworkloads/v1/BUILD.bazel b/google/cloud/assuredworkloads/v1/BUILD.bazel index 775e3c92f..a253a9892 100644 --- a/google/cloud/assuredworkloads/v1/BUILD.bazel +++ b/google/cloud/assuredworkloads/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":assuredworkloads_proto_with_info"], gapic_yaml = None, grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", test_deps = [ ":assuredworkloads_java_grpc", @@ -133,13 +134,14 @@ go_gapic_library( grpc_service_config = "assuredworkloads_grpc_service_config.json", importpath = "cloud.google.com/go/assuredworkloads/apiv1;assuredworkloads", metadata = True, + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", transport = "grpc+rest", deps = [ ":assuredworkloads_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -177,8 +179,11 @@ py_gapic_library( srcs = [":assuredworkloads_proto"], grpc_service_config = "assuredworkloads_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-assured-workloads"], + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -225,7 +230,9 @@ php_gapic_library( name = "assuredworkloads_php_gapic", srcs = [":assuredworkloads_proto_with_info"], grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", + transport = "grpc+rest", deps = [ ":assuredworkloads_php_grpc", ":assuredworkloads_php_proto", @@ -258,7 +265,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "assuredworkloads_grpc_service_config.json", package = "google.cloud.assuredworkloads.v1", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/assured-workloads/", ], grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Assured Workloads for Government secures government workloads and accelerates the path to running compliant workloads on Google Cloud.", ruby_cloud_title = "Assured Workloads for Government V1", service_yaml = "assuredworkloads_v1.yaml", @@ -349,6 +359,7 @@ csharp_gapic_library( srcs = [":assuredworkloads_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1.yaml", deps = [ ":assuredworkloads_csharp_grpc", diff --git a/google/cloud/assuredworkloads/v1/assuredworkloads.proto b/google/cloud/assuredworkloads/v1/assuredworkloads.proto index 9d4045e46..f6349f35f 100644 --- a/google/cloud/assuredworkloads/v1/assuredworkloads.proto +++ b/google/cloud/assuredworkloads/v1/assuredworkloads.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. @@ -41,12 +41,10 @@ option (google.api.resource_definition) = { // Service to manage AssuredWorkloads. service AssuredWorkloadsService { option (google.api.default_host) = "assuredworkloads.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 Assured Workload. - rpc CreateWorkload(CreateWorkloadRequest) - returns (google.longrunning.Operation) { + rpc CreateWorkload(CreateWorkloadRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=organizations/*/locations/*}/workloads" body: "workload" @@ -70,6 +68,19 @@ service AssuredWorkloadsService { option (google.api.method_signature) = "workload,update_mask"; } + // Restrict the list of resources allowed in the Workload environment. + // The current list of allowed products can be found at + // https://cloud.google.com/assured-workloads/docs/supported-products + // In addition to assuredworkloads.workload.update permission, the user should + // also have orgpolicy.policy.set permission on the folder resource + // to use this functionality. + rpc RestrictAllowedResources(RestrictAllowedResourcesRequest) returns (RestrictAllowedResourcesResponse) { + option (google.api.http) = { + post: "/v1/{name=organizations/*/locations/*/workloads/*}:restrictAllowedResources" + body: "*" + }; + } + // Deletes the workload. Make sure that workload's direct children are already // in a deleted state, otherwise the request will fail with a // FAILED_PRECONDITION error. @@ -95,6 +106,27 @@ service AssuredWorkloadsService { }; option (google.api.method_signature) = "parent"; } + + // Lists the Violations in the AssuredWorkload Environment. + // Callers may also choose to read across multiple Workloads as per + // [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash + // character) as a wildcard character instead of workload-id in the parent. + // Format `organizations/{org_id}/locations/{location}/workloads/-` + rpc ListViolations(ListViolationsRequest) returns (ListViolationsResponse) { + option (google.api.method_signature) = "parent"; + } + + // Retrieves Assured Workload Violation based on ID. + rpc GetViolation(GetViolationRequest) returns (Violation) { + option (google.api.method_signature) = "name"; + } + + // Acknowledges an existing violation. By acknowledging a violation, users + // acknowledge the existence of a compliance violation in their workload and + // decide to ignore it due to a valid business justification. Acknowledgement + // is a permanent operation and it cannot be reverted. + rpc AcknowledgeViolation(AcknowledgeViolationRequest) returns (AcknowledgeViolationResponse) { + } } // Request for creating a workload. @@ -111,8 +143,8 @@ message CreateWorkloadRequest { // Required. Assured Workload to create Workload workload = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A identifier associated with the workload and underlying projects - // which allows for the break down of billing costs for a workload. The value + // Optional. A identifier associated with the workload and underlying projects which + // allows for the break down of billing costs for a workload. The value // provided for the identifier will add a label to the workload and contained // projects with the identifier as the value. string external_id = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -121,14 +153,13 @@ message CreateWorkloadRequest { // Request for Updating a workload. message UpdateWorkloadRequest { // Required. The workload to update. - // The workload’s `name` field is used to identify the workload to be updated. + // The workload's `name` field is used to identify the workload to be updated. // Format: // organizations/{org_id}/locations/{location_id}/workloads/{workload_id} Workload workload = 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]; } // Request for deleting a Workload. @@ -150,8 +181,8 @@ message DeleteWorkloadRequest { // Request for fetching a workload. message GetWorkloadRequest { - // Required. The resource name of the Workload to fetch. This is the - // workloads's relative path in the API, formatted as + // Required. The resource name of the Workload to fetch. This is the workload's + // relative path in the API, formatted as // "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". // For example, // "organizations/123/locations/us-east1/workloads/assured-workload-1". @@ -196,7 +227,7 @@ message ListWorkloadsResponse { string next_page_token = 2; } -// An Workload object for managing highly regulated workloads of cloud +// A Workload object for managing highly regulated workloads of cloud // customers. message Workload { option (google.api.resource) = { @@ -212,7 +243,14 @@ message Workload { RESOURCE_TYPE_UNSPECIFIED = 0; // Consumer project. - CONSUMER_PROJECT = 1; + // AssuredWorkloads Projects are no longer supported. This field will be + // ignored only in CreateWorkload requests. ListWorkloads and GetWorkload + // will continue to provide projects information. + // Use CONSUMER_FOLDER instead. + CONSUMER_PROJECT = 1 [deprecated = true]; + + // Consumer Folder. + CONSUMER_FOLDER = 4; // Consumer project containing encryption keys. ENCRYPTION_KEYS_PROJECT = 2; @@ -229,20 +267,68 @@ message Workload { ResourceType resource_type = 2; } + // Supported Compliance Regimes. + enum ComplianceRegime { + // Unknown compliance regime. + COMPLIANCE_REGIME_UNSPECIFIED = 0; + + // Information protection as per DoD IL4 requirements. + IL4 = 1; + + // Criminal Justice Information Services (CJIS) Security policies. + CJIS = 2; + + // FedRAMP High data protection controls + FEDRAMP_HIGH = 3; + + // FedRAMP Moderate data protection controls + FEDRAMP_MODERATE = 4; + + // Assured Workloads For US Regions data protection controls + US_REGIONAL_ACCESS = 5; + + // Health Insurance Portability and Accountability Act controls + HIPAA = 6; + + // Health Information Trust Alliance controls + HITRUST = 7; + + // Assured Workloads For EU Regions and Support controls + EU_REGIONS_AND_SUPPORT = 8; + + // Assured Workloads For Canada Regions and Support controls + CA_REGIONS_AND_SUPPORT = 9; + + // International Traffic in Arms Regulations + ITAR = 10; + + // Assured Workloads for Australia Regions and Support controls + // Available for public preview consumption. + // Don't create production workloads. + AU_REGIONS_AND_US_SUPPORT = 11; + + // Assured Workloads for Partners + ASSURED_WORKLOADS_FOR_PARTNERS = 12; + } + // Settings specific to the Key Management Service. + // This message is deprecated. + // In order to create a Keyring, callers should specify, + // ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. message KMSSettings { - // Required. Input only. Immutable. The time at which the Key Management - // Service will automatically create a new version of the crypto key and - // mark it as the primary. + option deprecated = true; + + // Required. Input only. Immutable. The time at which the Key Management Service will automatically create a + // new version of the crypto key and mark it as the primary. google.protobuf.Timestamp next_rotation_time = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = INPUT_ONLY, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Input only. Immutable. [next_rotation_time] will be advanced by - // this period when the Key Management Service automatically rotates a key. - // Must be at least 24 hours and at most 876,000 hours. + // Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key + // Management Service automatically rotates a key. Must be at least 24 hours + // and at most 876,000 hours. google.protobuf.Duration rotation_period = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = INPUT_ONLY, @@ -255,10 +341,12 @@ message Workload { // Resource identifier. // For a project this represents project_id. If the project is already // taken, the workload creation will fail. + // For KeyRing, this represents the keyring_id. + // For a folder, don't set this value as folder_id is assigned by Google. string resource_id = 1; // Indicates the type of resource. This field should be specified to - // correspond the id to the right project type (CONSUMER_PROJECT or + // correspond the id to the right resource type (CONSUMER_FOLDER or // ENCRYPTION_KEYS_PROJECT) ResourceInfo.ResourceType resource_type = 2; @@ -268,6 +356,18 @@ message Workload { string display_name = 3; } + // Key Access Justifications(KAJ) Enrollment State. + enum KajEnrollmentState { + // Default State for KAJ Enrollment. + KAJ_ENROLLMENT_STATE_UNSPECIFIED = 0; + + // Pending State for KAJ Enrollment. + KAJ_ENROLLMENT_STATE_PENDING = 1; + + // Complete State for KAJ Enrollment. + KAJ_ENROLLMENT_STATE_COMPLETE = 2; + } + // Signed Access Approvals (SAA) enrollment response. message SaaEnrollmentResponse { // Setup state of SAA enrollment. @@ -310,52 +410,13 @@ message Workload { repeated SetupError setup_errors = 2; } - // Supported Compliance Regimes. - enum ComplianceRegime { - // Unknown compliance regime. - COMPLIANCE_REGIME_UNSPECIFIED = 0; - - // Information protection as per DoD IL4 requirements. - IL4 = 1; - - // Criminal Justice Information Services (CJIS) Security policies. - CJIS = 2; - - // FedRAMP High data protection controls - FEDRAMP_HIGH = 3; - - // FedRAMP Moderate data protection controls - FEDRAMP_MODERATE = 4; - - // Assured Workloads For US Regions data protection controls - US_REGIONAL_ACCESS = 5; + // Supported Assured Workloads Partners. + enum Partner { + // Unknown partner regime/controls. + PARTNER_UNSPECIFIED = 0; - // Health Insurance Portability and Accountability Act controls - HIPAA = 6; - - // Health Information Trust Alliance controls - HITRUST = 7; - - // Assured Workloads For EU Regions and Support controls - EU_REGIONS_AND_SUPPORT = 8; - - // Assured Workloads For Canada Regions and Support controls - CA_REGIONS_AND_SUPPORT = 9; - - // International Traffic in Arms Regulations - ITAR = 10; - } - - // Key Access Justifications(KAJ) Enrollment State. - enum KajEnrollmentState { - // Default State for KAJ Enrollment. - KAJ_ENROLLMENT_STATE_UNSPECIFIED = 0; - - // Pending State for KAJ Enrollment. - KAJ_ENROLLMENT_STATE_PENDING = 1; - - // Complete State for KAJ Enrollment. - KAJ_ENROLLMENT_STATE_COMPLETE = 2; + // S3NS regime/controls. + LOCAL_CONTROLS_BY_S3NS = 1; } // Optional. The resource name of the workload. @@ -377,8 +438,7 @@ message Workload { // These resources will be created when creating the workload. // If any of the projects already exist, the workload creation will fail. // Always read only. - repeated ResourceInfo resources = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ResourceInfo resources = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Immutable. Compliance Regime associated with this workload. ComplianceRegime compliance_regime = 4 [ @@ -392,7 +452,7 @@ message Workload { (google.api.field_behavior) = IMMUTABLE ]; - // Required. Input only. The billing account used for the resources which are + // Optional. The billing account used for the resources which are // direct children of workload. This billing account is initially associated // with the resources created as part of Workload creation. // After the initial creation of these resources, the customer can change @@ -400,10 +460,7 @@ message Workload { // The resource name has the form // `billingAccounts/{billing_account_id}`. For example, // `billingAccounts/012345-567890-ABCDEF`. - string billing_account = 6 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = INPUT_ONLY - ]; + string billing_account = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. ETag of the workload, it is calculated on the basis // of the Workload contents. It will be used in Update & Delete operations. @@ -412,29 +469,31 @@ message Workload { // Optional. Labels applied to the workload. map labels = 10 [(google.api.field_behavior) = OPTIONAL]; - // Input only. The parent resource for the resources managed by this Assured - // Workload. May be either empty or a folder resource which is a child of the + // Input only. The parent resource for the resources managed by this Assured Workload. May + // be either empty or a folder resource which is a child of the // Workload parent. If not specified all resources are created under the // parent organization. // Format: // folders/{folder_id} - string provisioned_resources_parent = 13 - [(google.api.field_behavior) = INPUT_ONLY]; - - // Input only. Settings used to create a CMEK crypto key. When set a project - // with a KMS CMEK key is provisioned. This field is mandatory for a subset of - // Compliance Regimes. - KMSSettings kms_settings = 14 [(google.api.field_behavior) = INPUT_ONLY]; + string provisioned_resources_parent = 13 [(google.api.field_behavior) = INPUT_ONLY]; + + // Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS + // CMEK key is provisioned. + // This field is deprecated as of Feb 28, 2022. + // In order to create a Keyring, callers should specify, + // ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. + KMSSettings kms_settings = 14 [ + deprecated = true, + (google.api.field_behavior) = INPUT_ONLY + ]; - // Input only. Resource properties that are used to customize workload - // resources. These properties (such as custom project id) will be used to - // create workload resources if possible. This field is optional. - repeated ResourceSettings resource_settings = 15 - [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. Resource properties that are used to customize workload resources. + // These properties (such as custom project id) will be used to create + // workload resources if possible. This field is optional. + repeated ResourceSettings resource_settings = 15 [(google.api.field_behavior) = INPUT_ONLY]; // Output only. Represents the KAJ enrollment state of the given workload. - KajEnrollmentState kaj_enrollment_state = 17 - [(google.api.field_behavior) = OUTPUT_ONLY]; + KajEnrollmentState kaj_enrollment_state = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Indicates the sovereignty status of the given workload. // Currently meant to be used by Europe/Canada customers. @@ -443,15 +502,22 @@ message Workload { // Output only. Represents the SAA enrollment response of the given workload. // SAA enrollment response is queried during GetWorkload call. // In failure cases, user friendly error message is shown in SAA details page. - SaaEnrollmentResponse saa_enrollment_response = 20 - [(google.api.field_behavior) = OUTPUT_ONLY]; + SaaEnrollmentResponse saa_enrollment_response = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Urls for services which are compliant for this Assured Workload, but which + // are currently disallowed by the ResourceUsageRestriction org policy. + // Invoke RestrictAllowedResources endpoint to allow your project developers + // to use these services in their environment." + repeated string compliant_but_disallowed_services = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. Compliance Regime associated with this workload. + Partner partner = 25 [(google.api.field_behavior) = OPTIONAL]; } // Operation metadata to give request details of CreateWorkload. message CreateWorkloadOperationMetadata { // Optional. Time when the operation was created. - google.protobuf.Timestamp create_time = 1 - [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The display name of the workload. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; @@ -459,8 +525,294 @@ message CreateWorkloadOperationMetadata { // Optional. The parent of the workload. string parent = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Compliance controls that should be applied to the resources - // managed by the workload. - Workload.ComplianceRegime compliance_regime = 4 - [(google.api.field_behavior) = OPTIONAL]; + // Optional. Compliance controls that should be applied to the resources managed by + // the workload. + Workload.ComplianceRegime compliance_regime = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request for restricting list of available resources in Workload environment. +message RestrictAllowedResourcesRequest { + // The type of restriction. + enum RestrictionType { + // Unknown restriction type. + RESTRICTION_TYPE_UNSPECIFIED = 0; + + // Allow the use all of all gcp products, irrespective of the compliance + // posture. This effectively removes gcp.restrictServiceUsage OrgPolicy + // on the AssuredWorkloads Folder. + ALLOW_ALL_GCP_RESOURCES = 1; + + // Based on Workload's compliance regime, allowed list changes. + // See - https://cloud.google.com/assured-workloads/docs/supported-products + // for the list of supported resources. + ALLOW_COMPLIANT_RESOURCES = 2; + } + + // Required. The resource name of the Workload. This is the workloads's + // relative path in the API, formatted as + // "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". + // For example, + // "organizations/123/locations/us-east1/workloads/assured-workload-1". + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The type of restriction for using gcp products in the Workload environment. + RestrictionType restriction_type = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response for restricting the list of allowed resources. +message RestrictAllowedResourcesResponse { + +} + +// Request for acknowledging the violation +// Next Id: 4 +message AcknowledgeViolationRequest { + // Required. The resource name of the Violation to acknowledge. + // Format: + // organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Business justification explaining the need for violation acknowledgement + string comment = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. This field is deprecated and will be removed in future version of the API. + // Name of the OrgPolicy which was modified with non-compliant change and + // resulted in this violation. + // Format: + // projects/{project_number}/policies/{constraint_name} + // folders/{folder_id}/policies/{constraint_name} + // organizations/{organization_id}/policies/{constraint_name} + string non_compliant_org_policy = 3 [ + deprecated = true, + (google.api.field_behavior) = OPTIONAL + ]; +} + +// Response for violation acknowledgement +message AcknowledgeViolationResponse { + +} + +// Interval defining a time window. +message TimeWindow { + // The start of the time window. + google.protobuf.Timestamp start_time = 1; + + // The end of the time window. + google.protobuf.Timestamp end_time = 2; +} + +// Request for fetching violations in an organization. +message ListViolationsRequest { + // Required. The Workload name. + // Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "assuredworkloads.googleapis.com/Violation" + } + ]; + + // Optional. Specifies the time window for retrieving active Violations. + // When specified, retrieves Violations that were active between start_time + // and end_time. + TimeWindow interval = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Page size. + int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Page token returned from previous request. + string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A custom filter for filtering by the Violations properties. + string filter = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response of ListViolations endpoint. +message ListViolationsResponse { + // List of Violations under a Workload. + repeated Violation violations = 1; + + // The next page token. Returns empty if reached the last page. + string next_page_token = 2; +} + +// Request for fetching a Workload Violation. +message GetViolationRequest { + // Required. The resource name of the Violation to fetch (ie. Violation.name). + // Format: + // organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "assuredworkloads.googleapis.com/Violation" + } + ]; +} + +// Workload monitoring Violation. +message Violation { + option (google.api.resource) = { + type: "assuredworkloads.googleapis.com/Violation" + pattern: "organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}" + }; + + // Violation State Values + enum State { + // Unspecified state. + STATE_UNSPECIFIED = 0; + + // Violation is resolved. + RESOLVED = 2; + + // Violation is Unresolved + UNRESOLVED = 3; + + // Violation is Exception + EXCEPTION = 4; + } + + // Represents remediation guidance to resolve compliance violation for + // AssuredWorkload + message Remediation { + // Classifying remediation into various types based on the kind of + // violation. For example, violations caused due to changes in boolean org + // policy requires different remediation instructions compared to violation + // caused due to changes in allowed values of list org policy. + enum RemediationType { + // Unspecified remediation type + REMEDIATION_TYPE_UNSPECIFIED = 0; + + // Remediation type for boolean org policy + REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION = 1; + + // Remediation type for list org policy which have allowed values in the + // monitoring rule + REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION = 2; + + // Remediation type for list org policy which have denied values in the + // monitoring rule + REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION = 3; + + // Remediation type for gcp.restrictCmekCryptoKeyProjects + REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION = 4; + } + + // Instructions to remediate violation + message Instructions { + // Remediation instructions to resolve violation via gcloud cli + message Gcloud { + // Gcloud command to resolve violation + repeated string gcloud_commands = 1; + + // Steps to resolve violation via gcloud cli + repeated string steps = 2; + + // Additional urls for more information about steps + repeated string additional_links = 3; + } + + // Remediation instructions to resolve violation via cloud console + message Console { + // Link to console page where violations can be resolved + repeated string console_uris = 1; + + // Steps to resolve violation via cloud console + repeated string steps = 2; + + // Additional urls for more information about steps + repeated string additional_links = 3; + } + + // Remediation instructions to resolve violation via gcloud cli + Gcloud gcloud_instructions = 1; + + // Remediation instructions to resolve violation via cloud console + Console console_instructions = 2; + } + + // Required. Remediation instructions to resolve violations + Instructions instructions = 1 [(google.api.field_behavior) = REQUIRED]; + + // Values that can resolve the violation + // For example: for list org policy violations, this will either be the list + // of allowed or denied values + repeated string compliant_values = 2; + + // Output only. Reemediation type based on the type of org policy values violated + RemediationType remediation_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Output only. Immutable. Name of the Violation. + // Format: + // organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Output only. Description for the Violation. + // e.g. OrgPolicy gcp.resourceLocations has non compliant value. + string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time of the event which triggered the Violation. + google.protobuf.Timestamp begin_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The last time when the Violation record was updated. + google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time of the event which fixed the Violation. + // If the violation is ACTIVE this will be empty. + google.protobuf.Timestamp resolve_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Category under which this violation is mapped. + // e.g. Location, Service Usage, Access, Encryption, etc. + string category = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the violation + State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in + // this violation. + string org_policy_constraint = 8 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Output only. Immutable. Audit Log Link for violated resource + // Format: + // https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} + string audit_log_link = 11 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and + // resulted this violation. + // Format: + // projects/{project_number}/policies/{constraint_name} + // folders/{folder_id}/policies/{constraint_name} + // organizations/{organization_id}/policies/{constraint_name} + string non_compliant_org_policy = 12 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Output only. Compliance violation remediation + Remediation remediation = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A boolean that indicates if the violation is acknowledged + bool acknowledged = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. Timestamp when this violation was acknowledged last. + // This will be absent when acknowledged field is marked as false. + optional google.protobuf.Timestamp acknowledgement_time = 15 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. Immutable. Audit Log link to find business justification provided for violation + // exception. Format: + // https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} + string exception_audit_log_link = 16 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; } diff --git a/google/cloud/assuredworkloads/v1/assuredworkloads_v1.yaml b/google/cloud/assuredworkloads/v1/assuredworkloads_v1.yaml index 5c6d73b32..40eefb3bf 100644 --- a/google/cloud/assuredworkloads/v1/assuredworkloads_v1.yaml +++ b/google/cloud/assuredworkloads/v1/assuredworkloads_v1.yaml @@ -5,6 +5,7 @@ title: Assured Workloads API apis: - name: google.cloud.assuredworkloads.v1.AssuredWorkloadsService +- name: google.longrunning.Operations types: - name: google.cloud.assuredworkloads.v1.CreateWorkloadOperationMetadata diff --git a/google/cloud/assuredworkloads/v1beta1/BUILD.bazel b/google/cloud/assuredworkloads/v1beta1/BUILD.bazel index 08dd4126b..5ce0db125 100644 --- a/google/cloud/assuredworkloads/v1beta1/BUILD.bazel +++ b/google/cloud/assuredworkloads/v1beta1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":assuredworkloads_proto_with_info"], gapic_yaml = None, grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", test_deps = [ ":assuredworkloads_java_grpc", @@ -134,13 +135,14 @@ go_gapic_library( grpc_service_config = "assuredworkloads_grpc_service_config.json", importpath = "cloud.google.com/go/assuredworkloads/apiv1beta1;assuredworkloads", metadata = True, + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", transport = "grpc+rest", deps = [ ":assuredworkloads_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -178,6 +180,7 @@ py_gapic_library( srcs = [":assuredworkloads_proto"], grpc_service_config = "assuredworkloads_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-assured-workloads"], + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", transport = "grpc", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "assuredworkloads_php_gapic", srcs = [":assuredworkloads_proto_with_info"], grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":assuredworkloads_php_grpc", ":assuredworkloads_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "assuredworkloads_grpc_service_config.json", package = "google.cloud.assuredworkloads.v1beta1", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -304,6 +311,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/assured-workloads/", ], grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Assured Workloads for Government secures government workloads and accelerates the path to running compliant workloads on Google Cloud.", ruby_cloud_title = "Assured Workloads for Government V1beta1", service_yaml = "assuredworkloads_v1beta1.yaml", @@ -350,6 +358,7 @@ csharp_gapic_library( srcs = [":assuredworkloads_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "assuredworkloads_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "assuredworkloads_v1beta1.yaml", deps = [ ":assuredworkloads_csharp_grpc", diff --git a/google/cloud/audit/BUILD.bazel b/google/cloud/audit/BUILD.bazel index 712939592..1473bb495 100644 --- a/google/cloud/audit/BUILD.bazel +++ b/google/cloud/audit/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"]) @@ -7,30 +16,31 @@ 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 = "audit_proto", srcs = [ "audit_log.proto", + "bigquery_audit_metadata.proto", ], deps = [ + "//google/api:field_behavior_proto", + "//google/iam/v1:policy_proto", "//google/rpc:status_proto", "//google/rpc/context:attribute_context_proto", "@com_google_protobuf//:any_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:struct_proto", + "@com_google_protobuf//:timestamp_proto", ], ) -proto_library( - name = "bigquery_audit_metadata_proto", - srcs = [ - "bigquery_audit_metadata.proto", - ], +proto_library_with_info( + name = "audit_proto_with_info", deps = [ - "//google/iam/v1:policy_proto", - "//google/rpc:status_proto", - "@com_google_protobuf//:duration_proto", - "@com_google_protobuf//:timestamp_proto", + ":audit_proto", + "//google/cloud:common_resources_proto", ], ) @@ -46,10 +56,7 @@ load( java_proto_library( name = "audit_java_proto", - deps = [ - ":audit_proto", - ":bigquery_audit_metadata_proto", - ], + deps = [":audit_proto"], ) java_grpc_library( @@ -85,6 +92,8 @@ go_proto_library( importpath = "google.golang.org/genproto/googleapis/cloud/audit", protos = [":audit_proto"], deps = [ + "//google/api:annotations_go_proto", + "//google/iam/v1:iam_go_proto", "//google/rpc:status_go_proto", "//google/rpc/context:attribute_context_go_proto", ], @@ -104,10 +113,14 @@ moved_proto_library( name = "audit_moved_proto", srcs = [":audit_proto"], deps = [ + "//google/api:field_behavior_proto", + "//google/iam/v1:policy_proto", "//google/rpc:status_proto", "//google/rpc/context:attribute_context_proto", "@com_google_protobuf//:any_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:struct_proto", + "@com_google_protobuf//:timestamp_proto", ], ) diff --git a/google/cloud/audit/audit_log.proto b/google/cloud/audit/audit_log.proto index 33d500830..ed4ae5f48 100644 --- a/google/cloud/audit/audit_log.proto +++ b/google/cloud/audit/audit_log.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,6 +16,7 @@ syntax = "proto3"; package google.cloud.audit; +import "google/api/field_behavior.proto"; import "google/protobuf/any.proto"; import "google/protobuf/struct.proto"; import "google/rpc/context/attribute_context.proto"; @@ -76,6 +77,11 @@ message AuditLog { // one AuthorizationInfo element for each {resource, permission} tuple. repeated AuthorizationInfo authorization_info = 9; + // Indicates the policy violations for this request. If the request + // is denied by the policy, violation information will be logged + // here. + PolicyViolationInfo policy_violation_info = 25; + // Metadata about the operation. RequestMetadata request_metadata = 4; @@ -111,8 +117,8 @@ message AuthenticationInfo { // of third party principal) making the request. For third party identity // callers, the `principal_subject` field is populated instead of this field. // For privacy reasons, the principal email address is sometimes redacted. - // For more information, see - // https://cloud.google.com/logging/docs/audit#user-id. + // For more information, see [Caller identities in audit + // logs](https://cloud.google.com/logging/docs/audit#user-id). string principal_email = 1; // The authority selector specified by the requestor, if any. @@ -173,14 +179,16 @@ message AuthorizationInfo { // Metadata about the request. message RequestMetadata { // The IP address of the caller. - // For caller from internet, this will be public IPv4 or IPv6 address. - // For caller from a Compute Engine VM with external IP address, this - // will be the VM's external IP address. For caller from a Compute - // Engine VM without external IP address, if the VM is in the same - // organization (or project) as the accessed resource, `caller_ip` will - // be the VM's internal IPv4 address, otherwise the `caller_ip` will be - // redacted to "gce-internal-ip". - // See https://cloud.google.com/compute/docs/vpc/ for more information. + // For a caller from the internet, this will be the public IPv4 or IPv6 + // address. For calls made from inside Google's internal production network + // from one GCP service to another, `caller_ip` will be redacted to "private". + // For a caller from a Compute Engine VM with a external IP address, + // `caller_ip` will be the VM's external IP address. For a caller from a + // Compute Engine VM without a external IP address, if the VM is in the same + // organization (or project) as the accessed resource, `caller_ip` will be the + // VM's internal IPv4 address, otherwise `caller_ip` will be redacted to + // "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more + // information. string caller_ip = 1; // The user agent of the caller. @@ -281,3 +289,65 @@ message ServiceAccountDelegationInfo { ThirdPartyPrincipal third_party_principal = 2; } } + +// Information related to policy violations for this request. +message PolicyViolationInfo { + // Indicates the orgpolicy violations for this resource. + OrgPolicyViolationInfo org_policy_violation_info = 1; +} + +// Represents OrgPolicy Violation information. +message OrgPolicyViolationInfo { + // Optional. Resource payload that is currently in scope and is subjected to orgpolicy + // conditions. This payload may be the subset of the actual Resource that may + // come in the request. This payload should not contain any core content. + google.protobuf.Struct payload = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Resource type that the orgpolicy is checked against. + // Example: compute.googleapis.com/Instance, store.googleapis.com/bucket + string resource_type = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Tags referenced on the resource at the time of evaluation. These also + // include the federated tags, if they are supplied in the CheckOrgPolicy + // or CheckCustomConstraints Requests. + // + // Optional field as of now. These tags are the Cloud tags that are + // available on the resource during the policy evaluation and will + // be available as part of the OrgPolicy check response for logging purposes. + map resource_tags = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Policy violations + repeated ViolationInfo violation_info = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Provides information about the Policy violation info for this request. +message ViolationInfo { + // Policy Type enum + enum PolicyType { + // Default value. This value should not be used. + POLICY_TYPE_UNSPECIFIED = 0; + + // Indicates boolean policy constraint + BOOLEAN_CONSTRAINT = 1; + + // Indicates list policy constraint + LIST_CONSTRAINT = 2; + + // Indicates custom policy constraint + CUSTOM_CONSTRAINT = 3; + } + + // Optional. Constraint name + string constraint = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Error message that policy is indicating. + string error_message = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Value that is being checked for the policy. + // This could be in encrypted form (if pii sensitive). + // This field will only be emitted in LIST_POLICY types + string checked_value = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Indicates the type of the policy. + PolicyType policy_type = 4 [(google.api.field_behavior) = OPTIONAL]; +} \ No newline at end of file diff --git a/google/cloud/audit/bigquery_audit_metadata.proto b/google/cloud/audit/bigquery_audit_metadata.proto index f3a87ac53..0cc20ce37 100644 --- a/google/cloud/audit/bigquery_audit_metadata.proto +++ b/google/cloud/audit/bigquery_audit_metadata.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. @@ -65,6 +65,26 @@ message BigQueryAuditMetadata { Job job = 3; } + // Job deletion event. + message JobDeletion { + // Describes how the job was deleted. + enum Reason { + // Unknown. + REASON_UNSPECIFIED = 0; + + // Job was deleted using the jobs.delete API. + JOB_DELETE_REQUEST = 1; + } + + // Job URI. + // + // Format: `projects//jobs/`. + string job_name = 1; + + // Describes how the job was deleted. + Reason reason = 2; + } + // Dataset creation event. message DatasetCreation { // Describes how the dataset was created. @@ -456,32 +476,6 @@ message BigQueryAuditMetadata { string job_name = 2; } - // BigQuery dataset. - message Dataset { - // Dataset URI. - // - // Format: `projects//datasets/`. - string dataset_name = 1; - - // Dataset creation time. - google.protobuf.Timestamp create_time = 3; - - // Dataset metadata last update time. - google.protobuf.Timestamp update_time = 4; - - // The access control list for the dataset. - BigQueryAcl acl = 5; - - // Default expiration time for tables in the dataset. - google.protobuf.Duration default_table_expire_duration = 6; - - // User-provided metadata for the dataset. - EntityInfo dataset_info = 7; - - // Default encryption for tables in the dataset. - EncryptionInfo default_encryption = 8; - } - // Table deletion event. message TableDeletion { // Describes how the table was deleted. @@ -499,7 +493,7 @@ message BigQueryAuditMetadata { QUERY = 4; } - // Describes how the table was deleted. + // Describes how table was deleted. Reason reason = 1; // The URI of the job that deleted a table. @@ -536,29 +530,6 @@ message BigQueryAuditMetadata { string job_name = 2; } - // Trained BigQuery ML model. - message Model { - // Model URI. - // - // Format: `projects//datasets//models/`. - string model_name = 1; - - // User-provided metadata for the model. - EntityInfo model_info = 2; - - // Model expiration time. - google.protobuf.Timestamp expire_time = 5; - - // Model creation time. - google.protobuf.Timestamp create_time = 6; - - // Model last update time. - google.protobuf.Timestamp update_time = 7; - - // Model encryption information. Set when non-default encryption is used. - EncryptionInfo encryption = 8; - } - // Routine deletion event. message RoutineDeletion { // Describes how the routine was deleted. @@ -586,6 +557,69 @@ message BigQueryAuditMetadata { string job_name = 4; } + // Row access policy creation event. + message RowAccessPolicyCreation { + // The row access policy created by this event. + RowAccessPolicy row_access_policy = 1; + + // The URI of the job that created this row access policy. + // + // Format: `projects//jobs/`. + string job_name = 2; + } + + // Row access policy change event. + message RowAccessPolicyChange { + // The row access policy that was changed by this event. + RowAccessPolicy row_access_policy = 1; + + // The URI of the job that created this row access policy. + // + // Format: `projects//jobs/`. + string job_name = 2; + } + + // Row access policy deletion event. + message RowAccessPolicyDeletion { + // The row access policies that were deleted. At present, only populated + // when a single policy is dropped. + repeated RowAccessPolicy row_access_policies = 1; + + // The job that deleted these row access policies. + // + // Format: `projects//jobs/`. + string job_name = 2; + + // This field is set to true when a DROP ALL command has been executed, thus + // removing all row access policies on the table. + bool all_row_access_policies_dropped = 3; + } + + // Unlink linked dataset from its source dataset event + message UnlinkDataset { + // Describes how the unlinking operation occurred. + enum Reason { + // Unknown. + REASON_UNSPECIFIED = 0; + + // Linked dataset unlinked via API + UNLINK_API = 1; + } + + // The linked dataset URI which is unlinked from its source. + // + // Format: `projects//datasets/`. + string linked_dataset = 1; + + // The source dataset URI from which the linked dataset is unlinked. + // + // Format: `projects//datasets/`. + string source_dataset = 2; + + // Reason for unlinking linked dataset + Reason reason = 3; + } + // BigQuery job. message Job { // Job URI. @@ -607,6 +641,24 @@ message BigQueryAuditMetadata { // See the [Jobs](https://cloud.google.com/bigquery/docs/reference/v2/jobs) // API resource for more details on individual fields. message JobConfig { + // Job type. + enum Type { + // Unknown. + TYPE_UNSPECIFIED = 0; + + // Query job. + QUERY = 1; + + // Table copy job. + COPY = 2; + + // Export (extract) job. + EXPORT = 3; + + // Import (load) job. + IMPORT = 4; + } + // Query job configuration. message Query { // Priority given to the query. @@ -730,24 +782,6 @@ message BigQueryAuditMetadata { google.protobuf.Timestamp destination_expiration_time = 8; } - // Job type. - enum Type { - // Unknown. - TYPE_UNSPECIFIED = 0; - - // Query job. - QUERY = 1; - - // Table copy job. - COPY = 2; - - // Export (extract) job. - EXPORT = 3; - - // Import (load) job. - IMPORT = 4; - } - // Job type. Type type = 1; @@ -779,98 +813,17 @@ message BigQueryAuditMetadata { repeated string source_uris = 2; } - // Status of a job. - message JobStatus { - // State of the job. - JobState job_state = 1; - - // Job error, if the job failed. - google.rpc.Status error_result = 2; - - // Errors encountered during the running of the job. Does not necessarily - // mean that the job has completed or was unsuccessful. - repeated google.rpc.Status errors = 3; - } - - // Job statistics. - message JobStats { - // Query job statistics. - message Query { - // Total bytes processed by the query job. - int64 total_processed_bytes = 1; - - // Total bytes billed by the query job. - int64 total_billed_bytes = 2; - - // The tier assigned by the CPU-based billing. - int32 billing_tier = 3; - - // Tables accessed by the query job. - repeated string referenced_tables = 6; - - // Views accessed by the query job. - repeated string referenced_views = 7; - - // Routines accessed by the query job. - repeated string referenced_routines = 10; - - // Number of output rows produced by the query job. - int64 output_row_count = 8; - - // True if the query job results were read from the query cache. - bool cache_hit = 9; - } - - // Load job statistics. - message Load { - // Total bytes loaded by the import job. - int64 total_output_bytes = 1; - } - - // Extract job statistics. - message Extract { - // Total bytes exported by the extract job. - int64 total_input_bytes = 1; - } - - // Job resource usage breakdown by reservation. - message ReservationResourceUsage { - // Reservation name or "unreserved" for on-demand resources usage. - string name = 1; - - // Total slot milliseconds used by the reservation for a particular job. - int64 slot_ms = 2; - } - - // Job creation time. - google.protobuf.Timestamp create_time = 1; - - // Job execution start time. - google.protobuf.Timestamp start_time = 2; - - // Job completion time. - google.protobuf.Timestamp end_time = 3; - - // Statistics specific to the job type. - oneof extended { - // Query job statistics. - Query query_stats = 8; - - // Load job statistics. - Load load_stats = 9; - - // Extract job statistics. - Extract extract_stats = 13; - } - - // The total number of slot-ms consumed by the query job. - int64 total_slot_ms = 10; + // Describes whether a job should create a destination table if it doesn't + // exist. + enum CreateDisposition { + // Unknown. + CREATE_DISPOSITION_UNSPECIFIED = 0; - // Reservation usage attributed from each tier of a reservation hierarchy. - repeated ReservationResourceUsage reservation_usage = 11; + // This job should never create tables. + CREATE_NEVER = 1; - // Parent job name. Only present for child jobs. - string parent_job_name = 12; + // This job should create a table if it doesn't already exist. + CREATE_IF_NEEDED = 2; } // Describes whether a job should overwrite or append the existing destination @@ -889,128 +842,23 @@ message BigQueryAuditMetadata { WRITE_APPEND = 3; } - // BigQuery table. - message Table { - // Table URI. - // - // Format: `projects//datasets//tables/`. - string table_name = 1; - - // A JSON representation of the table's schema. Entire field is truncated - // if exceeds 40K. - string schema_json = 3; + // Table copy job operation type. + enum OperationType { + // Unspecified operation type. + OPERATION_TYPE_UNSPECIFIED = 0; - // True if the schema_json field was truncated. - bool schema_json_truncated = 11; + // The source and the destination table have the same table type. + COPY = 1; - // View metadata. Only present for views. - TableViewDefinition view = 4; - - // Table expiration time. - google.protobuf.Timestamp expire_time = 5; - - // The table creation time. - google.protobuf.Timestamp create_time = 6; - - // The last time metadata update time. - google.protobuf.Timestamp update_time = 7; - - // The last table truncation time. - google.protobuf.Timestamp truncate_time = 8; - - // Table encryption information. Set when non-default encryption is used. - EncryptionInfo encryption = 9; - - // User-provided metadata for the table. - EntityInfo table_info = 10; - } - - // User Defined Function (UDF) or Stored Procedure. - message Routine { - // Routine URI. - // - // Format: - // `projects//datasets//routines/`. - string routine_name = 1; - - // Routine creation time. - google.protobuf.Timestamp create_time = 5; - - // Routine last update time. - google.protobuf.Timestamp update_time = 6; - } - - // Table copy job operation type. - enum OperationType { - // Unspecified operation type. - OPERATION_TYPE_UNSPECIFIED = 0; - - // The source and the destination table have the same table type. - COPY = 1; - - // The source table type is TABLE and - // the destination table type is SNAPSHOT. - SNAPSHOT = 2; + // The source table type is TABLE and + // the destination table type is SNAPSHOT. + SNAPSHOT = 2; // The source table type is SNAPSHOT and // the destination table type is TABLE. RESTORE = 3; } - // User-provided metadata for an entity, for e.g. dataset, table or model. - message EntityInfo { - // A short name for the entity. - string friendly_name = 1; - - // A long description for the entity. - string description = 2; - - // Labels provided for the entity. - map labels = 3; - } - - // View definition. - message TableViewDefinition { - // SQL query defining the view. Truncated if exceeds 40K. - string query = 1; - - // True if the schema_json field was truncated. - bool query_truncated = 2; - } - - // An access control list. - message BigQueryAcl { - // IAM policy for the resource. - google.iam.v1.Policy policy = 1; - - // List of authorized views for a dataset. - // - // Format: `projects//datasets//tables/`. - repeated string authorized_views = 2; - } - - // Encryption properties for a table or a job - message EncryptionInfo { - // Cloud kms key identifier. - // - // Format: - // `projects//locations//keyRings//cryptoKeys/` - string kms_key_name = 1; - } - - // Describes whether a job should create a destination table if it doesn't - // exist. - enum CreateDisposition { - // Unknown. - CREATE_DISPOSITION_UNSPECIFIED = 0; - - // This job should never create tables. - CREATE_NEVER = 1; - - // This job should create a table if it doesn't already exist. - CREATE_IF_NEEDED = 2; - } - // State of a job. enum JobState { // State unknown. @@ -1067,12 +915,21 @@ message BigQueryAuditMetadata { // CREATE FUNCTION <Function>(<Signature>) AS ... CREATE_FUNCTION = 14; + // CREATE TABLE FUNCTION <Function>(<Signature>) AS ... + CREATE_TABLE_FUNCTION = 56; + // CREATE PROCEDURE <Procedure> CREATE_PROCEDURE = 20; + // CREATE ROW ACCESS POLICY <RowAccessPolicy> ON <Table> + CREATE_ROW_ACCESS_POLICY = 24; + // CREATE SCHEMA <Schema> CREATE_SCHEMA = 53; + // CREATE SNAPSHOT TABLE <Snapshot> CLONE <Table> + CREATE_SNAPSHOT_TABLE = 59; + // DROP TABLE <Table> DROP_TABLE = 10; @@ -1097,6 +954,13 @@ message BigQueryAuditMetadata { // DROP SCHEMA <Schema> DROP_SCHEMA = 54; + // DROP ROW ACCESS POLICY <RowAccessPolicy> ON <Table> DROP + // ALL ROW ACCESS POLICIES ON ON <Table> + DROP_ROW_ACCESS_POLICY = 25; + + // DROP SNAPSHOT TABLE <Snapshot> + DROP_SNAPSHOT_TABLE = 62; + // ALTER TABLE <Table> ALTER_TABLE = 17; @@ -1112,7 +976,7 @@ message BigQueryAuditMetadata { // Script SCRIPT = 19; - // TRUNCATE TABLE <Table> + // TRUNCATE TABLE <Table> TRUNCATE_TABLE = 26; // CREATE EXTERNAL TABLE <TABLE> @@ -1125,6 +989,267 @@ message BigQueryAuditMetadata { CALL = 29; } + // Status of a job. + message JobStatus { + // State of the job. + JobState job_state = 1; + + // Job error, if the job failed. + google.rpc.Status error_result = 2; + + // Errors encountered during the running of the job. Does not necessarily + // mean that the job has completed or was unsuccessful. + repeated google.rpc.Status errors = 3; + } + + // Job statistics. + message JobStats { + // Query job statistics. + message Query { + // Total bytes processed by the query job. + int64 total_processed_bytes = 1; + + // Total bytes billed by the query job. + int64 total_billed_bytes = 2; + + // The tier assigned by the CPU-based billing. + int32 billing_tier = 3; + + // Tables accessed by the query job. + repeated string referenced_tables = 6; + + // Views accessed by the query job. + repeated string referenced_views = 7; + + // Routines accessed by the query job. + repeated string referenced_routines = 10; + + // Number of output rows produced by the query job. + int64 output_row_count = 8; + + // True if the query job results were read from the query cache. + bool cache_hit = 9; + } + + // Load job statistics. + message Load { + // Total bytes loaded by the import job. + int64 total_output_bytes = 1; + } + + // Extract job statistics. + message Extract { + // Total bytes exported by the extract job. + int64 total_input_bytes = 1; + } + + // Job resource usage breakdown by reservation. + message ReservationResourceUsage { + // Reservation name or "unreserved" for on-demand resources usage. + string name = 1; + + // Total slot milliseconds used by the reservation for a particular job. + int64 slot_ms = 2; + } + + // Job creation time. + google.protobuf.Timestamp create_time = 1; + + // Job execution start time. + google.protobuf.Timestamp start_time = 2; + + // Job completion time. + google.protobuf.Timestamp end_time = 3; + + // Statistics specific to the job type. + oneof extended { + // Query job statistics. + Query query_stats = 8; + + // Load job statistics. + Load load_stats = 9; + + // Extract job statistics. + Extract extract_stats = 13; + } + + // The total number of slot-ms consumed by the query job. + int64 total_slot_ms = 10; + + // Reservation usage attributed from each tier of a reservation hierarchy. + repeated ReservationResourceUsage reservation_usage = 11; + + // Parent job name. Only present for child jobs. + string parent_job_name = 12; + } + + // BigQuery table. + message Table { + // Table URI. + // + // Format: `projects//datasets//tables/`. + string table_name = 1; + + // User-provided metadata for the table. + EntityInfo table_info = 10; + + // A JSON representation of the table's schema. Entire field is truncated + // if exceeds 40K. + string schema_json = 3; + + // True if the schema_json field was truncated. + bool schema_json_truncated = 11; + + // View metadata. Only present for views. + TableViewDefinition view = 4; + + // Table expiration time. + google.protobuf.Timestamp expire_time = 5; + + // The table creation time. + google.protobuf.Timestamp create_time = 6; + + // The last time metadata update time. + google.protobuf.Timestamp update_time = 7; + + // The last table truncation time. + google.protobuf.Timestamp truncate_time = 8; + + // Table encryption information. Set when non-default encryption is used. + EncryptionInfo encryption = 9; + } + + // Trained BigQuery ML model. + message Model { + // Model URI. + // + // Format: `projects//datasets//models/`. + string model_name = 1; + + // User-provided metadata for the model. + EntityInfo model_info = 2; + + // Model expiration time. + google.protobuf.Timestamp expire_time = 5; + + // Model creation time. + google.protobuf.Timestamp create_time = 6; + + // Model last update time. + google.protobuf.Timestamp update_time = 7; + + // Model encryption information. Set when non-default encryption is used. + EncryptionInfo encryption = 8; + } + + // User Defined Function (UDF) or Stored Procedure. + message Routine { + // Routine URI. + // + // Format: + // `projects//datasets//routines/`. + string routine_name = 1; + + // Routine creation time. + google.protobuf.Timestamp create_time = 5; + + // Routine last update time. + google.protobuf.Timestamp update_time = 6; + } + + // User-provided metadata for an entity, for e.g. dataset, table or model. + message EntityInfo { + // A short name for the entity. + string friendly_name = 1; + + // A long description for the entity. + string description = 2; + + // Labels provided for the entity. + map labels = 3; + } + + // View definition. + message TableViewDefinition { + // SQL query defining the view. Truncated if exceeds 40K. + string query = 1; + + // True if the schema_json field was truncated. + bool query_truncated = 2; + } + + // BigQuery dataset. + message Dataset { + // Dataset URI. + // + // Format: `projects//datasets/`. + string dataset_name = 1; + + // User-provided metadata for the dataset. + EntityInfo dataset_info = 7; + + // Dataset creation time. + google.protobuf.Timestamp create_time = 3; + + // Dataset metadata last update time. + google.protobuf.Timestamp update_time = 4; + + // The access control list for the dataset. + BigQueryAcl acl = 5; + + // Default expiration time for tables in the dataset. + google.protobuf.Duration default_table_expire_duration = 6; + + // Default encryption for tables in the dataset. + EncryptionInfo default_encryption = 8; + + // Default collation for the dataset. + string default_collation = 9; + } + + // An access control list. + message BigQueryAcl { + // IAM policy for the resource. + google.iam.v1.Policy policy = 1; + + // List of authorized views for a dataset. + // + // Format: `projects//datasets//tables/`. + repeated string authorized_views = 2; + } + + // Encryption properties for a table or a job + message EncryptionInfo { + // Cloud kms key identifier. + // + // Format: + // `projects//locations//keyRings//cryptoKeys/` + string kms_key_name = 1; + } + + // BigQuery row access policy. + message RowAccessPolicy { + // Row access policy URI. + // + // Format: + // `projects//datasets//tables//rowAccessPolicies/` + string row_access_policy_name = 1; + } + + // First party (Google) application specific request metadata. + message FirstPartyAppMetadata { + oneof metadata { + // Google Sheets metadata. + SheetsMetadata sheets_metadata = 1; + } + } + + // Google Sheets specific request metadata. + message SheetsMetadata { + // The ID of the spreadsheet from which the request is sent. + string doc_id = 1; + } + // BigQuery event information. oneof event { // Job insertion event. @@ -1133,6 +1258,9 @@ message BigQueryAuditMetadata { // Job state change event. JobChange job_change = 2; + // Job deletion event. + JobDeletion job_deletion = 23; + // Dataset creation event. DatasetCreation dataset_creation = 3; @@ -1180,5 +1308,20 @@ message BigQueryAuditMetadata { // Routine deletion event. RoutineDeletion routine_deletion = 18; + + // Row access policy create event. + RowAccessPolicyCreation row_access_policy_creation = 20; + + // Row access policy change event. + RowAccessPolicyChange row_access_policy_change = 21; + + // Row access policy deletion event. + RowAccessPolicyDeletion row_access_policy_deletion = 22; + + // Unlink linked dataset from its source dataset event + UnlinkDataset unlink_dataset = 25; } + + // First party (Google) application specific metadata. + FirstPartyAppMetadata first_party_app_metadata = 24; } diff --git a/google/cloud/automl/v1/BUILD.bazel b/google/cloud/automl/v1/BUILD.bazel index fc1ff6720..fd2bd8c32 100644 --- a/google/cloud/automl/v1/BUILD.bazel +++ b/google/cloud/automl/v1/BUILD.bazel @@ -83,6 +83,7 @@ java_gapic_library( name = "automl_java_gapic", srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":automl_java_grpc", ], @@ -144,13 +145,14 @@ go_gapic_library( srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", importpath = "cloud.google.com/go/automl/apiv1;automl", + rest_numeric_enums = True, service_yaml = "automl_v1.yaml", transport = "grpc+rest", deps = [ ":automl_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", @@ -188,6 +190,7 @@ py_gapic_library( name = "automl_py_gapic", srcs = [":automl_proto"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -235,7 +238,9 @@ php_gapic_library( name = "automl_php_gapic", srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "automl_v1.yaml", + transport = "grpc+rest", deps = [ ":automl_php_grpc", ":automl_php_proto", @@ -269,7 +274,9 @@ nodejs_gapic_library( grpc_service_config = "automl_grpc_service_config.json", main_service = "automl", package = "google.cloud.automl.v1", + rest_numeric_enums = True, service_yaml = "automl_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -317,6 +324,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=automl", ], grpc_service_config = "automl_grpc_service_config.json", + 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", deps = [ @@ -362,6 +370,7 @@ csharp_gapic_library( srcs = [":automl_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "automl_v1.yaml", deps = [ ":automl_csharp_grpc", diff --git a/google/cloud/automl/v1beta1/BUILD.bazel b/google/cloud/automl/v1beta1/BUILD.bazel index aabd387b0..c453fd13c 100644 --- a/google/cloud/automl/v1beta1/BUILD.bazel +++ b/google/cloud/automl/v1beta1/BUILD.bazel @@ -92,6 +92,7 @@ java_gapic_library( name = "automl_java_gapic", srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":automl_java_grpc", ], @@ -153,13 +154,14 @@ go_gapic_library( srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", importpath = "cloud.google.com/go/automl/apiv1beta1;automl", + rest_numeric_enums = True, service_yaml = "automl_v1beta1.yaml", transport = "grpc+rest", deps = [ ":automl_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", @@ -197,6 +199,7 @@ py_gapic_library( name = "automl_py_gapic", srcs = [":automl_proto"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -244,7 +247,9 @@ php_gapic_library( name = "automl_php_gapic", srcs = [":automl_proto_with_info"], grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "automl_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":automl_php_grpc", ":automl_php_proto", @@ -278,7 +283,9 @@ nodejs_gapic_library( grpc_service_config = "automl_grpc_service_config.json", main_service = "automl", package = "google.cloud.automl.v1beta1", + rest_numeric_enums = True, service_yaml = "automl_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -325,6 +332,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=automl", ], grpc_service_config = "automl_grpc_service_config.json", + 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", deps = [ @@ -370,6 +378,7 @@ csharp_gapic_library( srcs = [":automl_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "automl_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "automl_v1beta1.yaml", deps = [ ":automl_csharp_grpc", diff --git a/google/cloud/backupdr/logging/v1/BUILD.bazel b/google/cloud/backupdr/logging/v1/BUILD.bazel new file mode 100644 index 000000000..bd5a02c01 --- /dev/null +++ b/google/cloud/backupdr/logging/v1/BUILD.bazel @@ -0,0 +1,177 @@ +# TODO(pandeydeeksha): describe this package. + +# This file was automatically generated by BuildFileGenerator + +############################################################################## +# Common +############################################################################## +load("@rules_proto//proto:defs.bzl", "proto_library") + +############################################################################## +# Java +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "java_grpc_library", + "java_proto_library", +) + +############################################################################## +# Go +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "go_proto_library", +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +############################################################################## +# PHP +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "php_grpc_library", + "php_proto_library", +) + +############################################################################## +# 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", +) + +############################################################################## +# C# +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_grpc_library", + "csharp_proto_library", +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) + +proto_library( + name = "logging_proto", + srcs = [ + "eventlog.proto", + ], + deps = [ + "@com_google_protobuf//:timestamp_proto", + ], +) + +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_proto_library( + name = "logging_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/backupdr/logging/v1", + protos = [":logging_proto"], + deps = [ + ], +) + +moved_proto_library( + name = "logging_moved_proto", + srcs = [":logging_proto"], + deps = [ + "@com_google_protobuf//:timestamp_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_proto_library( + name = "logging_php_proto", + deps = [":logging_proto"], +) + +php_grpc_library( + name = "logging_php_grpc", + srcs = [":logging_proto"], + deps = [":logging_php_proto"], +) + +ruby_proto_library( + name = "logging_ruby_proto", + deps = [":logging_proto"], +) + +ruby_grpc_library( + name = "logging_ruby_grpc", + srcs = [":logging_proto"], + deps = [":logging_ruby_proto"], +) + +csharp_proto_library( + name = "logging_csharp_proto", + deps = [":logging_proto"], +) + +csharp_grpc_library( + name = "logging_csharp_grpc", + srcs = [":logging_proto"], + deps = [":logging_csharp_proto"], +) + +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/google/cloud/backupdr/logging/v1/eventlog.proto b/google/cloud/backupdr/logging/v1/eventlog.proto new file mode 100644 index 000000000..ce85da9d9 --- /dev/null +++ b/google/cloud/backupdr/logging/v1/eventlog.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.cloud.backupdr.logging.v1; + +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/backupdr/logging/v1;logging"; + +// This is an event +message Event { + // The event_time field displays the time when the event was reported + google.protobuf.Timestamp event_time = 1; + + // The srcid field displays unique id of the event occurred in the backup + // appliance + int64 srcid = 2; + + // The error_message field describes the detailed error associated with the + // event + string error_message = 3; + + // The event_id field displays unique id associated with the error + int32 event_id = 4; + + // The component field displays the source of the event + string component = 5; + + // The appliance_id field displays unique id of the appliance on which event + // occurred + int64 appliance_id = 6; + // The appliance_name field displays name of the appliance on which event + // occurred + string appliance_name = 7; + // The source_event_time field displays the time when the event occurred at + // appliance + google.protobuf.Timestamp source_event_time = 8; + + // The app_name field displays name of the application associated with the + // event + string app_name = 9; + + // The app_type field displays type of the application associated with the + // event + string app_type = 10; + + // The job_name field displays name of the job associated with the event + string job_name = 11; +} diff --git a/google/cloud/baremetalsolution/v2/BUILD.bazel b/google/cloud/baremetalsolution/v2/BUILD.bazel index 9b821662d..18eca6fb6 100644 --- a/google/cloud/baremetalsolution/v2/BUILD.bazel +++ b/google/cloud/baremetalsolution/v2/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":baremetalsolution_proto_with_info"], gapic_yaml = None, grpc_service_config = "baremetalsolution_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "baremetalsolution_v2.yaml", test_deps = [ ":baremetalsolution_java_grpc", @@ -137,14 +138,15 @@ go_gapic_library( grpc_service_config = "baremetalsolution_grpc_service_config.json", importpath = "cloud.google.com/go/baremetalsolution/apiv2;baremetalsolution", metadata = True, + rest_numeric_enums = True, service_yaml = "baremetalsolution_v2.yaml", transport = "grpc+rest", deps = [ ":baremetalsolution_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -185,6 +187,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bare_metal_solution", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -232,7 +235,9 @@ php_gapic_library( name = "baremetalsolution_php_gapic", srcs = [":baremetalsolution_proto_with_info"], grpc_service_config = "baremetalsolution_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "baremetalsolution_v2.yaml", + transport = "grpc+rest", deps = [ ":baremetalsolution_php_grpc", ":baremetalsolution_php_proto", @@ -265,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "baremetalsolution_grpc_service_config.json", package = "google.cloud.baremetalsolution.v2", + rest_numeric_enums = True, service_yaml = "baremetalsolution_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -309,6 +316,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/bare-metal/", ], grpc_service_config = "baremetalsolution_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Bare Metal Solution is a managed solution that provides purpose-built HPE or Atos bare-metal servers in regional extensions that are connected to Google Cloud by a managed, high-performance connection with a low-latency network fabric.", ruby_cloud_title = "Bare Metal Solution V2", service_yaml = "baremetalsolution_v2.yaml", @@ -355,6 +363,7 @@ csharp_gapic_library( srcs = [":baremetalsolution_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "baremetalsolution_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "baremetalsolution_v2.yaml", deps = [ ":baremetalsolution_csharp_grpc", diff --git a/google/cloud/batch/v1/BUILD.bazel b/google/cloud/batch/v1/BUILD.bazel index 1286a10c9..261c591a5 100644 --- a/google/cloud/batch/v1/BUILD.bazel +++ b/google/cloud/batch/v1/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( srcs = [":batch_proto_with_info"], gapic_yaml = None, grpc_service_config = "batch_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", test_deps = [ ":batch_java_grpc", @@ -140,6 +141,7 @@ go_gapic_library( grpc_service_config = "batch_v1_grpc_service_config.json", importpath = "cloud.google.com/go/batch/apiv1;batch", metadata = True, + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", transport = "grpc+rest", deps = [ @@ -147,8 +149,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -185,6 +187,7 @@ py_gapic_library( name = "batch_py_gapic", srcs = [":batch_proto"], grpc_service_config = "batch_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", transport = "grpc+rest", deps = [ @@ -236,7 +239,9 @@ php_gapic_library( name = "batch_php_gapic", srcs = [":batch_proto_with_info"], grpc_service_config = "batch_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", + transport = "grpc+rest", deps = [ ":batch_php_grpc", ":batch_php_proto", @@ -269,7 +274,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "batch_v1_grpc_service_config.json", package = "google.cloud.batch.v1", + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-batch-v1", ], grpc_service_config = "batch_v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud Batch is a fully managed service used by scientists, VFX artists, developers to easily and efficiently run batch workloads on Google Cloud. This service manages provisioning of resources to satisfy the requirements of the batch jobs for a variety of workloads including ML, HPC, VFX rendering, transcoding, genomics and others.", ruby_cloud_title = "Batch V1", service_yaml = "batch_v1.yaml", @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":batch_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "batch_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1.yaml", deps = [ ":batch_csharp_grpc", diff --git a/google/cloud/batch/v1/batch.proto b/google/cloud/batch/v1/batch.proto index 5dfe9cad7..1fa330088 100644 --- a/google/cloud/batch/v1/batch.proto +++ b/google/cloud/batch/v1/batch.proto @@ -107,8 +107,9 @@ message CreateJobRequest { ]; // ID used to uniquely identify the Job within its parent scope. - // This field should contain at most 63 characters. - // Only alphanumeric characters or '-' are accepted. + // This field should contain at most 63 characters and must start with + // lowercase characters. + // Only lowercase characters, numbers and '-' are accepted. // The '-' character cannot be the first or the last one. // A system generated ID will be used if the field is not set. // diff --git a/google/cloud/batch/v1/batch_v1.yaml b/google/cloud/batch/v1/batch_v1.yaml index de3e4274b..15505521c 100644 --- a/google/cloud/batch/v1/batch_v1.yaml +++ b/google/cloud/batch/v1/batch_v1.yaml @@ -66,25 +66,12 @@ http: get: '/v1/{name=projects/*}/locations' - selector: google.iam.v1.IAMPolicy.GetIamPolicy get: '/v1/{resource=projects/*/locations/*/jobs/*}:getIamPolicy' - additional_bindings: - - get: '/v1/{resource=projects/*/locations/*/tasks/*}:getIamPolicy' - - get: '/v1/{resource=projects/*/locations/*/nodes/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1/{resource=projects/*/locations/*/jobs/*}:setIamPolicy' body: '*' - additional_bindings: - - post: '/v1/{resource=projects/*/locations/*/tasks/*}:setIamPolicy' - body: '*' - - post: '/v1/{resource=projects/*/locations/*/nodes/*}:setIamPolicy' - body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1/{resource=projects/*/locations/*/jobs/*}:testIamPermissions' body: '*' - additional_bindings: - - post: '/v1/{resource=projects/*/locations/*/tasks/*}:testIamPermissions' - body: '*' - - post: '/v1/{resource=projects/*/locations/*/nodes/*}:testIamPermissions' - body: '*' - selector: google.longrunning.Operations.CancelOperation post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' body: '*' @@ -117,3 +104,6 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/cloud/batch/v1/job.proto b/google/cloud/batch/v1/job.proto index 9c746ebea..0519f68f4 100644 --- a/google/cloud/batch/v1/job.proto +++ b/google/cloud/batch/v1/job.proto @@ -263,7 +263,7 @@ message AllocationPolicy { string disk_interface = 6; } - // A new or an existing persistent disk or a local ssd attached to a VM + // A new or an existing persistent disk (PD) or a local ssd attached to a VM // instance. message AttachedDisk { oneof attached { @@ -274,11 +274,13 @@ message AllocationPolicy { } // Device name that the guest operating system will see. - // If not specified, this is default to the disk name. + // It is used by Runnable.volumes field to mount disks. So please specify + // the device_name if you want Batch to help mount the disk, and it should + // match the device_name field in volumes. string device_name = 3; } - // Accelerator describes Compute Engine accelerators to be attached to VMs. + // Accelerator describes Compute Engine accelerators to be attached to the VM. message Accelerator { // The accelerator type. For example, "nvidia-tesla-t4". // See `gcloud compute accelerator-types list`. @@ -287,6 +289,7 @@ message AllocationPolicy { // The number of accelerators of this type. int64 count = 2; + // Deprecated: please use instances[0].install_gpu_drivers instead. bool install_gpu_drivers = 3 [deprecated = true]; } @@ -306,11 +309,10 @@ message AllocationPolicy { ProvisioningModel provisioning_model = 4; // The accelerators attached to each VM instance. - // Not yet implemented. repeated Accelerator accelerators = 5; // Non-boot disks to be attached for each VM created by this InstancePolicy. - // New disks will be deleted when the attached VM is deleted. + // New disks will be deleted when the VM is deleted. repeated AttachedDisk disks = 6; } @@ -325,6 +327,12 @@ message AllocationPolicy { // c++ keyword conflict. string instance_template = 2; } + + // Set this field true if users want Batch to help fetch drivers from a + // third party location and install them for GPUs specified in + // policy.accelerators or instance_template on their behalf. Default is + // false. + bool install_gpu_drivers = 3; } // A network interface. @@ -378,6 +386,9 @@ message AllocationPolicy { // Only instances[0] is supported now. repeated InstancePolicyOrTemplate instances = 8; + // Service account that VMs will run as. + ServiceAccount service_account = 9; + // Labels applied to all VM instances and other resources // created by AllocationPolicy. // Labels could be user provided or system generated. @@ -443,3 +454,12 @@ message TaskGroup { // VMs running the Batch tasks in the same TaskGroup. bool permissive_ssh = 12; } + +// Carries information about a Google Cloud service account. +message ServiceAccount { + // Email address of the service account. If not specified, the default + // Compute Engine service account for the project will be used. If instance + // 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; +} diff --git a/google/cloud/batch/v1/task.proto b/google/cloud/batch/v1/task.proto index bc4dbfea3..3c6251b94 100644 --- a/google/cloud/batch/v1/task.proto +++ b/google/cloud/batch/v1/task.proto @@ -126,12 +126,12 @@ message Runnable { bool block_external_network = 9; // Optional username for logging in to a docker registry. If username - // matches "projects/*/secrets/*/versions/*" then Batch will read the + // matches `projects/*/secrets/*/versions/*` then Batch will read the // username from the Secret Manager. string username = 10; // Optional password for logging in to a docker registry. If password - // matches "projects/*/secrets/*/versions/*" then Batch will read the + // matches `projects/*/secrets/*/versions/*` then Batch will read the // password from the Secret Manager; string password = 11; } @@ -230,8 +230,7 @@ message TaskSpec { // If task ends with non-zero exit code, retry the task with max_retry_count. repeated LifecyclePolicy lifecycle_policies = 9; - // Environment variables to set before running the Task. - // You can set up to 100 environments. + // Deprecated: please use environment(non-plural) instead. map environments = 6 [deprecated = true]; // Volumes to mount before running Tasks using this TaskSpec. diff --git a/google/cloud/batch/v1/volume.proto b/google/cloud/batch/v1/volume.proto index 45399ccc6..7b6ebac48 100644 --- a/google/cloud/batch/v1/volume.proto +++ b/google/cloud/batch/v1/volume.proto @@ -25,46 +25,50 @@ option objc_class_prefix = "GCB"; option php_namespace = "Google\\Cloud\\Batch\\V1"; option ruby_package = "Google::Cloud::Batch::V1"; -// Volume and mount parameters to be associated with a TaskSpec. A TaskSpec -// might describe zero, one, or multiple volumes to be mounted as part of the -// task. +// Volume describes a volume and parameters for it to be mounted to a VM. message Volume { // The source for the volume. oneof source { - // An NFS source for the volume (could be a Filestore, for example). + // A Network File System (NFS) volume. For example, a + // Filestore file share. NFS nfs = 1; - // A Google Cloud Storage source for the volume. + // A Google Cloud Storage (GCS) volume. GCS gcs = 3; - // Device name of an attached disk + // Device name of an attached disk volume, which should align with a + // device_name specified by + // job.allocation_policy.instances[0].policy.disks[i].device_name or + // defined by the given instance template in + // job.allocation_policy.instances[0].instance_template. string device_name = 6; } - // Mount path for the volume, e.g. /mnt/share + // The mount path for the volume, e.g. /mnt/disks/share. string mount_path = 4; - // Mount options - // For Google Cloud Storage, mount options are the global options supported by - // gcsfuse tool. Batch will use them to mount the volume with the following - // command: - // "gcsfuse [global options] bucket mountpoint". - // For PD, NFS, mount options are these supported by /etc/fstab. Batch will - // use Fstab to mount such volumes. - // https://help.ubuntu.com/community/Fstab + // For Google Cloud Storage (GCS), mount options are the options supported by + // the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). + // For existing persistent disks, mount options provided by the + // mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except + // writing are supported. This is due to restrictions of multi-writer mode + // (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). + // For other attached disks and Network File System (NFS), mount options are + // these supported by the mount command + // (https://man7.org/linux/man-pages/man8/mount.8.html). repeated string mount_options = 5; } -// Represents an NFS server and remote path: : +// Represents an NFS volume. message NFS { - // URI of the NFS server, e.g. an IP address. + // The IP address of the NFS. string server = 1; - // Remote source path exported from NFS, e.g., "/share". + // Remote source path exported from the NFS, e.g., "/share". string remote_path = 2; } -// Represents a Google Cloud Storage volume source config. +// Represents a Google Cloud Storage volume. message GCS { // Remote path, either a bucket name or a subdirectory of a bucket, e.g.: // bucket_name, bucket_name/subdirectory/ diff --git a/google/cloud/batch/v1alpha/BUILD.bazel b/google/cloud/batch/v1alpha/BUILD.bazel index 42e21ab66..02857831c 100644 --- a/google/cloud/batch/v1alpha/BUILD.bazel +++ b/google/cloud/batch/v1alpha/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( srcs = [":batch_proto_with_info"], gapic_yaml = None, grpc_service_config = "batch_v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", test_deps = [ ":batch_java_grpc", @@ -140,6 +141,7 @@ go_gapic_library( grpc_service_config = "batch_v1alpha_grpc_service_config.json", importpath = "cloud.google.com/go/batch/apiv1alpha;batch", metadata = True, + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -147,8 +149,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -185,6 +187,7 @@ py_gapic_library( name = "batch_py_gapic", srcs = [":batch_proto"], grpc_service_config = "batch_v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -236,7 +239,9 @@ php_gapic_library( name = "batch_php_gapic", srcs = [":batch_proto_with_info"], grpc_service_config = "batch_v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":batch_php_grpc", ":batch_php_proto", @@ -269,7 +274,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "batch_v1alpha_grpc_service_config.json", package = "google.cloud.batch.v1alpha", + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-batch-v1alpha", ], grpc_service_config = "batch_v1alpha_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud Batch is a fully managed service used by scientists, VFX artists, developers to easily and efficiently run batch workloads on Google Cloud. This service manages provisioning of resources to satisfy the requirements of the batch jobs for a variety of workloads including ML, HPC, VFX rendering, transcoding, genomics and others.", ruby_cloud_title = "Batch V1alpha", service_yaml = "batch_v1alpha.yaml", @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":batch_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "batch_v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "batch_v1alpha.yaml", deps = [ ":batch_csharp_grpc", diff --git a/google/cloud/batch/v1alpha/batch.proto b/google/cloud/batch/v1alpha/batch.proto index 97b3171ca..cc6dd16a5 100644 --- a/google/cloud/batch/v1alpha/batch.proto +++ b/google/cloud/batch/v1alpha/batch.proto @@ -107,8 +107,9 @@ message CreateJobRequest { ]; // ID used to uniquely identify the Job within its parent scope. - // This field should contain at most 63 characters. - // Only alphanumeric characters or '-' are accepted. + // This field should contain at most 63 characters and must start with + // lowercase characters. + // Only lowercase characters, numbers and '-' are accepted. // The '-' character cannot be the first or the last one. // A system generated ID will be used if the field is not set. // diff --git a/google/cloud/batch/v1alpha/batch_v1alpha.yaml b/google/cloud/batch/v1alpha/batch_v1alpha.yaml index b021fc5a3..b65ed302a 100644 --- a/google/cloud/batch/v1alpha/batch_v1alpha.yaml +++ b/google/cloud/batch/v1alpha/batch_v1alpha.yaml @@ -66,25 +66,12 @@ http: get: '/v1alpha/{name=projects/*}/locations' - selector: google.iam.v1.IAMPolicy.GetIamPolicy get: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:getIamPolicy' - additional_bindings: - - get: '/v1alpha/{resource=projects/*/locations/*/tasks/*}:getIamPolicy' - - get: '/v1alpha/{resource=projects/*/locations/*/nodes/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:setIamPolicy' body: '*' - additional_bindings: - - post: '/v1alpha/{resource=projects/*/locations/*/tasks/*}:setIamPolicy' - body: '*' - - post: '/v1alpha/{resource=projects/*/locations/*/nodes/*}:setIamPolicy' - body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:testIamPermissions' body: '*' - additional_bindings: - - post: '/v1alpha/{resource=projects/*/locations/*/tasks/*}:testIamPermissions' - body: '*' - - post: '/v1alpha/{resource=projects/*/locations/*/nodes/*}:testIamPermissions' - body: '*' - selector: google.longrunning.Operations.CancelOperation post: '/v1alpha/{name=projects/*/locations/*/operations/*}:cancel' body: '*' @@ -117,3 +104,6 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/cloud/batch/v1alpha/job.proto b/google/cloud/batch/v1alpha/job.proto index b313d2910..2271d33da 100644 --- a/google/cloud/batch/v1alpha/job.proto +++ b/google/cloud/batch/v1alpha/job.proto @@ -92,7 +92,7 @@ message Job { // Output only. Job status. It is read only for users. JobStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Job notification. + // Deprecated: please use notifications instead. JobNotification notification = 10 [deprecated = true]; // Output only. When the Job was created. @@ -318,7 +318,7 @@ message AllocationPolicy { string disk_interface = 6; } - // A new or an existing persistent disk or a local ssd attached to a VM + // A new or an existing persistent disk (PD) or a local ssd attached to a VM // instance. message AttachedDisk { oneof attached { @@ -329,11 +329,13 @@ message AllocationPolicy { } // Device name that the guest operating system will see. - // If not specified, this is default to the disk name. + // It is used by Runnable.volumes field to mount disks. So please specify + // the device_name if you want Batch to help mount the disk, and it should + // match the device_name field in volumes. string device_name = 3; } - // Accelerator describes Compute Engine accelerators to be attached to VMs. + // Accelerator describes Compute Engine accelerators to be attached to the VM. message Accelerator { // The accelerator type. For example, "nvidia-tesla-t4". // See `gcloud compute accelerator-types list`. @@ -342,12 +344,14 @@ message AllocationPolicy { // The number of accelerators of this type. int64 count = 2; + // Deprecated: please use instances[0].install_gpu_drivers instead. bool install_gpu_drivers = 3 [deprecated = true]; } // InstancePolicy describes an instance type and resources attached to each VM // created by this InstancePolicy. message InstancePolicy { + // Deprecated: please use machine_type instead. repeated string allowed_machine_types = 1 [deprecated = true]; // The Compute Engine machine type. @@ -363,12 +367,18 @@ message AllocationPolicy { ProvisioningModel provisioning_model = 4; // The accelerators attached to each VM instance. - // Not yet implemented. 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 attached VM is deleted. + // New disks will be deleted when the VM is deleted. repeated AttachedDisk disks = 6; + + // If specified, VMs will be allocated only inside the matching reservation. + string reservation = 7; } // Either an InstancePolicy or an instance template. @@ -383,6 +393,10 @@ message AllocationPolicy { string instance_template = 2; } + // Set this field true if users want Batch to help fetch drivers from a + // third party location and install them for GPUs specified in + // policy.accelerators or instance_template on their behalf. Default is + // false. bool install_gpu_drivers = 3; } @@ -433,29 +447,23 @@ message AllocationPolicy { // Location where compute resources should be allocated for the Job. LocationPolicy location = 1; - // Create only instances allowed by this policy. + // Deprecated: please use instances[0].policy instead. InstancePolicy instance = 2 [deprecated = true]; // Describe instances that can be created by this AllocationPolicy. // Only instances[0] is supported now. repeated InstancePolicyOrTemplate instances = 8; - // Instance templates that are used to VMs. - // If specified, only instance_templates[0] is used. + // Deprecated: please use instances[0].template instead. repeated string instance_templates = 3 [deprecated = true]; - // Create only instances in the listed provisiong models. - // Default to allow all. - // - // Currently only the first model of the provisioning_models list will be - // considered; specifying additional models (e.g., 2nd, 3rd, etc.) is a no-op. + // Deprecated: please use instances[0].policy.provisioning_model instead. repeated ProvisioningModel provisioning_models = 4 [deprecated = true]; - // Email of the service account that VMs will run as. + // Deprecated: please use service_account instead. string service_account_email = 5 [deprecated = true]; // Service account that VMs will run as. - // Not yet implemented. ServiceAccount service_account = 9; // Labels applied to all VM instances and other resources @@ -551,7 +559,9 @@ message TaskGroup { // Carries information about a Google Cloud service account. message ServiceAccount { // Email address of the service account. If not specified, the default - // Compute Engine service account for the project will be used. + // Compute Engine service account for the project will be used. If instance + // 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 diff --git a/google/cloud/batch/v1alpha/task.proto b/google/cloud/batch/v1alpha/task.proto index 6b69165bf..a28545ad4 100644 --- a/google/cloud/batch/v1alpha/task.proto +++ b/google/cloud/batch/v1alpha/task.proto @@ -131,12 +131,12 @@ message Runnable { bool block_external_network = 9; // Optional username for logging in to a docker registry. If username - // matches "projects/*/secrets/*/versions/*" then Batch will read the + // matches `projects/*/secrets/*/versions/*` then Batch will read the // username from the Secret Manager. string username = 10; // Optional password for logging in to a docker registry. If password - // matches "projects/*/secrets/*/versions/*" then Batch will read the + // matches `projects/*/secrets/*/versions/*` then Batch will read the // password from the Secret Manager; string password = 11; } @@ -238,8 +238,7 @@ message TaskSpec { // If task ends with non-zero exit code, retry the task with max_retry_count. repeated LifecyclePolicy lifecycle_policies = 9; - // Environment variables to set before running the Task. - // You can set up to 100 environments. + // Deprecated: please use environment(non-plural) instead. map environments = 6 [deprecated = true]; // Volumes to mount before running Tasks using this TaskSpec. diff --git a/google/cloud/batch/v1alpha/volume.proto b/google/cloud/batch/v1alpha/volume.proto index b71a62bb8..4112d2363 100644 --- a/google/cloud/batch/v1alpha/volume.proto +++ b/google/cloud/batch/v1alpha/volume.proto @@ -25,49 +25,53 @@ option objc_class_prefix = "GCB"; option php_namespace = "Google\\Cloud\\Batch\\V1alpha"; option ruby_package = "Google::Cloud::Batch::V1alpha"; -// Volume and mount parameters to be associated with a TaskSpec. A TaskSpec -// might describe zero, one, or multiple volumes to be mounted as part of the -// task. +// Volume describes a volume and parameters for it to be mounted to a VM. message Volume { // The source for the volume. oneof source { - // An NFS source for the volume (could be a Filestore, for example). + // A Network File System (NFS) volume. For example, a + // Filestore file share. NFS nfs = 1; - // A persistent disk source for the volume. + // Deprecated: please use device_name instead. PD pd = 2 [deprecated = true]; - // A Google Cloud Storage source for the volume. + // A Google Cloud Storage (GCS) volume. GCS gcs = 3; - // Device name of an attached disk + // Device name of an attached disk volume, which should align with a + // device_name specified by + // job.allocation_policy.instances[0].policy.disks[i].device_name or + // defined by the given instance template in + // job.allocation_policy.instances[0].instance_template. string device_name = 6; } - // Mount path for the volume, e.g. /mnt/share + // The mount path for the volume, e.g. /mnt/disks/share. string mount_path = 4; - // Mount options - // For Google Cloud Storage, mount options are the global options supported by - // gcsfuse tool. Batch will use them to mount the volume with the following - // command: - // "gcsfuse [global options] bucket mountpoint". - // For PD, NFS, mount options are these supported by /etc/fstab. Batch will - // use Fstab to mount such volumes. - // https://help.ubuntu.com/community/Fstab + // For Google Cloud Storage (GCS), mount options are the options supported by + // the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). + // For existing persistent disks, mount options provided by the + // mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except + // writing are supported. This is due to restrictions of multi-writer mode + // (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). + // For other attached disks and Network File System (NFS), mount options are + // these supported by the mount command + // (https://man7.org/linux/man-pages/man8/mount.8.html). repeated string mount_options = 5; } -// Represents an NFS server and remote path: : +// Represents an NFS volume. message NFS { - // URI of the NFS server, e.g. an IP address. + // The IP address of the NFS. string server = 1; - // Remote source path exported from NFS, e.g., "/share". + // Remote source path exported from the NFS, e.g., "/share". string remote_path = 2; } -// Represents a GCP persistent disk +// Deprecated: please use device_name instead. message PD { // PD disk name, e.g. pd-1. string disk = 1; @@ -82,7 +86,7 @@ message PD { bool existing = 3 [deprecated = true]; } -// Represents a Google Cloud Storage volume source config. +// Represents a Google Cloud Storage volume. message GCS { // Remote path, either a bucket name or a subdirectory of a bucket, e.g.: // bucket_name, bucket_name/subdirectory/ diff --git a/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel b/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel index 0650f6871..f94cf2f51 100644 --- a/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel +++ b/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel @@ -91,12 +91,14 @@ java_gapic_library( srcs = [":appconnections_proto_with_info"], gapic_yaml = None, grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", test_deps = [ ":appconnections_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":appconnections_java_proto", "//google/api:api_java_proto", @@ -117,6 +119,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-beyondcorp-appconnections-v1-java", include_samples = True, + transport = "grpc", deps = [ ":appconnections_java_gapic", ":appconnections_java_grpc", @@ -142,14 +145,15 @@ go_gapic_library( grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", importpath = "cloud.google.com/go/beyondcorp/appconnections/apiv1;appconnections", metadata = True, + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appconnections_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -180,6 +184,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=beyondcorp_appconnections", ], + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", transport = "grpc+rest", deps = [ @@ -220,7 +225,9 @@ php_gapic_library( name = "appconnections_php_gapic", srcs = [":appconnections_proto_with_info"], grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [ ":appconnections_php_grpc", ":appconnections_php_proto", @@ -244,7 +251,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", package = "google.cloud.beyondcorp.appconnections.v1", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,6 +287,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-beyond_corp", ], grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.", ruby_cloud_title = "BeyondCorp AppConnections V1", service_yaml = "beyondcorp_v1.yaml", @@ -313,6 +323,7 @@ csharp_gapic_library( srcs = [":appconnections_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appconnections_csharp_grpc", diff --git a/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto b/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto index 73f19ff7b..48143604a 100644 --- a/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto +++ b/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto @@ -40,12 +40,12 @@ option (google.api.resource_definition) = { pattern: "projects/{project}/locations/{location}/appGateways/{app_gateway}" }; -// ## API Overview +// API Overview: // // The `beyondcorp.googleapis.com` service implements the Google Cloud // BeyondCorp API. // -// ## Data Model +// Data Model: // // The AppConnectionsService exposes the following resources: // diff --git a/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel b/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel index 56581a16b..f68b38aed 100644 --- a/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel +++ b/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel @@ -94,12 +94,14 @@ java_gapic_library( srcs = [":appconnectors_proto_with_info"], gapic_yaml = None, grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", test_deps = [ ":appconnectors_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":appconnectors_java_proto", "//google/api:api_java_proto", @@ -120,6 +122,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-beyondcorp-appconnectors-v1-java", include_samples = True, + transport = "grpc", deps = [ ":appconnectors_java_gapic", ":appconnectors_java_grpc", @@ -145,14 +148,15 @@ go_gapic_library( grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", importpath = "cloud.google.com/go/beyondcorp/appconnectors/apiv1;appconnectors", metadata = True, + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appconnectors_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -184,6 +188,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=beyondcorp_appconnectors", ], + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", transport = "grpc+rest", deps = [ @@ -224,7 +229,9 @@ php_gapic_library( name = "appconnectors_php_gapic", srcs = [":appconnectors_proto_with_info"], grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [ ":appconnectors_php_grpc", ":appconnectors_php_proto", @@ -248,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", package = "google.cloud.beyondcorp.appconnectors.v1", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -282,6 +291,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-beyond_corp", ], grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.", ruby_cloud_title = "BeyondCorp AppConnectors V1", service_yaml = "beyondcorp_v1.yaml", @@ -317,6 +327,7 @@ csharp_gapic_library( srcs = [":appconnectors_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appconnectors_csharp_grpc", diff --git a/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto b/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto index d7d6d74f4..54634f867 100644 --- a/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto +++ b/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto @@ -34,12 +34,12 @@ option java_package = "com.google.cloud.beyondcorp.appconnectors.v1"; option php_namespace = "Google\\Cloud\\BeyondCorp\\AppConnectors\\V1"; option ruby_package = "Google::Cloud::BeyondCorp::AppConnectors::V1"; -// ## API Overview +// API Overview: // // The `beyondcorp.googleapis.com` service implements the Google Cloud // BeyondCorp API. // -// ## Data Model +// Data Model: // // The AppConnectorsService exposes the following resource: // diff --git a/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel b/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel index 600915049..ecde6b52c 100644 --- a/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel +++ b/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel @@ -90,12 +90,14 @@ java_gapic_library( srcs = [":appgateways_proto_with_info"], gapic_yaml = None, grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", test_deps = [ ":appgateways_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":appgateways_java_proto", "//google/api:api_java_proto", @@ -116,6 +118,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-beyondcorp-appgateways-v1-java", include_samples = True, + transport = "grpc", deps = [ ":appgateways_java_gapic", ":appgateways_java_grpc", @@ -141,14 +144,15 @@ go_gapic_library( grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", importpath = "cloud.google.com/go/beyondcorp/appgateways/apiv1;appgateways", metadata = True, + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appgateways_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +183,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=beyondcorp_appgateways", ], + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", transport = "grpc+rest", deps = [ @@ -219,7 +224,9 @@ php_gapic_library( name = "appgateways_php_gapic", srcs = [":appgateways_proto_with_info"], grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [ ":appgateways_php_grpc", ":appgateways_php_proto", @@ -243,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", package = "google.cloud.beyondcorp.appgateways.v1", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,6 +286,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-beyond_corp", ], grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.", ruby_cloud_title = "BeyondCorp AppGateways V1", service_yaml = "beyondcorp_v1.yaml", @@ -312,6 +322,7 @@ csharp_gapic_library( srcs = [":appgateways_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":appgateways_csharp_grpc", diff --git a/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto b/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto index 605a9354e..fa21383bf 100644 --- a/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto +++ b/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto @@ -31,12 +31,12 @@ option java_package = "com.google.cloud.beyondcorp.appgateways.v1"; option php_namespace = "Google\\Cloud\\BeyondCorp\\AppGateways\\V1"; option ruby_package = "Google::Cloud::BeyondCorp::AppGateways::V1"; -// ## API Overview +// API Overview: // // The `beyondcorp.googleapis.com` service implements the Google Cloud // BeyondCorp API. // -// ## Data Model +// Data Model: // // The AppGatewaysService exposes the following resources: // diff --git a/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel b/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel index 96628bb52..1c4df624d 100644 --- a/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel +++ b/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel @@ -91,12 +91,14 @@ java_gapic_library( srcs = [":clientconnectorservices_proto_with_info"], gapic_yaml = None, grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", test_deps = [ ":clientconnectorservices_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":clientconnectorservices_java_proto", "//google/api:api_java_proto", @@ -116,6 +118,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-beyondcorp-clientconnectorservices-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":clientconnectorservices_java_gapic", ":clientconnectorservices_java_grpc", @@ -141,14 +145,15 @@ go_gapic_library( grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", importpath = "cloud.google.com/go/beyondcorp/clientconnectorservices/apiv1;clientconnectorservices", metadata = True, + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":clientconnectorservices_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +184,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=beyondcorp_clientconnectorservices", ], + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", transport = "grpc+rest", deps = [ @@ -219,7 +225,9 @@ php_gapic_library( name = "clientconnectorservices_php_gapic", srcs = [":clientconnectorservices_proto_with_info"], grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [ ":clientconnectorservices_php_grpc", ":clientconnectorservices_php_proto", @@ -243,7 +251,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", package = "google.cloud.beyondcorp.clientconnectorservices.v1", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,6 +287,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-beyond_corp", ], grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.", ruby_cloud_title = "BeyondCorp ClientConnectorServices V1", service_yaml = "beyondcorp_v1.yaml", @@ -312,6 +323,7 @@ csharp_gapic_library( srcs = [":clientconnectorservices_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":clientconnectorservices_csharp_grpc", diff --git a/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto b/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto index fdfb27cdd..87932f735 100644 --- a/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto +++ b/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto @@ -32,12 +32,12 @@ option java_package = "com.google.cloud.beyondcorp.clientconnectorservices.v1"; option php_namespace = "Google\\Cloud\\BeyondCorp\\ClientConnectorServices\\V1"; option ruby_package = "Google::Cloud::BeyondCorp::ClientConnectorServices::V1"; -// ## API Overview +// API Overview: // // The `beyondcorp.googleapis.com` service implements the Google Cloud // BeyondCorp API. // -// ## Data Model +// Data Model: // // The ClientConnectorServicesService exposes the following resources: // diff --git a/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel b/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel index 18d06ae31..7944f2669 100644 --- a/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel +++ b/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel @@ -90,12 +90,14 @@ java_gapic_library( srcs = [":clientgateways_proto_with_info"], gapic_yaml = None, grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", test_deps = [ ":clientgateways_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":clientgateways_java_proto", "//google/api:api_java_proto", @@ -116,6 +118,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-beyondcorp-clientgateways-v1-java", include_samples = True, + transport = "grpc", deps = [ ":clientgateways_java_gapic", ":clientgateways_java_grpc", @@ -141,14 +144,15 @@ go_gapic_library( grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", importpath = "cloud.google.com/go/beyondcorp/clientgateways/apiv1;clientgateways", metadata = True, + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":clientgateways_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +183,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=beyondcorp_clientgateways", ], + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", transport = "grpc", deps = [ @@ -219,7 +224,9 @@ php_gapic_library( name = "clientgateways_php_gapic", srcs = [":clientgateways_proto_with_info"], grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [ ":clientgateways_php_grpc", ":clientgateways_php_proto", @@ -243,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", package = "google.cloud.beyondcorp.clientgateways.v1", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,6 +286,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-beyond_corp", ], grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.", ruby_cloud_title = "BeyondCorp ClientGateways V1", service_yaml = "beyondcorp_v1.yaml", @@ -312,6 +322,7 @@ csharp_gapic_library( srcs = [":clientgateways_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "beyondcorp_v1.yaml", deps = [ ":clientgateways_csharp_grpc", diff --git a/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto b/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto index 089fc73dd..8ce25bb1e 100644 --- a/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto +++ b/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto @@ -31,12 +31,12 @@ option java_package = "com.google.cloud.beyondcorp.clientgateways.v1"; option php_namespace = "Google\\Cloud\\BeyondCorp\\ClientGateways\\V1"; option ruby_package = "Google::Cloud::BeyondCorp::ClientGateways::V1"; -// ## API Overview +// API Overview: // // The `beyondcorp.googleapis.com` service implements the Google Cloud // BeyondCorp API. // -// ## Data Model +// Data Model: // // The ClientGatewaysService exposes the following resources: // diff --git a/google/cloud/bigquery/analyticshub/BUILD.bazel b/google/cloud/bigquery/analyticshub/BUILD.bazel new file mode 100644 index 000000000..38a033374 --- /dev/null +++ b/google/cloud/bigquery/analyticshub/BUILD.bazel @@ -0,0 +1,39 @@ +# This build file includes a target for the Ruby wrapper library for +# google-cloud-bigquery-analytics_hub. + +# 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 analyticshub. +# 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 = "analyticshub_ruby_wrapper", + srcs = ["//google/cloud/bigquery/analyticshub/v1:analyticshub_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-bigquery-analytics_hub", + "ruby-cloud-wrapper-of=v1:0.0", + "ruby-cloud-product-url=https://cloud.google.com/bigquery", + "ruby-cloud-api-id=analyticshub.googleapis.com", + "ruby-cloud-api-shortname=analyticshub", + ], + ruby_cloud_description = "Analytics Hub is a data exchange platform that enables you to share data and insights at scale across organizational boundaries with a robust security and privacy framework. With Analytics Hub, you can discover and access a data library curated by various data providers.", + ruby_cloud_title = "Analytics Hub V1", +) + +# Open Source package. +ruby_gapic_assembly_pkg( + name = "google-cloud-bigquery-analyticshub-ruby", + deps = [ + ":analyticshub_ruby_wrapper", + ], +) diff --git a/google/cloud/bigquery/analyticshub/v1/BUILD.bazel b/google/cloud/bigquery/analyticshub/v1/BUILD.bazel index 62e8b1826..b734e7f4c 100644 --- a/google/cloud/bigquery/analyticshub/v1/BUILD.bazel +++ b/google/cloud/bigquery/analyticshub/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":analyticshub_proto_with_info"], gapic_yaml = None, grpc_service_config = "analyticshub_v1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", test_deps = [ ":analyticshub_java_grpc", @@ -135,9 +136,9 @@ go_gapic_library( grpc_service_config = "analyticshub_v1_grpc_service_config.json", importpath = "cloud.google.com/go/bigquery/analyticshub/apiv1;analyticshub", metadata = True, - rest_numeric_enums = True, + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":analyticshub_go_proto", "//google/iam/v1:iam_go_proto", @@ -176,6 +177,7 @@ py_gapic_library( name = "analyticshub_py_gapic", srcs = [":analyticshub_proto"], grpc_service_config = "analyticshub_v1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", transport = "grpc", deps = [ @@ -227,7 +229,9 @@ php_gapic_library( name = "analyticshub_php_gapic", srcs = [":analyticshub_proto_with_info"], grpc_service_config = "analyticshub_v1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", + transport = "grpc+rest", deps = [ ":analyticshub_php_grpc", ":analyticshub_php_proto", @@ -260,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "analyticshub_v1_grpc_service_config.json", package = "google.cloud.bigquery.analyticshub.v1", + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", + transport = "grpc", deps = [], ) @@ -298,9 +304,15 @@ ruby_cloud_gapic_library( name = "analyticshub_ruby_gapic", srcs = [":analyticshub_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-bigquery-analyticshub-v1", + "ruby-cloud-api-id=analyticshub.googleapis.com", + "ruby-cloud-api-shortname=analyticshub", + "ruby-cloud-gem-name=google-cloud-bigquery-analytics_hub-v1", + "ruby-cloud-product-url=https://cloud.google.com/bigquery/docs", ], grpc_service_config = "analyticshub_v1_grpc_service_config.json", + rest_numeric_enums = False, + ruby_cloud_description = "Analytics Hub is a data exchange platform that enables you to share data and insights at scale across organizational boundaries with a robust security and privacy framework. With Analytics Hub, you can discover and access a data library curated by various data providers.", + ruby_cloud_title = "Analytics Hub V1", service_yaml = "analyticshub_v1.yaml", deps = [ ":analyticshub_ruby_grpc", @@ -345,6 +357,7 @@ csharp_gapic_library( srcs = [":analyticshub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "analyticshub_v1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1.yaml", deps = [ ":analyticshub_csharp_grpc", diff --git a/google/cloud/bigquery/connection/v1/BUILD.bazel b/google/cloud/bigquery/connection/v1/BUILD.bazel index 0172b2d06..95bac03b2 100644 --- a/google/cloud/bigquery/connection/v1/BUILD.bazel +++ b/google/cloud/bigquery/connection/v1/BUILD.bazel @@ -63,6 +63,7 @@ java_gapic_library( srcs = [":connection_proto_with_info"], gapic_yaml = "connection_gapic.yaml", grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":connection_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -123,6 +124,7 @@ 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", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1.yaml", transport = "grpc+rest", deps = [ @@ -166,6 +168,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bigquery_connection", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -216,6 +219,8 @@ php_gapic_library( name = "connection_php_gapic", srcs = [":connection_proto_with_info"], grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":connection_php_grpc", ":connection_php_proto", @@ -249,7 +254,9 @@ nodejs_gapic_library( gapic_yaml = "connection_gapic.yaml", grpc_service_config = "bigqueryconnection_grpc_service_config.json", package = "google.cloud.bigquery.connection.v1", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -294,6 +301,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=bigqueryconnection", ], grpc_service_config = "bigqueryconnection_grpc_service_config.json", + 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", deps = [ @@ -339,6 +347,7 @@ csharp_gapic_library( srcs = [":connection_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1.yaml", deps = [ ":connection_csharp_grpc", diff --git a/google/cloud/bigquery/connection/v1beta1/BUILD.bazel b/google/cloud/bigquery/connection/v1beta1/BUILD.bazel index 223595fac..f3245a650 100644 --- a/google/cloud/bigquery/connection/v1beta1/BUILD.bazel +++ b/google/cloud/bigquery/connection/v1beta1/BUILD.bazel @@ -62,6 +62,7 @@ java_gapic_library( name = "connection_java_gapic", srcs = [":connection_proto_with_info"], grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":connection_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -122,6 +123,7 @@ 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", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -160,6 +162,7 @@ py_gapic_library( name = "connection_py_gapic", srcs = [":connection_proto"], grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -210,6 +213,8 @@ php_gapic_library( name = "connection_php_gapic", srcs = [":connection_proto_with_info"], grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":connection_php_grpc", ":connection_php_proto", @@ -241,7 +246,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigqueryconnection_grpc_service_config.json", package = "google.cloud.bigquery.connection.v1beta1", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -279,6 +286,7 @@ ruby_cloud_gapic_library( name = "connection_ruby_gapic", srcs = [":connection_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-connection-v1beta1"], + rest_numeric_enums = True, deps = [ ":connection_ruby_grpc", ":connection_ruby_proto", @@ -322,6 +330,7 @@ csharp_gapic_library( srcs = [":connection_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigqueryconnection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigqueryconnection_v1beta1.yaml", deps = [ ":connection_csharp_grpc", diff --git a/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel b/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel index 740422983..00c2b2724 100644 --- a/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel +++ b/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":dataexchange_proto_with_info"], gapic_yaml = None, grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", test_deps = [ ":dataexchange_java_grpc", @@ -138,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, + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -184,6 +186,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-bigquery-data-exchange", ], + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", transport = "grpc", deps = [ @@ -235,7 +238,9 @@ php_gapic_library( name = "dataexchange_php_gapic", srcs = [":dataexchange_proto_with_info"], grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":dataexchange_php_grpc", ":dataexchange_php_proto", @@ -268,7 +273,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json", package = "google.cloud.bigquery.dataexchange.v1beta1", + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/analytics-hub/", ], grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "Analytics Hub is a data exchange that allows you to efficiently and securely exchange data assets across organizations to address challenges of data reliability and cost. Curate a library of internal and external assets, including unique datasets like Google Trends, backed by the power of BigQuery.", ruby_cloud_title = "Analytics Hub V1beta1", service_yaml = "analyticshub_v1beta1.yaml", @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":dataexchange_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "analyticshub_v1beta1.yaml", deps = [ ":dataexchange_csharp_grpc", diff --git a/google/cloud/bigquery/datapolicies/v1/BUILD.bazel b/google/cloud/bigquery/datapolicies/v1/BUILD.bazel new file mode 100644 index 000000000..cae57e3ca --- /dev/null +++ b/google/cloud/bigquery/datapolicies/v1/BUILD.bazel @@ -0,0 +1,391 @@ +# 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 = "datapolicies_proto", + srcs = [ + "datapolicy.proto", + ], + deps = [ + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "//google/iam/v1:iam_policy_proto", + "//google/iam/v1:policy_proto", + "@com_google_protobuf//:empty_proto", + "@com_google_protobuf//:field_mask_proto", + ], +) + +proto_library_with_info( + name = "datapolicies_proto_with_info", + deps = [ + ":datapolicies_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 = "datapolicies_java_proto", + deps = [":datapolicies_proto"], +) + +java_grpc_library( + name = "datapolicies_java_grpc", + srcs = [":datapolicies_proto"], + deps = [":datapolicies_java_proto"], +) + +java_gapic_library( + name = "datapolicies_java_gapic", + srcs = [":datapolicies_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + test_deps = [ + ":datapolicies_java_grpc", + "//google/iam/v1:iam_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":datapolicies_java_proto", + "//google/api:api_java_proto", + "//google/iam/v1:iam_java_proto", + ], +) + +java_gapic_test( + name = "datapolicies_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClientHttpJsonTest", + "com.google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClientTest", + ], + runtime_deps = [":datapolicies_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-bigquery-datapolicies-v1-java", + transport = "grpc+rest", + deps = [ + ":datapolicies_java_gapic", + ":datapolicies_java_grpc", + ":datapolicies_java_proto", + ":datapolicies_proto", + ], + include_samples = True, +) + +############################################################################## +# Go +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", +) + +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", + protos = [":datapolicies_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/iam/v1:iam_go_proto", + ], +) + +go_gapic_library( + name = "datapolicies_go_gapic", + srcs = [":datapolicies_proto_with_info"], + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1;datapolicies", + metadata = True, + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + transport = "grpc+rest", + deps = [ + ":datapolicies_go_proto", + "//google/iam/v1:iam_go_proto", + ], +) + +go_test( + name = "datapolicies_go_gapic_test", + srcs = [":datapolicies_go_gapic_srcjar_test"], + embed = [":datapolicies_go_gapic"], + importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1", +) + +# Open Source Packages +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_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "datapolicies_py_gapic", + srcs = [":datapolicies_proto"], + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + transport = "grpc+rest", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], +) + +py_test( + name = "datapolicies_py_gapic_test", + srcs = [ + "datapolicies_py_gapic_pytest.py", + "datapolicies_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":datapolicies_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "bigquery-datapolicies-v1-py", + deps = [ + ":datapolicies_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 = "datapolicies_php_proto", + deps = [":datapolicies_proto"], +) + +php_grpc_library( + name = "datapolicies_php_grpc", + srcs = [":datapolicies_proto"], + deps = [":datapolicies_php_proto"], +) + +php_gapic_library( + name = "datapolicies_php_gapic", + srcs = [":datapolicies_proto_with_info"], + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + transport = "grpc+rest", + deps = [ + ":datapolicies_php_grpc", + ":datapolicies_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-bigquery-datapolicies-v1-php", + deps = [ + ":datapolicies_php_gapic", + ":datapolicies_php_grpc", + ":datapolicies_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "datapolicies_nodejs_gapic", + package_name = "@google-cloud/datapolicies", + src = ":datapolicies_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + package = "google.cloud.bigquery.datapolicies.v1", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "bigquery-datapolicies-v1-nodejs", + deps = [ + ":datapolicies_nodejs_gapic", + ":datapolicies_proto", + ], +) + +############################################################################## +# Ruby +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "ruby_gapic_assembly_pkg", + "ruby_cloud_gapic_library", + "ruby_grpc_library", + "ruby_proto_library", +) + +ruby_proto_library( + name = "datapolicies_ruby_proto", + deps = [":datapolicies_proto"], +) + +ruby_grpc_library( + name = "datapolicies_ruby_grpc", + srcs = [":datapolicies_proto"], + deps = [":datapolicies_ruby_proto"], +) + +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", + ], + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + deps = [ + ":datapolicies_ruby_grpc", + ":datapolicies_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-bigquery-datapolicies-v1-ruby", + deps = [ + ":datapolicies_ruby_gapic", + ":datapolicies_ruby_grpc", + ":datapolicies_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 = "datapolicies_csharp_proto", + deps = [":datapolicies_proto"], +) + +csharp_grpc_library( + name = "datapolicies_csharp_grpc", + srcs = [":datapolicies_proto"], + deps = [":datapolicies_csharp_proto"], +) + +csharp_gapic_library( + name = "datapolicies_csharp_gapic", + srcs = [":datapolicies_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "datapolicies_v1_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "bigquerydatapolicy_v1.yaml", + deps = [ + ":datapolicies_csharp_grpc", + ":datapolicies_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-bigquery-datapolicies-v1-csharp", + deps = [ + ":datapolicies_csharp_gapic", + ":datapolicies_csharp_grpc", + ":datapolicies_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "datapolicies_cc_proto", + deps = [":datapolicies_proto"], +) + +cc_grpc_library( + name = "datapolicies_cc_grpc", + srcs = [":datapolicies_proto"], + grpc_only = True, + deps = [":datapolicies_cc_proto"], +) diff --git a/google/cloud/bigquery/datapolicies/v1/bigquerydatapolicy_v1.yaml b/google/cloud/bigquery/datapolicies/v1/bigquerydatapolicy_v1.yaml new file mode 100644 index 000000000..00a2606b4 --- /dev/null +++ b/google/cloud/bigquery/datapolicies/v1/bigquerydatapolicy_v1.yaml @@ -0,0 +1,23 @@ +type: google.api.Service +config_version: 3 +name: bigquerydatapolicy.googleapis.com +title: BigQuery Data Policy API + +apis: +- name: google.cloud.bigquery.datapolicies.v1.DataPolicyService + +documentation: + summary: Allows users to manage BigQuery data policies. + +backend: + rules: + - selector: 'google.cloud.bigquery.datapolicies.v1.DataPolicyService.*' + deadline: 60.0 + +authentication: + rules: + - selector: 'google.cloud.bigquery.datapolicies.v1.DataPolicyService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/bigquery, + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/bigquery/datapolicies/v1/datapolicies_v1_grpc_service_config.json b/google/cloud/bigquery/datapolicies/v1/datapolicies_v1_grpc_service_config.json new file mode 100644 index 000000000..2be87d59e --- /dev/null +++ b/google/cloud/bigquery/datapolicies/v1/datapolicies_v1_grpc_service_config.json @@ -0,0 +1,50 @@ +{ + "methodConfig": [{ + "name": [ + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "CreateDataPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "UpdateDataPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "RenameDataPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "DeleteDataPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "GetDataPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "ListDataPolicies" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "GetIamPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "SetIamPolicy" + }, + { + "service": "google.cloud.bigquery.datapolicies.v1.DataPolicyService", + "method": "TestIamPermissions" + } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }] +} \ No newline at end of file diff --git a/google/cloud/bigquery/datapolicies/v1/datapolicy.proto b/google/cloud/bigquery/datapolicies/v1/datapolicy.proto new file mode 100644 index 000000000..cd79acfba --- /dev/null +++ b/google/cloud/bigquery/datapolicies/v1/datapolicy.proto @@ -0,0 +1,320 @@ +// 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.datapolicies.v1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/iam/v1/iam_policy.proto"; +import "google/iam/v1/policy.proto"; +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 java_multiple_files = true; +option java_outer_classname = "DataPolicyProto"; +option java_package = "com.google.cloud.bigquery.datapolicies.v1"; +option php_namespace = "Google\\Cloud\\BigQuery\\DataPolicies\\V1"; +option ruby_package = "Google::Cloud::Bigquery::DataPolicies::V1"; + +// Data Policy Service provides APIs for managing the label-policy bindings. +service DataPolicyService { + option (google.api.default_host) = "bigquerydatapolicy.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/bigquery," + "https://www.googleapis.com/auth/cloud-platform"; + + // Creates a new data policy under a project with the given `dataPolicyId` + // (used as the display name), policy tag, and data policy type. + rpc CreateDataPolicy(CreateDataPolicyRequest) returns (DataPolicy) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/dataPolicies" + body: "data_policy" + }; + option (google.api.method_signature) = "parent,data_policy"; + } + + // Updates the metadata for an existing data policy. The target data policy + // can be specified by the resource name. + rpc UpdateDataPolicy(UpdateDataPolicyRequest) returns (DataPolicy) { + option (google.api.http) = { + patch: "/v1/{data_policy.name=projects/*/locations/*/dataPolicies/*}" + body: "data_policy" + }; + option (google.api.method_signature) = "data_policy,update_mask"; + } + + // Renames the id (display name) of the specified data policy. + rpc RenameDataPolicy(RenameDataPolicyRequest) returns (DataPolicy) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/dataPolicies/*}:rename" + body: "*" + }; + option (google.api.method_signature) = "name,new_data_policy_id"; + } + + // Deletes the data policy specified by its resource name. + rpc DeleteDataPolicy(DeleteDataPolicyRequest) + returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/dataPolicies/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Gets the data policy specified by its resource name. + rpc GetDataPolicy(GetDataPolicyRequest) returns (DataPolicy) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/dataPolicies/*}" + }; + option (google.api.method_signature) = "name"; + } + + // List all of the data policies in the specified parent project. + rpc ListDataPolicies(ListDataPoliciesRequest) + returns (ListDataPoliciesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/dataPolicies" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the IAM policy for the specified data policy. + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) + returns (google.iam.v1.Policy) { + option (google.api.http) = { + post: "/v1/{resource=projects/*/locations/*/dataPolicies/*}:getIamPolicy" + body: "*" + }; + } + + // Sets the IAM policy for the specified data policy. + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) + returns (google.iam.v1.Policy) { + option (google.api.http) = { + post: "/v1/{resource=projects/*/locations/*/dataPolicies/*}:setIamPolicy" + body: "*" + }; + } + + // Returns the caller's permission on the specified data policy resource. + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) + returns (google.iam.v1.TestIamPermissionsResponse) { + option (google.api.http) = { + post: "/v1/{resource=projects/*/locations/*/dataPolicies/*}:testIamPermissions" + body: "*" + }; + } +} + +// Request message for the CreateDataPolicy method. +message CreateDataPolicyRequest { + // Required. Resource name of the project that the data policy will belong to. + // The format is `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "bigquerydatapolicy.googleapis.com/DataPolicy" + } + ]; + + // Required. The data policy to create. The `name` field does not need to be + // provided for the data policy creation. + DataPolicy data_policy = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for the UpdateDataPolicy method. +message UpdateDataPolicyRequest { + // Required. Update the data policy's metadata. + // + // The target data policy is determined by the `name` field. + // Other fields are updated to the specified values based on the field masks. + DataPolicy data_policy = 1 [(google.api.field_behavior) = REQUIRED]; + + // The update mask applies to the resource. 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. + // + // Updates to the `name` and `dataPolicyId` fields are not allowed. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for the RenameDataPolicy method. +message RenameDataPolicyRequest { + // Required. Resource name of the data policy to rename. The format is + // `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}` + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The new data policy id. + string new_data_policy_id = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for the DeleteDataPolicy method. +message DeleteDataPolicyRequest { + // Required. Resource name of the data policy to delete. Format is + // `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "bigquerydatapolicy.googleapis.com/DataPolicy" + } + ]; +} + +// Request message for the GetDataPolicy method. +message GetDataPolicyRequest { + // Required. Resource name of the requested data policy. Format is + // `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "bigquerydatapolicy.googleapis.com/DataPolicy" + } + ]; +} + +// Request message for the ListDataPolicies method. +message ListDataPoliciesRequest { + // Required. Resource name of the project for which to list data policies. + // Format is `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "bigquerydatapolicy.googleapis.com/DataPolicy" + } + ]; + + // The maximum number of data policies to return. Must be a value between 1 + // and 1000. + // If not set, defaults to 50. + int32 page_size = 2; + + // The `nextPageToken` value returned from a previous list request, if any. If + // not set, defaults to an empty string. + string page_token = 3; + + // Filters the data policies by policy tags that they + // are associated with. Currently filter only supports + // "policy_tag" based filtering and OR based predicates. Sample + // filter can be "policy_tag: + // `'projects/1/locations/us/taxonomies/2/policyTags/3'`". You may use + // wildcard such as "policy_tag: + // `'projects/1/locations/us/taxonomies/2/*'`". + string filter = 4; +} + +// Response message for the ListDataPolicies method. +message ListDataPoliciesResponse { + // Data policies that belong to the requested project. + repeated DataPolicy data_policies = 1; + + // Token used to retrieve the next page of results, or empty if there are no + // more results. + string next_page_token = 2; +} + +// Represents the label-policy binding. +message DataPolicy { + option (google.api.resource) = { + type: "bigquerydatapolicy.googleapis.com/DataPolicy" + pattern: "projects/{project}/locations/{location}/dataPolicies/{data_policy}" + }; + + // A list of supported data policy types. + enum DataPolicyType { + // Default value for the data policy type. This should not be used. + DATA_POLICY_TYPE_UNSPECIFIED = 0; + + // Used to create a data policy for column-level security, without data + // masking. + COLUMN_LEVEL_SECURITY_POLICY = 3; + + // Used to create a data policy for data masking. + DATA_MASKING_POLICY = 2; + } + + // Label that is bound to this data policy. + oneof matching_label { + // Policy tag resource name, in the format of + // `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. + string policy_tag = 4; + } + + // The policy that is bound to this data policy. + oneof policy { + // The data masking policy that specifies the data masking rule to use. + DataMaskingPolicy data_masking_policy = 5; + } + + // Output only. Resource name of this data policy, in the format of + // `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Type of data policy. + DataPolicyType data_policy_type = 2; + + // User-assigned (human readable) ID of the data policy that needs to be + // unique within a project. Used as {data_policy_id} in part of the resource + // name. + string data_policy_id = 3; +} + +// The data masking policy that is used to specify data masking rule. +message DataMaskingPolicy { + // The available masking rules. Learn more here: + // https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options. + enum PredefinedExpression { + // Default, unspecified predefined expression. No masking will take place + // since no expression is specified. + PREDEFINED_EXPRESSION_UNSPECIFIED = 0; + + // Masking expression to replace data with SHA-256 hash. + SHA256 = 3; + + // Masking expression to replace data with NULLs. + ALWAYS_NULL = 5; + + // Masking expression to replace data with their default masking values. + // The default masking values for each type listed as below: + // + // * STRING: "" + // * BYTES: b'' + // * INTEGER: 0 + // * FLOAT: 0.0 + // * NUMERIC: 0 + // * BOOLEAN: FALSE + // * TIMESTAMP: 0001-01-01 00:00:00 UTC + // * DATE: 0001-01-01 + // * TIME: 00:00:00 + // * DATETIME: 0001-01-01T00:00:00 + // * GEOGRAPHY: POINT(0 0) + // * BIGNUMERIC: 0 + // * ARRAY: [] + // * STRUCT: NOT_APPLICABLE + // * JSON: NULL + DEFAULT_MASKING_VALUE = 7; + } + + // A masking expression to bind to the data masking rule. + oneof masking_expression { + // A predefined masking expression. + PredefinedExpression predefined_expression = 1; + } +} diff --git a/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel b/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel index e3eb78cd3..b824fd34f 100644 --- a/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel +++ b/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":datapolicies_proto_with_info"], gapic_yaml = None, grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", test_deps = [ ":datapolicies_java_grpc", @@ -134,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, + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -174,6 +176,7 @@ py_gapic_library( name = "datapolicies_py_gapic", srcs = [":datapolicies_proto"], grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", transport = "grpc", deps = [ @@ -225,7 +228,9 @@ php_gapic_library( name = "datapolicies_php_gapic", srcs = [":datapolicies_proto_with_info"], grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":datapolicies_php_grpc", ":datapolicies_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", package = "google.cloud.bigquery.datapolicies.v1beta1", + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -302,9 +309,10 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/bigquery/docs", ], grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", - service_yaml = "bigquerydatapolicy_v1beta1.yaml", + rest_numeric_enums = False, ruby_cloud_description = "The Data Policy Service provides APIs for managing the BigQuery label-policy bindings.", ruby_cloud_title = "BigQuery Data Policy Service V1beta1", + service_yaml = "bigquerydatapolicy_v1beta1.yaml", deps = [ ":datapolicies_ruby_grpc", ":datapolicies_ruby_proto", @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":datapolicies_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerydatapolicy_v1beta1.yaml", deps = [ ":datapolicies_csharp_grpc", diff --git a/google/cloud/bigquery/datatransfer/v1/BUILD.bazel b/google/cloud/bigquery/datatransfer/v1/BUILD.bazel index a12b66925..fc86884a3 100644 --- a/google/cloud/bigquery/datatransfer/v1/BUILD.bazel +++ b/google/cloud/bigquery/datatransfer/v1/BUILD.bazel @@ -65,6 +65,7 @@ java_gapic_library( name = "datatransfer_java_gapic", srcs = [":datatransfer_proto_with_info"], grpc_service_config = "bigquerydatatransfer_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":datatransfer_java_grpc", ], @@ -123,6 +124,7 @@ 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", + rest_numeric_enums = True, service_yaml = "bigquerydatatransfer_v1.yaml", transport = "grpc+rest", deps = [ @@ -167,6 +169,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bigquery_datatransfer", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -213,6 +216,8 @@ php_gapic_library( name = "datatransfer_php_gapic", srcs = [":datatransfer_proto_with_info"], grpc_service_config = "bigquerydatatransfer_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":datatransfer_php_grpc", ":datatransfer_php_proto", @@ -245,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerydatatransfer_grpc_service_config.json", package = "google.cloud.bigquery.datatransfer.v1", + rest_numeric_enums = True, service_yaml = "bigquerydatatransfer_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -291,6 +298,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=bigquerydatatransfer", ], 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", deps = [ @@ -336,6 +344,7 @@ csharp_gapic_library( srcs = [":datatransfer_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquerydatatransfer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigquerydatatransfer_v1.yaml", deps = [ ":datatransfer_csharp_grpc", diff --git a/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml b/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml index 276f3cdf9..760757259 100644 --- a/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml +++ b/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml @@ -5,6 +5,7 @@ title: BigQuery Data Transfer API apis: - name: google.cloud.bigquery.datatransfer.v1.DataTransferService +- name: google.cloud.location.Locations documentation: summary: |- diff --git a/google/cloud/bigquery/datatransfer/v1/datatransfer.proto b/google/cloud/bigquery/datatransfer/v1/datatransfer.proto index 28dd2d8e3..63ea08720 100644 --- a/google/cloud/bigquery/datatransfer/v1/datatransfer.proto +++ b/google/cloud/bigquery/datatransfer/v1/datatransfer.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. @@ -217,10 +217,12 @@ service DataTransferService { // Enroll data sources in a user project. This allows users to create transfer // configurations for these data sources. They will also appear in the - // ListDataSources RPC and as such, will appear in the BigQuery UI - // 'https://bigquery.cloud.google.com' (and the documents can be found at - // https://cloud.google.com/bigquery/bigquery-web-ui and - // https://cloud.google.com/bigquery/docs/working-with-transfers). + // ListDataSources RPC and as such, will appear in the + // [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents + // can be found in the public guide for + // [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) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*}:enrollDataSources" @@ -287,7 +289,7 @@ message DataSourceParameter { // For integer and double values specifies minimum allowed value. google.protobuf.DoubleValue min_value = 9; - // For integer and double values specifies maxminum allowed value. + // For integer and double values specifies maximum allowed value. google.protobuf.DoubleValue max_value = 10; // Deprecated. This field has no effect. @@ -438,7 +440,7 @@ message GetDataSourceRequest { message ListDataSourcesRequest { // 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} + // `projects/{project_id}/locations/{location_id}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -470,9 +472,9 @@ message ListDataSourcesResponse { } // A request to create a data transfer configuration. If new credentials are -// needed for this transfer configuration, an authorization code must be -// provided. If an authorization code is provided, the transfer configuration -// will be associated with the user id corresponding to the authorization code. +// needed for this transfer configuration, authorization info must be provided. +// If authorization info is provided, the transfer configuration will be +// associated with the user id corresponding to the authorization info. // Otherwise, the transfer configuration will be associated with the calling // user. message CreateTransferConfigRequest { @@ -491,78 +493,99 @@ message CreateTransferConfigRequest { TransferConfig transfer_config = 2 [(google.api.field_behavior) = REQUIRED]; // Optional OAuth2 authorization code to use with this transfer configuration. - // This is required if new credentials are needed, as indicated by - // `CheckValidCreds`. - // In order to obtain authorization_code, please make a - // request to - // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + // This is required only if `transferConfig.dataSourceId` is 'youtube_channel' + // and new credentials are needed, as indicated by `CheckValidCreds`. In order + // to obtain authorization_code, make a request to the following URL: + // 
+  // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
+  //
+ // * The client_id is the OAuth client_id of the a data source as + // returned by ListDataSources method. + // * data_source_scopes are the scopes returned by ListDataSources + // method. // - // * client_id should be OAuth client_id of BigQuery DTS API for the given - // data source returned by ListDataSources method. - // * data_source_scopes are the scopes returned by ListDataSources method. - // * redirect_uri is an optional parameter. If not specified, then - // authorization code is posted to the opener of authorization flow window. - // Otherwise it will be sent to the redirect uri. A special value of - // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - // returned in the title bar of the browser, with the page text prompting - // the user to copy the code and paste it in the application. + // Note that this should not be set when `service_account_name` is used to + // create the transfer config. string authorization_code = 3; - // Optional version info. If users want to find a very recent access token, - // that is, immediately after approving access, users have to set the - // version_info claim in the token request. To obtain the version_info, users - // must use the "none+gsession" response type. which be return a - // version_info back in the authorization response which be be put in a JWT - // claim in the token request. + // Optional version info. This is required only if + // `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials + // are needed, as indicated by `CheckValidCreds`. In order to obtain version + // info, make a request to the following URL: + // 
+  // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
+  //
+ // * The client_id is the OAuth client_id of the a data source as + // returned by ListDataSources method. + // * data_source_scopes are the scopes returned by ListDataSources + // method. + // + // Note that this should not be set when `service_account_name` is used to + // create the transfer config. string version_info = 5; - // Optional service account name. If this field is set, transfer config will - // be created with this service account credentials. It requires that - // requesting user calling this API has permissions to act as this service + // Optional service account name. 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. + // + // Note that not all data sources support service account credentials when + // creating a transfer config. For the latest list of data sources, read about + // [using service + // accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts). string service_account_name = 6; } // A request to update a transfer configuration. To update the user id of the -// transfer configuration, an authorization code needs to be provided. +// transfer configuration, authorization info needs to be provided. message UpdateTransferConfigRequest { // Required. Data transfer configuration to create. TransferConfig transfer_config = 1 [(google.api.field_behavior) = REQUIRED]; // Optional OAuth2 authorization code to use with this transfer configuration. - // If it is provided, the transfer configuration will be associated with the - // authorizing user. - // In order to obtain authorization_code, please make a - // request to - // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + // This is required only if `transferConfig.dataSourceId` is 'youtube_channel' + // and new credentials are needed, as indicated by `CheckValidCreds`. In order + // to obtain authorization_code, make a request to the following URL: + // 
+  // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
+  //
+ // * The client_id is the OAuth client_id of the a data source as + // returned by ListDataSources method. + // * data_source_scopes are the scopes returned by ListDataSources + // method. // - // * client_id should be OAuth client_id of BigQuery DTS API for the given - // data source returned by ListDataSources method. - // * data_source_scopes are the scopes returned by ListDataSources method. - // * redirect_uri is an optional parameter. If not specified, then - // authorization code is posted to the opener of authorization flow window. - // Otherwise it will be sent to the redirect uri. A special value of - // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - // returned in the title bar of the browser, with the page text prompting - // the user to copy the code and paste it in the application. + // Note that this should not be set when `service_account_name` is used to + // update the transfer config. 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]; - // Optional version info. If users want to find a very recent access token, - // that is, immediately after approving access, users have to set the - // version_info claim in the token request. To obtain the version_info, users - // must use the "none+gsession" response type. which be return a - // version_info back in the authorization response which be be put in a JWT - // claim in the token request. + // Optional version info. This is required only if + // `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials + // are needed, as indicated by `CheckValidCreds`. In order to obtain version + // info, make a request to the following URL: + // 
+  // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
+  //
+ // * The client_id is the OAuth client_id of the a data source as + // returned by ListDataSources method. + // * data_source_scopes are the scopes returned by ListDataSources + // method. + // + // Note that this should not be set when `service_account_name` is used to + // update the transfer config. string version_info = 5; - // Optional service account name. If this field is set and - // "service_account_name" is set in update_mask, transfer config will be - // updated to use this service account credentials. It requires that - // requesting user calling this API has permissions to act as this service + // Optional service account name. 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. + // + // Note that not all data sources support service account credentials when + // creating a transfer config. For the latest list of data sources, read about + // [using service + // accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts). string service_account_name = 6; } @@ -621,7 +644,7 @@ message DeleteTransferRunRequest { // A request to list data transfers configured for a BigQuery project. message ListTransferConfigsRequest { - // Required. The BigQuery project id for which data sources + // Required. The BigQuery project id for which transfer configs // should be returned: `projects/{project_id}` or // `projects/{project_id}/locations/{location_id}` string parent = 1 [ @@ -844,8 +867,7 @@ message StartManualTransferRunsResponse { // A request to enroll a set of data sources so they are visible in the // BigQuery UI's `Transfer` tab. message EnrollDataSourcesRequest { - // The name of the project resource in the form: - // `projects/{project_id}` + // The name of the project resource in the form: `projects/{project_id}` string name = 1; // Data sources that are enrolled. It is required to provide at least one diff --git a/google/cloud/bigquery/datatransfer/v1/transfer.proto b/google/cloud/bigquery/datatransfer/v1/transfer.proto index 9092b4b9e..97d163069 100644 --- a/google/cloud/bigquery/datatransfer/v1/transfer.proto +++ b/google/cloud/bigquery/datatransfer/v1/transfer.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. @@ -133,7 +133,9 @@ message TransferConfig { // User specified display name for the data transfer. string display_name = 3; - // Data source id. Cannot be changed once data transfer is created. + // Data source ID. This cannot be changed once data transfer is created. The + // full list of available data source IDs can be returned through an API call: + // https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list string data_source_id = 5; // Parameters specific to each data source. For more information see the diff --git a/google/cloud/bigquery/logging/v1/BUILD.bazel b/google/cloud/bigquery/logging/v1/BUILD.bazel index c75f20eb5..eb4276219 100644 --- a/google/cloud/bigquery/logging/v1/BUILD.bazel +++ b/google/cloud/bigquery/logging/v1/BUILD.bazel @@ -78,6 +78,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bigquery_logging", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/bigquery/migration/v2/BUILD.bazel b/google/cloud/bigquery/migration/v2/BUILD.bazel index d21359ff7..642ee5ab1 100644 --- a/google/cloud/bigquery/migration/v2/BUILD.bazel +++ b/google/cloud/bigquery/migration/v2/BUILD.bazel @@ -77,6 +77,7 @@ java_gapic_library( srcs = [":migration_proto_with_info"], gapic_yaml = None, grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2.yaml", test_deps = [ ":migration_java_grpc", @@ -140,8 +141,9 @@ go_gapic_library( grpc_service_config = "bigquerymigration_grpc_service_config.json", importpath = "cloud.google.com/go/bigquery/migration/apiv2;migration", metadata = True, + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":migration_go_proto", "//google/api:metric_go_proto", @@ -184,6 +186,7 @@ py_gapic_library( "python-gapic-name=bigquery_migration", "python-gapic-namespace=google.cloud", ], + rest_numeric_enums = False, transport = "grpc", ) @@ -231,7 +234,9 @@ php_gapic_library( name = "migration_php_gapic", srcs = [":migration_proto_with_info"], grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2.yaml", + transport = "grpc+rest", deps = [ ":migration_php_grpc", ":migration_php_proto", @@ -264,7 +269,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerymigration_grpc_service_config.json", package = "google.cloud.bigquery.migration.v2", + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2.yaml", + transport = "grpc", deps = [], ) @@ -308,6 +315,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=bigquerymigration", ], grpc_service_config = "bigquerymigration_grpc_service_config.json", + 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", deps = [ @@ -353,6 +361,7 @@ csharp_gapic_library( srcs = [":migration_proto_with_info"], 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_v2.yaml", deps = [ ":migration_csharp_grpc", diff --git a/google/cloud/bigquery/migration/v2alpha/BUILD.bazel b/google/cloud/bigquery/migration/v2alpha/BUILD.bazel index 60a6477ba..16ac7ca69 100644 --- a/google/cloud/bigquery/migration/v2alpha/BUILD.bazel +++ b/google/cloud/bigquery/migration/v2alpha/BUILD.bazel @@ -78,6 +78,7 @@ java_gapic_library( name = "migration_java_gapic", srcs = [":migration_proto_with_info"], grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":migration_java_grpc", ], @@ -139,6 +140,7 @@ go_gapic_library( grpc_service_config = "bigquerymigration_grpc_service_config.json", importpath = "cloud.google.com/go/bigquery/migration/apiv2alpha;migration", metadata = True, + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2alpha.yaml", transport = "grpc+rest", deps = [ @@ -182,6 +184,7 @@ py_gapic_library( "python-gapic-name=bigquery_migration", "python-gapic-namespace=google.cloud", ], + rest_numeric_enums = False, transport = "grpc", ) @@ -229,7 +232,9 @@ php_gapic_library( name = "migration_php_gapic", srcs = [":migration_proto_with_info"], grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2alpha.yaml", + transport = "grpc+rest", deps = [ ":migration_php_grpc", ":migration_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerymigration_grpc_service_config.json", package = "google.cloud.bigquery.migration.v2alpha", + rest_numeric_enums = False, service_yaml = "bigquerymigration_v2alpha.yaml", + transport = "grpc", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-bigquery-migration-v2alpha", ], grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, deps = [ ":migration_ruby_grpc", ":migration_ruby_proto", @@ -346,6 +354,7 @@ csharp_gapic_library( srcs = [":migration_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquerymigration_grpc_service_config.json", + rest_numeric_enums = False, deps = [ ":migration_csharp_grpc", ":migration_csharp_proto", diff --git a/google/cloud/bigquery/reservation/v1/BUILD.bazel b/google/cloud/bigquery/reservation/v1/BUILD.bazel index 2de491ffd..bbf46efd9 100644 --- a/google/cloud/bigquery/reservation/v1/BUILD.bazel +++ b/google/cloud/bigquery/reservation/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":reservation_proto_with_info"], gapic_yaml = None, grpc_service_config = "bigqueryreservation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigqueryreservation_v1.yaml", test_deps = [ ":reservation_java_grpc", @@ -132,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, + rest_numeric_enums = True, service_yaml = "bigqueryreservation_v1.yaml", transport = "grpc+rest", deps = [ @@ -175,6 +177,7 @@ py_gapic_library( "python-gapic-name=bigquery_reservation", "python-gapic-namespace=google.cloud", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -222,7 +225,9 @@ php_gapic_library( name = "reservation_php_gapic", srcs = [":reservation_proto_with_info"], grpc_service_config = "bigqueryreservation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigqueryreservation_v1.yaml", + transport = "grpc+rest", deps = [ ":reservation_php_grpc", ":reservation_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigqueryreservation_grpc_service_config.json", package = "google.cloud.bigquery.reservation.v1", + rest_numeric_enums = True, service_yaml = "bigqueryreservation_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,6 +307,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/bigquery/docs/reference/reservations", ], grpc_service_config = "bigqueryreservation_grpc_service_config.json", + 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", deps = [ @@ -345,6 +353,7 @@ csharp_gapic_library( srcs = [":reservation_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigqueryreservation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "bigqueryreservation_v1.yaml", deps = [ ":reservation_csharp_grpc", diff --git a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_gapic.yaml b/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_gapic.yaml deleted file mode 100644 index 2117733a9..000000000 --- a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_gapic.yaml +++ /dev/null @@ -1,16 +0,0 @@ -type: com.google.api.codegen.ConfigProto -config_schema_version: 2.0.0 -# The settings of generated code in a specific language. -language_settings: - python: - package_name: google.cloud.bigquery_reservation_v1beta1.gapic - go: - package_name: cloud.google.com/go/bigquery/reservation/apiv1beta1 - csharp: - package_name: Google.Cloud.Bigquery.Reservation.V1beta1 - ruby: - package_name: Google::Cloud::Bigquery::Reservation::V1beta1 - php: - package_name: Google\Cloud\BigQuery\Reservation\V1beta1 - nodejs: - package_name: reservation.v1beta1 diff --git a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_grpc_service_config.json b/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_grpc_service_config.json deleted file mode 100755 index cafd5140a..000000000 --- a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_grpc_service_config.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "methodConfig": [ - { - "name": [ - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "CreateReservation" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "UpdateReservation" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "CreateCapacityCommitment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "UpdateCapacityCommitment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "SplitCapacityCommitment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "MergeCapacityCommitments" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "CreateAssignment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "MoveAssignment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "UpdateBiReservation" - } - ], - "timeout": "60s" - }, - { - "name": [ - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "ListReservations" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "GetReservation" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "DeleteReservation" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "ListCapacityCommitments" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "GetCapacityCommitment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "DeleteCapacityCommitment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "ListAssignments" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "DeleteAssignment" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "SearchAssignments" - }, - { - "service": "google.cloud.bigquery.reservation.v1beta1.ReservationService", - "method": "GetBiReservation" - } - ], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "0.100s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": [ - "DEADLINE_EXCEEDED", - "UNAVAILABLE" - ] - } - } - ] -} diff --git a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_v1beta1.yaml b/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_v1beta1.yaml deleted file mode 100644 index a09152d0e..000000000 --- a/google/cloud/bigquery/reservation/v1beta1/bigqueryreservation_v1beta1.yaml +++ /dev/null @@ -1,30 +0,0 @@ -type: google.api.Service -config_version: 3 -name: bigqueryreservation.googleapis.com -title: BigQuery Reservation API - -apis: -- name: google.cloud.bigquery.reservation.v1beta1.ReservationService - -documentation: - summary: 'A service to modify your BigQuery flat-rate reservations.' - -backend: - rules: - - selector: 'google.cloud.bigquery.reservation.v1beta1.ReservationService.*' - deadline: 30.0 - - selector: 'google.longrunning.Operations.*' - deadline: 30.0 - -authentication: - rules: - - selector: 'google.cloud.bigquery.reservation.v1beta1.ReservationService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/bigquery, - https://www.googleapis.com/auth/cloud-platform - - selector: 'google.longrunning.Operations.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/bigquery, - https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/bigquery/reservation/v1beta1/reservation.proto b/google/cloud/bigquery/reservation/v1beta1/reservation.proto deleted file mode 100644 index 73de4d542..000000000 --- a/google/cloud/bigquery/reservation/v1beta1/reservation.proto +++ /dev/null @@ -1,915 +0,0 @@ -// Copyright 2020 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.reservation.v1beta1; - -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"; -import "google/rpc/status.proto"; - -option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1beta1;reservation"; -option java_multiple_files = true; -option java_package = "com.google.cloud.bigquery.reservation.v1beta1"; -option php_namespace = "Google\\Cloud\\BigQuery\\Reservation\\V1beta1"; - -// Deprecated: Please use the v1 api instead. -// This API allows users to manage their flat-rate BigQuery reservations. -// -// A reservation provides computational resource guarantees, in the form of -// [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a -// unit of computational power in BigQuery, and serves as the basic unit of -// parallelism. In a scan of a multi-partitioned table, a single slot operates -// on a single partition of the table. A reservation resource exists as a child -// resource of the admin project and location, e.g.: -// `projects/myproject/locations/US/reservations/reservationName`. -// -// A capacity commitment is a way to purchase compute capacity for BigQuery jobs -// (in the form of slots) with some committed period of usage. A capacity -// commitment resource exists as a child resource of the admin project and -// location, e.g.: -// `projects/myproject/locations/US/capacityCommitments/id`. -service ReservationService { - option deprecated = true; - option (google.api.default_host) = "bigqueryreservation.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/bigquery," - "https://www.googleapis.com/auth/cloud-platform"; - - // Creates a new reservation resource. - rpc CreateReservation(CreateReservationRequest) returns (Reservation) { - option (google.api.http) = { - post: "/v1beta1/{parent=projects/*/locations/*}/reservations" - body: "reservation" - }; - option (google.api.method_signature) = "parent,reservation,reservation_id"; - } - - // Lists all the reservations for the project in the specified location. - rpc ListReservations(ListReservationsRequest) - returns (ListReservationsResponse) { - option (google.api.http) = { - get: "/v1beta1/{parent=projects/*/locations/*}/reservations" - }; - option (google.api.method_signature) = "parent"; - } - - // Returns information about the reservation. - rpc GetReservation(GetReservationRequest) returns (Reservation) { - option (google.api.http) = { - get: "/v1beta1/{name=projects/*/locations/*/reservations/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes a reservation. - // Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has - // assignments. - rpc DeleteReservation(DeleteReservationRequest) - returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta1/{name=projects/*/locations/*/reservations/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates an existing reservation resource. - rpc UpdateReservation(UpdateReservationRequest) returns (Reservation) { - option (google.api.http) = { - patch: "/v1beta1/{reservation.name=projects/*/locations/*/reservations/*}" - body: "reservation" - }; - option (google.api.method_signature) = "reservation,update_mask"; - } - - // Creates a new capacity commitment resource. - rpc CreateCapacityCommitment(CreateCapacityCommitmentRequest) - returns (CapacityCommitment) { - option (google.api.http) = { - post: "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments" - body: "capacity_commitment" - }; - option (google.api.method_signature) = "parent,capacity_commitment"; - } - - // Lists all the capacity commitments for the admin project. - rpc ListCapacityCommitments(ListCapacityCommitmentsRequest) - returns (ListCapacityCommitmentsResponse) { - option (google.api.http) = { - get: "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments" - }; - } - - // Returns information about the capacity commitment. - rpc GetCapacityCommitment(GetCapacityCommitmentRequest) - returns (CapacityCommitment) { - option (google.api.http) = { - get: "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes a capacity commitment. Attempting to delete capacity commitment - // before its commitment_end_time will fail with the error code - // `google.rpc.Code.FAILED_PRECONDITION`. - rpc DeleteCapacityCommitment(DeleteCapacityCommitmentRequest) - returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates an existing capacity commitment. - // - // Only `plan` and `renewal_plan` fields can be updated. - // - // Plan can only be changed to a plan of a longer commitment period. - // Attempting to change to a plan with shorter commitment period will fail - // with the error code `google.rpc.Code.FAILED_PRECONDITION`. - rpc UpdateCapacityCommitment(UpdateCapacityCommitmentRequest) - returns (CapacityCommitment) { - option (google.api.http) = { - patch: "/v1beta1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" - body: "capacity_commitment" - }; - option (google.api.method_signature) = "capacity_commitment,update_mask"; - } - - // Splits capacity commitment to two commitments of the same plan and - // `commitment_end_time`. - // - // A common use case is to enable downgrading commitments. - // - // For example, in order to downgrade from 10000 slots to 8000, you might - // split a 10000 capacity commitment into commitments of 2000 and 8000. Then, - // you would change the plan of the first one to `FLEX` and then delete it. - rpc SplitCapacityCommitment(SplitCapacityCommitmentRequest) - returns (SplitCapacityCommitmentResponse) { - option (google.api.http) = { - post: "/v1beta1/{name=projects/*/locations/*/capacityCommitments/*}:split" - body: "*" - }; - option (google.api.method_signature) = "name,slot_count"; - } - - // Merges capacity commitments of the same plan into a single commitment. - // - // The resulting capacity commitment has the greater commitment_end_time - // out of the to-be-merged capacity commitments. - // - // Attempting to merge capacity commitments of different plan will fail - // with the error code `google.rpc.Code.FAILED_PRECONDITION`. - rpc MergeCapacityCommitments(MergeCapacityCommitmentsRequest) - returns (CapacityCommitment) { - option (google.api.http) = { - post: "/v1beta1/{parent=projects/*/locations/*}/capacityCommitments:merge" - body: "*" - }; - option (google.api.method_signature) = "parent,capacity_commitment_ids"; - } - - // Creates an assignment object which allows the given project to submit jobs - // of a certain type using slots from the specified reservation. - // - // Currently a - // resource (project, folder, organization) can only have one assignment per - // each (job_type, location) combination, and that reservation will be used - // for all jobs of the matching type. - // - // Different assignments can be created on different levels of the - // projects, folders or organization hierarchy. During query execution, - // the assignment is looked up at the project, folder and organization levels - // in that order. The first assignment found is applied to the query. - // - // When creating assignments, it does not matter if other assignments exist at - // higher levels. - // - // Example: - // - // * The organization `organizationA` contains two projects, `project1` - // and `project2`. - // * Assignments for all three entities (`organizationA`, `project1`, and - // `project2`) could all be created and mapped to the same or different - // reservations. - // - // Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have - // 'bigquery.admin' permissions on the project using the reservation - // and the project that owns this reservation. - // - // Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment - // does not match location of the reservation. - rpc CreateAssignment(CreateAssignmentRequest) returns (Assignment) { - option (google.api.http) = { - post: "/v1beta1/{parent=projects/*/locations/*/reservations/*}/assignments" - body: "assignment" - }; - option (google.api.method_signature) = "parent,assignment"; - } - - // Lists assignments. - // - // Only explicitly created assignments will be returned. - // - // Example: - // - // * Organization `organizationA` contains two projects, `project1` and - // `project2`. - // * Reservation `res1` exists and was created previously. - // * CreateAssignment was used previously to define the following - // associations between entities and reservations: `` - // and `` - // - // In this example, ListAssignments will just return the above two assignments - // for reservation `res1`, and no expansion/merge will happen. - // - // The wildcard "-" can be used for - // reservations in the request. In that case all assignments belongs to the - // specified project and location will be listed. - // - // **Note** "-" cannot be used for projects nor locations. - rpc ListAssignments(ListAssignmentsRequest) - returns (ListAssignmentsResponse) { - option (google.api.http) = { - get: "/v1beta1/{parent=projects/*/locations/*/reservations/*}/assignments" - }; - option (google.api.method_signature) = "parent"; - } - - // Deletes a assignment. No expansion will happen. - // - // Example: - // - // * Organization `organizationA` contains two projects, `project1` and - // `project2`. - // * Reservation `res1` exists and was created previously. - // * CreateAssignment was used previously to define the following - // associations between entities and reservations: `` - // and `` - // - // In this example, deletion of the `` assignment won't - // affect the other assignment ``. After said deletion, - // queries from `project1` will still use `res1` while queries from - // `project2` will switch to use on-demand mode. - rpc DeleteAssignment(DeleteAssignmentRequest) - returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta1/{name=projects/*/locations/*/reservations/*/assignments/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Looks up assignments for a specified resource for a particular region. - // If the request is about a project: - // - // 1. Assignments created on the project will be returned if they exist. - // 2. Otherwise assignments created on the closest ancestor will be - // returned. - // 3. Assignments for different JobTypes will all be returned. - // - // The same logic applies if the request is about a folder. - // - // If the request is about an organization, then assignments created on the - // organization will be returned (organization doesn't have ancestors). - // - // Comparing to ListAssignments, there are some behavior - // differences: - // - // 1. permission on the assignee will be verified in this API. - // 2. Hierarchy lookup (project->folder->organization) happens in this API. - // 3. Parent here is `projects/*/locations/*`, instead of - // `projects/*/locations/*reservations/*`. - // - // **Note** "-" cannot be used for projects - // nor locations. - rpc SearchAssignments(SearchAssignmentsRequest) - returns (SearchAssignmentsResponse) { - option (google.api.http) = { - get: "/v1beta1/{parent=projects/*/locations/*}:searchAssignments" - }; - option (google.api.method_signature) = "parent,query"; - } - - // Moves an assignment under a new reservation. - // - // This differs from removing an existing assignment and recreating a new one - // by providing a transactional change that ensures an assignee always has an - // associated reservation. - rpc MoveAssignment(MoveAssignmentRequest) returns (Assignment) { - option (google.api.http) = { - post: "/v1beta1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" - body: "*" - }; - option (google.api.method_signature) = "name,destination_id"; - } - - // Retrieves a BI reservation. - rpc GetBiReservation(GetBiReservationRequest) returns (BiReservation) { - option (google.api.http) = { - get: "/v1beta1/{name=projects/*/locations/*/biReservation}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a BI reservation. - // - // Only fields specified in the `field_mask` are updated. - // - // A singleton BI reservation always exists with default size 0. - // In order to reserve BI capacity it needs to be updated to an amount - // greater than 0. In order to release BI capacity reservation size - // must be set to 0. - rpc UpdateBiReservation(UpdateBiReservationRequest) returns (BiReservation) { - option (google.api.http) = { - patch: "/v1beta1/{reservation.name=projects/*/locations/*/biReservation}" - body: "reservation" - }; - option (google.api.method_signature) = "reservation,update_mask"; - } -} - -// A reservation is a mechanism used to guarantee slots to users. -message Reservation { - option (google.api.resource) = { - type: "bigqueryreservation.googleapis.com/Reservation" - pattern: "projects/{project}/locations/{location}/reservations/{reservation}" - }; - - // The resource name of the reservation, e.g., - // `projects/*/locations/*/reservations/team1-prod`. - string name = 1; - - // Minimum slots available to this reservation. A slot is a unit of - // computational power in BigQuery, and serves as the unit of parallelism. - // - // Queries using this reservation might use more slots during runtime if - // ignore_idle_slots is set to false. - // - // If the new reservation's slot capacity exceed the parent's slot capacity or - // if total slot capacity of the new reservation and its siblings exceeds the - // parent's slot capacity, the request will fail with - // `google.rpc.Code.RESOURCE_EXHAUSTED`. - int64 slot_capacity = 2; - - // If false, any query using this reservation will use idle slots from other - // reservations within the same admin project. If true, a query using this - // reservation will execute with the slot capacity specified above at most. - bool ignore_idle_slots = 4; -} - -// Capacity commitment is a way to purchase compute capacity for BigQuery jobs -// (in the form of slots) with some committed period of usage. Annual -// commitments renew by default. Commitments can be removed after their -// commitment end time passes. -// -// In order to remove annual commitment, its plan needs to be changed -// to monthly or flex first. -// -// A capacity commitment resource exists as a child resource of the admin -// project. -message CapacityCommitment { - option (google.api.resource) = { - type: "bigqueryreservation.googleapis.com/CapacityCommitment" - pattern: "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}" - }; - - // Commitment plan defines the current committed period. Capacity commitment - // cannot be deleted during it's committed period. - enum CommitmentPlan { - // Invalid plan value. Requests with this value will be rejected with - // error code `google.rpc.Code.INVALID_ARGUMENT`. - COMMITMENT_PLAN_UNSPECIFIED = 0; - - // Flex commitments have committed period of 1 minute after becoming ACTIVE. - // After that, they are not in a committed period anymore and can be removed - // any time. - FLEX = 3; - - // Trial commitments have a committed period of 182 days after becoming - // ACTIVE. After that, they are converted to a new commitment based on the - // `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so - // that it can be deleted right after committed period ends. - TRIAL = 5; - - // Monthly commitments have a committed period of 30 days after becoming - // ACTIVE. After that, they are not in a committed period anymore and can be - // removed any time. - MONTHLY = 2; - - // Annual commitments have a committed period of 365 days after becoming - // ACTIVE. After that they are converted to a new commitment based on the - // renewal_plan. - ANNUAL = 4; - } - - // Capacity commitment can either become ACTIVE right away or transition - // from PENDING to ACTIVE or FAILED. - enum State { - // Invalid state value. - STATE_UNSPECIFIED = 0; - - // Capacity commitment is pending provisioning. Pending capacity commitment - // does not contribute to the parent's slot_capacity. - PENDING = 1; - - // Once slots are provisioned, capacity commitment becomes active. - // slot_count is added to the parent's slot_capacity. - ACTIVE = 2; - - // Capacity commitment is failed to be activated by the backend. - FAILED = 3; - } - - // Output only. The resource name of the capacity commitment, e.g., - // `projects/myproject/locations/US/capacityCommitments/123` - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Number of slots in this commitment. - int64 slot_count = 2; - - // Capacity commitment commitment plan. - CommitmentPlan plan = 3; - - // Output only. State of the commitment. - State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The end of the current commitment period. It is applicable - // only for ACTIVE capacity commitments. - google.protobuf.Timestamp commitment_end_time = 5 - [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. For FAILED commitment plan, provides the reason of failure. - google.rpc.Status failure_status = 7 - [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The plan this capacity commitment is converted to after commitment_end_time - // passes. Once the plan is changed, committed period is extended according to - // commitment plan. Only applicable for ANNUAL commitments. - CommitmentPlan renewal_plan = 8; -} - -// The request for -// [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateReservation]. -message CreateReservationRequest { - // Required. Project, location. E.g., - // `projects/myproject/locations/US` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/Reservation" - } - ]; - - // The reservation ID. This field must only contain lower case alphanumeric - // characters or dash. Max length is 64 characters. - string reservation_id = 2; - - // Content of the new reservation to create. - Reservation reservation = 3; -} - -// The request for -// [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListReservations]. -message ListReservationsRequest { - // Required. The parent resource name containing project and location, e.g.: - // `projects/myproject/locations/US` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/Reservation" - } - ]; - - // The maximum number of items to return. - int32 page_size = 2; - - // The next_page_token value returned from a previous List request, if any. - string page_token = 3; - - // Can be used to filter out reservations based on names, capacity, etc, e.g.: - // filter="reservation.slot_capacity > 200" - // filter="reservation.name = \"*dev/*\"" - // Advanced filtering syntax can be - // [here](https://cloud.google.com/logging/docs/view/advanced-filters). - string filter = 4; -} - -// The response for -// [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListReservations]. -message ListReservationsResponse { - // List of reservations visible to the user. - repeated Reservation reservations = 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; -} - -// The request for -// [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1beta1.ReservationService.GetReservation]. -message GetReservationRequest { - // Required. Resource name of the reservation to retrieve. E.g., - // `projects/myproject/locations/US/reservations/team1-prod` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/Reservation" - } - ]; -} - -// The request for -// [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteReservation]. -message DeleteReservationRequest { - // Required. Resource name of the reservation to retrieve. E.g., - // `projects/myproject/locations/US/reservations/team1-prod` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/Reservation" - } - ]; -} - -// The request for -// [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1beta1.ReservationService.UpdateReservation]. -message UpdateReservationRequest { - // Content of the reservation to update. - Reservation reservation = 1; - - // Standard field mask for the set of fields to be updated. - google.protobuf.FieldMask update_mask = 2; -} - -// The request for -// [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateCapacityCommitment]. -message CreateCapacityCommitmentRequest { - // Required. Resource name of the parent reservation. E.g., - // `projects/myproject/locations/US` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/CapacityCommitment" - } - ]; - - // Content of the capacity commitment to create. - CapacityCommitment capacity_commitment = 2; - - // If true, fail the request if another project in the organization has a - // capacity commitment. - bool enforce_single_admin_project_per_org = 4; -} - -// The request for -// [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListCapacityCommitments]. -message ListCapacityCommitmentsRequest { - // Required. Resource name of the parent reservation. E.g., - // `projects/myproject/locations/US` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/CapacityCommitment" - } - ]; - - // The maximum number of items to return. - int32 page_size = 2; - - // The next_page_token value returned from a previous List request, if any. - string page_token = 3; -} - -// The response for -// [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListCapacityCommitments]. -message ListCapacityCommitmentsResponse { - // List of capacity commitments visible to the user. - repeated CapacityCommitment capacity_commitments = 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; -} - -// The request for -// [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.GetCapacityCommitment]. -message GetCapacityCommitmentRequest { - // Required. Resource name of the capacity commitment to retrieve. E.g., - // `projects/myproject/locations/US/capacityCommitments/123` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/CapacityCommitment" - } - ]; -} - -// The request for -// [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteCapacityCommitment]. -message DeleteCapacityCommitmentRequest { - // Required. Resource name of the capacity commitment to delete. E.g., - // `projects/myproject/locations/US/capacityCommitments/123` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/CapacityCommitment" - } - ]; -} - -// The request for -// [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.UpdateCapacityCommitment]. -message UpdateCapacityCommitmentRequest { - // Content of the capacity commitment to update. - CapacityCommitment capacity_commitment = 1; - - // Standard field mask for the set of fields to be updated. - google.protobuf.FieldMask update_mask = 2; -} - -// The request for -// [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.SplitCapacityCommitment]. -message SplitCapacityCommitmentRequest { - // Required. The resource name e.g.,: - // `projects/myproject/locations/US/capacityCommitments/123` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/CapacityCommitment" - } - ]; - - // Number of slots in the capacity commitment after the split. - int64 slot_count = 2; -} - -// The response for -// [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.ReservationService.SplitCapacityCommitment]. -message SplitCapacityCommitmentResponse { - // First capacity commitment, result of a split. - CapacityCommitment first = 1; - - // Second capacity commitment, result of a split. - CapacityCommitment second = 2; -} - -// The request for -// [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1beta1.ReservationService.MergeCapacityCommitments]. -message MergeCapacityCommitmentsRequest { - // Parent resource that identifies admin project and location e.g., - // `projects/myproject/locations/us` - string parent = 1 [(google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/CapacityCommitment" - }]; - - // Ids of capacity commitments to merge. - // These capacity commitments must exist under admin project and location - // specified in the parent. - repeated string capacity_commitment_ids = 2; -} - -// A Assignment allows a project to submit jobs -// of a certain type using slots from the specified reservation. -message Assignment { - option (google.api.resource) = { - type: "bigqueryreservation.googleapis.com/Assignment" - pattern: "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}" - }; - - // Types of job, which could be specified when using the reservation. - enum JobType { - // Invalid type. Requests with this value will be rejected with - // error code `google.rpc.Code.INVALID_ARGUMENT`. - JOB_TYPE_UNSPECIFIED = 0; - - // Pipeline (load/export) jobs from the project will use the reservation. - PIPELINE = 1; - - // Query jobs from the project will use the reservation. - QUERY = 2; - } - - // Assignment will remain in PENDING state if no active capacity commitment is - // present. It will become ACTIVE when some capacity commitment becomes - // active. - enum State { - // Invalid state value. - STATE_UNSPECIFIED = 0; - - // Queries from assignee will be executed as on-demand, if related - // assignment is pending. - PENDING = 1; - - // Assignment is ready. - ACTIVE = 2; - } - - // Output only. Name of the resource. E.g.: - // `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The resource which will use the reservation. E.g. - // `projects/myproject`, `folders/123`, or `organizations/456`. - string assignee = 4; - - // Which type of jobs will use the reservation. - JobType job_type = 3; - - // Output only. State of the assignment. - State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// The request for -// [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1beta1.ReservationService.CreateAssignment]. -// Note: "bigquery.reservationAssignments.create" permission is required on the -// related assignee. -message CreateAssignmentRequest { - // Required. The parent resource name of the assignment - // E.g. `projects/myproject/locations/US/reservations/team1-prod` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/Assignment" - } - ]; - - // Assignment resource to create. - Assignment assignment = 2; -} - -// The request for -// [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListAssignments]. -message ListAssignmentsRequest { - // Required. The parent resource name e.g.: - // - // `projects/myproject/locations/US/reservations/team1-prod` - // - // Or: - // - // `projects/myproject/locations/US/reservations/-` - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/Assignment" - } - ]; - - // The maximum number of items to return. - int32 page_size = 2; - - // The next_page_token value returned from a previous List request, if any. - string page_token = 3; -} - -// The response for -// [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1beta1.ReservationService.ListAssignments]. -message ListAssignmentsResponse { - // List of assignments visible to the user. - repeated Assignment assignments = 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; -} - -// The request for -// [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1beta1.ReservationService.DeleteAssignment]. -// Note: "bigquery.reservationAssignments.delete" permission is required on the -// related assignee. -message DeleteAssignmentRequest { - // Required. Name of the resource, e.g. - // `projects/myproject/locations/US/reservations/team1-prod/assignments/123` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/Assignment" - } - ]; -} - -// The request for -// [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1beta1.ReservationService.SearchAssignments]. -// Note: "bigquery.reservationAssignments.search" permission is required on the -// related assignee. -message SearchAssignmentsRequest { - // Required. The resource name of the admin project(containing project and - // location), e.g.: - // `projects/myproject/locations/US`. - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" - } - ]; - - // Please specify resource name as assignee in the query. - // - // Examples: - // - // * `assignee=projects/myproject` - // * `assignee=folders/123` - // * `assignee=organizations/456` - string query = 2; - - // The maximum number of items to return. - int32 page_size = 3; - - // The next_page_token value returned from a previous List request, if any. - string page_token = 4; -} - -// The response for -// [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1beta1.ReservationService.SearchAssignments]. -message SearchAssignmentsResponse { - // List of assignments visible to the user. - repeated Assignment assignments = 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; -} - -// The request for -// [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1beta1.ReservationService.MoveAssignment]. -// -// **Note**: "bigquery.reservationAssignments.create" permission is required on -// the destination_id. -// -// **Note**: "bigquery.reservationAssignments.create" and -// "bigquery.reservationAssignments.delete" permission are required on the -// related assignee. -message MoveAssignmentRequest { - // Required. The resource name of the assignment, - // e.g. - // `projects/myproject/locations/US/reservations/team1-prod/assignments/123` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/Assignment" - } - ]; - - // The new reservation ID, e.g.: - // `projects/myotherproject/locations/US/reservations/team2-prod` - string destination_id = 3 [(google.api.resource_reference) = { - child_type: "bigqueryreservation.googleapis.com/Assignment" - }]; -} - -// Represents a BI Reservation. -message BiReservation { - option (google.api.resource) = { - type: "bigqueryreservation.googleapis.com/BiReservation" - pattern: "projects/{project}/locations/{location}/bireservation/{bireservation}" - }; - - // The resource name of the singleton BI reservation. - // Reservation names have the form - // `projects/{project_id}/locations/{location_id}/bireservation`. - string name = 1; - - // Output only. The last update timestamp of a reservation. - google.protobuf.Timestamp update_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Size of a reservation, in bytes. - int64 size = 4; -} - -// A request to get a singleton BI reservation. -message GetBiReservationRequest { - // Required. Name of the requested reservation, for example: - // `projects/{project_id}/locations/{location_id}/bireservation` - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigqueryreservation.googleapis.com/BiReservation" - } - ]; -} - -// A request to update a BI reservation. -message UpdateBiReservationRequest { - // A reservation to update. - BiReservation reservation = 1; - - // A list of fields to be updated in this request. - google.protobuf.FieldMask update_mask = 2; -} diff --git a/google/cloud/bigquery/storage/v1/BUILD.bazel b/google/cloud/bigquery/storage/v1/BUILD.bazel index 0aa0a2f96..0fb59e177 100644 --- a/google/cloud/bigquery/storage/v1/BUILD.bazel +++ b/google/cloud/bigquery/storage/v1/BUILD.bazel @@ -1,11 +1,41 @@ -# 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "storage_proto", @@ -39,18 +69,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "storage_java_proto", deps = [":storage_proto"], @@ -67,9 +85,11 @@ java_gapic_library( srcs = [":storage_proto_with_info"], gapic_yaml = "bigquerystorage_gapic.yaml", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":storage_java_grpc", ], + transport = "grpc", deps = [ ":storage_java_proto", ], @@ -86,6 +106,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-bigquery-storage-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":storage_java_gapic", ":storage_java_grpc", @@ -94,17 +116,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "storage_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -121,7 +132,9 @@ 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", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1.yaml", + transport = "grpc", deps = [ ":storage_go_proto", ], @@ -148,12 +161,6 @@ go_gapic_assembly_pkg( # Python ############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "storage_py_gapic", srcs = [":storage_proto"], @@ -162,6 +169,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bigquery_storage", ], + rest_numeric_enums = False, transport = "grpc", ) @@ -182,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_php_proto", deps = [":storage_proto"], @@ -208,6 +205,8 @@ php_gapic_library( name = "storage_php_gapic", srcs = [":storage_proto_with_info"], grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":storage_php_grpc", ":storage_php_proto", @@ -224,15 +223,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "storage_nodejs_gapic", package_name = "@google-cloud/bigquery-storage", @@ -240,7 +230,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerystorage_grpc_service_config.json", package = "google.cloud.bigquery.storage.v1", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1.yaml", + transport = "grpc", deps = [], ) @@ -256,14 +248,6 @@ nodejs_gapic_assembly_pkg( # 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 = "storage_ruby_proto", deps = [":storage_proto"], @@ -286,6 +270,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=bigquerystorage", ], grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "The BigQuery Storage API provides fast access to BigQuery managed storage.", ruby_cloud_title = "BigQuery Storage V1", deps = [ @@ -304,17 +289,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_csharp_proto", deps = [":storage_proto"], @@ -331,6 +305,7 @@ csharp_gapic_library( srcs = [":storage_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1.yaml", deps = [ ":storage_csharp_grpc", @@ -348,15 +323,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "storage_cc_proto", deps = [":storage_proto"], diff --git a/google/cloud/bigquery/storage/v1/storage.proto b/google/cloud/bigquery/storage/v1/storage.proto index a49e1a389..85daf6dfa 100644 --- a/google/cloud/bigquery/storage/v1/storage.proto +++ b/google/cloud/bigquery/storage/v1/storage.proto @@ -73,7 +73,8 @@ service BigQueryRead { post: "/v1/{read_session.table=projects/*/datasets/*/tables/*}" body: "*" }; - option (google.api.method_signature) = "parent,read_session,max_stream_count"; + option (google.api.method_signature) = + "parent,read_session,max_stream_count"; } // Reads rows from the stream in the format prescribed by the ReadSession. @@ -102,7 +103,8 @@ service BigQueryRead { // original, primary, and residual, that original[0-j] = primary[0-j] and // original[j-n] = residual[0-m] once the streams have been read to // completion. - rpc SplitReadStream(SplitReadStreamRequest) returns (SplitReadStreamResponse) { + rpc SplitReadStream(SplitReadStreamRequest) + returns (SplitReadStreamResponse) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/sessions/*/streams/*}" }; @@ -167,13 +169,6 @@ service BigQueryWrite { // * For PENDING streams, data is not made visible until the stream itself is // finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly // committed via the `BatchCommitWriteStreams` rpc. - // - // Note: For users coding against the gRPC api directly, it may be - // necessary to supply the x-goog-request-params system parameter - // with `write_stream=`. - // - // More information about system parameters: - // https://cloud.google.com/apis/docs/system-parameters rpc AppendRows(stream AppendRowsRequest) returns (stream AppendRowsResponse) { option (google.api.http) = { post: "/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}" @@ -193,7 +188,8 @@ service BigQueryWrite { // Finalize a write stream so that no new data can be appended to the // stream. Finalize is not supported on the '_default' stream. - rpc FinalizeWriteStream(FinalizeWriteStreamRequest) returns (FinalizeWriteStreamResponse) { + rpc FinalizeWriteStream(FinalizeWriteStreamRequest) + returns (FinalizeWriteStreamResponse) { option (google.api.http) = { post: "/v1/{name=projects/*/datasets/*/tables/*/streams/*}" body: "*" @@ -207,7 +203,8 @@ service BigQueryWrite { // Streams must be finalized before commit and cannot be committed multiple // times. Once a stream is committed, data in the stream becomes available // for read operations. - rpc BatchCommitWriteStreams(BatchCommitWriteStreamsRequest) returns (BatchCommitWriteStreamsResponse) { + rpc BatchCommitWriteStreams(BatchCommitWriteStreamsRequest) + returns (BatchCommitWriteStreamsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/datasets/*/tables/*}" }; @@ -391,9 +388,7 @@ message CreateWriteStreamRequest { // of `projects/{project}/datasets/{dataset}/tables/{table}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigquery.googleapis.com/Table" - } + (google.api.resource_reference) = { type: "bigquery.googleapis.com/Table" } ]; // Required. Stream to be created. @@ -424,10 +419,27 @@ message AppendRowsRequest { ProtoRows rows = 2; } - // Required. The write_stream identifies the target of the append operation, and only - // needs to be specified as part of the first request on the gRPC connection. - // If provided for subsequent requests, it must match the value of the first - // request. + // An enum to indicate how to interpret missing values. Missing values are + // fields present in user schema but missing in rows. A missing value can + // represent a NULL or a column default value defined in BigQuery table + // schema. + enum MissingValueInterpretation { + // Invalid missing value interpretation. Requests with this value will be + // rejected. + MISSING_VALUE_INTERPRETATION_UNSPECIFIED = 0; + + // Missing value is interpreted as NULL. + NULL_VALUE = 1; + + // Missing value is interpreted as column default value if declared in the + // table schema, NULL otherwise. + DEFAULT_VALUE = 2; + } + + // Required. The write_stream identifies the target of the append operation, + // and only needs to be specified as part of the first request on the gRPC + // connection. If provided for subsequent requests, it must match the value of + // the first request. // // For explicitly created write streams, the format is: // @@ -461,6 +473,26 @@ message AppendRowsRequest { // Id set by client to annotate its identity. Only initial request setting is // respected. string trace_id = 6; + + // A map to indicate how to interpret missing value for some fields. Missing + // values are fields present in user schema but missing in rows. The key is + // the field name. The value is the interpretation of missing values for the + // field. + // + // For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all + // missing values in field foo are interpreted as NULL, all missing values in + // field bar are interpreted as the default value of field bar in table + // schema. + // + // If a field is not in this map and has missing values, the missing values + // in this field are interpreted as NULL. + // + // This field only applies to the current request, it won't affect other + // requests on the connection. + // + // Currently, field name can only be top-level column name, can't be a struct + // field path like 'foo.bar'. + map missing_value_interpretations = 7; } // Response message for `AppendRows`. @@ -532,13 +564,11 @@ message GetWriteStreamRequest { // Request message for `BatchCommitWriteStreams`. message BatchCommitWriteStreamsRequest { - // Required. Parent table that all the streams should belong to, in the form of - // `projects/{project}/datasets/{dataset}/tables/{table}`. + // Required. Parent table that all the streams should belong to, in the form + // of `projects/{project}/datasets/{dataset}/tables/{table}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "bigquery.googleapis.com/Table" - } + (google.api.resource_reference) = { type: "bigquery.googleapis.com/Table" } ]; // Required. The group of streams that will be committed atomically. diff --git a/google/cloud/bigquery/storage/v1/stream.proto b/google/cloud/bigquery/storage/v1/stream.proto index fe71adfa6..ec137de19 100644 --- a/google/cloud/bigquery/storage/v1/stream.proto +++ b/google/cloud/bigquery/storage/v1/stream.proto @@ -122,10 +122,12 @@ message ReadSession { oneof output_format_serialization_options { // Optional. Options specific to the Apache Arrow output format. - ArrowSerializationOptions arrow_serialization_options = 3 [(google.api.field_behavior) = OPTIONAL]; + ArrowSerializationOptions arrow_serialization_options = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Options specific to the Apache Avro output format - AvroSerializationOptions avro_serialization_options = 4 [(google.api.field_behavior) = OPTIONAL]; + AvroSerializationOptions avro_serialization_options = 4 + [(google.api.field_behavior) = OPTIONAL]; } } @@ -133,12 +135,15 @@ message ReadSession { // `projects/{project_id}/locations/{location}/sessions/{session_id}`. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time at which the session becomes invalid. After this time, subsequent - // requests to read this Session will return errors. The expire_time is - // automatically assigned and currently cannot be specified or updated. - google.protobuf.Timestamp expire_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time at which the session becomes invalid. After this time, + // subsequent requests to read this Session will return errors. The + // expire_time is automatically assigned and currently cannot be specified or + // updated. + google.protobuf.Timestamp expire_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported. + // Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not + // supported. DataFormat data_format = 3 [(google.api.field_behavior) = IMMUTABLE]; // The schema for the read. If read_options.selected_fields is set, the @@ -156,12 +161,11 @@ message ReadSession { // `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}` string table = 6 [ (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "bigquery.googleapis.com/Table" - } + (google.api.resource_reference) = { type: "bigquery.googleapis.com/Table" } ]; - // Optional. Any modifiers which are applied when reading from the specified table. + // Optional. Any modifiers which are applied when reading from the specified + // table. TableModifiers table_modifiers = 7 [(google.api.field_behavior) = OPTIONAL]; // Optional. Read options for this session (e.g. column selection, filters). @@ -178,10 +182,16 @@ message ReadSession { // Output only. An estimate on the number of bytes this session will scan when // all streams are completely consumed. This estimate is based on // metadata from the table which might be incomplete or stale. - int64 estimated_total_bytes_scanned = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + int64 estimated_total_bytes_scanned = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. An estimate on the number of rows present in this session's + // streams. This estimate is based on metadata from the table which might be + // incomplete or stale. + int64 estimated_row_count = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. ID set by client to annotate a session identity. This does not need - // to be strictly unique, but instead the same ID should be used to group + // Optional. ID set by client to annotate a session identity. This does not + // need to be strictly unique, but instead the same ID should be used to group // logically connected sessions (e.g. All using the same ID for all sessions // needed to complete a Spark SQL query is reasonable). // @@ -260,15 +270,17 @@ message WriteStream { // Immutable. Type of the stream. Type type = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. Create time of the stream. For the _default stream, this is the - // creation_time of the table. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Create time of the stream. For the _default stream, this is + // the creation_time of the table. + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Commit time of the stream. // If a stream is of `COMMITTED` type, then it will have a commit_time same as // `create_time`. If the stream is of `PENDING` type, empty commit_time // means it is not committed. - google.protobuf.Timestamp commit_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp commit_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The schema of the destination table. It is only returned in // `CreateWriteStream` response. Caller should generate data that's diff --git a/google/cloud/bigquery/storage/v1/table.proto b/google/cloud/bigquery/storage/v1/table.proto index fa4f840c5..57e793342 100644 --- a/google/cloud/bigquery/storage/v1/table.proto +++ b/google/cloud/bigquery/storage/v1/table.proto @@ -107,7 +107,8 @@ message TableFieldSchema { // Optional. The field mode. The default value is NULLABLE. Mode mode = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Describes the nested schema fields if the type property is set to STRUCT. + // Optional. Describes the nested schema fields if the type property is set to + // STRUCT. repeated TableFieldSchema fields = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. The field description. The maximum length is 1,024 characters. diff --git a/google/cloud/bigquery/storage/v1beta1/BUILD.bazel b/google/cloud/bigquery/storage/v1beta1/BUILD.bazel index 2f4a9acc7..0f8bda372 100644 --- a/google/cloud/bigquery/storage/v1beta1/BUILD.bazel +++ b/google/cloud/bigquery/storage/v1beta1/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "storage_proto", @@ -36,18 +67,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "storage_java_proto", deps = [":storage_proto"], @@ -64,9 +83,11 @@ java_gapic_library( srcs = [":storage_proto_with_info"], gapic_yaml = "bigquerystorage_gapic.yaml", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":storage_java_grpc", ], + transport = "grpc", deps = [ ":storage_java_proto", ], @@ -83,7 +104,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-bigquery-storage-v1beta1-java", - transport = "grpc+rest", + include_samples = True, + transport = "grpc", deps = [ ":storage_java_gapic", ":storage_java_grpc", @@ -92,17 +114,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "storage_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -118,7 +129,9 @@ 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", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":storage_go_proto", ], @@ -141,20 +154,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "storage_py_gapic", srcs = [":storage_proto"], grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -175,17 +179,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_php_proto", deps = [":storage_proto"], @@ -201,6 +194,8 @@ php_gapic_library( name = "storage_php_gapic", srcs = [":storage_proto_with_info"], grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":storage_php_grpc", ":storage_php_proto", @@ -217,15 +212,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "storage_nodejs_gapic", package_name = "@google-cloud/bigquery-storage", @@ -233,7 +219,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerystorage_grpc_service_config.json", package = "google.cloud.bigquery.storage.v1beta1", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -245,17 +233,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_ruby_proto", deps = [":storage_proto"], @@ -271,6 +248,7 @@ ruby_cloud_gapic_library( name = "storage_ruby_gapic", srcs = [":storage_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-storage-v1beta1"], + rest_numeric_enums = False, deps = [ ":storage_ruby_grpc", ":storage_ruby_proto", @@ -287,17 +265,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_csharp_proto", deps = [":storage_proto"], @@ -314,6 +281,7 @@ csharp_gapic_library( srcs = [":storage_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta1.yaml", deps = [ ":storage_csharp_grpc", @@ -331,15 +299,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "storage_cc_proto", deps = [":storage_proto"], diff --git a/google/cloud/bigquery/storage/v1beta2/BUILD.bazel b/google/cloud/bigquery/storage/v1beta2/BUILD.bazel index 111f9531c..c6e3c8670 100644 --- a/google/cloud/bigquery/storage/v1beta2/BUILD.bazel +++ b/google/cloud/bigquery/storage/v1beta2/BUILD.bazel @@ -66,9 +66,11 @@ java_gapic_library( srcs = [":storage_proto_with_info"], gapic_yaml = "bigquerystorage_gapic.yaml", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":storage_java_grpc", ], + transport = "grpc", deps = [ ":storage_java_proto", ], @@ -86,6 +88,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-bigquery-storage-v1beta2-java", include_samples = True, + transport = "grpc", deps = [ ":storage_java_gapic", ":storage_java_grpc", @@ -121,7 +124,9 @@ 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", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta2.yaml", + transport = "grpc+rest", deps = [ ":storage_go_proto", ], @@ -162,6 +167,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=bigquery_storage", ], + rest_numeric_enums = False, transport = "grpc", ) @@ -208,6 +214,8 @@ php_gapic_library( name = "storage_php_gapic", srcs = [":storage_proto_with_info"], grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":storage_php_grpc", ":storage_php_proto", @@ -239,7 +247,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquerystorage_grpc_service_config.json", package = "google.cloud.bigquery.storage.v1beta2", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta2.yaml", + transport = "grpc", deps = [], ) @@ -319,6 +329,7 @@ csharp_gapic_library( srcs = [":storage_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquerystorage_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquerystorage_v1beta2.yaml", deps = [ ":storage_csharp_grpc", diff --git a/google/cloud/bigquery/v2/BUILD.bazel b/google/cloud/bigquery/v2/BUILD.bazel index bba90ceb0..be0062c5e 100644 --- a/google/cloud/bigquery/v2/BUILD.bazel +++ b/google/cloud/bigquery/v2/BUILD.bazel @@ -63,6 +63,7 @@ java_gapic_library( name = "bigquery_java_gapic", srcs = [":bigquery_proto_with_info"], grpc_service_config = "bigquery_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":bigquery_java_grpc", ], @@ -120,8 +121,9 @@ go_gapic_library( srcs = [":bigquery_proto_with_info"], grpc_service_config = "bigquery_grpc_service_config.json", importpath = "cloud.google.com/go/bigquery/apiv2;bigquery", + rest_numeric_enums = False, service_yaml = "bigquery_v2.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":bigquery_go_proto", ], @@ -158,6 +160,7 @@ py_gapic_library( srcs = [":bigquery_proto"], grpc_service_config = "bigquery_grpc_service_config.json", opt_args = ["autogen-snippets=False"], + rest_numeric_enums = False, transport = "grpc", ) @@ -238,7 +241,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "bigquery_grpc_service_config.json", package = "google.cloud.bigquery.v2", + rest_numeric_enums = False, service_yaml = "bigquery_v2.yaml", + transport = "grpc", deps = [], ) @@ -276,6 +281,7 @@ ruby_cloud_gapic_library( name = "bigquery_ruby_gapic", srcs = [":bigquery_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-v2"], + rest_numeric_enums = False, deps = [ ":bigquery_ruby_grpc", ":bigquery_ruby_proto", @@ -319,6 +325,7 @@ csharp_gapic_library( srcs = [":bigquery_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "bigquery_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "bigquery_v2.yaml", deps = [ ":bigquery_csharp_grpc", diff --git a/google/cloud/billing/budgets/v1/BUILD.bazel b/google/cloud/billing/budgets/v1/BUILD.bazel index 29a111c5f..a4de198f1 100644 --- a/google/cloud/billing/budgets/v1/BUILD.bazel +++ b/google/cloud/billing/budgets/v1/BUILD.bazel @@ -89,6 +89,7 @@ java_gapic_library( name = "budgets_java_gapic", srcs = [":budgets_proto_with_info"], grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":budgets_java_grpc", ], @@ -138,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, + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", transport = "grpc+rest", deps = [ @@ -167,6 +169,7 @@ py_gapic_library( name = "budgets_py_gapic", srcs = [":budgets_proto"], grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -203,7 +206,9 @@ php_gapic_library( name = "budgets_php_gapic", 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", ":budgets_php_proto", @@ -227,7 +232,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "billingbudgets_grpc_service_config.json", package = "google.cloud.billing.budgets.v1", + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", + transport = "grpc+rest", deps = [], ) @@ -261,6 +268,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/billing/docs/how-to/budget-api-overview", ], grpc_service_config = "billingbudgets_grpc_service_config.json", + 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", deps = [ @@ -295,6 +303,7 @@ csharp_gapic_library( srcs = [":budgets_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", deps = [ ":budgets_csharp_grpc", diff --git a/google/cloud/billing/budgets/v1beta1/BUILD.bazel b/google/cloud/billing/budgets/v1beta1/BUILD.bazel index dba748446..4c6cf343c 100644 --- a/google/cloud/billing/budgets/v1beta1/BUILD.bazel +++ b/google/cloud/billing/budgets/v1beta1/BUILD.bazel @@ -72,9 +72,11 @@ java_gapic_library( name = "budgets_java_gapic", srcs = [":budgets_proto_with_info"], grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":budgets_java_grpc", ], + transport = "grpc", deps = [ ":budgets_java_proto", ], @@ -92,6 +94,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-billing-budgets-v1beta1-java", include_samples = True, + transport = "grpc", deps = [ ":budgets_java_gapic", ":budgets_java_grpc", @@ -129,7 +132,9 @@ go_gapic_library( grpc_service_config = "billingbudgets_grpc_service_config.json", importpath = "cloud.google.com/go/billing/budgets/apiv1beta1;budgets", metadata = True, + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", + transport = "grpc+rest", deps = [ ":budgets_go_proto", ], @@ -167,6 +172,7 @@ py_gapic_library( name = "budgets_py_gapic", srcs = [":budgets_proto"], grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -214,6 +220,8 @@ php_gapic_library( name = "budgets_php_gapic", srcs = [":budgets_proto_with_info"], grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":budgets_php_grpc", ":budgets_php_proto", @@ -246,7 +254,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "billingbudgets_grpc_service_config.json", package = "google.cloud.billing.budgets.v1beta1", + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", + transport = "grpc", deps = [], ) @@ -291,6 +301,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/billing/docs/how-to/budget-api-overview", ], grpc_service_config = "billingbudgets_grpc_service_config.json", + 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", deps = [ @@ -336,6 +347,7 @@ csharp_gapic_library( srcs = [":budgets_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "billingbudgets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "billingbudgets.yaml", deps = [ ":budgets_csharp_grpc", diff --git a/google/cloud/billing/v1/BUILD.bazel b/google/cloud/billing/v1/BUILD.bazel index 027152bb5..436c3e520 100644 --- a/google/cloud/billing/v1/BUILD.bazel +++ b/google/cloud/billing/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"]) @@ -62,7 +71,10 @@ java_grpc_library( java_gapic_library( name = "billing_java_gapic", srcs = [":billing_proto_with_info"], + gapic_yaml = None, grpc_service_config = "cloud_billing_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", test_deps = [ ":billing_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -70,6 +82,7 @@ java_gapic_library( transport = "grpc+rest", deps = [ ":billing_java_proto", + "//google/api:api_java_proto", "//google/iam/v1:iam_java_proto", ], ) @@ -126,7 +139,9 @@ go_gapic_library( srcs = [":billing_proto_with_info"], grpc_service_config = "cloud_billing_grpc_service_config.json", importpath = "cloud.google.com/go/billing/apiv1;billing", - service_yaml = "cloudbilling.yaml", + metadata = True, + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", transport = "grpc+rest", deps = [ ":billing_go_proto", @@ -146,6 +161,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-billing-v1-go", deps = [ ":billing_go_gapic", + ":billing_go_gapic_srcjar-metadata.srcjar", ":billing_go_gapic_srcjar-test.srcjar", ":billing_go_proto", ], @@ -165,6 +181,8 @@ py_gapic_library( name = "billing_py_gapic", srcs = [":billing_proto"], grpc_service_config = "cloud_billing_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -215,6 +233,9 @@ php_gapic_library( name = "billing_php_gapic", srcs = [":billing_proto_with_info"], grpc_service_config = "cloud_billing_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", + transport = "grpc+rest", deps = [ ":billing_php_grpc", ":billing_php_proto", @@ -247,7 +268,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloud_billing_grpc_service_config.json", package = "google.cloud.billing.v1", - service_yaml = "cloudbilling.yaml", + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -285,15 +308,17 @@ ruby_cloud_gapic_library( name = "billing_ruby_gapic", srcs = [":billing_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-billing-v1", - "ruby-cloud-env-prefix=BILLING", - "ruby-cloud-product-url=https://cloud.google.com/billing", "ruby-cloud-api-id=cloudbilling.googleapis.com", "ruby-cloud-api-shortname=cloudbilling", + "ruby-cloud-env-prefix=BILLING", + "ruby-cloud-gem-name=google-cloud-billing-v1", + "ruby-cloud-product-url=https://cloud.google.com/billing", ], grpc_service_config = "cloud_billing_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", ruby_cloud_title = "Billing V1", + service_yaml = "cloudbilling_v1.yaml", deps = [ ":billing_ruby_grpc", ":billing_ruby_proto", @@ -337,7 +362,8 @@ csharp_gapic_library( srcs = [":billing_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloud_billing_grpc_service_config.json", - service_yaml = "cloudbilling.yaml", + rest_numeric_enums = True, + service_yaml = "cloudbilling_v1.yaml", deps = [ ":billing_csharp_grpc", ":billing_csharp_proto", diff --git a/google/cloud/billing/v1/cloud_billing.proto b/google/cloud/billing/v1/cloud_billing.proto index f0b19d14d..b98f0fd7c 100644 --- a/google/cloud/billing/v1/cloud_billing.proto +++ b/google/cloud/billing/v1/cloud_billing.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -30,10 +29,14 @@ option java_multiple_files = true; option java_outer_classname = "CloudBillingProto"; option java_package = "com.google.cloud.billing.v1"; -// Retrieves GCP Console billing accounts and associates them with projects. +// Retrieves the Google Cloud Console billing accounts and associates them with +// projects. service CloudBilling { option (google.api.default_host) = "cloudbilling.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-billing," + "https://www.googleapis.com/auth/cloud-billing.readonly," + "https://www.googleapis.com/auth/cloud-platform"; // Gets information about a billing account. The current authenticated user // must be a [viewer of the billing @@ -69,15 +72,20 @@ service CloudBilling { option (google.api.method_signature) = "name,account"; } - // Creates a billing account. - // This method can only be used to create - // [billing subaccounts](https://cloud.google.com/billing/docs/concepts) - // by GCP resellers. + // This method creates [billing + // subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). + // + // Google Cloud resellers should use the + // Channel Services APIs, + // [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) + // and + // [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). + // // When creating a subaccount, the current authenticated user must have the - // `billing.accounts.update` IAM permission on the master account, which is + // `billing.accounts.update` IAM permission on the parent account, which is // typically given to billing account // [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). - // This method will return an error if the master account has not been + // This method will return an error if the parent account has not been // provisioned as a reseller account. rpc CreateBillingAccount(CreateBillingAccountRequest) returns (BillingAccount) { option (google.api.http) = { @@ -99,9 +107,10 @@ service CloudBilling { } // Gets the billing information for a project. The current authenticated user - // must have [permission to view the - // project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo - // ). + // must have the `resourcemanager.projects.get` permission for the project, + // which can be granted by assigning the [Project + // Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) + // role. rpc GetProjectBillingInfo(GetProjectBillingInfoRequest) returns (ProjectBillingInfo) { option (google.api.http) = { get: "/v1/{name=projects/*}/billingInfo" @@ -118,7 +127,7 @@ service CloudBilling { // usage charges. // // *Note:* Incurred charges that have not yet been reported in the transaction - // history of the GCP Console might be billed to the new billing + // history of the Google Cloud Console might be billed to the new billing // account, even if the charge occurred before the new billing account was // assigned to the project. // @@ -184,16 +193,20 @@ service CloudBilling { } } -// A billing account in [GCP Console](https://console.cloud.google.com/). -// You can assign a billing account to one or more projects. +// A billing account in the +// [Google Cloud Console](https://console.cloud.google.com/). You can assign a +// billing account to one or more projects. message BillingAccount { - // The resource name of the billing account. The resource name has the form + // 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 [(google.api.resource_reference) = { - type: "cloudbilling.googleapis.com/BillingAccount" - }]; + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "cloudbilling.googleapis.com/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 @@ -201,20 +214,20 @@ message BillingAccount { bool open = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // The display name given to the billing account, such as `My Billing - // Account`. This name is displayed in the GCP Console. + // Account`. This name is displayed in the Google Cloud Console. string display_name = 3; // If this account is a // [subaccount](https://cloud.google.com/billing/docs/concepts), then this - // will be the resource name of the master billing account that it is being + // will be the resource name of the parent billing account that it is being // resold through. // Otherwise this will be empty. string master_billing_account = 4; } -// Encapsulation of billing information for a GCP Console project. A project -// has at most one associated billing account at a time (but a billing account -// can be assigned to multiple projects). +// Encapsulation of billing information for a Google Cloud Console project. A +// project has at most one associated billing account at a time (but a billing +// account can be assigned to multiple projects). message ProjectBillingInfo { // The resource name for the `ProjectBillingInfo`; has the form // `projects/{project_id}/billingInfo`. For example, the resource name for the @@ -285,7 +298,7 @@ message ListBillingAccountsResponse { message CreateBillingAccountRequest { // Required. The billing account resource to create. // Currently CreateBillingAccount only supports subaccount creation, so - // any created billing accounts must be under a provided master billing + // any created billing accounts must be under a provided parent billing // account. BillingAccount billing_account = 1 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/cloud/billing/v1/cloud_catalog.proto b/google/cloud/billing/v1/cloud_catalog.proto index 7bc2f14e3..f3d46e627 100644 --- a/google/cloud/billing/v1/cloud_catalog.proto +++ b/google/cloud/billing/v1/cloud_catalog.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -36,7 +35,10 @@ option objc_class_prefix = "CLDCTLG"; // and SKUs. service CloudCatalog { option (google.api.default_host) = "cloudbilling.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-billing," + "https://www.googleapis.com/auth/cloud-billing.readonly," + "https://www.googleapis.com/auth/cloud-platform"; // Lists all public cloud services. rpc ListServices(ListServicesRequest) returns (ListServicesResponse) { @@ -111,6 +113,9 @@ message Sku { // Identifies the service provider. // This is 'Google' for first party services in Google Cloud Platform. string service_provider_name = 7; + + // The geographic taxonomy for this sku. + GeoTaxonomy geo_taxonomy = 8; } // Represents the category hierarchy of a SKU. @@ -187,6 +192,21 @@ message PricingExpression { // Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte". string usage_unit = 1; + // The recommended quantity of units for displaying pricing info. When + // displaying pricing info it is recommended to display: + // (unit_price * display_quantity) per display_quantity usage_unit. + // This field does not affect the pricing formula and is for display purposes + // only. + // Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and + // the display_quantity is "1000" then the recommended way of displaying the + // pricing info is "0.10 USD per 1000 GB" + double display_quantity = 2; + + // The list of tiered rates for this pricing. The total cost is computed by + // applying each of the tiered rates on usage. This repeated list is sorted + // by ascending order of start_usage_amount. + repeated TierRate tiered_rates = 3; + // The unit of usage in human readable form. // Example: "gibi byte". string usage_unit_description = 4; @@ -205,21 +225,6 @@ message PricingExpression { // start_usage_amount * base_unit_conversion_factor = start_usage_amount in // base_unit. double base_unit_conversion_factor = 7; - - // The recommended quantity of units for displaying pricing info. When - // displaying pricing info it is recommended to display: - // (unit_price * display_quantity) per display_quantity usage_unit. - // This field does not affect the pricing formula and is for display purposes - // only. - // Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and - // the display_quantity is "1000" then the recommended way of displaying the - // pricing info is "0.10 USD per 1000 GB" - double display_quantity = 2; - - // The list of tiered rates for this pricing. The total cost is computed by - // applying each of the tiered rates on usage. This repeated list is sorted - // by ascending order of start_usage_amount. - repeated TierRate tiered_rates = 3; } // Represents the aggregation level and interval for pricing of a single SKU. @@ -256,6 +261,33 @@ message AggregationInfo { int32 aggregation_count = 3; } +// Encapsulates the geographic taxonomy data for a sku. +message GeoTaxonomy { + // The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL. + enum Type { + // The type is not specified. + TYPE_UNSPECIFIED = 0; + + // The sku is global in nature, e.g. a license sku. Global skus are + // available in all regions, and so have an empty region list. + GLOBAL = 1; + + // The sku is available in a specific region, e.g. "us-west2". + REGIONAL = 2; + + // The sku is associated with multiple regions, e.g. "us-west2" and + // "us-east1". + MULTI_REGIONAL = 3; + } + + // The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL. + Type type = 1; + + // The list of regions associated with a sku. Empty for Global skus, which are + // associated with all Google Cloud regions. + repeated string regions = 2; +} + // Request message for `ListServices`. message ListServicesRequest { // Requested page size. Defaults to 5000. diff --git a/google/cloud/billing/v1/cloudbilling.yaml b/google/cloud/billing/v1/cloudbilling.yaml deleted file mode 100644 index fb0e32e1b..000000000 --- a/google/cloud/billing/v1/cloudbilling.yaml +++ /dev/null @@ -1,28 +0,0 @@ -type: google.api.Service -config_version: 1 -name: cloudbilling.googleapis.com -title: Cloud Billing API - -apis: -- name: google.cloud.billing.v1.CloudBilling -- name: google.cloud.billing.v1.CloudCatalog - -documentation: - summary: |- - Allows developers to manage billing for their Google Cloud Platform - projects programmatically. - -authentication: - rules: - - selector: 'google.cloud.billing.v1.CloudBilling.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: google.cloud.billing.v1.CloudCatalog.ListServices - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform - - selector: google.cloud.billing.v1.CloudCatalog.ListSkus - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/billing/v1/cloudbilling_v1.yaml b/google/cloud/billing/v1/cloudbilling_v1.yaml new file mode 100644 index 000000000..3f4c56751 --- /dev/null +++ b/google/cloud/billing/v1/cloudbilling_v1.yaml @@ -0,0 +1,54 @@ +type: google.api.Service +config_version: 3 +name: cloudbilling.googleapis.com +title: Cloud Billing API + +apis: +- name: google.cloud.billing.v1.CloudBilling +- name: google.cloud.billing.v1.CloudCatalog + +documentation: + summary: |- + Allows developers to manage billing for their Google Cloud Platform + projects programmatically. + +authentication: + rules: + - selector: 'google.cloud.billing.v1.CloudBilling.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-billing.readonly, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudBilling.CreateBillingAccount + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudBilling.SetIamPolicy + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudBilling.UpdateBillingAccount + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudBilling.UpdateProjectBillingInfo + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudCatalog.ListServices + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-billing.readonly, + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.billing.v1.CloudCatalog.ListSkus + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-billing, + https://www.googleapis.com/auth/cloud-billing.readonly, + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/binaryauthorization/v1/BUILD.bazel b/google/cloud/binaryauthorization/v1/BUILD.bazel index f131c0649..1f1adfa29 100644 --- a/google/cloud/binaryauthorization/v1/BUILD.bazel +++ b/google/cloud/binaryauthorization/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":binaryauthorization_proto_with_info"], gapic_yaml = None, grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1.yaml", test_deps = [ ":binaryauthorization_java_grpc", @@ -137,6 +138,7 @@ go_gapic_library( grpc_service_config = "binaryauthorization_grpc_service_config.json", importpath = "cloud.google.com/go/binaryauthorization/apiv1;binaryauthorization", metadata = True, + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1.yaml", transport = "grpc+rest", deps = [ @@ -176,6 +178,10 @@ py_gapic_library( name = "binaryauthorization_py_gapic", srcs = [":binaryauthorization_proto"], grpc_service_config = "binaryauthorization_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-binary-authorization", + ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//grafeas/v1:grafeas_py_proto", @@ -226,7 +232,9 @@ php_gapic_library( name = "binaryauthorization_php_gapic", srcs = [":binaryauthorization_proto_with_info"], grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1.yaml", + transport = "grpc+rest", deps = [ ":binaryauthorization_php_grpc", ":binaryauthorization_php_proto", @@ -259,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "binaryauthorization_grpc_service_config.json", package = "google.cloud.binaryauthorization.v1", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -308,6 +318,7 @@ ruby_cloud_gapic_library( "ruby-cloud-yard-strict=false", ], grpc_service_config = "binaryauthorization_grpc_service_config.json", + 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", deps = [ @@ -353,6 +364,7 @@ csharp_gapic_library( srcs = [":binaryauthorization_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1.yaml", deps = [ ":binaryauthorization_csharp_grpc", diff --git a/google/cloud/binaryauthorization/v1beta1/BUILD.bazel b/google/cloud/binaryauthorization/v1beta1/BUILD.bazel index f48d4ed6b..f5ea9e154 100644 --- a/google/cloud/binaryauthorization/v1beta1/BUILD.bazel +++ b/google/cloud/binaryauthorization/v1beta1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( name = "binaryauthorization_java_gapic", srcs = [":binaryauthorization_proto_with_info"], grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":binaryauthorization_java_grpc", ], @@ -128,6 +129,7 @@ go_gapic_library( grpc_service_config = "binaryauthorization_grpc_service_config.json", importpath = "cloud.google.com/go/binaryauthorization/apiv1beta1;binaryauthorization", metadata = True, + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -167,6 +169,10 @@ py_gapic_library( name = "binaryauthorization_py_gapic", srcs = [":binaryauthorization_proto"], grpc_service_config = "binaryauthorization_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-binary-authorization", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -214,7 +220,9 @@ php_gapic_library( name = "binaryauthorization_php_gapic", srcs = [":binaryauthorization_proto_with_info"], grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":binaryauthorization_php_grpc", ":binaryauthorization_php_proto", @@ -247,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "binaryauthorization_grpc_service_config.json", package = "google.cloud.binaryauthorization.v1beta1", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +303,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=BinauthzManagementServiceV1Beta1=BinauthzManagementService;SystemPolicyV1Beta1=SystemPolicy", ], grpc_service_config = "binaryauthorization_grpc_service_config.json", + 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", deps = [ @@ -338,6 +349,7 @@ csharp_gapic_library( srcs = [":binaryauthorization_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "binaryauthorization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "binaryauthorization_v1beta1.yaml", deps = [ ":binaryauthorization_csharp_grpc", diff --git a/google/cloud/certificatemanager/v1/BUILD.bazel b/google/cloud/certificatemanager/v1/BUILD.bazel index 5a5bf8f49..d9e04a5f5 100644 --- a/google/cloud/certificatemanager/v1/BUILD.bazel +++ b/google/cloud/certificatemanager/v1/BUILD.bazel @@ -21,6 +21,7 @@ load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") proto_library( name = "certificatemanager_proto", srcs = [ + "certificate_issuance_config.proto", "certificate_manager.proto", ], deps = [ @@ -29,6 +30,7 @@ proto_library( "//google/api:field_behavior_proto", "//google/api:resource_proto", "//google/longrunning:operations_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], @@ -71,6 +73,7 @@ java_gapic_library( srcs = [":certificatemanager_proto_with_info"], gapic_yaml = None, grpc_service_config = "certificatemanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", test_deps = [ ":certificatemanager_java_grpc", @@ -134,14 +137,16 @@ go_gapic_library( grpc_service_config = "certificatemanager_grpc_service_config.json", importpath = "cloud.google.com/go/certificatemanager/apiv1;certificatemanager", metadata = True, + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", transport = "grpc+rest", deps = [ ":certificatemanager_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -182,8 +187,11 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-certificate-manager", ], + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -230,7 +238,9 @@ php_gapic_library( name = "certificatemanager_php_gapic", srcs = [":certificatemanager_proto_with_info"], grpc_service_config = "certificatemanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", + transport = "grpc+rest", deps = [ ":certificatemanager_php_grpc", ":certificatemanager_php_proto", @@ -263,7 +273,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "certificatemanager_grpc_service_config.json", package = "google.cloud.certificatemanager.v1", + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/certificate-manager", ], grpc_service_config = "certificatemanager_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Certificate Manager lets you acquire and manage Transport Layer Security (TLS) (SSL) certificates for use with classic external HTTP(S) load balancers in Google Cloud.", ruby_cloud_title = "Certificate Manager V1", service_yaml = "certificatemanager_v1.yaml", @@ -353,6 +366,7 @@ csharp_gapic_library( srcs = [":certificatemanager_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "certificatemanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "certificatemanager_v1.yaml", deps = [ ":certificatemanager_csharp_grpc", diff --git a/google/cloud/certificatemanager/v1/certificate_issuance_config.proto b/google/cloud/certificatemanager/v1/certificate_issuance_config.proto new file mode 100644 index 000000000..629cb5944 --- /dev/null +++ b/google/cloud/certificatemanager/v1/certificate_issuance_config.proto @@ -0,0 +1,200 @@ +// 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.certificatemanager.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +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 java_multiple_files = true; +option java_outer_classname = "CertificateIssuanceConfigProto"; +option java_package = "com.google.cloud.certificatemanager.v1"; +option php_namespace = "Google\\Cloud\\CertificateManager\\V1"; +option ruby_package = "Google::Cloud::CertificateManager::V1"; +option (google.api.resource_definition) = { + type: "privateca.googleapis.com/CaPool" + pattern: "projects/{project}/locations/{location}/caPools/{ca_pool}" +}; + +// Request for the `ListCertificateIssuanceConfigs` method. +message ListCertificateIssuanceConfigsRequest { + // Required. The project and location from which the certificate should be + // listed, specified in the format `projects/*/locations/*`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Maximum number of certificate configs to return per call. + int32 page_size = 2; + + // The value returned by the last `ListCertificateIssuanceConfigsResponse`. + // Indicates that this is a continuation of a prior + // `ListCertificateIssuanceConfigs` call, and that the system should return + // the next page of data. + string page_token = 3; + + // Filter expression to restrict the Certificates Configs returned. + string filter = 4; + + // A list of Certificate Config field names used to specify the order of the + // returned results. The default sorting order is ascending. To specify + // descending order for a field, add a suffix " desc". + string order_by = 5; +} + +// Response for the `ListCertificateIssuanceConfigs` method. +message ListCertificateIssuanceConfigsResponse { + // A list of certificate configs for the parent resource. + repeated CertificateIssuanceConfig certificate_issuance_configs = 1; + + // If there might be more results than those appearing in this response, then + // `next_page_token` is included. To get the next set of results, call this + // method again using the value of `next_page_token` as `page_token`. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request for the `GetCertificateIssuanceConfig` method. +message GetCertificateIssuanceConfigRequest { + // Required. A name of the certificate issuance config to describe. Must be in + // the format `projects/*/locations/*/certificateIssuanceConfigs/*`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "certificatemanager.googleapis.com/CertificateIssuanceConfig" + } + ]; +} + +// Request for the `CreateCertificateIssuanceConfig` method. +message CreateCertificateIssuanceConfigRequest { + // Required. The parent resource of the certificate issuance config. Must be + // in the format `projects/*/locations/*`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Required. A user-provided name of the certificate config. + string certificate_issuance_config_id = 2 + [(google.api.field_behavior) = REQUIRED]; + + // Required. A definition of the certificate issuance config to create. + CertificateIssuanceConfig certificate_issuance_config = 3 + [(google.api.field_behavior) = REQUIRED]; +} + +// Request for the `DeleteCertificateIssuanceConfig` method. +message DeleteCertificateIssuanceConfigRequest { + // Required. A name of the certificate issuance config to delete. Must be in + // the format `projects/*/locations/*/certificateIssuanceConfigs/*`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "certificatemanager.googleapis.com/CertificateIssuanceConfig" + } + ]; +} + +// CertificateIssuanceConfig specifies how to issue and manage a certificate. +message CertificateIssuanceConfig { + option (google.api.resource) = { + type: "certificatemanager.googleapis.com/CertificateIssuanceConfig" + pattern: "projects/{project}/locations/{location}/certificateIssuanceConfigs/{certificate_issuance_config}" + }; + + // The CA that issues the workload certificate. It includes CA address, type, + // authentication to CA service, etc. + message CertificateAuthorityConfig { + // Contains information required to contact CA service. + message CertificateAuthorityServiceConfig { + // Required. A CA pool resource used to issue a certificate. + // The CA pool string has a relative resource path following the form + // "projects/{project}/locations/{location}/caPools/{ca_pool}". + string ca_pool = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "privateca.googleapis.com/CaPool" + } + ]; + } + + oneof kind { + // Defines a CertificateAuthorityServiceConfig. + CertificateAuthorityServiceConfig certificate_authority_service_config = + 1; + } + } + + // The type of keypair to generate. + enum KeyAlgorithm { + // Unspecified key algorithm. + KEY_ALGORITHM_UNSPECIFIED = 0; + + // Specifies RSA with a 2048-bit modulus. + RSA_2048 = 1; + + // Specifies ECDSA with curve P256. + ECDSA_P256 = 4; + } + + // A user-defined name of the certificate issuance config. + // CertificateIssuanceConfig names must be unique globally and match pattern + // `projects/*/locations/*/certificateIssuanceConfigs/*`. + string name = 1; + + // Output only. The creation timestamp of a CertificateIssuanceConfig. + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The last update timestamp of a CertificateIssuanceConfig. + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Set of labels associated with a CertificateIssuanceConfig. + map labels = 4; + + // One or more paragraphs of text description of a CertificateIssuanceConfig. + string description = 5; + + // Required. The CA that issues the workload certificate. It includes the CA + // address, type, authentication to CA service, etc. + CertificateAuthorityConfig certificate_authority_config = 6 + [(google.api.field_behavior) = REQUIRED]; + + // Required. Workload certificate lifetime requested. + google.protobuf.Duration lifetime = 7 + [(google.api.field_behavior) = REQUIRED]; + + // Required. Specifies the percentage of elapsed time of the certificate + // lifetime to wait before renewing the certificate. Must be a number between + // 1-99, inclusive. + int32 rotation_window_percentage = 8 [(google.api.field_behavior) = REQUIRED]; + + // Required. The key algorithm to use when generating the private key. + KeyAlgorithm key_algorithm = 9 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/certificatemanager/v1/certificate_manager.proto b/google/cloud/certificatemanager/v1/certificate_manager.proto index 2b221da44..07b4c0859 100644 --- a/google/cloud/certificatemanager/v1/certificate_manager.proto +++ b/google/cloud/certificatemanager/v1/certificate_manager.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/certificatemanager/v1/certificate_issuance_config.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; @@ -60,10 +61,12 @@ option ruby_package = "Google::Cloud::CertificateManager::V1"; // Provides methods to manage Cloud Certificate Manager entities. service CertificateManager { option (google.api.default_host) = "certificatemanager.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"; // Lists Certificates in a given project and location. - rpc ListCertificates(ListCertificatesRequest) returns (ListCertificatesResponse) { + rpc ListCertificates(ListCertificatesRequest) + returns (ListCertificatesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/certificates" }; @@ -79,7 +82,8 @@ service CertificateManager { } // Creates a new Certificate in a given project and location. - rpc CreateCertificate(CreateCertificateRequest) returns (google.longrunning.Operation) { + rpc CreateCertificate(CreateCertificateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/certificates" body: "certificate" @@ -92,7 +96,8 @@ service CertificateManager { } // Updates a Certificate. - rpc UpdateCertificate(UpdateCertificateRequest) returns (google.longrunning.Operation) { + rpc UpdateCertificate(UpdateCertificateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{certificate.name=projects/*/locations/*/certificates/*}" body: "certificate" @@ -105,7 +110,8 @@ service CertificateManager { } // Deletes a single Certificate. - rpc DeleteCertificate(DeleteCertificateRequest) returns (google.longrunning.Operation) { + rpc DeleteCertificate(DeleteCertificateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/certificates/*}" }; @@ -117,7 +123,8 @@ service CertificateManager { } // Lists CertificateMaps in a given project and location. - rpc ListCertificateMaps(ListCertificateMapsRequest) returns (ListCertificateMapsResponse) { + rpc ListCertificateMaps(ListCertificateMapsRequest) + returns (ListCertificateMapsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/certificateMaps" }; @@ -133,12 +140,14 @@ service CertificateManager { } // Creates a new CertificateMap in a given project and location. - rpc CreateCertificateMap(CreateCertificateMapRequest) returns (google.longrunning.Operation) { + rpc CreateCertificateMap(CreateCertificateMapRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/certificateMaps" body: "certificate_map" }; - option (google.api.method_signature) = "parent,certificate_map,certificate_map_id"; + option (google.api.method_signature) = + "parent,certificate_map,certificate_map_id"; option (google.longrunning.operation_info) = { response_type: "CertificateMap" metadata_type: "OperationMetadata" @@ -146,7 +155,8 @@ service CertificateManager { } // Updates a CertificateMap. - rpc UpdateCertificateMap(UpdateCertificateMapRequest) returns (google.longrunning.Operation) { + rpc UpdateCertificateMap(UpdateCertificateMapRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{certificate_map.name=projects/*/locations/*/certificateMaps/*}" body: "certificate_map" @@ -161,7 +171,8 @@ service CertificateManager { // Deletes a single CertificateMap. A Certificate Map can't be deleted // if it contains Certificate Map Entries. Remove all the entries from // the map before calling this method. - rpc DeleteCertificateMap(DeleteCertificateMapRequest) returns (google.longrunning.Operation) { + rpc DeleteCertificateMap(DeleteCertificateMapRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/certificateMaps/*}" }; @@ -173,7 +184,8 @@ service CertificateManager { } // Lists CertificateMapEntries in a given project and location. - rpc ListCertificateMapEntries(ListCertificateMapEntriesRequest) returns (ListCertificateMapEntriesResponse) { + rpc ListCertificateMapEntries(ListCertificateMapEntriesRequest) + returns (ListCertificateMapEntriesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/certificateMaps/*}/certificateMapEntries" }; @@ -181,7 +193,8 @@ service CertificateManager { } // Gets details of a single CertificateMapEntry. - rpc GetCertificateMapEntry(GetCertificateMapEntryRequest) returns (CertificateMapEntry) { + rpc GetCertificateMapEntry(GetCertificateMapEntryRequest) + returns (CertificateMapEntry) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}" }; @@ -189,12 +202,14 @@ service CertificateManager { } // Creates a new CertificateMapEntry in a given project and location. - rpc CreateCertificateMapEntry(CreateCertificateMapEntryRequest) returns (google.longrunning.Operation) { + rpc CreateCertificateMapEntry(CreateCertificateMapEntryRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/certificateMaps/*}/certificateMapEntries" body: "certificate_map_entry" }; - option (google.api.method_signature) = "parent,certificate_map_entry,certificate_map_entry_id"; + option (google.api.method_signature) = + "parent,certificate_map_entry,certificate_map_entry_id"; option (google.longrunning.operation_info) = { response_type: "CertificateMapEntry" metadata_type: "OperationMetadata" @@ -202,7 +217,8 @@ service CertificateManager { } // Updates a CertificateMapEntry. - rpc UpdateCertificateMapEntry(UpdateCertificateMapEntryRequest) returns (google.longrunning.Operation) { + rpc UpdateCertificateMapEntry(UpdateCertificateMapEntryRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{certificate_map_entry.name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}" body: "certificate_map_entry" @@ -215,7 +231,8 @@ service CertificateManager { } // Deletes a single CertificateMapEntry. - rpc DeleteCertificateMapEntry(DeleteCertificateMapEntryRequest) returns (google.longrunning.Operation) { + rpc DeleteCertificateMapEntry(DeleteCertificateMapEntryRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}" }; @@ -227,7 +244,8 @@ service CertificateManager { } // Lists DnsAuthorizations in a given project and location. - rpc ListDnsAuthorizations(ListDnsAuthorizationsRequest) returns (ListDnsAuthorizationsResponse) { + rpc ListDnsAuthorizations(ListDnsAuthorizationsRequest) + returns (ListDnsAuthorizationsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/dnsAuthorizations" }; @@ -235,7 +253,8 @@ service CertificateManager { } // Gets details of a single DnsAuthorization. - rpc GetDnsAuthorization(GetDnsAuthorizationRequest) returns (DnsAuthorization) { + rpc GetDnsAuthorization(GetDnsAuthorizationRequest) + returns (DnsAuthorization) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/dnsAuthorizations/*}" }; @@ -243,12 +262,14 @@ service CertificateManager { } // Creates a new DnsAuthorization in a given project and location. - rpc CreateDnsAuthorization(CreateDnsAuthorizationRequest) returns (google.longrunning.Operation) { + rpc CreateDnsAuthorization(CreateDnsAuthorizationRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/dnsAuthorizations" body: "dns_authorization" }; - option (google.api.method_signature) = "parent,dns_authorization,dns_authorization_id"; + option (google.api.method_signature) = + "parent,dns_authorization,dns_authorization_id"; option (google.longrunning.operation_info) = { response_type: "DnsAuthorization" metadata_type: "OperationMetadata" @@ -256,7 +277,8 @@ service CertificateManager { } // Updates a DnsAuthorization. - rpc UpdateDnsAuthorization(UpdateDnsAuthorizationRequest) returns (google.longrunning.Operation) { + rpc UpdateDnsAuthorization(UpdateDnsAuthorizationRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{dns_authorization.name=projects/*/locations/*/dnsAuthorizations/*}" body: "dns_authorization" @@ -269,7 +291,8 @@ service CertificateManager { } // Deletes a single DnsAuthorization. - rpc DeleteDnsAuthorization(DeleteDnsAuthorizationRequest) returns (google.longrunning.Operation) { + rpc DeleteDnsAuthorization(DeleteDnsAuthorizationRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/dnsAuthorizations/*}" }; @@ -279,12 +302,58 @@ service CertificateManager { metadata_type: "OperationMetadata" }; } + + // Lists CertificateIssuanceConfigs in a given project and location. + rpc ListCertificateIssuanceConfigs(ListCertificateIssuanceConfigsRequest) + returns (ListCertificateIssuanceConfigsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single CertificateIssuanceConfig. + rpc GetCertificateIssuanceConfig(GetCertificateIssuanceConfigRequest) + returns (CertificateIssuanceConfig) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new CertificateIssuanceConfig in a given project and location. + rpc CreateCertificateIssuanceConfig(CreateCertificateIssuanceConfigRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs" + body: "certificate_issuance_config" + }; + option (google.api.method_signature) = + "parent,certificate_issuance_config,certificate_issuance_config_id"; + option (google.longrunning.operation_info) = { + response_type: "CertificateIssuanceConfig" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single CertificateIssuanceConfig. + rpc DeleteCertificateIssuanceConfig(DeleteCertificateIssuanceConfigRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } } // Request for the `ListCertificates` method. message ListCertificatesRequest { - // Required. The project and location from which the certificate should be listed, - // specified in the format `projects/*/locations/*`. + // Required. The project and location from which the certificate should be + // listed, specified in the format `projects/*/locations/*`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -358,10 +427,11 @@ message UpdateCertificateRequest { // Required. A definition of the certificate to update. Certificate certificate = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. For the `FieldMask` definition, - // see + // Required. The update mask applies to the resource. For the `FieldMask` + // definition, see // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `DeleteCertificate` method. @@ -378,8 +448,8 @@ message DeleteCertificateRequest { // Request for the `ListCertificateMaps` method. message ListCertificateMapsRequest { - // Required. The project and location from which the certificate maps should be listed, - // specified in the format `projects/*/locations/*`. + // Required. The project and location from which the certificate maps should + // be listed, specified in the format `projects/*/locations/*`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -453,10 +523,11 @@ message UpdateCertificateMapRequest { // Required. A definition of the certificate map to update. CertificateMap certificate_map = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. For the `FieldMask` definition, - // see + // Required. The update mask applies to the resource. For the `FieldMask` + // definition, see // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `DeleteCertificateMap` method. @@ -473,8 +544,8 @@ message DeleteCertificateMapRequest { // Request for the `ListCertificateMapEntries` method. message ListCertificateMapEntriesRequest { - // Required. The project, location and certificate map from which the certificate map - // entries should be listed, specified in the format + // Required. The project, location and certificate map from which the + // certificate map entries should be listed, specified in the format // `projects/*/locations/*/certificateMaps/*`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -545,24 +616,27 @@ message CreateCertificateMapEntryRequest { string certificate_map_entry_id = 2 [(google.api.field_behavior) = REQUIRED]; // Required. A definition of the certificate map entry to create. - CertificateMapEntry certificate_map_entry = 3 [(google.api.field_behavior) = REQUIRED]; + CertificateMapEntry certificate_map_entry = 3 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `UpdateCertificateMapEntry` method. message UpdateCertificateMapEntryRequest { // Required. A definition of the certificate map entry to create map entry. - CertificateMapEntry certificate_map_entry = 1 [(google.api.field_behavior) = REQUIRED]; + CertificateMapEntry certificate_map_entry = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. For the `FieldMask` definition, - // see + // Required. The update mask applies to the resource. For the `FieldMask` + // definition, see // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `DeleteCertificateMapEntry` method. message DeleteCertificateMapEntryRequest { - // Required. A name of the certificate map entry to delete. Must be in the format - // `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. + // Required. A name of the certificate map entry to delete. Must be in the + // format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -573,8 +647,8 @@ message DeleteCertificateMapEntryRequest { // Request for the `ListDnsAuthorizations` method. message ListDnsAuthorizationsRequest { - // Required. The project and location from which the dns authorizations should be - // listed, specified in the format `projects/*/locations/*`. + // Required. The project and location from which the dns authorizations should + // be listed, specified in the format `projects/*/locations/*`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -615,8 +689,8 @@ message ListDnsAuthorizationsResponse { // Request for the `GetDnsAuthorization` method. message GetDnsAuthorizationRequest { - // Required. A name of the dns authorization to describe. Must be in the format - // `projects/*/locations/*/dnsAuthorizations/*`. + // Required. A name of the dns authorization to describe. Must be in the + // format `projects/*/locations/*/dnsAuthorizations/*`. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -627,8 +701,8 @@ message GetDnsAuthorizationRequest { // Request for the `CreateDnsAuthorization` method. message CreateDnsAuthorizationRequest { - // Required. The parent resource of the dns authorization. Must be in the format - // `projects/*/locations/*`. + // Required. The parent resource of the dns authorization. Must be in the + // format `projects/*/locations/*`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -640,18 +714,21 @@ message CreateDnsAuthorizationRequest { string dns_authorization_id = 2 [(google.api.field_behavior) = REQUIRED]; // Required. A definition of the dns authorization to create. - DnsAuthorization dns_authorization = 3 [(google.api.field_behavior) = REQUIRED]; + DnsAuthorization dns_authorization = 3 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `UpdateDnsAuthorization` method. message UpdateDnsAuthorizationRequest { // Required. A definition of the dns authorization to update. - DnsAuthorization dns_authorization = 1 [(google.api.field_behavior) = REQUIRED]; + DnsAuthorization dns_authorization = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. For the `FieldMask` definition, - // see + // Required. The update mask applies to the resource. For the `FieldMask` + // definition, see // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request for the `DeleteDnsAuthorization` method. @@ -685,8 +762,9 @@ message OperationMetadata { // 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; // API version used to start the operation. @@ -751,13 +829,13 @@ message Certificate { RATE_LIMITED = 2; } - // Reason for provisioning failures. - Reason reason = 1; + // Output only. Reason for provisioning failures. + Reason reason = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Human readable explanation about the issue. Provided to help address - // the configuration issues. - // Not guaranteed to be stable. For programmatic access use Reason enum. - string details = 2; + // Output only. Human readable explanation about the issue. Provided to + // help address the configuration issues. Not guaranteed to be stable. For + // programmatic access use Reason enum. + string details = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } // State of the latest attempt to authorize a domain for certificate @@ -798,23 +876,27 @@ message Certificate { // Domain name of the authorization attempt. string domain = 1; - // State of the domain for managed certificate issuance. - State state = 2; + // Output only. State of the domain for managed certificate issuance. + State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Reason for failure of the authorization attempt for the domain. - FailureReason failure_reason = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Reason for failure of the authorization attempt for the + // domain. + FailureReason failure_reason = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Human readable explanation for reaching the state. Provided to help - // address the configuration issues. - // Not guaranteed to be stable. For programmatic access use Reason enum. - string details = 4; + // Output only. Human readable explanation for reaching the state. + // Provided to help address the configuration issues. Not guaranteed to be + // stable. For programmatic access use FailureReason enum. + string details = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Immutable. The domains for which a managed SSL certificate will be generated. - // Wildcard domains are only supported with DNS challenge resolution. + // Immutable. The domains for which a managed SSL certificate will be + // generated. Wildcard domains are only supported with DNS challenge + // resolution. repeated string domains = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Authorizations that will be used for performing domain authorization. + // Immutable. Authorizations that will be used for performing domain + // authorization. repeated string dns_authorizations = 2 [ (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { @@ -822,15 +904,32 @@ message Certificate { } ]; + // The resource name for a + // [CertificateIssuanceConfig][google.cloud.certificatemanager.v1.CertificateIssuanceConfig] + // used to configure private PKI certificates in the format + // `projects/*/locations/*/certificateIssuanceConfigs/*`. + // If this field is not set, the certificates will instead be publicly + // signed as documented at + // https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. + string issuance_config = 6 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "certificatemanager.googleapis.com/CertificateIssuanceConfig" + } + ]; + // Output only. State of the managed certificate resource. State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Information about issues with provisioning a Managed Certificate. - ProvisioningIssue provisioning_issue = 3; + // Output only. Information about issues with provisioning a Managed + // Certificate. + ProvisioningIssue provisioning_issue = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Detailed state of the latest authorization attempt for each domain - // specified for managed certificate resource. - repeated AuthorizationAttemptInfo authorization_attempt_info = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Detailed state of the latest authorization attempt for each + // domain specified for managed certificate resource. + repeated AuthorizationAttemptInfo authorization_attempt_info = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Certificate scope. @@ -852,10 +951,12 @@ message Certificate { string description = 8; // Output only. The creation timestamp of a Certificate. - 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 last update timestamp of a Certificate. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Set of labels associated with a Certificate. map labels = 4; @@ -868,17 +969,18 @@ message Certificate { ManagedCertificate managed = 11; } - // Output only. The list of Subject Alternative Names of dnsName type defined in the - // certificate (see RFC 5280 4.2.1.6). - // Managed certificates that haven't been provisioned yet have this field - // populated with a value of the managed.domains field. + // Output only. The list of Subject Alternative Names of dnsName type defined + // in the certificate (see RFC 5280 4.2.1.6). Managed certificates that + // haven't been provisioned yet have this field populated with a value of the + // managed.domains field. repeated string san_dnsnames = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The PEM-encoded certificate chain. string pem_certificate = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The expiry timestamp of a Certificate. - google.protobuf.Timestamp expire_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp expire_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. The scope of the certificate. Scope scope = 12 [(google.api.field_behavior) = IMMUTABLE]; @@ -895,27 +997,30 @@ message CertificateMap { message GclbTarget { // Defines IP configuration where this Certificate Map is serving. message IpConfig { - // An external IP address. - string ip_address = 1; + // Output only. An external IP address. + string ip_address = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Ports. - repeated uint32 ports = 3; + // Output only. Ports. + repeated uint32 ports = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } // A Target Proxy to which this map is attached to. oneof target_proxy { - // This field returns the resource name in the following format: + // Output only. This field returns the resource name in the following + // format: // `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`. - string target_https_proxy = 1; + string target_https_proxy = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // This field returns the resource name in the following format: + // Output only. This field returns the resource name in the following + // format: // `//compute.googleapis.com/projects/*/global/targetSslProxies/*`. - string target_ssl_proxy = 3; + string target_ssl_proxy = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // IP configurations for this Target Proxy where the + // Output only. IP configurations for this Target Proxy where the // Certificate Map is serving. - repeated IpConfig ip_configs = 2; + repeated IpConfig ip_configs = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // A user-defined name of the Certificate Map. Certificate Map names must be @@ -927,16 +1032,21 @@ message CertificateMap { string description = 5; // Output only. The creation timestamp of a Certificate Map. - 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 update timestamp of a Certificate Map. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Set of labels associated with a Certificate Map. map labels = 3; // Output only. A list of GCLB targets which use this Certificate Map. - repeated GclbTarget gclb_targets = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + // A Target Proxy is only present on this list if it's attached to a + // Forwarding Rule. + repeated GclbTarget gclb_targets = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Defines a certificate map entry. @@ -966,10 +1076,12 @@ message CertificateMapEntry { string description = 9; // Output only. The creation timestamp of a Certificate Map Entry. - 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 update timestamp of a Certificate Map Entry. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Set of labels associated with a Certificate Map Entry. map labels = 4; @@ -988,8 +1100,8 @@ message CertificateMapEntry { // defined up to fifteen 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" - }]; + type: "certificatemanager.googleapis.com/Certificate" + }]; // Output only. A serving state of this Certificate Map Entry. ServingState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -1025,10 +1137,12 @@ message DnsAuthorization { string name = 1; // Output only. The creation timestamp of a DnsAuthorization. - 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 last update timestamp of a DnsAuthorization. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Set of labels associated with a DnsAuthorization. map labels = 4; @@ -1036,16 +1150,19 @@ 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 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`. + // Required. Immutable. A domain which 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`. string domain = 6 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Output only. DNS Resource Record that needs to be added to DNS configuration. - DnsResourceRecord dns_resource_record = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. DNS Resource Record that needs to be added to DNS + // configuration. + DnsResourceRecord dns_resource_record = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Defines set of serving states associated with a resource. diff --git a/google/cloud/certificatemanager/v1/certificatemanager_grpc_service_config.json b/google/cloud/certificatemanager/v1/certificatemanager_grpc_service_config.json index bf34ddb0d..1fbaffe62 100644 --- a/google/cloud/certificatemanager/v1/certificatemanager_grpc_service_config.json +++ b/google/cloud/certificatemanager/v1/certificatemanager_grpc_service_config.json @@ -22,6 +22,10 @@ { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "CreateDnsAuthorization" }, { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "UpdateDnsAuthorization" }, { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "DeleteDnsAuthorization" }, + { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "GetCertificateIssuanceConfig" }, + { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "ListCertificateIssuanceConfigs" }, + { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "CreateCertificateIssuanceConfig" }, + { "service": "google.cloud.certificatemanager.v1.CertificateManager", "method": "DeleteCertificateIssuanceConfig" }, { "service": "google.longrunning.Operations", "method": "ListOperations" }, { "service": "google.longrunning.Operations", "method": "CancelOperation" }, { "service": "google.longrunning.Operations", "method": "DeleteOperation" }, diff --git a/google/cloud/channel/BUILD.bazel b/google/cloud/channel/BUILD.bazel index 4f0f35a3c..858802046 100644 --- a/google/cloud/channel/BUILD.bazel +++ b/google/cloud/channel/BUILD.bazel @@ -22,7 +22,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-channel", "ruby-cloud-env-prefix=CHANNEL", - "ruby-cloud-wrapper-of=v1:0.5", + "ruby-cloud-wrapper-of=v1:0.13", "ruby-cloud-product-url=https://cloud.google.com/channel", "ruby-cloud-api-id=cloudchannel.googleapis.com", "ruby-cloud-api-shortname=cloudchannel", diff --git a/google/cloud/channel/v1/BUILD.bazel b/google/cloud/channel/v1/BUILD.bazel index 83043102c..3bd7a0614 100644 --- a/google/cloud/channel/v1/BUILD.bazel +++ b/google/cloud/channel/v1/BUILD.bazel @@ -28,6 +28,7 @@ proto_library( "offers.proto", "operations.proto", "products.proto", + "reports_service.proto", "repricing.proto", "service.proto", "subscriber_event.proto", @@ -39,6 +40,7 @@ proto_library( "//google/api:resource_proto", "//google/longrunning:operations_proto", "//google/type:date_proto", + "//google/type:datetime_proto", "//google/type:decimal_proto", "//google/type:money_proto", "//google/type:postal_address_proto", @@ -85,6 +87,7 @@ java_gapic_library( srcs = [":channel_proto_with_info"], gapic_yaml = None, grpc_service_config = "cloudchannel_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", test_deps = [ ":channel_java_grpc", @@ -138,6 +141,7 @@ go_proto_library( "//google/api:annotations_go_proto", "//google/longrunning:longrunning_go_proto", "//google/type:date_go_proto", + "//google/type:datetime_go_proto", "//google/type:decimal_go_proto", "//google/type:money_go_proto", "//google/type:postaladdress_go_proto", @@ -150,13 +154,14 @@ go_gapic_library( grpc_service_config = "cloudchannel_grpc_service_config.json", importpath = "cloud.google.com/go/channel/apiv1;channel", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", transport = "grpc+rest", deps = [ ":channel_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -193,6 +198,7 @@ py_gapic_library( name = "channel_py_gapic", srcs = [":channel_proto"], grpc_service_config = "cloudchannel_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", transport = "grpc", ) @@ -241,7 +247,9 @@ php_gapic_library( name = "channel_php_gapic", srcs = [":channel_proto_with_info"], grpc_service_config = "cloudchannel_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", + transport = "grpc+rest", deps = [ ":channel_php_grpc", ":channel_php_proto", @@ -274,7 +282,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudchannel_grpc_service_config.json", package = "google.cloud.channel.v1", + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -319,6 +329,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/channel", ], grpc_service_config = "cloudchannel_grpc_service_config.json", + 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", deps = [ @@ -364,6 +375,7 @@ csharp_gapic_library( srcs = [":channel_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudchannel_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudchannel_v1.yaml", deps = [ ":channel_csharp_grpc", diff --git a/google/cloud/channel/v1/channel_partner_links.proto b/google/cloud/channel/v1/channel_partner_links.proto index fb301586e..d0607af27 100644 --- a/google/cloud/channel/v1/channel_partner_links.proto +++ b/google/cloud/channel/v1/channel_partner_links.proto @@ -26,7 +26,9 @@ option java_multiple_files = true; option java_outer_classname = "ChannelPartnerLinksProto"; option java_package = "com.google.cloud.channel.v1"; -// The level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display. +// The level of granularity the +// [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will +// display. enum ChannelPartnerLinkView { // The default / unset value. // The API will default to the BASIC view. @@ -72,24 +74,29 @@ message ChannelPartnerLink { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Cloud Identity ID of the linked reseller. - string reseller_cloud_identity_id = 2 [(google.api.field_behavior) = REQUIRED]; + string reseller_cloud_identity_id = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. State of the channel partner link. - ChannelPartnerLinkState link_state = 3 [(google.api.field_behavior) = REQUIRED]; + ChannelPartnerLinkState link_state = 3 + [(google.api.field_behavior) = REQUIRED]; // Output only. URI of the web page where partner accepts the link invitation. string invite_link_uri = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp of when the channel partner link is 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 of when the channel partner link is 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. Public identifier that a customer must use to generate a transfer token - // to move to this distributor-reseller combination. + // Output only. Public identifier that a customer must use to generate a + // transfer token to move to this distributor-reseller combination. string public_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Cloud Identity info of the channel partner (IR). - CloudIdentityInfo channel_partner_cloud_identity_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; -} + CloudIdentityInfo channel_partner_cloud_identity_info = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} \ No newline at end of file diff --git a/google/cloud/channel/v1/cloudchannel_v1.yaml b/google/cloud/channel/v1/cloudchannel_v1.yaml index e4138f5bf..c4d379a26 100644 --- a/google/cloud/channel/v1/cloudchannel_v1.yaml +++ b/google/cloud/channel/v1/cloudchannel_v1.yaml @@ -4,6 +4,7 @@ name: cloudchannel.googleapis.com title: Cloud Channel API apis: +- name: google.cloud.channel.v1.CloudChannelReportsService - name: google.cloud.channel.v1.CloudChannelService - name: google.longrunning.Operations @@ -11,6 +12,7 @@ types: - name: google.cloud.channel.v1.CustomerEvent - name: google.cloud.channel.v1.EntitlementEvent - name: google.cloud.channel.v1.OperationMetadata +- name: google.cloud.channel.v1.RunReportJobResponse - name: google.cloud.channel.v1.SubscriberEvent - name: google.cloud.channel.v1.TransferEntitlementsResponse @@ -34,6 +36,10 @@ http: authentication: rules: + - selector: 'google.cloud.channel.v1.CloudChannelReportsService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/apps.reports.usage.readonly - selector: 'google.cloud.channel.v1.CloudChannelService.*' oauth: canonical_scopes: |- diff --git a/google/cloud/channel/v1/common.proto b/google/cloud/channel/v1/common.proto index 175d044e6..2380722ac 100644 --- a/google/cloud/channel/v1/common.proto +++ b/google/cloud/channel/v1/common.proto @@ -149,4 +149,4 @@ message AdminUser { // Family name of the admin user. string family_name = 3; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/customers.proto b/google/cloud/channel/v1/customers.proto index e34432f2e..18bf1ad99 100644 --- a/google/cloud/channel/v1/customers.proto +++ b/google/cloud/channel/v1/customers.proto @@ -45,7 +45,8 @@ message Customer { // embargoes, we require a region and zip code. You must provide valid // addresses for every customer. To set the customer's language, use the // Customer-level language code. - google.type.PostalAddress org_postal_address = 3 [(google.api.field_behavior) = REQUIRED]; + google.type.PostalAddress org_postal_address = 3 + [(google.api.field_behavior) = REQUIRED]; // Primary contact info. ContactInfo primary_contact_info = 4; @@ -62,10 +63,12 @@ message Customer { string domain = 6 [(google.api.field_behavior) = REQUIRED]; // Output only. Time when the customer 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. Time when the customer was 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. The customer's Cloud Identity ID if the customer has a Cloud // Identity resource. @@ -78,7 +81,8 @@ message Customer { // Output only. Cloud Identity information for the customer. // Populated only if a Cloud Identity account exists for this customer. - CloudIdentityInfo cloud_identity_info = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + CloudIdentityInfo cloud_identity_info = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Cloud Identity ID of the customer's channel partner. // Populated only if a channel partner exists for this customer. @@ -107,4 +111,4 @@ message ContactInfo { // The customer account's contact phone number. string phone = 7; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/entitlements.proto b/google/cloud/channel/v1/entitlements.proto index 35da23938..8a6633b14 100644 --- a/google/cloud/channel/v1/entitlements.proto +++ b/google/cloud/channel/v1/entitlements.proto @@ -47,7 +47,9 @@ message Entitlement { SUSPENDED = 5; } - // Suspension reason for an entitlement if [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] = SUSPENDED. + // Suspension reason for an entitlement if + // [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] + // = SUSPENDED. enum SuspensionReason { // Not used. SUSPENSION_REASON_UNSPECIFIED = 0; @@ -74,10 +76,12 @@ message Entitlement { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time at which the entitlement is 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. The time at which the entitlement is 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]; // Required. The offer resource name for which the entitlement is to be // created. Takes the form: accounts/{account_id}/offers/{offer_id}. @@ -93,19 +97,23 @@ message Entitlement { CommitmentSettings commitment_settings = 12; // Output only. Current provisioning state of the entitlement. - ProvisioningState provisioning_state = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + ProvisioningState provisioning_state = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Service provisioning details for the entitlement. - ProvisionedService provisioned_service = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Enumerable of all current suspension reasons for an entitlement. - repeated SuspensionReason suspension_reasons = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. This purchase order (PO) information is for resellers to use for their - // company tracking usage. If a purchaseOrderId value is given, it appears in - // the API responses and shows up in the invoice. The property accepts up to - // 80 plain text characters. This is only supported for Google Workspace - // entitlements. + ProvisionedService provisioned_service = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Enumerable of all current suspension reasons for an + // entitlement. + repeated SuspensionReason suspension_reasons = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. This purchase order (PO) information is for resellers to use for + // their company tracking usage. If a purchaseOrderId value is given, it + // appears in the API responses and shows up in the invoice. The property + // accepts up to 80 plain text characters. This is only supported for Google + // Workspace entitlements. string purchase_order_id = 19 [(google.api.field_behavior) = OPTIONAL]; // Output only. Settings for trial offers. @@ -136,9 +144,9 @@ message Parameter { // Value of the parameter. Value value = 2; - // Output only. Specifies whether this parameter is allowed to be changed. For example, for - // a Google Workspace Business Starter entitlement in commitment plan, - // num_units is editable when entitlement is active. + // Output only. Specifies whether this parameter is allowed to be changed. For + // example, for a Google Workspace Business Starter entitlement in commitment + // plan, num_units is editable when entitlement is active. bool editable = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -146,32 +154,35 @@ message Parameter { message AssociationInfo { // The name of the base entitlement, for which this entitlement is an add-on. string base_entitlement = 1 [(google.api.resource_reference) = { - type: "cloudchannel.googleapis.com/Entitlement" - }]; + type: "cloudchannel.googleapis.com/Entitlement" + }]; } // Service provisioned for an entitlement. message ProvisionedService { - // Output only. Provisioning ID of the entitlement. For Google Workspace, this is the - // underlying Subscription ID. For Google Cloud Platform, this is the + // Output only. Provisioning ID of the entitlement. For Google Workspace, this + // is the underlying Subscription ID. For Google Cloud Platform, this is the // Billing Account ID of the billing subaccount." string provisioning_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The product pertaining to the provisioning resource as specified in the - // Offer. + // Output only. The product pertaining to the provisioning resource as + // specified in the Offer. string product_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The SKU pertaining to the provisioning resource as specified in the Offer. + // Output only. The SKU pertaining to the provisioning resource as specified + // in the Offer. string sku_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Commitment settings for commitment-based offers. message CommitmentSettings { // Output only. Commitment start timestamp. - google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Commitment end timestamp. - google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Renewal settings applicable for a commitment-based Offer. RenewalSettings renewal_settings = 4 [(google.api.field_behavior) = OPTIONAL]; @@ -218,7 +229,8 @@ message TransferableSku { // The SKU pertaining to the provisioning resource as specified in the Offer. Sku sku = 11; - // Optional. The customer to transfer has an entitlement with the populated legacy SKU. + // Optional. The customer to transfer has an entitlement with the populated + // legacy SKU. Sku legacy_sku = 12 [(google.api.field_behavior) = OPTIONAL]; } @@ -247,4 +259,4 @@ message TransferEligibility { // Specified the reason for ineligibility. Reason ineligibility_reason = 3; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/offers.proto b/google/cloud/channel/v1/offers.proto index 615e3d932..3a5040453 100644 --- a/google/cloud/channel/v1/offers.proto +++ b/google/cloud/channel/v1/offers.proto @@ -125,8 +125,8 @@ enum PeriodType { } // Represents an offer made to resellers for purchase. -// An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan for payment, a price, and -// defines the constraints for buying. +// An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan +// for payment, a price, and defines the constraints for buying. message Offer { option (google.api.resource) = { type: "cloudchannel.googleapis.com/Offer" @@ -156,10 +156,14 @@ message Offer { google.protobuf.Timestamp start_time = 7; // Output only. End of the Offer validity time. - google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Parameters required to use current Offer to purchase. repeated ParameterDefinition parameter_definitions = 9; + + // The deal code of the offer to get a special promotion or discount. + string deal_code = 12; } // Parameter's definition. Specifies what parameter is required to use the @@ -323,4 +327,4 @@ message Period { // Period Type. PeriodType period_type = 2; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/operations.proto b/google/cloud/channel/v1/operations.proto index ad432919b..e9e190772 100644 --- a/google/cloud/channel/v1/operations.proto +++ b/google/cloud/channel/v1/operations.proto @@ -21,7 +21,8 @@ option java_multiple_files = true; option java_outer_classname = "OperationsProto"; option java_package = "com.google.cloud.channel.v1"; -// Provides contextual information about a [google.longrunning.Operation][google.longrunning.Operation]. +// Provides contextual information about a +// [google.longrunning.Operation][google.longrunning.Operation]. message OperationMetadata { // RPCs that return a Long Running Operation. enum OperationType { @@ -64,4 +65,4 @@ message OperationMetadata { // The RPC that initiated this Long Running Operation. OperationType operation_type = 1; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/products.proto b/google/cloud/channel/v1/products.proto index 8dc39767a..411e1698b 100644 --- a/google/cloud/channel/v1/products.proto +++ b/google/cloud/channel/v1/products.proto @@ -91,4 +91,4 @@ message Media { // Type of the media. MediaType type = 3; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/reports_service.proto b/google/cloud/channel/v1/reports_service.proto new file mode 100644 index 000000000..1cb87124c --- /dev/null +++ b/google/cloud/channel/v1/reports_service.proto @@ -0,0 +1,444 @@ +// 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.channel.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/timestamp.proto"; +import "google/type/date.proto"; +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 java_multiple_files = true; +option java_outer_classname = "ReportsServiceProto"; +option java_package = "com.google.cloud.channel.v1"; + +// CloudChannelReportsService lets Google Cloud resellers and +// distributors retrieve and combine a variety of data in Cloud Channel for +// multiple products (Google Cloud Platform (GCP), Google Voice, and +// Google Workspace.) +service CloudChannelReportsService { + option (google.api.default_host) = "cloudchannel.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/apps.reports.usage.readonly"; + + // Begins generation of data for a given report. The report + // identifier is a UID (for example, `613bf59q`). + // + // Possible error codes: + // + // * PERMISSION_DENIED: The user doesn't have access to this report. + // * INVALID_ARGUMENT: Required request parameters are missing + // or invalid. + // * NOT_FOUND: The report identifier was not found. + // * INTERNAL: Any non-user error related to a technical issue + // in the backend. Contact Cloud Channel support. + // * UNKNOWN: Any non-user error related to a technical issue + // in the backend. Contact Cloud Channel support. + // + // Return value: + // The ID of a long-running operation. + // + // To get the results of the operation, call the GetOperation method of + // CloudChannelOperationsService. The Operation metadata contains an + // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. + // + // To get the results of report generation, call + // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] + // with the + // [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job]. + rpc RunReportJob(RunReportJobRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=accounts/*/reports/*}:run" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "RunReportJobResponse" + metadata_type: "OperationMetadata" + }; + } + + // Retrieves data generated by + // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. + rpc FetchReportResults(FetchReportResultsRequest) + returns (FetchReportResultsResponse) { + option (google.api.http) = { + post: "/v1/{report_job=accounts/*/reportJobs/*}:fetchReportResults" + body: "*" + }; + option (google.api.method_signature) = "report_job"; + } + + // Lists the reports that RunReportJob can run. These reports include an ID, + // a description, and the list of columns that will be in the result. + rpc ListReports(ListReportsRequest) returns (ListReportsResponse) { + option (google.api.http) = { + get: "/v1/{parent=accounts/*}/reports" + }; + option (google.api.method_signature) = "parent"; + } +} + +// Request message for +// [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. +message RunReportJobRequest { + // Required. The report's resource name. Specifies the account and report used + // to generate report data. The report_id identifier is a UID (for example, + // `613bf59q`). + // Name uses the format: + // accounts/{account_id}/reports/{report_id} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "cloudchannel.googleapis.com/Report" + } + ]; + + // Optional. The range of usage or invoice dates to include in the result. + DateRange date_range = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A structured string that defines conditions on dimension columns + // to restrict the report output. + // + // Filters support logical operators (AND, OR, NOT) and conditional operators + // (=, !=, <, >, <=, and >=) using `column_id` as keys. + // + // For example: + // `(customer:"accounts/C123abc/customers/S456def" OR + // customer:"accounts/C123abc/customers/S789ghi") AND + // invoice_start_date.year >= 2022` + string filter = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The BCP-47 language code, such as "en-US". If specified, the + // response is localized to the corresponding language code if the + // original data sources support it. + // Default is "en-US". + string language_code = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for +// [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. +message RunReportJobResponse { + // Pass `report_job.name` to + // [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job] + // to retrieve the report's results. + ReportJob report_job = 1; + + // The metadata for the report's results (display name, columns, row count, + // and date range). If you view this before the operation finishes, + // you may see incomplete data. + ReportResultsMetadata report_metadata = 2; +} + +// Request message for +// [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]. +message FetchReportResultsRequest { + // Required. The report job created by + // [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. + // Report_job uses the format: + // accounts/{account_id}/reportJobs/{report_job_id} + string report_job = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "cloudchannel.googleapis.com/ReportJob" + } + ]; + + // Optional. Requested page size of the report. The server may return fewer + // results than requested. If you don't specify a page size, the server uses a + // sensible default (may change over time). + // + // The maximum value is 30,000; the server will change larger values to + // 30,000. + int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A token that specifies a page of results beyond the first page. + // Obtained through + // [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token] + // of the previous + // [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] + // call. + string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for +// [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]. +// Contains a tabular representation of the report results. +message FetchReportResultsResponse { + // The metadata for the report results (display name, columns, row count, and + // date ranges). + ReportResultsMetadata report_metadata = 1; + + // The report's lists of values. Each row follows the settings and ordering + // of the columns from `report_metadata`. + repeated Row rows = 2; + + // Pass this token to + // [FetchReportResultsRequest.page_token][google.cloud.channel.v1.FetchReportResultsRequest.page_token] + // to retrieve the next page of results. + string next_page_token = 3; +} + +// Request message for +// [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports]. +message ListReportsRequest { + // Required. The resource name of the partner account to list available + // reports for. Parent uses the format: accounts/{account_id} + string parent = 1 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Requested page size of the report. The server might return fewer + // results than requested. If unspecified, returns 20 reports. The maximum + // value is 100. + int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A token that specifies a page of results beyond the first page. + // Obtained through + // [ListReportsResponse.next_page_token][google.cloud.channel.v1.ListReportsResponse.next_page_token] + // of the previous + // [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports] + // call. + string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The BCP-47 language code, such as "en-US". If specified, the + // response is localized to the corresponding language code if the + // original data sources support it. + // Default is "en-US". + string language_code = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for +// [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports]. +message ListReportsResponse { + // The reports available to the partner. + repeated Report reports = 1; + + // Pass this token to + // [FetchReportResultsRequest.page_token][google.cloud.channel.v1.FetchReportResultsRequest.page_token] + // to retrieve the next page of results. + string next_page_token = 2; +} + +// The result of a [RunReportJob][] operation. Contains the name to use in +// [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job] +// and the status of the operation. +message ReportJob { + option (google.api.resource) = { + type: "cloudchannel.googleapis.com/ReportJob" + pattern: "accounts/{account}/reportJobs/{report_job}" + }; + + // Required. The resource name of a report job. + // Name uses the format: + // `accounts/{account_id}/reportJobs/{report_job_id}` + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The current status of report generation. + ReportStatus report_status = 2; +} + +// The features describing the data. Returned by +// [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob] +// and +// [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]. +message ReportResultsMetadata { + // Details of the completed report. + Report report = 1; + + // The total number of rows of data in the final report. + int64 row_count = 2; + + // The date range of reported usage. + DateRange date_range = 3; + + // The usage dates immediately preceding `date_range` with the same duration. + // Use this to calculate trending usage and costs. This is only populated if + // you request trending data. + // + // For example, if `date_range` is July 1-15, `preceding_date_range` will be + // June 16-30. + DateRange preceding_date_range = 4; +} + +// The definition of a report column. Specifies the data properties +// in the corresponding position of the report rows. +message Column { + // Available data types for columns. Corresponds to the fields in the + // ReportValue `oneof` field. + enum DataType { + // Not used. + DATA_TYPE_UNSPECIFIED = 0; + + // ReportValues for this column will use string_value. + STRING = 1; + + // ReportValues for this column will use int_value. + INT = 2; + + // ReportValues for this column will use decimal_value. + DECIMAL = 3; + + // ReportValues for this column will use money_value. + MONEY = 4; + + // ReportValues for this column will use date_value. + DATE = 5; + + // ReportValues for this column will use date_time_value. + DATE_TIME = 6; + } + + // The unique name of the column (for example, customer_domain, + // channel_partner, customer_cost). You can use column IDs in + // [RunReportJobRequest.filter][google.cloud.channel.v1.RunReportJobRequest.filter]. + // To see all reports and their columns, call + // [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports]. + string column_id = 1; + + // The column's display name. + string display_name = 2; + + // The type of the values for this column. + DataType data_type = 3; +} + +// A representation of usage or invoice date ranges. +message DateRange { + // The earliest usage date time (inclusive). + // + // If you use time groupings (daily, weekly, etc), each group uses + // midnight to midnight (Pacific time). The usage start date is + // rounded down to include all usage from the specified date. We recommend + // that clients pass `usage_start_date_time` in Pacific time. + google.type.DateTime usage_start_date_time = 1; + + // The latest usage date time (exclusive). + // + // If you use time groupings (daily, weekly, etc), each group uses + // midnight to midnight (Pacific time). The usage end date is + // rounded down to include all usage from the specified date. We recommend + // that clients pass `usage_start_date_time` in Pacific time. + google.type.DateTime usage_end_date_time = 2; + + // The earliest invoice date (inclusive). + // + // If your product uses monthly invoices, and this value is not the beginning + // of a month, this will adjust the date to the first day of the given month. + google.type.Date invoice_start_date = 3; + + // The latest invoice date (exclusive). + // + // If your product uses monthly invoices, and this value is not the beginning + // of a month, this will adjust the date to the first day of the following + // month. + google.type.Date invoice_end_date = 4; +} + +// A row of report values. +message Row { + // The list of values in the row. + repeated ReportValue values = 1; +} + +// A single report value. +message ReportValue { + // A single report value. + oneof value { + // A value of type `string`. + string string_value = 1; + + // A value of type `int`. + int64 int_value = 2; + + // A value of type `google.type.Decimal`, representing non-integer numeric + // values. + google.type.Decimal decimal_value = 3; + + // A value of type `google.type.Money` (currency code, whole units, decimal + // units). + google.type.Money money_value = 4; + + // A value of type `google.type.Date` (year, month, day). + google.type.Date date_value = 5; + + // A value of type `google.type.DateTime` (year, month, day, hour, minute, + // second, and UTC offset or timezone.) + google.type.DateTime date_time_value = 6; + } +} + +// Status of a report generation process. +message ReportStatus { + // Available states of report generation. + enum State { + // Not used. + STATE_UNSPECIFIED = 0; + + // Report processing started. + STARTED = 1; + + // Data generated from the report is being staged. + WRITING = 2; + + // Report data is available for access. + AVAILABLE = 3; + + // Report failed. + FAILED = 4; + } + + // The current state of the report generation process. + State state = 1; + + // The report generation's start time. + google.protobuf.Timestamp start_time = 2; + + // The report generation's completion time. + google.protobuf.Timestamp end_time = 3; +} + +// The ID and description of a report that was used to generate report data. +// For example, "GCP Daily Spend", "Google Workspace License Activity", etc. +message Report { + option (google.api.resource) = { + type: "cloudchannel.googleapis.com/Report" + pattern: "accounts/{account}/reports/{report}" + }; + + // Required. The report's resource name. Specifies the account and report used + // to generate report data. The report_id identifier is a UID (for example, + // `613bf59q`). + // + // Name uses the format: + // accounts/{account_id}/reports/{report_id} + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // A human-readable name for this report. + string display_name = 2; + + // The list of columns included in the report. This defines the schema of + // the report results. + repeated Column columns = 3; + + // A description of other aspects of the report, such as the products + // it supports. + string description = 4; +} \ No newline at end of file diff --git a/google/cloud/channel/v1/repricing.proto b/google/cloud/channel/v1/repricing.proto index 7cc2f2607..1a15067b3 100644 --- a/google/cloud/channel/v1/repricing.proto +++ b/google/cloud/channel/v1/repricing.proto @@ -54,14 +54,16 @@ message CustomerRepricingConfig { // accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The configuration for bill modifications made by a reseller before - // sending it to customers. + // Required. The configuration for bill modifications made by a reseller + // before sending it to customers. RepricingConfig repricing_config = 2 [(google.api.field_behavior) = REQUIRED]; - // Output only. Timestamp of an update to the repricing rule. If `update_time` is after - // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] then it indicates this was set - // mid-month. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp of an update to the repricing rule. If `update_time` + // is after + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // then it indicates this was set mid-month. + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Configuration for how a distributor will rebill a channel partner @@ -77,14 +79,16 @@ message ChannelPartnerRepricingConfig { // accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The configuration for bill modifications made by a reseller before - // sending it to ChannelPartner. + // Required. The configuration for bill modifications made by a reseller + // before sending it to ChannelPartner. RepricingConfig repricing_config = 2 [(google.api.field_behavior) = REQUIRED]; - // Output only. Timestamp of an update to the repricing rule. If `update_time` is after - // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] then it indicates this was set - // mid-month. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp of an update to the repricing rule. If `update_time` + // is after + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // then it indicates this was set mid-month. + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Configuration for repricing a Google bill over a period of time. @@ -95,16 +99,14 @@ message RepricingConfig { // Format: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string entitlement = 1 [(google.api.resource_reference) = { - type: "cloudchannel.googleapis.com/Entitlement" - }]; + type: "cloudchannel.googleapis.com/Entitlement" + }]; } // Applies the repricing configuration at the channel partner level. // The channel partner value is derived from the resource name. Takes an // empty json object. - message ChannelPartnerGranularity { - - } + message ChannelPartnerGranularity {} // Required. Defines the granularity for repricing. oneof granularity { @@ -117,16 +119,23 @@ message RepricingConfig { ChannelPartnerGranularity channel_partner_granularity = 5; } - // Required. The YearMonth when these adjustments activate. The Day field needs to be - // "0" since we only accept YearMonth repricing boundaries. - google.type.Date effective_invoice_month = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The YearMonth when these adjustments activate. The Day field + // needs to be "0" since we only accept YearMonth repricing boundaries. + google.type.Date effective_invoice_month = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Information about the adjustment. RepricingAdjustment adjustment = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The [RebillingBasis][google.cloud.channel.v1.RebillingBasis] to use for this bill. Specifies the relative cost - // based on repricing costs you will apply. + // Required. The [RebillingBasis][google.cloud.channel.v1.RebillingBasis] to + // use for this bill. Specifies the relative cost based on repricing costs you + // will apply. RebillingBasis rebilling_basis = 3 [(google.api.field_behavior) = REQUIRED]; + + // The conditional overrides to apply for this configuration. If you list + // multiple overrides, only the first valid override is used. If you don't + // list any overrides, the API uses the normal adjustment and rebilling basis. + repeated ConditionalOverride conditional_overrides = 6; } // A type that represents the various adjustments you can apply to a bill. @@ -147,3 +156,39 @@ message PercentageAdjustment { // Pass-Through => "0.00" google.type.Decimal percentage = 2; } + +// Specifies the override to conditionally apply. +message ConditionalOverride { + // Required. Information about the applied override's adjustment. + RepricingAdjustment adjustment = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The [RebillingBasis][google.cloud.channel.v1.RebillingBasis] to + // use for the applied override. Shows the relative cost based on your + // repricing costs. + RebillingBasis rebilling_basis = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Specifies the condition which, if met, will apply the override. + RepricingCondition repricing_condition = 3 + [(google.api.field_behavior) = REQUIRED]; +} + +// Represents the various repricing conditions you can use for a conditional +// override. +message RepricingCondition { + // Represents the types of existing conditional statements. + oneof condition { + // SKU Group condition for override. + SkuGroupCondition sku_group_condition = 1; + } +} + +// A condition that applies the override if a line item SKU is found in the SKU +// group. +message SkuGroupCondition { + // Specifies a SKU group (https://cloud.google.com/skus/sku-groups). + // Resource name of SKU group. Format: + // accounts/{account}/skuGroups/{sku_group}. + // Example: + // "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041". + string sku_group = 1; +} \ No newline at end of file diff --git a/google/cloud/channel/v1/service.proto b/google/cloud/channel/v1/service.proto index 7a6b3f0e4..93730e9ea 100644 --- a/google/cloud/channel/v1/service.proto +++ b/google/cloud/channel/v1/service.proto @@ -46,18 +46,20 @@ option java_package = "com.google.cloud.channel.v1"; // 3. Resellers and distributors can manage customer entitlements. // // CloudChannelService exposes the following resources: -// - [Customer][google.cloud.channel.v1.Customer]s: An entity—usually an enterprise—managed by a reseller or -// distributor. +// - [Customer][google.cloud.channel.v1.Customer]s: An entity-usually an +// enterprise-managed by a reseller or distributor. // -// - [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with the means to use -// a service. Entitlements are created or updated as a result of a successful -// fulfillment. +// - [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that +// provides a customer with the means to use a service. Entitlements are created +// or updated as a result of a successful fulfillment. // -// - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between -// distributors and their indirect resellers in a channel. +// - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An +// entity that identifies links between distributors and their indirect +// resellers in a channel. service CloudChannelService { option (google.api.default_host) = "cloudchannel.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/apps.order"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/apps.order"; // List [Customer][google.cloud.channel.v1.Customer]s. // @@ -68,7 +70,8 @@ service CloudChannelService { // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // // Return value: - // List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers. + // List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if + // there are no customers. rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse) { option (google.api.http) = { get: "/v1/{parent=accounts/*}/customers" @@ -78,7 +81,8 @@ service CloudChannelService { }; } - // Returns the requested [Customer][google.cloud.channel.v1.Customer] resource. + // Returns the requested [Customer][google.cloud.channel.v1.Customer] + // resource. // // Possible error codes: // @@ -111,20 +115,24 @@ service CloudChannelService { // * INVALID_VALUE: Invalid domain value in the request. // // Return value: - // A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be - // empty) + // A list of + // [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] + // resources for the domain (may be empty) // // Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if - // no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain. - rpc CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest) returns (CheckCloudIdentityAccountsExistResponse) { + // no + // [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] + // resources match the domain. + rpc CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest) + returns (CheckCloudIdentityAccountsExistResponse) { option (google.api.http) = { post: "/v1/{parent=accounts/*}:checkCloudIdentityAccountsExist" body: "*" }; } - // Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor - // account. + // Creates a new [Customer][google.cloud.channel.v1.Customer] resource under + // the reseller or distributor account. // // Possible error codes: // @@ -147,15 +155,16 @@ service CloudChannelService { }; } - // Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or - // distributor. + // Updates an existing [Customer][google.cloud.channel.v1.Customer] resource + // for the reseller or distributor. // // Possible error codes: // // * PERMISSION_DENIED: The reseller account making the request is different // from the reseller account in the API request. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. - // * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request. + // * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found + // for the name in the request. // // Return value: // The updated [Customer][google.cloud.channel.v1.Customer] resource. @@ -178,7 +187,8 @@ service CloudChannelService { // this customer. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // * FAILED_PRECONDITION: The customer has existing entitlements. - // * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request. + // * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found + // for the name in the request. rpc DeleteCustomer(DeleteCustomerRequest) returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=accounts/*/customers/*}" @@ -189,10 +199,10 @@ service CloudChannelService { option (google.api.method_signature) = "name"; } - // Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided - // Cloud Identity ID or domain before a TransferEntitlements call. If a - // linked Customer already exists and overwrite_if_exists is true, it will - // update that Customer's data. + // Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud + // Identity associated with the provided Cloud Identity ID or domain before a + // TransferEntitlements call. If a linked Customer already exists and + // overwrite_if_exists is true, it will update that Customer's data. // // Possible error codes: // @@ -238,7 +248,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata contains an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc ProvisionCloudIdentity(ProvisionCloudIdentityRequest) returns (google.longrunning.Operation) { + rpc ProvisionCloudIdentity(ProvisionCloudIdentityRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{customer=accounts/*/customers/*}:provisionCloudIdentity" body: "*" @@ -249,7 +260,8 @@ service CloudChannelService { }; } - // Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer. + // Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a + // customer. // // Possible error codes: // @@ -257,15 +269,17 @@ service CloudChannelService { // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // // Return value: - // A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s. - rpc ListEntitlements(ListEntitlementsRequest) returns (ListEntitlementsResponse) { + // A list of the customer's + // [Entitlement][google.cloud.channel.v1.Entitlement]s. + rpc ListEntitlements(ListEntitlementsRequest) + returns (ListEntitlementsResponse) { option (google.api.http) = { get: "/v1/{parent=accounts/*/customers/*}/entitlements" }; } - // List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or - // Customer Name in the request. + // List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a + // customer based on the Cloud Identity ID or Customer Name in the request. // // Use this method to list the entitlements information of an // unowned customer. You should provide the customer's @@ -281,16 +295,18 @@ service CloudChannelService { // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // // Return value: - // A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku]. - rpc ListTransferableSkus(ListTransferableSkusRequest) returns (ListTransferableSkusResponse) { + // A list of the customer's + // [TransferableSku][google.cloud.channel.v1.TransferableSku]. + rpc ListTransferableSkus(ListTransferableSkusRequest) + returns (ListTransferableSkusResponse) { option (google.api.http) = { post: "/v1/{parent=accounts/*}:listTransferableSkus" body: "*" }; } - // List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or - // Customer Name in the request. + // List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a + // customer based on Cloud Identity ID or Customer Name in the request. // // Use this method when a reseller gets the entitlement information of an // unowned customer. The reseller should provide the customer's @@ -300,21 +316,25 @@ service CloudChannelService { // // * PERMISSION_DENIED: // * The customer doesn't belong to the reseller and has no auth token. - // * The supplied auth token is invalid. + // * The customer provided incorrect reseller information when generating + // auth token. // * The reseller account making the request is different // from the reseller account in the query. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // // Return value: - // List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU. - rpc ListTransferableOffers(ListTransferableOffersRequest) returns (ListTransferableOffersResponse) { + // List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for + // the given customer and SKU. + rpc ListTransferableOffers(ListTransferableOffersRequest) + returns (ListTransferableOffersResponse) { option (google.api.http) = { post: "/v1/{parent=accounts/*}:listTransferableOffers" body: "*" }; } - // Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource. + // Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] + // resource. // // Possible error codes: // @@ -366,7 +386,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc CreateEntitlement(CreateEntitlementRequest) returns (google.longrunning.Operation) { + rpc CreateEntitlement(CreateEntitlementRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accounts/*/customers/*}/entitlements" body: "*" @@ -400,7 +421,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc ChangeParameters(ChangeParametersRequest) returns (google.longrunning.Operation) { + rpc ChangeParameters(ChangeParametersRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:changeParameters" body: "*" @@ -434,7 +456,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc ChangeRenewalSettings(ChangeRenewalSettingsRequest) returns (google.longrunning.Operation) { + rpc ChangeRenewalSettings(ChangeRenewalSettingsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:changeRenewalSettings" body: "*" @@ -501,7 +524,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc StartPaidService(StartPaidServiceRequest) returns (google.longrunning.Operation) { + rpc StartPaidService(StartPaidServiceRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:startPaidService" body: "*" @@ -533,7 +557,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc SuspendEntitlement(SuspendEntitlementRequest) returns (google.longrunning.Operation) { + rpc SuspendEntitlement(SuspendEntitlementRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:suspend" body: "*" @@ -570,7 +595,8 @@ service CloudChannelService { // CloudChannelOperationsService. The response will contain // google.protobuf.Empty on success. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc CancelEntitlement(CancelEntitlementRequest) returns (google.longrunning.Operation) { + rpc CancelEntitlement(CancelEntitlementRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:cancel" body: "*" @@ -608,7 +634,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc ActivateEntitlement(ActivateEntitlementRequest) returns (google.longrunning.Operation) { + rpc ActivateEntitlement(ActivateEntitlementRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=accounts/*/customers/*/entitlements/*}:activate" body: "*" @@ -648,7 +675,8 @@ service CloudChannelService { // To get the results of the operation, call the GetOperation method of // CloudChannelOperationsService. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc TransferEntitlements(TransferEntitlementsRequest) returns (google.longrunning.Operation) { + rpc TransferEntitlements(TransferEntitlementsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accounts/*/customers/*}:transferEntitlements" body: "*" @@ -688,7 +716,8 @@ service CloudChannelService { // CloudChannelOperationsService. The response will contain // google.protobuf.Empty on success. The Operation metadata will contain an // instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. - rpc TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest) returns (google.longrunning.Operation) { + rpc TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accounts/*/customers/*}:transferEntitlementsToGoogle" body: "*" @@ -699,8 +728,8 @@ service CloudChannelService { }; } - // List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. - // You must be a distributor to call this method. + // List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s + // belonging to a distributor. You must be a distributor to call this method. // // Possible error codes: // @@ -709,14 +738,17 @@ service CloudChannelService { // * INVALID_ARGUMENT: Required request parameters are missing or invalid. // // Return value: - // The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources. - rpc ListChannelPartnerLinks(ListChannelPartnerLinksRequest) returns (ListChannelPartnerLinksResponse) { + // The list of the distributor account's + // [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources. + rpc ListChannelPartnerLinks(ListChannelPartnerLinksRequest) + returns (ListChannelPartnerLinksResponse) { option (google.api.http) = { get: "/v1/{parent=accounts/*}/channelPartnerLinks" }; } - // Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. + // Returns the requested + // [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. // You must be a distributor to call this method. // // Possible error codes: @@ -728,8 +760,10 @@ service CloudChannelService { // invalid channel partner link name. // // Return value: - // The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. - rpc GetChannelPartnerLink(GetChannelPartnerLinkRequest) returns (ChannelPartnerLink) { + // The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] + // resource. + rpc GetChannelPartnerLink(GetChannelPartnerLinkRequest) + returns (ChannelPartnerLink) { option (google.api.http) = { get: "/v1/{name=accounts/*/channelPartnerLinks/*}" }; @@ -756,8 +790,10 @@ service CloudChannelService { // Contact Cloud Channel support. // // Return value: - // The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. - rpc CreateChannelPartnerLink(CreateChannelPartnerLinkRequest) returns (ChannelPartnerLink) { + // The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] + // resource. + rpc CreateChannelPartnerLink(CreateChannelPartnerLinkRequest) + returns (ChannelPartnerLink) { option (google.api.http) = { post: "/v1/{parent=accounts/*}/channelPartnerLinks" body: "channel_partner_link" @@ -784,8 +820,10 @@ service CloudChannelService { // Contact Cloud Channel support. // // Return value: - // The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. - rpc UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest) returns (ChannelPartnerLink) { + // The updated + // [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. + rpc UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest) + returns (ChannelPartnerLink) { option (google.api.http) = { patch: "/v1/{name=accounts/*/channelPartnerLinks/*}" body: "*" @@ -799,14 +837,18 @@ service CloudChannelService { // // * PERMISSION_DENIED: If the account making the request and the account // being queried are different. - // * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found. + // * NOT_FOUND: The + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // was not found. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns - // an error. - rpc GetCustomerRepricingConfig(GetCustomerRepricingConfigRequest) returns (CustomerRepricingConfig) { + // If successful, the + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // resource, otherwise returns an error. + rpc GetCustomerRepricingConfig(GetCustomerRepricingConfigRequest) + returns (CustomerRepricingConfig) { option (google.api.http) = { get: "/v1/{name=accounts/*/customers/*/customerRepricingConfigs/*}" }; @@ -820,21 +862,25 @@ service CloudChannelService { // // * PERMISSION_DENIED: If the account making the request and the account // being queried are different. - // * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is - // not associated with the given account. + // * NOT_FOUND: The + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The - // data for each resource is displayed in the ascending order of: + // If successful, the + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // resources. The data for each resource is displayed in the ascending order + // of: // * customer ID // * [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] // * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] // * [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time] // // If unsuccessful, returns an error. - rpc ListCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest) returns (ListCustomerRepricingConfigsResponse) { + rpc ListCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest) + returns (ListCustomerRepricingConfigsResponse) { option (google.api.http) = { get: "/v1/{parent=accounts/*/customers/*}/customerRepricingConfigs" }; @@ -843,9 +889,9 @@ service CloudChannelService { // Creates a CustomerRepricingConfig. Call this method to set modifications // for a specific customer's bill. You can only create configs if the - // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a - // future month. If needed, you can create a config for the current month, - // with some restrictions. + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is a future month. If needed, you can create a config for the current + // month, with some restrictions. // // When creating a config for a future month, make sure there are no existing // configs for that @@ -859,9 +905,11 @@ service CloudChannelService { // Changes to the config may be immediate, but may take up to 24 hours. // * There is a limit of ten configs for any // [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] - // or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. - // * The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] vaule must be - // different from the value used in the current config for a + // or + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. + // * The contained + // [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] + // vaule must be different from the value used in the current config for a // [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]. // // Possible Error Codes: @@ -871,15 +919,18 @@ service CloudChannelService { // * INVALID_ARGUMENT: Missing or invalid required parameters in the // request. Also displays if the updated config is for the current month or // past months. - // * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is - // not associated with the given account. + // * NOT_FOUND: The + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise - // returns an error. - rpc CreateCustomerRepricingConfig(CreateCustomerRepricingConfigRequest) returns (CustomerRepricingConfig) { + // If successful, the updated + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // resource, otherwise returns an error. + rpc CreateCustomerRepricingConfig(CreateCustomerRepricingConfigRequest) + returns (CustomerRepricingConfig) { option (google.api.http) = { post: "/v1/{parent=accounts/*/customers/*}/customerRepricingConfigs" body: "customer_repricing_config" @@ -892,10 +943,11 @@ service CloudChannelService { // CustomerRepricingConfig. // // You can only update configs if the - // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a - // future month. To make changes to configs for the current month, use - // [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You - // cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is a future month. To make changes to configs for the current month, use + // [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], + // taking note of its restrictions. You cannot update the + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. // // When updating a config in the future: // @@ -908,15 +960,18 @@ service CloudChannelService { // * INVALID_ARGUMENT: Missing or invalid required parameters in the // request. Also displays if the updated config is for the current month or // past months. - // * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is - // not associated with the given account. + // * NOT_FOUND: The + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise - // returns an error. - rpc UpdateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest) returns (CustomerRepricingConfig) { + // If successful, the updated + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // resource, otherwise returns an error. + rpc UpdateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest) + returns (CustomerRepricingConfig) { option (google.api.http) = { patch: "/v1/{customer_repricing_config.name=accounts/*/customers/*/customerRepricingConfigs/*}" body: "customer_repricing_config" @@ -924,20 +979,25 @@ service CloudChannelService { option (google.api.method_signature) = "customer_repricing_config"; } - // Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only - // delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set - // to a date after the current month. + // Deletes the given + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // permanently. You can only delete configs if their + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is set to a date after the current month. // // Possible error codes: // // * PERMISSION_DENIED: The account making the request does not own // this customer. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. - // * FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the - // past. - // * NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the - // request. - rpc DeleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest) returns (google.protobuf.Empty) { + // * FAILED_PRECONDITION: The + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // is active or in the past. + // * NOT_FOUND: No + // [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] + // found for the name in the request. + rpc DeleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=accounts/*/customers/*/customerRepricingConfigs/*}" }; @@ -951,14 +1011,18 @@ service CloudChannelService { // // * PERMISSION_DENIED: If the account making the request and the account // being queried are different. - // * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found. + // * NOT_FOUND: The + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // was not found. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise - // returns an error. - rpc GetChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest) returns (ChannelPartnerRepricingConfig) { + // If successful, the + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // resource, otherwise returns an error. + rpc GetChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest) + returns (ChannelPartnerRepricingConfig) { option (google.api.http) = { get: "/v1/{name=accounts/*/channelPartnerLinks/*/channelPartnerRepricingConfigs/*}" }; @@ -972,20 +1036,25 @@ service CloudChannelService { // // * PERMISSION_DENIED: If the account making the request and the account // being queried are different. - // * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist - // or is not associated with the given account. + // * NOT_FOUND: The + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. - // The data for each resource is displayed in the ascending order of: + // If successful, the + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // resources. The data for each resource is displayed in the ascending order + // of: // * channel partner ID // * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] // * [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time] // // If unsuccessful, returns an error. - rpc ListChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest) returns (ListChannelPartnerRepricingConfigsResponse) { + rpc ListChannelPartnerRepricingConfigs( + ListChannelPartnerRepricingConfigsRequest) + returns (ListChannelPartnerRepricingConfigsResponse) { option (google.api.http) = { get: "/v1/{parent=accounts/*/channelPartnerLinks/*}/channelPartnerRepricingConfigs" }; @@ -994,9 +1063,10 @@ service CloudChannelService { // Creates a ChannelPartnerRepricingConfig. Call this method to set // modifications for a specific ChannelPartner's bill. You can only create - // configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future - // month. If needed, you can create a config for the current month, with some - // restrictions. + // configs if the + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is a future month. If needed, you can create a config for the current + // month, with some restrictions. // // When creating a config for a future month, make sure there are no existing // configs for that @@ -1010,8 +1080,9 @@ service CloudChannelService { // Changes to the config may be immediate, but may take up to 24 hours. // * There is a limit of ten configs for any ChannelPartner or // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. - // * The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] vaule - // must be different from the value used in the current config for a + // * The contained + // [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] + // vaule must be different from the value used in the current config for a // ChannelPartner. // // Possible Error Codes: @@ -1021,20 +1092,25 @@ service CloudChannelService { // * INVALID_ARGUMENT: Missing or invalid required parameters in the // request. Also displays if the updated config is for the current month or // past months. - // * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist - // or is not associated with the given account. + // * NOT_FOUND: The + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, - // otherwise returns an error. - rpc CreateChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest) returns (ChannelPartnerRepricingConfig) { + // If successful, the updated + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // resource, otherwise returns an error. + rpc CreateChannelPartnerRepricingConfig( + CreateChannelPartnerRepricingConfigRequest) + returns (ChannelPartnerRepricingConfig) { option (google.api.http) = { post: "/v1/{parent=accounts/*/channelPartnerLinks/*}/channelPartnerRepricingConfigs" body: "channel_partner_repricing_config" }; - option (google.api.method_signature) = "parent,channel_partner_repricing_config"; + option (google.api.method_signature) = + "parent,channel_partner_repricing_config"; } // Updates a ChannelPartnerRepricingConfig. Call this method to set @@ -1042,10 +1118,11 @@ service CloudChannelService { // the existing CustomerRepricingConfig. // // You can only update configs if the - // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a - // future month. To make changes to configs for the current month, use - // [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. - // You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is a future month. To make changes to configs for the current month, use + // [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], + // taking note of its restrictions. You cannot update the + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. // // When updating a config in the future: // @@ -1058,15 +1135,19 @@ service CloudChannelService { // * INVALID_ARGUMENT: Missing or invalid required parameters in the // request. Also displays if the updated config is for the current month or // past months. - // * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist - // or is not associated with the given account. + // * NOT_FOUND: The + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // specified does not exist or is not associated with the given account. // * INTERNAL: Any non-user error related to technical issues in the // backend. In this case, contact Cloud Channel support. // // Return Value: - // If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, - // otherwise returns an error. - rpc UpdateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest) returns (ChannelPartnerRepricingConfig) { + // If successful, the updated + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // resource, otherwise returns an error. + rpc UpdateChannelPartnerRepricingConfig( + UpdateChannelPartnerRepricingConfigRequest) + returns (ChannelPartnerRepricingConfig) { option (google.api.http) = { patch: "/v1/{channel_partner_repricing_config.name=accounts/*/channelPartnerLinks/*/channelPartnerRepricingConfigs/*}" body: "channel_partner_repricing_config" @@ -1074,20 +1155,26 @@ service CloudChannelService { option (google.api.method_signature) = "channel_partner_repricing_config"; } - // Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can - // only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is - // set to a date after the current month. + // Deletes the given + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // permanently. You can only delete configs if their + // [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] + // is set to a date after the current month. // // Possible error codes: // // * PERMISSION_DENIED: The account making the request does not own // this customer. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. - // * FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or - // in the past. - // * NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the - // request. - rpc DeleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest) returns (google.protobuf.Empty) { + // * FAILED_PRECONDITION: The + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // is active or in the past. + // * NOT_FOUND: No + // [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] + // found for the name in the request. + rpc DeleteChannelPartnerRepricingConfig( + DeleteChannelPartnerRepricingConfigRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=accounts/*/channelPartnerLinks/*/channelPartnerRepricingConfigs/*}" }; @@ -1152,7 +1239,8 @@ service CloudChannelService { // // * PERMISSION_DENIED: The customer doesn't belong to the reseller. // * INVALID_ARGUMENT: Required request parameters are missing or invalid. - rpc ListPurchasableSkus(ListPurchasableSkusRequest) returns (ListPurchasableSkusResponse) { + rpc ListPurchasableSkus(ListPurchasableSkusRequest) + returns (ListPurchasableSkusResponse) { option (google.api.http) = { get: "/v1/{customer=accounts/*/customers/*}:listPurchasableSkus" }; @@ -1167,7 +1255,8 @@ service CloudChannelService { // // * PERMISSION_DENIED: The customer doesn't belong to the reseller // * INVALID_ARGUMENT: Required request parameters are missing or invalid. - rpc ListPurchasableOffers(ListPurchasableOffersRequest) returns (ListPurchasableOffersResponse) { + rpc ListPurchasableOffers(ListPurchasableOffersRequest) + returns (ListPurchasableOffersResponse) { option (google.api.http) = { get: "/v1/{customer=accounts/*/customers/*}:listPurchasableOffers" }; @@ -1175,7 +1264,8 @@ service CloudChannelService { // Registers a service account with subscriber privileges on the Cloud Pub/Sub // topic for this Channel Services account. After you create a - // subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent] + // subscriber, you get the events through + // [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent] // // Possible error codes: // @@ -1190,7 +1280,8 @@ service CloudChannelService { // // Return value: // The topic name with the registered service email address. - rpc RegisterSubscriber(RegisterSubscriberRequest) returns (RegisterSubscriberResponse) { + rpc RegisterSubscriber(RegisterSubscriberRequest) + returns (RegisterSubscriberResponse) { option (google.api.http) = { post: "/v1/{account=accounts/*}:register" body: "*" @@ -1218,7 +1309,8 @@ service CloudChannelService { // The topic name that unregistered the service email address. // Returns a success response if the service email address wasn't registered // with the topic. - rpc UnregisterSubscriber(UnregisterSubscriberRequest) returns (UnregisterSubscriberResponse) { + rpc UnregisterSubscriber(UnregisterSubscriberRequest) + returns (UnregisterSubscriberResponse) { option (google.api.http) = { post: "/v1/{account=accounts/*}:unregister" body: "*" @@ -1242,14 +1334,16 @@ service CloudChannelService { // // Return value: // A list of service email addresses. - rpc ListSubscribers(ListSubscribersRequest) returns (ListSubscribersResponse) { + rpc ListSubscribers(ListSubscribersRequest) + returns (ListSubscribersResponse) { option (google.api.http) = { get: "/v1/{account=accounts/*}:listSubscribers" }; } } -// Request message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist]. +// Request message for +// [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist]. message CheckCloudIdentityAccountsExistRequest { // Required. The reseller account's resource name. // Parent uses the format: accounts/{account_id} @@ -1286,40 +1380,48 @@ message CheckCloudIdentityAccountsExistResponse { repeated CloudIdentityCustomerAccount cloud_identity_accounts = 1; } -// Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] +// Request message for +// [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] message ListCustomersRequest { // Required. The resource name of the reseller account to list customers from. // Parent uses the format: accounts/{account_id}. string parent = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The maximum number of customers to return. The service may return fewer - // than this value. If unspecified, returns at most 10 customers. The + // Optional. The maximum number of customers to return. The service may return + // fewer than this value. If unspecified, returns at most 10 customers. The // maximum value is 50. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token identifying a page of results other than the first page. // Obtained through - // [ListCustomersResponse.next_page_token][google.cloud.channel.v1.ListCustomersResponse.next_page_token] of the previous - // [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] call. + // [ListCustomersResponse.next_page_token][google.cloud.channel.v1.ListCustomersResponse.next_page_token] + // of the previous + // [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] + // call. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See + // Optional. Filters applied to the [CloudChannelService.ListCustomers] + // results. See // https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers // for more information. string filter = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]. +// Response message for +// [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]. message ListCustomersResponse { // The customers belonging to a reseller or distributor. repeated Customer customers = 1; // A token to retrieve the next page of results. - // Pass to [ListCustomersRequest.page_token][google.cloud.channel.v1.ListCustomersRequest.page_token] to obtain that page. + // Pass to + // [ListCustomersRequest.page_token][google.cloud.channel.v1.ListCustomersRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer]. +// Request message for +// [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer]. message GetCustomerRequest { // Required. The resource name of the customer to retrieve. // Name uses the format: accounts/{account_id}/customers/{customer_id} @@ -1331,17 +1433,19 @@ message GetCustomerRequest { ]; } -// Request message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.CloudChannelService.CreateCustomer] +// Request message for +// [CloudChannelService.CreateCustomer][google.cloud.channel.v1.CloudChannelService.CreateCustomer] message CreateCustomerRequest { - // Required. The resource name of reseller account in which to create the customer. - // Parent uses the format: accounts/{account_id} + // Required. The resource name of reseller account in which to create the + // customer. Parent uses the format: accounts/{account_id} string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The customer to create. Customer customer = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer]. +// Request message for +// [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer]. message UpdateCustomerRequest { // Required. New contents of the customer. Customer customer = 2 [(google.api.field_behavior) = REQUIRED]; @@ -1351,7 +1455,8 @@ message UpdateCustomerRequest { google.protobuf.FieldMask update_mask = 3; } -// Request message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer]. +// Request message for +// [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer]. message DeleteCustomerRequest { // Required. The resource name of the customer to delete. string name = 1 [ @@ -1362,7 +1467,8 @@ message DeleteCustomerRequest { ]; } -// Request message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer] +// Request message for +// [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer] message ImportCustomerRequest { // Specifies the identity of the transfer customer. // A customer's cloud_identity_id or domain is required to look up the @@ -1392,9 +1498,10 @@ message ImportCustomerRequest { // conflicting region code or domain. bool overwrite_if_exists = 5 [(google.api.field_behavior) = REQUIRED]; - // Optional. Cloud Identity ID of a channel partner who will be the direct reseller for - // the customer's order. This field is required for 2-tier transfer scenarios - // and can be provided via the request Parent binding as well. + // Optional. Cloud Identity ID of a channel partner who will be the direct + // reseller for the customer's order. This field is required for 2-tier + // transfer scenarios and can be provided via the request Parent binding as + // well. string channel_partner_id = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. Specifies the customer that will receive imported Cloud Identity @@ -1408,7 +1515,8 @@ message ImportCustomerRequest { ]; } -// Request message for [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity] +// Request message for +// [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity] message ProvisionCloudIdentityRequest { // Required. Resource name of the customer. // Format: accounts/{account_id}/customers/{customer_id} @@ -1429,7 +1537,8 @@ message ProvisionCloudIdentityRequest { bool validate_only = 4; } -// Request message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] +// Request message for +// [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] message ListEntitlementsRequest { // Required. The resource name of the reseller's customer account to list // entitlements for. @@ -1441,29 +1550,35 @@ message ListEntitlementsRequest { } ]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, return at most 50 entitlements. - // The maximum value is 100; the server will coerce values above 100. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, return at most 50 entitlements. The maximum + // value is 100; the server will coerce values above 100. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. // Obtained using - // [ListEntitlementsResponse.next_page_token][google.cloud.channel.v1.ListEntitlementsResponse.next_page_token] of the previous - // [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] call. + // [ListEntitlementsResponse.next_page_token][google.cloud.channel.v1.ListEntitlementsResponse.next_page_token] + // of the previous + // [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] + // call. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]. +// Response message for +// [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]. message ListEntitlementsResponse { // The reseller customer's entitlements. repeated Entitlement entitlements = 1; // A token to list the next page of results. - // Pass to [ListEntitlementsRequest.page_token][google.cloud.channel.v1.ListEntitlementsRequest.page_token] to obtain that page. + // Pass to + // [ListEntitlementsRequest.page_token][google.cloud.channel.v1.ListEntitlementsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] +// Request message for +// [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] message ListTransferableSkusRequest { // Specifies the identity of transferred customer. // Either a cloud_identity_id of the customer or the customer name is @@ -1491,16 +1606,17 @@ message ListTransferableSkusRequest { // A token for a page of results other than the first page. // Obtained using - // [ListTransferableSkusResponse.next_page_token][google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token] of the previous - // [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] call. - // Optional. + // [ListTransferableSkusResponse.next_page_token][google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token] + // of the previous + // [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] + // call. Optional. string page_token = 3; - // The super admin of the resold customer generates this token to + // Optional. The super admin of the resold customer generates this token to // authorize a reseller to access their Cloud Identity and purchase // entitlements on their behalf. You can omit this token after authorization. // See https://support.google.com/a/answer/7643790 for more details. - string auth_token = 5; + string auth_token = 5 [(google.api.field_behavior) = OPTIONAL]; // The BCP-47 language code. For example, "en-US". The // response will localize in the corresponding language code, if specified. @@ -1509,18 +1625,21 @@ message ListTransferableSkusRequest { string language_code = 6; } -// Response message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]. +// Response message for +// [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]. message ListTransferableSkusResponse { // Information about existing SKUs for a customer that needs a transfer. repeated TransferableSku transferable_skus = 1; // A token to retrieve the next page of results. - // Pass to [ListTransferableSkusRequest.page_token][google.cloud.channel.v1.ListTransferableSkusRequest.page_token] to obtain - // that page. + // Pass to + // [ListTransferableSkusRequest.page_token][google.cloud.channel.v1.ListTransferableSkusRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] +// Request message for +// [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] message ListTransferableOffersRequest { // Specifies the identity of transferred customer. // Either a cloud_identity_id of the customer or the customer name is @@ -1544,28 +1663,32 @@ message ListTransferableOffersRequest { // A token for a page of results other than the first page. // Obtained using - // [ListTransferableOffersResponse.next_page_token][google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token] of the previous - // [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] call. + // [ListTransferableOffersResponse.next_page_token][google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token] + // of the previous + // [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] + // call. string page_token = 3; // Required. The SKU to look up Offers for. string sku = 6 [(google.api.field_behavior) = REQUIRED]; - // The BCP-47 language code. For example, "en-US". The + // Optional. The BCP-47 language code. For example, "en-US". The // response will localize in the corresponding language code, if specified. // The default value is "en-US". - string language_code = 7; + string language_code = 7 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]. +// Response message for +// [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]. message ListTransferableOffersResponse { // Information about Offers for a customer that can be used for // transfer. repeated TransferableOffer transferable_offers = 1; // A token to retrieve the next page of results. - // Pass to [ListTransferableOffersRequest.page_token][google.cloud.channel.v1.ListTransferableOffersRequest.page_token] to obtain - // that page. + // Pass to + // [ListTransferableOffersRequest.page_token][google.cloud.channel.v1.ListTransferableOffersRequest.page_token] + // to obtain that page. string next_page_token = 2; } @@ -1576,7 +1699,8 @@ message TransferableOffer { Offer offer = 1; } -// Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement]. +// Request message for +// [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement]. message GetEntitlementRequest { // Required. The resource name of the entitlement to retrieve. // Name uses the format: @@ -1589,39 +1713,45 @@ message GetEntitlementRequest { ]; } -// Request message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] +// Request message for +// [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] message ListChannelPartnerLinksRequest { - // Required. The resource name of the reseller account for listing channel partner - // links. - // Parent uses the format: accounts/{account_id} + // Required. The resource name of the reseller account for listing channel + // partner links. Parent uses the format: accounts/{account_id} string parent = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, server will pick a default size (25). - // The maximum value is 200; the server will coerce values above 200. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, server will pick a default size (25). The + // maximum value is 200; the server will coerce values above 200. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. // Obtained using - // [ListChannelPartnerLinksResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token] of the previous - // [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] call. + // [ListChannelPartnerLinksResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token] + // of the previous + // [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] + // call. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The level of granularity the ChannelPartnerLink will display. ChannelPartnerLinkView view = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]. +// Response message for +// [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]. message ListChannelPartnerLinksResponse { // The Channel partner links for a reseller. repeated ChannelPartnerLink channel_partner_links = 1; // A token to retrieve the next page of results. - // Pass to [ListChannelPartnerLinksRequest.page_token][google.cloud.channel.v1.ListChannelPartnerLinksRequest.page_token] to obtain that page. + // Pass to + // [ListChannelPartnerLinksRequest.page_token][google.cloud.channel.v1.ListChannelPartnerLinksRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink]. +// Request message for +// [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink]. message GetChannelPartnerLinkRequest { // Required. The resource name of the channel partner link to retrieve. // Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} @@ -1632,7 +1762,8 @@ message GetChannelPartnerLinkRequest { ChannelPartnerLinkView view = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink] +// Request message for +// [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink] message CreateChannelPartnerLinkRequest { // Required. Create a channel partner link for the provided reseller account's // resource name. @@ -1642,27 +1773,32 @@ message CreateChannelPartnerLinkRequest { // Required. The channel partner link to create. // Either channel_partner_link.reseller_cloud_identity_id or domain can be // used to create a link. - ChannelPartnerLink channel_partner_link = 2 [(google.api.field_behavior) = REQUIRED]; + ChannelPartnerLink channel_partner_link = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink] +// Request message for +// [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink] message UpdateChannelPartnerLinkRequest { // Required. The resource name of the channel partner link to cancel. // Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} // where {id} is the Cloud Identity ID of the partner. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The channel partner link to update. Only channel_partner_link.link_state - // is allowed for updates. - ChannelPartnerLink channel_partner_link = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The channel partner link to update. Only + // channel_partner_link.link_state is allowed for updates. + ChannelPartnerLink channel_partner_link = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The update mask that applies to the resource. // The only allowable value for an update mask is // channel_partner_link.link_state. - google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 3 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [CloudChannelService.GetCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig]. +// Request message for +// [CloudChannelService.GetCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig]. message GetCustomerRepricingConfigRequest { // Required. The resource name of the CustomerRepricingConfig. // Format: @@ -1675,7 +1811,8 @@ message GetCustomerRepricingConfigRequest { ]; } -// Request message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs]. +// Request message for +// [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs]. message ListCustomerRepricingConfigsRequest { // Required. The resource name of the customer. // Parent uses the format: accounts/{account_id}/customers/{customer_id}. @@ -1688,15 +1825,17 @@ message ListCustomerRepricingConfigsRequest { } ]; - // Optional. The maximum number of repricing configs to return. The service may return - // fewer than this value. If unspecified, returns a maximum of 50 rules. The - // maximum value is 100; values above 100 will be coerced to 100. + // Optional. The maximum number of repricing configs to return. The service + // may return fewer than this value. If unspecified, returns a maximum of 50 + // rules. The maximum value is 100; values above 100 will be coerced to 100. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token identifying a page of results beyond the first page. // Obtained through - // [ListCustomerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token] of the previous - // [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs] call. + // [ListCustomerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token] + // of the previous + // [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs] + // call. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] @@ -1709,21 +1848,25 @@ message ListCustomerRepricingConfigsRequest { string filter = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs]. +// Response message for +// [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs]. message ListCustomerRepricingConfigsResponse { // The repricing configs for this channel partner. repeated CustomerRepricingConfig customer_repricing_configs = 1; // A token to retrieve the next page of results. - // Pass to [ListCustomerRepricingConfigsRequest.page_token][google.cloud.channel.v1.ListCustomerRepricingConfigsRequest.page_token] to obtain that - // page. + // Pass to + // [ListCustomerRepricingConfigsRequest.page_token][google.cloud.channel.v1.ListCustomerRepricingConfigsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [CloudChannelService.CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig]. +// Request message for +// [CloudChannelService.CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig]. message CreateCustomerRepricingConfigRequest { - // Required. The resource name of the customer that will receive this repricing config. - // Parent uses the format: accounts/{account_id}/customers/{customer_id} + // Required. The resource name of the customer that will receive this + // repricing config. Parent uses the format: + // accounts/{account_id}/customers/{customer_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1732,19 +1875,23 @@ message CreateCustomerRepricingConfigRequest { ]; // Required. The CustomerRepricingConfig object to update. - CustomerRepricingConfig customer_repricing_config = 2 [(google.api.field_behavior) = REQUIRED]; + CustomerRepricingConfig customer_repricing_config = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [CloudChannelService.UpdateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig]. +// Request message for +// [CloudChannelService.UpdateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig]. message UpdateCustomerRepricingConfigRequest { // Required. The CustomerRepricingConfig object to update. - CustomerRepricingConfig customer_repricing_config = 1 [(google.api.field_behavior) = REQUIRED]; + CustomerRepricingConfig customer_repricing_config = 1 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [CloudChannelService.DeleteCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig]. +// Request message for +// [CloudChannelService.DeleteCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig]. message DeleteCustomerRepricingConfigRequest { - // Required. The resource name of the customer repricing config rule to delete. - // Format: + // Required. The resource name of the customer repricing config rule to + // delete. Format: // accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1754,7 +1901,8 @@ message DeleteCustomerRepricingConfigRequest { ]; } -// Request message for [CloudChannelService.GetChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig] +// Request message for +// [CloudChannelService.GetChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig] message GetChannelPartnerRepricingConfigRequest { // Required. The resource name of the ChannelPartnerRepricingConfig // Format: @@ -1770,8 +1918,9 @@ message GetChannelPartnerRepricingConfigRequest { // Request message for // [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs]. message ListChannelPartnerRepricingConfigsRequest { - // Required. The resource name of the account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. - // Parent uses the format: + // Required. The resource name of the account's + // [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent + // uses the format: // accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. // Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs // for all channel partners. @@ -1782,21 +1931,23 @@ message ListChannelPartnerRepricingConfigsRequest { } ]; - // Optional. The maximum number of repricing configs to return. The service may return - // fewer than this value. If unspecified, returns a maximum of 50 rules. The - // maximum value is 100; values above 100 will be coerced to 100. + // Optional. The maximum number of repricing configs to return. The service + // may return fewer than this value. If unspecified, returns a maximum of 50 + // rules. The maximum value is 100; values above 100 will be coerced to 100. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token identifying a page of results beyond the first page. // Obtained through - // [ListChannelPartnerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token] of the - // previous [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs] call. + // [ListChannelPartnerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token] + // of the previous + // [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs] + // call. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] - // results (channel_partner_link only). You can use this filter when you - // support a BatchGet-like query. - // To use the filter, you must set + // Optional. A filter for + // [CloudChannelService.ListChannelPartnerRepricingConfigs] results + // (channel_partner_link only). You can use this filter when you support a + // BatchGet-like query. To use the filter, you must set // `parent=accounts/{account_id}/channelPartnerLinks/-`. // // Example: `channel_partner_link = @@ -1812,16 +1963,17 @@ message ListChannelPartnerRepricingConfigsResponse { repeated ChannelPartnerRepricingConfig channel_partner_repricing_configs = 1; // A token to retrieve the next page of results. - // Pass to [ListChannelPartnerRepricingConfigsRequest.page_token][google.cloud.channel.v1.ListChannelPartnerRepricingConfigsRequest.page_token] to obtain - // that page. + // Pass to + // [ListChannelPartnerRepricingConfigsRequest.page_token][google.cloud.channel.v1.ListChannelPartnerRepricingConfigsRequest.page_token] + // to obtain that page. string next_page_token = 2; } // Request message for // [CloudChannelService.CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig]. message CreateChannelPartnerRepricingConfigRequest { - // Required. The resource name of the ChannelPartner that will receive the repricing - // config. Parent uses the format: + // Required. The resource name of the ChannelPartner that will receive the + // repricing config. Parent uses the format: // accounts/{account_id}/channelPartnerLinks/{channel_partner_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1831,19 +1983,22 @@ message CreateChannelPartnerRepricingConfigRequest { ]; // Required. The ChannelPartnerRepricingConfig object to update. - ChannelPartnerRepricingConfig channel_partner_repricing_config = 2 [(google.api.field_behavior) = REQUIRED]; + ChannelPartnerRepricingConfig channel_partner_repricing_config = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for // [CloudChannelService.UpdateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig]. message UpdateChannelPartnerRepricingConfigRequest { // Required. The ChannelPartnerRepricingConfig object to update. - ChannelPartnerRepricingConfig channel_partner_repricing_config = 1 [(google.api.field_behavior) = REQUIRED]; + ChannelPartnerRepricingConfig channel_partner_repricing_config = 1 + [(google.api.field_behavior) = REQUIRED]; } // Request message for DeleteChannelPartnerRepricingConfig. message DeleteChannelPartnerRepricingConfigRequest { - // Required. The resource name of the channel partner repricing config rule to delete. + // Required. The resource name of the channel partner repricing config rule to + // delete. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1852,11 +2007,12 @@ message DeleteChannelPartnerRepricingConfigRequest { ]; } -// Request message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement] +// Request message for +// [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement] message CreateEntitlementRequest { - // Required. The resource name of the reseller's customer account in which to create the - // entitlement. - // Parent uses the format: accounts/{account_id}/customers/{customer_id} + // Required. The resource name of the reseller's customer account in which to + // create the entitlement. Parent uses the format: + // accounts/{account_id}/customers/{customer_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1867,8 +2023,9 @@ message CreateEntitlementRequest { // Required. The entitlement to create. Entitlement entitlement = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -1881,15 +2038,17 @@ message CreateEntitlementRequest { string request_id = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. +// Request message for +// [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. message TransferEntitlementsRequest { - // Required. The resource name of the reseller's customer account that will receive - // transferred entitlements. - // Parent uses the format: accounts/{account_id}/customers/{customer_id} + // Required. The resource name of the reseller's customer account that will + // receive transferred entitlements. Parent uses the format: + // accounts/{account_id}/customers/{customer_id} string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The new entitlements to create or transfer. - repeated Entitlement entitlements = 2 [(google.api.field_behavior) = REQUIRED]; + repeated Entitlement entitlements = 2 + [(google.api.field_behavior) = REQUIRED]; // The super admin of the resold customer generates this token to // authorize a reseller to access their Cloud Identity and purchase @@ -1897,8 +2056,9 @@ message TransferEntitlementsRequest { // See https://support.google.com/a/answer/7643790 for more details. string auth_token = 4; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -1911,25 +2071,29 @@ message TransferEntitlementsRequest { string request_id = 6 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. +// Response message for +// [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. // This is put in the response field of google.longrunning.Operation. message TransferEntitlementsResponse { // The transferred entitlements. repeated Entitlement entitlements = 1; } -// Request message for [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle]. +// Request message for +// [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle]. message TransferEntitlementsToGoogleRequest { - // Required. The resource name of the reseller's customer account where the entitlements - // transfer from. - // Parent uses the format: accounts/{account_id}/customers/{customer_id} + // Required. The resource name of the reseller's customer account where the + // entitlements transfer from. Parent uses the format: + // accounts/{account_id}/customers/{customer_id} string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The entitlements to transfer to Google. - repeated Entitlement entitlements = 2 [(google.api.field_behavior) = REQUIRED]; + repeated Entitlement entitlements = 2 + [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -1949,14 +2113,17 @@ message ChangeParametersRequest { // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Entitlement parameters to update. You can only change editable parameters. + // Required. Entitlement parameters to update. You can only change editable + // parameters. // // To view the available Parameters for a request, refer to the - // [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] from the desired offer. + // [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] + // from the desired offer. repeated Parameter parameters = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -1972,7 +2139,8 @@ message ChangeParametersRequest { string purchase_order_id = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings]. +// Request message for +// [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings]. message ChangeRenewalSettingsRequest { // Required. The name of the entitlement to update. // Name uses the format: @@ -1982,8 +2150,9 @@ message ChangeRenewalSettingsRequest { // Required. New renewal settings. RenewalSettings renewal_settings = 4 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -1996,7 +2165,8 @@ message ChangeRenewalSettingsRequest { string request_id = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer]. +// Request message for +// [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer]. message ChangeOfferRequest { // Required. The resource name of the entitlement to update. // Name uses the format: @@ -2012,15 +2182,18 @@ message ChangeOfferRequest { } ]; - // Optional. Parameters needed to purchase the Offer. To view the available Parameters - // refer to the [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] from the desired offer. + // Optional. Parameters needed to purchase the Offer. To view the available + // Parameters refer to the + // [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] + // from the desired offer. repeated Parameter parameters = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Purchase order id provided by the reseller. string purchase_order_id = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -2033,15 +2206,17 @@ message ChangeOfferRequest { string request_id = 6 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.CloudChannelService.StartPaidService]. +// Request message for +// [CloudChannelService.StartPaidService][google.cloud.channel.v1.CloudChannelService.StartPaidService]. message StartPaidServiceRequest { // Required. The name of the entitlement to start a paid service for. // Name uses the format: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -2054,15 +2229,17 @@ message StartPaidServiceRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement]. +// Request message for +// [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement]. message CancelEntitlementRequest { // Required. The resource name of the entitlement to cancel. // Name uses the format: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -2075,15 +2252,17 @@ message CancelEntitlementRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement]. +// Request message for +// [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement]. message SuspendEntitlementRequest { // Required. The resource name of the entitlement to suspend. // Name uses the format: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -2096,15 +2275,17 @@ message SuspendEntitlementRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement]. +// Request message for +// [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement]. message ActivateEntitlementRequest { // Required. The resource name of the entitlement to activate. // Name uses the format: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. You can specify an optional unique request ID, and if you need to retry - // your request, the server will know to ignore the request if it's complete. + // Optional. You can specify an optional unique request ID, and if you need to + // retry your request, the server will know to ignore the request if it's + // complete. // // For example, you make an initial request and the request times out. If you // make the request again with the same request ID, the server can check if @@ -2136,9 +2317,9 @@ message ListProductsRequest { // Format: accounts/{account_id}. string account = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, returns at most 100 Products. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, returns at most 100 Products. The maximum value + // is 1000; the server will coerce values above 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. @@ -2175,9 +2356,9 @@ message ListSkusRequest { // Format: accounts/{account_id}. string account = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, returns at most 100 SKUs. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, returns at most 100 SKUs. The maximum value is + // 1000; the server will coerce values above 1000. int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. @@ -2201,13 +2382,13 @@ message ListSkusResponse { // Request message for ListOffers. message ListOffersRequest { - // Required. The resource name of the reseller account from which to list Offers. - // Parent uses the format: accounts/{account_id}. + // Required. The resource name of the reseller account from which to list + // Offers. Parent uses the format: accounts/{account_id}. string parent = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, returns at most 500 Offers. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, returns at most 500 Offers. The maximum value is + // 1000; the server will coerce values above 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. @@ -2247,7 +2428,8 @@ message ListPurchasableSkusRequest { } // List SKUs for upgrading or downgrading an entitlement. Make the purchase - // using [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer]. + // using + // [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer]. message ChangeOfferPurchase { // Change Type enum. enum ChangeType { @@ -2288,9 +2470,9 @@ message ListPurchasableSkusRequest { } ]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, returns at most 100 SKUs. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, returns at most 100 SKUs. The maximum value is + // 1000; the server will coerce values above 1000. int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. @@ -2358,9 +2540,9 @@ message ListPurchasableOffersRequest { } ]; - // Optional. Requested page size. Server might return fewer results than requested. - // If unspecified, returns at most 100 Offers. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. Requested page size. Server might return fewer results than + // requested. If unspecified, returns at most 100 Offers. The maximum value is + // 1000; the server will coerce values above 1000. int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. A token for a page of results other than the first page. @@ -2393,7 +2575,8 @@ message RegisterSubscriberRequest { // Required. Resource name of the account. string account = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Service account that provides subscriber access to the registered topic. + // Required. Service account that provides subscriber access to the registered + // topic. string service_account = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -2408,7 +2591,8 @@ message UnregisterSubscriberRequest { // Required. Resource name of the account. string account = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Service account to unregister from subscriber access to the topic. + // Required. Service account to unregister from subscriber access to the + // topic. string service_account = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -2423,10 +2607,10 @@ message ListSubscribersRequest { // Required. Resource name of the account. string account = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The maximum number of service accounts to return. The service may return - // fewer than this value. - // If unspecified, returns at most 100 service accounts. - // The maximum value is 1000; the server will coerce values above 1000. + // Optional. The maximum number of service accounts to return. The service may + // return fewer than this value. If unspecified, returns at most 100 service + // accounts. The maximum value is 1000; the server will coerce values above + // 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A page token, received from a previous `ListSubscribers` call. @@ -2448,4 +2632,4 @@ message ListSubscribersResponse { // A token that 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 = 3; -} +} \ No newline at end of file diff --git a/google/cloud/channel/v1/subscriber_event.proto b/google/cloud/channel/v1/subscriber_event.proto index 3c67216ed..0135c066f 100644 --- a/google/cloud/channel/v1/subscriber_event.proto +++ b/google/cloud/channel/v1/subscriber_event.proto @@ -40,8 +40,8 @@ message CustomerEvent { // Resource name of the customer. // Format: accounts/{account_id}/customers/{customer_id} string customer = 1 [(google.api.resource_reference) = { - type: "cloudchannel.googleapis.com/Customer" - }]; + type: "cloudchannel.googleapis.com/Customer" + }]; // Type of event which happened on the customer. Type event_type = 2; @@ -97,8 +97,8 @@ message EntitlementEvent { // Resource name of an entitlement of the form: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} string entitlement = 1 [(google.api.resource_reference) = { - type: "cloudchannel.googleapis.com/Entitlement" - }]; + type: "cloudchannel.googleapis.com/Entitlement" + }]; // Type of event which happened on the entitlement. Type event_type = 2; @@ -116,4 +116,4 @@ message SubscriberEvent { // Entitlement event sent as part of Pub/Sub event to partners. EntitlementEvent entitlement_event = 2; } -} +} \ No newline at end of file diff --git a/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto b/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto index ebefd3010..8d4f95e97 100644 --- a/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto +++ b/google/cloud/clouddms/logging/v1/clouddms_platform_logs.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. @@ -42,6 +42,12 @@ enum DatabaseEngine { // The source engine is SQL Server. SQLSERVER = 3; + + // The source engine is Oracle (for heterogeneous migrations). + ORACLE = 4; + + // The engine is Spanner (for heterogeneous migrations). + SPANNER = 5; } // The database providers. @@ -54,6 +60,12 @@ enum DatabaseProvider { // RDS runs the database. RDS = 2; + + // Amazon Aurora. + AURORA = 3; + + // AlloyDB. + ALLOYDB = 4; } // A message defining the database engine and provider. @@ -277,8 +289,29 @@ message CloudSqlConnectionProfile { string cloud_sql_id = 1; } +// An Oracle connection profile. +message OracleConnectionProfile { + // Connectivity options used to establish a connection to the profile. + enum ConnectivityType { + // No data defined. + CONNECTIVITY_TYPE_UNSPECIFIED = 0; + + // Static Service IP connectivity. + STATIC_SERVICE_IP = 1; + + // Forward SSH tunnel connectivity. + FORWARD_SSH_TUNNEL = 2; + + // Private connectivity. + PRIVATE_CONNECTIVITY = 3; + } + + // Required. Type of connectivity to source database. + ConnectivityType connectivity_type = 1 [(google.api.field_behavior) = REQUIRED]; +} + // An producer connection profile definition. -// NEXT_TAG = 18. +// NEXT_TAG = 8. message LoggedConnectionProfile { // The connection profile states enum. enum State { @@ -329,6 +362,9 @@ message LoggedConnectionProfile { // A CloudSQL database connection profile. CloudSqlConnectionProfile cloudsql = 102; + + // An Oracle database connection profile. + OracleConnectionProfile oracle = 103; } // The error details in case of state FAILED. @@ -385,3 +421,83 @@ message ConnectionProfileEventLog { string original_message = 201; } } + +// The PrivateConnection resource is used to establish private connectivity +// with the customer's network. +message LoggedPrivateConnection { + // Private Connection state. + enum State { + // Unspecified state. + STATE_UNSPECIFIED = 0; + + // The private connection is in creation state - creating resources. + CREATING = 1; + + // The private connection has been created with all of its resources. + CREATED = 2; + + // The private connection creation has failed. + FAILED = 3; + + // The private connection is being deleted. + DELETING = 4; + + // Delete request has failed, resource is in invalid state. + FAILED_TO_DELETE = 5; + + // The private connection has been deleted. + DELETED = 6; + } + + // The resource's name. + string name = 1; + + // Labels. + map labels = 2; + + // Display name. + string display_name = 3; + + // The state of the Private Connection. + State state = 4; + + // The error details in case of state FAILED. + google.rpc.Status error = 5; + + // VPC Peering Config. + VpcPeeringConfig vpc_peering_config = 100; +} + +// The VPC Peering configuration is used to create VPC peering between +// the data plane and the consumer's VPC. +message VpcPeeringConfig { + // Fully qualified name of the VPC DMS will peer to. + string vpc_name = 1; + + // The subnet that will be peered to. (CIDR of /29). + string subnet = 2; +} + +// Log definition for a Private Connection event. +message PrivateConnectionEventLog { + // The private connection resource. + LoggedPrivateConnection private_connection = 1; + + // Timestamp of the event. + google.protobuf.Timestamp occurrence_timestamp = 2; + + // Event code. + int32 code = 3; + + // Event message. + string text_message = 4; + + // Original event data. + oneof original_cause { + // Original event code. + int32 original_code = 200; + + // Original event message. + string original_message = 201; + } +} diff --git a/google/cloud/clouddms/v1/BUILD.bazel b/google/cloud/clouddms/v1/BUILD.bazel index c20f7bb9b..e0c04b5d7 100644 --- a/google/cloud/clouddms/v1/BUILD.bazel +++ b/google/cloud/clouddms/v1/BUILD.bazel @@ -73,9 +73,11 @@ java_gapic_library( name = "clouddms_java_gapic", srcs = [":clouddms_proto_with_info"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":clouddms_java_grpc", ], + transport = "grpc", deps = [ ":clouddms_java_proto", ], @@ -93,6 +95,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-clouddms-v1-java", include_samples = True, + transport = "grpc", deps = [ ":clouddms_java_gapic", ":clouddms_java_grpc", @@ -130,12 +133,14 @@ go_gapic_library( grpc_service_config = "library_grpc_service_config.json", importpath = "cloud.google.com/go/clouddms/apiv1;clouddms", metadata = True, + rest_numeric_enums = True, service_yaml = "datamigration_v1.yaml", + transport = "grpc", deps = [ ":clouddms_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -173,6 +178,7 @@ py_gapic_library( srcs = [":clouddms_proto"], grpc_service_config = "library_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-dms"], + rest_numeric_enums = True, transport = "grpc", ) @@ -220,7 +226,9 @@ php_gapic_library( name = "clouddms_php_gapic", srcs = [":clouddms_proto_with_info"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datamigration_v1.yaml", + transport = "grpc+rest", deps = [ ":clouddms_php_grpc", ":clouddms_php_proto", @@ -253,7 +261,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "library_grpc_service_config.json", package = "google.cloud.clouddms.v1", + rest_numeric_enums = True, service_yaml = "datamigration_v1.yaml", + transport = "grpc", deps = [], ) @@ -300,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-namespace-override=CloudDms=CloudDMS", ], grpc_service_config = "library_grpc_service_config.json", + 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", deps = [ @@ -345,6 +356,7 @@ csharp_gapic_library( srcs = [":clouddms_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datamigration_v1.yaml", deps = [ ":clouddms_csharp_grpc", diff --git a/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel b/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel index 748ccc977..fbd392ecf 100644 --- a/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel +++ b/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":procurement_proto_with_info"], gapic_yaml = None, grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", test_deps = [ ":procurement_java_grpc", @@ -131,13 +132,14 @@ go_gapic_library( grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", importpath = "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1;procurement", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", transport = "grpc+rest", deps = [ ":procurement_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -173,6 +175,7 @@ py_gapic_library( name = "procurement_py_gapic", srcs = [":procurement_proto"], grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( name = "procurement_php_gapic", srcs = [":procurement_proto_with_info"], grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", + transport = "grpc+rest", deps = [ ":procurement_php_grpc", ":procurement_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", package = "google.cloud.commerce.consumer.procurement.v1alpha1", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-consumer-procurement-v1alpha1", ], grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", deps = [ ":procurement_ruby_grpc", @@ -339,6 +347,7 @@ csharp_gapic_library( srcs = [":procurement_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml", deps = [ ":procurement_csharp_grpc", diff --git a/google/cloud/common/BUILD.bazel b/google/cloud/common/BUILD.bazel index 155fec6e1..da4653ee9 100644 --- a/google/cloud/common/BUILD.bazel +++ b/google/cloud/common/BUILD.bazel @@ -96,6 +96,7 @@ load( py_gapic_library( name = "common_py_gapic", srcs = [":common_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/compute/v1/compute.proto b/google/cloud/compute/v1/compute.proto index 2e8c66642..04d01834a 100644 --- a/google/cloud/compute/v1/compute.proto +++ b/google/cloud/compute/v1/compute.proto @@ -14,7 +14,7 @@ // Generated by the disco-to-proto3-converter. DO NOT EDIT! // Source Discovery file: compute.v1.json -// Source file revision: 20220831 +// Source file revision: 20221126 // API name: compute // API version: v1 @@ -706,6 +706,19 @@ message Address { } + // 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. + enum Ipv6EndpointType { + // A value indicating that the enum field is not set. + UNDEFINED_IPV6_ENDPOINT_TYPE = 0; + + // Reserved IPv6 address can be used on network load balancer. + NETLB = 74173363; + + // Reserved IPv6 address can be used on VM. + VM = 2743; + + } + // 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. enum NetworkTier { // A value indicating that the enum field is not set. @@ -792,6 +805,10 @@ message Address { // Check the IpVersion enum for the list of possible values. optional string ip_version = 294959552; + // 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. + // Check the Ipv6EndpointType enum for the list of possible values. + optional string ipv6_endpoint_type = 97501004; + // [Output Only] Type of the resource. Always compute#address for addresses. optional string kind = 3292052; @@ -1253,6 +1270,31 @@ message AggregatedListMachineTypesRequest { } +// A request message for NetworkAttachments.AggregatedList. See the method description for details. +message AggregatedListNetworkAttachmentsRequest { + // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + optional string filter = 336120696; + + // 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. + optional bool include_all_scopes = 391327988; + + // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + optional uint32 max_results = 54715419; + + // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + optional string order_by = 160562920; + + // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + optional string page_token = 19994697; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + optional bool return_partial_success = 517198390; + +} + // A request message for NetworkEdgeSecurityServices.AggregatedList. See the method description for details. message AggregatedListNetworkEdgeSecurityServicesRequest { // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. @@ -1753,6 +1795,31 @@ message AggregatedListTargetPoolsRequest { } +// A request message for TargetTcpProxies.AggregatedList. See the method description for details. +message AggregatedListTargetTcpProxiesRequest { + // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + optional string filter = 336120696; + + // 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. + optional bool include_all_scopes = 391327988; + + // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + optional uint32 max_results = 54715419; + + // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + optional string order_by = 160562920; + + // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + optional string page_token = 19994697; + + // Name of the project scoping this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + optional bool return_partial_success = 517198390; + +} + // A request message for TargetVpnGateways.AggregatedList. See the method description for details. message AggregatedListTargetVpnGatewaysRequest { // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. @@ -2203,7 +2270,7 @@ message AttachedDiskInitializeParams { // 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. optional int64 disk_size_gb = 316263735; - // 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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. + // 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. optional string disk_type = 93009052; // Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. @@ -2228,7 +2295,7 @@ message AttachedDiskInitializeParams { // 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. optional string source_image = 50443319; - // The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. + // 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. optional CustomerEncryptionKey source_image_encryption_key = 381503659; // 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. @@ -2686,7 +2753,7 @@ message Backend { // Check the BalancingMode enum for the list of possible values. optional string balancing_mode = 430286217; - // 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. + // 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. optional float capacity_scaler = 315958157; // An optional description of this resource. Provide this property when you create the resource. @@ -3091,7 +3158,7 @@ message BackendService { // 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. optional string network = 232872494; - // 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, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. 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. + // 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. optional OutlierDetection outlier_detection = 354625086; // 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. @@ -4174,7 +4241,7 @@ message CorsPolicy { // Specifies the content for the Access-Control-Allow-Methods header. repeated string allow_methods = 205405372; - // 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. + // 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. repeated string allow_origin_regexes = 215385810; // 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. @@ -4849,6 +4916,28 @@ message DeleteMachineImageRequest { } +// A request message for NetworkAttachments.Delete. See the method description for details. +message DeleteNetworkAttachmentRequest { + // Name of the NetworkAttachment resource to delete. + string network_attachment = 224644052 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "project" + ]; + + // Name of the region of this request. + string region = 138946292 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "region" + ]; + + // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 + optional string request_id = 37109963; + +} + // A request message for NetworkEdgeSecurityServices.Delete. See the method description for details. message DeleteNetworkEdgeSecurityServiceRequest { // Name of the network edge security service to delete. @@ -6567,6 +6656,8 @@ message ErrorDetails { optional LocalizedMessage localized_message = 404537155; + optional QuotaExceededInfo quota_info = 93923861; + } // 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" } } @@ -6577,7 +6668,7 @@ message ErrorInfo { // 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. map metadatas = 8514340; - // 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-Z0-9_]+/. + // 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. optional string reason = 138777156; } @@ -6958,7 +7049,7 @@ message FirewallPolicy { // [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies optional string kind = 3292052; - // Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by GCP which uniquely identifies the Organization Firewall Policy. + // 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. optional string name = 3373707; // [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. @@ -7236,14 +7327,14 @@ message ForwardingRule { } - // 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` * 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. + // 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. optional string I_p_address = 42976943; // 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). // Check the IPProtocolEnum enum for the list of possible values. optional string I_p_protocol = 488094525; - // This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. + // 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. optional bool all_ports = 445175796; // 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. @@ -7300,10 +7391,10 @@ message ForwardingRule { // 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. optional bool no_automate_dns_zone = 64546991; - // This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications). @pattern: \\d+(?:-\\d+)? + // 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+)? optional string port_range = 217518079; - // The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the [specified list of ports]((https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)? + // 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+)? repeated string ports = 106854418; // [Output Only] The PSC connection id of the PSC Forwarding Rule. @@ -7331,6 +7422,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. optional string target = 192835985; } @@ -7413,18 +7505,18 @@ message ForwardingRulesScopedList { // message GRPCHealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, gRPC health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -7432,13 +7524,13 @@ message GRPCHealthCheck { // 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. optional string grpc_service_name = 136533078; - // The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, gRPC health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -7912,6 +8004,22 @@ message GetIamPolicyMachineImageRequest { } +// A request message for NetworkAttachments.GetIamPolicy. See the method description for details. +message GetIamPolicyNetworkAttachmentRequest { + // Requested IAM Policy version. + optional int32 options_requested_policy_version = 499220029; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // The name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + + // Name or id of the resource for this request. + string resource = 195806222 [(google.api.field_behavior) = REQUIRED]; + +} + // A request message for NetworkFirewallPolicies.GetIamPolicy. See the method description for details. message GetIamPolicyNetworkFirewallPolicyRequest { // Requested IAM Policy version. @@ -8258,6 +8366,19 @@ message GetNatMappingInfoRoutersRequest { } +// A request message for NetworkAttachments.Get. See the method description for details. +message GetNetworkAttachmentRequest { + // Name of the NetworkAttachment resource to return. + string network_attachment = 224644052 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Name of the region of this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + +} + // A request message for NetworkEdgeSecurityServices.Get. See the method description for details. message GetNetworkEdgeSecurityServiceRequest { // Name of the network edge security service to get. @@ -9201,18 +9322,18 @@ message GuestOsFeature { // message HTTP2HealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -9228,16 +9349,16 @@ message HTTP2HealthCheck { } - // The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + // 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 optional string host = 3208616; - // The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -9248,25 +9369,25 @@ message HTTP2HealthCheck { // The request path of the HTTP/2 health check request. The default value is /. optional string request_path = 229403605; - // The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + // 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 optional string response = 196547649; } // message HTTPHealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -9282,16 +9403,16 @@ message HTTPHealthCheck { } - // The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + // 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 optional string host = 3208616; - // The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -9302,25 +9423,25 @@ message HTTPHealthCheck { // The request path of the HTTP health check request. The default value is /. optional string request_path = 229403605; - // The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + // 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 optional string response = 196547649; } // message HTTPSHealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -9336,16 +9457,16 @@ message HTTPSHealthCheck { } - // The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + // 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 optional string host = 3208616; - // The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -9356,7 +9477,7 @@ message HTTPSHealthCheck { // The request path of the HTTPS health check request. The default value is /. optional string request_path = 229403605; - // The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + // 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 optional string response = 196547649; } @@ -9475,7 +9596,7 @@ message HealthCheckReference { // Represents a Health-Check as a Service resource. message HealthCheckService { - // 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. . + // 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 HealthStatusAggregationPolicy { // A value indicating that the enum field is not set. UNDEFINED_HEALTH_STATUS_AGGREGATION_POLICY = 0; @@ -9497,10 +9618,10 @@ message HealthCheckService { // 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. optional string fingerprint = 234678500; - // A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. 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 NEGs. + // 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. repeated string health_checks = 448370606; - // 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. . + // 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. // Check the HealthStatusAggregationPolicy enum for the list of possible values. optional string health_status_aggregation_policy = 253163129; @@ -9513,7 +9634,7 @@ message HealthCheckService { // 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. optional string name = 3373707; - // 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. + // 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. repeated string network_endpoint_groups = 29346733; // 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. @@ -9783,7 +9904,7 @@ message HttpHeaderMatch { // 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. optional Int64RangeMatch range_match = 97244227; - // 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. regexMatch only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. + // 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. optional string regex_match = 107387853; // 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. @@ -9815,7 +9936,7 @@ message HttpQueryParameterMatch { // 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. optional bool present_match = 67435841; - // 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. regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + // 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. optional string regex_match = 107387853; } @@ -9951,7 +10072,7 @@ message HttpRouteRuleMatch { // 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. repeated HttpQueryParameterMatch query_parameter_matches = 286231270; - // 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. regexMatch only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. + // 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. optional string regex_match = 107387853; } @@ -10582,6 +10703,28 @@ message InsertMachineImageRequest { } +// A request message for NetworkAttachments.Insert. See the method description for details. +message InsertNetworkAttachmentRequest { + // The body resource for this request + NetworkAttachment network_attachment_resource = 210974745 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "project" + ]; + + // Name of the region of this request. + string region = 138946292 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "region" + ]; + + // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 + optional string request_id = 37109963; + +} + // A request message for NetworkEdgeSecurityServices.Insert. See the method description for details. message InsertNetworkEdgeSecurityServiceRequest { // The body resource for this request @@ -11708,6 +11851,9 @@ message Instance { // Resource policies applied to this instance. repeated string resource_policies = 22220385; + // [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. + optional ResourceStatus resource_status = 249429315; + // [Output Only] Reserved for future use. optional bool satisfies_pzs = 480964267; @@ -11891,6 +12037,19 @@ message InstanceGroupList { // 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. message InstanceGroupManager { + // Pagination behavior of the listManagedInstances API method for this managed instance group. + enum ListManagedInstancesResults { + // A value indicating that the enum field is not set. + UNDEFINED_LIST_MANAGED_INSTANCES_RESULTS = 0; + + // (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. + PAGELESS = 32183464; + + // Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected. + PAGINATED = 40190637; + + } + // The autohealing policy for this managed instance group. You can specify only one value. repeated InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109; @@ -11924,6 +12083,10 @@ message InstanceGroupManager { // [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. optional string kind = 3292052; + // Pagination behavior of the listManagedInstances API method for this managed instance group. + // Check the ListManagedInstancesResults enum for the list of possible values. + optional string list_managed_instances_results = 296047156; + // The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. optional string name = 3373707; @@ -13392,9 +13555,43 @@ message InterconnectCircuitInfo { // Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. message InterconnectDiagnostics { + // The aggregation type of the bundle interface. + enum BundleAggregationType { + // A value indicating that the enum field is not set. + UNDEFINED_BUNDLE_AGGREGATION_TYPE = 0; + + // LACP is enabled. + BUNDLE_AGGREGATION_TYPE_LACP = 27758925; + + // LACP is disabled. + BUNDLE_AGGREGATION_TYPE_STATIC = 50678873; + + } + + // The operational status of the bundle interface. + enum BundleOperationalStatus { + // A value indicating that the enum field is not set. + UNDEFINED_BUNDLE_OPERATIONAL_STATUS = 0; + + // 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. + BUNDLE_OPERATIONAL_STATUS_DOWN = 453842693; + + // 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. + BUNDLE_OPERATIONAL_STATUS_UP = 161366462; + + } + // 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. repeated InterconnectDiagnosticsARPEntry arp_caches = 414591761; + // The aggregation type of the bundle interface. + // Check the BundleAggregationType enum for the list of possible values. + optional string bundle_aggregation_type = 434939028; + + // The operational status of the bundle interface. + // Check the BundleOperationalStatus enum for the list of possible values. + optional string bundle_operational_status = 106433500; + // A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. repeated InterconnectDiagnosticsLinkStatus links = 102977465; @@ -13475,6 +13672,19 @@ message InterconnectDiagnosticsLinkOpticalPower { // message InterconnectDiagnosticsLinkStatus { + // The operational status of the link. + enum OperationalStatus { + // A value indicating that the enum field is not set. + UNDEFINED_OPERATIONAL_STATUS = 0; + + // The interface is unable to communicate with the remote end. + LINK_OPERATIONAL_STATUS_DOWN = 281653885; + + // The interface has low level communication with the remote end. + LINK_OPERATIONAL_STATUS_UP = 305879862; + + } + // A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled repeated InterconnectDiagnosticsARPEntry arp_caches = 414591761; @@ -13486,6 +13696,10 @@ message InterconnectDiagnosticsLinkStatus { optional InterconnectDiagnosticsLinkLACPStatus lacp_status = 361210415; + // The operational status of the link. + // Check the OperationalStatus enum for the list of possible values. + optional string operational_status = 201070847; + // An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. optional InterconnectDiagnosticsLinkOpticalPower receiving_optical_power = 244717279; @@ -14822,6 +15036,31 @@ message ListManagedInstancesRegionInstanceGroupManagersRequest { } +// A request message for NetworkAttachments.List. See the method description for details. +message ListNetworkAttachmentsRequest { + // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + optional string filter = 336120696; + + // The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + optional uint32 max_results = 54715419; + + // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + optional string order_by = 160562920; + + // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + optional string page_token = 19994697; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Name of the region of this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + + // Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + optional bool return_partial_success = 517198390; + +} + // A request message for NetworkEndpointGroups.List. See the method description for details. message ListNetworkEndpointGroupsRequest { // A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. @@ -17098,6 +17337,165 @@ message Network { } +// NetworkAttachments A network attachment resource ... +message NetworkAttachment { + // + enum ConnectionPreference { + // A value indicating that the enum field is not set. + UNDEFINED_CONNECTION_PREFERENCE = 0; + + ACCEPT_AUTOMATIC = 75250580; + + ACCEPT_MANUAL = 373061341; + + INVALID = 530283991; + + } + + // [Output Only] An array of connections for all the producers connected to this network attachment. + repeated NetworkAttachmentConnectedEndpoint connection_endpoints = 326078813; + + // + // Check the ConnectionPreference enum for the list of possible values. + optional string connection_preference = 285818076; + + // [Output Only] Creation timestamp in RFC3339 text format. + optional string creation_timestamp = 30525366; + + // An optional description of this resource. Provide this property when you create the resource. + optional string description = 422937596; + + // [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. + optional string fingerprint = 234678500; + + // [Output Only] The unique identifier for the resource type. The server generates this identifier. + optional uint64 id = 3355; + + // [Output Only] Type of the resource. + optional string kind = 3292052; + + // 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; + + // [Output Only] The URL of the network which the Network Attachment belongs to. + optional string network = 232872494; + + // Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. + repeated string producer_accept_lists = 202804523; + + // Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number. + repeated string producer_reject_lists = 4112002; + + // [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. + optional string region = 138946292; + + // [Output Only] Server-defined URL for the resource. + optional string self_link = 456214797; + + // [Output Only] Server-defined URL for this resource's resource id. + optional string self_link_with_id = 44520962; + + // 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. + repeated string subnetworks = 415853125; + +} + +// Contains a list of NetworkAttachmentsScopedList. +message NetworkAttachmentAggregatedList { + // [Output Only] Unique identifier for the resource; defined by the server. + optional string id = 3355; + + // A list of NetworkAttachmentsScopedList resources. + map items = 100526016; + + optional string kind = 3292052; + + // [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. + optional string next_page_token = 79797525; + + // [Output Only] Server-defined URL for this resource. + optional string self_link = 456214797; + + // [Output Only] Informational warning message. + optional Warning warning = 50704284; + +} + +// [Output Only] A connection connected to this network attachment. +message NetworkAttachmentConnectedEndpoint { + // The status of a connected endpoint to this network attachment. + enum Status { + // A value indicating that the enum field is not set. + UNDEFINED_STATUS = 0; + + // The consumer allows traffic from the producer to reach its VPC. + ACCEPTED = 246714279; + + // The consumer network attachment no longer exists. + CLOSED = 380163436; + + // The consumer needs to take further action before traffic can be served. + NEEDS_ATTENTION = 344491452; + + // The consumer neither allows nor prohibits traffic from the producer to reach its VPC. + PENDING = 35394935; + + // The consumer prohibits traffic from the producer to reach its VPC. + REJECTED = 174130302; + + STATUS_UNSPECIFIED = 42133066; + + } + + // The IP address assigned to the producer instance network interface. This value will be a range in case of Serverless. + optional string ip_address = 406272220; + + // The project id or number of the interface to which the IP was assigned. + optional string project_id_or_num = 349783336; + + // Alias IP ranges from the same subnetwork + repeated string secondary_ip_cidr_ranges = 117184788; + + // The status of a connected endpoint to this network attachment. + // Check the Status enum for the list of possible values. + optional string status = 181260274; + + // The subnetwork used to assign the IP to the producer instance network interface. + optional string subnetwork = 307827694; + +} + +// +message NetworkAttachmentList { + // [Output Only] Unique identifier for the resource; defined by the server. + optional string id = 3355; + + // A list of NetworkAttachment resources. + repeated NetworkAttachment items = 100526016; + + optional string kind = 3292052; + + // [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. + optional string next_page_token = 79797525; + + // [Output Only] Server-defined URL for this resource. + optional string self_link = 456214797; + + // [Output Only] Informational warning message. + optional Warning warning = 50704284; + +} + +// +message NetworkAttachmentsScopedList { + // A list of NetworkAttachments contained in this scope. + repeated NetworkAttachment network_attachments = 521514783; + + // Informational warning which replaces the list of network attachments when the list is empty. + optional Warning warning = 50704284; + +} + // Represents a Google Cloud Armor network edge security service resource. message NetworkEdgeSecurityService { // [Output Only] Creation timestamp in RFC3339 text format. @@ -17255,6 +17653,8 @@ message NetworkEndpointGroup { // Check the NetworkEndpointType enum for the list of possible values. optional string network_endpoint_type = 118301523; + optional NetworkEndpointGroupPscData psc_data = 71937481; + // 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" optional string psc_target_service = 269132134; @@ -17358,6 +17758,44 @@ message NetworkEndpointGroupList { } +// All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. +message NetworkEndpointGroupPscData { + // [Output Only] The connection status of the PSC Forwarding Rule. + enum PscConnectionStatus { + // A value indicating that the enum field is not set. + UNDEFINED_PSC_CONNECTION_STATUS = 0; + + // The connection has been accepted by the producer. + ACCEPTED = 246714279; + + // The connection has been closed by the producer and will not serve traffic going forward. + CLOSED = 380163436; + + // The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic. + NEEDS_ATTENTION = 344491452; + + // The connection is pending acceptance by the producer. + PENDING = 35394935; + + // The connection has been rejected by the producer. + REJECTED = 174130302; + + STATUS_UNSPECIFIED = 42133066; + + } + + // [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. + optional string consumer_psc_address = 452646572; + + // [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. + optional uint64 psc_connection_id = 292082397; + + // [Output Only] The connection status of the PSC Forwarding Rule. + // Check the PscConnectionStatus enum for the list of possible values. + optional string psc_connection_status = 184149172; + +} + // message NetworkEndpointGroupsAttachEndpointsRequest { // The list of network endpoints to be attached. @@ -18319,7 +18757,7 @@ message NotificationEndpointGrpcSettings { // Optional. If specified, this field is used to populate the "name" field in gRPC requests. optional string payload_name = 300358300; - // 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. + // 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. optional Duration resend_interval = 478288969; // 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. @@ -18500,16 +18938,16 @@ message OutlierDetection { // 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. optional Duration base_ejection_time = 80997255; - // 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. + // 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. optional int32 consecutive_errors = 387193248; - // 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. + // 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. optional int32 consecutive_gateway_failure = 417504250; - // 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. + // 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. optional int32 enforcing_consecutive_errors = 213133760; - // 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. + // 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. optional int32 enforcing_consecutive_gateway_failure = 394440666; // 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. @@ -19992,6 +20430,21 @@ message Project { } + // [Output Only] Default internal DNS setting used by VMs running in this project. + enum VmDnsSetting { + // A value indicating that the enum field is not set. + UNDEFINED_VM_DNS_SETTING = 0; + + GLOBAL_DEFAULT = 345419141; + + UNSPECIFIED_VM_DNS_SETTING = 35691930; + + ZONAL_DEFAULT = 368475782; + + ZONAL_ONLY = 521198951; + + } + // [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. enum XpnProjectStatus { // A value indicating that the enum field is not set. @@ -20040,6 +20493,10 @@ message Project { // The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. optional UsageExportLocation usage_export_location = 347543874; + // [Output Only] Default internal DNS setting used by VMs running in this project. + // Check the VmDnsSetting enum for the list of possible values. + optional string vm_dns_setting = 58856370; + // [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. // Check the XpnProjectStatus enum for the list of possible values. optional string xpn_project_status = 228419265; @@ -20464,10 +20921,18 @@ message Quota { FORWARDING_RULES = 432668949; + GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES = 164566753; + GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES = 327611949; + GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES = 400256169; + GLOBAL_INTERNAL_ADDRESSES = 42738332; + GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES = 256608303; + + GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES = 323514196; + GPUS_ALL_REGIONS = 39387177; HEALTH_CHECKS = 289347502; @@ -20586,8 +21051,16 @@ message Quota { REGIONAL_AUTOSCALERS = 29363772; + REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES = 4240989; + + REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES = 409564525; + REGIONAL_INSTANCE_GROUP_MANAGERS = 37543696; + REGIONAL_INTERNAL_LB_BACKEND_SERVICES = 137983760; + + REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES = 96282539; + RESERVATIONS = 32644647; RESOURCE_POLICIES = 83955297; @@ -20619,6 +21092,8 @@ message Quota { STATIC_BYOIP_ADDRESSES = 275809649; + STATIC_EXTERNAL_IPV6_ADDRESS_RANGES = 472346774; + SUBNETWORKS = 421330469; T2A_CPUS = 522170599; @@ -20664,6 +21139,22 @@ message Quota { } +// Additional details for quota exceeded error for resource quota. +message QuotaExceededInfo { + // The map holding related quota dimensions. + map dimensions = 414334925; + + // Current effective quota limit. The limit's unit depends on the quota type or metric. + optional double limit = 102976443; + + // The name of the quota limit. + optional string limit_name = 398197903; + + // The Compute Engine quota metric name. + optional string metric_name = 409881530; + +} + // The parameters of the raw disk image. message RawDisk { // 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. @@ -21559,13 +22050,16 @@ 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] Reserved for future use. optional bool satisfies_pzs = 480964267; // [Output Only] Server-defined fully-qualified URL for this resource. optional string self_link = 456214797; - // Share-settings for shared-reservation + // 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. optional ShareSettings share_settings = 266668163; // Reservation for instances with specific machine shapes. @@ -21828,7 +22322,7 @@ message ResizeReservationRequest { // Commitment for a particular resource (a Commitment is composed of one or more of these). message ResourceCommitment { - // Type of resource for which this commitment applies. Possible values are VCPU and MEMORY + // Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. enum Type { // A value indicating that the enum field is not set. UNDEFINED_TYPE = 0; @@ -21851,7 +22345,7 @@ message ResourceCommitment { // 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. optional int64 amount = 196759640; - // Type of resource for which this commitment applies. Possible values are VCPU and MEMORY + // Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. // Check the Type enum for the list of possible values. optional string type = 3575610; @@ -22186,6 +22680,13 @@ message ResourcePolicyWeeklyCycleDayOfWeek { } +// 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. +message ResourceStatus { + // [Output Only] An opaque ID of the host on which the VM is running. + optional string physical_host = 464370704; + +} + // A request message for Instances.Resume. See the method description for details. message ResumeInstanceRequest { // Name of the instance resource to resume. @@ -22385,6 +22886,9 @@ message Router { // [Output Only] Type of resource. Always compute#router for routers. optional string kind = 3292052; + // Keys used for MD5 authentication. + repeated RouterMd5AuthenticationKey md5_authentication_keys = 71063322; + // 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; @@ -22563,6 +23067,9 @@ message RouterBgpPeer { // Check the ManagementType enum for the list of possible values. optional string management_type = 173703606; + // 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. + optional string md5_authentication_key_name = 281075345; + // 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. optional string name = 3373707; @@ -22674,6 +23181,16 @@ message RouterList { } +// +message RouterMd5AuthenticationKey { + // [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. + optional string key = 106079; + + // Name used to identify the key. Must be unique within a router. Must be referenced by at least one bgpPeer. Must comply with RFC1035. + optional string name = 3373707; + +} + // 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. message RouterNat { // @@ -22891,17 +23408,38 @@ message RouterStatusBgpPeerStatus { } + // Indicates why particular status was returned. + enum StatusReason { + // A value indicating that the enum field is not set. + UNDEFINED_STATUS_REASON = 0; + + // Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN. + MD5_AUTH_INTERNAL_PROBLEM = 140462259; + + STATUS_REASON_UNSPECIFIED = 394331913; + + } + // Routes that were advertised to the remote BGP peer repeated Route advertised_routes = 333393068; optional BfdStatus bfd_status = 395631729; + // Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. + optional bool enable_ipv6 = 181467939; + // IP address of the local BGP interface. optional string ip_address = 406272220; + // IPv6 address of the local BGP interface. + optional string ipv6_nexthop_address = 27968211; + // URL of the VPN tunnel that this BGP peer controls. optional string linked_vpn_tunnel = 352296953; + // Informs whether MD5 authentication is enabled on this BGP peer. + optional bool md5_auth_enabled = 451152075; + // Name of this BGP peer. Unique within the Routers resource. optional string name = 3373707; @@ -22911,6 +23449,9 @@ message RouterStatusBgpPeerStatus { // IP address of the remote BGP interface. optional string peer_ip_address = 207735769; + // IPv6 address of the remote BGP interface. + optional string peer_ipv6_nexthop_address = 491486608; + // [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. optional string router_appliance_instance = 468312989; @@ -22921,6 +23462,10 @@ message RouterStatusBgpPeerStatus { // Check the Status enum for the list of possible values. optional string status = 181260274; + // Indicates why particular status was returned. + // Check the StatusReason enum for the list of possible values. + optional string status_reason = 342706993; + // Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds optional string uptime = 235379688; @@ -23058,18 +23603,18 @@ message Rule { // message SSLHealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -23085,13 +23630,13 @@ message SSLHealthCheck { } - // The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -23099,10 +23644,10 @@ message SSLHealthCheck { // Check the ProxyHeader enum for the list of possible values. optional string proxy_header = 160374142; - // The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. + // 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. optional string request = 21951119; - // The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. + // 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 optional string response = 196547649; } @@ -23502,7 +24047,7 @@ message SecurityPolicy { // [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. optional string region = 138946292; - // 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 security policy, a default rule with action "allow" will be added. + // 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. repeated SecurityPolicyRule rules = 108873975; // [Output Only] Server-defined URL for the resource. @@ -23719,7 +24264,7 @@ message SecurityPolicyRuleMatcherConfig { // message SecurityPolicyRuleRateLimitOptions { - // 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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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. + // 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 EnforceOnKey { // A value indicating that the enum field is not set. UNDEFINED_ENFORCE_ON_KEY = 0; @@ -23730,8 +24275,14 @@ message SecurityPolicyRuleRateLimitOptions { HTTP_HEADER = 91597348; + HTTP_PATH = 311503228; + IP = 2343; + REGION_CODE = 79559768; + + SNI = 82254; + XFF_IP = 438707118; } @@ -23745,7 +24296,7 @@ message SecurityPolicyRuleRateLimitOptions { // Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. optional string conform_action = 517612367; - // 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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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. + // 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. // Check the EnforceOnKey enum for the list of possible values. optional string enforce_on_key = 416648956; @@ -24014,6 +24565,9 @@ message ServiceAttachmentConsumerProjectLimit { // The value of the limit to set. optional uint32 connection_limit = 131403546; + // The network URL for the network to set the limit for. + optional string network_url = 207194078; + // The project id or number for the project to set the limit for. optional string project_id_or_num = 349783336; @@ -24385,6 +24939,22 @@ message SetIamPolicyMachineImageRequest { } +// A request message for NetworkAttachments.SetIamPolicy. See the method description for details. +message SetIamPolicyNetworkAttachmentRequest { + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // The name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + + // The body resource for this request + RegionSetPolicyRequest region_set_policy_request_resource = 276489091 [(google.api.field_behavior) = REQUIRED]; + + // Name or id of the resource for this request. + string resource = 195806222 [(google.api.field_behavior) = REQUIRED]; + +} + // A request message for NetworkFirewallPolicies.SetIamPolicy. See the method description for details. message SetIamPolicyNetworkFirewallPolicyRequest { // The body resource for this request @@ -26383,6 +26953,9 @@ message StatefulPolicyPreservedStateDiskDevice { // A request message for Instances.Stop. See the method description for details. message StopInstanceRequest { + // If true, discard the contents of any attached localSSD partitions. Default value is false. + optional bool discard_local_ssd = 319517903; + // Name of the instance resource to stop. string instance = 18257045 [(google.api.field_behavior) = REQUIRED]; @@ -26508,7 +27081,7 @@ message Subnetwork { // 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. optional bool enable_flow_logs = 151544420; - // [Output Only] The external IPv6 address range that is assigned to this subnetwork. + // The external IPv6 address range that is owned by this subnetwork. optional string external_ipv6_prefix = 139299190; // 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. @@ -26738,6 +27311,9 @@ message Subsetting { // A request message for Instances.Suspend. See the method description for details. message SuspendInstanceRequest { + // If true, discard the contents of any attached localSSD partitions. Default value is false. + optional bool discard_local_ssd = 319517903; + // Name of the instance resource to suspend. string instance = 18257045 [(google.api.field_behavior) = REQUIRED]; @@ -26776,18 +27352,18 @@ message SwitchToCustomModeNetworkRequest { // message TCPHealthCheck { - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. + // 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 PortSpecification { // A value indicating that the enum field is not set. UNDEFINED_PORT_SPECIFICATION = 0; - // The port number in port is used for health checking. + // The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_FIXED_PORT = 190235748; - // The portName is used for health checking. + // Not supported. USE_NAMED_PORT = 349300671; - // For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. + // 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. USE_SERVING_PORT = 362637516; } @@ -26803,13 +27379,13 @@ message TCPHealthCheck { } - // The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + // The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535. optional int32 port = 3446913; - // Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + // Not supported. optional string port_name = 41534345; - // Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. + // 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. // Check the PortSpecification enum for the list of possible values. optional string port_specification = 51590597; @@ -26817,10 +27393,10 @@ message TCPHealthCheck { // Check the ProxyHeader enum for the list of possible values. optional string proxy_header = 160374142; - // The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. + // Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. optional string request = 21951119; - // The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. + // 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 optional string response = 196547649; } @@ -27528,6 +28104,16 @@ message TargetSslProxyList { } +// +message TargetTcpProxiesScopedList { + // A list of TargetTcpProxies contained in this scope. + repeated TargetTcpProxy target_tcp_proxies = 262056832; + + // Informational warning which replaces the list of backend services when the list is empty. + optional Warning warning = 50704284; + +} + // message TargetTcpProxiesSetBackendServiceRequest { // The URL of the new BackendService resource for the targetTcpProxy. @@ -27600,6 +28186,31 @@ message TargetTcpProxy { } +// +message TargetTcpProxyAggregatedList { + // [Output Only] Unique identifier for the resource; defined by the server. + optional string id = 3355; + + // A list of TargetTcpProxiesScopedList resources. + map items = 100526016; + + // [Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies. + optional string kind = 3292052; + + // [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. + optional string next_page_token = 79797525; + + // [Output Only] Server-defined URL for this resource. + optional string self_link = 456214797; + + // [Output Only] Unreachable resources. + repeated string unreachables = 243372063; + + // [Output Only] Informational warning message. + optional Warning warning = 50704284; + +} + // Contains a list of TargetTcpProxy resources. message TargetTcpProxyList { // [Output Only] Unique identifier for the resource; defined by the server. @@ -27883,6 +28494,22 @@ message TestIamPermissionsMachineImageRequest { } +// A request message for NetworkAttachments.TestIamPermissions. See the method description for details. +message TestIamPermissionsNetworkAttachmentRequest { + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // The name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + + // Name or id of the resource for this request. + string resource = 195806222 [(google.api.field_behavior) = REQUIRED]; + + // The body resource for this request + TestPermissionsRequest test_permissions_request_resource = 439214758 [(google.api.field_behavior) = REQUIRED]; + +} + // A request message for NetworkEndpointGroups.TestIamPermissions. See the method description for details. message TestIamPermissionsNetworkEndpointGroupRequest { // Project ID for this request. @@ -29095,7 +29722,7 @@ message VmEndpointNatMappingsList { // 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 . message VpnGateway { - // The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used. + // 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. enum StackType { // A value indicating that the enum field is not set. UNDEFINED_STACK_TYPE = 0; @@ -29138,7 +29765,7 @@ message VpnGateway { // [Output Only] Server-defined URL for the resource. optional string self_link = 456214797; - // The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used. + // 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. // Check the StackType enum for the list of possible values. optional string stack_type = 425908881; @@ -29368,7 +29995,7 @@ message VpnTunnel { // 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. optional string peer_external_gateway = 384956173; - // 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. + // 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. optional int32 peer_external_gateway_interface = 452768391; // 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. @@ -29405,7 +30032,7 @@ message VpnTunnel { // 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. optional string vpn_gateway = 406684153; - // The interface ID of the VPN gateway with which this VPN tunnel is associated. + // The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. optional int32 vpn_gateway_interface = 95979123; } @@ -32295,7 +32922,7 @@ service Interconnects { "https://www.googleapis.com/auth/compute," "https://www.googleapis.com/auth/cloud-platform"; - // Deletes the specified interconnect. + // Deletes the specified Interconnect. rpc Delete(DeleteInterconnectRequest) returns (Operation) { option (google.api.http) = { delete: "/compute/v1/projects/{project}/global/interconnects/{interconnect}" @@ -32304,7 +32931,7 @@ service Interconnects { option (google.cloud.operation_service) = "GlobalOperations"; } - // Returns the specified interconnect. Get a list of available interconnects by making a list() request. + // Returns the specified Interconnect. Get a list of available Interconnects by making a list() request. rpc Get(GetInterconnectRequest) returns (Interconnect) { option (google.api.http) = { get: "/compute/v1/projects/{project}/global/interconnects/{interconnect}" @@ -32312,7 +32939,7 @@ service Interconnects { option (google.api.method_signature) = "project,interconnect"; } - // Returns the interconnectDiagnostics for the specified interconnect. + // Returns the interconnectDiagnostics for the specified Interconnect. rpc GetDiagnostics(GetDiagnosticsInterconnectRequest) returns (InterconnectsGetDiagnosticsResponse) { option (google.api.http) = { get: "/compute/v1/projects/{project}/global/interconnects/{interconnect}/getDiagnostics" @@ -32320,7 +32947,7 @@ service Interconnects { option (google.api.method_signature) = "project,interconnect"; } - // Creates a Interconnect in the specified project using the data included in the request. + // Creates an Interconnect in the specified project using the data included in the request. rpc Insert(InsertInterconnectRequest) returns (Operation) { option (google.api.http) = { body: "interconnect_resource" @@ -32330,7 +32957,7 @@ service Interconnects { option (google.cloud.operation_service) = "GlobalOperations"; } - // Retrieves the list of interconnect available to the specified project. + // Retrieves the list of Interconnects available to the specified project. rpc List(ListInterconnectsRequest) returns (InterconnectList) { option (google.api.http) = { get: "/compute/v1/projects/{project}/global/interconnects" @@ -32338,7 +32965,7 @@ service Interconnects { option (google.api.method_signature) = "project"; } - // 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. + // 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. rpc Patch(PatchInterconnectRequest) returns (Operation) { option (google.api.http) = { body: "interconnect_resource" @@ -32569,6 +33196,86 @@ service MachineTypes { } +// The NetworkAttachments API. +service NetworkAttachments { + option (google.api.default_host) = + "compute.googleapis.com"; + + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/compute," + "https://www.googleapis.com/auth/cloud-platform"; + + // Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. + rpc AggregatedList(AggregatedListNetworkAttachmentsRequest) returns (NetworkAttachmentAggregatedList) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/aggregated/networkAttachments" + }; + option (google.api.method_signature) = "project"; + } + + // Deletes the specified NetworkAttachment in the given scope + rpc Delete(DeleteNetworkAttachmentRequest) returns (Operation) { + option (google.api.http) = { + delete: "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{network_attachment}" + }; + option (google.api.method_signature) = "project,region,network_attachment"; + option (google.cloud.operation_service) = "RegionOperations"; + } + + // Returns the specified NetworkAttachment resource in the given scope. + rpc Get(GetNetworkAttachmentRequest) returns (NetworkAttachment) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{network_attachment}" + }; + option (google.api.method_signature) = "project,region,network_attachment"; + } + + // Gets the access control policy for a resource. May be empty if no such policy or resource exists. + rpc GetIamPolicy(GetIamPolicyNetworkAttachmentRequest) returns (Policy) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy" + }; + option (google.api.method_signature) = "project,region,resource"; + } + + // Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request. + rpc Insert(InsertNetworkAttachmentRequest) returns (Operation) { + option (google.api.http) = { + body: "network_attachment_resource" + post: "/compute/v1/projects/{project}/regions/{region}/networkAttachments" + }; + option (google.api.method_signature) = "project,region,network_attachment_resource"; + option (google.cloud.operation_service) = "RegionOperations"; + } + + // Lists the NetworkAttachments for a project in the given scope. + rpc List(ListNetworkAttachmentsRequest) returns (NetworkAttachmentList) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/regions/{region}/networkAttachments" + }; + option (google.api.method_signature) = "project,region"; + } + + // Sets the access control policy on the specified resource. Replaces any existing policy. + rpc SetIamPolicy(SetIamPolicyNetworkAttachmentRequest) returns (Policy) { + option (google.api.http) = { + body: "region_set_policy_request_resource" + post: "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy" + }; + option (google.api.method_signature) = "project,region,resource,region_set_policy_request_resource"; + } + + // Returns permissions that a caller has on the specified resource. + rpc TestIamPermissions(TestIamPermissionsNetworkAttachmentRequest) returns (TestPermissionsResponse) { + option (google.api.http) = { + body: "test_permissions_request_resource" + post: "/compute/v1/projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions" + }; + option (google.api.method_signature) = "project,region,resource,test_permissions_request_resource"; + } + +} + // The NetworkEdgeSecurityServices API. service NetworkEdgeSecurityServices { option (google.api.default_host) = @@ -34636,7 +35343,7 @@ service RegionSecurityPolicies { option (google.api.method_signature) = "project,region"; } - // Patches the specified policy with the data included in the request. + // 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. rpc Patch(PatchRegionSecurityPolicyRequest) returns (Operation) { option (google.api.http) = { body: "security_policy_resource" @@ -35442,7 +36149,7 @@ service SecurityPolicies { option (google.api.method_signature) = "project"; } - // Patches the specified policy with the data included in the request. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. + // 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. rpc Patch(PatchSecurityPolicyRequest) returns (Operation) { option (google.api.http) = { body: "security_policy_resource" @@ -36415,6 +37122,14 @@ service TargetTcpProxies { "https://www.googleapis.com/auth/compute," "https://www.googleapis.com/auth/cloud-platform"; + // Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. + rpc AggregatedList(AggregatedListTargetTcpProxiesRequest) returns (TargetTcpProxyAggregatedList) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/aggregated/targetTcpProxies" + }; + option (google.api.method_signature) = "project"; + } + // Deletes the specified TargetTcpProxy resource. rpc Delete(DeleteTargetTcpProxyRequest) returns (Operation) { option (google.api.http) = { diff --git a/google/cloud/compute/v1/compute.v1.json b/google/cloud/compute/v1/compute.v1.json index 16d4c49c1..1c7ef678c 100644 --- a/google/cloud/compute/v1/compute.v1.json +++ b/google/cloud/compute/v1/compute.v1.json @@ -1,35394 +1,22364 @@ { - "title": "Compute Engine API", - "ownerName": "Google", + "kind": "discovery#restDescription", + "documentationLink": "https://cloud.google.com/compute/", + "parameters": { + "upload_protocol": { + "type": "string", + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "userIp": { + "description": "Legacy name for parameter that has been superseded by `quotaUser`.", + "location": "query", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "location": "query", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "description": "V1 error format.", + "enum": [ + "1", + "2" + ] + }, + "oauth_token": { + "type": "string", + "location": "query", + "description": "OAuth 2.0 token for the current user." + }, + "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", + "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." + }, + "access_token": { + "type": "string", + "location": "query", + "description": "OAuth access token." + }, + "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", + "location": "query", + "description": "Data format for response." + }, + "prettyPrint": { + "type": "boolean", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "location": "query" + } + }, + "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", - "schemas": { - "InstanceProperties": { - "properties": { - "privateIpv6GoogleAccess": { - "type": "string", - "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." - ], - "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": { - "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", - "type": "array", - "items": { - "$ref": "AcceleratorConfig" - } - }, - "confidentialInstanceConfig": { - "$ref": "ConfidentialInstanceConfig", - "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet." - }, - "labels": { - "type": "object", - "description": "Labels to apply to instances that are created from these properties.", - "additionalProperties": { - "type": "string" - } - }, - "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." - }, - "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" - } - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Specifies the scheduling options for the instances that are created from these properties." - }, - "shieldedInstanceConfig": { - "$ref": "ShieldedInstanceConfig", - "description": "Note that for MachineImage, this is not supported yet." - }, - "machineType": { - "description": "The machine type to use for instances that are created from these properties.", - "annotations": { - "required": [ - "compute.instanceTemplates.insert" - ] + "ownerDomain": "google.com", + "baseUrl": "https://compute.googleapis.com/compute/v1/", + "servicePath": "compute/v1/", + "discoveryVersion": "v1", + "resources": { + "machineTypes": { + "methods": { + "get": { + "httpMethod": "GET", + "response": { + "$ref": "MachineType" }, - "type": "string" - }, - "advancedMachineFeatures": { - "$ref": "AdvancedMachineFeatures", - "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet." - }, - "keyRevocationActionType": { - "enumDescriptions": [ - "Default value. This value is unused.", - "Indicates user chose no operation.", - "Indicates user chose to opt for VM shutdown on key revocation." + "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])?" + } + }, + "parameterOrder": [ + "project", + "zone", + "machineType" ], - "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}/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" ] }, - "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.", - "$ref": "Metadata" - }, - "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." - }, - "networkInterfaces": { - "description": "An array of network access configurations for this interface.", - "items": { - "$ref": "NetworkInterface" - }, - "type": "array" - }, - "networkPerformanceConfig": { - "$ref": "NetworkPerformanceConfig", - "description": "Note that for MachineImage, this is not supported yet." - }, - "description": { - "description": "An optional text description for the instances that are created from these properties.", - "type": "string" - }, - "reservationAffinity": { - "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.", - "$ref": "ReservationAffinity" - }, - "disks": { - "items": { - "$ref": "AttachedDisk" + "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" }, - "description": "An array of disks that are associated with the instances that are created from these properties.", - "type": "array" - }, - "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" - }, - "resourcePolicies": { - "type": "array", - "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", - "items": { - "type": "string" + "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." + } } }, - "serviceAccounts": { - "type": "array", - "items": { - "$ref": "ServiceAccount" + "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`.", + "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." + }, + "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" + } }, - "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." - } - }, - "id": "InstanceProperties", - "type": "object" - }, - "LicenseResourceCommitment": { - "type": "object", - "id": "LicenseResourceCommitment", - "properties": { - "coresPerLicense": { - "type": "string", - "description": "Specifies the core range of the instance for which this license applies." - }, - "amount": { - "description": "The number of licenses purchased.", - "type": "string", - "format": "int64" - }, - "license": { - "description": "Any applicable license URI.", - "type": "string" + "response": { + "$ref": "MachineTypeList" + }, + "flatPath": "projects/{project}/zones/{zone}/machineTypes" } - }, - "description": "Commitment for a particular license resource." + } }, - "RouterInterface": { - "id": "RouterInterface", - "properties": { - "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" - }, - "managementType": { - "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", - "enum": [ - "MANAGED_BY_ATTACHMENT", - "MANAGED_BY_USER" + "vpnTunnels": { + "methods": { + "delete": { + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "parameterOrder": [ + "project", + "region", + "vpnTunnel" ], - "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": { - "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])?", - "type": "string" - }, - "linkedInterconnectAttachment": { - "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.", - "type": "string" - }, - "name": { - "type": "string", - "annotations": { - "required": [ - "compute.routers.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": { + "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." + }, + "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." + }, + "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." + } }, - "pattern": "[a-z](?:[-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." - }, - "privateIpAddress": { - "type": "string", - "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." - }, - "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." - }, - "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." - } - }, - "type": "object" - }, - "SSLHealthCheck": { - "properties": { - "portName": { - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.", - "type": "string" - }, - "proxyHeader": { - "enum": [ - "NONE", - "PROXY_V1" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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": [ - "", - "" - ] - }, - "port": { - "description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.", - "format": "int32", - "type": "integer" + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "response": { + "$ref": "Operation" + }, + "httpMethod": "DELETE", + "description": "Deletes the specified VpnTunnel resource.", + "id": "compute.vpnTunnels.delete" }, - "portSpecification": { - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "list": { + "parameterOrder": [ + "project", + "region" ], - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields.", - "type": "string", - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." - ] - }, - "response": { - "description": "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.", - "type": "string" - }, - "request": { - "description": "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.", - "type": "string" - } - }, - "id": "SSLHealthCheck", - "type": "object" - }, - "SubnetworksExpandIpCidrRangeRequest": { - "type": "object", - "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" - } - }, - "id": "SubnetworksExpandIpCidrRangeRequest" - }, - "RouteList": { - "properties": { - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#routeList" - }, - "items": { - "items": { - "$ref": "Route" + "response": { + "$ref": "VpnTunnelList" }, - "description": "A list of Route 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" - }, - "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" - }, - "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": { - "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": "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" }, - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "description": "Name of the region 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" - ], - "description": "[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." - ], + "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" } - }, - "type": "object" - } - }, - "id": "RouteList", - "type": "object", - "description": "Contains a list of Route resources." - }, - "NodeTemplateNodeTypeFlexibility": { - "id": "NodeTemplateNodeTypeFlexibility", - "type": "object", - "properties": { - "localSsd": { - "type": "string" - }, - "cpus": { - "type": "string" - }, - "memory": { - "type": "string" - } - } - }, - "SecurityPolicyRuleMatcherConfig": { - "id": "SecurityPolicyRuleMatcherConfig", - "type": "object", - "properties": { - "srcIpRanges": { - "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.", - "type": "array", - "items": { - "type": "string" } - } - } - }, - "VpnGatewayStatusHighAvailabilityRequirementState": { - "properties": { - "state": { - "enum": [ - "CONNECTION_REDUNDANCY_MET", - "CONNECTION_REDUNDANCY_NOT_MET" - ], - "description": "Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.", - "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" - ], - "type": "string" - }, - "unsatisfiedReason": { - "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" - ], - "enumDescriptions": [ - "" - ] - } - }, - "description": "Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.", - "type": "object", - "id": "VpnGatewayStatusHighAvailabilityRequirementState" - }, - "Scheduling": { - "description": "Sets the scheduling options for an Instance.", - "type": "object", - "properties": { - "minNodeCpus": { - "type": "integer", - "format": "int32", - "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node." }, - "provisioningModel": { - "type": "string", - "enum": [ - "SPOT", - "STANDARD" + "get": { + "httpMethod": "GET", + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "parameterOrder": [ + "project", + "region", + "vpnTunnel" ], - "enumDescriptions": [ - "Heavily discounted, no guaranteed runtime.", - "Standard provisioning with user controlled runtime, no discounts." + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "response": { + "$ref": "VpnTunnel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "description": "Specifies the provisioning model of the instance." + "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}" + } + } }, - "instanceTerminationAction": { - "enumDescriptions": [ - "Delete the VM.", - "Default value. This value is unused.", - "Stop the VM without storing in-memory content. default action." + "setLabels": { + "parameterOrder": [ + "project", + "region", + "resource" ], - "description": "Specifies the termination action for the instance.", - "enum": [ - "DELETE", - "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", - "STOP" + "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" ], - "type": "string" - }, - "locationHint": { - "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.", - "type": "string" - }, - "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." - }, - "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" + "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" + } + } }, - "onHostMaintenance": { - "enum": [ - "MIGRATE", - "TERMINATE" + "aggregatedList": { + "httpMethod": "GET", + "parameterOrder": [ + "project" ], - "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.", - "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." + "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" ] }, - "nodeAffinities": { - "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.", - "type": "array", - "items": { - "$ref": "SchedulingNodeAffinity" + "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" + ], + "parameterOrder": [ + "project", + "region" + ], + "response": { + "$ref": "Operation" } } - }, - "id": "Scheduling" + } }, - "CommitmentAggregatedList": { - "id": "CommitmentAggregatedList", - "type": "object", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of commitments.", - "$ref": "CommitmentsScopedList" + "reservations": { + "methods": { + "update": { + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", + "httpMethod": "PATCH", + "response": { + "$ref": "Operation" }, - "description": "A list of CommitmentsScopedList resources.", - "type": "object" - }, - "kind": { - "default": "compute#commitmentAggregatedList", - "description": "[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.", - "type": "string" - }, - "warning": { - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "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)." }, - "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." - } - } - } - }, - "code": { + "zone": { + "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" - ], - "description": "[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." - }, - "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" - } - } - }, - "AcceleratorType": { - "properties": { - "kind": { - "default": "compute#acceleratorType", - "description": "[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.", - "type": "string" - }, - "name": { - "type": "string", - "description": "[Output Only] Name of the resource.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "maximumCardsPerInstance": { - "format": "int32", - "type": "integer", - "description": "[Output Only] Maximum number of accelerator cards allowed per instance." - }, - "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" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined, fully qualified URL for this resource." - }, - "description": { - "description": "[Output Only] An optional textual description of the resource.", - "type": "string" - }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "[Output Only] The deprecation status associated with this accelerator type." - } - }, - "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" - }, - "InstanceGroupManagerAggregatedList": { - "id": "InstanceGroupManagerAggregatedList", - "properties": { - "items": { - "additionalProperties": { - "description": "[Output Only] The name of the scope that contains this set of managed instance groups.", - "$ref": "InstanceGroupManagersScopedList" - }, - "type": "object", - "description": "A list of InstanceGroupManagersScopedList resources." - }, - "kind": { - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.", - "type": "string", - "default": "compute#instanceGroupManagerAggregatedList" - }, - "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": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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": "Name of the zone for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, - "code": { + "reservation": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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." + "required": true, + "location": "path", + "description": "Name of the reservation to update." }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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." } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "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" - }, - "unreachables": { - "type": "array", - "items": { - "type": "string" - }, - "description": "[Output Only] Unreachable resources." - } - }, - "type": "object" - }, - "License": { - "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. ", - "properties": { - "kind": { - "default": "compute#license", - "description": "[Output Only] Type of resource. Always compute#license for licenses.", - "type": "string" - }, - "description": { - "type": "string", - "description": "An optional textual description of the resource; provided by the client when the resource is created." - }, - "chargesUseFee": { - "type": "boolean", - "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee." - }, - "transferable": { - "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.", - "type": "boolean" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "licenseCode": { - "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.", - "format": "uint64", - "type": "string" - }, - "resourceRequirements": { - "$ref": "LicenseResourceRequirements" - }, - "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" - ] - } - }, - "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." - } - }, - "type": "object" - }, - "TargetVpnGatewayAggregatedList": { - "properties": { - "items": { - "type": "object", - "description": "A list of TargetVpnGateway resources.", - "additionalProperties": { - "$ref": "TargetVpnGatewaysScopedList", - "description": "[Output Only] Name of the scope containing this set of target VPN gateways." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.reservations.update", + "parameterOrder": [ + "project", + "zone", + "reservation" + ], + "path": "projects/{project}/zones/{zone}/reservations/{reservation}", + "request": { + "$ref": "Reservation" } }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", - "type": "string", - "default": "compute#targetVpnGatewayAggregatedList" - }, - "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." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "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": { - "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" + "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])?))" }, - "code": { + "reservation": { "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 reservation to update.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, - "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" + }, + "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 } } }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "id": "TargetVpnGatewayAggregatedList", - "type": "object" - }, - "HealthCheckLogConfig": { - "id": "HealthCheckLogConfig", - "description": "Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.", - "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" - } - }, - "type": "object" - }, - "InstanceGroupsRemoveInstancesRequest": { - "id": "InstanceGroupsRemoveInstancesRequest", - "type": "object", - "properties": { - "instances": { - "items": { - "$ref": "InstanceReference" + "aggregatedList": { + "response": { + "$ref": "ReservationAggregatedList" }, - "type": "array", - "description": "The list of instances to remove from the instance group." - } - } - }, - "TargetHttpsProxiesScopedList": { - "id": "TargetHttpsProxiesScopedList", - "type": "object", - "properties": { - "warning": { - "type": "object", - "description": "Informational warning which replaces the list of backend services when the list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "parameterOrder": [ + "project" + ], + "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" }, - "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": { + "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" }, - "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\" } " + "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" } - } - }, - "targetHttpsProxies": { - "type": "array", - "description": "A list of TargetHttpsProxies contained in this scope.", - "items": { - "$ref": "TargetHttpsProxy" - } - } - } - }, - "VpnGatewayVpnGatewayInterface": { - "description": "A VPN gateway interface.", - "properties": { - "id": { - "description": "[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.", - "type": "integer", - "format": "uint32" - }, - "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": { - "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": "string" - } - }, - "id": "VpnGatewayVpnGatewayInterface", - "type": "object" - }, - "RouterStatusResponse": { - "id": "RouterStatusResponse", - "properties": { - "kind": { - "default": "compute#routerStatusResponse", - "description": "Type of resource.", - "type": "string" - }, - "result": { - "$ref": "RouterStatus" - } - }, - "type": "object" - }, - "BackendServiceCdnPolicyNegativeCachingPolicy": { - "id": "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" - }, - "ttl": { - "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": "integer" - } - }, - "description": "Specify CDN TTLs for response error codes.", - "type": "object" - }, - "InstanceGroupManagerActionsSummary": { - "properties": { - "creating": { - "type": "integer", - "format": "int32", - "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." - }, - "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." - }, - "creatingWithoutRetries": { - "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", - "format": "int32" - }, - "verifying": { - "format": "int32", - "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." - }, - "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" - }, - "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" - }, - "abandoning": { - "format": "int32", - "type": "integer", - "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." - }, - "deleting": { - "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", - "format": "int32" - }, - "none": { - "type": "integer", - "format": "int32", - "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions." - }, - "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": { - "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" - }, - "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." - } - }, - "id": "InstanceGroupManagerActionsSummary", - "type": "object" - }, - "Reference": { - "id": "Reference", - "description": "Represents a reference to a resource.", - "properties": { - "target": { - "type": "string", - "description": "URL of the resource to which this reference points." - }, - "referenceType": { - "description": "A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF ", - "type": "string" - }, - "referrer": { - "description": "URL of the resource which refers to the target.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#reference", - "description": "[Output Only] Type of the resource. Always compute#reference for references." - } - }, - "type": "object" - }, - "CommitmentList": { - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#commitmentList for lists of commitments.", - "default": "compute#commitmentList" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "description": "A list of Commitment resources.", - "items": { - "$ref": "Commitment" }, - "type": "array" + "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" + ], + "httpMethod": "GET" }, - "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.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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])?", + "description": "Name of the zone for this request." }, - "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])?))", + "location": "path", + "type": "string", + "description": "Project ID for this request.", + "required": true }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" } - } - }, - "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." - } - }, - "description": "Contains a list of Commitment resources.", - "id": "CommitmentList", - "type": "object" - }, - "HealthStatus": { - "id": "HealthStatus", - "type": "object", - "properties": { - "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." - }, - "forwardingRuleIp": { - "description": "A forwarding rule IP address assigned to this instance.", - "type": "string" + }, + "path": "projects/{project}/zones/{zone}/reservations/{reservation}", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "zone", + "reservation" + ] }, - "healthState": { - "enum": [ - "HEALTHY", - "UNHEALTHY" + "get": { + "response": { + "$ref": "Reservation" + }, + "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])?" + } + }, + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", + "parameterOrder": [ + "project", + "zone", + "reservation" ], - "enumDescriptions": [ - "", - "" + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "description": "Health state of the instance.", - "type": "string" - }, - "instance": { - "type": "string", - "description": "URL of the instance resource." - }, - "annotations": { - "type": "object", - "description": "Metadata defined as annotations for network endpoint.", - "additionalProperties": { - "type": "string" - } - }, - "port": { - "description": "The named port of the instance group, not necessarily the port that is health-checked.", - "type": "integer", - "format": "int32" + "id": "compute.reservations.get" }, - "forwardingRule": { - "description": "URL of the forwarding rule associated with the health status of the instance.", - "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." + "list": { + "id": "compute.reservations.list", + "flatPath": "projects/{project}/zones/{zone}/reservations", + "response": { + "$ref": "ReservationList" + }, + "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", - "enum": [ - "INVALID_WEIGHT", - "MISSING_WEIGHT", - "UNAVAILABLE_WEIGHT", - "WEIGHT_NONE" + "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" ] }, - "weight": { - "type": "string" - } - } - }, - "HTTPHealthCheck": { - "properties": { - "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", - "enumDescriptions": [ - "", - "" + "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" + } + }, + "request": { + "$ref": "ZoneSetPolicyRequest" + }, + "parameterOrder": [ + "project", + "zone", + "resource" ], - "enum": [ - "NONE", - "PROXY_V1" - ] - }, - "host": { - "type": "string", - "description": "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used." - }, - "portName": { - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.", - "type": "string" - }, - "requestPath": { - "type": "string", - "description": "The request path of the HTTP health check request. The default value is /." + "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" + }, + "id": "compute.reservations.setIamPolicy", + "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy" }, - "portSpecification": { - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "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" ], - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields.", - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "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" ], - "type": "string" - }, - "port": { - "description": "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.", - "format": "int32", - "type": "integer" - }, - "response": { - "description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.", - "type": "string" - } - }, - "type": "object", - "id": "HTTPHealthCheck" - }, - "RegionDisksResizeRequest": { - "properties": { - "sizeGb": { - "type": "string", - "format": "int64", - "description": "The new size of the regional persistent disk, which is specified in GB." - } - }, - "id": "RegionDisksResizeRequest", - "type": "object" - }, - "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": { - "googleCircuitId": { - "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.", - "type": "string" - }, - "customerDemarcId": { - "description": "Customer-side demarc ID for this circuit.", - "type": "string" - }, - "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" - } - } - }, - "SecuritySettings": { - "type": "object", - "description": "The authentication and authorization settings for a BackendService.", - "id": "SecuritySettings", - "properties": { - "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" + "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" + } + } }, - "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" + "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." + } }, - "type": "array" - } - } - }, - "InstancesAddResourcePoliciesRequest": { - "type": "object", - "properties": { - "resourcePolicies": { - "type": "array", - "items": { - "type": "string" + "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", + "httpMethod": "POST", + "response": { + "$ref": "TestPermissionsResponse" }, - "description": "Resource policies to be added to this instance." - } - }, - "id": "InstancesAddResourcePoliciesRequest" - }, - "NetworkEndpointGroupsListNetworkEndpoints": { - "id": "NetworkEndpointGroupsListNetworkEndpoints", - "type": "object", - "properties": { - "kind": { - "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", - "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." + "request": { + "$ref": "TestPermissionsRequest" + }, + "id": "compute.reservations.testIamPermissions" }, - "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": { - "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\" } " + "insert": { + "id": "compute.reservations.insert", + "request": { + "$ref": "Reservation" + }, + "parameters": { + "zone": { + "location": "path", + "description": "Name of the zone for this request.", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Project ID for this request.", + "location": "path", + "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" } }, - "type": "object" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "type": "array", - "description": "A list of NetworkEndpointWithHealthStatus resources.", - "items": { - "$ref": "NetworkEndpointWithHealthStatus" - } + "parameterOrder": [ + "project", + "zone" + ], + "response": { + "$ref": "Operation" + }, + "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." } } }, - "SecurityPoliciesScopedList": { - "id": "SecurityPoliciesScopedList", - "properties": { - "securityPolicies": { - "type": "array", - "description": "A list of SecurityPolicies contained in this scope.", - "items": { - "$ref": "SecurityPolicy" - } + "httpsHealthChecks": { + "methods": { + "patch": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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 + }, + "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." + }, + "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" + } + }, + "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." }, - "warning": { - "description": "Informational warning which replaces the list of security policies when the list is empty.", - "type": "object", - "properties": { - "message": { + "insert": { + "parameterOrder": [ + "project" + ], + "httpMethod": "POST", + "parameters": { + "project": { + "location": "path", + "required": true, + "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])?))" }, - "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." - ], + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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\" } " } - } - } - }, - "type": "object" - }, - "PublicDelegatedPrefixPublicDelegatedSubPrefix": { - "type": "object", - "description": "Represents a sub PublicDelegatedPrefix.", - "id": "PublicDelegatedPrefixPublicDelegatedSubPrefix", - "properties": { - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "name": { - "description": "The name of the sub public delegated prefix.", - "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}" }, - "isAddress": { - "type": "boolean", - "description": "Whether the sub prefix is delegated to create Address resources in the delegatee project." + "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", + "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" + } + }, + "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", + "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request." }, - "status": { - "enum": [ - "ACTIVE", - "INACTIVE" + "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" + } + }, + "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] The status of the sub public delegated prefix.", - "type": "string", - "enumDescriptions": [ - "", - "" + "parameterOrder": [ + "project" ] }, - "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." - }, - "delegateeProject": { - "description": "Name of the project scoping this PublicDelegatedSubPrefix.", - "type": "string" - }, - "ipCidrRange": { - "description": "The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.", - "type": "string" + "delete": { + "id": "compute.httpsHealthChecks.delete", + "response": { + "$ref": "Operation" + }, + "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" + } + }, + "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" + ], + "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}" } } }, - "SslCertificateAggregatedList": { - "id": "SslCertificateAggregatedList", - "type": "object", - "properties": { - "items": { - "description": "A list of SslCertificatesScopedList resources.", - "type": "object", - "additionalProperties": { - "$ref": "SslCertificatesScopedList", - "description": "Name of the scope containing this set of SslCertificates." - } - }, - "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." - }, - "unreachables": { - "type": "array", - "description": "[Output Only] Unreachable resources.", - "items": { - "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." - }, - "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." - ], + "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", - "description": "[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, + "location": "path", + "pattern": "[a-z](?:[-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": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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" - } - } - } + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { + "interconnectAttachment": { "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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" } + }, + "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" } - } - } - }, - "Int64RangeMatch": { - "id": "Int64RangeMatch", - "type": "object", - "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.", - "properties": { - "rangeStart": { - "description": "The start of the range (inclusive) in signed long integer format.", - "format": "int64", - "type": "string" }, - "rangeEnd": { - "format": "int64", - "type": "string", - "description": "The end of the range (exclusive) in signed long integer format." - } - } - }, - "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": { - "filterMatchCriteria": { - "enum": [ - "MATCH_ALL", - "MATCH_ANY", - "NOT_SET" + "delete": { + "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." + "parameterOrder": [ + "project", + "region", + "interconnectAttachment" ], - "type": "string" - }, - "filterLabels": { - "items": { - "$ref": "MetadataFilterLabelMatch" + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" }, - "type": "array", - "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": "object", - "id": "MetadataFilter" - }, - "AccessConfig": { - "type": "object", - "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.", - "id": "AccessConfig", - "properties": { - "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." - }, - "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." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.", - "default": "compute#accessConfig" - }, - "networkTier": { - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" + "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" + } + } + }, + "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" ], - "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": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "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." + "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." }, - "type": { - "enumDescriptions": [ - "", - "" + "get": { + "id": "compute.interconnectAttachments.get", + "parameterOrder": [ + "project", + "region", + "interconnectAttachment" ], - "type": "string", - "enum": [ - "DIRECT_IPV6", - "ONE_TO_ONE_NAT" + "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" ], - "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" - }, - "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." - }, - "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" - }, - "externalIpv6PrefixLength": { - "format": "int32", - "description": "The prefix length of the external IPv6 range.", - "type": "integer" - } - } - }, - "ZoneSetPolicyRequest": { - "properties": { - "bindings": { - "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "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" - }, - "etag": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "type": "string", - "format": "byte" - } - }, - "type": "object", - "id": "ZoneSetPolicyRequest" - }, - "RouterNatSubnetworkToNat": { - "type": "object", - "properties": { - "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": { - "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" - ] - } - }, - "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.", - "items": { - "type": "string" + "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" + } }, - "type": "array" + "description": "Returns the specified interconnect attachment." }, - "name": { - "type": "string", - "description": "URL for the subnetwork resource that will use NAT." - } - }, - "id": "RouterNatSubnetworkToNat", - "description": "Defines the IP ranges that want to use NAT for a subnetwork." - }, - "NetworkList": { - "id": "NetworkList", - "description": "Contains a list of networks.", - "properties": { - "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" + "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" }, - "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": { + "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." }, - "message": { - "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." + }, + "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" } - } - }, - "items": { - "type": "array", - "items": { - "$ref": "Network" }, - "description": "A list of Network resources." - }, - "kind": { - "default": "compute#networkList", - "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", - "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." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "parameterOrder": [ + "project", + "region" + ], + "flatPath": "projects/{project}/regions/{region}/interconnectAttachments", + "path": "projects/{project}/regions/{region}/interconnectAttachments", + "response": { + "$ref": "InterconnectAttachmentList" + }, + "id": "compute.interconnectAttachments.list", + "httpMethod": "GET" }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - }, - "type": "object" - }, - "ResourcePolicyList": { - "type": "object", - "properties": { - "warning": { - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "setLabels": { + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "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 }, - "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\" } " + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": { + "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", - "description": "[Output Only] Informational warning message." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "description": "[Output Only] A list of ResourcePolicy resources.", - "items": { - "$ref": "ResourcePolicy" + "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels", + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "etag": { - "type": "string" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "region", + "resource" + ], + "httpMethod": "POST", + "path": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels", + "id": "compute.interconnectAttachments.setLabels" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#resourcePolicyList", - "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies" - }, - "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": "ResourcePolicyList" - }, - "SecurityPoliciesWafConfig": { - "type": "object", - "properties": { - "wafRules": { - "$ref": "PreconfiguredWafSet" - } - }, - "id": "SecurityPoliciesWafConfig" - }, - "NetworkRoutingConfig": { - "properties": { - "routingMode": { - "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" ], - "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.", - "enum": [ - "GLOBAL", - "REGIONAL" - ] - } - }, - "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" - }, - "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", - "id": "TargetPoolsRemoveHealthCheckRequest" - }, - "DiskParams": { - "description": "Additional disk params.", - "properties": { - "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" + "httpMethod": "GET", + "path": "projects/{project}/aggregated/interconnectAttachments", + "parameterOrder": [ + "project" + ], + "response": { + "$ref": "InterconnectAttachmentAggregatedList" }, - "type": "object" + "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" } - }, - "id": "DiskParams", - "type": "object" + } }, - "BackendService": { - "id": "BackendService", - "properties": { - "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" - }, - "sessionAffinity": { - "type": "string", - "enum": [ - "CLIENT_IP", - "CLIENT_IP_NO_DESTINATION", - "CLIENT_IP_PORT_PROTO", - "CLIENT_IP_PROTO", - "GENERATED_COOKIE", - "HEADER_FIELD", - "HTTP_COOKIE", - "NONE" + "targetPools": { + "methods": { + "aggregatedList": { + "path": "projects/{project}/aggregated/targetPools", + "httpMethod": "GET", + "description": "Retrieves an aggregated list of target pools.", + "id": "compute.targetPools.aggregatedList", + "parameterOrder": [ + "project" ], - "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).", - "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." - ] - }, - "enableCDN": { - "type": "boolean", - "description": "If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer." - }, - "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.", - "$ref": "SecuritySettings" - }, - "loadBalancingScheme": { - "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.", - "" + "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" ], - "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", - "enum": [ - "EXTERNAL", - "EXTERNAL_MANAGED", - "INTERNAL", - "INTERNAL_MANAGED", - "INTERNAL_SELF_MANAGED", - "INVALID_LOAD_BALANCING_SCHEME" - ] - }, - "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" - }, - "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." - }, - "subsetting": { - "$ref": "Subsetting" - }, - "edgeSecurityPolicy": { - "type": "string", - "description": "[Output Only] The resource URL for the edge security policy associated with this backend service." + "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" + } }, - "compressionMode": { - "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." + "insert": { + "parameterOrder": [ + "project", + "region" ], - "enum": [ - "AUTOMATIC", - "DISABLED" + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string" - }, - "customResponseHeaders": { - "type": "array", - "items": { - "type": "string" + "path": "projects/{project}/regions/{region}/targetPools", + "flatPath": "projects/{project}/regions/{region}/targetPools", + "httpMethod": "POST", + "request": { + "$ref": "TargetPool" }, - "description": "Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)." - }, - "affinityCookieTtlSec": { - "format": "int32", - "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" - }, - "timeoutSec": { - "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.", - "type": "integer" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "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" + "description": "Creates a target pool in the specified project and region using the data included in the request." }, - "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." + "setBackup": { + "parameterOrder": [ + "project", + "region", + "targetPool" ], - "enum": [ - "GRPC", - "HTTP", - "HTTP2", - "HTTPS", - "SSL", - "TCP", - "UDP", - "UNSPECIFIED" + "httpMethod": "POST", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "request": { + "$ref": "TargetReference" + }, + "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" ], - "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.", - "type": "string" - }, - "healthChecks": { - "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.", - "items": { - "type": "string" + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "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" - }, - "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 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." - }, - "circuitBreakers": { - "$ref": "CircuitBreakers" - }, - "failoverPolicy": { - "$ref": "BackendServiceFailoverPolicy", - "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)." + "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." + } + } }, - "backends": { - "type": "array", - "items": { - "$ref": "Backend" + "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" + }, + "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 + }, + "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": "The list of backends that serve this BackendService." - }, - "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." - }, - "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." - }, - "outlierDetection": { - "$ref": "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, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. 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." - }, - "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.", - "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." - ], - "enum": [ - "INVALID_LB_POLICY", - "LEAST_REQUEST", - "MAGLEV", - "ORIGINAL_DESTINATION", - "RANDOM", - "RING_HASH", - "ROUND_ROBIN" + "response": { + "$ref": "TargetPool" + }, + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "httpMethod": "GET", + "id": "compute.targetPools.get", + "parameterOrder": [ + "project", + "region", + "targetPool" ], - "type": "string" - }, - "connectionDraining": { - "$ref": "ConnectionDraining" - }, - "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" - } - }, - "kind": { - "default": "compute#backendService", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#backendService for backend services." - }, - "cdnPolicy": { - "$ref": "BackendServiceCdnPolicy", - "description": "Cloud CDN configuration for this BackendService. Only available for specified load balancer types." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] }, - "serviceBindings": { - "items": { - "type": "string" + "removeHealthCheck": { + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", + "request": { + "$ref": "TargetPoolsRemoveHealthCheckRequest" }, - "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." - }, - "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." - }, - "consistentHash": { - "$ref": "ConsistentHashLoadBalancerSettings", - "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. " - }, - "securityPolicy": { - "description": "[Output Only] The resource URL for the security policy associated with this backend service.", - "type": "string" - }, - "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." - }, - "iap": { - "description": "The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.", - "$ref": "BackendServiceIAP" - }, - "customRequestHeaders": { - "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).", - "items": { - "type": "string" - } - } - }, - "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." - }, - "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": { - "auditLogConfigs": { - "items": { - "$ref": "AuditLogConfig" + "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.", + "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])?))" + }, + "region": { + "location": "path", + "type": "string", + "description": "Name of the region for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true + }, + "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." + } }, - "type": "array", - "description": "The configuration for logging of each type of permission." - }, - "exemptedMembers": { - "type": "array", - "description": "This is deprecated and has no effect. Do not use.", - "items": { - "type": "string" - } - }, - "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." - } - }, - "id": "AuditConfig", - "type": "object" - }, - "CommitmentsScopedList": { - "properties": { - "commitments": { - "items": { - "$ref": "Commitment" + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", + "description": "Removes health check URL from a target pool.", + "id": "compute.targetPools.removeHealthCheck", + "response": { + "$ref": "Operation" }, - "type": "array", - "description": "[Output Only] A list of commitments contained in this scope." + "httpMethod": "POST", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "warning": { - "type": "object", - "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" + "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)." }, - "message": { + "project": { + "required": true, + "description": "Project ID for this request.", "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])?))" }, - "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." - ], + "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" - ], - "description": "[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}", + "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" } }, - "description": "[Output Only] Informational warning which replaces the list of commitments when the list is empty." - } - }, - "type": "object", - "id": "CommitmentsScopedList" - }, - "FixedOrPercent": { - "properties": { - "calculated": { - "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. ", - "type": "integer", - "format": "int32" - }, - "percent": { - "format": "int32", - "type": "integer", - "description": "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%." - }, - "fixed": { - "format": "int32", - "description": "Specifies a fixed number of VM instances. This must be a positive integer.", - "type": "integer" - } - }, - "id": "FixedOrPercent", - "type": "object", - "description": "Encapsulates numeric value that can be either absolute or relative." - }, - "Router": { - "type": "object", - "properties": { - "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" - }, - "interfaces": { - "type": "array", - "items": { - "$ref": "RouterInterface" - }, - "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." - }, - "name": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "annotations": { - "required": [ - "compute.routers.insert" - ] + "id": "compute.targetPools.delete", + "httpMethod": "DELETE", + "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." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "kind": { - "default": "compute#router", - "description": "[Output Only] Type of resource. Always compute#router for routers.", - "type": "string" + "description": "Deletes the specified target pool." }, - "bgpPeers": { - "type": "array", - "items": { - "$ref": "RouterBgpPeer" + "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": "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." - }, - "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" - }, - "network": { - "annotations": { - "required": [ - "compute.routers.insert", - "compute.routers.update" - ] + "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" + } }, - "type": "string", - "description": "URI of the network to which this router belongs." - }, - "nats": { - "type": "array", - "description": "A list of NAT services created in this router.", - "items": { - "$ref": "RouterNat" + "request": { + "$ref": "TargetPoolsRemoveInstanceRequest" } }, - "encryptedInterconnectRouter": { - "type": "boolean", - "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments)." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "bgp": { - "$ref": "RouterBgp", - "description": "BGP information specific to this router." - } - }, - "id": "Router", - "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview." - }, - "AutoscalingPolicyCpuUtilization": { - "type": "object", - "description": "CPU utilization policy.", - "id": "AutoscalingPolicyCpuUtilization", - "properties": { - "predictiveMethod": { - "type": "string", - "enum": [ - "NONE", - "OPTIMIZE_AVAILABILITY" - ], - "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." + "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" ], - "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." + "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" + ] }, - "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." - } - } - }, - "UsableSubnetwork": { - "type": "object", - "id": "UsableSubnetwork", - "properties": { - "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.", - "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." + "addHealthCheck": { + "parameterOrder": [ + "project", + "region", + "targetPool" ], - "enum": [ - "INTERNAL_HTTPS_LOAD_BALANCER", - "PRIVATE", - "PRIVATE_RFC_1918", - "PRIVATE_SERVICE_CONNECT", - "REGIONAL_MANAGED_PROXY" + "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" ], - "type": "string" - }, - "subnetwork": { - "type": "string", - "description": "Subnetwork URL." + "response": { + "$ref": "Operation" + } }, - "role": { - "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." + "addInstance": { + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "ACTIVE", - "BACKUP" - ] - }, - "externalIpv6Prefix": { - "description": "[Output Only] The external 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." - }, - "secondaryIpRanges": { - "description": "Secondary IP ranges.", - "type": "array", - "items": { - "$ref": "UsableSubnetworkSecondaryRange" - } - }, - "network": { - "description": "Network URL.", - "type": "string" - }, - "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." - ], - "enum": [ - "EXTERNAL", - "INTERNAL" - ], - "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." - }, - "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" - ], - "enumDescriptions": [ - "New VMs in this subnet can have both IPv4 and IPv6 addresses.", - "New VMs in this subnet will only be assigned IPv4 addresses." - ], - "type": "string" - }, - "internalIpv6Prefix": { - "type": "string", - "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork." - } - }, - "description": "Subnetwork which the current user has compute.subnetworks.use permission on." - }, - "InstanceGroupManagerList": { - "properties": { - "kind": { - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.", - "default": "compute#instanceGroupManagerList", - "type": "string" - }, - "items": { - "description": "A list of InstanceGroupManager resources.", - "type": "array", - "items": { - "$ref": "InstanceGroupManager" - } - }, - "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" + "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)." }, - "code": { + "project": { + "location": "path", + "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" - ] + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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\" } ", - "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" - } - } - } + "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" + }, + "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, + "type": "string" } + }, + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "httpMethod": "POST", + "description": "Adds an instance to a target pool.", + "response": { + "$ref": "Operation" } }, - "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" - } - }, - "type": "object", - "description": "[Output Only] A list of managed instance groups.", - "id": "InstanceGroupManagerList" - }, - "HealthChecksScopedList": { - "id": "HealthChecksScopedList", - "properties": { - "healthChecks": { - "description": "A list of HealthChecks contained in this scope.", - "items": { - "$ref": "HealthCheck" + "getHealth": { + "response": { + "$ref": "TargetPoolInstanceHealth" }, - "type": "array" - }, - "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.", - "type": "string" + "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" }, - "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)." - } - } - } + "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": { + "region": { + "description": "Name of the region scoping this request.", "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, + "location": "path" } }, - "description": "Informational warning which replaces the list of backend services when the list is empty." - } - }, - "type": "object" - }, - "TargetPoolInstanceHealth": { - "type": "object", - "id": "TargetPoolInstanceHealth", - "properties": { - "healthStatus": { - "type": "array", - "items": { - "$ref": "HealthStatus" - } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.", - "type": "string", - "default": "compute#targetPoolInstanceHealth" + "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" } } }, - "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.", - "format": "int64", - "type": "string" - }, - "architecture": { - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "targetHttpsProxies": { + "methods": { + "delete": { + "id": "compute.targetHttpsProxies.delete", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "description": "The architecture of the disk. Valid values are ARM64 or X86_64.", - "type": "string", - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ] - }, - "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" - }, - "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." - }, - "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." - }, - "lastAttachTimestamp": { - "type": "string", - "description": "[Output Only] Last attach timestamp in RFC3339 text format." - }, - "licenseCodes": { - "items": { - "format": "int64", - "type": "string" + "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, + "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 + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "Integer license codes indicating which licenses are attached to this disk.", - "type": "array" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string", - "format": "uint64" - }, - "params": { - "$ref": "DiskParams", - "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." - }, - "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 " - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined fully-qualified URL for this resource." - }, - "name": { - "type": "string", - "annotations": { - "required": [ - "compute.disks.insert" - ] + "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.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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 " + "httpMethod": "DELETE", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "parameterOrder": [ + "project", + "targetHttpsProxy" + ] }, - "guestOsFeatures": { - "type": "array", - "items": { - "$ref": "GuestOsFeature" + "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" }, - "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." - }, - "resourcePolicies": { - "description": "Resource policies applied to this disk for automatic snapshot creations.", - "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" }, - "type": "array" - }, - "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" - }, - "sourceImage": { - "type": "string", - "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 " - }, - "replicaZones": { - "description": "URLs of the zones where the disk should be replicated to. Only applicable for regional resources.", - "type": "array", - "items": { - "type": "string" + "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)." + } } }, - "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" - }, - "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#disk for disks.", - "default": "compute#disk", - "type": "string" - }, - "diskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "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." - }, - "users": { - "items": { - "type": "string" - }, - "description": "[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance", - "type": "array" - }, - "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" - }, - "satisfiesPzs": { - "type": "boolean", - "description": "[Output Only] Reserved for future use." - }, - "licenses": { - "items": { - "type": "string" - }, - "type": "array", - "description": "A list of publicly visible licenses. Reserved for Google's use." - }, - "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." - }, - "status": { - "enum": [ - "CREATING", - "DELETING", - "FAILED", - "READY", - "RESTORING" + "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" ], - "enumDescriptions": [ - "Disk is provisioning", - "Disk is deleting.", - "Disk creation failed.", - "Disk is ready for use.", - "Source data is being copied into the disk." + "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" ], - "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" - }, - "provisionedIops": { - "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.", - "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" - }, - "lastDetachTimestamp": { - "description": "[Output Only] Last detach timestamp in RFC3339 text format.", - "type": "string" - }, - "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" - }, - "options": { - "description": "Internal use only.", - "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" - }, - "labels": { - "type": "object", - "description": "Labels to apply to this disk. These can be later modified by the setLabels method.", - "additionalProperties": { - "type": "string" + "response": { + "$ref": "TargetHttpsProxy" } }, - "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" - }, - "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" - } - }, - "id": "Disk", - "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." - }, - "TargetSslProxiesSetSslCertificatesRequest": { - "id": "TargetSslProxiesSetSslCertificatesRequest", - "properties": { - "sslCertificates": { - "type": "array", - "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.", - "items": { - "type": "string" - } - } - }, - "type": "object" - }, - "InstanceGroupManagersDeletePerInstanceConfigsReq": { - "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" - } - } - }, - "description": "InstanceGroupManagers.deletePerInstanceConfigs", - "type": "object", - "id": "InstanceGroupManagersDeletePerInstanceConfigsReq" - }, - "ProjectsListXpnHostsRequest": { - "type": "object", - "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." - } - } - }, - "RegionUrlMapsValidateRequest": { - "type": "object", - "properties": { - "resource": { - "$ref": "UrlMap", - "description": "Content of the UrlMap to be validated." - } - }, - "id": "RegionUrlMapsValidateRequest" - }, - "SecurityPolicyAdaptiveProtectionConfig": { - "type": "object", - "id": "SecurityPolicyAdaptiveProtectionConfig", - "properties": { - "layer7DdosDefenseConfig": { - "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", - "description": "If set to true, enables Cloud Armor Machine Learning." - } - }, - "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP)." - }, - "InstanceGroupManagersListErrorsResponse": { - "id": "InstanceGroupManagersListErrorsResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "InstanceManagedByIgmError" + "list": { + "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", + "response": { + "$ref": "TargetHttpsProxyList" }, - "description": "[Output Only] The list of errors of the managed instance group." + "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" + }, + "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" + } + }, + "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" + ] }, - "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" - }, - "LogConfigDataAccessOptions": { - "properties": { - "logMode": { - "enum": [ - "LOG_FAIL_CLOSED", - "LOG_MODE_UNSPECIFIED" + "setSslCertificates": { + "description": "Replaces SslCertificates for TargetHttpsProxy.", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "enumDescriptions": [ - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use." + "parameterOrder": [ + "project", + "targetHttpsProxy" ], - "description": "This is deprecated and has no effect. Do not use." - } - }, - "description": "This is deprecated and has no effect. Do not use.", - "type": "object", - "id": "LogConfigDataAccessOptions" - }, - "UrlMapsAggregatedList": { - "properties": { - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#urlMapsAggregatedList" - }, - "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": { - "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\" } " - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "id": "compute.targetHttpsProxies.setSslCertificates", + "response": { + "$ref": "Operation" + }, + "httpMethod": "POST", + "request": { + "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" + }, + "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" }, - "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." - ], + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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 } - }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "type": "string" } }, - "items": { - "description": "A list of UrlMapsScopedList resources.", - "additionalProperties": { - "$ref": "UrlMapsScopedList", - "description": "Name of the scope containing this set of UrlMaps." + "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" }, - "type": "object" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - }, - "type": "object", - "id": "UrlMapsAggregatedList" - }, - "TargetSslProxy": { - "type": "object", - "id": "TargetSslProxy", - "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.", - "properties": { - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." + "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" + } + }, + "httpMethod": "GET", + "path": "projects/{project}/aggregated/targetHttpsProxies", + "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project." }, - "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.", - "enumDescriptions": [ - "", - "" + "patch": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "NONE", - "PROXY_V1" + "parameterOrder": [ + "project", + "targetHttpsProxy" ], - "type": "string" - }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - }, - "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" - }, - "kind": { - "type": "string", - "default": "compute#targetSslProxy", - "description": "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies." - }, - "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" - } - }, - "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" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "service": { - "type": "string", - "description": "URL to the BackendService resource." - }, - "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." - } - } - }, - "BackendServiceCdnPolicyBypassCacheOnRequestHeader": { - "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.", - "id": "BackendServiceCdnPolicyBypassCacheOnRequestHeader", - "type": "object", - "properties": { - "headerName": { - "type": "string", - "description": "The header field name to match on when bypassing cache. Values are case-insensitive." - } - } - }, - "UrlMapReference": { - "properties": { - "urlMap": { - "type": "string" - } - }, - "type": "object", - "id": "UrlMapReference" - }, - "TargetTcpProxiesSetProxyHeaderRequest": { - "properties": { - "proxyHeader": { - "type": "string", - "enumDescriptions": [ - "", - "" - ], - "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.", - "enum": [ - "NONE", - "PROXY_V1" - ] - } - }, - "type": "object", - "id": "TargetTcpProxiesSetProxyHeaderRequest" - }, - "PacketMirroringFilter": { - "type": "object", - "properties": { - "IPProtocols": { - "type": "array", - "items": { - "type": "string" + "httpMethod": "PATCH", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "id": "compute.targetHttpsProxies.patch", + "request": { + "$ref": "TargetHttpsProxy" }, - "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." - }, - "cidrRanges": { - "type": "array", - "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.", - "items": { - "type": "string" + "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}" + } + }, + "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" } }, - "direction": { - "enum": [ - "BOTH", - "EGRESS", - "INGRESS" + "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" ], - "type": "string", - "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." + "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" ] - } - }, - "id": "PacketMirroringFilter" - }, - "InstanceGroupsListInstances": { - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." }, - "items": { - "type": "array", - "description": "A list of InstanceWithNamedPorts resources.", - "items": { - "$ref": "InstanceWithNamedPorts" + "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." + } + }, + "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" + }, + "request": { + "$ref": "TargetHttpsProxiesSetCertificateMapRequest" } }, - "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" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "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." - ], + "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).", "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": { + "description": "Project ID for this request.", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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": { - "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" + "targetHttpsProxy": { + "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 } }, - "type": "object" + "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" }, - "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": "InstanceGroupsListInstances" - }, - "InstancesScopedList": { - "type": "object", - "id": "InstancesScopedList", - "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" - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" + "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" }, - "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" + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { + "targetHttpsProxy": { + "location": "path", + "required": true, "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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": "[Output Only] Informational warning which replaces the list of instances when the list is empty." - }, - "instances": { - "type": "array", - "items": { - "$ref": "Instance" + "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" }, - "description": "[Output Only] A list of instances contained in this scope." + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "request": { + "$ref": "SslPolicyReference" + } } } }, - "PublicDelegatedPrefixList": { - "id": "PublicDelegatedPrefixList", - "properties": { - "items": { - "description": "A list of PublicDelegatedPrefix resources.", - "items": { - "$ref": "PublicDelegatedPrefix" - }, - "type": "array" - }, - "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": { - "default": "compute#publicDelegatedPrefixList", - "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.", - "type": "string" - }, - "warning": { - "properties": { - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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." }, - "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": { + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" - ] + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "description": "Project ID for this request." }, - "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\" } " + "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" } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - }, - "type": "object" - }, - "BackendBucket": { - "type": "object", - "id": "BackendBucket", - "properties": { - "id": { - "format": "uint64", - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "Type of the resource.", - "default": "compute#backendBucket" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "bucketName": { - "description": "Cloud Storage bucket name.", - "type": "string" - }, - "compressionMode": { - "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}/securityPolicies", + "response": { + "$ref": "SecurityPolicyList" + }, + "parameterOrder": [ + "project", + "region" ], - "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.", - "type": "string", - "enum": [ - "AUTOMATIC", - "DISABLED" - ] - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "cdnPolicy": { - "description": "Cloud CDN configuration for this BackendBucket.", - "$ref": "BackendBucketCdnPolicy" - }, - "edgeSecurityPolicy": { - "type": "string", - "description": "[Output Only] The resource URL for the edge security policy associated with this backend bucket." - }, - "description": { - "type": "string", - "description": "An optional textual description of the resource; provided by the client when the resource is created." + "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" }, - "customResponseHeaders": { - "items": { - "type": "string" + "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" }, - "type": "array", - "description": "Headers that the HTTP/S load balancer should add to proxied responses." - }, - "enableCdn": { - "description": "If true, enable Cloud CDN for this BackendBucket.", - "type": "boolean" - }, - "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" - } - }, - "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." - }, - "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" - } - }, - "id": "PacketMirroringForwardingRuleInfo" - }, - "InstanceManagedByIgmErrorManagedInstanceError": { - "id": "InstanceManagedByIgmErrorManagedInstanceError", - "type": "object", - "properties": { - "message": { - "description": "[Output Only] Error message.", - "type": "string" - }, - "code": { - "type": "string", - "description": "[Output Only] Error code." - } - } - }, - "AutoscalerAggregatedList": { - "id": "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." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.", - "default": "compute#autoscalerAggregatedList" - }, - "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." - ], + "description": "Deletes the specified policy.", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "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." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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": { + "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": "[Output Only] Informational warning message.", - "type": "object" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "type": "object", - "description": "A list of AutoscalersScopedList resources.", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of autoscalers.", - "$ref": "AutoscalersScopedList" - } - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", + "httpMethod": "DELETE" }, - "unreachables": { - "items": { - "type": "string" + "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" + } }, - "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", - "type": "array" - } - }, - "type": "object" - }, - "SubnetworkLogConfig": { - "description": "The available logging options for this subnetwork.", - "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": { - "type": "string", - "enumDescriptions": [ - "", - "", - "" + "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" ], - "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" - ] - }, - "flowSampling": { - "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.", - "format": "float", - "type": "number" - }, - "enable": { - "type": "boolean", - "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." + "id": "compute.regionSecurityPolicies.patch", + "request": { + "$ref": "SecurityPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "httpMethod": "PATCH", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}" }, - "aggregationInterval": { - "enum": [ - "INTERVAL_10_MIN", - "INTERVAL_15_MIN", - "INTERVAL_1_MIN", - "INTERVAL_30_SEC", - "INTERVAL_5_MIN", - "INTERVAL_5_SEC" + "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" ], - "type": "string", - "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": [ - "", - "", - "", - "", - "", - "" + "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" ] }, - "metadataFields": { - "type": "array", - "items": { - "type": "string" + "insert": { + "parameterOrder": [ + "project", + "region" + ], + "flatPath": "projects/{project}/regions/{region}/securityPolicies", + "request": { + "$ref": "SecurityPolicy" }, - "description": "Can only be specified if VPC flow logs for this subnetwork is enabled and \"metadata\" was set to CUSTOM_METADATA." - } - }, - "id": "SubnetworkLogConfig", - "type": "object" - }, - "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": { - "type": "string", - "description": "Name of the version. Unique among all versions in the scope of this managed instance group." - } - }, - "id": "InstanceGroupManagerVersion", - "type": "object" - }, - "ResourcePoliciesScopedList": { - "properties": { - "warning": { - "type": "object", - "description": "Informational warning which replaces the list of resourcePolicies 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." - ], - "description": "[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", + "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])?))" + }, + "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" }, - "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" - } + "validateOnly": { + "location": "query", + "description": "If true, the request will not be committed.", + "type": "boolean" }, - "message": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" } - } - }, - "resourcePolicies": { - "description": "A list of resourcePolicies contained in this scope.", - "items": { - "$ref": "ResourcePolicy" }, - "type": "array" + "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." } - }, - "id": "ResourcePoliciesScopedList", - "type": "object" + } }, - "DeprecationStatus": { - "type": "object", - "id": "DeprecationStatus", - "description": "Deprecation status for a public resource.", - "properties": { - "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." - }, - "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." - }, - "state": { - "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.", - "type": "string", - "enum": [ - "ACTIVE", - "DELETED", - "DEPRECATED", - "OBSOLETE" + "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" ], - "enumDescriptions": [ - "", - "", - "", - "" + "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" ] }, - "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" - }, - "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." + "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" + ], + "httpMethod": "GET", + "flatPath": "projects/{project}/regions", + "response": { + "$ref": "RegionList" + }, + "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." + } + }, + "parameterOrder": [ + "project" + ] } } }, - "InstanceGroupManagersSetInstanceTemplateRequest": { - "properties": { - "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" - } - }, - "type": "object", - "id": "InstanceGroupManagersSetInstanceTemplateRequest" - }, - "MachineType": { - "properties": { - "kind": { - "type": "string", - "default": "compute#machineType", - "description": "[Output Only] The type of the resource. Always compute#machineType for machine types." - }, - "zone": { - "type": "string", - "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a." - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "guestCpus": { - "type": "integer", - "description": "[Output Only] The number of virtual CPUs that are available to the instance.", - "format": "int32" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "imageSpaceGb": { - "description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.", - "format": "int32", - "type": "integer" - }, - "isSharedCpu": { - "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.", - "type": "boolean" - }, - "deprecated": { - "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.", - "$ref": "DeprecationStatus" - }, - "maximumPersistentDisksSizeGb": { - "description": "[Output Only] Maximum total persistent disks size (GB) allowed.", - "type": "string", - "format": "int64" - }, - "description": { - "type": "string", - "description": "[Output Only] An optional textual description of the resource." - }, - "accelerators": { - "description": "[Output Only] A list of accelerator configurations assigned to this machine type.", - "items": { - "properties": { - "guestAcceleratorType": { - "description": "The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'.", - "type": "string" - }, - "guestAcceleratorCount": { - "type": "integer", - "format": "int32", - "description": "Number of accelerator cards exposed to the guest." - } + "networkAttachments": { + "methods": { + "aggregatedList": { + "path": "projects/{project}/aggregated/networkAttachments", + "response": { + "$ref": "NetworkAttachmentAggregatedList" + }, + "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" }, - "type": "object" + "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." + }, + "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])?))" + }, + "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" - }, - "maximumPersistentDisks": { - "type": "integer", - "format": "int32", - "description": "[Output Only] Maximum persistent disks allowed." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "memoryMb": { - "type": "integer", - "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.", - "format": "int32" - }, - "name": { - "description": "[Output Only] Name of the resource.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "flatPath": "projects/{project}/aggregated/networkAttachments" }, - "scratchDisks": { - "type": "array", - "items": { - "properties": { - "diskGb": { - "format": "int32", - "type": "integer", - "description": "Size of the scratch disk, defined in GB." - } - }, - "type": "object" + "getIamPolicy": { + "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] A list of extended scratch disks assigned to the instance." - } - }, - "type": "object", - "id": "MachineType", - "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." - }, - "Rule": { - "type": "object", - "id": "Rule", - "properties": { - "notIns": { - "items": { - "type": "string" + "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" + } }, - "type": "array", - "description": "This is deprecated and has no effect. Do not use." - }, - "description": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" + "parameterOrder": [ + "project", + "region", + "resource" + ] }, - "conditions": { - "type": "array", - "items": { - "$ref": "Condition" + "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" + } }, - "description": "This is deprecated and has no effect. Do not use." - }, - "logConfigs": { - "items": { - "$ref": "LogConfig" + "httpMethod": "POST", + "response": { + "$ref": "Policy" }, - "description": "This is deprecated and has no effect. Do not use.", - "type": "array" - }, - "permissions": { - "type": "array", - "description": "This is deprecated and has no effect. Do not use.", - "items": { - "type": "string" - } - }, - "ins": { - "items": { - "type": "string" + "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" + ], + "id": "compute.networkAttachments.setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" }, - "description": "This is deprecated and has no effect. Do not use.", - "type": "array" - }, - "action": { - "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.", - "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", + "region", + "resource" ], - "type": "string", - "enum": [ - "ALLOW", - "ALLOW_WITH_LOG", - "DENY", - "DENY_WITH_LOG", - "LOG", - "NO_ACTION" - ] - } - }, - "description": "This is deprecated and has no effect. Do not use." - }, - "NetworksGetEffectiveFirewallsResponse": { - "properties": { - "firewallPolicys": { - "items": { - "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - }, - "type": "array", - "description": "Effective firewalls from firewall policy." + "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy" }, - "firewalls": { - "type": "array", - "items": { - "$ref": "Firewall" + "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" + ], + "response": { + "$ref": "NetworkAttachmentList" }, - "description": "Effective firewalls on the network." - } - }, - "type": "object", - "id": "NetworksGetEffectiveFirewallsResponse" - }, - "UrlMapTest": { - "type": "object", - "id": "UrlMapTest", - "description": "Message for the expected URL mappings.", - "properties": { - "description": { - "description": "Description of this test case.", - "type": "string" + "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" + ], + "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" + } + } }, - "headers": { - "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value.", - "items": { - "$ref": "UrlMapTestHeader" + "insert": { + "request": { + "$ref": "NetworkAttachment" }, - "type": "array" - }, - "path": { - "description": "Path portion of the URL.", - "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" + "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" + }, + "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." + } + }, + "flatPath": "projects/{project}/regions/{region}/networkAttachments", + "parameterOrder": [ + "project", + "region" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "path": "projects/{project}/regions/{region}/networkAttachments", + "id": "compute.networkAttachments.insert", + "response": { + "$ref": "Operation" + }, + "description": "Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request." }, - "expectedOutputUrl": { - "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.", - "type": "string" + "testIamPermissions": { + "response": { + "$ref": "TestPermissionsResponse" + }, + "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 + } + }, + "httpMethod": "POST", + "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "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" + ], + "id": "compute.networkAttachments.testIamPermissions" }, - "expectedRedirectResponseCode": { - "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.", - "type": "integer" + "get": { + "description": "Returns the specified NetworkAttachment resource in the given scope.", + "parameterOrder": [ + "project", + "region", + "networkAttachment" + ], + "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" + ] }, - "service": { - "type": "string", - "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set." + "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" + ], + "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" + ] } } }, - "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" - }, - "TargetHttpsProxiesSetCertificateMapRequest": { - "properties": { - "certificateMap": { - "type": "string", - "description": "URL of the Certificate Map to associate with this TargetHttpsProxy." - } - }, - "id": "TargetHttpsProxiesSetCertificateMapRequest", - "type": "object" - }, - "OutlierDetection": { - "properties": { - "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" - }, - "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.", - "format": "int32", - "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.", - "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" - }, - "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." - }, - "enforcingConsecutiveErrors": { - "type": "integer", - "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.", - "format": "int32" - }, - "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" - }, - "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" - }, - "enforcingConsecutiveGatewayFailure": { - "format": "int32", - "type": "integer", - "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." - }, - "successRateRequestVolume": { - "format": "int32", - "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." - }, - "consecutiveGatewayFailure": { - "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.", - "type": "integer", - "format": "int32" - } - }, - "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.", - "id": "OutlierDetection", - "type": "object" - }, - "CacheKeyPolicy": { - "type": "object", - "description": "Message containing what to include in the cache key for a request for Cloud CDN.", - "id": "CacheKeyPolicy", - "properties": { - "includeHost": { - "type": "boolean", - "description": "If true, requests to different hosts will be cached separately." - }, - "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.", - "items": { - "type": "string" + "firewallPolicies": { + "methods": { + "getAssociation": { + "response": { + "$ref": "FirewallPolicyAssociation" }, - "type": "array" + "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" + ], + "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" }, - "queryStringWhitelist": { - "items": { - "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" + ], + "id": "compute.firewallPolicies.removeAssociation", + "response": { + "$ref": "Operation" }, - "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.", - "type": "array" + "httpMethod": "POST", + "parameters": { + "firewallPolicy": { + "required": true, + "description": "Name of the firewall policy to update.", + "type": "string", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "location": "path" + }, + "name": { + "location": "query", + "type": "string", + "description": "Name for the attachment that will be removed." + }, + "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": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation", + "description": "Removes an association for the specified firewall policy." }, - "includeNamedCookies": { - "type": "array", - "items": { - "type": "string" + "setIamPolicy": { + "response": { + "$ref": "Policy" }, - "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." + "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 + } + }, + "httpMethod": "POST" }, - "includeHttpHeaders": { - "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" + ], + "parameterOrder": [ + "resource" + ], + "id": "compute.firewallPolicies.testIamPermissions", + "flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions", + "response": { + "$ref": "TestPermissionsResponse" }, - "description": "Allows HTTP request headers (by name) to be used in the cache key.", - "type": "array" + "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." + } + } }, - "includeProtocol": { - "type": "boolean", - "description": "If true, http and https requests will be cached separately." + "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." }, - "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" - } - } - }, - "AdvancedMachineFeatures": { - "id": "AdvancedMachineFeatures", - "type": "object", - "properties": { - "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" - }, - "threadsPerCore": { - "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.", - "format": "int32", - "type": "integer" - }, - "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" - } - }, - "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)." - }, - "InterconnectDiagnostics": { - "properties": { - "macAddress": { - "description": "The MAC address of the Interconnect's bundle interface.", - "type": "string" - }, - "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" + "getRule": { + "description": "Gets a rule of the specified priority.", + "httpMethod": "GET", + "parameterOrder": [ + "firewallPolicy" + ], + "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" + ], + "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" + } } }, - "links": { - "type": "array", - "items": { - "$ref": "InterconnectDiagnosticsLinkStatus" + "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" + } }, - "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect." - } - }, - "id": "InterconnectDiagnostics", - "type": "object", - "description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection." - }, - "InstancesSetMachineResourcesRequest": { - "properties": { - "guestAccelerators": { - "description": "A list of the type and count of accelerator cards attached to the instance.", - "type": "array", - "items": { - "$ref": "AcceleratorConfig" + "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" } - } - }, - "id": "InstancesSetMachineResourcesRequest", - "type": "object" - }, - "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).", - "type": "object", - "id": "SecurityPolicyRule", - "properties": { - "redirectOptions": { - "$ref": "SecurityPolicyRuleRedirectOptions", - "description": "Parameters defining the redirect action. Cannot be specified for any other actions." - }, - "headerAction": { - "description": "Optional, additional actions that are performed on headers.", - "$ref": "SecurityPolicyRuleHttpHeaderAction" - }, - "match": { - "$ref": "SecurityPolicyRuleMatcher", - "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." - }, - "rateLimitOptions": { - "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions.", - "$ref": "SecurityPolicyRuleRateLimitOptions" - }, - "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" - }, - "action": { - "type": "string", - "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. " - }, - "kind": { - "type": "string", - "default": "compute#securityPolicyRule", - "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "preview": { - "type": "boolean", - "description": "If set to true, the specified action is not enforced." - } - } - }, - "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" + "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." + } + }, + "response": { + "$ref": "FirewallPoliciesListAssociationsResponse" } - } - }, - "type": "object", - "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs", - "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq" - }, - "InterconnectAttachment": { - "properties": { - "adminEnabled": { - "type": "boolean", - "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER." - }, - "customerRouterIpAddress": { - "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface 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." - }, - "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" - }, - "cloudRouterIpAddress": { - "type": "string", - "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "cloudRouterIpv6Address": { - "type": "string", - "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment." - }, - "interconnect": { - "type": "string", - "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through." - }, - "partnerMetadata": { - "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.", - "$ref": "InterconnectAttachmentPartnerMetadata" - }, - "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])?" - }, - "vlanTag8021q": { - "format": "int32", - "type": "integer", - "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time." }, - "edgeAvailabilityDomain": { - "enumDescriptions": [ - "", - "", - "" + "get": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enum": [ - "AVAILABILITY_DOMAIN_1", - "AVAILABILITY_DOMAIN_2", - "AVAILABILITY_DOMAIN_ANY" + "id": "compute.firewallPolicies.get", + "parameterOrder": [ + "firewallPolicy" ], - "type": "string", - "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." - }, - "mtu": { - "type": "integer", - "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.", - "format": "int32" - }, - "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." + "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}" }, - "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" + "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" ], - "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" + "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" ] }, - "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" - }, - "partnerAsn": { - "type": "string", - "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.", - "format": "int64" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "operationalStatus": { - "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." + "cloneRules": { + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "enum": [ - "OS_ACTIVE", - "OS_UNPROVISIONED" - ] - }, - "ipsecInternalAddresses": { - "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. ", - "type": "array", - "items": { - "type": "string" - } - }, - "satisfiesPzs": { - "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.", - "type": "boolean" - }, - "cloudRouterIpv6InterfaceId": { - "description": "This field is not available.", - "type": "string" - }, - "candidateSubnets": { - "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.", - "items": { - "type": "string" - } - }, - "description": { - "description": "An optional description of this resource.", - "type": "string" - }, - "kind": { - "default": "compute#interconnectAttachment", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments." - }, - "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\"" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "customerRouterIpv6InterfaceId": { - "description": "This field is not available.", - "type": "string" - }, - "dataplaneVersion": { - "format": "int32", - "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.", - "type": "integer" - }, - "state": { - "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", - "enum": [ - "ACTIVE", - "DEFUNCT", - "PARTNER_REQUEST_RECEIVED", - "PENDING_CUSTOMER", - "PENDING_PARTNER", - "STATE_UNSPECIFIED", - "UNPROVISIONED" + "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", + "description": "Copies rules to the specified firewall policy.", + "parameterOrder": [ + "firewallPolicy" ], - "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." - ] - }, - "candidateIpv6Subnets": { - "description": "This field is not available.", - "type": "array", - "items": { - "type": "string" + "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)." + } } }, - "stackType": { - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" + "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" ], - "type": "string", - "enumDescriptions": [ - "The interconnect attachment can have both IPv4 and IPv6 addresses.", - "The interconnect attachment will only be assigned IPv4 addresses." + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." + "id": "compute.firewallPolicies.addAssociation", + "description": "Inserts an association for the specified firewall policy.", + "request": { + "$ref": "FirewallPolicyAssociation" + } }, - "encryption": { - "enum": [ - "IPSEC", - "NONE" - ], - "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", - "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." - ] - }, - "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" - }, - "type": { - "type": "string", - "enumDescriptions": [ - "Attachment to a dedicated interconnect.", - "Attachment to a partner interconnect, created by the customer.", - "Attachment to a partner interconnect, created by the partner." + "move": { + "id": "compute.firewallPolicies.move", + "parameterOrder": [ + "firewallPolicy" ], - "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. ", - "enum": [ - "DEDICATED", - "PARTNER", - "PARTNER_PROVIDER" - ] - } - }, - "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" - }, - "LocationPolicyLocation": { - "type": "object", - "id": "LocationPolicyLocation", - "properties": { - "preference": { - "description": "Preference for a given location. Set to either ALLOW or DENY.", - "type": "string", - "enum": [ - "ALLOW", - "DENY", - "PREFERENCE_UNSPECIFIED" + "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" ], - "enumDescriptions": [ - "Location is allowed for use.", - "Location is prohibited.", - "Default value, unused." - ] - }, - "constraints": { - "$ref": "LocationPolicyLocationConstraints", - "description": "Constraints that the caller requires on the result distribution in this zone." - } - } - }, - "AllocationSpecificSKUReservation": { - "properties": { - "instanceProperties": { - "description": "The instance properties for the reservation.", - "$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties" - }, - "inUseCount": { - "type": "string", - "description": "[Output Only] Indicates how many instances are in use.", - "format": "int64" - }, - "assuredCount": { - "description": "[Output Only] Indicates how many instances are actually usable currently.", - "type": "string", - "format": "int64" - }, - "count": { - "type": "string", - "format": "int64", - "description": "Specifies the number of resources that are allocated." - } - }, - "id": "AllocationSpecificSKUReservation", - "type": "object", - "description": "This reservation type allows to pre allocate specific instance configuration. Next ID: 6" - }, - "PublicAdvertisedPrefix": { - "properties": { - "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." + "path": "locations/global/firewallPolicies/{firewallPolicy}/move", + "description": "Moves the specified firewall policy.", + "httpMethod": "POST" }, - "status": { - "type": "string", - "enum": [ - "INITIAL", - "PREFIX_CONFIGURATION_COMPLETE", - "PREFIX_CONFIGURATION_IN_PROGRESS", - "PREFIX_REMOVAL_IN_PROGRESS", - "PTR_CONFIGURED", - "REVERSE_DNS_LOOKUP_FAILED", - "VALIDATED" + "patch": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." - ] - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "ipCidrRange": { - "description": "The IPv4 address range, in CIDR format, represented by this public advertised prefix.", - "type": "string" - }, - "publicDelegatedPrefixs": { - "description": "[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.", - "type": "array", - "items": { - "$ref": "PublicAdvertisedPrefixPublicDelegatedPrefix" + "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)." + } + }, + "parameterOrder": [ + "firewallPolicy" + ], + "id": "compute.firewallPolicies.patch", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "FirewallPolicy" } }, - "sharedSecret": { - "type": "string", - "description": "[Output Only] The shared secret to be used for reverse DNS verification." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", - "format": "uint64" - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "annotations": { - "required": [ - "compute.publicAdvertisedPrefixes.insert" - ] + "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)." + } }, - "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." - }, - "dnsVerificationIp": { - "description": "The IPv4 address to be used for reverse DNS verification.", - "type": "string" - }, - "kind": { - "default": "compute#publicAdvertisedPrefix", - "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - } - }, - "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.", - "type": "object", - "id": "PublicAdvertisedPrefix" - }, - "DiskTypeList": { - "id": "DiskTypeList", - "description": "Contains a list of disk types.", - "type": "object", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "items": { - "$ref": "DiskType" + "id": "compute.firewallPolicies.removeRule", + "description": "Deletes a rule of the specified priority.", + "response": { + "$ref": "Operation" }, - "description": "A list of DiskType resources.", - "type": "array" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#diskTypeList", - "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk 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." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule" }, - "warning": { - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "patchRule": { + "parameters": { + "priority": { + "location": "query", + "description": "The priority of the rule to patch.", + "type": "integer", + "format": "int32" }, - "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" + "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": { - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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." - ], + "firewallPolicy": { "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": "Name of the firewall policy to update.", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "location": "path" } }, - "type": "object", - "description": "[Output Only] Informational warning message." + "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" + }, + "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" + }, + "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" + ], + "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" + } } } }, - "SecurityPolicyRecaptchaOptionsConfig": { - "id": "SecurityPolicyRecaptchaOptionsConfig", - "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." - } - }, - "type": "object" - }, - "UrlMapList": { - "type": "object", - "description": "Contains a list of UrlMap resources.", - "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": { - "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" - }, - "message": { + "licenses": { + "methods": { + "testIamPermissions": { + "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, "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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": { - "description": "[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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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 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": "object", - "description": "[Output Only] Informational warning message." - }, - "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 UrlMap resources.", - "type": "array", - "items": { - "$ref": "UrlMap" - } - }, - "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#urlMapList", - "type": "string" - } - }, - "id": "UrlMapList" - }, - "NodeGroupMaintenanceWindow": { - "type": "object", - "description": "Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.", - "id": "NodeGroupMaintenanceWindow", - "properties": { - "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." - }, - "maintenanceDuration": { - "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", - "$ref": "Duration" - } - } - }, - "SslPoliciesList": { - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", - "default": "compute#sslPoliciesList" + "parameterOrder": [ + "project", + "resource" + ], + "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. " }, - "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." - ], + "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": "[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" - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "description": "Project ID for this request.", + "required": true, + "location": "path" }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "required": true } }, - "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." - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "type": "array", - "description": "A list of SslPolicy resources.", - "items": { - "$ref": "SslPolicy" - } - } - }, - "type": "object", - "id": "SslPoliciesList" - }, - "FirewallPolicyAssociation": { - "properties": { - "firewallPolicyId": { - "description": "[Output Only] The firewall policy ID of the association.", - "type": "string" - }, - "attachmentTarget": { - "type": "string", - "description": "The target that the firewall policy is attached to." - }, - "name": { - "type": "string", - "description": "The name for an association." - }, - "displayName": { - "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.", - "type": "string" + "parameterOrder": [ + "project", + "resource" + ], + "id": "compute.licenses.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. *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" }, - "shortName": { - "description": "[Output Only] The short name of the firewall policy of the association.", - "type": "string" - } - }, - "id": "FirewallPolicyAssociation", - "type": "object" - }, - "SecurityPolicyRuleHttpHeaderAction": { - "id": "SecurityPolicyRuleHttpHeaderAction", - "properties": { - "requestHeadersToAdds": { - "items": { - "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption" + "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" }, - "type": "array", - "description": "The list of request headers to add or overwrite if they're already present." - } - }, - "type": "object" - }, - "ReservationList": { - "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." - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "path": "projects/{project}/global/licenses/{license}", + "id": "compute.licenses.delete", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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" + ] }, - "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": { - "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)." - } - } - } + "list": { + "id": "compute.licenses.list", + "flatPath": "projects/{project}/global/licenses", + "response": { + "$ref": "LicensesListResponse" + }, + "path": "projects/{project}/global/licenses", + "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." }, - "code": { + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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.", + "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])?))" + }, + "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" } - } - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", - "default": "compute#reservationList" + }, + "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" + ] }, - "items": { - "type": "array", - "description": "[Output Only] A list of Allocation resources.", - "items": { - "$ref": "Reservation" + "insert": { + "request": { + "$ref": "License" + }, + "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": { + "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).", + "type": "string", + "location": "query" + } + }, + "httpMethod": "POST", + "path": "projects/{project}/global/licenses", + "flatPath": "projects/{project}/global/licenses", + "id": "compute.licenses.insert", + "response": { + "$ref": "Operation" } - } - }, - "id": "ReservationList" - }, - "BackendServiceFailoverPolicy": { - "id": "BackendServiceFailoverPolicy", - "properties": { - "failoverRatio": { - "format": "float", - "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)." - }, - "dropTrafficIfUnhealthy": { - "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.", - "type": "boolean" }, - "disableConnectionDrainOnFailover": { - "type": "boolean", - "description": "This can be set to true only if the protocol is TCP. The default is false." - } - }, - "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)." - }, - "NodeGroupAggregatedList": { - "id": "NodeGroupAggregatedList", - "type": "object", - "properties": { - "kind": { - "description": "[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.", - "type": "string", - "default": "compute#nodeGroupAggregatedList" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "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.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" + "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" }, - "message": { + "project": { "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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])?))" }, - "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\" } " + "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" } } }, - "unreachables": { - "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" + ], + "response": { + "$ref": "License" }, - "type": "array", - "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" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of node groups.", - "$ref": "NodeGroupsScopedList" + "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": "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 + } }, - "description": "A list of NodeGroupsScopedList resources.", - "type": "object" + "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" } } }, - "PacketMirroringMirroredResourceInfo": { - "id": "PacketMirroringMirroredResourceInfo", - "properties": { - "subnetworks": { - "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.", - "items": { - "$ref": "PacketMirroringMirroredResourceInfoSubnetInfo" - } - }, - "tags": { - "description": "A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.", - "type": "array", - "items": { - "type": "string" - } - }, - "instances": { - "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.", - "items": { - "$ref": "PacketMirroringMirroredResourceInfoInstanceInfo" + "regionSslPolicies": { + "methods": { + "list": { + "path": "projects/{project}/regions/{region}/sslPolicies", + "httpMethod": "GET", + "response": { + "$ref": "SslPoliciesList" }, - "type": "array" - } - }, - "type": "object" - }, - "LogConfig": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "object", - "id": "LogConfig", - "properties": { - "dataAccess": { - "description": "This is deprecated and has no effect. Do not use.", - "$ref": "LogConfigDataAccessOptions" - }, - "counter": { - "description": "This is deprecated and has no effect. Do not use.", - "$ref": "LogConfigCounterOptions" - }, - "cloudAudit": { - "description": "This is deprecated and has no effect. Do not use.", - "$ref": "LogConfigCloudAuditOptions" - } - } - }, - "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.", - "properties": { - "http2HealthCheck": { - "$ref": "HTTP2HealthCheck" - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "region": { - "description": "[Output Only] Region where the health check resides. Not applicable to global health checks.", - "type": "string" - }, - "type": { - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "" + "id": "compute.regionSslPolicies.list", + "parameterOrder": [ + "project", + "region" ], - "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.", - "type": "string", - "enum": [ - "GRPC", - "HTTP", - "HTTP2", - "HTTPS", - "INVALID", - "SSL", - "TCP" + "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" + }, + "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": { + "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" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "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" - }, - "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" - }, - "httpsHealthCheck": { - "$ref": "HTTPSHealthCheck" - }, - "grpcHealthCheck": { - "$ref": "GRPCHealthCheck" - }, - "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." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in 3339 text format." - }, - "kind": { - "description": "Type of the resource.", - "type": "string", - "default": "compute#healthCheck" - }, - "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. 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." - }, - "httpHealthCheck": { - "$ref": "HTTPHealthCheck" - }, - "sslHealthCheck": { - "$ref": "SSLHealthCheck" - }, - "checkIntervalSec": { - "format": "int32", - "type": "integer", - "description": "How often (in seconds) to send a health check. The default value is 5 seconds." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "logConfig": { - "$ref": "HealthCheckLogConfig", - "description": "Configure logging on this health check." - }, - "tcpHealthCheck": { - "$ref": "TCPHealthCheck" - } - }, - "type": "object", - "id": "HealthCheck" - }, - "InterconnectAttachmentPrivateInfo": { - "type": "object", - "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.", - "format": "uint32", - "type": "integer" - } - }, - "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.", - "id": "InterconnectAttachmentPrivateInfo" - }, - "LogConfigCounterOptionsCustomField": { - "type": "object", - "description": "This is deprecated and has no effect. Do not use.", - "id": "LogConfigCounterOptionsCustomField", - "properties": { - "value": { - "type": "string", - "description": "This is deprecated and has no effect. Do not use." - }, - "name": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" - } - } - }, - "HTTPSHealthCheck": { - "type": "object", - "id": "HTTPSHealthCheck", - "properties": { - "portSpecification": { - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields.", - "type": "string", - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." + "get": { + "parameterOrder": [ + "project", + "region", + "sslPolicy" ], - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "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 + }, + "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 + }, + "sslPolicy": { + "required": true, + "type": "string", + "location": "path", + "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035." + } + }, + "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" ] }, - "requestPath": { - "type": "string", - "description": "The request path of the HTTPS health check request. The default value is /." - }, - "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", - "enumDescriptions": [ - "", - "" + "listAvailableFeatures": { + "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" - ] - }, - "response": { - "type": "string", - "description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII." - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535." - }, - "portName": { - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.", - "type": "string" - }, - "host": { - "type": "string", - "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used." - } - } - }, - "DisksResizeRequest": { - "properties": { - "sizeGb": { - "type": "string", - "format": "int64", - "description": "The new size of the persistent disk, which is specified in GB." - } - }, - "type": "object", - "id": "DisksResizeRequest" - }, - "InstanceGroupManagersSetTargetPoolsRequest": { - "type": "object", - "id": "InstanceGroupManagersSetTargetPoolsRequest", - "properties": { - "fingerprint": { - "type": "string", - "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." - }, - "targetPools": { - "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.", - "items": { - "type": "string" - } - } - } - }, - "RouteAsPath": { - "properties": { - "pathSegmentType": { - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string", - "enum": [ - "AS_CONFED_SEQUENCE", - "AS_CONFED_SET", - "AS_SEQUENCE", - "AS_SET" - ], - "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 " - }, - "asLists": { - "items": { - "format": "uint32", - "type": "integer" + "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" }, - "description": "[Output Only] The AS numbers of the AS Path.", - "type": "array" - } - }, - "id": "RouteAsPath", - "type": "object" - }, - "GRPCHealthCheck": { - "id": "GRPCHealthCheck", - "type": "object", - "properties": { - "portName": { - "type": "string", - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035." - }, - "port": { - "type": "integer", - "description": "The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.", - "format": "int32" - }, - "portSpecification": { - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, gRPC health check follows behavior specified in port and portName fields.", - "type": "string", - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." + "httpMethod": "GET", + "parameterOrder": [ + "project", + "region" ], - "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" - } - } - }, - "SslCertificateList": { - "description": "Contains a list of SslCertificate 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." - }, - "items": { - "type": "array", - "items": { - "$ref": "SslCertificate" - }, - "description": "A list of SslCertificate resources." - }, - "kind": { - "default": "compute#sslCertificateList", - "type": "string", - "description": "Type of resource." - }, - "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": { - "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\" } " + "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." }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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" - ], + "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", - "description": "[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" + }, + "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" } } }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "id": "SslCertificateList", - "type": "object" - }, - "VpnGatewayAggregatedList": { - "type": "object", - "id": "VpnGatewayAggregatedList", - "properties": { - "unreachables": { - "items": { - "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" }, - "type": "array", - "description": "[Output Only] Unreachable resources." - }, - "items": { - "type": "object", - "description": "A list of VpnGateway resources.", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of VPN gateways.", - "$ref": "VpnGatewaysScopedList" - } - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "warning": { - "properties": { - "message": { + "parameters": { + "region": { "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.", + "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.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" }, - "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" - } + "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" } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.", - "type": "string", - "default": "compute#vpnGatewayAggregatedList" - }, - "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" - } - } - }, - "Image": { - "type": "object", - "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", - "properties": { - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "annotations": { - "required": [ - "compute.images.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." + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "sourceType": { - "enum": [ - "RAW" + "patch": { + "parameterOrder": [ + "project", + "region", + "sslPolicy" ], - "description": "The type of the image used to create this disk. The default and only valid value is RAW.", - "enumDescriptions": [ - "" + "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" ], - "default": "RAW", - "type": "string" - }, - "shieldedInstanceInitialState": { - "description": "Set the secure boot keys of shielded instance.", - "$ref": "InitialStateConfig" - }, - "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." - }, - "deprecated": { - "description": "The deprecation status associated with this image.", - "$ref": "DeprecationStatus" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "diskSizeGb": { - "type": "string", - "format": "int64", - "description": "Size of the image when restored onto a persistent disk (in GB)." - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "storageLocations": { - "type": "array", - "description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", - "items": { - "type": "string" - } - }, - "rawDisk": { - "type": "object", - "description": "The parameters of the raw disk image.", - "properties": { - "containerType": { + "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", - "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.", - "enum": [ - "TAR" - ], - "enumDescriptions": [ - "" - ] + "required": true }, - "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" + "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." }, - "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.", + "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", - "pattern": "[a-f0-9]{40}" + "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" + }, + "id": "compute.regionSslPolicies.patch", + "request": { + "$ref": "SslPolicy" } }, - "family": { - "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.", - "type": "string" - }, - "archiveSizeBytes": { - "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", - "format": "int64", - "type": "string" - }, - "sourceSnapshot": { - "type": "string", - "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 " - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "insert": { + "request": { + "$ref": "SslPolicy" }, - "description": "Labels to apply to this image. These can be later modified by the setLabels method." - }, - "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 " - }, - "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" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "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 " - }, - "sourceSnapshotId": { - "type": "string", - "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." - }, - "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." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#image for images.", - "default": "compute#image" - }, - "guestOsFeatures": { - "items": { - "$ref": "GuestOsFeature" - }, - "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.", - "type": "array" - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "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" - }, - "licenses": { - "items": { - "type": "string" - }, - "description": "Any applicable license URI.", - "type": "array" - }, - "architecture": { - "type": "string", - "description": "The architecture of the image. Valid values are ARM64 or X86_64.", - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ], - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" - ] - }, - "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" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "imageEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "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." - }, - "labelFingerprint": { - "format": "byte", - "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" - }, - "status": { - "enum": [ - "DELETING", - "FAILED", - "PENDING", - "READY" + "parameterOrder": [ + "project", + "region" ], - "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.", - "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}/sslPolicies", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string" - }, - "licenseCodes": { - "type": "array", - "description": "Integer license codes indicating which licenses are attached to this image.", - "items": { - "type": "string", - "format": "int64" - } - } - }, - "id": "Image" - }, - "BackendServiceGroupHealth": { - "id": "BackendServiceGroupHealth", - "type": "object", - "properties": { - "healthStatus": { - "items": { - "$ref": "HealthStatus" + "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" + } }, - "description": "Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.", - "type": "array" - }, - "annotations": { - "description": "Metadata defined as annotations on the network endpoint group.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "kind": { - "type": "string", - "default": "compute#backendServiceGroupHealth", - "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services." + "path": "projects/{project}/regions/{region}/sslPolicies" } } }, - "ProjectsGetXpnResources": { - "id": "ProjectsGetXpnResources", - "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": { - "description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)", - "default": "compute#projectsGetXpnResources", - "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" - } - } - }, - "type": "object" - }, - "RouterBgpPeer": { - "properties": { - "ipAddress": { - "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.", - "type": "string" - }, - "interfaceName": { - "type": "string", - "description": "Name of the interface the BGP peer is associated with." - }, - "advertisedIpRanges": { - "items": { - "$ref": "RouterAdvertisedIpRange" + "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" + }, + "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" + } }, - "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." - }, - "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.", - "type": "string", - "enumDescriptions": [ - "", - "" + "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" ], - "enum": [ - "FALSE", - "TRUE" - ] - }, - "peerIpAddress": { - "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.", - "type": "string" - }, - "routerApplianceInstance": { - "type": "string", - "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." - }, - "ipv6NexthopAddress": { - "description": "IPv6 address of the interface inside Google Cloud Platform.", - "type": "string" - }, - "enableIpv6": { - "type": "boolean", - "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default." - }, - "managementType": { - "enum": [ - "MANAGED_BY_ATTACHMENT", - "MANAGED_BY_USER" + "response": { + "$ref": "Operation" + }, + "id": "compute.regionInstanceGroupManagers.patch", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" ], - "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. ", - "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." - ] - }, - "bfd": { - "description": "BFD configuration for the BGP peering.", - "$ref": "RouterBgpPeerBfd" + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}" }, - "peerAsn": { - "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.", - "type": "integer", - "annotations": { - "required": [ - "compute.routers.insert" - ] + "applyUpdatesToInstances": { + "id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances", + "httpMethod": "POST", + "response": { + "$ref": "Operation" }, - "format": "uint32" + "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." }, - "advertisedGroups": { - "items": { - "enum": [ - "ALL_SUBNETS" - ], - "enumDescriptions": [ - "Advertise all available subnets (including peer VPC subnets)." - ], - "type": "string" + "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 + } }, - "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.", - "type": "array" + "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" }, - "advertiseMode": { - "type": "string", - "description": "User-specified flag to indicate which mode to use for advertisement.", - "enumDescriptions": [ - "", - "" + "insert": { + "httpMethod": "POST", + "path": "projects/{project}/regions/{region}/instanceGroupManagers", + "parameterOrder": [ + "project", + "region" ], - "enum": [ - "CUSTOM", - "DEFAULT" + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "advertisedRoutePriority": { - "type": "integer", - "format": "uint32", - "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." + "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.", + "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": { + "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": "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" + } }, - "name": { - "annotations": { - "required": [ - "compute.routers.insert" - ] + "createInstances": { + "id": "compute.regionInstanceGroupManagers.createInstances", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "request": { + "$ref": "RegionInstanceGroupManagersCreateInstancesRequest" }, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "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." + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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." + }, + "region": { + "description": "The name of the region where the managed instance group is located. It should conform to RFC1035.", + "required": true, + "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. 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" + }, + "httpMethod": "POST", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances" }, - "peerIpv6NexthopAddress": { - "description": "IPv6 address of the BGP interface outside Google Cloud Platform.", - "type": "string" - } - }, - "type": "object", - "id": "RouterBgpPeer" - }, - "HttpFaultDelay": { - "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", - "id": "HttpFaultDelay", - "type": "object", - "properties": { - "fixedDelay": { - "description": "Specifies the value of the fixed delay interval.", - "$ref": "Duration" - }, - "percentage": { - "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", - "type": "number" - } - } - }, - "Quota": { - "type": "object", - "description": "A quotas entry.", - "properties": { - "metric": { - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "Guest CPUs", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "The total number of snapshots allowed for a single project.", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "description": "[Output Only] Name of the quota 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_FORWARDING_RULES", - "GLOBAL_INTERNAL_ADDRESSES", - "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_INSTANCE_GROUP_MANAGERS", - "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", - "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" - ], - "type": "string" - }, - "usage": { - "description": "[Output Only] Current usage of this metric.", - "type": "number", - "format": "double" - }, - "limit": { - "type": "number", - "format": "double", - "description": "[Output Only] Quota limit for this metric." - }, - "owner": { - "description": "[Output Only] Owning resource. This is the resource on which this quota is applied.", - "type": "string" - } - }, - "id": "Quota" - }, - "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", - "id": "NetworkPeering", - "properties": { - "importCustomRoutes": { - "description": "Whether to import the custom routes from peer network. The default value is false.", - "type": "boolean" - }, - "exportCustomRoutes": { - "type": "boolean", - "description": "Whether to export the custom routes to peer network. The default value is false." - }, - "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." - }, - "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." - }, - "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." - }, - "peerMtu": { - "format": "int32", - "description": "Maximum Transmission Unit in bytes.", - "type": "integer" - }, - "stackType": { - "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." - ], - "type": "string", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" - ], - "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." - }, - "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." - }, - "state": { - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "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." - ] - }, - "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." - }, - "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." - }, - "stateDetails": { - "type": "string", - "description": "[Output Only] Details about the current state of the peering." - } - } - }, - "NodeTemplatesScopedList": { - "properties": { - "nodeTemplates": { - "description": "[Output Only] A list of node templates contained in this scope.", - "items": { - "$ref": "NodeTemplate" - }, - "type": "array" - }, - "warning": { - "properties": { - "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\" } ", - "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" - }, - "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" - ] - } - }, - "type": "object", - "description": "[Output Only] An informational warning that appears when the node templates list is empty." - } - }, - "type": "object", - "id": "NodeTemplatesScopedList" - }, - "ConsistentHashLoadBalancerSettingsHttpCookie": { - "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.", - "type": "object", - "id": "ConsistentHashLoadBalancerSettingsHttpCookie", - "properties": { - "path": { - "description": "Path to set for the cookie.", - "type": "string" - }, - "ttl": { - "description": "Lifetime of the cookie.", - "$ref": "Duration" - }, - "name": { - "description": "Name of the cookie.", - "type": "string" - } - } - }, - "ReservationsScopedList": { - "type": "object", - "id": "ReservationsScopedList", - "properties": { - "warning": { - "description": "Informational warning which replaces the list of reservations when the list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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" - ], - "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." - }, - "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" - } - } - } - } - }, - "type": "object" - }, - "reservations": { - "type": "array", - "description": "A list of reservations contained in this scope.", - "items": { - "$ref": "Reservation" - } - } - } - }, - "InstanceGroupManagerAutoHealingPolicy": { - "type": "object", - "id": "InstanceGroupManagerAutoHealingPolicy", - "properties": { - "initialDelaySec": { - "type": "integer", - "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]." - }, - "healthCheck": { - "description": "The URL for the health check that signals autohealing.", - "type": "string" - } - } - }, - "Tags": { - "id": "Tags", - "type": "object", - "properties": { - "items": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.", - "items": { - "type": "string" - }, - "type": "array" - }, - "fingerprint": { - "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.", - "format": "byte" - } - }, - "description": "A set of instance tags." - }, - "ShieldedInstanceIdentityEntry": { - "properties": { - "ekPub": { - "description": "A PEM-encoded public key.", - "type": "string" - }, - "ekCert": { - "type": "string", - "description": "A PEM-encoded X.509 certificate. This field can be empty." - } - }, - "id": "ShieldedInstanceIdentityEntry", - "description": "A Shielded Instance Identity Entry.", - "type": "object" - }, - "RegionInstanceGroupManagersDeleteInstancesRequest": { - "id": "RegionInstanceGroupManagersDeleteInstancesRequest", - "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." - }, - "instances": { - "type": "array", - "items": { - "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": "object" - }, - "TargetHttpProxy": { - "id": "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": { - "id": { - "format": "uint64", - "type": "string", - "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." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "urlMap": { - "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService.", - "type": "string" - }, - "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." - }, - "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 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." - }, - "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." - }, - "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": { - "default": "compute#targetHttpProxy", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - } - } - }, - "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" - }, - "minimumRingSize": { - "format": "int64", - "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.", - "type": "string" - }, - "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" - } - } - }, - "LocationPolicy": { - "id": "LocationPolicy", - "properties": { - "locations": { - "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.", - "type": "object", - "additionalProperties": { - "$ref": "LocationPolicyLocation" - } - }, - "targetShape": { - "enum": [ - "ANY", - "ANY_SINGLE_ZONE", - "BALANCED" - ], - "type": "string", - "description": "Strategy for distributing VMs across zones in a region.", - "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." - ] - } - }, - "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).", - "type": "object" - }, - "HttpsHealthCheck": { - "id": "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": { - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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" - }, - "checkIntervalSec": { - "type": "integer", - "format": "int32", - "description": "How often (in seconds) to send a health check. The default value is 5 seconds." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "port": { - "format": "int32", - "description": "The TCP port number for the HTTPS health check request. The default value is 443.", - "type": "integer" - }, - "requestPath": { - "type": "string", - "description": "The request path of the HTTPS health check request. The default value is \"/\"." - }, - "kind": { - "description": "Type of the resource.", - "type": "string", - "default": "compute#httpsHealthCheck" - }, - "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" - }, - "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" - }, - "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." - }, - "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." - } - } - }, - "TargetReference": { - "id": "TargetReference", - "type": "object", - "properties": { - "target": { - "type": "string" - } - } - }, - "TargetTcpProxiesSetBackendServiceRequest": { - "type": "object", - "properties": { - "service": { - "description": "The URL of the new BackendService resource for the targetTcpProxy.", - "type": "string" - } - }, - "id": "TargetTcpProxiesSetBackendServiceRequest" - }, - "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" - }, - "TargetPoolsRemoveInstanceRequest": { - "properties": { - "instances": { - "type": "array", - "items": { - "$ref": "InstanceReference" - }, - "description": "URLs of the instances to be removed from target pool." - } - }, - "type": "object", - "id": "TargetPoolsRemoveInstanceRequest" - }, - "GuestAttributesEntry": { - "type": "object", - "properties": { - "namespace": { - "type": "string", - "description": "Namespace for the guest attribute entry." - }, - "value": { - "type": "string", - "description": "Value for the guest attribute entry." - }, - "key": { - "type": "string", - "description": "Key for the guest attribute entry." - } - }, - "description": "A guest attributes namespace/key/value entry.", - "id": "GuestAttributesEntry" - }, - "VpnGatewaysGetStatusResponse": { - "properties": { - "result": { - "$ref": "VpnGatewayStatus" - } - }, - "type": "object", - "id": "VpnGatewaysGetStatusResponse" - }, - "InterconnectList": { - "description": "Response to the list request, and contains a list of interconnects.", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "Interconnect" - }, - "description": "A list of Interconnect resources." - }, - "warning": { - "properties": { - "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" - ], - "description": "[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" - } - } - } - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.", - "default": "compute#interconnectList", - "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": { - "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": "InterconnectList", - "type": "object" - }, - "PreservedStatePreservedDisk": { - "type": "object", - "properties": { - "source": { - "description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", - "type": "string" - }, - "autoDelete": { - "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.", - "enumDescriptions": [ - "", - "" - ], - "type": "string", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ] - }, - "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." - ], - "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": "string" - } - }, - "id": "PreservedStatePreservedDisk" - }, - "OperationsScopedList": { - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of operations when the 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" - ], - "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." - ] - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - } - } - } - }, - "operations": { - "description": "[Output Only] A list of operations contained in this scope.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "type": "object", - "id": "OperationsScopedList" - }, - "TargetPoolAggregatedList": { - "properties": { - "items": { - "additionalProperties": { - "description": "Name of the scope containing this set of target pools.", - "$ref": "TargetPoolsScopedList" - }, - "description": "A list of TargetPool resources.", - "type": "object" - }, - "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", - "description": "[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": { - "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" - } - }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.", - "type": "string", - "default": "compute#targetPoolAggregatedList" - }, - "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." - }, - "unreachables": { - "items": { - "type": "string" - }, - "description": "[Output Only] Unreachable resources.", - "type": "array" - } - }, - "type": "object", - "id": "TargetPoolAggregatedList" - }, - "DisksRemoveResourcePoliciesRequest": { - "type": "object", - "properties": { - "resourcePolicies": { - "items": { - "type": "string" - }, - "description": "Resource policies to be removed from this disk.", - "type": "array" - } - }, - "id": "DisksRemoveResourcePoliciesRequest" - }, - "FirewallLogConfig": { - "description": "The available logging options for a firewall rule.", - "properties": { - "enable": { - "type": "boolean", - "description": "This field denotes whether to enable logging for a particular firewall rule." - }, - "metadata": { - "enum": [ - "EXCLUDE_ALL_METADATA", - "INCLUDE_ALL_METADATA" - ], - "enumDescriptions": [ - "", - "" - ], - "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" - } - }, - "type": "object", - "id": "FirewallLogConfig" - }, - "Expr": { - "id": "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": { - "location": { - "type": "string", - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", - "type": "string" - }, - "description": { - "type": "string", - "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": "object" - }, - "CorsPolicy": { - "type": "object", - "properties": { - "allowHeaders": { - "items": { - "type": "string" - }, - "description": "Specifies the content for the Access-Control-Allow-Headers header.", - "type": "array" - }, - "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" - }, - "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": { - "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.", - "format": "int32", - "type": "integer" - }, - "allowOriginRegexes": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "allowOrigins": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "exposeHeaders": { - "items": { - "type": "string" - }, - "description": "Specifies the content for the Access-Control-Expose-Headers header.", - "type": "array" - }, - "allowMethods": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specifies the content for the Access-Control-Allow-Methods 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.", - "id": "CorsPolicy" - }, - "TargetInstance": { - "type": "object", - "properties": { - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "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 " - }, - "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" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "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.", - "enum": [ - "NO_NAT" - ], - "enumDescriptions": [ - "No NAT performed." - ], - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] Creation 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." - }, - "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" - }, - "kind": { - "type": "string", - "default": "compute#targetInstance", - "description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances." - }, - "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." - } - }, - "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.", - "id": "TargetInstance" - }, - "NetworksRemovePeeringRequest": { - "properties": { - "name": { - "type": "string", - "description": "Name of the peering, which should conform to RFC1035." - } - }, - "type": "object", - "id": "NetworksRemovePeeringRequest" - }, - "FirewallPoliciesListAssociationsResponse": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "default": "compute#firewallPoliciesListAssociationsResponse", - "description": "[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations." - }, - "associations": { - "items": { - "$ref": "FirewallPolicyAssociation" - }, - "type": "array", - "description": "A list of associations." - } - }, - "id": "FirewallPoliciesListAssociationsResponse" - }, - "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." - } - }, - "id": "CacheInvalidationRule", - "type": "object" - }, - "NetworkPerformanceConfig": { - "type": "object", - "properties": { - "totalEgressBandwidthTier": { - "type": "string", - "enum": [ - "DEFAULT", - "TIER_1" - ], - "enumDescriptions": [ - "", - "" - ] - } - }, - "id": "NetworkPerformanceConfig" - }, - "HealthStatusForNetworkEndpoint": { - "properties": { - "backendService": { - "description": "URL of the backend service associated with the health state of the network endpoint.", - "$ref": "BackendServiceReference" - }, - "healthState": { - "enum": [ - "DRAINING", - "HEALTHY", - "UNHEALTHY", - "UNKNOWN" - ], - "description": "Health state of the network endpoint determined based on the health checks configured.", - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "healthCheckService": { - "$ref": "HealthCheckServiceReference", - "description": "URL of the health check service associated with the health state of the network endpoint." - }, - "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" - } - }, - "type": "object", - "id": "HealthStatusForNetworkEndpoint" - }, - "SubnetworksSetPrivateIpGoogleAccessRequest": { - "type": "object", - "properties": { - "privateIpGoogleAccess": { - "type": "boolean" - } - }, - "id": "SubnetworksSetPrivateIpGoogleAccessRequest" - }, - "NetworkEdgeSecurityService": { - "description": "Represents a Google Cloud Armor network edge security service resource.", - "id": "NetworkEdgeSecurityService", - "type": "object", - "properties": { - "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." - }, - "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" - }, - "selfLinkWithId": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource with the resource id." - }, - "kind": { - "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", - "default": "compute#networkEdgeSecurityService", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "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 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." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "securityPolicy": { - "description": "The resource URL for the network edge security service associated with this network edge security service.", - "type": "string" - } - } - }, - "ExchangedPeeringRoutesList": { - "id": "ExchangedPeeringRoutesList", - "type": "object", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - ] - }, - "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." - }, - "kind": { - "default": "compute#exchangedPeeringRoutesList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists." - }, - "items": { - "items": { - "$ref": "ExchangedPeeringRoute" - }, - "description": "A list of ExchangedPeeringRoute resources.", - "type": "array" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - } - }, - "AttachedDiskInitializeParams": { - "id": "AttachedDiskInitializeParams", - "type": "object", - "properties": { - "onUpdateAction": { - "enum": [ - "RECREATE_DISK", - "RECREATE_DISK_IF_SOURCE_CHANGED", - "USE_EXISTING_DISK" - ], - "type": "string", - "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." - ] - }, - "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. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys." - }, - "diskSizeGb": { - "type": "string", - "format": "int64", - "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." - }, - "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." - }, - "provisionedIops": { - "format": "int64", - "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." - }, - "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" - }, - "type": "object" - }, - "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." - }, - "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" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "type": "object", - "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." - }, - "architecture": { - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" - ], - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ], - "type": "string", - "description": "The architecture of the attached disk. Valid values are arm64 or x86_64." - }, - "resourcePolicies": { - "items": { - "type": "string" - }, - "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." - }, - "licenses": { - "items": { - "type": "string" - }, - "description": "A list of publicly visible licenses. Reserved for Google's use.", - "type": "array" - }, - "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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL." - } - }, - "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." - }, - "InstanceGroupManager": { - "id": "InstanceGroupManager", - "type": "object", - "properties": { - "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.", - "type": "string" - }, - "status": { - "$ref": "InstanceGroupManagerStatus", - "description": "[Output Only] The status of this managed instance group." - }, - "versions": { - "items": { - "$ref": "InstanceGroupManagerVersion" - }, - "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" - }, - "selfLink": { - "description": "[Output Only] The URL for this managed instance group. The server defines this URL.", - "type": "string" - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier." - }, - "namedPorts": { - "description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.", - "type": "array", - "items": { - "$ref": "NamedPort" - } - }, - "name": { - "annotations": { - "required": [ - "compute.instanceGroupManagers.insert", - "compute.regionInstanceGroupManagers.insert" - ] - }, - "type": "string", - "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." - }, - "description": { - "type": "string", - "description": "An optional description of this resource." - }, - "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." - }, - "region": { - "type": "string", - "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources)." - }, - "kind": { - "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.", - "type": "string", - "default": "compute#instanceGroupManager" - }, - "currentActions": { - "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.", - "$ref": "InstanceGroupManagerActionsSummary" - }, - "distributionPolicy": { - "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.", - "$ref": "DistributionPolicy" - }, - "autoHealingPolicies": { - "items": { - "$ref": "InstanceGroupManagerAutoHealingPolicy" - }, - "type": "array", - "description": "The autohealing policy for this managed instance group. You can specify only one value." - }, - "targetPools": { - "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.", - "items": { - "type": "string" - } - }, - "targetSize": { - "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.", - "annotations": { - "required": [ - "compute.instanceGroupManagers.insert", - "compute.regionInstanceGroupManagers.insert" - ] - }, - "format": "int32", - "type": "integer" - }, - "instanceGroup": { - "type": "string", - "description": "[Output Only] The URL of the Instance Group resource." - }, - "statefulPolicy": { - "description": "Stateful configuration for this Instanced Group Manager", - "$ref": "StatefulPolicy" - }, - "baseInstanceName": { - "type": "string", - "pattern": "[a-z][-a-z0-9]{0,57}", - "annotations": { - "required": [ - "compute.instanceGroupManagers.insert" - ] - }, - "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." - }, - "updatePolicy": { - "description": "The update policy for this managed instance group.", - "$ref": "InstanceGroupManagerUpdatePolicy" - }, - "zone": { - "type": "string", - "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources)." - }, - "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" - } - }, - "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." - }, - "InterconnectAttachmentsScopedList": { - "id": "InterconnectAttachmentsScopedList", - "properties": { - "interconnectAttachments": { - "type": "array", - "items": { - "$ref": "InterconnectAttachment" - }, - "description": "A list of interconnect attachments contained in this scope." - }, - "warning": { - "description": "Informational warning which replaces the list of addresses 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": { - "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" - }, - "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." - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - }, - "type": "object" - } - }, - "type": "object" - }, - "TestFailure": { - "id": "TestFailure", - "type": "object", - "properties": { - "expectedRedirectResponseCode": { - "type": "integer", - "format": "int32", - "description": "Expected HTTP status code for rule with `urlRedirect` calculated by load balancer" - }, - "headers": { - "type": "array", - "description": "HTTP headers of the request.", - "items": { - "$ref": "UrlMapTestHeader" - } - }, - "actualService": { - "type": "string", - "description": "BackendService or BackendBucket returned by load balancer." - }, - "expectedService": { - "type": "string", - "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to." - }, - "expectedOutputUrl": { - "type": "string", - "description": "The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters." - }, - "actualRedirectResponseCode": { - "type": "integer", - "format": "int32", - "description": "Actual HTTP status code for rule with `urlRedirect` calculated by load balancer" - }, - "host": { - "description": "Host portion of the URL.", - "type": "string" - }, - "actualOutputUrl": { - "type": "string", - "description": "The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters." - }, - "path": { - "type": "string", - "description": "Path portion including query parameters in the URL." - } - } - }, - "TargetVpnGateway": { - "type": "object", - "id": "TargetVpnGateway", - "properties": { - "kind": { - "type": "string", - "default": "compute#targetVpnGateway", - "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways." - }, - "status": { - "enum": [ - "CREATING", - "DELETING", - "FAILED", - "READY" - ], - "description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.", - "type": "string", - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "name": { - "annotations": { - "required": [ - "compute.targetVpnGateways.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." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "network": { - "annotations": { - "required": [ - "compute.targetVpnGateways.insert" - ] - }, - "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.", - "type": "string" - }, - "tunnels": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "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 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." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "forwardingRules": { - "items": { - "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.", - "type": "array" - }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - } - }, - "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." - }, - "RegionInstanceGroupList": { - "properties": { - "warning": { - "type": "object", - "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\" } " - }, - "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." - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "description": "[Output Only] Informational warning message." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "default": "compute#regionInstanceGroupList", - "type": "string", - "description": "The resource type." - }, - "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" - }, - "items": { - "type": "array", - "items": { - "$ref": "InstanceGroup" - }, - "description": "A list of InstanceGroup resources." - } - }, - "type": "object", - "description": "Contains a list of InstanceGroup resources.", - "id": "RegionInstanceGroupList" - }, - "InstanceConsumptionData": { - "type": "object", - "properties": { - "consumptionInfo": { - "description": "Resources consumed by the instance.", - "$ref": "InstanceConsumptionInfo" - }, - "instance": { - "type": "string", - "description": "Server-defined URL for the instance." - } - }, - "id": "InstanceConsumptionData" - }, - "TargetHttpsProxiesSetQuicOverrideRequest": { - "type": "object", - "id": "TargetHttpsProxiesSetQuicOverrideRequest", - "properties": { - "quicOverride": { - "enum": [ - "DISABLE", - "ENABLE", - "NONE" - ], - "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." - ], - "type": "string", - "description": "QUIC policy for the TargetHttpsProxy resource." - } - } - }, - "TargetHttpsProxiesSetSslCertificatesRequest": { - "id": "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." - } - } - }, - "InstanceGroupManagerUpdatePolicy": { - "id": "InstanceGroupManagerUpdatePolicy", - "properties": { - "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." - }, - "mostDisruptiveAllowedAction": { - "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." - ], - "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" - ] - }, - "maxSurge": { - "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.", - "$ref": "FixedOrPercent" - }, - "replacementMethod": { - "enumDescriptions": [ - "Instances will be recreated (with the same name)", - "Default option: instances will be deleted and created (with a new name)" - ], - "enum": [ - "RECREATE", - "SUBSTITUTE" - ], - "description": "What action should be used to replace instances. See minimal_action.REPLACE", - "type": "string" - }, - "minimalAction": { - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "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." - ], - "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": { - "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)." - ], - "enum": [ - "OPPORTUNISTIC", - "PROACTIVE" - ], - "type": "string" - }, - "instanceRedistributionType": { - "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." - ], - "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. ", - "type": "string", - "enum": [ - "NONE", - "PROACTIVE" - ] - } - }, - "type": "object" - }, - "SecurityPolicyAdvancedOptionsConfig": { - "properties": { - "logLevel": { - "type": "string", - "enum": [ - "NORMAL", - "VERBOSE" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "jsonCustomConfig": { - "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", - "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD." - }, - "jsonParsing": { - "type": "string", - "enum": [ - "DISABLED", - "STANDARD" - ], - "enumDescriptions": [ - "", - "" - ] - } - }, - "type": "object", - "id": "SecurityPolicyAdvancedOptionsConfig" - }, - "NetworkEndpointGroupsDetachEndpointsRequest": { - "type": "object", - "id": "NetworkEndpointGroupsDetachEndpointsRequest", - "properties": { - "networkEndpoints": { - "items": { - "$ref": "NetworkEndpoint" - }, - "description": "The list of network endpoints to be detached.", - "type": "array" - } - } - }, - "ForwardingRuleAggregatedList": { - "properties": { - "items": { - "description": "A list of ForwardingRulesScopedList resources.", - "type": "object", - "additionalProperties": { - "description": "Name of the scope containing this set of addresses.", - "$ref": "ForwardingRulesScopedList" - } - }, - "warning": { - "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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." - }, - "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" - } - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "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." - }, - "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": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.", - "default": "compute#forwardingRuleAggregatedList" - } - }, - "type": "object", - "id": "ForwardingRuleAggregatedList" - }, - "TargetInstanceList": { - "description": "Contains a list of TargetInstance resources.", - "type": "object", - "id": "TargetInstanceList", - "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." - ] - }, - "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" - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "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" - }, - "items": { - "type": "array", - "items": { - "$ref": "TargetInstance" - }, - "description": "A list of TargetInstance resources." - }, - "kind": { - "description": "Type of resource.", - "default": "compute#targetInstanceList", - "type": "string" - } - } - }, - "Zone": { - "type": "object", - "id": "Zone", - "properties": { - "name": { - "description": "[Output Only] Name of the resource.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "region": { - "type": "string", - "description": "[Output Only] Full URL reference to the region which hosts the zone." - }, - "availableCpuPlatforms": { - "items": { - "type": "string" - }, - "type": "array", - "description": "[Output Only] Available cpu/platform selections for the zone." - }, - "kind": { - "default": "compute#zone", - "description": "[Output Only] Type of the resource. Always compute#zone for zones.", - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "status": { - "type": "string", - "enumDescriptions": [ - "", - "" - ], - "enum": [ - "DOWN", - "UP" - ], - "description": "[Output Only] Status of the zone, either UP or DOWN." - }, - "description": { - "description": "[Output Only] Textual description of the resource.", - "type": "string" - }, - "supportsPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "[Output Only] The deprecation status associated with this zone." - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - } - }, - "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." - }, - "TargetTcpProxy": { - "id": "TargetTcpProxy", - "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.", - "properties": { - "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." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "proxyHeader": { - "enum": [ - "NONE", - "PROXY_V1" - ], - "type": "string", - "enumDescriptions": [ - "", - "" - ], - "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE." - }, - "service": { - "description": "URL to the BackendService resource.", - "type": "string" - }, - "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." - }, - "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." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.", - "default": "compute#targetTcpProxy" - }, - "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." - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - } - }, - "type": "object" - }, - "RouterStatusNatStatusNatRuleStatus": { - "id": "RouterStatusNatStatusNatRuleStatus", - "properties": { - "minExtraIpsNeeded": { - "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.", - "type": "integer", - "format": "int32" - }, - "activeNatIps": { - "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].", - "items": { - "type": "string" - }, - "type": "array" - }, - "numVmEndpointsWithNatMappings": { - "format": "int32", - "type": "integer", - "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule." - }, - "ruleNumber": { - "type": "integer", - "description": "Rule number of the rule.", - "format": "int32" - }, - "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" - } - }, - "type": "object", - "description": "Status of a NAT Rule contained in this NAT." - }, - "SslPolicy": { - "type": "object", - "id": "SslPolicy", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "minTlsVersion": { - "enum": [ - "TLS_1_0", - "TLS_1_1", - "TLS_1_2" - ], - "type": "string", - "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.", - "enumDescriptions": [ - "TLS 1.0", - "TLS 1.1", - "TLS 1.2" - ] - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "customFeatures": { - "items": { - "type": "string" - }, - "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.", - "type": "array" - }, - "kind": { - "type": "string", - "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", - "default": "compute#sslPolicy" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "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 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.", - "type": "string" - }, - "warnings": { - "type": "array", - "items": { - "properties": { - "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\" } " - }, - "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" - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - }, - "type": "object" - }, - "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages." - }, - "enabledFeatures": { - "type": "array", - "description": "[Output Only] The list of features enabled in the SSL policy.", - "items": { - "type": "string" - } - }, - "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." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "profile": { - "type": "string", - "enum": [ - "COMPATIBLE", - "CUSTOM", - "MODERN", - "RESTRICTED" - ], - "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." - ], - "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." - }, - "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" - } - }, - "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." - }, - "TargetGrpcProxy": { - "properties": { - "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." - }, - "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" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL with id for the resource.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "name": { - "annotations": { - "required": [ - "compute.targetGrpcProxies.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.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", - "type": "string", - "format": "uint64" - }, - "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" - }, - "kind": { - "default": "compute#targetGrpcProxy", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies." - }, - "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 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.", - "format": "byte", - "type": "string" - } - }, - "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.", - "id": "TargetGrpcProxy", - "type": "object" - }, - "ResourcePolicyInstanceSchedulePolicySchedule": { - "type": "object", - "id": "ResourcePolicyInstanceSchedulePolicySchedule", - "description": "Schedule for an instance operation.", - "properties": { - "schedule": { - "type": "string", - "description": "Specifies the frequency for the operation, using the unix-cron format." - } - } - }, - "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.", - "items": { - "$ref": "CustomerEncryptionKeyProtectedDisk" - }, - "type": "array" - } - }, - "type": "object", - "id": "InstancesStartWithEncryptionKeyRequest" - }, - "ErrorInfo": { - "id": "ErrorInfo", - "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\" } }", - "properties": { - "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.", - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "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\"." - }, - "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-Z0-9_]+/.", - "type": "string" - } - } - }, - "ManagedInstanceLastAttempt": { - "properties": { - "errors": { - "type": "object", - "properties": { - "errors": { - "items": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." - }, - "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" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - } - } - } - }, - "code": { - "type": "string", - "description": "[Output Only] The error type identifier for this error." - }, - "message": { - "type": "string", - "description": "[Output Only] An optional, human-readable error message." - } - } - }, - "description": "[Output Only] The array of errors encountered while processing this operation.", - "type": "array" - } - }, - "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance." - } - }, - "id": "ManagedInstanceLastAttempt", - "type": "object" - }, - "ImageList": { - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "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." - ], - "description": "[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" - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - } - }, - "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." - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "type": "array", - "items": { - "$ref": "Image" - }, - "description": "A list of Image resources." - }, - "kind": { - "description": "Type of resource.", - "type": "string", - "default": "compute#imageList" - } - }, - "type": "object", - "id": "ImageList", - "description": "Contains a list of images." - }, - "ImageFamilyView": { - "type": "object", - "properties": { - "image": { - "$ref": "Image", - "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated." - } - }, - "id": "ImageFamilyView" - }, - "RegionInstanceGroupManagersAbandonInstancesRequest": { - "type": "object", - "id": "RegionInstanceGroupManagersAbandonInstancesRequest", - "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" - } - } - } - }, - "HttpRedirectAction": { - "id": "HttpRedirectAction", - "description": "Specifies settings for an HTTP redirect.", - "type": "object", - "properties": { - "redirectResponseCode": { - "enum": [ - "FOUND", - "MOVED_PERMANENTLY_DEFAULT", - "PERMANENT_REDIRECT", - "SEE_OTHER", - "TEMPORARY_REDIRECT" - ], - "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." - ], - "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. " - }, - "prefixRedirect": { - "type": "string", - "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." - }, - "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": { - "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." - }, - "stripQuery": { - "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. ", - "type": "boolean" - }, - "httpsRedirect": { - "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.", - "type": "boolean" - } - } - }, - "InitialStateConfig": { - "id": "InitialStateConfig", - "type": "object", - "properties": { - "pk": { - "description": "The Platform Key (PK).", - "$ref": "FileContentBuffer" - }, - "keks": { - "items": { - "$ref": "FileContentBuffer" - }, - "description": "The Key Exchange Key (KEK).", - "type": "array" - }, - "dbs": { - "description": "The Key Database (db).", - "items": { - "$ref": "FileContentBuffer" - }, - "type": "array" - }, - "dbxs": { - "items": { - "$ref": "FileContentBuffer" - }, - "type": "array", - "description": "The forbidden key database (dbx)." - } - }, - "description": "Initial State for shielded instance, these are public keys which are safe to store in public" - }, - "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.", - "type": "object", - "id": "UrlMap", - "properties": { - "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" - }, - "pathMatchers": { - "type": "array", - "description": "The list of named PathMatchers to use against the URL.", - "items": { - "$ref": "PathMatcher" - } - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "hostRules": { - "type": "array", - "description": "The list of host rules to use against the URL.", - "items": { - "$ref": "HostRule" - } - }, - "fingerprint": { - "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.", - "format": "byte", - "type": "string" - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "kind": { - "default": "compute#urlMap", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps." - }, - "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])?" - }, - "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" - }, - "defaultService": { - "type": "string", - "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." - }, - "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" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "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." - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "tests": { - "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" - }, - "type": "array" - } - } - }, - "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": { - "properties": { - "contentTypes": { - "type": "array", - "items": { - "type": "string" - }, - "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." - } - }, - "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", - "type": "object" - }, - "AutoscalingPolicyScalingSchedule": { - "properties": { - "durationSec": { - "format": "int32", - "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." - }, - "minRequiredReplicas": { - "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", - "type": "integer" - }, - "description": { - "description": "A description of a scaling schedule.", - "type": "string" - }, - "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" - }, - "schedule": { - "type": "string", - "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." - }, - "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." - } - }, - "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." - }, - "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" - } - } - }, - "FirewallPolicyRule": { - "properties": { - "action": { - "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.", - "type": "string" - }, - "direction": { - "enum": [ - "EGRESS", - "INGRESS" - ], - "description": "The direction in which this rule applies.", - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "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" - }, - "kind": { - "type": "string", - "default": "compute#firewallPolicyRule", - "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules" - }, - "targetResources": { - "items": { - "type": "string" - }, - "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" - }, - "ruleTupleCount": { - "type": "integer", - "format": "int32", - "description": "[Output Only] Calculation of the complexity of a single firewall policy rule." - }, - "targetServiceAccounts": { - "items": { - "type": "string" - }, - "type": "array", - "description": "A list of service accounts indicating the sets of instances that are applied with this rule." - }, - "targetSecureTags": { - "items": { - "$ref": "FirewallPolicyRuleSecureTag" - }, - "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.", - "type": "array" - }, - "ruleName": { - "description": "An optional name for the rule. This field is not a unique identifier and can be updated.", - "type": "string" - }, - "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.", - "format": "int32", - "type": "integer" - }, - "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" - }, - "description": { - "type": "string", - "description": "An optional description for this resource." - } - }, - "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).", - "type": "object" - }, - "ServiceAttachmentList": { - "type": "object", - "id": "ServiceAttachmentList", - "properties": { - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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." - ] - }, - "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" - } - }, - "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#serviceAttachment for service attachments.", - "type": "string", - "default": "compute#serviceAttachmentList" - }, - "items": { - "type": "array", - "items": { - "$ref": "ServiceAttachment" - }, - "description": "A list of ServiceAttachment resources." - }, - "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." - } - } - }, - "VpnTunnelAggregatedList": { - "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." - }, - "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": "A list of VpnTunnelsScopedList resources.", - "additionalProperties": { - "$ref": "VpnTunnelsScopedList", - "description": "Name of the scope containing this set of VPN tunnels." - } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", - "type": "string", - "default": "compute#vpnTunnelAggregatedList" - }, - "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\" } " - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" - } - } - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object", - "id": "VpnTunnelAggregatedList" - }, - "BackendServiceAggregatedList": { - "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)." - } - } - } - }, - "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." - ] - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "type": "string" - } - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "type": "object", - "description": "A list of BackendServicesScopedList resources.", - "additionalProperties": { - "$ref": "BackendServicesScopedList", - "description": "Name of the scope containing this set of BackendServices." - } - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "kind": { - "default": "compute#backendServiceAggregatedList", - "type": "string", - "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" - } - }, - "type": "object", - "description": "Contains a list of BackendServicesScopedList.", - "id": "BackendServiceAggregatedList" - }, - "ForwardingRuleReference": { - "type": "object", - "properties": { - "forwardingRule": { - "type": "string" - } - }, - "id": "ForwardingRuleReference" - }, - "ServiceAccount": { - "type": "object", - "properties": { - "scopes": { - "items": { - "type": "string" - }, - "type": "array", - "description": "The list of scopes to be made available for this service account." - }, - "email": { - "description": "Email address of the service account.", - "type": "string" - } - }, - "id": "ServiceAccount", - "description": "A service account." - }, - "SubnetworkSecondaryRange": { - "properties": { - "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." - }, - "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." - } - }, - "type": "object", - "description": "Represents a secondary IP range of a subnetwork.", - "id": "SubnetworkSecondaryRange" - }, - "OperationAggregatedList": { - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "unreachables": { - "type": "array", - "items": { - "type": "string" - }, - "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" - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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." - }, - "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\" } " - } - } - }, - "items": { - "description": "[Output Only] A map of scoped operation lists.", - "type": "object", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of operations.", - "$ref": "OperationsScopedList" - } - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "kind": { - "default": "compute#operationAggregatedList", - "type": "string", - "description": "[Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations." - } - }, - "type": "object", - "id": "OperationAggregatedList" - }, - "FirewallPolicy": { - "description": "Represents a Firewall Policy resource.", - "id": "FirewallPolicy", - "properties": { - "ruleTupleCount": { - "type": "integer", - "format": "int32", - "description": "[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "rules": { - "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.", - "type": "array", - "items": { - "$ref": "FirewallPolicyRule" - } - }, - "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" - }, - "associations": { - "description": "A list of associations that belong to this firewall policy.", - "items": { - "$ref": "FirewallPolicyAssociation" - }, - "type": "array" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "shortName": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." - }, - "name": { - "type": "string", - "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by GCP which uniquely identifies the Organization Firewall Policy." - }, - "parent": { - "type": "string", - "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies." - }, - "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." - }, - "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." - }, - "kind": { - "type": "string", - "description": "[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies", - "default": "compute#firewallPolicy" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - } - }, - "type": "object" - }, - "TargetSslProxiesSetCertificateMapRequest": { - "type": "object", - "properties": { - "certificateMap": { - "type": "string", - "description": "URL of the Certificate Map to associate with this TargetSslProxy." - } - }, - "id": "TargetSslProxiesSetCertificateMapRequest" - }, - "BackendServiceIAP": { - "type": "object", - "description": "Identity-Aware Proxy", - "id": "BackendServiceIAP", - "properties": { - "oauth2ClientSecretSha256": { - "description": "[Output Only] SHA256 hash value for the field oauth2_client_secret above.", - "type": "string" - }, - "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" - }, - "oauth2ClientId": { - "description": "OAuth2 client ID to use for the authentication flow.", - "type": "string" - }, - "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" - } - } - }, - "VpnTunnel": { - "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.", - "id": "VpnTunnel", - "properties": { - "peerIp": { - "type": "string", - "description": "IP address of the peer VPN gateway. Only IPv4 is supported." - }, - "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" - }, - "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" - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", - "default": "compute#vpnTunnel", - "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." - }, - "peerExternalGatewayInterface": { - "format": "int32", - "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.", - "type": "integer" - }, - "detailedStatus": { - "description": "[Output Only] Detailed status message for the VPN tunnel.", - "type": "string" - }, - "vpnGatewayInterface": { - "description": "The interface ID of the VPN gateway with which this VPN tunnel is associated.", - "type": "integer", - "format": "int32" - }, - "remoteTrafficSelector": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "localTrafficSelector": { - "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" - }, - "type": "array" - }, - "sharedSecretHash": { - "type": "string", - "description": "Hash of the shared secret." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "sharedSecret": { - "type": "string", - "description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway." - }, - "router": { - "type": "string", - "description": "URL of the router resource to be used for dynamic routing." - }, - "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.vpnTunnels.insert" - ] - }, - "type": "string" - }, - "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 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" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "status": { - "type": "string", - "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." - ], - "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" - ] - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "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." - }, - "ikeVersion": { - "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.", - "type": "integer" - } - }, - "type": "object" - }, - "BackendBucketCdnPolicy": { - "properties": { - "signedUrlKeyNames": { - "description": "[Output Only] Names of the keys for signing request URLs.", - "type": "array", - "items": { - "type": "string" - } - }, - "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": { - "type": "integer", - "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." - }, - "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" - }, - "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", - "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." - ], - "enum": [ - "CACHE_ALL_STATIC", - "FORCE_CACHE_ALL", - "INVALID_CACHE_MODE", - "USE_ORIGIN_HEADERS" - ] - }, - "negativeCachingPolicy": { - "items": { - "$ref": "BackendBucketCdnPolicyNegativeCachingPolicy" - }, - "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.", - "type": "array" - }, - "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." - }, - "bypassCacheOnRequestHeaders": { - "items": { - "$ref": "BackendBucketCdnPolicyBypassCacheOnRequestHeader" - }, - "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" - }, - "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" - }, - "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": { - "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.", - "type": "string", - "format": "int64" - } - }, - "id": "BackendBucketCdnPolicy", - "type": "object", - "description": "Message containing Cloud CDN configuration for a backend bucket." - }, - "ForwardingRuleList": { - "id": "ForwardingRuleList", - "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": { - "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" - } - } - } - }, - "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": "[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" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "type": "array", - "description": "A list of ForwardingRule resources.", - "items": { - "$ref": "ForwardingRule" - } - }, - "kind": { - "default": "compute#forwardingRuleList", - "type": "string", - "description": "Type of resource." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "description": "Contains a list of ForwardingRule resources.", - "type": "object" - }, - "Firewall": { - "id": "Firewall", - "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.", - "type": "object", - "properties": { - "targetTags": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "destinationRanges": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "sourceTags": { - "items": { - "type": "string" - }, - "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." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "direction": { - "type": "string", - "enumDescriptions": [ - "Indicates that firewall should apply to outgoing traffic.", - "Indicates that firewall should apply to incoming traffic." - ], - "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.", - "enum": [ - "EGRESS", - "INGRESS" - ] - }, - "kind": { - "default": "compute#firewall", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules." - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "sourceServiceAccounts": { - "items": { - "type": "string" - }, - "type": "array", - "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." - }, - "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" - ] - }, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "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" - }, - "denied": { - "description": "The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.", - "items": { - "type": "object", - "properties": { - "ports": { - "type": "array", - "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\"]." - }, - "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": "array" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this field when you create the resource." - }, - "disabled": { - "type": "boolean", - "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." - }, - "sourceRanges": { - "items": { - "type": "string" - }, - "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." - }, - "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`.", - "type": "integer", - "format": "int32" - }, - "allowed": { - "items": { - "type": "object", - "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\"].", - "type": "array", - "items": { - "type": "string" - } - }, - "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" - } - } - }, - "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" - }, - "targetServiceAccounts": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "logConfig": { - "description": "This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.", - "$ref": "FirewallLogConfig" - } - } - }, - "AutoscalersScopedList": { - "properties": { - "autoscalers": { - "type": "array", - "description": "[Output Only] A list of autoscalers contained in this scope.", - "items": { - "$ref": "Autoscaler" - } - }, - "warning": { - "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.", - "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\" } " - }, - "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ] - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - } - } - }, - "type": "object", - "id": "AutoscalersScopedList" - }, - "InstanceGroupsSetNamedPortsRequest": { - "type": "object", - "id": "InstanceGroupsSetNamedPortsRequest", - "properties": { - "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.", - "type": "string", - "format": "byte" - }, - "namedPorts": { - "description": "The list of named ports to set for this instance group.", - "type": "array", - "items": { - "$ref": "NamedPort" - } - } - } - }, - "TargetTcpProxyList": { - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "warning": { - "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": { - "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" - }, - "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" - ] - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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" - }, - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#targetTcpProxyList" - }, - "items": { - "type": "array", - "items": { - "$ref": "TargetTcpProxy" - }, - "description": "A list of TargetTcpProxy resources." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "id": "TargetTcpProxyList", - "type": "object", - "description": "Contains a list of TargetTcpProxy resources." - }, - "RoutersPreviewResponse": { - "id": "RoutersPreviewResponse", - "type": "object", - "properties": { - "resource": { - "description": "Preview of given router.", - "$ref": "Router" - } - } - }, - "PathRule": { - "type": "object", - "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": { - "service": { - "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.", - "type": "string" - }, - "paths": { - "type": "array", - "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.", - "items": { - "type": "string" - } - }, - "urlRedirect": { - "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.", - "$ref": "HttpRedirectAction" - }, - "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" - } - } - }, - "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": { - "properties": { - "ruleVisibility": { - "enumDescriptions": [ - "", - "" - ], - "enum": [ - "PREMIUM", - "STANDARD" - ], - "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules.", - "type": "string" - }, - "enable": { - "type": "boolean", - "description": "If set to true, enables CAAP for L7 DDoS detection." - } - }, - "type": "object", - "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", - "description": "Configuration options for L7 DDoS detection." - }, - "BulkInsertInstanceResource": { - "type": "object", - "properties": { - "minCount": { - "type": "string", - "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.", - "format": "int64" - }, - "instanceProperties": { - "description": "The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.", - "$ref": "InstanceProperties" - }, - "locationPolicy": { - "description": "Policy for chosing target zone. For more information, see Create VMs in bulk .", - "$ref": "LocationPolicy" - }, - "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" - }, - "count": { - "type": "string", - "format": "int64", - "description": "The maximum number of instances to create." - }, - "perInstanceProperties": { - "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.", - "additionalProperties": { - "$ref": "BulkInsertInstanceResourcePerInstanceProperties" - } - }, - "sourceInstanceTemplate": { - "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.", - "type": "string" - } - }, - "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.", - "id": "BulkInsertInstanceResource" - }, - "ProjectsSetDefaultNetworkTierRequest": { - "type": "object", - "properties": { - "networkTier": { - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" - ], - "type": "string", - "description": "Default network tier to be set.", - "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." - ] - } - }, - "id": "ProjectsSetDefaultNetworkTierRequest" - }, - "NodeGroupAutoscalingPolicy": { - "id": "NodeGroupAutoscalingPolicy", - "properties": { - "maxNodes": { - "type": "integer", - "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." - }, - "mode": { - "type": "string", - "enumDescriptions": [ - "", - "Autoscaling is disabled.", - "Autocaling is fully enabled.", - "Autoscaling will only scale out and will not remove nodes." - ], - "description": "The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.", - "enum": [ - "MODE_UNSPECIFIED", - "OFF", - "ON", - "ONLY_SCALE_OUT" - ] - }, - "minNodes": { - "description": "The minimum number of nodes that the group should have.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "SslCertificateSelfManagedSslCertificate": { - "properties": { - "privateKey": { - "description": "A write-only private key in PEM format. Only insert requests will include this field.", - "type": "string" - }, - "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" - } - }, - "id": "SslCertificateSelfManagedSslCertificate", - "description": "Configuration and status of a self-managed SSL certificate.", - "type": "object" - }, - "TargetPool": { - "properties": { - "healthChecks": { - "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", - "items": { - "type": "string" - } - }, - "instances": { - "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" - }, - "type": "array" - }, - "region": { - "description": "[Output Only] URL of the region where the target pool resides.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string", - "format": "uint64" - }, - "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" - }, - "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.", - "type": "number", - "format": "float" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "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#targetPool for target pools.", - "type": "string", - "default": "compute#targetPool" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "sessionAffinity": { - "type": "string", - "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." - ], - "enum": [ - "CLIENT_IP", - "CLIENT_IP_NO_DESTINATION", - "CLIENT_IP_PORT_PROTO", - "CLIENT_IP_PROTO", - "GENERATED_COOKIE", - "HEADER_FIELD", - "HTTP_COOKIE", - "NONE" - ], - "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." - }, - "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 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.", - "type": "object", - "id": "TargetPool" - }, - "UrlMapsValidateResponse": { - "id": "UrlMapsValidateResponse", - "properties": { - "result": { - "$ref": "UrlMapValidationResult" - } - }, - "type": "object" - }, - "PublicDelegatedPrefix": { - "type": "object", - "id": "PublicDelegatedPrefix", - "properties": { - "parentPrefix": { - "type": "string", - "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix." - }, - "region": { - "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.", - "type": "string" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "name": { - "annotations": { - "required": [ - "compute.publicDelegatedPrefixes.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])?", - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "status": { - "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." - ], - "enum": [ - "ANNOUNCED", - "DELETING", - "INITIALIZING", - "READY_TO_ANNOUNCE" - ], - "type": "string", - "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. " - }, - "publicDelegatedSubPrefixs": { - "items": { - "$ref": "PublicDelegatedPrefixPublicDelegatedSubPrefix" - }, - "type": "array", - "description": "The list of sub public delegated prefixes that exist for this public delegated prefix." - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", - "format": "uint64" - }, - "ipCidrRange": { - "type": "string", - "description": "The IPv4 address range, in CIDR format, represented by this public delegated prefix." - }, - "isLiveMigration": { - "type": "boolean", - "description": "If true, the prefix will be live migrated." - }, - "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 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", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "kind": { - "default": "compute#publicDelegatedPrefix", - "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.", - "type": "string" - } - }, - "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." - }, - "TargetHttpProxiesScopedList": { - "type": "object", - "id": "TargetHttpProxiesScopedList", - "properties": { - "targetHttpProxies": { - "type": "array", - "description": "A list of TargetHttpProxies contained in this scope.", - "items": { - "$ref": "TargetHttpProxy" - } - }, - "warning": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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": "[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", - "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\" } " - } - }, - "description": "Informational warning which replaces the list of backend services when the list is empty." - } - } - }, - "InterconnectAttachmentList": { - "description": "Response to the list request, and contains a list of interconnect attachments.", - "type": "object", - "id": "InterconnectAttachmentList", - "properties": { - "items": { - "items": { - "$ref": "InterconnectAttachment" - }, - "type": "array", - "description": "A list of InterconnectAttachment resources." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.", - "default": "compute#interconnectAttachmentList" - }, - "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." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "warning": { - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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" - }, - "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" - } - }, - "description": "[Output Only] Informational warning message." - } - } - }, - "NodeTypeList": { - "description": "Contains a list of node types.", - "type": "object", - "id": "NodeTypeList", - "properties": { - "kind": { - "type": "string", - "default": "compute#nodeTypeList", - "description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types." - }, - "items": { - "description": "A list of NodeType resources.", - "type": "array", - "items": { - "$ref": "NodeType" - } - }, - "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": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - ] - }, - "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" - } - } - } - } - } - }, - "RouterList": { - "description": "Contains a list of Router resources.", - "id": "RouterList", - "type": "object", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "type": "array", - "items": { - "$ref": "Router" - }, - "description": "A list of Router resources." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#router for routers.", - "type": "string", - "default": "compute#routerList" - }, - "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" - }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - ] - }, - "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" - } - } - } - } - }, - "UsableSubnetworkSecondaryRange": { - "id": "UsableSubnetworkSecondaryRange", - "type": "object", - "description": "Secondary IP range of a usable subnetwork.", - "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": { - "description": "The range of IP addresses belonging to this subnetwork secondary range.", - "type": "string" - } - } - }, - "InstancesGetEffectiveFirewallsResponse": { - "properties": { - "firewallPolicys": { - "type": "array", - "description": "Effective firewalls from firewall policies.", - "items": { - "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - } - }, - "firewalls": { - "items": { - "$ref": "Firewall" - }, - "type": "array", - "description": "Effective firewalls on the instance." - } - }, - "id": "InstancesGetEffectiveFirewallsResponse", - "type": "object" - }, - "SslPoliciesScopedList": { - "type": "object", - "properties": { - "sslPolicies": { - "type": "array", - "description": "A list of SslPolicies contained in this scope.", - "items": { - "$ref": "SslPolicy" - } - }, - "warning": { - "description": "Informational warning which replaces the list of SSL policies when the list is empty.", - "type": "object", - "properties": { - "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" - ], - "description": "[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": { - "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" - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - } - } - } - }, - "id": "SslPoliciesScopedList" - }, - "SslPoliciesAggregatedList": { - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, - "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" - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - } - }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "type": "string", - "default": "compute#sslPoliciesAggregatedList", - "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies." - }, - "items": { - "description": "A list of SslPoliciesScopedList resources.", - "type": "object", - "additionalProperties": { - "description": "Name of the scope containing this set of SSL policies.", - "$ref": "SslPoliciesScopedList" - } - }, - "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" - }, - "etag": { - "type": "string" - } - }, - "id": "SslPoliciesAggregatedList", - "type": "object" - }, - "Project": { - "properties": { - "name": { - "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.", - "type": "string" - }, - "quotas": { - "items": { - "$ref": "Quota" - }, - "type": "array", - "description": "[Output Only] Quotas assigned to this project." - }, - "description": { - "type": "string", - "description": "An optional textual description of the resource." - }, - "enabledFeatures": { - "items": { - "type": "string" - }, - "type": "array", - "description": "Restricted features enabled for use on this project." - }, - "xpnProjectStatus": { - "enum": [ - "HOST", - "UNSPECIFIED_XPN_PROJECT_STATUS" - ], - "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.", - "type": "string", - "enumDescriptions": [ - "", - "" - ] - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "usageExportLocation": { - "$ref": "UsageExportLocation", - "description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored." - }, - "defaultServiceAccount": { - "type": "string", - "description": "[Output Only] Default service account used by VMs running in this project." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#project for projects.", - "default": "compute#project" - }, - "defaultNetworkTier": { - "type": "string", - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" - ], - "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.", - "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." - ] - }, - "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" - }, - "commonInstanceMetadata": { - "$ref": "Metadata", - "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information." - } - }, - "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", - "id": "Project" - }, - "Binding": { - "id": "Binding", - "type": "object", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." - }, - "bindingId": { - "type": "string", - "description": "This is deprecated and has no effect. Do not use." - }, - "role": { - "type": "string", - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`." - }, - "members": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. " - } - }, - "description": "Associates `members`, or principals, with a `role`." - }, - "Backend": { - "id": "Backend", - "description": "Message containing information of one individual backend.", - "properties": { - "balancingMode": { - "enumDescriptions": [ - "Balance based on the number of simultaneous connections.", - "Balance based on requests per second (RPS).", - "Balance based on the backend utilization." - ], - "enum": [ - "CONNECTION", - "RATE", - "UTILIZATION" - ], - "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" - }, - "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" - }, - "maxConnectionsPerInstance": { - "type": "integer", - "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." - }, - "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.", - "type": "number", - "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" - }, - "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" - }, - "maxRate": { - "type": "integer", - "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.", - "format": "int32" - }, - "maxConnectionsPerEndpoint": { - "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" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "capacityScaler": { - "format": "float", - "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." - }, - "group": { - "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.", - "type": "string" - }, - "failover": { - "type": "boolean", - "description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService." - } - }, - "type": "object" - }, - "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.", - "id": "DiskType", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "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" - }, - "name": { - "type": "string", - "description": "[Output Only] Name of the resource.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "validDiskSize": { - "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\".", - "type": "string" - }, - "zone": { - "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.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string", - "format": "uint64" - }, - "defaultDiskSizeGb": { - "description": "[Output Only] Server-defined default disk size in GB.", - "type": "string", - "format": "int64" - }, - "description": { - "description": "[Output Only] An optional description of this resource.", - "type": "string" - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#diskType for disk types.", - "default": "compute#diskType", - "type": "string" - }, - "deprecated": { - "description": "[Output Only] The deprecation status associated with this disk type.", - "$ref": "DeprecationStatus" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyList": { - "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#securityPolicyList for listsof securityPolicies", - "default": "compute#securityPolicyList" - }, - "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." - ], - "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": { - "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" - } - }, - "description": "[Output Only] Informational warning message." - }, - "items": { - "type": "array", - "items": { - "$ref": "SecurityPolicy" - }, - "description": "A list of SecurityPolicy resources." - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - }, - "type": "object", - "id": "SecurityPolicyList" - }, - "HostRule": { - "properties": { - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "hosts": { - "items": { - "type": "string" - }, - "type": "array", - "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." - }, - "pathMatcher": { - "type": "string", - "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." - } - }, - "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", - "type": "object", - "id": "HostRule" - }, - "BackendServiceCdnPolicy": { - "description": "Message containing Cloud CDN configuration for a backend service.", - "properties": { - "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" - } - }, - "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.", - "format": "int32", - "type": "integer" - }, - "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" - }, - "signedUrlKeyNames": { - "items": { - "type": "string" - }, - "description": "[Output Only] Names of the keys for signing request URLs.", - "type": "array" - }, - "cacheMode": { - "type": "string", - "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." - ] - }, - "signedUrlCacheMaxAgeSec": { - "format": "int64", - "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.", - "type": "string" - }, - "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" - }, - "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." - }, - "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" - }, - "bypassCacheOnRequestHeaders": { - "items": { - "$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader" - }, - "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" - }, - "cacheKeyPolicy": { - "$ref": "CacheKeyPolicy", - "description": "The CacheKeyPolicy for this CdnPolicy." - }, - "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" - } - }, - "id": "BackendServiceCdnPolicy", - "type": "object" - }, - "InstanceGroupManagersPatchPerInstanceConfigsReq": { - "properties": { - "perInstanceConfigs": { - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", - "type": "array", - "items": { - "$ref": "PerInstanceConfig" - } - } - }, - "id": "InstanceGroupManagersPatchPerInstanceConfigsReq", - "description": "InstanceGroupManagers.patchPerInstanceConfigs", - "type": "object" - }, - "ReservationsResizeRequest": { - "type": "object", - "id": "ReservationsResizeRequest", - "properties": { - "specificSkuCount": { - "type": "string", - "format": "int64", - "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000." - } - } - }, - "BackendServiceReference": { - "properties": { - "backendService": { - "type": "string" - } - }, - "type": "object", - "id": "BackendServiceReference" - }, - "InstanceParams": { - "description": "Additional instance params.", - "id": "InstanceParams", - "type": "object", - "properties": { - "resourceManagerTags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty." - } - } - }, - "HttpRouteRule": { - "properties": { - "headerAction": { - "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.", - "$ref": "HttpHeaderAction" - }, - "priority": { - "format": "int32", - "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." - }, - "matchRules": { - "items": { - "$ref": "HttpRouteRuleMatch" - }, - "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" - }, - "urlRedirect": { - "$ref": "HttpRedirectAction", - "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." - }, - "service": { - "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.", - "type": "string" - }, - "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." - }, - "description": { - "type": "string", - "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters." - } - }, - "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.", - "id": "HttpRouteRule", - "type": "object" - }, - "PublicDelegatedPrefixAggregatedList": { - "id": "PublicDelegatedPrefixAggregatedList", - "type": "object", - "properties": { - "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": { - "type": "object", - "additionalProperties": { - "$ref": "PublicDelegatedPrefixesScopedList", - "description": "[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes." - }, - "description": "A list of PublicDelegatedPrefixesScopedList resources." - }, - "kind": { - "default": "compute#publicDelegatedPrefixAggregatedList", - "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.", - "type": "string" - }, - "warning": { - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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": { - "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": { - "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": "[Output Only] Informational warning message.", - "type": "object" - }, - "unreachables": { - "type": "array", - "items": { - "type": "string" - }, - "description": "[Output Only] Unreachable resources." - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - } - }, - "Region": { - "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.", - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#region for regions.", - "default": "compute#region" - }, - "zones": { - "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "quotas": { - "description": "[Output Only] Quotas assigned to this region.", - "items": { - "$ref": "Quota" - }, - "type": "array" - }, - "supportsPzs": { - "type": "boolean", - "description": "[Output Only] Reserved for future use." - }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "[Output Only] The deprecation status associated with this region." - }, - "description": { - "type": "string", - "description": "[Output Only] Textual description of the resource." - }, - "name": { - "type": "string", - "description": "[Output Only] Name of the resource." - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "status": { - "enumDescriptions": [ - "", - "" - ], - "description": "[Output Only] Status of the region, either UP or DOWN.", - "enum": [ - "DOWN", - "UP" - ], - "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" - } - } - }, - "DisksScopedList": { - "id": "DisksScopedList", - "type": "object", - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.", - "type": "object", - "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": { - "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\" } " - }, - "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." - ], - "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." - } - } - }, - "disks": { - "items": { - "$ref": "Disk" - }, - "description": "[Output Only] A list of disks contained in this scope.", - "type": "array" - } - } - }, - "RoutersScopedList": { - "id": "RoutersScopedList", - "properties": { - "routers": { - "description": "A list of routers contained in this scope.", - "items": { - "$ref": "Router" - }, - "type": "array" - }, - "warning": { - "description": "Informational warning which replaces the list of routers when the list is empty.", - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" - ] - }, - "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" - } - } - } - }, - "type": "object" - }, - "UsableSubnetworksAggregatedList": { - "type": "object", - "properties": { - "warning": { - "properties": { - "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": { - "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" - } - } - } - }, - "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." - } - }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "kind": { - "default": "compute#usableSubnetworksAggregatedList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks." - }, - "items": { - "type": "array", - "description": "[Output] A list of usable subnetwork URLs.", - "items": { - "$ref": "UsableSubnetwork" - } - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is 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. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results." - } - }, - "id": "UsableSubnetworksAggregatedList" - }, - "InterconnectDiagnosticsLinkStatus": { - "properties": { - "googleDemarc": { - "type": "string", - "description": "The Demarc address assigned by Google and provided in the LoA." - }, - "receivingOpticalPower": { - "$ref": "InterconnectDiagnosticsLinkOpticalPower", - "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level." - }, - "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" - }, - "type": "array" - }, - "transmittingOpticalPower": { - "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.", - "$ref": "InterconnectDiagnosticsLinkOpticalPower" - }, - "circuitId": { - "description": "The unique ID for this link assigned during turn up by Google.", - "type": "string" - }, - "lacpStatus": { - "$ref": "InterconnectDiagnosticsLinkLACPStatus" - } - }, - "id": "InterconnectDiagnosticsLinkStatus", - "type": "object" - }, - "ReservationAffinity": { - "id": "ReservationAffinity", - "description": "Specifies the reservations that this instance can consume from.", - "properties": { - "consumeReservationType": { - "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.", - "" - ], - "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" - ] - }, - "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." - }, - "values": { - "type": "array", - "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.", - "items": { - "type": "string" - } - } - }, - "type": "object" - }, - "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": { - "type": "object", - "description": "Policy for retention of scheduled snapshots.", - "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", - "properties": { - "onSourceDiskDelete": { - "enumDescriptions": [ - "", - "", - "" - ], - "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" - ] - }, - "maxRetentionDays": { - "description": "Maximum age of the snapshot that is allowed to be kept.", - "type": "integer", - "format": "int32" - } - } - }, - "NotificationEndpointGrpcSettings": { - "id": "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.", - "properties": { - "endpoint": { - "description": "Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.", - "type": "string" - }, - "payloadName": { - "description": "Optional. If specified, this field is used to populate the \"name\" field in gRPC requests.", - "type": "string" - }, - "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" - }, - "retryDurationSec": { - "format": "uint32", - "type": "integer", - "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." - }, - "resendInterval": { - "$ref": "Duration", - "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." - } - } - }, - "InstanceConsumptionInfo": { - "type": "object", - "id": "InstanceConsumptionInfo", - "properties": { - "guestCpus": { - "description": "The number of virtual CPUs that are available to the instance.", - "format": "int32", - "type": "integer" - }, - "minNodeCpus": { - "type": "integer", - "description": "The minimal guaranteed number of virtual CPUs that are reserved.", - "format": "int32" - }, - "memoryMb": { - "description": "The amount of physical memory available to the instance, defined in MiB.", - "type": "integer", - "format": "int32" - }, - "localSsdGb": { - "format": "int32", - "description": "The amount of local SSD storage available to the instance, defined in GiB.", - "type": "integer" - } - } - }, - "NetworkEndpoint": { - "properties": { - "instance": { - "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.", - "type": "string" - }, - "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." - }, - "annotations": { - "type": "object", - "description": "Metadata defined as annotations on the network endpoint.", - "additionalProperties": { - "type": "string" - } - }, - "port": { - "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.", - "format": "int32", - "type": "integer" - }, - "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." - } - }, - "description": "The network endpoint.", - "type": "object", - "id": "NetworkEndpoint" - }, - "AutoscalerList": { - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "default": "compute#autoscalerList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers." - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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" - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "instanceGroupManager": { + "type": "string", + "required": true, + "location": "path", + "description": "The name of the managed instance group. It should conform to RFC1035." }, - "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." - ], + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" } }, - "type": "object" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "items": { - "description": "A list of Autoscaler resources.", - "type": "array", - "items": { - "$ref": "Autoscaler" - } - }, - "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." - } - }, - "description": "Contains a list of Autoscaler resources.", - "type": "object", - "id": "AutoscalerList" - }, - "NamedPort": { - "properties": { - "port": { - "description": "The port number, which can be a value between 1 and 65535.", - "type": "integer", - "format": "int32" - }, - "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.", - "type": "object", - "id": "NamedPort" - }, - "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings": { - "properties": { - "drainNatIpPortRanges": { - "items": { - "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\"]." - }, - "ruleNumber": { - "format": "int32", - "description": "Rule number of the NAT Rule.", - "type": "integer" - }, - "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.", - "type": "integer", - "format": "int32" - }, - "natIpPortRanges": { - "type": "array", - "items": { - "type": "string" - }, - "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\"]." - }, - "numTotalNatPorts": { - "type": "integer", - "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": "object", - "id": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings", - "description": "Contains information of NAT Mappings provided by a NAT Rule." - }, - "StatefulPolicyPreservedState": { - "id": "StatefulPolicyPreservedState", - "type": "object", - "properties": { - "disks": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateDiskDevice" + "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" }, - "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.", - "type": "object" - } - }, - "description": "Configuration of preserved resources." - }, - "ExchangedPeeringRoute": { - "type": "object", - "properties": { - "destRange": { - "description": "The destination range of the route.", - "type": "string" - }, - "type": { - "description": "The type of the peering route.", - "enum": [ - "DYNAMIC_PEERING_ROUTE", - "STATIC_PEERING_ROUTE", - "SUBNET_PEERING_ROUTE" + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" ], - "type": "string", - "enumDescriptions": [ - "For routes exported from local network.", - "The peering route.", - "The peering route corresponding to subnetwork range." - ] - }, - "priority": { - "type": "integer", - "format": "uint32", - "description": "The priority of the peering route." - }, - "nextHopRegion": { - "type": "string", - "description": "The region of peering route next hop, only applies to dynamic routes." - }, - "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" - }, - "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" - }, - "vmStartSchedule": { - "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", - "description": "Specifies the schedule for starting instances." - }, - "vmStopSchedule": { - "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", - "description": "Specifies the schedule for stopping instances." - } - }, - "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.", - "type": "object", - "id": "ResourcePolicyInstanceSchedulePolicy" - }, - "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.", - "type": "array", - "items": { - "type": "string" - } - }, - "fingerprint": { - "format": "byte", - "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" - } - }, - "type": "object", - "id": "RegionInstanceGroupManagersSetTargetPoolsRequest" - }, - "VpnGatewayStatusTunnel": { - "description": "Contains some information about a VPN tunnel.", - "id": "VpnGatewayStatusTunnel", - "type": "object", - "properties": { - "localGatewayInterface": { - "type": "integer", - "description": "The VPN gateway interface this VPN tunnel is associated with.", - "format": "uint32" - }, - "peerGatewayInterface": { - "type": "integer", - "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.", - "format": "uint32" - }, - "tunnelUrl": { - "type": "string", - "description": "URL reference to the VPN tunnel." - } - } - }, - "InterconnectsGetDiagnosticsResponse": { - "type": "object", - "id": "InterconnectsGetDiagnosticsResponse", - "description": "Response for the InterconnectsGetDiagnosticsRequest.", - "properties": { - "result": { - "$ref": "InterconnectDiagnostics" - } - } - }, - "Screenshot": { - "description": "An instance's screenshot.", - "id": "Screenshot", - "properties": { - "contents": { - "description": "[Output Only] The Base64-encoded screenshot data.", - "type": "string" + "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." }, - "kind": { - "default": "compute#screenshot", - "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots.", - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyRuleRedirectOptions": { - "type": "object", - "id": "SecurityPolicyRuleRedirectOptions", - "properties": { - "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" + "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", + "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, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." + } + } }, - "type": { - "enumDescriptions": [ - "", - "" + "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" ], - "type": "string", - "enum": [ - "EXTERNAL_302", - "GOOGLE_RECAPTCHA" + "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" ], - "description": "Type of the redirect action." - } - } - }, - "WafExpressionSet": { - "type": "object", - "id": "WafExpressionSet", - "properties": { - "expressions": { - "type": "array", - "description": "List of available expressions.", - "items": { - "$ref": "WafExpressionSetExpression" + "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." + } } }, - "id": { - "description": "Google specified expression set ID. The format should be: - E.g. XSS-20170329 required", - "type": "string" - }, - "aliases": { - "items": { - "type": "string" + "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" + ], + "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" + } }, - "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." - } - } - }, - "AddressList": { - "type": "object", - "description": "Contains a list of addresses.", - "id": "AddressList", - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "default": "compute#addressList", - "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.", - "type": "string" + "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`." }, - "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." + "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" + ], + "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" + ] }, - "items": { - "description": "A list of Address resources.", - "type": "array", - "items": { - "$ref": "Address" + "patchPerInstanceConfigs": { + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "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" + ], + "request": { + "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq" + }, + "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" + } } }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" + "listErrors": { + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", + "response": { + "$ref": "RegionInstanceGroupManagersListErrorsResponse" + }, + "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." + } + }, + "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", + "region", + "instanceGroupManager" + ], + "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" }, - "warning": { - "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": { - "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" - } - } - } + "deleteInstances": { + "response": { + "$ref": "Operation" + }, + "parameters": { + "region": { + "location": "path", + "type": "string", + "description": "Name of the region scoping this request.", + "required": true }, - "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, + "location": "path", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "description": "Project ID for this request." }, - "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" - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" } }, - "description": "[Output Only] Informational warning message." - } - } - }, - "TargetPoolsAddInstanceRequest": { - "type": "object", - "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" - }, - "ServiceAttachmentsScopedList": { - "type": "object", - "properties": { - "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" + ], + "request": { + "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest" + }, + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "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" + }, + "setTargetPools": { + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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" }, - "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" + "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." - ], + "region": { + "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" - ] + "description": "Name of the region scoping this request.", + "required": true } }, - "description": "Informational warning which replaces the list of service attachments when the list is empty.", - "type": "object" - }, - "serviceAttachments": { - "description": "A list of ServiceAttachments contained in this scope.", - "type": "array", - "items": { - "$ref": "ServiceAttachment" - } - } - }, - "id": "ServiceAttachmentsScopedList" - }, - "SnapshotList": { - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools" }, - "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" - }, - "message": { + "delete": { + "parameters": { + "instanceGroupManager": { + "required": true, + "description": "Name of the managed instance group to delete.", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": { + "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" } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#snapshotList" - }, - "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 Snapshot resources.", - "type": "array", - "items": { - "$ref": "Snapshot" - } - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - }, - "description": "Contains a list of Snapshot resources.", - "type": "object", - "id": "SnapshotList" - }, - "StatefulPolicyPreservedStateDiskDevice": { - "id": "StatefulPolicyPreservedStateDiskDevice", - "properties": { - "autoDelete": { - "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.", - "enumDescriptions": [ - "", - "" - ], - "type": "string", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ] - } - }, - "type": "object" - }, - "VpnGateway": { - "id": "VpnGateway", - "properties": { - "stackType": { - "enumDescriptions": [ - "Enable VPN gateway with both IPv4 and IPv6 protocols.", - "Enable VPN gateway with only IPv4 protocol." + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" ], - "type": "string", - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "vpnInterfaces": { - "type": "array", - "items": { - "$ref": "VpnGatewayVpnGatewayInterface" + "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" }, - "description": "The list of VPN interfaces associated with this VPN gateway." - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." + "id": "compute.regionInstanceGroupManagers.delete" }, - "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.vpnGateways.insert" - ] + "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" + ], + "request": { + "$ref": "RegionInstanceGroupManagersRecreateRequest" + }, + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "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" + } } }, - "kind": { - "type": "string", - "default": "compute#vpnGateway", - "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways." - }, - "region": { - "description": "[Output Only] URL of the region where the VPN gateway resides.", - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "labelFingerprint": { - "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.", - "type": "string", - "format": "byte" - }, - "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.vpnGateways.insert" - ] + "abandonInstances": { + "parameters": { + "instanceGroupManager": { + "location": "path", + "type": "string", + "description": "Name of the managed instance group.", + "required": true + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "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" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "id": "compute.regionInstanceGroupManagers.abandonInstances", + "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." - } - }, - "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 ." - }, - "RouterNatRuleAction": { - "type": "object", - "id": "RouterNatRuleAction", - "properties": { - "sourceNatDrainIps": { - "items": { - "type": "string" + "httpMethod": "POST", + "request": { + "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" }, - "type": "array", - "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." + "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" }, - "sourceNatActiveIps": { - "items": { - "type": "string" + "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" + }, + "instanceGroupManager": { + "description": "Name of the managed instance group.", + "type": "string", + "location": "path", + "required": true + }, + "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])?))" + }, + "size": { + "type": "integer", + "required": true, + "location": "query", + "description": "Number of instances that should exist in this instance group manager.", + "format": "int32", + "minimum": "0" + } }, - "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." - } - } - }, - "AutoscalingPolicyLoadBalancingUtilization": { - "id": "AutoscalingPolicyLoadBalancingUtilization", - "type": "object", - "description": "Configuration parameters of autoscaling based on load balancing.", - "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" - } - } - }, - "GuestAttributes": { - "description": "A guest attributes entry.", - "type": "object", - "id": "GuestAttributes", - "properties": { - "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" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.", - "default": "compute#guestAttributes" - }, - "variableKey": { - "type": "string", - "description": "The key to search for." - }, - "variableValue": { - "type": "string", - "description": "[Output Only] The value found for the requested key." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "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" + ] } } }, - "HttpRouteRuleMatch": { - "type": "object", - "properties": { - "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." - }, - "queryParameterMatches": { - "items": { - "$ref": "HttpQueryParameterMatch" + "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 + } }, - "type": "array", - "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." - }, - "metadataFilters": { - "items": { - "$ref": "MetadataFilter" + "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" }, - "type": "array", - "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." - }, - "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." - }, - "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. regexMatch only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED.", - "type": "string" - }, - "ignoreCase": { - "type": "boolean", - "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." + "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" + ] }, - "headerMatches": { - "type": "array", - "items": { - "$ref": "HttpHeaderMatch" + "attachNetworkEndpoints": { + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "id": "compute.networkEndpointGroups.attachNetworkEndpoints", + "httpMethod": "POST", + "request": { + "$ref": "NetworkEndpointGroupsAttachEndpointsRequest" }, - "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request." - } - }, - "id": "HttpRouteRuleMatch", - "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur." - }, - "NetworkEndpointGroupAppEngine": { - "properties": { - "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\"." - }, - "version": { - "type": "string", - "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: \"v1\", \"v2\"." + "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" + }, + "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." + } + } }, - "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", - "type": "object", - "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." - }, - "VmEndpointNatMappingsInterfaceNatMappings": { - "description": "Contain information of Nat mapping for an interface of this endpoint.", - "id": "VmEndpointNatMappingsInterfaceNatMappings", - "type": "object", - "properties": { - "numTotalDrainNatPorts": { - "type": "integer", - "format": "int32", - "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." + "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}" }, - "natIpPortRanges": { - "type": "array", - "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" + "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" + } } }, - "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\"].", - "type": "array", - "items": { - "type": "string" + "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" } }, - "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" - }, - "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\"." - }, - "sourceVirtualIp": { - "description": "Primary IP of the VM for this NIC.", - "type": "string" - }, - "ruleMappings": { - "items": { - "$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings" + "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." + }, + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 + }, + "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": "Information about mappings provided by rules in this NAT." - } - } - }, - "ResourcePolicySnapshotSchedulePolicy": { - "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." - }, - "retentionPolicy": { - "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", - "description": "Retention policy applied to snapshots created by this resource policy." - }, - "snapshotProperties": { - "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", - "description": "Properties with which snapshots are created such as labels, encryption keys." - } - }, - "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" - }, - "HttpFaultAbort": { - "description": "Specification for how requests are aborted as part of fault injection.", - "type": "object", - "properties": { - "httpStatus": { - "format": "uint32", - "type": "integer", - "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." - }, - "percentage": { - "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.", - "type": "number", - "format": "double" - } - }, - "id": "HttpFaultAbort" - }, - "PacketMirroringList": { - "id": "PacketMirroringList", - "type": "object", - "description": "Contains a list of PacketMirroring resources.", - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "default": "compute#packetMirroringList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "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." }, - "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" + "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" }, - "items": { - "items": { - "$ref": "PacketMirroring" + "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" + } }, - "description": "A list of PacketMirroring resources.", - "type": "array" + "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" }, - "warning": { - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "code": { + "zone": { + "description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.", "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." + "required": true, + "location": "path" }, - "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": { + "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" } }, - "description": "[Output Only] Informational warning message." + "path": "projects/{project}/zones/{zone}/networkEndpointGroups" } } }, - "PacketMirroring": { - "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", - "properties": { - "kind": { - "type": "string", - "default": "compute#packetMirroring", - "description": "[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings." - }, - "region": { - "type": "string", - "description": "[Output Only] URI of the region where the packetMirroring resides." - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "annotations": { - "required": [ - "compute.packetMirrorings.insert" - ] + "regionDisks": { + "methods": { + "setLabels": { + "request": { + "$ref": "RegionSetLabelsRequest" }, - "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": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "enable": { - "enumDescriptions": [ - "", - "" + "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" ], - "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.", - "type": "string", - "enum": [ - "FALSE", - "TRUE" - ] - }, - "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" - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "network": { - "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.", - "annotations": { - "required": [ - "compute.packetMirrorings.insert" - ] + "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "response": { + "$ref": "Operation" }, - "$ref": "PacketMirroringNetworkInfo" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "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." + "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels", + "httpMethod": "POST" }, - "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" - } - } - }, - "NetworkEndpointGroupsListEndpointsRequest": { - "id": "NetworkEndpointGroupsListEndpointsRequest", - "type": "object", - "properties": { - "healthStatus": { - "enum": [ - "SHOW", - "SKIP" + "createSnapshot": { + "response": { + "$ref": "Operation" + }, + "id": "compute.regionDisks.createSnapshot", + "parameterOrder": [ + "project", + "region", + "disk" ], - "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.", - "enumDescriptions": [ - "Show the health status for each network endpoint. Impacts latency of the call.", - "Health status for network endpoints will not be provided." + "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" ], - "type": "string" - } - } - }, - "TargetHttpsProxyList": { - "id": "TargetHttpsProxyList", - "type": "object", - "description": "Contains a list of TargetHttpsProxy resources.", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "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)." + } + } }, - "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" + "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" + } }, - "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." - ], + "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", - "description": "[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 }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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" }, - "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" - } + "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])?" } }, - "type": "object" - }, - "kind": { - "type": "string", - "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.", - "default": "compute#targetHttpsProxyList" - }, - "items": { - "type": "array", - "items": { - "$ref": "TargetHttpsProxy" - }, - "description": "A list of TargetHttpsProxy resources." + "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", + "id": "compute.regionDisks.setIamPolicy" }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - } - }, - "BackendServiceLocalityLoadBalancingPolicyConfigPolicy": { - "description": "The configuration for a built-in load balancing policy.", - "properties": { - "name": { - "type": "string", - "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." + "insert": { + "parameterOrder": [ + "project", + "region" ], - "enum": [ - "INVALID_LB_POLICY", - "LEAST_REQUEST", - "MAGLEV", - "ORIGINAL_DESTINATION", - "RANDOM", - "RING_HASH", - "ROUND_ROBIN" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." - } - }, - "type": "object", - "id": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy" - }, - "PacketMirroringMirroredResourceInfoSubnetInfo": { - "id": "PacketMirroringMirroredResourceInfoSubnetInfo", - "properties": { - "url": { - "type": "string", - "description": "Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored." - }, - "canonicalUrl": { - "type": "string", - "description": "[Output Only] Unique identifier for the subnetwork; defined by the server." - } - }, - "type": "object" - }, - "BackendServiceList": { - "id": "BackendServiceList", - "description": "Contains a list of BackendService 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" - }, - "items": { - "type": "array", - "items": { - "$ref": "BackendService" + "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])?))" + } }, - "description": "A list of BackendService resources." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.", - "default": "compute#backendServiceList", - "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": "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" + } }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { + "testIamPermissions": { + "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", + "response": { + "$ref": "TestPermissionsResponse" + }, + "flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", + "parameters": { + "region": { "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, + "description": "The name of the region for this request.", + "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", - "description": "[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" }, - "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" + "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" } }, - "type": "object" - } - }, - "type": "object" - }, - "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." - } - }, - "id": "WeightedBackendService", - "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" - }, - "RequestMirrorPolicy": { - "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.", - "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" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersApplyUpdatesRequest": { - "type": "object", - "id": "RegionInstanceGroupManagersApplyUpdatesRequest", - "description": "RegionInstanceGroupManagers.applyUpdatesToInstances", - "properties": { - "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." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "type": "string", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" + "parameterOrder": [ + "project", + "region", + "resource" ], - "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." + "description": "Returns permissions that a caller has on the specified resource.", + "id": "compute.regionDisks.testIamPermissions", + "httpMethod": "POST", + "request": { + "$ref": "TestPermissionsRequest" + } }, - "instances": { - "items": { - "type": "string" + "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" + } }, - "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]." + "response": { + "$ref": "Disk" + }, + "description": "Returns a specified regional persistent disk." }, - "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" + "delete": { + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." - ] - }, - "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" - } - } - }, - "InstancesSetMinCpuPlatformRequest": { - "properties": { - "minCpuPlatform": { - "description": "Minimum cpu/platform this instance should be started at.", - "type": "string" - } - }, - "type": "object", - "id": "InstancesSetMinCpuPlatformRequest" - }, - "NodeType": { - "id": "NodeType", - "type": "object", - "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.", - "properties": { - "description": { - "description": "[Output Only] An optional textual description of the resource.", - "type": "string" - }, - "memoryMb": { - "format": "int32", - "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", - "type": "integer" - }, - "deprecated": { - "$ref": "DeprecationStatus", - "description": "[Output Only] The deprecation status associated with this node type." - }, - "name": { - "description": "[Output Only] Name of the resource.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "cpuPlatform": { - "description": "[Output Only] The CPU platform used by this node type.", - "type": "string" - }, - "zone": { - "description": "[Output Only] The name of the zone where the node type resides, such as us-central1-a.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "description": "[Output Only] The type of the resource. Always compute#nodeType for node types.", - "default": "compute#nodeType", - "type": "string" - }, - "guestCpus": { - "type": "integer", - "description": "[Output Only] The number of virtual CPUs that are available to the node type.", - "format": "int32" - }, - "localSsdGb": { - "type": "integer", - "format": "int32", - "description": "[Output Only] Local SSD available to the node type, defined in GB." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - } - } - }, - "FirewallPolicyRuleMatcher": { - "properties": { - "srcSecureTags": { - "items": { - "$ref": "FirewallPolicyRuleSecureTag" + "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)." + } }, - "type": "array", - "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." - }, - "srcIpRanges": { - "items": { - "type": "string" + "response": { + "$ref": "Operation" }, - "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.", - "type": "array" + "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" + ] }, - "destIpRanges": { - "type": "array", - "items": { - "type": "string" + "removeResourcePolicies": { + "request": { + "$ref": "RegionDisksRemoveResourcePoliciesRequest" }, - "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000." - }, - "layer4Configs": { - "items": { - "$ref": "FirewallPolicyRuleMatcherLayer4Config" + "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" + } }, - "description": "Pairs of IP protocols and ports that the rule should match.", - "type": "array" - } - }, - "id": "FirewallPolicyRuleMatcher", - "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", - "type": "object" - }, - "RouterStatus": { - "id": "RouterStatus", - "properties": { - "bgpPeerStatus": { - "type": "array", - "items": { - "$ref": "RouterStatusBgpPeerStatus" - } - }, - "network": { - "type": "string", - "description": "URI of the network to which this router belongs." - }, - "natStatus": { - "items": { - "$ref": "RouterStatusNatStatus" + "response": { + "$ref": "Operation" }, - "type": "array" + "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." }, - "bestRoutes": { - "description": "Best routes for this router's network.", - "type": "array", - "items": { - "$ref": "Route" + "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" } }, - "bestRoutesForRouter": { - "items": { - "$ref": "Route" + "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 + } }, - "type": "array", - "description": "Best routes learned by this router." + "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" } - }, - "type": "object" + } }, - "MachineTypesScopedList": { - "type": "object", - "properties": { - "machineTypes": { - "items": { - "$ref": "MachineType" + "regionCommitments": { + "methods": { + "list": { + "response": { + "$ref": "CommitmentList" }, - "description": "[Output Only] A list of machine types contained in this scope.", - "type": "array" - }, - "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": { - "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\" } " + "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": { - "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])?))", + "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" }, - "code": { + "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": "[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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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] An informational warning that appears when the machine types list is empty." - } - }, - "id": "MachineTypesScopedList" - }, - "BfdStatusPacketCounts": { - "properties": { - "numRxSuccessful": { - "format": "uint32", - "description": "Number of packets received that were successfully processed 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": { - "format": "uint32", - "type": "integer", - "description": "Number of packets transmitted since the beginning of the current BFD session." - }, - "numRx": { - "format": "uint32", - "description": "Number of packets received since the beginning of the current BFD session.", - "type": "integer" - } - }, - "type": "object", - "id": "BfdStatusPacketCounts" - }, - "AcceleratorTypeList": { - "id": "AcceleratorTypeList", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "kind": { - "type": "string", - "default": "compute#acceleratorTypeList", - "description": "[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types." + "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" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "description": "update_mask indicates fields to be updated as part of this request.", + "location": "query", + "format": "google-fieldmask" }, - "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.", + "commitment": { + "description": "Name of the commitment for which auto renew is being updated.", + "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" - ] + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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" - }, - "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" + }, + "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])?" } }, - "type": "object" - }, - "items": { - "type": "array", - "items": { - "$ref": "AcceleratorType" + "response": { + "$ref": "Operation" }, - "description": "A list of AcceleratorType 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." + "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" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "description": "Contains a list of accelerator types.", - "type": "object" - }, - "RouterStatusNatStatus": { - "description": "Status of a NAT contained in this router.", - "id": "RouterStatusNatStatus", - "properties": { - "drainUserAllocatedNatIps": { - "items": { - "type": "string" + "insert": { + "httpMethod": "POST", + "response": { + "$ref": "Operation" }, - "type": "array", - "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"]." - }, - "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" + "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])?))" + } }, - "type": "array" - }, - "ruleStatus": { - "description": "Status of rules in this NAT.", - "items": { - "$ref": "RouterStatusNatStatusNatRuleStatus" + "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" }, - "type": "array" - }, - "numVmEndpointsWithNatMappings": { - "description": "Number of VM endpoints (i.e., Nics) that can use NAT.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Unique name of this NAT.", - "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." - }, - "userAllocatedNatIpResources": { - "type": "array", - "description": "A list of fully qualified URLs of reserved IP address resources.", - "items": { - "type": "string" - } + "parameterOrder": [ + "project", + "region" + ] }, - "autoAllocatedNatIps": { - "items": { - "type": "string" + "aggregatedList": { + "httpMethod": "GET", + "response": { + "$ref": "CommitmentAggregatedList" }, - "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]", - "type": "array" + "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." }, - "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" - } - } - }, - "type": "object" - }, - "StatefulPolicy": { - "id": "StatefulPolicy", - "type": "object", - "properties": { - "preservedState": { - "$ref": "StatefulPolicyPreservedState" + "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" } } }, - "VpnGatewayStatusVpnConnection": { - "properties": { - "tunnels": { - "items": { - "$ref": "VpnGatewayStatusTunnel" + "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 + } }, - "description": "List of VPN tunnels that are in this VPN connection.", - "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" - }, - "state": { - "$ref": "VpnGatewayStatusHighAvailabilityRequirementState", - "description": "HighAvailabilityRequirementState for the VPN connection." - }, - "peerExternalGateway": { - "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.", - "type": "string" - } - }, - "id": "VpnGatewayStatusVpnConnection", - "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.", - "type": "object" - }, - "AutoscalingPolicy": { - "id": "AutoscalingPolicy", - "description": "Cloud Autoscaler policy.", - "properties": { - "loadBalancingUtilization": { - "description": "Configuration parameters of autoscaling based on load balancer.", - "$ref": "AutoscalingPolicyLoadBalancingUtilization" - }, - "customMetricUtilizations": { - "type": "array", - "items": { - "$ref": "AutoscalingPolicyCustomMetricUtilization" + "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" }, - "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" - }, - "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" + "path": "projects/{project}/regions/{region}/sslCertificates", + "parameterOrder": [ + "project", + "region" + ], + "request": { + "$ref": "SslCertificate" + } }, - "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." + "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" ], - "description": "Defines operating mode for this policy.", - "type": "string", - "enum": [ - "OFF", - "ON", - "ONLY_SCALE_OUT", - "ONLY_UP" + "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "httpMethod": "GET", + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", + "parameterOrder": [ + "project", + "region", + "sslCertificate" ] }, - "scaleInControl": { - "$ref": "AutoscalingPolicyScaleInControl" - }, - "minNumReplicas": { - "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.", - "format": "int32" - }, - "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" - } - }, - "coolDownPeriodSec": { - "format": "int32", - "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" - } - }, - "type": "object" - }, - "AutoscalerStatusDetails": { - "type": "object", - "id": "AutoscalerStatusDetails", - "properties": { - "message": { - "type": "string", - "description": "The status message." + "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" + ] }, - "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.", - "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." + "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" ], - "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" + "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.regionSslCertificates.list" } } }, - "ServiceAttachment": { - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", - "default": "compute#serviceAttachment" - }, - "connectedEndpoints": { - "description": "[Output Only] An array of connections for all the consumers connected to this service attachment.", - "items": { - "$ref": "ServiceAttachmentConnectedEndpoint" - }, - "type": "array" - }, - "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." - }, - "region": { - "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.", - "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 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" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "consumerRejectLists": { - "items": { - "type": "string" - }, - "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.", - "type": "array" - }, - "producerForwardingRule": { - "type": "string", - "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment." - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier." - }, - "natSubnets": { - "items": { - "type": "string" + "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" }, - "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" - }, - "connectionPreference": { - "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.", - "enum": [ - "ACCEPT_AUTOMATIC", - "ACCEPT_MANUAL", - "CONNECTION_PREFERENCE_UNSPECIFIED" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "enumDescriptions": [ - "", - "", - "" + "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" ] }, - "consumerAcceptLists": { - "type": "array", - "items": { - "$ref": "ServiceAttachmentConsumerProjectLimit" + "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." + } }, - "description": "Projects that are allowed to connect to this service attachment." - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "annotations": { - "required": [ - "compute.serviceAttachments.insert" - ] + "httpMethod": "PATCH", + "id": "compute.networks.updatePeering", + "parameterOrder": [ + "project", + "network" + ], + "path": "projects/{project}/global/networks/{network}/updatePeering", + "request": { + "$ref": "NetworksUpdatePeeringRequest" }, - "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" - }, - "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" + "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" } }, - "pscServiceAttachmentId": { - "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment.", - "$ref": "Uint128" - }, - "targetService": { - "type": "string", - "description": "The URL of a service serving the endpoint identified by this service attachment." - } - }, - "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", - "id": "ServiceAttachment" - }, - "InterconnectAttachmentPartnerMetadata": { - "properties": { - "partnerName": { - "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.", - "type": "string" - }, - "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": { - "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." - } - }, - "id": "InterconnectAttachmentPartnerMetadata", - "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.", - "type": "object" - }, - "HttpsHealthCheckList": { - "properties": { - "items": { - "items": { - "$ref": "HttpsHealthCheck" + "list": { + "parameterOrder": [ + "project" + ], + "id": "compute.networks.list", + "httpMethod": "GET", + "path": "projects/{project}/global/networks", + "response": { + "$ref": "NetworkList" }, - "type": "array", - "description": "A list of HttpsHealthCheck resources." - }, - "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" - ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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`." }, - "message": { - "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": { - "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", + "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" } - }, - "type": "object" - }, - "kind": { - "default": "compute#httpsHealthCheckList", - "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." - } - }, - "id": "HttpsHealthCheckList", - "type": "object", - "description": "Contains a list of HttpsHealthCheck resources." - }, - "PublicAdvertisedPrefixList": { - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.", - "default": "compute#publicAdvertisedPrefixList" - }, - "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": "array", - "description": "A list of PublicAdvertisedPrefix resources.", - "items": { - "$ref": "PublicAdvertisedPrefix" } }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "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" - ], + "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", - "description": "[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-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": { - "description": "[Output Only] A warning data value corresponding to the key.", - "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": { + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "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": "[Output Only] Informational warning message." - } - }, - "type": "object", - "id": "PublicAdvertisedPrefixList" - }, - "SourceInstanceParams": { - "properties": { - "diskConfigs": { - "type": "array", - "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" + "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" + } } - } - }, - "type": "object", - "id": "SourceInstanceParams", - "description": "A specification of the parameters to use when creating the instance template from a source instance." - }, - "NetworkEndpointGroupsScopedList": { - "id": "NetworkEndpointGroupsScopedList", - "type": "object", - "properties": { - "networkEndpointGroups": { - "items": { - "$ref": "NetworkEndpointGroup" + }, + "delete": { + "response": { + "$ref": "Operation" }, - "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", - "type": "array" + "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" }, - "warning": { - "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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.", + "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": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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." ], "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" + ], + "location": "query", + "description": "The direction of the exchanged routes." }, - "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": { + "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" } - } - } - } - }, - "NodeGroupsSetNodeTemplateRequest": { - "properties": { - "nodeTemplate": { - "description": "Full or partial URL of the node template resource to be updated for this node group.", - "type": "string" - } - }, - "type": "object", - "id": "NodeGroupsSetNodeTemplateRequest" - }, - "GuestAttributesValue": { - "id": "GuestAttributesValue", - "type": "object", - "description": "Array of guest attribute namespace/key/value tuples.", - "properties": { - "items": { - "items": { - "$ref": "GuestAttributesEntry" }, - "type": "array" - } - } - }, - "InstanceGroupManagersApplyUpdatesRequest": { - "properties": { - "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": "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" ], - "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" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "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": { - "type": "array", - "items": { - "type": "string" - }, - "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]." - }, - "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.", - "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." + "patch": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" + "parameterOrder": [ + "project", + "network" ], - "type": "string" - } - }, - "type": "object", - "description": "InstanceGroupManagers.applyUpdatesToInstances", - "id": "InstanceGroupManagersApplyUpdatesRequest" - }, - "SslCertificatesScopedList": { - "properties": { - "sslCertificates": { - "type": "array", - "items": { - "$ref": "SslCertificate" + "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" }, - "description": "List of SslCertificates contained in this scope." + "id": "compute.networks.patch", + "flatPath": "projects/{project}/global/networks/{network}" }, - "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": { - "type": "string", - "description": "[Output Only] A warning data value corresponding to the key." - } - }, - "type": "object" - } + "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])?))" }, - "code": { + "network": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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" - ] + "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." }, - "message": { + "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", - "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": "Informational warning which replaces the list of backend services when the list is empty." - } - }, - "id": "SslCertificatesScopedList", - "type": "object" - }, - "SecurityPolicyDdosProtectionConfig": { - "properties": { - "ddosProtection": { - "type": "string", - "enum": [ - "ADVANCED", - "STANDARD" - ], - "enumDescriptions": [ - "", - "" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] } - }, - "type": "object", - "id": "SecurityPolicyDdosProtectionConfig" + } }, - "RouterAggregatedList": { - "type": "object", - "id": "RouterAggregatedList", - "description": "Contains a list of routers.", - "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" - }, - "unreachables": { - "type": "array", - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "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." + } } }, - "items": { - "additionalProperties": { - "description": "Name of the scope containing this set of routers.", - "$ref": "RoutersScopedList" + "insert": { + "response": { + "$ref": "Operation" }, - "description": "A list of Router resources.", - "type": "object" - }, - "kind": { - "description": "Type of resource.", - "type": "string", - "default": "compute#routerAggregatedList" - }, - "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" + "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" }, - "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." - } - } - }, - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "type": "array" } }, - "type": "object" - } - } - }, - "PreconfiguredWafSet": { - "type": "object", - "id": "PreconfiguredWafSet", - "properties": { - "expressionSets": { - "type": "array", - "items": { - "$ref": "WafExpressionSet" + "request": { + "$ref": "HttpHealthCheck" }, - "description": "List of entities that are currently supported for WAF rules." - } - } - }, - "LicenseCodeLicenseAlias": { - "id": "LicenseCodeLicenseAlias", - "type": "object", - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] URL of license corresponding to this License Code." - }, - "description": { - "type": "string", - "description": "[Output Only] Description of this License Code." - } - } - }, - "ZoneSetLabelsRequest": { - "properties": { - "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.", - "type": "string", - "format": "byte" - }, - "labels": { - "description": "The labels to set for this resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "ZoneSetLabelsRequest", - "type": "object" - }, - "RouterBgpPeerBfd": { - "type": "object", - "properties": { - "minReceiveInterval": { - "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", - "type": "integer" + "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" }, - "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" + "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}" }, - "multiplier": { - "format": "uint32", - "type": "integer", - "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." + "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." }, - "sessionInitializationMode": { - "type": "string", - "enum": [ - "ACTIVE", - "DISABLED", - "PASSIVE" + "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" ], - "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": "RouterBgpPeerBfd" - }, - "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.", - "properties": { - "nanos": { - "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", - "format": "int32" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "response": { + "$ref": "Operation" + } }, - "seconds": { - "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", - "format": "int64" - } - }, - "id": "Duration", - "type": "object" - }, - "VpnGatewayList": { - "description": "Contains a list of VpnGateway resources.", - "id": "VpnGatewayList", - "properties": { - "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" + "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" }, - "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" - ], + "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." + "description": "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": { + "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", - "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])?))", + "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`." } - } - }, - "items": { - "description": "A list of VpnGateway resources.", - "type": "array", - "items": { - "$ref": "VpnGateway" - } - }, - "kind": { - "type": "string", - "default": "compute#vpnGatewayList", - "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways." - }, - "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": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "type": "object" - }, - "TargetSslProxiesSetProxyHeaderRequest": { - "type": "object", - "properties": { - "proxyHeader": { - "enumDescriptions": [ - "", - "" + }, + "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" ], - "type": "string", - "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.", - "enum": [ - "NONE", - "PROXY_V1" - ] + "parameterOrder": [ + "project" + ], + "flatPath": "projects/{project}/global/httpHealthChecks", + "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.", + "path": "projects/{project}/global/httpHealthChecks" } - }, - "id": "TargetSslProxiesSetProxyHeaderRequest" + } }, - "NetworkEndpointGroupsAttachEndpointsRequest": { - "type": "object", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be attached.", - "items": { - "$ref": "NetworkEndpoint" + "interconnectLocations": { + "methods": { + "list": { + "response": { + "$ref": "InterconnectLocationList" }, - "type": "array" - } - }, - "id": "NetworkEndpointGroupsAttachEndpointsRequest" - }, - "ScalingScheduleStatus": { - "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." - }, - "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": { - "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." + "description": "Retrieves the list of interconnect locations available to the specified project.", + "flatPath": "projects/{project}/global/interconnectLocations", + "parameterOrder": [ + "project" ], - "type": "string", - "enum": [ - "ACTIVE", - "DISABLED", - "OBSOLETE", - "READY" - ] - } - }, - "type": "object" - }, - "NetworkEdgeSecurityServicesScopedList": { - "type": "object", - "properties": { - "warning": { - "description": "Informational warning which replaces the list of security policies when the list is empty.", - "properties": { - "code": { + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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." + "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" + "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." }, - "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" + "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])?))" } }, - "type": "object" - }, - "networkEdgeSecurityServices": { - "type": "array", - "description": "A list of NetworkEdgeSecurityServices contained in this scope.", - "items": { - "$ref": "NetworkEdgeSecurityService" - } - } - }, - "id": "NetworkEdgeSecurityServicesScopedList" - }, - "HttpQueryParameterMatch": { - "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. " - }, - "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." + "id": "compute.interconnectLocations.list" }, - "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. regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. ", - "type": "string" - }, - "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" - } - }, - "type": "object", - "description": "HttpRouteRuleMatch criteria for a request's query parameter." - }, - "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." + "get": { + "id": "compute.interconnectLocations.get", + "flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}", + "httpMethod": "GET", + "parameterOrder": [ + "project", + "interconnectLocation" ], - "enum": [ - "GLOBAL", - "LOCAL_REGION", - "LP_GLOBAL", - "LP_LOCAL_REGION" + "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" ], - "type": "string" - }, - "region": { - "description": "URL for the region of this location.", - "type": "string" - }, - "expectedRttMs": { - "format": "int64", - "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.", - "type": "string" + "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." } - }, - "id": "InterconnectLocationRegionInfo" + } }, - "RegionInstanceGroupsListInstancesRequest": { - "type": "object", - "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": { - "type": "string", - "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.", - "enum": [ - "ALL", - "RUNNING" + "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" ], - "enumDescriptions": [ - "Matches any status of the instances, running, non-running and others.", - "Instance is in RUNNING state if it is running." - ] - } - }, - "id": "RegionInstanceGroupsListInstancesRequest" - }, - "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": { - "type": "object", - "properties": { - "headerName": { - "type": "string", - "description": "The name of the header to set." - }, - "headerValue": { - "description": "The value to set the named header to.", - "type": "string" - } - }, - "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption" - }, - "DiskTypeAggregatedList": { - "properties": { - "kind": { - "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.", - "type": "string", - "default": "compute#diskTypeAggregatedList" + "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" + } }, - "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" - ], + "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": "[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\" } ", - "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": { + "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": { + "project": { + "description": "Project ID for this request.", + "required": true, + "location": "path", "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])?))" + }, + "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": "[Output Only] Informational warning message." - }, - "unreachables": { - "type": "array", - "items": { - "type": "string" + "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" }, - "description": "[Output Only] Unreachable resources." - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" + "httpMethod": "GET", + "id": "compute.interconnects.list", + "flatPath": "projects/{project}/global/interconnects" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "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" + ] }, - "items": { - "additionalProperties": { - "$ref": "DiskTypesScopedList", - "description": "[Output Only] Name of the scope containing this set of disk types." + "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" }, - "type": "object", - "description": "A list of DiskTypesScopedList resources." + "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" }, - "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": "DiskTypeAggregatedList" - }, - "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 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.", - "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" + "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" }, - "abort": { - "$ref": "HttpFaultAbort", - "description": "The specification for how client requests are aborted as part of fault injection." - } - }, - "id": "HttpFaultInjection", - "type": "object" - }, - "InstanceGroupsAddInstancesRequest": { - "type": "object", - "id": "InstanceGroupsAddInstancesRequest", - "properties": { - "instances": { - "type": "array", - "description": "The list of instances to add to the instance group.", - "items": { - "$ref": "InstanceReference" + "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" } } } }, - "TargetHttpProxyAggregatedList": { - "type": "object", - "properties": { - "items": { - "type": "object", - "description": "A list of TargetHttpProxiesScopedList resources.", - "additionalProperties": { - "description": "Name of the scope containing this set of TargetHttpProxies.", - "$ref": "TargetHttpProxiesScopedList" - } - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "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." - }, - "kind": { - "type": "string", - "default": "compute#targetHttpProxyAggregatedList", - "description": "[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "id": "TargetHttpProxyAggregatedList" - }, - "RouterNatLogConfig": { - "description": "Configuration of logging on a NAT.", - "id": "RouterNatLogConfig", - "properties": { - "enable": { - "description": "Indicates whether or not to export logs. This is false by default.", - "type": "boolean" + "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}" }, - "filter": { - "enumDescriptions": [ - "Export logs for all (successful and unsuccessful) connections.", - "Export logs for connection failures only.", - "Export logs for successful connections only." + "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" ], - "enum": [ - "ALL", - "ERRORS_ONLY", - "TRANSLATIONS_ONLY" + "id": "compute.regionInstanceGroups.setNamedPorts", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "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": "object" - }, - "MachineImageList": { - "description": "A list of machine images.", - "type": "object", - "properties": { - "items": { - "items": { - "$ref": "MachineImage" + "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": "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." + "description": "Sets the named ports for the specified regional instance group." }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "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" + ] }, - "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": { - "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" + "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])?))" }, - "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.", + "type": "boolean", + "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." - ], + "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" } } - }, - "kind": { - "type": "string", - "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.", - "default": "compute#machineImageList" } - }, - "id": "MachineImageList" + } }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "type": "object", - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", - "properties": { - "displayName": { - "description": "[Output Only] The display name of the firewall policy.", - "type": "string" - }, - "rules": { - "description": "The rules that apply to the network.", - "items": { - "$ref": "FirewallPolicyRule" - }, - "type": "array" - }, - "name": { - "type": "string", - "description": "[Output Only] The name of the firewall policy." - }, - "type": { - "enumDescriptions": [ - "", - "", - "", - "" + "regionUrlMaps": { + "methods": { + "list": { + "parameterOrder": [ + "project", + "region" ], - "enum": [ - "HIERARCHY", - "NETWORK", - "NETWORK_REGIONAL", - "UNSPECIFIED" + "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" ], - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", - "type": "string" - } - } - }, - "InstanceGroupManagersCreateInstancesRequest": { - "id": "InstanceGroupManagersCreateInstancesRequest", - "properties": { - "instances": { - "type": "array", - "items": { - "$ref": "PerInstanceConfig" - }, - "description": "[Required] List of specifications of per-instance configs." - } - }, - "description": "InstanceGroupManagers.createInstances", - "type": "object" - }, - "GlobalNetworkEndpointGroupsDetachEndpointsRequest": { - "type": "object", - "properties": { - "networkEndpoints": { - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array", - "description": "The list of network endpoints to be detached." - } - }, - "id": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" - }, - "PacketMirroringsScopedList": { - "type": "object", - "id": "PacketMirroringsScopedList", - "properties": { - "warning": { - "description": "Informational warning which replaces the list of packetMirrorings 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" - ], - "description": "[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." - ], + "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" }, - "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." - } - } - } + "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." }, - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "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" } - } - }, - "packetMirrorings": { - "description": "A list of packetMirrorings contained in this scope.", - "items": { - "$ref": "PacketMirroring" }, - "type": "array" - } - } - }, - "GlobalSetLabelsRequest": { - "properties": { - "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." - }, - "labels": { - "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\": \"\").", - "additionalProperties": { - "type": "string" + "response": { + "$ref": "UrlMapList" }, - "type": "object" - } - }, - "type": "object", - "id": "GlobalSetLabelsRequest" - }, - "PublicAdvertisedPrefixPublicDelegatedPrefix": { - "id": "PublicAdvertisedPrefixPublicDelegatedPrefix", - "type": "object", - "description": "Represents a CIDR range which can be used to assign addresses.", - "properties": { - "ipRange": { - "type": "string", - "description": "The IP address range of the public delegated prefix" - }, - "region": { - "type": "string", - "description": "The region of the public delegated prefix if it is regional. If absent, the prefix is global." - }, - "name": { - "description": "The name of the public delegated prefix", - "type": "string" - }, - "status": { - "type": "string", - "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." - }, - "project": { - "description": "The project number of the public delegated prefix", - "type": "string" - } - } - }, - "ExternalVpnGatewayList": { - "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." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.", - "type": "string", - "default": "compute#externalVpnGatewayList" + "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.", + "path": "projects/{project}/regions/{region}/urlMaps", + "httpMethod": "GET" }, - "items": { - "description": "A list of ExternalVpnGateway resources.", - "items": { - "$ref": "ExternalVpnGateway" + "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" }, - "type": "array" - }, - "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" + "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." }, - "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": { + "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." - ] + "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." }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "etag": { - "type": "string" - } - }, - "description": "Response to the list request, and contains a list of externalVpnGateways.", - "type": "object", - "id": "ExternalVpnGatewayList" - }, - "SecurityPoliciesAggregatedList": { - "id": "SecurityPoliciesAggregatedList", - "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." - }, - "items": { - "type": "object", - "description": "A list of SecurityPoliciesScopedList resources.", - "additionalProperties": { - "$ref": "SecurityPoliciesScopedList", - "description": "Name of the scope containing this set of security policies." - } - }, - "kind": { - "type": "string", - "default": "compute#securityPoliciesAggregatedList", - "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies." - }, - "unreachables": { - "type": "array", - "items": { - "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" }, - "description": "[Output Only] Unreachable resources." - }, - "etag": { - "type": "string" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." + "parameterOrder": [ + "project", + "region", + "urlMap" + ], + "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request." }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "code": { + "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", - "description": "[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" - ] + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region scoping this request.", + "required": true }, - "message": { + "urlMap": { "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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" }, - "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\" } " + "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])?))" } - } - } - } - }, - "ConnectionDraining": { - "description": "Message containing connection draining configuration.", - "type": "object", - "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" - }, - "SslCertificate": { - "type": "object", - "properties": { - "subjectAlternativeNames": { - "items": { - "type": "string" }, - "type": "array", - "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name." - }, - "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" - }, - "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" - }, - "selfManaged": { - "description": "Configuration and status of a self-managed SSL certificate.", - "$ref": "SslCertificateSelfManagedSslCertificate" - }, - "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." - }, - "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" - }, - "expireTime": { - "description": "[Output Only] Expire time of the certificate. RFC3339", - "type": "string" - }, - "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" - }, - "managed": { - "description": "Configuration and status of a managed SSL certificate.", - "$ref": "SslCertificateManagedSslCertificate" - }, - "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" + "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" }, - "type": { - "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.", - "enumDescriptions": [ - "Google-managed SSLCertificate.", - "Certificate uploaded by user.", - "" + "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" ], - "type": "string", - "enum": [ - "MANAGED", - "SELF_MANAGED", - "TYPE_UNSPECIFIED" - ] - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", - "default": "compute#sslCertificate", - "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." - }, - "BackendServiceLocalityLoadBalancingPolicyConfig": { - "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.", - "id": "BackendServiceLocalityLoadBalancingPolicyConfig", - "properties": { - "customPolicy": { - "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy" + "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}" }, - "policy": { - "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy" - } - } - }, - "RegionInstanceGroupsSetNamedPortsRequest": { - "id": "RegionInstanceGroupsSetNamedPortsRequest", - "properties": { - "namedPorts": { - "description": "The list of named ports to set for this instance group.", - "items": { - "$ref": "NamedPort" + "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])?))" + } }, - "type": "array" + "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" }, - "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" + "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." } - }, - "type": "object" + } }, - "Network": { - "type": "object", - "id": "Network", - "properties": { - "IPv4Range": { - "type": "string", - "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", - "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." - }, - "peerings": { - "items": { - "$ref": "NetworkPeering" - }, - "description": "[Output Only] A list of network peerings for the resource.", - "type": "array" - }, - "description": { - "description": "An optional description of this resource. Provide this field when you create the resource.", - "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])?", - "annotations": { - "required": [ - "compute.networks.insert" - ] + "projects": { + "methods": { + "setDefaultNetworkTier": { + "id": "compute.projects.setDefaultNetworkTier", + "request": { + "$ref": "ProjectsSetDefaultNetworkTierRequest" }, - "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." - }, - "firewallPolicy": { - "description": "[Output Only] URL of the firewall policy the network is associated with.", - "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" - }, - "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" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "enableUlaInternalIpv6": { - "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .", - "type": "boolean" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." + "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." }, - "subnetworks": { - "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", - "type": "array", - "items": { - "type": "string" + "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" } }, - "gatewayIPv4": { - "type": "string", - "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}" - }, - "networkFirewallPolicyEnforcementOrder": { - "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.", - "enumDescriptions": [ - "", - "" + "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" ], - "enum": [ - "AFTER_CLASSIC_FIREWALL", - "BEFORE_CLASSIC_FIREWALL" + "response": { + "$ref": "Project" + }, + "flatPath": "projects/{project}", + "parameterOrder": [ + "project" ], - "type": "string" - }, - "mtu": { - "type": "integer", - "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." - }, - "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. ." - }, - "kind": { - "default": "compute#network", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#network for networks." - } - }, - "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." - }, - "ResourcePolicyDailyCycle": { - "properties": { - "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" - }, - "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." - }, - "duration": { - "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", - "type": "string" - } - }, - "type": "object", - "id": "ResourcePolicyDailyCycle", - "description": "Time window specified for daily operations." - }, - "SecurityPolicyRuleRateLimitOptionsThreshold": { - "id": "SecurityPolicyRuleRateLimitOptionsThreshold", - "properties": { - "intervalSec": { - "description": "Interval over which the threshold is computed.", - "format": "int32", - "type": "integer" - }, - "count": { - "format": "int32", - "type": "integer", - "description": "Number of HTTP(S) requests for calculating the threshold." - } - }, - "type": "object" - }, - "SecurityPoliciesListPreconfiguredExpressionSetsResponse": { - "type": "object", - "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse", - "properties": { - "preconfiguredExpressionSets": { - "$ref": "SecurityPoliciesWafConfig" - } - } - }, - "InstanceGroupAggregatedList": { - "type": "object", - "properties": { - "items": { - "description": "A list of InstanceGroupsScopedList resources.", - "type": "object", - "additionalProperties": { - "description": "The name of the scope that contains this set of instance groups.", - "$ref": "InstanceGroupsScopedList" - } + "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." }, - "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." - ], + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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", + "description": "Project ID for this request.", + "required": true }, - "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." + "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" - }, - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "type": "array" + "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": "[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" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." + "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" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "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" }, - "kind": { - "default": "compute#instanceGroupAggregatedList", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups." - } - }, - "id": "InstanceGroupAggregatedList" - }, - "HttpHeaderOption": { - "id": "HttpHeaderOption", - "type": "object", - "properties": { - "headerName": { - "description": "The name of the header.", - "type": "string" + "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" + ] }, - "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" + "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" }, - "headerValue": { - "description": "The value of the header to add.", - "type": "string" - } - }, - "description": "Specification determining how headers are added to requests or responses." - }, - "UrlMapTestHeader": { - "type": "object", - "properties": { - "value": { - "description": "Header value.", - "type": "string" + "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" + ] }, - "name": { - "type": "string", - "description": "Header name." - } - }, - "id": "UrlMapTestHeader", - "description": "HTTP headers used in UrlMapTests." - }, - "BackendServiceConnectionTrackingPolicy": { - "id": "BackendServiceConnectionTrackingPolicy", - "type": "object", - "description": "Connection Tracking configuration for this BackendService.", - "properties": { - "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" + "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" + ] }, - "enableStrongAffinity": { - "description": "Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.", - "type": "boolean" + "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" }, - "connectionPersistenceOnUnhealthyBackends": { - "type": "string", - "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": [ - "", - "", - "" + "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" ], - "enum": [ - "ALWAYS_PERSIST", - "DEFAULT_FOR_PROTOCOL", - "NEVER_PERSIST" + "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" ] }, - "trackingMode": { - "enumDescriptions": [ - "", - "", - "" + "setCommonInstanceMetadata": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "INVALID_TRACKING_MODE", - "PER_CONNECTION", - "PER_SESSION" + "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" ], - "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" + "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." } } }, - "PacketIntervals": { - "type": "object", - "id": "PacketIntervals", - "properties": { - "type": { - "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.", - "" + "globalForwardingRules": { + "methods": { + "insert": { + "parameterOrder": [ + "project" ], - "description": "The type of packets for which inter-packet intervals were computed.", - "type": "string", - "enum": [ - "LOOPBACK", - "RECEIVE", - "TRANSMIT", - "TYPE_UNSPECIFIED" - ] - }, - "numIntervals": { - "format": "int64", - "type": "string", - "description": "Number of inter-packet intervals from which these statistics were derived." - }, - "avgMs": { - "format": "int64", - "description": "Average observed inter-packet interval in milliseconds.", - "type": "string" - }, - "minMs": { - "type": "string", - "description": "Minimum observed inter-packet interval in milliseconds.", - "format": "int64" - }, - "duration": { - "description": "From how long ago in the past these intervals were observed.", - "type": "string", - "enum": [ - "DURATION_UNSPECIFIED", - "HOUR", - "MAX", - "MINUTE" + "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" ], - "enumDescriptions": [ - "", - "", - "From BfdSession object creation time.", - "" - ] - }, - "maxMs": { - "format": "int64", - "description": "Maximum observed inter-packet interval in milliseconds.", - "type": "string" - } - }, - "description": "Next free: 7" - }, - "CircuitBreakers": { - "description": "Settings controlling the volume of requests, connections and retries to this backend service.", - "type": "object", - "properties": { - "maxRequests": { - "description": "The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.", - "type": "integer", - "format": "int32" - }, - "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." - }, - "maxRetries": { - "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.", - "type": "integer", - "format": "int32" - }, - "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" - }, - "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" - } - }, - "id": "CircuitBreakers" - }, - "NetworksAddPeeringRequest": { - "type": "object", - "properties": { - "name": { - "description": "Name of the peering, which should conform to RFC1035.", - "type": "string", - "annotations": { - "required": [ - "compute.networks.addPeering" - ] + "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 + } } }, - "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." - }, - "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" - }, - "autoCreateRoutes": { - "type": "boolean", - "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." - } - }, - "id": "NetworksAddPeeringRequest" - }, - "TargetPoolList": { - "id": "TargetPoolList", - "properties": { - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.", - "type": "string", - "default": "compute#targetPoolList" - }, - "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.", + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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." - ] - }, - "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" + "required": true }, - "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])?))", + "description": "Project ID for this request.", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "required": true, + "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" - }, - "items": { - "description": "A list of TargetPool resources.", - "type": "array", - "items": { - "$ref": "TargetPool" - } - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "description": "Contains a list of TargetPool resources.", - "type": "object" - }, - "Address": { - "properties": { - "status": { - "enum": [ - "IN_USE", - "RESERVED", - "RESERVING" + "parameterOrder": [ + "project", + "forwardingRule" ], - "type": "string", - "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." - ] - }, - "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.*" + "id": "compute.globalForwardingRules.get" }, - "kind": { - "type": "string", - "default": "compute#address", - "description": "[Output Only] Type of the resource. Always compute#address for addresses." - }, - "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." - }, - "ipVersion": { - "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.", - "enumDescriptions": [ - "", - "", - "" + "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" ], - "type": "string", - "enum": [ - "IPV4", - "IPV6", - "UNSPECIFIED_VERSION" - ] - }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" + "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" + } }, - "addressType": { - "enumDescriptions": [ - "A publicly visible external IP address.", - "A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.", - "" + "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" ], - "type": "string", - "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.", - "enum": [ - "EXTERNAL", - "INTERNAL", - "UNSPECIFIED_TYPE" + "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" ] }, - "networkTier": { - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" + "setLabels": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." + "parameterOrder": [ + "project", + "resource" ], - "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." - }, - "users": { - "description": "[Output Only] The URLs of the resources that are using this address.", - "items": { - "type": "string" + "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" }, - "type": "array" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "prefixLength": { - "format": "int32", - "type": "integer", - "description": "The prefix length if the resource represents an IP range." - }, - "address": { - "type": "string", - "description": "The static IP address represented by this resource." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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" - ] - } - }, - "subnetwork": { - "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.", - "type": "string" + "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" }, - "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." + "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" ], - "enum": [ - "DNS_RESOLVER", - "GCE_ENDPOINT", - "IPSEC_INTERCONNECT", - "NAT_AUTO", - "PRIVATE_SERVICE_CONNECT", - "SERVERLESS", - "SHARED_LOADBALANCER_VIP", - "VPC_PEERING" + "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.", + "parameterOrder": [ + "project" ], - "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. " - } - }, - "type": "object", - "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.", - "id": "Address" - }, - "MetadataFilterLabelMatch": { - "type": "object", - "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.", - "properties": { - "name": { - "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.", - "type": "string" - }, - "value": { - "type": "string", - "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters." - } - }, - "id": "MetadataFilterLabelMatch" - }, - "ShieldedInstanceIntegrityPolicy": { - "type": "object", - "id": "ShieldedInstanceIntegrityPolicy", - "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" - } - } - }, - "NodeGroupsAddNodesRequest": { - "properties": { - "additionalNodeCount": { - "type": "integer", - "description": "Count of additional nodes to be added to the node group.", - "format": "int32" - } - }, - "type": "object", - "id": "NodeGroupsAddNodesRequest" - }, - "MachineTypeAggregatedList": { - "properties": { - "items": { - "type": "object", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of machine types.", - "$ref": "MachineTypesScopedList" + "path": "projects/{project}/global/forwardingRules", + "httpMethod": "GET", + "response": { + "$ref": "ForwardingRuleList" }, - "description": "A list of MachineTypesScopedList resources." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "id": "compute.globalForwardingRules.list" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "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" }, - "type": "array" - }, - "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#machineTypeAggregatedList for aggregated lists of machine types.", - "type": "string", - "default": "compute#machineTypeAggregatedList" - }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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": { "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": { - "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" + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "MachineTypeAggregatedList" - }, - "RegionDisksAddResourcePoliciesRequest": { - "type": "object", - "properties": { - "resourcePolicies": { - "items": { - "type": "string" - }, - "type": "array", - "description": "Resource policies to be added to this disk." - } - }, - "id": "RegionDisksAddResourcePoliciesRequest" + } }, - "Instance": { - "type": "object", - "id": "Instance", - "properties": { - "startRestricted": { - "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.", - "type": "boolean" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "cpuPlatform": { - "type": "string", - "description": "[Output Only] The CPU platform used by this instance." - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "networkInterfaces": { - "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" + "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" }, - "type": "array" - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Sets the scheduling options for this instance." - }, - "canIpForward": { - "type": "boolean", - "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 ." - }, - "shieldedInstanceIntegrityPolicy": { - "$ref": "ShieldedInstanceIntegrityPolicy" - }, - "confidentialInstanceConfig": { - "$ref": "ConfidentialInstanceConfig" - }, - "metadata": { - "description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.", - "$ref": "Metadata" - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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", - "annotations": { - "required": [ - "compute.instances.insert" - ] - } - }, - "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" - }, - "advancedMachineFeatures": { - "description": "Controls for advanced machine-related behavior features.", - "$ref": "AdvancedMachineFeatures" - }, - "sourceMachineImage": { - "type": "string", - "description": "Source machine image" - }, - "shieldedInstanceConfig": { - "$ref": "ShieldedInstanceConfig" + "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" + ] }, - "privateIpv6GoogleAccess": { - "enum": [ - "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", - "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", - "INHERIT_FROM_SUBNETWORK" + "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" ], - "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." + "parameterOrder": [ + "project", + "region", + "publicDelegatedPrefix" ], - "type": "string", - "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default." - }, - "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\"." - }, - "networkPerformanceConfig": { - "$ref": "NetworkPerformanceConfig" - }, - "disks": { - "type": "array", - "items": { - "$ref": "AttachedDisk" + "response": { + "$ref": "PublicDelegatedPrefix" }, - "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them." + "httpMethod": "GET", + "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", + "id": "compute.publicDelegatedPrefixes.get", + "description": "Returns the specified PublicDelegatedPrefix resource in the given region." }, - "labels": { - "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", - "additionalProperties": { - "type": "string" + "insert": { + "request": { + "$ref": "PublicDelegatedPrefix" }, - "type": "object" - }, - "params": { - "$ref": "InstanceParams", - "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." - }, - "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." - }, - "serviceAccounts": { - "items": { - "$ref": "ServiceAccount" + "response": { + "$ref": "Operation" }, - "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" - }, - "lastStopTimestamp": { - "type": "string", - "description": "[Output Only] Last stop timestamp in RFC3339 text format." - }, - "reservationAffinity": { - "description": "Specifies the reservations that this instance can consume from.", - "$ref": "ReservationAffinity" - }, - "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." - }, - "statusMessage": { - "description": "[Output Only] An optional, human-readable explanation of the status.", - "type": "string" - }, - "satisfiesPzs": { - "type": "boolean", - "description": "[Output Only] Reserved for future use." - }, - "labelFingerprint": { - "type": "string", - "format": "byte", - "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." - }, - "hostname": { - "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.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "keyRevocationActionType": { - "type": "string", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" + "id": "compute.publicDelegatedPrefixes.insert", + "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." + "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" ], - "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified." - }, - "deletionProtection": { - "description": "Whether the resource should be protected against deletion.", - "type": "boolean" - }, - "lastSuspendedTimestamp": { - "description": "[Output Only] Last suspended timestamp in RFC3339 text format.", - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "kind": { - "default": "compute#instance", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#instance for instances." + "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." }, - "resourcePolicies": { - "type": "array", - "items": { - "type": "string" + "list": { + "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes", + "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes", + "response": { + "$ref": "PublicDelegatedPrefixList" }, - "description": "Resource policies applied to this instance." - }, - "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.", - "enum": [ - "DEPROVISIONING", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "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)." + "parameterOrder": [ + "project", + "region" ], - "type": "string" - }, - "lastStartTimestamp": { - "description": "[Output Only] Last start timestamp in RFC3339 text format.", - "type": "string" - }, - "displayDevice": { - "description": "Enables display device for the instance.", - "$ref": "DisplayDevice" - }, - "machineType": { - "type": "string", - "annotations": { - "required": [ - "compute.instances.insert" - ] + "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": "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." + "description": "Lists the PublicDelegatedPrefixes for a project in the given region.", + "httpMethod": "GET", + "id": "compute.publicDelegatedPrefixes.list" }, - "guestAccelerators": { - "type": "array", - "description": "A list of the type and count of accelerator cards attached to the instance.", - "items": { - "$ref": "AcceleratorConfig" + "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 + } } }, - "sourceMachineImageEncryptionKey": { - "description": "Source machine image encryption key when creating an instance from a machine image.", - "$ref": "CustomerEncryptionKey" - } - }, - "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." - }, - "UrlRewrite": { - "description": "The spec for modifying the path before sending the request to the matched backend service.", - "type": "object", - "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" - } - }, - "id": "UrlRewrite" - }, - "LicenseResourceRequirements": { - "type": "object", - "properties": { - "minGuestCpuCount": { - "type": "integer", - "description": "Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.", - "format": "int32" - }, - "minMemoryMb": { - "format": "int32", - "description": "Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.", - "type": "integer" + "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" + ] } - }, - "id": "LicenseResourceRequirements" + } }, - "ForwardingRulesScopedList": { - "properties": { - "warning": { - "type": "object", - "description": "Informational warning which replaces the list of forwarding rules when the list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "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." }, - "code": { + "project": { + "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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" }, - "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\" } " + "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}" } - } - }, - "forwardingRules": { - "items": { - "$ref": "ForwardingRule" }, - "type": "array", - "description": "A list of forwarding rules contained in this scope." - } - }, - "type": "object", - "id": "ForwardingRulesScopedList" - }, - "InstancesRemoveResourcePoliciesRequest": { - "type": "object", - "id": "InstancesRemoveResourcePoliciesRequest", - "properties": { - "resourcePolicies": { - "type": "array", - "items": { - "type": "string" + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", + "request": { + "$ref": "BackendService" }, - "description": "Resource policies to be removed from this instance." - } - } - }, - "DisplayDevice": { - "id": "DisplayDevice", - "type": "object", - "properties": { - "enableDisplay": { - "description": "Defines whether the instance has Display enabled.", - "type": "boolean" - } - }, - "description": "A set of Display Device options" - }, - "RegionInstanceGroupsListInstances": { - "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." + "id": "compute.regionBackendServices.update" }, - "items": { - "description": "A list of InstanceWithNamedPorts resources.", - "items": { - "$ref": "InstanceWithNamedPorts" + "patch": { + "httpMethod": "PATCH", + "request": { + "$ref": "BackendService" }, - "type": "array" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#regionInstanceGroupsListInstances", - "description": "The resource type." - }, - "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." - ], - "description": "[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": "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" }, - "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)." - } - } - } + "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.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" } - }, - "type": "object", - "description": "[Output Only] Informational warning message." - } - }, - "id": "RegionInstanceGroupsListInstances" - }, - "RegionAutoscalerList": { - "description": "Contains a list of autoscalers.", - "properties": { - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "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\" } " + } + }, + "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." }, - "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.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { + "location": "path", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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." } - } - }, - "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." - }, - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#regionAutoscalerList" + }, + "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." }, - "items": { - "type": "array", - "description": "A list of Autoscaler resources.", - "items": { - "$ref": "Autoscaler" + "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])?" + } } }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - } - }, - "id": "RegionAutoscalerList", - "type": "object" - }, - "AutoscalingPolicyScaleInControl": { - "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.", - "properties": { - "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." - }, - "timeWindowSec": { - "format": "int32", - "type": "integer", - "description": "How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above." - } - }, - "type": "object", - "id": "AutoscalingPolicyScaleInControl" - }, - "Operation": { - "id": "Operation", - "properties": { - "progress": { - "type": "integer", - "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." - }, - "insertTime": { - "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server.", - "type": "string", - "format": "uint64" - }, - "status": { - "enum": [ - "DONE", - "PENDING", - "RUNNING" + "list": { + "parameterOrder": [ + "project", + "region" ], - "type": "string", - "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.", - "enumDescriptions": [ - "", - "", - "" - ] - }, - "operationGroupId": { - "type": "string", - "description": "[Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request." - }, - "creationTimestamp": { - "type": "string", - "description": "[Deprecated] This field is deprecated." - }, - "httpErrorMessage": { - "type": "string", - "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`." - }, - "error": { - "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "errorDetails": { - "items": { - "type": "object", - "properties": { - "help": { - "$ref": "Help" - }, - "localizedMessage": { - "$ref": "LocalizedMessage" - }, - "errorInfo": { - "$ref": "ErrorInfo" - } - } - }, - "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" - }, - "location": { - "type": "string", - "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." - }, - "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" - } - } - }, - "description": "[Output Only] The array of errors encountered while processing this operation." + "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" } }, - "endTime": { - "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.", - "type": "string" - }, - "clientOperationId": { - "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.", - "type": "string" - }, - "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" - }, - "kind": { - "description": "[Output Only] Type of the resource. Always `compute#operation` for Operation resources.", - "default": "compute#operation", - "type": "string" - }, - "startTime": { - "type": "string", - "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format." - }, - "name": { - "description": "[Output Only] Name of the operation.", - "type": "string" - }, - "region": { - "type": "string", - "description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations." - }, - "statusMessage": { - "type": "string", - "description": "[Output Only] An optional textual description of the current status of the operation." - }, - "description": { - "type": "string", - "description": "[Output Only] A textual description of the operation, which is set when the operation is created." - }, - "httpErrorStatusCode": { - "type": "integer", - "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.", - "format": "int32" - }, - "zone": { - "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.", - "type": "string" - }, - "operationType": { - "description": "[Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.", - "type": "string" - }, - "targetId": { - "format": "uint64", - "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.", - "type": "string" - }, - "user": { - "description": "[Output Only] User who requested the operation, for example: `user@example.com`.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" + "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" + } + } }, - "warnings": { - "items": { - "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": { - "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" - } - } - } - }, - "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" - } + "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])?))" } }, - "type": "array", - "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated." - } - }, - "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.", - "type": "object" - }, - "UsageExportLocation": { - "id": "UsageExportLocation", - "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" + "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" + ] }, - "bucketName": { - "type": "string", - "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": "object" - }, - "PreservedState": { - "description": "Preserved state for a given instance.", - "id": "PreservedState", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "Preserved metadata defined for this instance.", - "additionalProperties": { - "type": "string" + "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" } }, - "disks": { - "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", - "type": "object", - "additionalProperties": { - "$ref": "PreservedStatePreservedDisk" - } - } - } - }, - "RegionInstanceGroupManagerPatchInstanceConfigReq": { - "properties": { - "perInstanceConfigs": { - "type": "array", - "items": { - "$ref": "PerInstanceConfig" + "get": { + "response": { + "$ref": "BackendService" }, - "description": "The list of per-instance configurations to insert or patch on this managed instance group." - } - }, - "id": "RegionInstanceGroupManagerPatchInstanceConfigReq", - "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs", - "type": "object" - }, - "BulkInsertInstanceResourcePerInstanceProperties": { - "properties": { - "name": { - "type": "string", - "description": "This field is only temporary. It will be removed. Do not use it." - } - }, - "type": "object", - "description": "Per-instance properties to be set on individual instances. To be extended in the future.", - "id": "BulkInsertInstanceResourcePerInstanceProperties" - }, - "SignedUrlKey": { - "id": "SignedUrlKey", - "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs", - "type": "object", - "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." + "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}" } } }, - "BfdStatus": { - "properties": { - "localDiagnostic": { - "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" + "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" ], - "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": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ] - }, - "rxPacket": { - "$ref": "BfdPacket", - "description": "The most recent Rx control packet for this BFD session." + "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." }, - "bfdSessionInitializationMode": { - "enum": [ - "ACTIVE", - "DISABLED", - "PASSIVE" + "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" ], - "enumDescriptions": [ - "", - "", - "" + "parameterOrder": [ + "project", + "firewallPolicy" ], - "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." - }, - "controlPacketIntervals": { - "description": "Inter-packet time interval statistics for control packets.", - "type": "array", - "items": { - "$ref": "PacketIntervals" - } - }, - "configUpdateTimestampMicros": { - "description": "Unix timestamp of the most recent config update.", - "type": "string", - "format": "int64" + "description": "Gets an association with the specified name.", + "response": { + "$ref": "FirewallPolicyAssociation" + }, + "id": "compute.networkFirewallPolicies.getAssociation" }, - "localState": { - "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880", - "enumDescriptions": [ - "", - "", - "", - "", - "" + "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" ], - "enum": [ - "ADMIN_DOWN", - "DOWN", - "INIT", - "STATE_UNSPECIFIED", - "UP" + "parameterOrder": [ + "project", + "firewallPolicy" ], - "type": "string" - }, - "controlPacketCounts": { - "description": "Control packet counts for the current BFD session.", - "$ref": "BfdStatusPacketCounts" - }, - "uptimeMs": { - "format": "int64", - "type": "string", - "description": "Session uptime in milliseconds. Value will be 0 if session is not up." - }, - "negotiatedLocalControlTxIntervalMs": { - "description": "Negotiated transmit interval for control packets.", - "format": "uint32", - "type": "integer" - }, - "txPacket": { - "$ref": "BfdPacket", - "description": "The most recent Tx control packet for this BFD session." - } - }, - "type": "object", - "description": "Next free: 15", - "id": "BfdStatus" - }, - "HealthCheckList": { - "properties": { - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "default": "compute#healthCheckList", - "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" - }, - "warning": { - "properties": { - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "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 }, - "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": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { - "description": "[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", "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])?))", + "required": true } }, - "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 HealthCheck resources.", - "type": "array", - "items": { - "$ref": "HealthCheck" + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", + "response": { + "$ref": "Operation" } - } - }, - "type": "object", - "id": "HealthCheckList", - "description": "Contains a list of HealthCheck resources." - }, - "AllocationSpecificSKUAllocationReservedInstanceProperties": { - "description": "Properties of the SKU instances being reserved. Next ID: 9", - "type": "object", - "id": "AllocationSpecificSKUAllocationReservedInstanceProperties", - "properties": { - "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" }, - "machineType": { - "type": "string", - "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." + "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" }, - "guestAccelerators": { - "description": "Specifies accelerator type and count.", - "type": "array", - "items": { - "$ref": "AcceleratorConfig" + "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" } }, - "minCpuPlatform": { - "type": "string", - "description": "Minimum cpu platform the reservation." + "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" + ] }, - "localSsds": { - "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.", - "items": { - "$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk" + "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" }, - "type": "array" - } - } - }, - "ManagedInstanceVersion": { - "properties": { - "name": { - "type": "string", - "description": "[Output Only] Name of the version." + "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" }, - "instanceTemplate": { - "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.", - "type": "string" - } - }, - "type": "object", - "id": "ManagedInstanceVersion" - }, - "BackendBucketCdnPolicyCacheKeyPolicy": { - "id": "BackendBucketCdnPolicyCacheKeyPolicy", - "description": "Message containing what to include in the cache key for a request for Cloud CDN.", - "properties": { - "queryStringWhitelist": { - "items": { - "type": "string" + "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": "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.", - "type": "array" + "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" + } + } }, - "includeHttpHeaders": { - "items": { - "type": "string" + "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" }, - "description": "Allows HTTP request headers (by name) to be used in the cache key.", - "type": "array" - } - }, - "type": "object" - }, - "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "type": "object", - "properties": { - "shortName": { - "type": "string", - "description": "[Output Only] The short name of the firewall policy." + "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" }, - "type": { - "enum": [ - "HIERARCHY", - "NETWORK", - "NETWORK_REGIONAL", - "UNSPECIFIED" + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "rules": { - "type": "array", - "items": { - "$ref": "FirewallPolicyRule" + "httpMethod": "DELETE", + "description": "Deletes the specified policy.", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", + "response": { + "$ref": "Operation" }, - "description": "The rules that apply to the network." - }, - "displayName": { - "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", - "type": "string" + "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])?))" + } + } }, - "name": { - "description": "[Output Only] The name of the firewall policy.", - "type": "string" - } - }, - "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - }, - "SubnetworksScopedList": { - "id": "SubnetworksScopedList", - "properties": { - "subnetworks": { - "type": "array", - "items": { - "$ref": "Subnetwork" + "getIamPolicy": { + "path": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy", + "httpMethod": "GET", + "response": { + "$ref": "Policy" }, - "description": "A list of subnetworks contained in this scope." + "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" }, - "warning": { - "description": "An informational warning that appears when the list of addresses is empty.", - "type": "object", - "properties": { - "code": { + "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": "[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" }, - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "description": "Project ID for this request.", + "location": "path" }, - "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\" } " - } - } - } - }, - "type": "object" - }, - "PublicDelegatedPrefixesScopedList": { - "id": "PublicDelegatedPrefixesScopedList", - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of public delegated prefixes 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." - ], + "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", - "description": "[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": "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": { + "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", - "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, + "location": "path" }, - "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" } }, - "publicDelegatedPrefixes": { - "items": { - "$ref": "PublicDelegatedPrefix" + "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" + } }, - "type": "array", - "description": "[Output Only] A list of PublicDelegatedPrefixes contained in this scope." - } - }, - "type": "object" - }, - "Uint128": { - "id": "Uint128", - "properties": { - "high": { - "type": "string", - "format": "uint64" - }, - "low": { - "type": "string", - "format": "uint64" - } - }, - "type": "object" - }, - "HTTP2HealthCheck": { - "type": "object", - "id": "HTTP2HealthCheck", - "properties": { - "portName": { - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.", - "type": "string" - }, - "port": { - "type": "integer", - "description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.", - "format": "int32" - }, - "requestPath": { - "type": "string", - "description": "The request path of the HTTP/2 health check request. The default value is /." - }, - "response": { - "type": "string", - "description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII." - }, - "proxyHeader": { - "enum": [ - "NONE", - "PROXY_V1" + "path": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", + "id": "compute.networkFirewallPolicies.setIamPolicy", + "httpMethod": "POST", + "request": { + "$ref": "GlobalSetPolicyRequest" + }, + "parameterOrder": [ + "project", + "resource" ], - "type": "string", - "enumDescriptions": [ - "", - "" + "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" ], - "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE." + "flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", + "response": { + "$ref": "Policy" + } }, - "host": { - "type": "string", - "description": "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used." + "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" }, - "portSpecification": { - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "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" ], - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." + "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" ], - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.", - "type": "string" + "id": "compute.networkFirewallPolicies.testIamPermissions" } } }, - "LocalizedMessage": { - "type": "object", - "id": "LocalizedMessage", - "properties": { - "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" - }, - "message": { - "type": "string", - "description": "The localized error message in the above locale." - } - }, - "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error." - }, - "FileContentBuffer": { - "id": "FileContentBuffer", - "properties": { - "fileType": { - "type": "string", - "description": "The file type of source file.", - "enumDescriptions": [ - "", - "", - "" + "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" ], - "enum": [ - "BIN", - "UNDEFINED", - "X509" - ] - }, - "content": { - "type": "string", - "description": "The raw content in the secure keys file.", - "format": "byte" - } - }, - "type": "object" - }, - "ResourcePolicyHourlyCycle": { - "id": "ResourcePolicyHourlyCycle", - "properties": { - "hoursInCycle": { - "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.", - "format": "int32", - "type": "integer" - }, - "duration": { - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", - "type": "string" - }, - "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" - } - }, - "description": "Time window specified for hourly operations.", - "type": "object" - }, - "SecurityPolicyRuleRateLimitOptions": { - "type": "object", - "id": "SecurityPolicyRuleRateLimitOptions", - "properties": { - "enforceOnKeyName": { - "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.", - "type": "string" - }, - "conformAction": { - "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only.", - "type": "string" - }, - "rateLimitThreshold": { - "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold", - "description": "Threshold at which to begin ratelimiting." - }, - "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": { - "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", - "type": "integer" - }, - "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" - }, - "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'." + "response": { + "$ref": "Zone" + }, + "flatPath": "projects/{project}/zones/{zone}", + "parameterOrder": [ + "project", + "zone" + ], + "path": "projects/{project}/zones/{zone}" }, - "enforceOnKey": { - "type": "string", - "enum": [ - "ALL", - "HTTP_COOKIE", - "HTTP_HEADER", - "IP", - "XFF_IP" + "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" ], - "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 this field 'enforce_on_key' 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 \"enforce_on_key_name\". 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 \"enforce_on_key_name\". 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. ", - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] + "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" + } } } }, - "ManagedInstance": { - "properties": { - "preservedStateFromPolicy": { - "$ref": "PreservedState", - "description": "[Output Only] Preserved state generated based on stateful policy for this instance." - }, - "id": { - "type": "string", - "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.", - "format": "uint64" - }, - "instanceHealth": { - "type": "array", - "description": "[Output Only] Health state of the instance per health-check.", - "items": { - "$ref": "ManagedInstanceInstanceHealth" - } - }, - "lastAttempt": { - "description": "[Output Only] Information about the last attempt to create or delete the instance.", - "$ref": "ManagedInstanceLastAttempt" - }, - "currentAction": { - "enum": [ - "ABANDONING", - "CREATING", - "CREATING_WITHOUT_RETRIES", - "DELETING", - "NONE", - "RECREATING", - "REFRESHING", - "RESTARTING", - "RESUMING", - "STARTING", - "STOPPING", - "SUSPENDING", - "VERIFYING" + "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" ], - "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.autoscalers.update", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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. " - }, - "instance": { - "type": "string", - "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created." - }, - "preservedStateFromConfig": { - "description": "[Output Only] Preserved state applied from per-instance config for this instance.", - "$ref": "PreservedState" + "request": { + "$ref": "Autoscaler" + } }, - "instanceStatus": { - "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", - "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)." + "patch": { + "request": { + "$ref": "Autoscaler" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "DEPROVISIONING", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" - ] - }, - "version": { - "description": "[Output Only] Intended version of this instance.", - "$ref": "ManagedInstanceVersion" - } - }, - "type": "object", - "description": "A Managed Instance resource.", - "id": "ManagedInstance" - }, - "PacketMirroringAggregatedList": { - "properties": { - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "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." - }, - "kind": { - "default": "compute#packetMirroringAggregatedList", - "description": "Type of resource.", - "type": "string" - }, - "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": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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": "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)." }, - "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - ] + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" } }, - "type": "object" - }, - "items": { - "additionalProperties": { - "$ref": "PacketMirroringsScopedList", - "description": "Name of the scope containing this set of packetMirrorings." + "response": { + "$ref": "AutoscalerList" }, - "description": "A list of PacketMirroring resources.", - "type": "object" - } - }, - "id": "PacketMirroringAggregatedList", - "description": "Contains a list of packetMirrorings.", - "type": "object" - }, - "InstanceGroupsListInstancesRequest": { - "properties": { - "instanceState": { - "enum": [ - "ALL", - "RUNNING" - ], - "type": "string", - "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." - ], - "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": "object", - "id": "InstanceGroupsListInstancesRequest" - }, - "ServiceAttachmentConsumerProjectLimit": { - "type": "object", - "id": "ServiceAttachmentConsumerProjectLimit", - "properties": { - "projectIdOrNum": { - "description": "The project id or number for the project to set the limit for.", - "type": "string" - }, - "connectionLimit": { - "description": "The value of the limit to set.", - "format": "uint32", - "type": "integer" - } - } - }, - "ResourcePolicyWeeklyCycleDayOfWeek": { - "properties": { - "duration": { - "type": "string", - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario." - }, - "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" + "id": "compute.autoscalers.list" }, - "day": { - "enum": [ - "FRIDAY", - "INVALID", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" + "delete": { + "parameterOrder": [ + "project", + "zone", + "autoscaler" ], - "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.", - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" - ] - } - }, - "id": "ResourcePolicyWeeklyCycleDayOfWeek", - "type": "object" - }, - "InstanceGroupManagersRecreateInstancesRequest": { - "id": "InstanceGroupManagersRecreateInstancesRequest", - "type": "object", - "properties": { - "instances": { - "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" - }, - "type": "array" - } - } - }, - "NotificationEndpointList": { - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "NotificationEndpoint" - }, - "description": "A list of NotificationEndpoint resources." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "code": { + "zone": { + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the zone 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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" }, - "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\" } " + "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)." } - } - }, - "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": { - "default": "compute#notificationEndpointList", - "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.", - "type": "string" - } - }, - "id": "NotificationEndpointList", - "type": "object" - }, - "RegionInstanceGroupManagersCreateInstancesRequest": { - "properties": { - "instances": { - "items": { - "$ref": "PerInstanceConfig" }, - "description": "[Required] List of specifications of per-instance configs.", - "type": "array" - } - }, - "type": "object", - "description": "RegionInstanceGroupManagers.createInstances", - "id": "RegionInstanceGroupManagersCreateInstancesRequest" - }, - "SecurityPolicy": { - "properties": { - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "fingerprint": { - "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 security policy.", - "format": "byte" - }, - "adaptiveProtectionConfig": { - "$ref": "SecurityPolicyAdaptiveProtectionConfig" - }, - "kind": { - "type": "string", - "default": "compute#securityPolicy", - "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies" - }, - "ddosProtectionConfig": { - "$ref": "SecurityPolicyDdosProtectionConfig" - }, - "recaptchaOptionsConfig": { - "$ref": "SecurityPolicyRecaptchaOptionsConfig" + "response": { + "$ref": "Operation" + } }, - "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.", - "type": "string", - "enum": [ - "CLOUD_ARMOR", - "CLOUD_ARMOR_EDGE", - "CLOUD_ARMOR_NETWORK" + "get": { + "parameterOrder": [ + "project", + "zone", + "autoscaler" ], - "enumDescriptions": [ - "", - "", - "" + "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" ] }, - "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": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "advancedOptionsConfig": { - "$ref": "SecurityPolicyAdvancedOptionsConfig" - }, - "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" - }, - "rules": { - "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 security policy, a default rule with action \"allow\" will be added.", - "type": "array", - "items": { - "$ref": "SecurityPolicyRule" + "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" + } } }, - "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.", - "type": "string", - "format": "uint64" - } - }, - "type": "object", - "id": "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." - }, - "SavedAttachedDisk": { - "id": "SavedAttachedDisk", - "properties": { - "storageBytes": { - "type": "string", - "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image.", - "format": "int64" - }, - "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.", - "type": "array", - "items": { - "$ref": "GuestOsFeature" + "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" + ] }, - "diskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The encryption key for the disk." - }, - "interface": { - "enumDescriptions": [ - "", - "" + "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" ], - "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.", - "type": "string", - "enum": [ - "NVME", - "SCSI" + "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", + "id": "compute.nodeTemplates.delete", + "response": { + "$ref": "Operation" + }, + "httpMethod": "DELETE", + "parameterOrder": [ + "project", + "region", + "nodeTemplate" ] }, - "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." + "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" ], - "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.", - "enum": [ - "READ_ONLY", - "READ_WRITE" + "parameterOrder": [ + "project", + "region", + "nodeTemplate" ], - "type": "string" - }, - "source": { - "type": "string", - "description": "Specifies a URL of the disk attached to the source instance." - }, - "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" - }, - "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" - }, - "index": { - "format": "int32", - "description": "Specifies zero-based index of the disk that is attached to the source instance.", - "type": "integer" - }, - "diskType": { - "type": "string", - "description": "[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd" + "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." }, - "licenses": { - "type": "array", - "items": { - "type": "string" + "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 + } }, - "description": "[Output Only] Any valid publicly visible licenses." - }, - "diskSizeGb": { - "type": "string", - "format": "int64", - "description": "The size of the disk in base-2 GB." + "response": { + "$ref": "NodeTemplateList" + }, + "id": "compute.nodeTemplates.list" }, - "deviceName": { - "type": "string", - "description": "Specifies the name of the disk attached to the source instance." + "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" }, - "type": { - "type": "string", - "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.", - "enumDescriptions": [ - "", - "" + "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" ], - "enum": [ - "PERSISTENT", - "SCRATCH" + "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" ] }, - "storageBytesStatus": { - "enum": [ - "UPDATING", - "UP_TO_DATE" + "testIamPermissions": { + "parameterOrder": [ + "project", + "region", + "resource" ], - "type": "string", - "enumDescriptions": [ - "", - "" + "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": "[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": "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" + } }, - "kind": { - "type": "string", - "default": "compute#savedAttachedDisk", - "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks." - } - }, - "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.", - "type": "object" - }, - "NetworksUpdatePeeringRequest": { - "type": "object", - "properties": { - "networkPeering": { - "$ref": "NetworkPeering" + "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" + } + } } - }, - "id": "NetworksUpdatePeeringRequest" + } }, - "InstanceTemplateList": { - "id": "InstanceTemplateList", - "description": "A list of instance templates.", - "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." + "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" }, - "items": { - "type": "array", - "items": { - "$ref": "InstanceTemplate" + "listReferrers": { + "response": { + "$ref": "InstanceListReferrers" }, - "description": "A list of InstanceTemplate resources." - }, - "kind": { - "default": "compute#instanceTemplateList", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists." - }, - "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": "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" + } + } }, - "warning": { - "type": "object", - "properties": { - "code": { + "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": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." + "", + "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": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" ], - "description": "[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": "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" }, - "message": { + "instance": { + "required": true, "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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" }, - "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\" } " + "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] Informational warning message." - } - }, - "type": "object" - }, - "ResourcePolicyWeeklyCycle": { - "description": "Time window specified for weekly operations.", - "properties": { - "dayOfWeeks": { - "items": { - "$ref": "ResourcePolicyWeeklyCycleDayOfWeek" - }, - "type": "array", - "description": "Up to 7 intervals/windows, one for each day of the week." - } - }, - "id": "ResourcePolicyWeeklyCycle", - "type": "object" - }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", - "properties": { - "logType": { - "type": "string", - "enum": [ - "ADMIN_READ", - "DATA_READ", - "DATA_WRITE", - "LOG_TYPE_UNSPECIFIED" + "parameterOrder": [ + "project", + "zone", + "instance" ], - "enumDescriptions": [ - "Admin reads. Example: CloudIAM getIamPolicy", - "Data reads. Example: CloudSQL Users list", - "Data writes. Example: CloudSQL Users create", - "Default case. Should never be this." + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "description": "The log type that this config enables." - }, - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } - }, - "ignoreChildExemptions": { - "type": "boolean", - "description": "This is deprecated and has no effect. Do not use." - } - }, - "type": "object", - "id": "AuditLogConfig" - }, - "PacketMirroringMirroredResourceInfoInstanceInfo": { - "properties": { - "canonicalUrl": { - "description": "[Output Only] Unique identifier for the instance; defined by the server.", - "type": "string" - }, - "url": { - "description": "Resource URL to the virtual machine instance which is being mirrored.", - "type": "string" - } - }, - "type": "object", - "id": "PacketMirroringMirroredResourceInfoInstanceInfo" - }, - "TestPermissionsResponse": { - "type": "object", - "properties": { - "permissions": { - "items": { - "type": "string" + "request": { + "$ref": "Instance" }, - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "type": "array" - } - }, - "id": "TestPermissionsResponse" - }, - "CustomerEncryptionKeyProtectedDisk": { - "properties": { - "diskEncryptionKey": { - "description": "Decrypts data associated with the disk with a customer-supplied encryption key.", - "$ref": "CustomerEncryptionKey" - }, - "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 " - } - }, - "type": "object", - "id": "CustomerEncryptionKeyProtectedDisk" - }, - "NetworkEndpointWithHealthStatus": { - "id": "NetworkEndpointWithHealthStatus", - "properties": { - "networkEndpoint": { - "$ref": "NetworkEndpoint", - "description": "[Output only] The network endpoint;" + "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" }, - "healths": { - "type": "array", - "items": { - "$ref": "HealthStatusForNetworkEndpoint" + "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": "[Output only] The health status of network endpoint;" - } - }, - "type": "object" - }, - "AttachedDisk": { - "type": "object", - "id": "AttachedDisk", - "description": "An instance-attached disk resource.", - "properties": { - "licenses": { - "description": "[Output Only] Any valid publicly visible licenses.", - "type": "array", - "items": { - "type": "string" - } - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", - "default": "compute#attachedDisk" - }, - "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" - }, - "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.", - "enum": [ - "NVME", - "SCSI" - ], - "enumDescriptions": [ - "", - "" - ], - "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" - }, - "type": { - "type": "string", - "enumDescriptions": [ - "", - "" + "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" ], - "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.", - "enum": [ - "PERSISTENT", - "SCRATCH" + "request": { + "$ref": "InstancesSetMinCpuPlatformRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "deviceName": { - "type": "string", - "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." - }, - "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" - ], - "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." - ], - "type": "string" - }, - "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.", - "type": "array", - "items": { - "$ref": "GuestOsFeature" - } - }, - "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" - }, - "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." - }, - "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)." - }, - "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." - }, - "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" - }, - "diskSizeGb": { - "description": "The size of the disk in GB.", - "format": "int64", - "type": "string" - }, - "shieldedInstanceInitialState": { - "description": "[Output Only] shielded vm initial state stored on disk", - "$ref": "InitialStateConfig" - }, - "architecture": { - "type": "string", - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ], - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" - ], - "description": "[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64." - } - } - }, - "NodeGroupList": { - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "type": "object", - "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": { - "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" + "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" }, - "code": { + "project": { + "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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 }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path" } }, - "description": "[Output Only] Informational warning message." - }, - "items": { - "description": "A list of NodeGroup resources.", - "type": "array", - "items": { - "$ref": "NodeGroup" + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", + "request": { + "$ref": "InstancesSetMachineResourcesRequest" } }, - "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#nodeGroupList", - "description": "[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.", - "type": "string" - } - }, - "type": "object", - "description": "Contains a list of nodeGroups.", - "id": "NodeGroupList" - }, - "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": { - "properties": { - "interface": { - "enumDescriptions": [ - "", - "" + "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" ], - "type": "string", - "enum": [ - "NVME", - "SCSI" + "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" ], - "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." - }, - "diskSizeGb": { - "type": "string", - "format": "int64", - "description": "Specifies the size of the disk in base-2 GB." - } - }, - "id": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk", - "type": "object" - }, - "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": { - "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", - "properties": { - "nextRunStartTime": { - "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.", - "type": "string" + "httpMethod": "POST" }, - "lastRunStartTime": { - "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.", - "type": "string" - } - }, - "type": "object" - }, - "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.", - "id": "InterconnectLocation", - "properties": { - "continent": { - "type": "string", - "enum": [ - "AFRICA", - "ASIA_PAC", - "C_AFRICA", - "C_ASIA_PAC", - "C_EUROPE", - "C_NORTH_AMERICA", - "C_SOUTH_AMERICA", - "EUROPE", - "NORTH_AMERICA", - "SOUTH_AMERICA" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "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" ], - "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA " - }, - "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" - }, - "name": { - "type": "string", - "description": "[Output Only] Name of the resource." - }, - "city": { - "type": "string", - "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\"." - }, - "description": { - "type": "string", - "description": "[Output Only] An optional description of the resource." - }, - "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" - }, - "availabilityZone": { - "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\".", - "type": "string" - }, - "regionInfos": { - "items": { - "$ref": "InterconnectLocationRegionInfo" + "request": { + "$ref": "TestPermissionsRequest" }, - "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." - }, - "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}/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" ], - "type": "string", - "enum": [ - "AVAILABLE", - "CLOSED" - ] - }, - "address": { - "type": "string", - "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character." - }, - "peeringdbFacilityId": { - "type": "string", - "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb)." - }, - "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" - }, - "facilityProviderFacilityId": { - "type": "string", - "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1)." - }, - "kind": { - "type": "string", - "default": "compute#interconnectLocation", - "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations." - } - }, - "type": "object" - }, - "ServiceAttachmentAggregatedList": { - "type": "object", - "properties": { - "kind": { - "default": "compute#serviceAttachmentAggregatedList", - "type": "string", - "description": "Type of resource." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "items": { - "description": "A list of ServiceAttachmentsScopedList resources.", - "type": "object", - "additionalProperties": { - "$ref": "ServiceAttachmentsScopedList", - "description": "Name of the scope containing this set of ServiceAttachments." + "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", + "httpMethod": "POST", + "response": { + "$ref": "TestPermissionsResponse" } }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "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" }, - "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": "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" + ] }, - "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." - ], + "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", - "description": "[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])?", + "location": "path", + "description": "The name of the zone for this request." }, - "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" + "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 }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "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." } }, - "type": "object" + "id": "compute.instances.getGuestAttributes" }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - }, - "description": "Contains a list of ServiceAttachmentsScopedList.", - "id": "ServiceAttachmentAggregatedList" - }, - "SslCertificateManagedSslCertificate": { - "description": "Configuration and status of a managed SSL certificate.", - "id": "SslCertificateManagedSslCertificate", - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "[Output only] Status of the managed certificate resource.", - "enum": [ - "ACTIVE", - "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", - "PROVISIONING", - "PROVISIONING_FAILED", - "PROVISIONING_FAILED_PERMANENTLY", - "RENEWAL_FAILED" + "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" ], - "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." + "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" ] }, - "domains": { - "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).", - "items": { - "type": "string" - } - }, - "domainStatus": { - "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", - "additionalProperties": { - "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." - ], - "type": "string", - "enum": [ - "ACTIVE", - "DOMAIN_STATUS_UNSPECIFIED", - "FAILED_CAA_CHECKING", - "FAILED_CAA_FORBIDDEN", - "FAILED_NOT_VISIBLE", - "FAILED_RATE_LIMITED", - "PROVISIONING" - ] + "detachDisk": { + "response": { + "$ref": "Operation" }, - "type": "object" - } - } - }, - "InstanceGroup": { - "type": "object", - "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.", - "properties": { - "name": { - "description": "The name of the 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])?", - "type": "string", - "annotations": { - "required": [ - "compute.instanceGroups.insert" - ] - } - }, - "region": { - "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).", - "type": "string" - }, - "size": { - "description": "[Output Only] The total number of instances in the instance group.", - "type": "integer", - "format": "int32" - }, - "namedPorts": { - "type": "array", - "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. ", - "items": { - "$ref": "NamedPort" - } - }, - "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" - }, - "fingerprint": { - "type": "string", - "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" - }, - "kind": { - "type": "string", - "default": "compute#instanceGroup", - "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups." - }, - "subnetwork": { - "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).", - "type": "string" - }, - "zone": { - "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).", - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format.", - "type": "string" - }, - "id": { - "type": "string", - "description": "[Output Only] A unique identifier for this instance group, generated by the server.", - "format": "uint64" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] The URL for this instance group. The server generates this URL." - } - } - }, - "InstanceGroupManagersScopedList": { - "type": "object", - "id": "InstanceGroupManagersScopedList", - "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" - ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", + "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}" }, - "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" - } + "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" }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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" } }, - "type": "object", - "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty." + "description": "Detaches a disk from an instance.", + "id": "compute.instances.detachDisk" }, - "instanceGroupManagers": { - "items": { - "$ref": "InstanceGroupManager" + "setLabels": { + "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.", + "response": { + "$ref": "Operation" }, - "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.", - "type": "array" - } - } - }, - "InstancesSetLabelsRequest": { - "id": "InstancesSetLabelsRequest", - "type": "object", - "properties": { - "labels": { - "additionalProperties": { - "type": "string" + "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", + "request": { + "$ref": "InstancesSetLabelsRequest" }, - "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." - } - } - }, - "SourceInstanceProperties": { - "type": "object", - "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", - "id": "SourceInstanceProperties", - "properties": { - "guestAccelerators": { - "items": { - "$ref": "AcceleratorConfig" + "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 + } }, - "type": "array", - "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image." - }, - "canIpForward": { - "type": "boolean", - "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." + "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" + ] }, - "serviceAccounts": { - "type": "array", - "items": { - "$ref": "ServiceAccount" + "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" + } }, - "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." - }, - "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": { - "type": "string", - "description": "An optional text description for the instances that are created from this machine image." - }, - "disks": { - "description": "An array of disks that are associated with the instances that are created from this machine image.", - "type": "array", - "items": { - "$ref": "SavedAttachedDisk" - } - }, - "deletionProtection": { - "type": "boolean", - "description": "Whether the instance created from this machine image should be protected against deletion." - }, - "machineType": { - "type": "string", - "description": "The machine type to use for instances that are created from this machine image." + "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" }, - "networkInterfaces": { - "description": "An array of network access configurations for this interface.", - "items": { - "$ref": "NetworkInterface" + "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" + } }, - "type": "array" - }, - "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.", - "$ref": "Tags" - }, - "minCpuPlatform": { - "type": "string", - "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." - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Specifies the scheduling options for the instances that are created from this machine image." + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "id": "compute.instances.reset" }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "addResourcePolicies": { + "request": { + "$ref": "InstancesAddResourcePoliciesRequest" }, - "description": "Labels to apply to instances that are created from this machine image." - }, - "keyRevocationActionType": { - "type": "string", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" + "response": { + "$ref": "Operation" + }, + "id": "compute.instances.addResourcePolicies", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." - ] - } - } - }, - "NodeGroupsScopedList": { - "properties": { - "warning": { - "type": "object", - "properties": { - "message": { + "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": "[Output Only] A human-readable description of the warning code." + "description": "The name of the zone for this request." }, - "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" + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "description": "[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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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)." + }, + "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}" } }, - "description": "[Output Only] An informational warning that appears when the nodeGroup list is empty." + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", + "parameterOrder": [ + "project", + "zone", + "instance" + ] }, - "nodeGroups": { - "items": { - "$ref": "NodeGroup" + "suspend": { + "response": { + "$ref": "Operation" }, - "type": "array", - "description": "[Output Only] A list of node groups contained in this scope." - } - }, - "type": "object", - "id": "NodeGroupsScopedList" - }, - "HealthCheckServiceReference": { - "id": "HealthCheckServiceReference", - "type": "object", - "properties": { - "healthCheckService": { - "type": "string" - } - }, - "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 " - }, - "ConfidentialInstanceConfig": { - "id": "ConfidentialInstanceConfig", - "type": "object", - "properties": { - "enableConfidentialCompute": { - "description": "Defines whether the instance should have confidential compute enabled.", - "type": "boolean" - } - }, - "description": "A set of Confidential Instance options." - }, - "TargetPoolsAddHealthCheckRequest": { - "type": "object", - "id": "TargetPoolsAddHealthCheckRequest", - "properties": { - "healthChecks": { - "description": "The HttpHealthCheck to add to the target pool.", - "type": "array", - "items": { - "$ref": "HealthCheckReference" - } - } - } - }, - "ResourcePolicyGroupPlacementPolicy": { - "type": "object", - "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality", - "properties": { - "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.", - "type": "integer", - "format": "int32" - }, - "vmCount": { - "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.", - "format": "int32", - "type": "integer" - }, - "collocation": { - "type": "string", - "description": "Specifies network collocation", - "enumDescriptions": [ - "", - "" + "parameterOrder": [ + "project", + "zone", + "instance" ], - "enum": [ - "COLLOCATED", - "UNSPECIFIED_COLLOCATION" - ] - } - }, - "id": "ResourcePolicyGroupPlacementPolicy" - }, - "TargetPoolsScopedList": { - "type": "object", - "properties": { - "targetPools": { - "description": "A list of target pools contained in this scope.", - "type": "array", - "items": { - "$ref": "TargetPool" - } - }, - "warning": { - "type": "object", - "description": "Informational warning which replaces the list of addresses when the list is empty.", - "properties": { - "code": { + "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", - "description": "[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", + "description": "The name of the zone for this request." }, - "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" + "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" }, - "message": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" } - } - } - }, - "id": "TargetPoolsScopedList" - }, - "DiskInstantiationConfig": { - "id": "DiskInstantiationConfig", - "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" + }, + "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." }, - "instantiateFrom": { - "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." + "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" ], - "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. ", - "enum": [ - "ATTACH_READ_ONLY", - "BLANK", - "CUSTOM_IMAGE", - "DEFAULT", - "DO_NOT_INCLUDE", - "SOURCE_IMAGE", - "SOURCE_IMAGE_FAMILY" - ] - }, - "customImage": { - "description": "The custom source image to be used to restore this disk when instantiating this instance template.", - "type": "string" + "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" }, - "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)." - } - }, - "type": "object" - }, - "InstanceList": { - "id": "InstanceList", - "type": "object", - "description": "Contains a list of instances.", - "properties": { - "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" - ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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, + "description": "Project ID for this request." }, - "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\" } " + "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" }, - "message": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" } - } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.", - "type": "string", - "default": "compute#instanceList" - }, - "items": { - "type": "array", - "items": { - "$ref": "Instance" }, - "description": "A list of Instance 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." + "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance." }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - } - }, - "VpnGatewayStatus": { - "id": "VpnGatewayStatus", - "type": "object", - "properties": { - "vpnConnections": { - "description": "List of VPN connection for this VpnGateway.", - "items": { - "$ref": "VpnGatewayStatusVpnConnection" + "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)." + } }, - "type": "array" - } - } - }, - "RegionInstanceGroupManagersListInstancesResponse": { - "properties": { - "managedInstances": { - "items": { - "$ref": "ManagedInstance" + "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" }, - "description": "A list of managed instances.", - "type": "array" + "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" + } }, - "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": "RegionInstanceGroupManagersListInstancesResponse" - }, - "TargetHttpProxyList": { - "type": "object", - "id": "TargetHttpProxyList", - "description": "A list of TargetHttpProxy resources.", - "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": { - "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" + "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" }, - "code": { + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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 }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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 } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "type": "string", - "default": "compute#targetHttpProxyList", - "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies." - }, - "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", - "description": "A list of TargetHttpProxy resources.", - "items": { - "$ref": "TargetHttpProxy" - } - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - } - }, - "NodeGroupNode": { - "id": "NodeGroupNode", - "type": "object", - "properties": { - "instances": { - "description": "Instances scheduled on this node.", - "items": { - "type": "string" + "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "cpuOvercommitType": { - "description": "CPU overcommit.", - "type": "string", - "enum": [ - "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", - "ENABLED", - "NONE" + "httpMethod": "PATCH", + "request": { + "$ref": "ShieldedInstanceConfig" + }, + "parameterOrder": [ + "project", + "zone", + "instance" ], - "enumDescriptions": [ - "", - "", - "" - ] - }, - "serverBinding": { - "$ref": "ServerBinding", - "description": "Binding properties for the physical server." + "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." }, - "status": { - "type": "string", - "enumDescriptions": [ - "", - "", - "", - "", - "" + "delete": { + "parameterOrder": [ + "project", + "zone", + "instance" ], - "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY", - "REPAIRING" - ] - }, - "nodeType": { - "description": "The type of this node.", - "type": "string" - }, - "serverId": { - "type": "string", - "description": "Server ID associated with this node." - }, - "name": { - "type": "string", - "description": "The name of the node." - }, - "consumedResources": { - "description": "Node resources that are reserved by all instances.", - "$ref": "InstanceConsumptionInfo" - }, - "totalResources": { - "description": "Total amount of available resources on the node.", - "$ref": "InstanceConsumptionInfo" - }, - "accelerators": { - "type": "array", - "items": { - "$ref": "AcceleratorConfig" - }, - "description": "Accelerators for this node." - }, - "disks": { - "type": "array", - "items": { - "$ref": "LocalDisk" + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" }, - "description": "Local disk configurations." - }, - "instanceConsumptionData": { - "description": "Instance data that shows consumed resources on the node.", - "type": "array", - "items": { - "$ref": "InstanceConsumptionData" - } - }, - "satisfiesPzs": { - "type": "boolean", - "description": "[Output Only] Reserved for future use." - } - } - }, - "Metadata": { - "description": "A metadata key/value entry.", - "properties": { - "items": { - "type": "array", - "items": { - "properties": { - "key": { - "pattern": "[a-zA-Z0-9-_]{1,128}", - "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.", - "type": "string" - }, - "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" - ] - } - } + "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." }, - "description": "Metadata", - "type": "object" + "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" + } }, - "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB." - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", - "default": "compute#metadata", - "type": "string" - }, - "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" - } - }, - "type": "object", - "id": "Metadata" - }, - "XpnResourceId": { - "description": "Service resource (a.k.a service project) ID.", - "type": "object", - "id": "XpnResourceId", - "properties": { - "type": { - "enumDescriptions": [ - "", - "" - ], - "description": "The type of the service resource.", - "type": "string", - "enum": [ - "PROJECT", - "XPN_RESOURCE_TYPE_UNSPECIFIED" + "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" ] }, - "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)." - } - } - }, - "InterconnectDiagnosticsLinkLACPStatus": { - "type": "object", - "id": "InterconnectDiagnosticsLinkLACPStatus", - "properties": { - "neighborSystemId": { - "description": "System ID of the port on the neighbor's side of the LACP exchange.", - "type": "string" - }, - "state": { - "enum": [ - "ACTIVE", - "DETACHED" + "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" ], - "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." + "parameterOrder": [ + "project", + "zone", + "instance", + "networkInterface" ], - "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. " + "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" }, - "googleSystemId": { - "description": "System ID of the port on Google's side of the LACP exchange.", - "type": "string" - } - } - }, - "AuthorizationLoggingOptions": { - "properties": { - "permissionType": { - "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.", - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use." + "setMetadata": { + "id": "compute.instances.setMetadata", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "ADMIN_READ", - "ADMIN_WRITE", - "DATA_READ", - "DATA_WRITE", - "PERMISSION_TYPE_UNSPECIFIED" + "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" ], - "type": "string" - } - }, - "description": "This is deprecated and has no effect. Do not use.", - "id": "AuthorizationLoggingOptions", - "type": "object" - }, - "ServiceAttachmentConnectedEndpoint": { - "type": "object", - "id": "ServiceAttachmentConnectedEndpoint", - "properties": { - "endpoint": { - "type": "string", - "description": "The url of a connected endpoint." + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "Metadata" + }, + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata" }, - "status": { - "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.", - "" + "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" ], - "type": "string", - "description": "The status of a connected endpoint to this service attachment.", - "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" - ] - }, - "pscConnectionId": { - "description": "The PSC connection id of the connected endpoint.", - "type": "string", - "format": "uint64" - } - }, - "description": "[Output Only] A connection connected to this service attachment." - }, - "InstanceGroupManagerStatusStatefulPerInstanceConfigs": { - "type": "object", - "properties": { - "allEffective": { - "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": "boolean" - } - }, - "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs" - }, - "BackendBucketList": { - "id": "BackendBucketList", - "type": "object", - "properties": { - "kind": { - "default": "compute#backendBucketList", - "type": "string", - "description": "Type of resource." - }, - "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." + "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" + } }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { + "getSerialPortOutput": { + "id": "compute.instances.getSerialPortOutput", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "httpMethod": "GET", + "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" - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "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" - } + "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" }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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" + ] }, - "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" + "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." }, - "items": { - "type": "array", - "description": "A list of BackendBucket resources.", - "items": { - "$ref": "BackendBucket" - } - } - }, - "description": "Contains a list of BackendBucket resources." - }, - "FirewallList": { - "id": "FirewallList", - "description": "Contains a list of firewalls.", - "properties": { - "warning": { - "type": "object", - "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" - } - } - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "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." }, - "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" - ], + "instance": { + "location": "path", + "description": "The instance name 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." + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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 } }, - "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" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.", - "default": "compute#firewallList" - }, - "items": { - "description": "A list of Firewall resources.", - "type": "array", - "items": { - "$ref": "Firewall" - } - }, - "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" - } - }, - "type": "object" - }, - "Help": { - "id": "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.", - "type": "object", - "properties": { - "links": { - "type": "array", - "items": { - "$ref": "HelpLink" + "parameterOrder": [ + "project", + "zone", + "instance", + "accessConfig", + "networkInterface" + ], + "response": { + "$ref": "Operation" }, - "description": "URL(s) pointing to additional information on handling the current error." - } - } - }, - "TargetSslProxiesSetBackendServiceRequest": { - "properties": { - "service": { - "type": "string", - "description": "The URL of the new BackendService resource for the targetSslProxy." - } - }, - "type": "object", - "id": "TargetSslProxiesSetBackendServiceRequest" - }, - "NetworkEndpointGroupCloudFunction": { - "type": "object", - "id": "NetworkEndpointGroupCloudFunction", - "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" - }, - "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" - } - }, - "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." - }, - "RegionDiskTypeList": { - "id": "RegionDiskTypeList", - "properties": { - "items": { - "description": "A list of DiskType resources.", - "type": "array", - "items": { - "$ref": "DiskType" - } - }, - "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" + "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" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { + "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": "[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" }, - "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\" } " + "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" }, - "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.", + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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", + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.", - "default": "compute#regionDiskTypeList" - } - }, - "type": "object" - }, - "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", - "id": "Commitment", - "properties": { - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string", - "format": "uint64" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "splitSourceCommitment": { - "type": "string", - "description": "Source commitment to be splitted into a new commitment." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "plan": { - "enum": [ - "INVALID", - "THIRTY_SIX_MONTH", - "TWELVE_MONTH" - ], - "type": "string", - "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": [ - "", - "", - "" - ] - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "CANCELLED", - "CREATING", - "EXPIRED", - "NOT_YET_ACTIVE" + "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" ], - "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": [ - "", - "", - "", - "", - "" - ] - }, - "endTimestamp": { - "description": "[Output Only] Commitment end time in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "resources": { - "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", - "items": { - "$ref": "ResourceCommitment" + "response": { + "$ref": "InstanceList" }, - "type": "array" - }, - "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" - }, - "kind": { - "default": "compute#commitment", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#commitment for commitments." - }, - "region": { - "description": "[Output Only] URL of the region where this commitment may be used.", - "type": "string" - }, - "licenseResource": { - "description": "The license specification required as part of a license commitment.", - "$ref": "LicenseResourceCommitment" - }, - "reservations": { - "description": "List of reservations in this commitment.", - "type": "array", - "items": { - "$ref": "Reservation" - } - }, - "mergeSourceCommitments": { - "type": "array", - "description": "List of source commitments to be merged into a new commitment.", - "items": { - "type": "string" - } - }, - "category": { - "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.", - "type": "string", - "enumDescriptions": [ - "", - "", - "" + "parameterOrder": [ + "project", + "zone" ], - "enum": [ - "CATEGORY_UNSPECIFIED", - "LICENSE", - "MACHINE" - ] - }, - "statusMessage": { - "type": "string", - "description": "[Output Only] An optional, human-readable explanation of the status." - }, - "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])?" - }, - "startTimestamp": { - "type": "string", - "description": "[Output Only] Commitment start time in RFC3339 text format." + "httpMethod": "GET", + "path": "projects/{project}/zones/{zone}/instances", + "id": "compute.instances.list", + "flatPath": "projects/{project}/zones/{zone}/instances" }, - "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" + "setServiceAccount": { + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", + "parameterOrder": [ + "project", + "zone", + "instance" ], - "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": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "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" ], - "type": "string" - } - } - }, - "ZoneList": { - "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." - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "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\" } " - }, - "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." - ], + "parameters": { + "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" - ], - "description": "[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])?))" }, - "message": { + "zone": { + "location": "path", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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" } - } - }, - "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#zoneList", - "description": "Type of resource.", - "type": "string" - }, - "items": { - "description": "A list of Zone resources.", - "items": { - "$ref": "Zone" }, - "type": "array" - } - }, - "description": "Contains a list of zone resources.", - "id": "ZoneList", - "type": "object" - }, - "InstancesSetServiceAccountRequest": { - "id": "InstancesSetServiceAccountRequest", - "type": "object", - "properties": { - "scopes": { - "type": "array", - "items": { - "type": "string" + "request": { + "$ref": "InstancesSetServiceAccountRequest" }, - "description": "The list of scopes to be made available for this service account." + "description": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance." }, - "email": { - "description": "Email address of the service account.", - "type": "string" - } - } - }, - "RegionInstanceGroupManagerUpdateInstanceConfigReq": { - "type": "object", - "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", - "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", - "properties": { - "perInstanceConfigs": { - "items": { - "$ref": "PerInstanceConfig" + "attachDisk": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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 + } }, - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", - "type": "array" - } - } - }, - "RegionDisksRemoveResourcePoliciesRequest": { - "properties": { - "resourcePolicies": { - "items": { - "type": "string" + "response": { + "$ref": "Operation" }, - "type": "array", - "description": "Resource policies to be removed from this disk." - } - }, - "id": "RegionDisksRemoveResourcePoliciesRequest", - "type": "object" - }, - "InstanceGroupManagerStatus": { - "id": "InstanceGroupManagerStatus", - "properties": { - "isStable": { - "type": "boolean", - "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." - }, - "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": { - "$ref": "InstanceGroupManagerStatusStateful", - "description": "[Output Only] Stateful status of the given Instance Group Manager." - }, - "autoscaler": { - "type": "string", - "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager." - } - }, - "type": "object" - }, - "TargetGrpcProxyList": { - "properties": { - "items": { - "description": "A list of TargetGrpcProxy resources.", - "items": { - "$ref": "TargetGrpcProxy" + "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" }, - "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": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.", - "default": "compute#targetGrpcProxyList" - }, - "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" + "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", + "httpMethod": "POST", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk" }, - "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)." - } - } - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "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" }, - "message": { + "zone": { + "required": true, + "location": "path", + "description": "The name of the zone for this request.", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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.", + "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": "[Output Only] Informational warning message." - } - }, - "type": "object", - "id": "TargetGrpcProxyList" - }, - "DistributionPolicyZoneConfiguration": { - "type": "object", - "id": "DistributionPolicyZoneConfiguration", - "properties": { - "zone": { - "annotations": { - "required": [ - "compute.regionInstanceGroupManagers.insert" - ] - }, - "type": "string", - "description": "The URL of the zone. The zone must exist in the region where the managed instance group is located." - } - } - }, - "GlobalNetworkEndpointGroupsAttachEndpointsRequest": { - "properties": { - "networkEndpoints": { - "type": "array", - "items": { - "$ref": "NetworkEndpoint" + "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" }, - "description": "The list of network endpoints to be attached." - } - }, - "id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest", - "type": "object" - }, - "InstancesSetMachineTypeRequest": { - "id": "InstancesSetMachineTypeRequest", - "properties": { - "machineType": { - "type": "string", - "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": "object" - }, - "InstanceTemplate": { - "id": "InstanceTemplate", - "type": "object", - "properties": { - "id": { - "format": "uint64", - "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.", - "type": "string" - }, - "sourceInstanceParams": { - "$ref": "SourceInstanceParams", - "description": "The source instance params to use to create this instance template." - }, - "kind": { - "default": "compute#instanceTemplate", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "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" + "parameterOrder": [ + "project", + "zone", + "instance", + "networkInterface" + ], + "id": "compute.instances.updateNetworkInterface" }, - "name": { - "type": "string", - "annotations": { - "required": [ - "compute.instanceTemplates.insert" - ] + "updateDisplayDevice": { + "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.", - "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" + ], + "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" + }, + "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)." + }, + "instance": { + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path", + "type": "string", + "description": "Name of the instance scoping this request." + }, + "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])?", + "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." + } + } }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format." + "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" }, - "properties": { - "description": "The instance properties for this instance template.", - "$ref": "InstanceProperties" + "setMachineType": { + "id": "compute.instances.setMachineType", + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "InstancesSetMachineTypeRequest" + }, + "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": "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 + }, + "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])?))", + "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" + } + } }, - "selfLink": { - "type": "string", - "description": "[Output Only] The URL for this instance template. The server defines this URL." - } - }, - "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." - }, - "InterconnectAttachmentAggregatedList": { - "type": "object", - "id": "InterconnectAttachmentAggregatedList", - "properties": { - "items": { - "description": "A list of InterconnectAttachmentsScopedList resources.", - "additionalProperties": { - "description": "Name of the scope containing this set of interconnect attachments.", - "$ref": "InterconnectAttachmentsScopedList" + "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" }, - "type": "object" - }, - "unreachables": { - "type": "array", - "items": { - "type": "string" + "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": "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" + }, + "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": { + "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}" + } }, - "description": "[Output Only] Unreachable resources." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.", - "default": "compute#interconnectAttachmentAggregatedList" - }, - "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" + "request": { + "$ref": "ShieldedInstanceIntegrityPolicy" + } }, - "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)." - } - } - } + "get": { + "path": "projects/{project}/zones/{zone}/instances/{instance}", + "parameters": { + "instance": { + "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 return.", + "location": "path" }, - "code": { + "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." - ], - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" }, - "message": { + "zone": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "required": true, + "description": "The name of the zone for this request." } }, - "type": "object", - "description": "[Output Only] Informational warning message." - } - } - }, - "Condition": { - "properties": { - "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." + "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" ], - "description": "This is deprecated and has no effect. Do not use.", - "enum": [ - "APPROVER", - "ATTRIBUTION", - "AUTHORITY", - "CREDENTIALS_TYPE", - "CREDS_ASSERTION", - "JUSTIFICATION_TYPE", - "NO_ATTR", - "SECURITY_REALM" + "parameterOrder": [ + "project", + "zone", + "instance" ], - "type": "string" - }, - "svc": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "This is deprecated and has no effect. Do not use." + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", + "httpMethod": "GET", + "id": "compute.instances.get" }, - "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." + "setDiskAutoDelete": { + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "IP", - "NAME", - "NO_ATTR", - "REGION", - "SERVICE" + "parameterOrder": [ + "project", + "zone", + "instance", + "autoDelete", + "deviceName" ], - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" + "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": "Sets the auto-delete flag for a disk attached to an instance.", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete" }, - "op": { - "type": "string", - "description": "This is deprecated and has no effect. Do not use.", - "enum": [ - "DISCHARGED", - "EQUALS", - "IN", - "NOT_EQUALS", - "NOT_IN", - "NO_OP" + "setDeletionProtection": { + "parameterOrder": [ + "project", + "zone", + "resource" ], - "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." - ] - } - }, - "type": "object", - "description": "This is deprecated and has no effect. Do not use.", - "id": "Condition" - }, - "MachineTypeList": { - "description": "Contains a list of machine types.", - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.", - "default": "compute#machineTypeList" - }, - "items": { - "type": "array", - "description": "A list of MachineType resources.", - "items": { - "$ref": "MachineType" - } - }, - "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": { - "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], + "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" }, - "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", + "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." + } + }, + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "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" + ], + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start", + "path": "projects/{project}/zones/{zone}/instances/{instance}/start", + "httpMethod": "POST", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "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])?" }, - "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" + }, + "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" } } - } - }, - "id": "MachineTypeList" - }, - "UrlMapsScopedList": { - "properties": { - "urlMaps": { - "description": "A list of UrlMaps contained in this scope.", - "type": "array", - "items": { - "$ref": "UrlMap" - } }, - "warning": { - "description": "Informational warning which replaces the list of backend services when the list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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." - } - } - } + "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" }, - "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" - ], + "orderBy": { + "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." + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" } }, - "type": "object" - } - }, - "type": "object", - "id": "UrlMapsScopedList" - }, - "VpnGatewaysScopedList": { - "type": "object", - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of addresses 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" - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" - }, - "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" - } + "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" + }, + "setIamPolicy": { + "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetPolicyRequest" + }, + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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 }, - "message": { + "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 human-readable description of the warning code." + "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" } }, - "type": "object" + "response": { + "$ref": "Policy" + } }, - "vpnGateways": { - "items": { - "$ref": "VpnGateway" + "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" }, - "type": "array", - "description": "[Output Only] A list of VPN gateways contained in this scope." - } - }, - "id": "VpnGatewaysScopedList" - }, - "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.", - "" + "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" ], - "type": "string", - "enum": [ - "RESTART_NODE_ON_ANY_SERVER", - "RESTART_NODE_ON_MINIMAL_SERVERS", - "SERVER_BINDING_TYPE_UNSPECIFIED" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "HttpHealthCheckList": { - "id": "HttpHealthCheckList", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "kind": { - "default": "compute#httpHealthCheckList", - "description": "Type of resource.", - "type": "string" }, - "warning": { - "properties": { - "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\" } " + "bulkInsert": { + "id": "compute.instances.bulkInsert", + "path": "projects/{project}/zones/{zone}/instances/bulkInsert", + "parameterOrder": [ + "project", + "zone" + ], + "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" + ], + "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" }, - "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])?))", + "required": true, + "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" + } + } + }, + "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" + }, + "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": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + }, + "networkInterface": { + "location": "query", + "description": "The name of the network interface where the access config is attached.", + "type": "string", + "required": true } }, - "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." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.instances.updateAccessConfig", + "httpMethod": "POST" }, - "items": { - "items": { - "$ref": "HttpHealthCheck" + "addAccessConfig": { + "httpMethod": "POST", + "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig", + "response": { + "$ref": "Operation" }, - "description": "A list of HttpHealthCheck resources.", - "type": "array" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "type": "object", - "description": "Contains a list of HttpHealthCheck resources." - }, - "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 .", - "id": "HttpHealthCheck", - "properties": { - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "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." - }, - "requestPath": { - "type": "string", - "description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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" - }, - "checkIntervalSec": { - "format": "int32", - "type": "integer", - "description": "How often (in seconds) to send a health check. The default value is 5 seconds." - }, - "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" - }, - "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])?" - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "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." - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", - "default": "compute#httpHealthCheck", - "type": "string" - }, - "port": { - "format": "int32", - "type": "integer", - "description": "The TCP port number for the HTTP health check request. The default value is 80." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." + "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": "compute.instances.addAccessConfig", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig" } - }, - "type": "object" + } }, - "Autoscaler": { - "id": "Autoscaler", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "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" + "globalPublicDelegatedPrefixes": { + "methods": { + "patch": { + "id": "compute.globalPublicDelegatedPrefixes.patch", + "request": { + "$ref": "PublicDelegatedPrefix" }, - "type": "array" - }, - "zone": { - "description": "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).", - "type": "string" - }, - "recommendedSize": { - "format": "int32", - "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.", - "type": "integer" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "target": { - "type": "string", - "description": "URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler." - }, - "region": { - "description": "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).", - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "scalingScheduleStatus": { - "description": "[Output Only] Status information of existing scaling schedules.", - "additionalProperties": { - "$ref": "ScalingScheduleStatus" + "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", + "response": { + "$ref": "Operation" }, - "type": "object" - }, - "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", - "annotations": { - "required": [ - "compute.autoscalers.insert" - ] + "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" + } }, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "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%.", - "$ref": "AutoscalingPolicy" - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.", - "default": "compute#autoscaler", - "type": "string" - }, - "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.", - "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": "string", - "enum": [ - "ACTIVE", - "DELETING", - "ERROR", - "PENDING" - ] - } - }, - "type": "object", - "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." - }, - "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.", - "type": "object", - "id": "ForwardingRule", - "properties": { - "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" - }, - "serviceLabel": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." - }, - "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." - }, - "IPProtocol": { - "type": "string", - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "" + "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", + "parameterOrder": [ + "project", + "publicDelegatedPrefix" ], - "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).", - "enum": [ - "AH", - "ESP", - "ICMP", - "L3_DEFAULT", - "SCTP", - "TCP", - "UDP" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "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#forwardingRule for Forwarding Rule resources.", - "default": "compute#forwardingRule", - "type": "string" - }, - "metadataFilters": { - "type": "array", - "items": { - "$ref": "MetadataFilter" + "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.", + "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" + }, + "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": "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." - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "response": { + "$ref": "PublicDelegatedPrefixList" }, - "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." - }, - "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." - }, - "labelFingerprint": { - "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.", - "format": "byte" - }, - "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." - }, - "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" - }, - "subnetwork": { - "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": "string" - }, - "allPorts": { - "description": "This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService.", - "type": "boolean" - }, - "ipVersion": { - "type": "string", - "description": "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.", - "enumDescriptions": [ - "", - "", - "" - ], - "enum": [ - "IPV4", - "IPV6", - "UNSPECIFIED_VERSION" - ] - }, - "IPAddress": { - "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` * 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.", - "type": "string" - }, - "ports": { - "description": "The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the [specified list of ports]((https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\\\d+(?:-\\\\d+)?", - "type": "array", - "items": { - "type": "string" - } - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "networkTier": { - "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.", - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" + "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" ], - "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." + "parameterOrder": [ + "project" ] }, - "serviceDirectoryRegistrations": { - "description": "Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.", - "type": "array", - "items": { - "$ref": "ForwardingRuleServiceDirectoryRegistration" - } - }, - "portRange": { - "description": "This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications). @pattern: \\\\d+(?:-\\\\d+)?", - "type": "string" - }, - "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." - }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "pscConnectionStatus": { - "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.", - "" + "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" + } + }, + "response": { + "$ref": "PublicDelegatedPrefix" + }, + "httpMethod": "GET", + "parameterOrder": [ + "project", + "publicDelegatedPrefix" ], - "type": "string", - "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" - ] + "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}" }, - "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.", - "format": "byte", - "type": "string" + "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": { + "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.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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/publicDelegatedPrefixes", + "request": { + "$ref": "PublicDelegatedPrefix" + }, + "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, + "flatPath": "projects/{project}/global/publicDelegatedPrefixes", + "id": "compute.globalPublicDelegatedPrefixes.insert" }, - "loadBalancingScheme": { - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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" + "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" ] - }, - "pscConnectionId": { - "type": "string", - "description": "[Output Only] The PSC connection id of the PSC Forwarding Rule.", - "format": "uint64" - }, - "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." - }, - "target": { - "type": "string" - }, - "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" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." } } }, - "HttpRetryPolicy": { - "description": "The retry policy associates with HttpRouteRule", - "id": "HttpRetryPolicy", - "properties": { - "perTryTimeout": { - "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.", - "$ref": "Duration" - }, - "retryConditions": { - "items": { - "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" + }, + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 + }, + "targetTcpProxy": { + "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}" + } }, - "type": "array", - "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 " - }, - "numRetries": { - "format": "uint32", - "type": "integer", - "description": "Specifies the allowed number retries. This number must be \u003e 0. If not specified, defaults to 1." - } - }, - "type": "object" - }, - "SslPolicyReference": { - "type": "object", - "properties": { - "sslPolicy": { - "type": "string", - "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource." - } - }, - "id": "SslPolicyReference" - }, - "AcceleratorConfig": { - "type": "object", - "id": "AcceleratorConfig", - "description": "A specification of the type and number of accelerator cards attached to the instance.", - "properties": { - "acceleratorCount": { - "type": "integer", - "format": "int32", - "description": "The number of the guest accelerator cards exposed to this instance." - }, - "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" - } - } - }, - "SavedDisk": { - "type": "object", - "properties": { - "kind": { - "default": "compute#savedDisk", - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks." + "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" }, - "storageBytes": { - "description": "[Output Only] Size of the individual disk snapshot used by this machine image.", - "format": "int64", - "type": "string" + "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" + }, + "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}" + } + } }, - "storageBytesStatus": { - "enumDescriptions": [ - "", - "" + "aggregatedList": { + "path": "projects/{project}/aggregated/targetTcpProxies", + "flatPath": "projects/{project}/aggregated/targetTcpProxies", + "parameterOrder": [ + "project" ], - "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" + "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" ], - "type": "string" + "httpMethod": "GET" }, - "sourceDisk": { - "type": "string", - "description": "Specifies a URL of the disk attached to the source instance." + "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" + }, + "description": "Changes the ProxyHeaderType for TargetTcpProxy.", + "response": { + "$ref": "Operation" + } }, - "architecture": { - "type": "string", - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "list": { + "id": "compute.targetTcpProxies.list", + "httpMethod": "GET", + "response": { + "$ref": "TargetTcpProxyList" + }, + "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" ], - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" + "parameterOrder": [ + "project" ], - "description": "[Output Only] The architecture of the attached disk." - } - }, - "id": "SavedDisk", - "description": "An instance-attached disk resource." - }, - "InstanceGroupsScopedList": { - "id": "InstanceGroupsScopedList", - "properties": { - "warning": { - "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.", - "type": "object", - "properties": { - "code": { + "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { + "pageToken": { "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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." }, - "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" + "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" + } + } + }, + "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)." } + }, + "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.", + "httpMethod": "POST", + "request": { + "$ref": "TargetTcpProxy" } }, - "instanceGroups": { - "type": "array", - "items": { - "$ref": "InstanceGroup" + "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" + ], + "response": { + "$ref": "Operation" }, - "description": "[Output Only] The list of instance groups that are contained in this scope." + "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } - }, - "type": "object" + } }, - "DistributionPolicy": { - "type": "object", - "properties": { - "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" + "regionHealthCheckServices": { + "methods": { + "insert": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "region" ], - "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": { + "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", + "description": "Project ID for this request.", + "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" + } + }, + "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" ], - "type": "string" - }, - "zones": { - "description": "Zones where the regional managed instance group will create and manage its instances.", - "type": "array", - "items": { - "$ref": "DistributionPolicyZoneConfiguration" + "httpMethod": "POST", + "id": "compute.regionHealthCheckServices.insert", + "request": { + "$ref": "HealthCheckService" } - } - }, - "id": "DistributionPolicy" - }, - "InstanceListReferrers": { - "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" - }, - "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": { - "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" - } - } - } + "patch": { + "id": "compute.regionHealthCheckServices.patch", + "httpMethod": "PATCH", + "parameterOrder": [ + "project", + "region", + "healthCheckService" + ], + "request": { + "$ref": "HealthCheckService" + }, + "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "response": { + "$ref": "Operation" + }, + "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" }, - "message": { + "project": { + "required": true, + "description": "Project ID for this request.", "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])?))" }, - "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": { + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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])?", + "location": "path", + "description": "Name of the region scoping this request." } }, - "type": "object" + "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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." }, - "items": { - "items": { - "$ref": "Reference" + "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" + } }, - "type": "array", - "description": "A list of Reference resources." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.", - "default": "compute#instanceListReferrers", - "type": "string" - } - }, - "id": "InstanceListReferrers", - "type": "object", - "description": "Contains a list of instance referrers." - }, - "MachineImage": { - "type": "object", - "id": "MachineImage", - "properties": { - "name": { - "annotations": { - "required": [ - "compute.machineImages.insert" - ] + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" }, - "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" - }, - "sourceInstance": { - "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 ", - "type": "string" - }, - "kind": { - "default": "compute#machineImage", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#machineImage for machine image." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format." + "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "id": "compute.regionHealthCheckServices.delete", + "parameterOrder": [ + "project", + "region", + "healthCheckService" + ], + "description": "Deletes the specified regional HealthCheckService.", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "storageLocations": { - "type": "array", - "items": { - "type": "string" + "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" }, - "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored." - }, - "instanceProperties": { - "$ref": "InstanceProperties", - "description": "[Output Only] Properties of source instance" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] The URL for this machine image. The server defines this URL." - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "sourceDiskEncryptionKeys": { - "items": { - "$ref": "SourceDiskEncryptionKey" + "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, + "location": "path", + "description": "Project ID for this request." + }, + "healthCheckService": { + "required": true, + "location": "path", + "type": "string", + "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035." + }, + "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" + } }, - "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.", - "type": "array" - }, - "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." - }, - "savedDisks": { - "type": "array", - "description": "An array of Machine Image specific properties for disks attached to the source instance", - "items": { - "$ref": "SavedDisk" - } - }, - "totalStorageBytes": { - "type": "string", - "format": "int64", - "description": "[Output Only] Total size of the storage used by the machine image." - }, - "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." - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "guestFlush": { - "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.", - "type": "boolean" + "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "parameterOrder": [ + "project", + "region", + "healthCheckService" + ], + "id": "compute.regionHealthCheckServices.get", + "httpMethod": "GET" }, - "id": { - "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier.", - "type": "string", - "format": "uint64" + "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`." + } + }, + "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}/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." + } + } + }, + "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" + }, + "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" + } + }, + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "region", + "resource" + ] }, - "status": { - "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.", - "enumDescriptions": [ - "", - "", - "", - "", - "" + "get": { + "parameterOrder": [ + "project", + "region", + "address" ], - "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY", - "UPLOADING" + "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" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "type": "string" - } - }, - "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." - }, - "NetworkInterface": { - "type": "object", - "description": "A network interface resource attached to an instance.", - "properties": { - "queueCount": { - "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.", - "type": "integer", - "format": "int32" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", - "default": "compute#networkInterface" - }, - "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." - }, - "ipv6Address": { - "type": "string", - "description": "An IPv6 internal network address for this network interface." + "httpMethod": "GET", + "path": "projects/{project}/regions/{region}/addresses/{address}", + "response": { + "$ref": "Address" + }, + "flatPath": "projects/{project}/regions/{region}/addresses/{address}" }, - "stackType": { - "enumDescriptions": [ - "The network interface can have both IPv4 and IPv6 addresses.", - "The network interface will be assigned IPv4 address." + "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" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" + "httpMethod": "GET", + "flatPath": "projects/{project}/aggregated/addresses", + "parameterOrder": [ + "project" ], - "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." + "description": "Retrieves an aggregated list of addresses.", + "path": "projects/{project}/aggregated/addresses", + "id": "compute.addresses.aggregatedList", + "response": { + "$ref": "AddressAggregatedList" + } }, - "ipv6AccessType": { - "type": "string", - "enumDescriptions": [ - "This network interface can have external IPv6.", - "This network interface can have internal IPv6." + "delete": { + "path": "projects/{project}/regions/{region}/addresses/{address}", + "parameterOrder": [ + "project", + "region", + "address" ], - "enum": [ - "EXTERNAL", - "INTERNAL" + "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" ], - "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." - }, - "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" - }, - "internalIpv6PrefixLength": { - "format": "int32", - "type": "integer", - "description": "The prefix length of the primary internal IPv6 range." - }, - "network": { - "type": "string", - "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 " - }, - "accessConfigs": { - "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.", - "items": { - "$ref": "AccessConfig" + "description": "Deletes the specified address resource.", + "flatPath": "projects/{project}/regions/{region}/addresses/{address}", + "id": "compute.addresses.delete", + "response": { + "$ref": "Operation" }, - "type": "array" + "httpMethod": "DELETE" }, - "nicType": { - "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", - "enumDescriptions": [ - "GVNIC", - "No type specified.", - "VIRTIO" - ], - "enum": [ - "GVNIC", - "UNSPECIFIED_NIC_TYPE", - "VIRTIO_NET" + "list": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "type": "string" - }, - "aliasIpRanges": { - "items": { - "$ref": "AliasIpRange" + "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" + } }, - "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" - }, - "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" - }, - "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": { - "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.", - "items": { - "$ref": "AccessConfig" - } - } - }, - "id": "NetworkInterface" - }, - "SerialPortOutput": { - "type": "object", - "properties": { - "contents": { - "description": "[Output Only] The contents of the console output.", - "type": "string" - }, - "next": { - "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", - "format": "int64" - }, - "kind": { - "default": "compute#serialPortOutput", - "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "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.", - "type": "string", - "format": "int64" - } - }, - "description": "An instance serial console output.", - "id": "SerialPortOutput" - }, - "SubnetworkList": { - "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" - }, - "items": { - "items": { - "$ref": "Subnetwork" + "parameterOrder": [ + "project", + "region" + ], + "path": "projects/{project}/regions/{region}/addresses", + "response": { + "$ref": "AddressList" }, - "description": "A list of Subnetwork resources.", - "type": "array" + "flatPath": "projects/{project}/regions/{region}/addresses", + "description": "Retrieves a list of addresses contained within the specified region.", + "id": "compute.addresses.list" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "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\" } " + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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": { + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-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." - ] + "location": "path" } - } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.", - "type": "string", - "default": "compute#subnetworkList" - }, - "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", - "description": "Contains a list of Subnetwork resources.", - "id": "SubnetworkList" - }, - "InstanceReference": { - "id": "InstanceReference", - "properties": { - "instance": { - "type": "string", - "description": "The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances" - } - }, - "type": "object" - }, - "InstanceGroupManagersListManagedInstancesResponse": { - "type": "object", - "id": "InstanceGroupManagersListManagedInstancesResponse", - "properties": { - "managedInstances": { - "type": "array", - "items": { - "$ref": "ManagedInstance" }, - "description": "[Output Only] The list of instances in 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." + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "region" + ], + "path": "projects/{project}/regions/{region}/addresses", + "request": { + "$ref": "Address" + }, + "description": "Creates an address resource in the specified project by using the data included in the request.", + "id": "compute.addresses.insert" } } }, - "GlobalOrganizationSetPolicyRequest": { - "id": "GlobalOrganizationSetPolicyRequest", - "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" - }, - "etag": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "format": "byte", - "type": "string" - }, - "bindings": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "type": "array", - "items": { - "$ref": "Binding" - } - } - }, - "type": "object" - }, - "LogConfigCounterOptions": { - "type": "object", - "properties": { - "customFields": { - "type": "array", - "description": "This is deprecated and has no effect. Do not use.", - "items": { - "$ref": "LogConfigCounterOptionsCustomField" - } + "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" + } + }, + "httpMethod": "GET" }, - "metric": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" + "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" + ], + "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" + ] }, - "field": { - "type": "string", - "description": "This is deprecated and has no effect. Do not use." + "delete": { + "id": "compute.globalOrganizationOperations.delete", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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" + ] } - }, - "description": "This is deprecated and has no effect. Do not use.", - "id": "LogConfigCounterOptions" + } }, - "XpnHostList": { - "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" - }, - "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." - ], + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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])?))", + "required": true, + "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" + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "The name of the region for this request.", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "required": true } }, - "description": "[Output Only] Informational warning message." - }, - "kind": { - "default": "compute#xpnHostList", - "description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.", - "type": "string" - }, - "items": { - "items": { - "$ref": "Project" + "response": { + "$ref": "Operation" }, - "description": "[Output Only] A list of shared VPC host project URLs.", - "type": "array" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." + "path": "projects/{project}/regions/{region}/instances/bulkInsert", + "parameterOrder": [ + "project", + "region" + ], + "flatPath": "projects/{project}/regions/{region}/instances/bulkInsert", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "request": { + "$ref": "BulkInsertInstanceResource" + } } - }, - "id": "XpnHostList", - "type": "object" + } }, - "NetworkEndpointGroupList": { - "id": "NetworkEndpointGroupList", - "type": "object", - "properties": { - "items": { - "items": { - "$ref": "NetworkEndpointGroup" + "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." + } }, - "description": "A list of NetworkEndpointGroup resources.", - "type": "array" - }, - "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#networkEndpointGroupList for network endpoint group lists.", - "default": "compute#networkEndpointGroupList", - "type": "string" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "Route" + }, + "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" }, - "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.", + "list": { + "path": "projects/{project}/global/routes", + "parameterOrder": [ + "project" + ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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": "[Output Only] A human-readable description of the warning code." + "description": "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" }, - "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" - } + "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" + ] + }, + "delete": { + "httpMethod": "DELETE", + "flatPath": "projects/{project}/global/routes/{route}", + "description": "Deletes the specified Route resource.", + "path": "projects/{project}/global/routes/{route}", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "route" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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" } - } - }, - "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" - } - } - }, - "DisksAddResourcePoliciesRequest": { - "properties": { - "resourcePolicies": { - "type": "array", - "items": { - "type": "string" }, - "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" - }, - "HealthChecksAggregatedList": { - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." + "id": "compute.routes.delete" }, - "unreachables": { - "items": { - "type": "string" + "get": { + "flatPath": "projects/{project}/global/routes/{route}", + "response": { + "$ref": "Route" }, - "type": "array", - "description": "[Output Only] Unreachable resources." - }, - "warning": { - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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." - } - } - } - }, - "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" - ], + "route": { + "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." - ] + "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] Informational warning message.", - "type": "object" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "default": "compute#healthChecksAggregatedList", - "description": "Type of 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 HealthChecksScopedList resources.", - "type": "object", - "additionalProperties": { - "description": "Name of the scope containing this set of HealthChecks.", - "$ref": "HealthChecksScopedList" - } - } - }, - "type": "object", - "id": "HealthChecksAggregatedList" - }, - "InstanceManagedByIgmErrorInstanceActionDetails": { - "properties": { - "instance": { - "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.", - "type": "string" - }, - "action": { - "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)." + "parameterOrder": [ + "project", + "route" ], - "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:", - "type": "string", - "enum": [ - "ABANDONING", - "CREATING", - "CREATING_WITHOUT_RETRIES", - "DELETING", - "NONE", - "RECREATING", - "REFRESHING", - "RESTARTING", - "RESUMING", - "STARTING", - "STOPPING", - "SUSPENDING", - "VERIFYING" - ] - }, - "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" + "httpMethod": "GET", + "id": "compute.routes.get", + "description": "Returns the specified Route resource. Gets a list of available routes by making a list() request." } - }, - "type": "object", - "id": "InstanceManagedByIgmErrorInstanceActionDetails" + } }, - "NodeTypeAggregatedList": { - "properties": { - "items": { - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of node types.", - "$ref": "NodeTypesScopedList" + "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" }, - "description": "A list of NodeTypesScopedList resources.", - "type": "object" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.", - "default": "compute#nodeTypeAggregatedList" - }, - "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" - }, - "unreachables": { - "type": "array", - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - } - }, - "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" - ], + "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" }, - "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" + "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": { - "description": "[Output Only] A human-readable description of the warning code.", + "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": "NodeTypeAggregatedList", - "type": "object" - }, - "PacketMirroringNetworkInfo": { - "type": "object", - "id": "PacketMirroringNetworkInfo", - "properties": { - "url": { - "type": "string", - "description": "URL of the network resource." - }, - "canonicalUrl": { - "type": "string", - "description": "[Output Only] Unique identifier for the network; defined by the server." - } - } - }, - "LocationPolicyLocationConstraints": { - "description": "Per-zone constraints on location policy for this zone.", - "type": "object", - "id": "LocationPolicyLocationConstraints", - "properties": { - "maxCount": { - "format": "int32", - "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.", - "type": "integer" - } - } - }, - "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" - }, - "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" }, - "type": "array" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" + "id": "compute.packetMirrorings.aggregatedList" }, - "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" - ], - "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." - ] + "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" + ], + "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 }, - "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" }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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" } }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "additionalProperties": { - "$ref": "AcceleratorTypesScopedList", - "description": "[Output Only] Name of the scope containing this set of accelerator types." - }, - "description": "A list of AcceleratorTypesScopedList resources.", - "type": "object" - } - }, - "id": "AcceleratorTypeAggregatedList" - }, - "UrlMapsValidateRequest": { - "type": "object", - "properties": { - "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" + "insert": { + "httpMethod": "POST", + "response": { + "$ref": "Operation" }, - "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": "array" - }, - "resource": { - "description": "Content of the UrlMap to be validated.", - "$ref": "UrlMap" - } - }, - "id": "UrlMapsValidateRequest" - }, - "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" - } - }, - "id": "HealthCheckReference", - "type": "object" - }, - "HttpRouteAction": { - "id": "HttpRouteAction", - "type": "object", - "properties": { - "urlRewrite": { - "$ref": "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." - }, - "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." - }, - "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." - }, - "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": { - "items": { - "$ref": "WeightedBackendService" + "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" }, - "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.", - "type": "array" - }, - "timeout": { - "$ref": "Duration", - "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." - }, - "retryPolicy": { - "$ref": "HttpRetryPolicy", - "description": "Specifies the retry policy associated with this route." - }, - "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." - } - } - }, - "RegionInstanceGroupManagerList": { - "type": "object", - "id": "RegionInstanceGroupManagerList", - "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": { - "type": "string", - "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." - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "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\" } ", - "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" - } - } - } + "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])?))" }, - "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" }, - "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." - ], + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region 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." + "location": "path", + "required": true } } }, - "items": { - "type": "array", - "items": { - "$ref": "InstanceGroupManager" + "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": "A list of InstanceGroupManager resources." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "description": "Contains a list of managed instance groups." - }, - "NetworkEndpointGroup": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "annotations": { - "description": "Metadata defined as annotations on the network endpoint group.", - "additionalProperties": { - "type": "string" + "description": "Returns the specified PacketMirroring resource.", + "response": { + "$ref": "PacketMirroring" }, - "type": "object" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "networkEndpointType": { - "type": "string", - "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." + "id": "compute.packetMirrorings.get", + "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "parameterOrder": [ + "project", + "region", + "packetMirroring" ], - "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" - ] - }, - "network": { - "type": "string", - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified." - }, - "region": { - "description": "[Output Only] The URL of the region where the network endpoint group is located.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#networkEndpointGroup", - "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group." - }, - "cloudFunction": { - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.", - "$ref": "NetworkEndpointGroupCloudFunction" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "cloudRun": { - "$ref": "NetworkEndpointGroupCloudRun", - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set." - }, - "appEngine": { - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.", - "$ref": "NetworkEndpointGroupAppEngine" - }, - "size": { - "format": "int32", - "description": "[Output only] Number of network endpoints in the network endpoint group.", - "type": "integer" - }, - "id": { - "type": "string", - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "defaultPort": { - "type": "integer", - "description": "The default port used if the port number is not specified in the network endpoint.", - "format": "int32" - }, - "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\"" - }, - "zone": { - "type": "string", - "description": "[Output Only] The URL of the zone where the network endpoint group is located." - }, - "subnetwork": { - "type": "string", - "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong." - }, - "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." - } - }, - "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." - }, - "TargetInstanceAggregatedList": { - "type": "object", - "properties": { - "kind": { - "default": "compute#targetInstanceAggregatedList", - "type": "string", - "description": "Type of resource." + "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" }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" + "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])?" }, - "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\" } " + "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" }, - "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": { + "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" + ] + }, + "testIamPermissions": { + "response": { + "$ref": "TestPermissionsResponse" + }, + "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": "[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": "Name or id of the resource for this request.", + "location": "path", + "required": true + }, + "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, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string", + "location": "path", + "description": "The name of the region for this request." } + }, + "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" } }, - "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 target instances.", - "$ref": "TargetInstancesScopedList" + "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." + }, + "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": { + "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" + }, + "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])?))" + } }, - "description": "A list of TargetInstance resources." - }, - "unreachables": { - "items": { - "type": "string" + "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" }, - "description": "[Output Only] Unreachable resources.", - "type": "array" - }, - "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", + "region" + ] } - }, - "id": "TargetInstanceAggregatedList" + } }, - "PathMatcher": { - "type": "object", - "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": { - "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" - } - }, - "defaultUrlRedirect": { - "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.", - "$ref": "HttpRedirectAction" - }, - "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" - }, - "name": { - "description": "The name to which this PathMatcher is referred by the HostRule.", - "type": "string" + "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" }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." + "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" + } + }, + "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" + ] }, - "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.", - "type": "array", - "items": { - "$ref": "PathRule" + "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.", + "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" + }, + "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": { + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" + } } }, - "defaultService": { - "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 ", - "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" - }, - "FirewallPolicyRuleMatcherLayer4Config": { - "id": "FirewallPolicyRuleMatcherLayer4Config", - "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." + "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, + "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 + } + }, + "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" + ] }, - "ports": { - "items": { - "type": "string" + "aggregatedList": { + "response": { + "$ref": "OperationAggregatedList" }, - "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" + "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" + } + }, + "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" + ] } } }, - "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." - }, - "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" - } - }, - "id": "SourceDiskEncryptionKey", - "type": "object" - }, - "TargetVpnGatewayList": { - "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." - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", - "default": "compute#targetVpnGatewayList", - "type": "string" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "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." - ], + "images": { + "methods": { + "deprecate": { + "parameterOrder": [ + "project", + "image" + ], + "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" + ], + "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" }, - "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\" } " + "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" }, - "message": { + "project": { + "description": "Project ID for this request.", + "location": "path", "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", - "description": "[Output Only] Informational warning message." - }, - "items": { - "type": "array", - "description": "A list of TargetVpnGateway resources.", - "items": { - "$ref": "TargetVpnGateway" } }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "id": "TargetVpnGatewayList", - "description": "Contains a list of TargetVpnGateway resources." - }, - "TargetHttpsProxy": { - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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" - }, - "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." - }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - }, - "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 " + "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." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "id": "compute.images.testIamPermissions", + "flatPath": "projects/{project}/global/images/{resource}/testIamPermissions", + "parameterOrder": [ + "project", + "resource" + ], + "httpMethod": "POST", + "path": "projects/{project}/global/images/{resource}/testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource." }, - "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" + "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" + ], + "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" } }, - "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." - }, - "serverTlsPolicy": { - "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.", - "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" - }, - "kind": { - "default": "compute#targetHttpsProxy", - "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.", - "type": "string" - }, - "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" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "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" - }, - "region": { - "type": "string", - "description": "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies." - }, - "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. ", - "enum": [ - "DISABLE", - "ENABLE", - "NONE" + "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" ], - "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." + "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" + } + }, + "flatPath": "projects/{project}/global/images/{resource}/getIamPolicy", + "parameterOrder": [ + "project", + "resource" ] }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - } - }, - "id": "TargetHttpsProxy", - "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" - }, - "ResourcePolicyAggregatedList": { - "id": "ResourcePolicyAggregatedList", - "description": "Contains a list of resourcePolicies.", - "type": "object", - "properties": { - "warning": { - "type": "object", - "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\" } " - }, - "code": { + "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}", "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 }, - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "required": true } }, - "description": "[Output Only] Informational warning message." + "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" + } }, - "items": { - "description": "A list of ResourcePolicy resources.", - "additionalProperties": { - "$ref": "ResourcePoliciesScopedList", - "description": "Name of the scope containing this set of resourcePolicies." + "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", + "type": "string", + "description": "Name or id of the resource for this request." + }, + "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 + } }, - "type": "object" - }, - "etag": { - "type": "string" - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "unreachables": { - "items": { - "type": "string" + "request": { + "$ref": "GlobalSetLabelsRequest" }, - "description": "[Output Only] Unreachable resources.", - "type": "array" - }, - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "compute#resourcePolicyAggregatedList" - }, - "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" - } - } - }, - "NetworkEdgeSecurityServiceAggregatedList": { - "properties": { - "items": { - "description": "A list of NetworkEdgeSecurityServicesScopedList resources.", - "type": "object", - "additionalProperties": { - "$ref": "NetworkEdgeSecurityServicesScopedList", - "description": "Name of the scope containing this set of security policies." - } + "response": { + "$ref": "Operation" + }, + "description": "Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.", + "path": "projects/{project}/global/images/{resource}/setLabels" }, - "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" - ], + "get": { + "path": "projects/{project}/global/images/{image}", + "httpMethod": "GET", + "response": { + "$ref": "Image" + }, + "flatPath": "projects/{project}/global/images/{image}", + "id": "compute.images.get", + "parameterOrder": [ + "project", + "image" + ], + "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" + ] + }, + "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" }, - "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" - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "forceCreate": { + "type": "boolean", + "location": "query", + "description": "Force image creation if true." }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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." } - } - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", - "default": "compute#networkEdgeSecurityServiceAggregatedList" - }, - "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." - }, - "etag": { - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object", - "id": "NetworkEdgeSecurityServiceAggregatedList" - }, - "InstanceManagedByIgmError": { - "type": "object", - "properties": { - "error": { - "$ref": "InstanceManagedByIgmErrorManagedInstanceError", - "description": "[Output Only] Contents of the error." - }, - "timestamp": { - "type": "string", - "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format." - }, - "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" - } - }, - "id": "InstanceManagedByIgmError" - }, - "LocalDisk": { - "properties": { - "diskCount": { - "type": "integer", - "format": "int32", - "description": "Specifies the number of such disks." - }, - "diskSizeGb": { - "type": "integer", - "description": "Specifies the size of the disk in base-2 GB.", - "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" - } - }, - "type": "object", - "id": "LocalDisk" - }, - "NodeTemplateList": { - "id": "NodeTemplateList", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "type": "array", - "items": { - "$ref": "NodeTemplate" }, - "description": "A list of NodeTemplate 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": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." + "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" + }, + "request": { + "$ref": "Image" + }, + "flatPath": "projects/{project}/global/images" }, - "warning": { - "properties": { - "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\" } " + "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" }, - "message": { + "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" }, - "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" + "image": { + "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 } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "type": "string", - "default": "compute#nodeTemplateList", - "description": "[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates." - } - }, - "description": "Contains a list of node templates." - }, - "RegionInstanceGroupManagersRecreateRequest": { - "type": "object", - "id": "RegionInstanceGroupManagersRecreateRequest", - "properties": { - "instances": { - "type": "array", - "items": { - "type": "string" + "response": { + "$ref": "Operation" }, - "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]." - } - } - }, - "PerInstanceConfig": { - "id": "PerInstanceConfig", - "properties": { - "preservedState": { - "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.", - "$ref": "PreservedState" - }, - "status": { - "enum": [ - "APPLYING", - "DELETING", - "EFFECTIVE", - "NONE", - "UNAPPLIED", - "UNAPPLIED_DELETION" + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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." + "flatPath": "projects/{project}/global/images/{image}", + "parameterOrder": [ + "project", + "image" ], - "type": "string" + "id": "compute.images.delete", + "path": "projects/{project}/global/images/{image}" }, - "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.", - "format": "byte", - "type": "string" + "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" + ], + "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" + ], + "request": { + "$ref": "GlobalSetPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, - "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" - } - }, - "type": "object" - }, - "InterconnectLocationList": { - "id": "InterconnectLocationList", - "type": "object", - "description": "Response to the list request, and contains a list of interconnect locations.", - "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": { - "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" + "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" + ], + "id": "compute.images.list", + "httpMethod": "GET", + "parameterOrder": [ + "project" + ], + "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 }, - "message": { + "pageToken": { + "location": "query", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results." }, - "code": { + "filter": { + "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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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`." + }, + "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" + }, + "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." + } + } + } + } + }, + "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." + }, + "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, + "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" } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "items": { - "description": "A list of InterconnectLocation resources.", - "items": { - "$ref": "InterconnectLocation" + "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" }, - "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" - }, - "kind": { - "type": "string", - "default": "compute#interconnectLocationList", - "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations." - }, - "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." + "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}" } } }, - "Subnetwork": { - "type": "object", - "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.", - "id": "Subnetwork", - "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" - }, - "logConfig": { - "description": "This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.", - "$ref": "SubnetworkLogConfig" - }, - "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." - }, - "role": { - "enum": [ - "ACTIVE", - "BACKUP" - ], - "type": "string", - "enumDescriptions": [ - "The ACTIVE subnet that is currently used.", - "The BACKUP subnet that could be promoted to ACTIVE." - ], - "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." - }, - "externalIpv6Prefix": { - "type": "string", - "description": "[Output Only] The external IPv6 address range that is assigned to this subnetwork." - }, - "gatewayAddress": { - "type": "string", - "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "internalIpv6Prefix": { - "type": "string", - "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork." - }, - "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 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", - "format": "byte" - }, - "ipv6CidrRange": { - "description": "[Output Only] This field is for internal use.", - "type": "string" - }, - "ipv6AccessType": { - "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." + "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" ], - "type": "string", - "enum": [ - "EXTERNAL", - "INTERNAL" + "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" + }, + "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." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "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." - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "purpose": { - "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.", - "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": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "INTERNAL_HTTPS_LOAD_BALANCER", - "PRIVATE", - "PRIVATE_RFC_1918", - "PRIVATE_SERVICE_CONNECT", - "REGIONAL_MANAGED_PROXY" - ] - }, - "enableFlowLogs": { - "type": "boolean", - "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." - }, - "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." + "response": { + "$ref": "Operation" + }, + "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": "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" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "Deletes the specified policy.", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}", + "parameterOrder": [ + "project", + "securityPolicy" + ], + "id": "compute.securityPolicies.delete" }, - "privateIpv6GoogleAccess": { - "enum": [ - "DISABLE_GOOGLE_ACCESS", - "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", - "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE" + "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" + } + }, + "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" ], - "type": "string", - "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." + "response": { + "$ref": "SecurityPolicyRule" + }, + "httpMethod": "GET", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", + "parameterOrder": [ + "project", + "securityPolicy" ], - "description": "This field is for internal use. This field can be both set at resource creation time and updated using patch." + "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule" }, - "secondaryIpRanges": { - "items": { - "$ref": "SubnetworkSecondaryRange" + "list": { + "response": { + "$ref": "SecurityPolicyList" }, - "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." - }, - "region": { - "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#subnetwork", - "description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources." - }, - "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])?" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "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." + "parameterOrder": [ + "project" ], - "enum": [ - "IPV4_IPV6", - "IPV4_ONLY" + "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" ], - "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." + "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" + }, + "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", + "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" + }, + "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])?))" + } + }, + "httpMethod": "GET", + "description": "List all the policies that have been configured for the specified project.", + "id": "compute.securityPolicies.list", + "flatPath": "projects/{project}/global/securityPolicies" }, - "state": { - "type": "string", - "enumDescriptions": [ - "Subnetwork is being drained.", - "Subnetwork is ready for use." + "addRule": { + "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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", - "enum": [ - "DRAINING", - "READY" - ] - } - } - }, - "ProjectsEnableXpnResourceRequest": { - "properties": { - "xpnResource": { - "$ref": "XpnResourceId", - "description": "Service resource (a.k.a service project) ID." - } - }, - "id": "ProjectsEnableXpnResourceRequest", - "type": "object" - }, - "VmEndpointNatMappings": { - "properties": { - "interfaceNatMappings": { - "type": "array", - "items": { - "$ref": "VmEndpointNatMappingsInterfaceNatMappings" - } - }, - "instanceName": { - "type": "string", - "description": "Name of the VM instance which the endpoint belongs to" - } - }, - "type": "object", - "id": "VmEndpointNatMappings", - "description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC)." - }, - "InstanceMoveRequest": { - "type": "object", - "properties": { - "targetInstance": { - "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 ", - "type": "string" - }, - "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" - }, - "ReservationAggregatedList": { - "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." - }, - "kind": { - "default": "compute#reservationAggregatedList", - "description": "Type of resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "id": "compute.securityPolicies.addRule", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", + "parameterOrder": [ + "project", + "securityPolicy" + ], + "parameters": { + "securityPolicy": { + "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 + }, + "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" + }, + "validateOnly": { + "type": "boolean", + "location": "query", + "description": "If true, the request will not be committed." + } }, - "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." - }, - "items": { - "type": "object", - "additionalProperties": { - "$ref": "ReservationsScopedList", - "description": "Name of the scope containing this set of reservations." + "httpMethod": "POST", + "response": { + "$ref": "Operation" }, - "description": "A list of Allocation resources." - }, - "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.", - "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." - ] + "request": { + "$ref": "SecurityPolicyRule" + }, + "description": "Inserts a rule into a security policy." + }, + "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." }, - "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" - } - } - } + "priority": { + "location": "query", + "description": "The priority of the rule to remove from the security policy.", + "format": "int32", + "type": "integer" }, - "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])?))", + "location": "path", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "description": "Project ID for this request." } - } - } - }, - "id": "ReservationAggregatedList", - "description": "Contains a list of reservations." - }, - "ExternalVpnGatewayInterface": { - "id": "ExternalVpnGatewayInterface", - "type": "object", - "description": "The interface for the external VPN gateway.", - "properties": { - "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" - }, - "ipAddress": { - "type": "string", - "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." - } - } - }, - "RouterNat": { - "properties": { - "endpointTypes": { - "items": { - "enum": [ - "ENDPOINT_TYPE_SWG", - "ENDPOINT_TYPE_VM" - ], - "enumDescriptions": [ - "This is used for Secure Web Gateway endpoints.", - "This is the default." - ], - "type": "string" }, - "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" + "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" + } }, - "drainNatIps": { - "items": { - "type": "string" + "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)." + }, + "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." + }, + "validateOnly": { + "type": "boolean", + "description": "If true, the request will not be committed.", + "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.", - "type": "array" - }, - "udpIdleTimeoutSec": { - "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - }, - "tcpTimeWaitTimeoutSec": { - "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.", - "type": "integer", - "format": "int32" - }, - "tcpEstablishedIdleTimeoutSec": { - "type": "integer", - "format": "int32", - "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set." - }, - "enableEndpointIndependentMapping": { - "type": "boolean" - }, - "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" - }, - "tcpTransitoryIdleTimeoutSec": { - "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - }, - "rules": { - "type": "array", - "items": { - "$ref": "RouterNatRule" + "request": { + "$ref": "SecurityPolicy" }, - "description": "A list of rules associated with this NAT." - }, - "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", - "enum": [ - "ALL_SUBNETWORKS_ALL_IP_RANGES", - "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES", - "LIST_OF_SUBNETWORKS" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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)" - ] - }, - "icmpIdleTimeoutSec": { - "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - }, - "logConfig": { - "description": "Configure logging on this NAT.", - "$ref": "RouterNatLogConfig" - }, - "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" - }, - "maxPortsPerVm": { - "type": "integer", - "format": "int32", - "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." - }, - "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.", - "items": { - "type": "string" + "description": "Creates a new policy in the specified project using the data included in the request.", + "response": { + "$ref": "Operation" }, - "type": "array" + "httpMethod": "POST" }, - "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." + "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" ], - "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. ", - "type": "string", - "enum": [ - "AUTO_ONLY", - "MANUAL_ONLY" - ] - }, - "subnetworks": { - "items": { - "$ref": "RouterNatSubnetworkToNat" + "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" }, - "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." - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035." - } - }, - "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.", - "id": "RouterNat" - }, - "TCPHealthCheck": { - "type": "object", - "id": "TCPHealthCheck", - "properties": { - "response": { - "type": "string", - "description": "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII." - }, - "request": { - "type": "string", - "description": "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII." + "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" + } + } }, - "portSpecification": { - "enumDescriptions": [ - "The port number in port is used for health checking.", - "The portName is used for health checking.", - "For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking." + "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" ], - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "httpMethod": "PATCH", + "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", + "parameterOrder": [ + "project", + "securityPolicy" ], - "type": "string", - "description": "Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields." + "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}" + }, + "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": { + "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" + } + } }, - "proxyHeader": { - "type": "string", - "enum": [ - "NONE", - "PROXY_V1" + "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" + } + }, + "response": { + "$ref": "Operation" + }, + "id": "compute.securityPolicies.patchRule", + "request": { + "$ref": "SecurityPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enumDescriptions": [ - "", - "" + "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", + "description": "Patches a rule at the specified priority.", + "parameterOrder": [ + "project", + "securityPolicy" ], - "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE." - }, - "portName": { - "type": "string", - "description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence." - }, - "port": { - "format": "int32", - "description": "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.", - "type": "integer" - } - } - }, - "BackendBucketCdnPolicyNegativeCachingPolicy": { - "type": "object", - "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" - }, - "ttl": { - "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", - "format": "int32" - } - }, - "description": "Specify CDN TTLs for response error codes.", - "id": "BackendBucketCdnPolicyNegativeCachingPolicy" - }, - "NodeTemplateAggregatedList": { - "properties": { - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "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" - } + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", + "httpMethod": "POST" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "message": { + "aggregatedList": { + "httpMethod": "GET", + "response": { + "$ref": "SecurityPoliciesAggregatedList" + }, + "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": "[Output Only] A human-readable description of the warning code." + "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])?))" }, - "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" + "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" }, - "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.", + "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": { + "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." + }, + "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": { + "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" } - } - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.", - "default": "compute#nodeTemplateAggregatedList" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" }, - "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" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - } - }, - "type": "object", - "id": "NodeTemplateAggregatedList" - }, - "SecurityPolicyReference": { - "properties": { - "securityPolicy": { - "type": "string" - } - }, - "id": "SecurityPolicyReference", - "type": "object" - }, - "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", - "properties": { - "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", - "type": "string" + "path": "projects/{project}/aggregated/securityPolicies", + "parameterOrder": [ + "project" + ], + "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" }, - "type": { - "type": "string", - "enum": [ - "ACCELERATOR", - "LOCAL_SSD", - "MEMORY", - "UNSPECIFIED", - "VCPU" + "listPreconfiguredExpressionSets": { + "response": { + "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" + }, + "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." + }, + "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" ], - "description": "Type of resource for which this commitment applies. Possible values are VCPU and MEMORY", - "enumDescriptions": [ - "", - "", - "", - "", - "" + "id": "compute.securityPolicies.listPreconfiguredExpressionSets", + "flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", + "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", + "parameterOrder": [ + "project" ] - }, - "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" } - }, - "type": "object", - "id": "ResourceCommitment" + } }, - "RegionList": { - "description": "Contains a list of region resources.", - "type": "object", - "properties": { - "warning": { - "properties": { - "message": { + "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" + }, + "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", - "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": "Name of the project scoping this request." }, - "code": { + "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": { "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." + "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\" } ", - "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" - } + "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" + }, + "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." - }, - "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": { - "items": { - "$ref": "Region" - }, - "type": "array", - "description": "A list of Region resources." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "kind": { - "default": "compute#regionList", - "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.", - "type": "string" - } - }, - "id": "RegionList" - }, - "InterconnectDiagnosticsARPEntry": { - "type": "object", - "description": "Describing the ARP neighbor entries seen on this link", - "properties": { - "ipAddress": { - "description": "The IP address of this ARP neighbor.", - "type": "string" - }, - "macAddress": { - "type": "string", - "description": "The MAC address of this ARP neighbor." - } - }, - "id": "InterconnectDiagnosticsARPEntry" - }, - "HttpHeaderAction": { - "type": "object", - "id": "HttpHeaderAction", - "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", - "properties": { - "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" - } + "flatPath": "projects/{project}/aggregated/serviceAttachments" }, - "requestHeadersToAdd": { - "description": "Headers to add to a matching request before forwarding the request to the backendService.", - "items": { - "$ref": "HttpHeaderOption" + "insert": { + "path": "projects/{project}/regions/{region}/serviceAttachments", + "parameterOrder": [ + "project", + "region" + ], + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "responseHeadersToRemove": { - "type": "array", - "items": { - "type": "string" + "flatPath": "projects/{project}/regions/{region}/serviceAttachments", + "request": { + "$ref": "ServiceAttachment" }, - "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client." - }, - "responseHeadersToAdd": { - "description": "Headers to add the response before sending the response back to the client.", - "items": { - "$ref": "HttpHeaderOption" + "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", + "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": { + "required": true, + "location": "path", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region of this request." + } }, - "type": "array" - } - } - }, - "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" - }, - "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" - } - }, - "type": "object", - "id": "DiskMoveRequest" - }, - "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.", - "id": "NetworkEndpointGroupCloudRun", - "type": "object", - "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": { - "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\".", - "type": "string" - }, - "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" - } - } - }, - "InstanceGroupList": { - "properties": { - "kind": { - "default": "compute#instanceGroupList", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists." - }, - "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" + "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." }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "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." + "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" }, - "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": { + "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": { - "description": "[Output Only] A human-readable description of the warning code.", + "serviceAttachment": { + "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 + }, + "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" } - } - }, - "items": { - "items": { - "$ref": "InstanceGroup" }, - "description": "A list of InstanceGroup resources.", - "type": "array" - } - }, - "type": "object", - "description": "A list of InstanceGroup resources.", - "id": "InstanceGroupList" - }, - "HelpLink": { - "id": "HelpLink", - "type": "object", - "properties": { - "url": { - "description": "The URL of the link.", - "type": "string" - }, - "description": { - "type": "string", - "description": "Describes what the link offers." - } - }, - "description": "Describes a URL link." - }, - "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.", - "properties": { - "status": { - "type": "string", - "enumDescriptions": [ - "Resources are being allocated for the reservation.", - "Reservation is currently being deleted.", - "", - "Reservation has allocated all its resources.", - "Reservation is currently being resized." + "description": "Deletes the specified ServiceAttachment in the given scope", + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "region", + "serviceAttachment" ], - "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY", - "UPDATING" + "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "description": "[Output Only] The status of the reservation." - }, - "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." - }, - "satisfiesPzs": { - "type": "boolean", - "description": "[Output Only] Reserved for future use." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", - "type": "string", - "default": "compute#reservation" - }, - "specificReservation": { - "$ref": "AllocationSpecificSKUReservation", - "description": "Reservation for instances with specific machine shapes." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined fully-qualified URL for this resource." + "id": "compute.serviceAttachments.delete" }, - "name": { - "annotations": { - "required": [ - "compute.instances.insert" - ] + "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." + }, + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "location": "path", + "type": "string", + "description": "The 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": "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.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "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." - }, - "zone": { - "type": "string", - "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment." - }, - "shareSettings": { - "description": "Share-settings for shared-reservation", - "$ref": "ShareSettings" - }, - "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" - } - }, - "id": "Reservation", - "type": "object" - }, - "FirewallPolicyList": { - "type": "object", - "id": "FirewallPolicyList", - "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#firewallPolicyList for listsof FirewallPolicies", - "type": "string", - "default": "compute#firewallPolicyList" - }, - "items": { - "type": "array", - "description": "A list of FirewallPolicy resources.", - "items": { - "$ref": "FirewallPolicy" - } + "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" + ], + "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." }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { + "patch": { + "response": { + "$ref": "Operation" + }, + "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": "[Output Only] A human-readable description of the warning code." + "description": "The region scoping this request and should conform to RFC1035.", + "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" - } - } - } + "serviceAttachment": { + "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 }, - "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." - ], + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" - } - } - }, - "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." + "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "request": { + "$ref": "ServiceAttachment" + }, + "parameterOrder": [ + "project", + "region", + "serviceAttachment" + ] }, - "items": { - "items": { - "$ref": "Disk" + "get": { + "parameterOrder": [ + "project", + "region", + "serviceAttachment" + ], + "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" + } }, - "type": "array", - "description": "A list of Disk resources." + "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" + ], + "response": { + "$ref": "ServiceAttachment" + }, + "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", + "id": "compute.serviceAttachments.get", + "httpMethod": "GET" }, - "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": { - "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" - } - } - } + "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}" }, - "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" - ], + "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, "type": "string" }, - "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])?))", + "type": "string", + "required": true + } + }, + "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" + }, + "list": { + "description": "Lists the ServiceAttachments for a project in the given scope.", + "response": { + "$ref": "ServiceAttachmentList" + }, + "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": "[Output Only] A human-readable description of the warning code." + "description": "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" } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "kind": { - "default": "compute#diskList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks." - }, - "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" - } - }, - "type": "object", - "description": "A list of Disk resources.", - "id": "DiskList" - }, - "ResourcePolicyResourceStatus": { - "type": "object", - "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.", - "properties": { - "instanceSchedulePolicy": { - "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.", - "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus" - } - }, - "id": "ResourcePolicyResourceStatus" - }, - "BfdPacket": { - "type": "object", - "properties": { - "multipoint": { - "description": "The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880", - "type": "boolean" - }, - "yourDiscriminator": { - "format": "uint32", - "type": "integer", - "description": "The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880" - }, - "controlPlaneIndependent": { - "description": "The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880", - "type": "boolean" - }, - "final": { - "description": "The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880", - "type": "boolean" - }, - "authenticationPresent": { - "description": "The Authentication Present 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" - }, - "demand": { - "description": "The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880", - "type": "boolean" - }, - "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" - }, - "state": { - "enum": [ - "ADMIN_DOWN", - "DOWN", - "INIT", - "STATE_UNSPECIFIED", - "UP" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ], - "type": "string", - "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880" - }, - "diagnostic": { - "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" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "parameterOrder": [ + "project", + "region" ] }, - "minTxIntervalMs": { - "type": "integer", - "format": "uint32", - "description": "The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880" - }, - "length": { - "type": "integer", - "format": "uint32", - "description": "The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880" - }, - "version": { - "format": "uint32", - "description": "The version number of the BFD protocol, as specified in section 4.1 of RFC5880.", - "type": "integer" - }, - "minEchoRxIntervalMs": { - "type": "integer", - "description": "The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880", - "format": "uint32" - }, - "myDiscriminator": { - "type": "integer", - "description": "The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880", - "format": "uint32" - }, - "multiplier": { - "type": "integer", - "format": "uint32", - "description": "The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880" - } - }, - "id": "BfdPacket" - }, - "GuestOsFeature": { - "properties": { - "type": { - "type": "string", - "enum": [ - "FEATURE_TYPE_UNSPECIFIED", - "GVNIC", - "MULTI_IP_SUBNET", - "SECURE_BOOT", - "SEV_CAPABLE", - "UEFI_COMPATIBLE", - "VIRTIO_SCSI_MULTIQUEUE", - "WINDOWS" + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" + "id": "compute.serviceAttachments.getIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" ], - "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." + "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 + } + } } - }, - "type": "object", - "id": "GuestOsFeature", - "description": "Guest OS features." + } }, - "BackendServicesScopedList": { - "id": "BackendServicesScopedList", - "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.", + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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, + "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])?))" }, - "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" + "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`)" }, - "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" + }, + "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" + }, + "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." + }, + "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": "Informational warning which replaces the list of backend services when the list is empty.", - "type": "object" + "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" }, - "backendServices": { - "items": { - "$ref": "BackendService" + "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." + } }, - "description": "A list of BackendServices contained in this scope.", - "type": "array" + "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": "object" + } }, - "HealthCheckService": { - "id": "HealthCheckService", - "type": "object", - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "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." - }, - "name": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." - }, - "kind": { - "description": "[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.", - "default": "compute#healthCheckService", - "type": "string" - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "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." - }, - "notificationEndpoints": { - "type": "array", - "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.", - "items": { - "type": "string" + "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", + "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" + }, + "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": { + "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" + } + }, + "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" } }, - "networkEndpointGroups": { - "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.", - "items": { - "type": "string" + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "response": { + "$ref": "Operation" + }, + "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 the PublicAdvertisedPrefix 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": { + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" + } } }, - "healthStatusAggregationPolicy": { - "type": "string", - "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. .", - "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." + "patch": { + "request": { + "$ref": "PublicAdvertisedPrefix" + }, + "httpMethod": "PATCH", + "response": { + "$ref": "Operation" + }, + "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 + } + }, + "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", + "id": "compute.publicAdvertisedPrefixes.patch", + "parameterOrder": [ + "project", + "publicAdvertisedPrefix" ], - "enum": [ - "AND", - "NO_AGGREGATION" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "healthChecks": { - "items": { - "type": "string" + "get": { + "parameterOrder": [ + "project", + "publicAdvertisedPrefix" + ], + "response": { + "$ref": "PublicAdvertisedPrefix" }, - "description": "A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. 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 NEGs.", - "type": "array" + "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" + ], + "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", + "id": "compute.publicAdvertisedPrefixes.get", + "description": "Returns the specified PublicAdvertisedPrefix resource.", + "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", + "httpMethod": "GET" }, - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" + "insert": { + "request": { + "$ref": "PublicAdvertisedPrefix" + }, + "path": "projects/{project}/global/publicAdvertisedPrefixes", + "id": "compute.publicAdvertisedPrefixes.insert", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project" + ], + "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" + } + }, + "httpMethod": "POST", + "response": { + "$ref": "Operation" + } } - }, - "description": "Represents a Health-Check as a Service resource." + } }, - "InstanceAggregatedList": { - "id": "InstanceAggregatedList", - "properties": { - "items": { - "type": "object", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of instances.", - "$ref": "InstancesScopedList" - }, - "description": "An object that contains a list of instances scoped by zone." - }, - "warning": { - "properties": { - "message": { + "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", - "description": "[Output Only] A human-readable description of the warning code." + "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": { - "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" + "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" }, - "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" - ], + "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", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.", - "default": "compute#instanceAggregatedList" - }, - "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" + "response": { + "$ref": "TargetInstanceAggregatedList" }, - "description": "[Output Only] Unreachable resources.", - "type": "array" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersListErrorsResponse": { - "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." + "description": "Retrieves an aggregated list of target instances.", + "path": "projects/{project}/aggregated/targetInstances" }, - "items": { - "type": "array", - "items": { - "$ref": "InstanceManagedByIgmError" + "get": { + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "id": "compute.targetInstances.get", + "response": { + "$ref": "TargetInstance" }, - "description": "[Output Only] The list of errors of the managed instance group." - } - }, - "type": "object", - "id": "RegionInstanceGroupManagersListErrorsResponse" - }, - "ResourcePolicySnapshotSchedulePolicySchedule": { - "id": "ResourcePolicySnapshotSchedulePolicySchedule", - "description": "A schedule for disks where the schedueled operations are performed.", - "type": "object", - "properties": { - "dailySchedule": { - "$ref": "ResourcePolicyDailyCycle" - }, - "weeklySchedule": { - "$ref": "ResourcePolicyWeeklyCycle" + "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" + } + }, + "parameterOrder": [ + "project", + "zone", + "targetInstance" + ], + "description": "Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.", + "httpMethod": "GET" }, - "hourlySchedule": { - "$ref": "ResourcePolicyHourlyCycle" - } - } - }, - "VpnTunnelList": { - "description": "Contains a list of VpnTunnel resources.", - "id": "VpnTunnelList", - "properties": { - "items": { - "items": { - "$ref": "VpnTunnel" + "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])?))", + "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)." + }, + "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" + } }, - "description": "A list of VpnTunnel resources.", - "type": "array" + "httpMethod": "DELETE", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "zone", + "targetInstance" + ], + "id": "compute.targetInstances.delete", + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "description": "Deletes the specified TargetInstance 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\" } ", - "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)." - } - } - } + "list": { + "parameterOrder": [ + "project", + "zone" + ], + "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" + ], + "response": { + "$ref": "TargetInstanceList" + }, + "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." }, - "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": { + "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" + }, + "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" }, - "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" - ] + "zone": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path", + "required": true, + "description": "Name of the zone scoping this request.", + "type": "string" } - } - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", - "default": "compute#vpnTunnelList" - }, - "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" - }, - "RegionSetLabelsRequest": { - "id": "RegionSetLabelsRequest", - "properties": { - "labelFingerprint": { - "type": "string", - "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" - }, - "labels": { - "additionalProperties": { - "type": "string" }, - "description": "The labels to set for this resource.", - "type": "object" - } - }, - "type": "object" - }, - "ShieldedInstanceIdentity": { - "properties": { - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.", - "default": "compute#shieldedInstanceIdentity" - }, - "encryptionKey": { - "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.", - "$ref": "ShieldedInstanceIdentityEntry" - }, - "signingKey": { - "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.", - "$ref": "ShieldedInstanceIdentityEntry" - } - }, - "type": "object", - "id": "ShieldedInstanceIdentity", - "description": "A Shielded Instance Identity." - }, - "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. ", - "id": "LicenseCode", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "type": "string", - "description": "[Output Only] Description of this License Code." - }, - "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." + "flatPath": "projects/{project}/zones/{zone}/targetInstances" }, - "licenseAlias": { - "items": { - "$ref": "LicenseCodeLicenseAlias" + "insert": { + "response": { + "$ref": "Operation" }, - "type": "array", - "description": "[Output Only] URL and description aliases of Licenses with the same License Code." - }, - "state": { - "enum": [ - "DISABLED", - "ENABLED", - "RESTRICTED", - "STATE_UNSPECIFIED", - "TERMINATED" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "description": "[Output Only] Current state of this License Code.", - "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." + "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 + } + }, + "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/zones/{zone}/targetInstances", + "parameterOrder": [ + "project", + "zone" ], - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for 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" - }, - "name": { - "pattern": "[0-9]{0,20}?", - "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" - ] + "request": { + "$ref": "TargetInstance" } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.", - "default": "compute#licenseCode", - "type": "string" - } - }, - "type": "object" - }, - "AliasIpRange": { - "type": "object", - "properties": { - "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" - }, - "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" } - }, - "description": "An alias IP range attached to an instance's network interface.", - "id": "AliasIpRange" + } }, - "Route": { - "id": "Route", - "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.", - "properties": { - "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" - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "destRange": { - "type": "string", - "annotations": { - "required": [ - "compute.routes.insert" - ] - }, - "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported." - }, - "warnings": { - "items": { - "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" - } - }, - "message": { - "type": "string", - "description": "[Output Only] A human-readable description of the warning code." - }, - "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" - ] - } + "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." }, - "type": "object" + "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." + }, + "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": { + "location": "path", + "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", + "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" + } }, - "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.", - "type": "array" - }, - "network": { - "description": "Fully-qualified URL of the network that this route applies to.", - "type": "string", - "annotations": { - "required": [ - "compute.routes.insert" - ] + "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 network endpoint groups available to the specified project in the given region.", + "id": "compute.regionNetworkEndpointGroups.list", + "httpMethod": "GET", + "parameterOrder": [ + "project", + "region" + ], + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", + "path": "projects/{project}/regions/{region}/networkEndpointGroups", + "response": { + "$ref": "NetworkEndpointGroupList" } }, - "kind": { - "type": "string", - "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.", - "default": "compute#route" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "nextHopNetwork": { - "type": "string", - "description": "The URL of the local network if it should handle matching packets." - }, - "priority": { - "annotations": { - "required": [ - "compute.routes.insert" - ] + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" }, - "format": "uint32", - "type": "integer", - "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." - }, - "nextHopPeering": { - "type": "string", - "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035." - }, - "routeStatus": { - "type": "string", - "description": "[Output only] The status of the route.", - "enum": [ - "ACTIVE", - "DROPPED", - "INACTIVE", - "PENDING" + "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" ], - "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." - ] - }, - "nextHopVpnTunnel": { - "type": "string", - "description": "The URL to a VpnTunnel that should handle matching packets." - }, - "nextHopInstance": { - "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/", - "type": "string" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined fully-qualified URL for this resource." + "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" + ] }, - "tags": { - "description": "A list of instance tags to which this route applies.", - "annotations": { - "required": [ - "compute.routes.insert" - ] + "insert": { + "response": { + "$ref": "Operation" }, - "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" + ], + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", + "request": { + "$ref": "NetworkEndpointGroup" }, - "type": "array" + "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." + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups", + "parameterOrder": [ + "project", + "region" + ] }, - "routeType": { - "enumDescriptions": [ - "", - "", - "", - "" + "get": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enum": [ - "BGP", - "STATIC", - "SUBNET", - "TRANSIT" + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" ], - "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" - }, - "name": { - "annotations": { - "required": [ - "compute.routes.insert" - ] + "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" + } }, - "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." - }, - "asPaths": { - "items": { - "$ref": "RouteAsPath" + "response": { + "$ref": "NetworkEndpointGroup" }, - "type": "array", - "description": "[Output Only] AS path." - }, - "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 " - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this field when you create the resource." - }, - "nextHopIp": { - "description": "The network IP address of an instance that should handle matching packets. Only IPv4 is supported.", - "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}" } } }, - "ProjectsDisableXpnResourceRequest": { - "properties": { - "xpnResource": { - "$ref": "XpnResourceId", - "description": "Service resource (a.k.a service project) ID." - } - }, - "id": "ProjectsDisableXpnResourceRequest", - "type": "object" - }, - "TargetSslProxyList": { - "type": "object", - "description": "Contains a list of TargetSslProxy 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." - }, - "items": { - "type": "array", - "items": { - "$ref": "TargetSslProxy" + "forwardingRules": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of forwarding rules.", + "response": { + "$ref": "ForwardingRuleAggregatedList" + }, + "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" + } }, - "description": "A list of TargetSslProxy resources." + "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" }, - "kind": { - "default": "compute#targetSslProxyList", - "description": "Type of resource.", - "type": "string" + "list": { + "parameterOrder": [ + "project", + "region" + ], + "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" + ], + "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" }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." + "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" + }, + "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])?))" + }, + "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 + }, + "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])?" + } + }, + "parameterOrder": [ + "project", + "region", + "forwardingRule" + ], + "response": { + "$ref": "Operation" + }, + "httpMethod": "PATCH", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}" }, - "warning": { - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "insert": { + "path": "projects/{project}/regions/{region}/forwardingRules", + "request": { + "$ref": "ForwardingRule" + }, + "httpMethod": "POST", + "id": "compute.forwardingRules.insert", + "parameterOrder": [ + "project", + "region" + ], + "response": { + "$ref": "Operation" + }, + "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" }, - "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": { "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 scoping this request.", + "required": true, + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + } + }, + "flatPath": "projects/{project}/regions/{region}/forwardingRules", + "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request." + }, + "get": { + "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." }, - "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" + "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" + }, + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" + } + }, + "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" + ], + "response": { + "$ref": "ForwardingRule" + }, + "parameterOrder": [ + "project", + "region", + "forwardingRule" + ], + "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", + "description": "Returns the specified ForwardingRule resource.", + "path": "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.", + "request": { + "$ref": "TargetReference" + }, + "parameterOrder": [ + "project", + "region", + "forwardingRule" + ], + "httpMethod": "POST", + "id": "compute.forwardingRules.setTarget", + "response": { + "$ref": "Operation" + }, + "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": "[Output Only] Informational warning message." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - } - }, - "id": "TargetSslProxyList" - }, - "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.", - "properties": { - "kind": { - "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.", - "default": "compute#notificationEndpoint", - "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])?" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "grpcSettings": { - "$ref": "NotificationEndpointGrpcSettings", - "description": "Settings of the gRPC notification endpoint including the endpoint URL and the retry duration." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "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" + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget" }, - "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": "NotificationEndpoint", - "type": "object" - }, - "TargetHttpsProxyAggregatedList": { - "properties": { - "warning": { - "properties": { - "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\" } " + "delete": { + "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "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])?))" }, - "message": { + "region": { + "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.", + "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." - ], + "forwardingRule": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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": "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" } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.", - "type": "string", - "default": "compute#targetHttpsProxyAggregatedList" + "description": "Deletes the specified ForwardingRule resource.", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}" }, - "items": { - "description": "A list of TargetHttpsProxiesScopedList resources.", - "additionalProperties": { - "description": "Name of the scope containing this set of TargetHttpsProxies.", - "$ref": "TargetHttpsProxiesScopedList" + "setLabels": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "region", + "resource" + ], + "response": { + "$ref": "Operation" }, - "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." - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "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" - } - }, - "id": "TargetHttpsProxyAggregatedList", - "type": "object" - }, - "InstanceGroupManagersDeleteInstancesRequest": { - "id": "InstanceGroupManagersDeleteInstancesRequest", - "type": "object", - "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" + "request": { + "$ref": "RegionSetLabelsRequest" }, - "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" - } - } - }, - "SslPoliciesListAvailableFeaturesResponse": { - "id": "SslPoliciesListAvailableFeaturesResponse", - "type": "object", - "properties": { - "features": { - "items": { - "type": "string" + "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": "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" + }, + "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." + } }, - "type": "array" + "id": "compute.forwardingRules.setLabels", + "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels" } } }, - "RouterAdvertisedIpRange": { - "description": "Description-tagged IP ranges for the router to advertise.", - "type": "object", - "properties": { - "range": { - "type": "string", - "description": "The IP range to advertise. The value must be a CIDR-formatted string." - }, - "description": { - "description": "User-specified description for the IP range.", - "type": "string" - } - }, - "id": "RouterAdvertisedIpRange" - }, - "GlobalSetPolicyRequest": { - "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" - }, - "etag": { - "type": "string", - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "format": "byte" - }, - "bindings": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "items": { - "$ref": "Binding" - }, - "type": "array" - } - }, - "type": "object", - "id": "GlobalSetPolicyRequest" - }, - "AddressesScopedList": { - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "regionTargetTcpProxies": { + "methods": { + "list": { + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", + "path": "projects/{project}/regions/{region}/targetTcpProxies", + "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 + }, + "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" + }, + "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": { - "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": { + "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." }, - "code": { + "filter": { "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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" + }, + "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" } }, - "type": "object" - }, - "addresses": { - "description": "[Output Only] A list of addresses contained in this scope.", - "items": { - "$ref": "Address" + "response": { + "$ref": "TargetTcpProxyList" }, - "type": "array" - } - }, - "id": "AddressesScopedList", - "type": "object" - }, - "ResourceGroupReference": { - "properties": { - "group": { - "type": "string", - "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service." - } - }, - "type": "object", - "id": "ResourceGroupReference" - }, - "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.", - "id": "BackendBucketCdnPolicyBypassCacheOnRequestHeader", - "type": "object", - "properties": { - "headerName": { - "type": "string", - "description": "The header field name to match on when bypassing cache. Values are case-insensitive." - } - } - }, - "RegionSetPolicyRequest": { - "type": "object", - "id": "RegionSetPolicyRequest", - "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": { - "format": "byte", - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "type": "string" - }, - "bindings": { - "type": "array", - "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "items": { - "$ref": "Binding" - } - } - } - }, - "InterconnectDiagnosticsLinkOpticalPower": { - "properties": { - "value": { - "type": "number", - "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.", - "format": "float" + "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" + ], + "parameterOrder": [ + "project", + "region" + ], + "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", + "httpMethod": "GET" }, - "state": { - "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. ", - "enum": [ - "HIGH_ALARM", - "HIGH_WARNING", - "LOW_ALARM", - "LOW_WARNING", - "OK" + "insert": { + "httpMethod": "POST", + "parameterOrder": [ + "project", + "region" ], - "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": "compute.regionTargetTcpProxies.insert", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string" - } - }, - "id": "InterconnectDiagnosticsLinkOpticalPower", - "type": "object" - }, - "DiskTypesScopedList": { - "id": "DiskTypesScopedList", - "properties": { - "diskTypes": { - "description": "[Output Only] A list of disk types contained in this scope.", - "items": { - "$ref": "DiskType" + "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." + } }, - "type": "array" + "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" + }, + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies" }, - "warning": { - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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": { + "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" }, - "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.", + "targetTcpProxy": { + "location": "path", + "required": true, + "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": "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" } }, - "type": "object", - "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty." - } - }, - "type": "object" - }, - "VmEndpointNatMappingsList": { - "id": "VmEndpointNatMappingsList", - "type": "object", - "description": "Contains a list of VmEndpointNatMappings.", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "kind": { - "default": "compute#vmEndpointNatMappingsList", - "type": "string", - "description": "[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints." - }, - "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." + "httpMethod": "DELETE", + "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "response": { + "$ref": "Operation" + }, + "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" + ] }, - "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.", - "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" - ] + "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" }, - "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" + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" }, - "message": { + "targetTcpProxy": { "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "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 } }, - "type": "object", - "description": "[Output Only] Informational warning message." - }, - "result": { - "items": { - "$ref": "VmEndpointNatMappings" + "parameterOrder": [ + "project", + "region", + "targetTcpProxy" + ], + "response": { + "$ref": "TargetTcpProxy" }, - "type": "array", - "description": "[Output Only] A list of Nat mapping information of VM endpoints." + "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" } } }, - "Policy": { - "properties": { - "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)." - }, - "rules": { - "type": "array", - "description": "This is deprecated and has no effect. Do not use.", - "items": { - "$ref": "Rule" - } - }, - "auditConfigs": { - "items": { - "$ref": "AuditConfig" + "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." + } }, - "type": "array", - "description": "Specifies cloud audit logging configuration for this policy." - }, - "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" - }, - "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" + "parameterOrder": [ + "project", + "zone", + "acceleratorType" + ], + "httpMethod": "GET", + "response": { + "$ref": "AcceleratorType" }, - "type": "array" - } - }, - "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" - }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", - "type": "object", - "properties": { - "firewallPolicys": { - "description": "Effective firewalls from firewall policy.", - "type": "array", - "items": { - "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - } + "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}" }, - "firewalls": { - "items": { - "$ref": "Firewall" + "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])?))" + } }, - "type": "array", - "description": "Effective firewalls on the network." - } - } - }, - "ManagedInstanceInstanceHealth": { - "type": "object", - "id": "ManagedInstanceInstanceHealth", - "properties": { - "healthCheck": { - "type": "string", - "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy." + "path": "projects/{project}/zones/{zone}/acceleratorTypes", + "description": "Retrieves a list of accelerator types that are available to the specified project.", + "response": { + "$ref": "AcceleratorTypeList" + }, + "id": "compute.acceleratorTypes.list" }, - "detailedHealthState": { - "description": "[Output Only] The current detailed instance health state.", - "enum": [ - "DRAINING", - "HEALTHY", - "TIMEOUT", - "UNHEALTHY", - "UNKNOWN" - ], - "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." + "aggregatedList": { + "httpMethod": "GET", + "parameterOrder": [ + "project" ], - "type": "string" + "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" + ], + "id": "compute.acceleratorTypes.aggregatedList", + "response": { + "$ref": "AcceleratorTypeAggregatedList" + }, + "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": "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" + }, + "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" + } + } } } }, - "LicensesListResponse": { - "properties": { - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "warning": { - "description": "[Output Only] Informational warning message.", - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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": { + "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": { - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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.", + "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" } - } - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - }, - "items": { - "description": "A list of License resources.", - "items": { - "$ref": "License" }, - "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." - } - }, - "type": "object", - "id": "LicensesListResponse" - }, - "SchedulingNodeAffinity": { - "properties": { - "operator": { - "enumDescriptions": [ - "Requires Compute Engine to seek for matched nodes.", - "Requires Compute Engine to avoid certain nodes.", - "" + "httpMethod": "GET", + "parameterOrder": [ + "project" ], - "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.", - "type": "string", - "enum": [ - "IN", - "NOT_IN", - "OPERATOR_UNSPECIFIED" + "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" ] }, - "values": { - "type": "array", - "description": "Corresponds to the label values of Node resource.", - "items": { - "type": "string" - } - }, - "key": { - "description": "Corresponds to the label key of Node resource.", - "type": "string" - } - }, - "type": "object", - "id": "SchedulingNodeAffinity", - "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled." - }, - "RegionInstanceGroupManagersSetTemplateRequest": { - "id": "RegionInstanceGroupManagersSetTemplateRequest", - "properties": { - "instanceTemplate": { - "description": "URL of the InstanceTemplate resource from which all new instances will be created.", - "type": "string" - } - }, - "type": "object" - }, - "NodeGroupsListNodes": { - "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#nodeGroupsListNodes", - "description": "[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.", - "type": "string" - }, - "items": { - "type": "array", - "items": { - "$ref": "NodeGroupNode" - }, - "description": "A list of Node resources." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "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\" } " + "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 }, - "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" + "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.", + "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" } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - }, - "type": "object", - "id": "NodeGroupsListNodes" - }, - "CustomerEncryptionKey": { - "type": "object", - "properties": { - "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": { - "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=\" " - }, - "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" - }, - "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" - }, - "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 " - } - }, - "id": "CustomerEncryptionKey" - }, - "HttpHeaderMatch": { - "type": "object", - "properties": { - "presentMatch": { - "type": "boolean", - "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." - }, - "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. regexMatch only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED." - }, - "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`." - }, - "rangeMatch": { - "$ref": "Int64RangeMatch", - "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." - }, - "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" - }, - "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." - }, - "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" - } - }, - "id": "HttpHeaderMatch", - "description": "matchRule criteria for request header matches." - }, - "AddressAggregatedList": { - "properties": { - "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": { - "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." - ], + "response": { + "$ref": "Operation" + }, + "id": "compute.firewalls.patch", + "parameterOrder": [ + "project", + "firewall" + ], + "flatPath": "projects/{project}/global/firewalls/{firewall}", + "request": { + "$ref": "Firewall" + } + }, + "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" }, - "message": { + "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 human-readable description of the warning code." - }, - "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\" } " + "required": true } - } - }, - "kind": { - "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.", - "default": "compute#addressAggregatedList", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "items": { - "type": "object", - "description": "A list of AddressesScopedList resources.", - "additionalProperties": { - "$ref": "AddressesScopedList", - "description": "[Output Only] Name of the scope containing this set of addresses." - } - }, - "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.", - "items": { - "type": "string" }, - "type": "array" - } - }, - "id": "AddressAggregatedList", - "type": "object" - }, - "Interconnect": { - "type": "object", - "id": "Interconnect", - "properties": { - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "adminEnabled": { - "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.", - "type": "boolean" - }, - "operationalStatus": { - "type": "string", - "enum": [ - "OS_ACTIVE", - "OS_UNPROVISIONED" + "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" ], - "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. ", - "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." + "path": "projects/{project}/global/firewalls", + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "Firewall" + }, + "parameterOrder": [ + "project" ] }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - }, - "name": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "annotations": { - "required": [ - "compute.interconnects.insert" - ] + "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" + } }, - "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": "compute.firewalls.get", + "response": { + "$ref": "Firewall" + }, + "flatPath": "projects/{project}/global/firewalls/{firewall}", + "parameterOrder": [ + "project", + "firewall" + ], + "path": "projects/{project}/global/firewalls/{firewall}", + "description": "Returns the specified firewall." }, - "linkType": { - "type": "string", - "enum": [ - "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR" + "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}" + } + }, + "flatPath": "projects/{project}/global/firewalls/{firewall}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enumDescriptions": [ - "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "path": "projects/{project}/global/firewalls/{firewall}", + "description": "Deletes the specified firewall.", + "parameterOrder": [ + "project", + "firewall" ], - "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." - }, - "customerName": { - "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", - "type": "string" - }, - "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." - }, - "provisionedLinkCount": { - "description": "[Output Only] Number of links actually provisioned in this interconnect.", - "format": "int32", - "type": "integer" - }, - "requestedLinkCount": { - "type": "integer", - "description": "Target number of physical links in the link bundle, as requested by the customer.", - "format": "int32" - }, - "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" - }, - "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" + "httpMethod": "DELETE" }, - "interconnectType": { - "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.", - "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." + "update": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enum": [ - "DEDICATED", - "IT_PRIVATE", - "PARTNER" - ] - }, - "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." - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for the resource." - }, - "circuitInfos": { - "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", - "items": { - "$ref": "InterconnectCircuitInfo" + "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)." + } }, - "type": "array" - }, - "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." - }, - "kind": { - "type": "string", - "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects.", - "default": "compute#interconnect" - }, - "location": { - "type": "string", - "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned." - }, - "state": { - "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" + "parameterOrder": [ + "project", + "firewall" ], - "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." + "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." + } + } + }, + "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" ], - "type": "string" - }, - "expectedOutages": { - "items": { - "$ref": "InterconnectOutageNotification" + "description": "Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.", + "response": { + "$ref": "SslCertificate" }, - "type": "array", - "description": "[Output Only] A list of outages expected for this Interconnect." + "id": "compute.sslCertificates.get", + "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", + "httpMethod": "GET", + "parameterOrder": [ + "project", + "sslCertificate" + ] }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." + "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", + "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": { + "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" + }, + "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 + } + }, + "response": { + "$ref": "SslCertificateAggregatedList" + }, + "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/sslCertificates", + "httpMethod": "GET" }, - "interconnectAttachments": { - "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.", - "items": { - "type": "string" + "delete": { + "response": { + "$ref": "Operation" }, - "type": "array" - } - }, - "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." - }, - "TargetVpnGatewaysScopedList": { - "properties": { - "warning": { - "description": "[Output Only] Informational warning which replaces the list of addresses 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" - ], + "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", + "httpMethod": "DELETE", + "parameterOrder": [ + "project", + "sslCertificate" + ], + "description": "Deletes the specified SslCertificate resource.", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.sslCertificates.delete", + "parameters": { + "project": { + "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." - ], - "description": "[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 }, - "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\" } " + "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" }, - "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" } - } - }, - "targetVpnGateways": { - "items": { - "$ref": "TargetVpnGateway" }, - "type": "array", - "description": "[Output Only] A list of target VPN gateways contained in this scope." - } - }, - "type": "object", - "id": "TargetVpnGatewaysScopedList" - }, - "SecurityPolicyRuleMatcher": { - "type": "object", - "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", - "properties": { - "versionedExpr": { - "enum": [ - "SRC_IPS_V1" + "path": "projects/{project}/global/sslCertificates/{sslCertificate}" + }, + "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" ], - "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." + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string" - }, - "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." - } - }, - "id": "SecurityPolicyRuleMatcher" - }, - "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy": { - "id": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy", - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation." + "flatPath": "projects/{project}/global/sslCertificates" }, - "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." - }, - "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "properties": { - "rules": { - "items": { - "$ref": "FirewallPolicyRule" + "list": { + "id": "compute.sslCertificates.list", + "response": { + "$ref": "SslCertificateList" }, - "description": "The rules that apply to the network.", - "type": "array" - }, - "type": { - "enum": [ - "HIERARCHY", - "NETWORK", - "UNSPECIFIED" + "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" + } + }, + "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}/global/sslCertificates", + "httpMethod": "GET", + "flatPath": "projects/{project}/global/sslCertificates", + "parameterOrder": [ + "project" ], - "description": "[Output Only] The type of the firewall policy.", - "type": "string" - }, - "shortName": { - "description": "[Output Only] The short name of the firewall policy.", - "type": "string" - }, - "displayName": { - "type": "string", - "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy." - }, - "name": { - "type": "string", - "description": "[Output Only] The name of the firewall policy." + "description": "Retrieves the list of SslCertificate resources available to the specified project." } - }, - "type": "object", - "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + } }, - "LogConfigCloudAuditOptions": { - "type": "object", - "id": "LogConfigCloudAuditOptions", - "description": "This is deprecated and has no effect. Do not use.", - "properties": { - "logName": { - "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." + "routers": { + "methods": { + "getNatMappingInfo": { + "response": { + "$ref": "VmEndpointNatMappingsList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "enum": [ - "ADMIN_ACTIVITY", - "DATA_ACCESS", - "UNSPECIFIED_LOG_NAME" + "parameterOrder": [ + "project", + "region", + "router" ], - "description": "This is deprecated and has no effect. Do not use." + "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" + } + } }, - "authorizationLoggingOptions": { - "description": "This is deprecated and has no effect. Do not use.", - "$ref": "AuthorizationLoggingOptions" - } - } - }, - "Snapshot": { - "type": "object", - "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", - "properties": { - "architecture": { - "type": "string", - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "get": { + "response": { + "$ref": "Router" + }, + "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" ], - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" + "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" + } + }, + "parameterOrder": [ + "project", + "region", + "router" ], - "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64." - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "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" - }, - "sourceSnapshotSchedulePolicy": { - "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", - "type": "string" - }, - "labelFingerprint": { - "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.", - "type": "string", - "format": "byte" - }, - "sourceDisk": { - "type": "string", - "description": "The source disk used to create this snapshot." - }, - "diskSizeGb": { - "type": "string", - "format": "int64", - "description": "[Output Only] Size of the source disk, specified in GB." + "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." }, - "status": { - "enum": [ - "CREATING", - "DELETING", - "FAILED", - "READY", - "UPLOADING" + "list": { + "httpMethod": "GET", + "id": "compute.routers.list", + "response": { + "$ref": "RouterList" + }, + "parameterOrder": [ + "project", + "region" ], - "type": "string", - "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", - "enumDescriptions": [ - "Snapshot creation is in progress.", - "Snapshot is currently being deleted.", - "Snapshot creation failed.", - "Snapshot has been created successfully.", - "Snapshot is being uploaded." - ] - }, - "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." - }, - "licenses": { - "items": { - "type": "string" + "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" + }, + "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", + "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 + } }, - "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" - }, - "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." + "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" }, - "id": { - "format": "uint64", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" + "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" + }, + "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" + } + }, + "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": { + "$ref": "Operation" + }, + "flatPath": "projects/{project}/regions/{region}/routers", + "parameterOrder": [ + "project", + "region" + ], + "path": "projects/{project}/regions/{region}/routers" }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." + "delete": { + "parameterOrder": [ + "project", + "region", + "router" + ], + "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" + ], + "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 + } + }, + "flatPath": "projects/{project}/regions/{region}/routers/{router}", + "response": { + "$ref": "Operation" + } }, - "snapshotType": { - "type": "string", - "enumDescriptions": [ - "", - "" + "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" ], - "enum": [ - "ARCHIVE", - "STANDARD" + "parameterOrder": [ + "project" ], - "description": "Indicates the type of the snapshot." - }, - "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.", - "annotations": { - "required": [ - "compute.snapshots.insert" - ] - } - }, - "kind": { - "type": "string", - "default": "compute#snapshot", - "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources." - }, - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "licenseCodes": { - "type": "array", - "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", - "items": { - "type": "string", - "format": "int64" + "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" } }, - "storageLocations": { - "type": "array", - "items": { - "type": "string" + "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" }, - "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional)." - }, - "locationHint": { - "type": "string", - "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." - }, - "creationSizeBytes": { - "type": "string", - "format": "int64", - "description": "[Output Only] Size in bytes of the snapshot at creation time." - }, - "downloadBytes": { - "format": "int64", - "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", - "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." - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "sourceSnapshotSchedulePolicyId": { - "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", - "type": "string" - }, - "storageBytes": { - "format": "int64", - "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.", - "type": "string" - }, - "storageBytesStatus": { - "enum": [ - "UPDATING", - "UP_TO_DATE" + "request": { + "$ref": "Router" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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": [ - "", - "" - ] - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "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" + } }, - "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty." + "flatPath": "projects/{project}/regions/{region}/routers/{router}", + "parameterOrder": [ + "project", + "region", + "router" + ], + "path": "projects/{project}/regions/{region}/routers/{router}" }, - "autoCreated": { - "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", - "type": "boolean" - } - } - }, - "TargetInstancesScopedList": { - "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": { - "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" - } - } - } + "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 }, - "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", + "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": { + "region": { + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "location": "path", + "description": "Name of the region for this request." } }, - "description": "Informational warning which replaces the list of addresses when the list is empty.", - "type": "object" + "id": "compute.routers.getRouterStatus", + "parameterOrder": [ + "project", + "region", + "router" + ] }, - "targetInstances": { - "items": { - "$ref": "TargetInstance" + "patch": { + "request": { + "$ref": "Router" }, - "type": "array", - "description": "A list of target instances contained in this scope." - } - }, - "id": "TargetInstancesScopedList" - }, - "ShieldedInstanceConfig": { - "type": "object", - "description": "A set of Shielded Instance options.", - "properties": { - "enableSecureBoot": { - "type": "boolean", - "description": "Defines whether the instance has Secure Boot enabled. Disabled by default." - }, - "enableIntegrityMonitoring": { - "type": "boolean", - "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default." - }, - "enableVtpm": { - "type": "boolean", - "description": "Defines whether the instance has the vTPM enabled. Enabled by default." - } - }, - "id": "ShieldedInstanceConfig" - }, - "NodeTemplate": { - "id": "NodeTemplate", - "properties": { - "description": { - "type": "string", - "description": "An optional description of this resource. Provide this property when you create the resource." - }, - "disks": { - "items": { - "$ref": "LocalDisk" + "path": "projects/{project}/regions/{region}/routers/{router}", + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "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." - }, - "accelerators": { - "items": { - "$ref": "AcceleratorConfig" + "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", + "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, + "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": { + "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." + } }, - "type": "array" - }, - "nodeType": { - "type": "string", - "description": "The node type to use for nodes group that are created from this template." - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "region": { - "description": "[Output Only] The name of the region where the node template resides, such as us-central1.", - "type": "string" + "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" + ] }, - "status": { - "type": "string", - "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY" + "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" ], - "enumDescriptions": [ - "Resources are being allocated.", - "The node template is currently being deleted.", - "Invalid status.", - "The node template is ready." + "httpMethod": "POST", + "path": "projects/{project}/regions/{region}/routers/{router}/preview", + "response": { + "$ref": "RoutersPreviewResponse" + }, + "parameterOrder": [ + "project", + "region", + "router" ], - "description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING." - }, - "nodeAffinityLabels": { - "additionalProperties": { - "type": "string" + "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" + } + } + } + } + }, + "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" + } }, - "type": "object", - "description": "Labels to use for node affinity, which will be used in instance scheduling." - }, - "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" - }, - "statusMessage": { - "type": "string", - "description": "[Output Only] An optional, human-readable explanation of the status." - }, - "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" - }, - "kind": { - "description": "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.", - "default": "compute#nodeTemplate", - "type": "string" + "response": { + "$ref": "NetworkEndpointGroupsListNetworkEndpoints" + }, + "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" }, - "cpuOvercommitType": { - "enum": [ - "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", - "ENABLED", - "NONE" + "list": { + "parameterOrder": [ + "project" ], - "type": "string", - "enumDescriptions": [ - "", - "", - "" + "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])?))" + } + }, + "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" ], - "description": "CPU overcommit." - } - }, - "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" - }, - "InterconnectOutageNotification": { - "id": "InterconnectOutageNotification", - "description": "Description of a planned outage on this Interconnect.", - "type": "object", - "properties": { - "affectedCircuits": { - "type": "array", - "items": { - "type": "string" + "id": "compute.globalNetworkEndpointGroups.list", + "response": { + "$ref": "NetworkEndpointGroupList" }, - "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected." - }, - "description": { - "type": "string", - "description": "A description about the purpose of the outage." - }, - "endTime": { - "format": "int64", - "type": "string", - "description": "Scheduled end time for the outage (milliseconds since Unix epoch)." + "httpMethod": "GET" }, - "state": { - "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." + "detachNetworkEndpoints": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "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" + "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" ], - "type": "string" - }, - "startTime": { - "description": "Scheduled start time for the outage (milliseconds since Unix epoch).", - "type": "string", - "format": "int64" + "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 + } + } }, - "source": { - "enum": [ - "GOOGLE", - "NSRC_GOOGLE" - ], - "enumDescriptions": [ - "This notification was generated by Google.", - "[Deprecated] This notification was generated by Google." + "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" ], - "type": "string", - "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." - }, - "issueType": { - "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." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "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.", - "enum": [ - "IT_OUTAGE", - "IT_PARTIAL_OUTAGE", - "OUTAGE", - "PARTIAL_OUTAGE" - ] - }, - "name": { - "type": "string", - "description": "Unique identifier for this outage notification." - } - } - }, - "RouterNatRule": { - "type": "object", - "properties": { - "match": { - "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'\"", - "type": "string" - }, - "description": { - "description": "An optional description of this rule.", - "type": "string" - }, - "ruleNumber": { - "format": "uint32", - "type": "integer", - "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." + "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." }, - "action": { - "$ref": "RouterNatRuleAction", - "description": "The action to be enforced for traffic that matches this rule." - } - }, - "id": "RouterNatRule" - }, - "NodeGroupsDeleteNodesRequest": { - "id": "NodeGroupsDeleteNodesRequest", - "type": "object", - "properties": { - "nodes": { - "description": "Names of the nodes to delete.", - "items": { - "type": "string" + "insert": { + "httpMethod": "POST", + "response": { + "$ref": "Operation" }, - "type": "array" - } - } - }, - "HealthCheckServicesList": { - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "HealthCheckService" + "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" + } }, - "description": "A list of HealthCheckService resources." + "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" + ], + "parameterOrder": [ + "project" + ] }, - "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": { - "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" + "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." }, - "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" }, - "message": { + "networkEndpointGroup": { + "location": "path", "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", + "required": true } - } - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.", - "type": "string", - "default": "compute#healthCheckServicesList" - }, - "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" - } - }, - "type": "object", - "id": "HealthCheckServicesList" - }, - "ForwardingRuleServiceDirectoryRegistration": { - "id": "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": { - "serviceDirectoryRegion": { - "type": "string", - "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." - }, - "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." - } - }, - "type": "object" - }, - "ExternalVpnGateway": { - "id": "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.", - "properties": { - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "kind": { - "description": "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.", - "type": "string", - "default": "compute#externalVpnGateway" - }, - "name": { - "annotations": { - "required": [ - "compute.externalVpnGateways.insert" - ] }, - "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." + "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" }, - "redundancyType": { - "description": "Indicates the user-supplied redundancy type of this external VPN gateway.", - "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." + "get": { + "id": "compute.globalNetworkEndpointGroups.get", + "parameterOrder": [ + "project", + "networkEndpointGroup" + ], + "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" ], - "type": "string", - "enum": [ - "FOUR_IPS_REDUNDANCY", - "SINGLE_IP_INTERNALLY_REDUNDANT", - "TWO_IPS_REDUNDANCY" - ] - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "response": { + "$ref": "NetworkEndpointGroup" }, - "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." - }, - "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.", - "type": "string", - "format": "uint64" - }, - "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" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "interfaces": { - "type": "array", - "items": { - "$ref": "ExternalVpnGatewayInterface" + "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 + } }, - "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." + "httpMethod": "GET", + "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}" } - }, - "type": "object" + } }, - "FirewallPolicyRuleSecureTag": { - "id": "FirewallPolicyRuleSecureTag", - "properties": { - "state": { - "enum": [ - "EFFECTIVE", - "INEFFECTIVE" + "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" ], - "enumDescriptions": [ - "", - "" + "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "project", + "zone", + "nodeGroup" ], - "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": "string" - }, - "name": { - "type": "string", - "pattern": "tagValues/[0-9]+", - "description": "Name of the secure tag, created with TagManager's TagValue API." - } - }, - "type": "object" - }, - "NodeGroup": { - "properties": { - "zone": { - "description": "[Output Only] The name of the zone where the node group resides, such as us-central1-a.", - "type": "string" - }, - "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" - }, - "fingerprint": { - "type": "string", - "format": "byte" - }, - "creationTimestamp": { - "type": "string", - "description": "[Output Only] Creation timestamp in RFC3339 text format." - }, - "kind": { - "description": "[Output Only] The type of the resource. Always compute#nodeGroup for node group.", - "type": "string", - "default": "compute#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}" }, - "status": { - "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY" + "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])?))", + "type": "string", + "location": "path", + "required": true, + "description": "Project ID for this request." + }, + "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 + }, + "initialNodeCount": { + "location": "query", + "format": "int32", + "type": "integer", + "description": "Initial count of nodes in the node group.", + "required": true + } + }, + "path": "projects/{project}/zones/{zone}/nodeGroups", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "enumDescriptions": [ - "", - "", - "", - "" + "parameterOrder": [ + "project", + "zone", + "initialNodeCount" ], - "type": "string" - }, - "maintenanceWindow": { - "$ref": "NodeGroupMaintenanceWindow" + "response": { + "$ref": "Operation" + }, + "flatPath": "projects/{project}/zones/{zone}/nodeGroups" }, - "maintenancePolicy": { - "type": "string", - "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." + "listNodes": { + "response": { + "$ref": "NodeGroupsListNodes" + }, + "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}" + } + }, + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", + "parameterOrder": [ + "project", + "zone", + "nodeGroup" ], - "enum": [ - "DEFAULT", - "MAINTENANCE_POLICY_UNSPECIFIED", - "MIGRATE_WITHIN_NODE_GROUP", - "RESTART_IN_PLACE" + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "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." - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "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" + "description": "Lists nodes in the node group." }, - "size": { - "description": "[Output Only] The total number of nodes in the node group.", - "format": "int32", - "type": "integer" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "id": { - "format": "uint64", - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." - }, - "autoscalingPolicy": { - "$ref": "NodeGroupAutoscalingPolicy", - "description": "Specifies how autoscaling should behave." - }, - "shareSettings": { - "description": "Share-settings for the node group", - "$ref": "ShareSettings" - }, - "nodeTemplate": { - "description": "URL of the node template to create the node group from.", - "type": "string" - } - }, - "id": "NodeGroup", - "type": "object", - "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." - }, - "DiskAggregatedList": { - "properties": { - "items": { - "type": "object", - "additionalProperties": { - "description": "[Output Only] Name of the scope containing this set of disks.", - "$ref": "DisksScopedList" + "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": { + "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." + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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 + } }, - "description": "A list of DisksScopedList resources." - }, - "unreachables": { - "type": "array", - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" + "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" } }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" + "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" + }, + "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" + } }, - "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." - ], + "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.", + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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" - } + "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" } }, - "description": "[Output Only] Informational warning message.", - "type": "object" - }, - "kind": { - "type": "string", - "default": "compute#diskAggregatedList", - "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks." + "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" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" + "setIamPolicy": { + "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", + "httpMethod": "POST", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "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" + ], + "id": "compute.nodeGroups.setIamPolicy" }, - "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": "DiskAggregatedList", - "type": "object" - }, - "InstanceGroupManagersListPerInstanceConfigsResp": { - "type": "object", - "properties": { - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "message": { + "testIamPermissions": { + "request": { + "$ref": "TestPermissionsRequest" + }, + "id": "compute.nodeGroups.testIamPermissions", + "parameters": { + "zone": { + "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": "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" - ], - "description": "[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": { + "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 or id of the resource 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": { - "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" } }, - "type": "object" + "description": "Returns permissions that a caller has on the specified resource.", + "response": { + "$ref": "TestPermissionsResponse" + }, + "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", + "zone", + "resource" + ], + "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", + "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions" }, - "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" + "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" + ], + "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" + ] }, - "items": { - "description": "[Output Only] The list of PerInstanceConfig.", - "type": "array", - "items": { - "$ref": "PerInstanceConfig" - } - } - }, - "id": "InstanceGroupManagersListPerInstanceConfigsResp" - }, - "RegionInstanceGroupManagersListInstanceConfigsResp": { - "id": "RegionInstanceGroupManagersListInstanceConfigsResp", - "type": "object", - "properties": { - "items": { - "items": { - "$ref": "PerInstanceConfig" + "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])?", + "type": "string", + "description": "The name of the zone for this request." + }, + "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" + }, + "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" + } }, - "description": "[Output Only] The list of PerInstanceConfig.", - "type": "array" + "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" + ] }, - "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." + "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." + } + }, + "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." }, - "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." - ], + "getIamPolicy": { + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "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" + ], + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "optionsRequestedPolicyVersion": { + "format": "int32", + "description": "Requested IAM Policy version.", + "type": "integer", + "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])?))", + "location": "path", + "required": true + } + }, + "response": { + "$ref": "Policy" + }, + "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy" + }, + "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" + }, + "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." }, - "message": { + "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, "type": "string", - "description": "[Output Only] A human-readable description of the warning code." + "description": "The name of the zone for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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" + "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" } }, - "type": "object" - } - } - }, - "RegionTargetHttpsProxiesSetSslCertificatesRequest": { - "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", - "properties": { - "sslCertificates": { - "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", - "items": { - "type": "string" + "request": { + "$ref": "NodeGroupsSetNodeTemplateRequest" }, - "type": "array" + "id": "compute.nodeGroups.setNodeTemplate" } - }, - "type": "object" + } }, - "Subsetting": { - "properties": { - "policy": { - "enum": [ - "CONSISTENT_HASH_SUBSETTING", - "NONE" - ], - "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." + "licenseCodes": { + "methods": { + "testIamPermissions": { + "parameterOrder": [ + "project", + "resource" ], - "type": "string" - } - }, - "id": "Subsetting", - "type": "object", - "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." - }, - "ResourcePolicy": { - "type": "object", - "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.", - "properties": { - "id": { - "type": "string", - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64" - }, - "instanceSchedulePolicy": { - "$ref": "ResourcePolicyInstanceSchedulePolicy", - "description": "Resource policy for scheduling instance operations." - }, - "groupPlacementPolicy": { - "description": "Resource policy for instances for placement configuration.", - "$ref": "ResourcePolicyGroupPlacementPolicy" - }, - "status": { - "type": "string", - "description": "[Output Only] The status of resource policy creation.", - "enum": [ - "CREATING", - "DELETING", - "EXPIRED", - "INVALID", - "READY" + "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" ], - "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." - ] - }, - "region": { - "type": "string" - }, - "description": { - "type": "string" - }, - "resourceStatus": { - "description": "[Output Only] The system status of the resource policy.", - "$ref": "ResourcePolicyResourceStatus" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined fully-qualified URL for this resource.", - "type": "string" - }, - "kind": { - "default": "compute#resourcePolicy", - "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.", - "type": "string" - }, - "name": { - "type": "string", - "annotations": { - "required": [ - "compute.instances.insert" - ] + "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])?))" + } }, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." - }, - "snapshotSchedulePolicy": { - "$ref": "ResourcePolicySnapshotSchedulePolicy", - "description": "Resource policy for persistent disks for creating snapshots." - } - }, - "id": "ResourcePolicy" - }, - "InstanceGroupManagersUpdatePerInstanceConfigsReq": { - "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq", - "type": "object", - "description": "InstanceGroupManagers.updatePerInstanceConfigs", - "properties": { - "perInstanceConfigs": { - "items": { - "$ref": "PerInstanceConfig" + "request": { + "$ref": "TestPermissionsRequest" }, - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", - "type": "array" - } - } - }, - "ShareSettings": { - "properties": { - "projectMap": { - "type": "object", - "additionalProperties": { - "$ref": "ShareSettingsProjectConfig" + "response": { + "$ref": "TestPermissionsResponse" }, - "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS." + "id": "compute.licenseCodes.testIamPermissions", + "httpMethod": "POST", + "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions", + "flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions" }, - "shareType": { - "enum": [ - "LOCAL", - "ORGANIZATION", - "SHARE_TYPE_UNSPECIFIED", - "SPECIFIC_PROJECTS" + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "project", + "licenseCode" ], - "enumDescriptions": [ - "Default value.", - "Shared-reservation is open to entire Organization", - "Default value. This value is unused.", - "Shared-reservation is open to specific projects" + "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" ], - "description": "Type of sharing for this shared-reservation", - "type": "string" + "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, + "type": "string" + }, + "licenseCode": { + "description": "Number corresponding to the License code resource to return.", + "location": "path", + "pattern": "[0-9]{0,61}?", + "type": "string", + "required": true + } + }, + "response": { + "$ref": "LicenseCode" + } } - }, - "description": "The share setting for reservations and sole tenancy node groups.", - "id": "ShareSettings", - "type": "object" + } }, - "ResourcePolicySnapshotSchedulePolicySnapshotProperties": { - "properties": { - "chainName": { - "description": "Chain name that the snapshot is created in.", - "type": "string" - }, - "guestFlush": { - "type": "boolean", - "description": "Indication to perform a 'guest aware' snapshot." - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "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": { + "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}" + }, + "region": { + "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." + }, + "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 apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty." + "httpMethod": "DELETE", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "description": "Deletes the specified VPN gateway." }, - "storageLocations": { - "type": "array", - "items": { - "type": "string" + "setLabels": { + "request": { + "$ref": "RegionSetLabelsRequest" }, - "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional)." - } - }, - "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", - "type": "object", - "description": "Specified snapshot properties for scheduled snapshots created by this policy." - }, - "VpnTunnelsScopedList": { - "type": "object", - "id": "VpnTunnelsScopedList", - "properties": { - "vpnTunnels": { - "description": "A list of VPN tunnels contained in this scope.", - "items": { - "$ref": "VpnTunnel" + "response": { + "$ref": "Operation" }, - "type": "array" - }, - "warning": { - "type": "object", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" + ], + "parameterOrder": [ + "project", + "region", + "resource" + ], + "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" }, - "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": { + "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." }, - "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" - ], + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" + }, + "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}" + } + } + }, + "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" + ], + "parameterOrder": [ + "project", + "region", + "vpnGateway" + ], + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", + "response": { + "$ref": "VpnGatewaysGetStatusResponse" + }, + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus" + }, + "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" } }, - "description": "Informational warning which replaces the list of addresses when the list is empty." - } - } - }, - "InstanceWithNamedPorts": { - "properties": { - "status": { - "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)." + "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, + "description": "Creates a VPN gateway in the specified project and region using the data included in the request.", + "parameterOrder": [ + "project", + "region" ], - "description": "[Output Only] The status of the instance.", - "enum": [ - "DEPROVISIONING", - "PROVISIONING", - "REPAIRING", - "RUNNING", - "STAGING", - "STOPPED", - "STOPPING", - "SUSPENDED", - "SUSPENDING", - "TERMINATED" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string" - }, - "instance": { - "type": "string", - "description": "[Output Only] The URL of the instance." - }, - "namedPorts": { - "type": "array", - "description": "[Output Only] The named ports that belong to this instance group.", - "items": { - "$ref": "NamedPort" - } - } - }, - "id": "InstanceWithNamedPorts", - "type": "object" - }, - "ShareSettingsProjectConfig": { - "description": "Config for each project in the share settings.", - "id": "ShareSettingsProjectConfig", - "type": "object", - "properties": { - "projectId": { - "description": "The project ID, should be same as the key of this project config in the parent map.", - "type": "string" - } - } - }, - "NodeTypesScopedList": { - "type": "object", - "id": "NodeTypesScopedList", - "properties": { - "nodeTypes": { - "description": "[Output Only] A list of node types contained in this scope.", - "items": { - "$ref": "NodeType" + "request": { + "$ref": "VpnGateway" }, - "type": "array" + "id": "compute.vpnGateways.insert", + "path": "projects/{project}/regions/{region}/vpnGateways" }, - "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": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - } + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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": { + "region": { + "pattern": "[a-z](?:[-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.", - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", + "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 } }, - "description": "[Output Only] An informational warning that appears when the node types list is empty." - } - } - }, - "RouterStatusBgpPeerStatus": { - "properties": { - "status": { - "description": "Status of the BGP peer: {UP, DOWN}", - "enum": [ - "DOWN", - "UNKNOWN", - "UP" + "flatPath": "projects/{project}/regions/{region}/vpnGateways", + "id": "compute.vpnGateways.list", + "path": "projects/{project}/regions/{region}/vpnGateways", + "parameterOrder": [ + "project", + "region" ], - "type": "string", - "enumDescriptions": [ - "", - "", - "" - ] - }, - "peerIpAddress": { - "type": "string", - "description": "IP address of the remote BGP interface." + "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 VPN gateways available to the specified project and region.", + "httpMethod": "GET" }, - "advertisedRoutes": { - "items": { - "$ref": "Route" + "get": { + "description": "Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.", + "parameterOrder": [ + "project", + "region", + "vpnGateway" + ], + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "response": { + "$ref": "VpnGateway" }, - "type": "array", - "description": "Routes that were advertised to the remote BGP peer" - }, - "ipAddress": { - "description": "IP address of the local BGP interface.", - "type": "string" - }, - "uptimeSeconds": { - "type": "string", - "description": "Time this session has been up, in seconds. Format: 145" - }, - "state": { - "type": "string", - "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states." - }, - "bfdStatus": { - "$ref": "BfdStatus" - }, - "linkedVpnTunnel": { - "description": "URL of the VPN tunnel that this BGP peer controls.", - "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" - }, - "uptime": { - "type": "string", - "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds" - }, - "name": { - "description": "Name of this BGP peer. Unique within the Routers resource.", - "type": "string" - }, - "numLearnedRoutes": { - "description": "Number of routes learned from the remote BGP Peer.", - "format": "uint32", - "type": "integer" - } - }, - "type": "object", - "id": "RouterStatusBgpPeerStatus" - }, - "BackendServiceLogConfig": { - "id": "BackendServiceLogConfig", - "description": "The available logging options for the load balancer traffic served by this backend service.", - "properties": { - "sampleRate": { - "format": "float", - "type": "number", - "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." + "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" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "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" - }, - "InstanceGroupManagersAbandonInstancesRequest": { - "id": "InstanceGroupManagersAbandonInstancesRequest", - "properties": { - "instances": { - "items": { - "type": "string" + "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." + } }, - "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" - } - }, - "type": "object" - }, - "OperationList": { - "type": "object", - "description": "Contains a list of Operation resources.", - "properties": { - "warning": { - "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\" } " + "parameterOrder": [ + "project", + "region", + "resource" + ], + "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" + ], + "response": { + "$ref": "TestPermissionsResponse" + }, + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions" + }, + "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" + ], + "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])?))" }, - "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.", + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "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": "[Output Only] Informational warning message.", - "type": "object" - }, - "selfLink": { - "type": "string", - "description": "[Output Only] Server-defined URL for this resource." - }, - "items": { - "type": "array", - "items": { - "$ref": "Operation" + "response": { + "$ref": "VpnGatewayAggregatedList" }, - "description": "[Output Only] A list of Operation 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] The unique identifier for the resource. This identifier is defined by the server.", - "type": "string" - }, - "kind": { - "type": "string", - "default": "compute#operationList", - "description": "[Output Only] Type of resource. Always `compute#operations` for Operations resource." - } - }, - "id": "OperationList" - }, - "TestPermissionsRequest": { - "id": "TestPermissionsRequest", - "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" - } + "httpMethod": "GET", + "parameterOrder": [ + "project" + ] } - }, - "type": "object" + } }, - "AcceleratorTypesScopedList": { - "type": "object", - "properties": { - "warning": { - "description": "[Output Only] An informational warning that appears when the accelerator types list is empty.", - "properties": { - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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\" } " + "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": { + "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.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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": "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" } }, - "type": "object" - }, - "acceleratorTypes": { - "type": "array", - "description": "[Output Only] A list of accelerator types contained in this scope.", - "items": { - "$ref": "AcceleratorType" - } - } - }, - "id": "AcceleratorTypesScopedList" - }, - "SubnetworkAggregatedList": { - "properties": { - "kind": { - "default": "compute#subnetworkAggregatedList", - "description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.", - "type": "string" - }, - "items": { - "type": "object", - "additionalProperties": { - "description": "Name of the scope containing this set of Subnetworks.", - "$ref": "SubnetworksScopedList" + "response": { + "$ref": "NetworkEdgeSecurityServiceAggregatedList" }, - "description": "A list of SubnetworksScopedList resources." - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "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" + "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" }, - "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)." - } - } - }, - "type": "array", - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + "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" }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", + "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" }, - "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" - ], + "networkEdgeSecurityService": { + "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 network edge security service 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", - "description": "[Output Only] Informational warning message." - }, - "id": { - "type": "string", - "description": "[Output Only] Unique identifier for the resource; defined by the server." - } - }, - "type": "object", - "id": "SubnetworkAggregatedList" - }, - "NetworkEndpointGroupAggregatedList": { - "properties": { - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "type": "array", - "items": { - "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." - }, - "kind": { - "default": "compute#networkEndpointGroupAggregatedList", - "type": "string", - "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups." - }, - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "additionalProperties": { - "description": "The name of the scope that contains this set of network endpoint groups.", - "$ref": "NetworkEndpointGroupsScopedList" + "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" }, - "description": "A list of NetworkEndpointGroupsScopedList resources.", - "type": "object" + "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", + "httpMethod": "DELETE" }, - "warning": { - "type": "object", - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { + "patch": { + "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", + "httpMethod": "PATCH", + "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", + "request": { + "$ref": "NetworkEdgeSecurityService" + }, + "response": { + "$ref": "Operation" + }, + "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", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_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." + "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" + }, + "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." + }, + "paths": { + "type": "string", + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "project", + "region", + "networkEdgeSecurityService" + ] + }, + "get": { + "parameterOrder": [ + "project", + "region", + "networkEdgeSecurityService" + ], + "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}", + "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])?))", + "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": { - "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" - } + "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])?" } - } - } - }, - "id": "NetworkEndpointGroupAggregatedList", - "type": "object" - }, - "AutoscalingPolicyCustomMetricUtilization": { - "properties": { - "utilizationTargetType": { - "enum": [ - "DELTA_PER_MINUTE", - "DELTA_PER_SECOND", - "GAUGE" + }, + "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" ], - "description": "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.", - "type": "string", - "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." - ] - }, - "utilizationTarget": { - "type": "number", - "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." - }, - "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." - }, - "singleInstanceAssignment": { - "format": "double", - "type": "number", - "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." - }, - "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" - } - }, - "id": "AutoscalingPolicyCustomMetricUtilization", - "description": "Custom utilization metric policy.", - "type": "object" - }, - "RouterBgp": { - "properties": { - "asn": { - "type": "integer", - "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.", - "format": "uint32" - }, - "keepaliveInterval": { - "format": "uint32", - "type": "integer", - "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." - }, - "advertisedGroups": { - "items": { - "type": "string", - "enumDescriptions": [ - "Advertise all available subnets (including peer VPC subnets)." - ], - "enum": [ - "ALL_SUBNETS" - ] + "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", + "response": { + "$ref": "NetworkEdgeSecurityService" }, - "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." + "httpMethod": "GET" }, - "advertisedIpRanges": { - "type": "array", - "items": { - "$ref": "RouterAdvertisedIpRange" + "insert": { + "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices", + "request": { + "$ref": "NetworkEdgeSecurityService" }, - "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." - }, - "advertiseMode": { - "enum": [ - "CUSTOM", - "DEFAULT" + "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" + }, + "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." + } + }, + "parameterOrder": [ + "project", + "region" ], - "enumDescriptions": [ - "", - "" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "type": "string", - "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM." + "id": "compute.networkEdgeSecurityServices.insert", + "httpMethod": "POST" } - }, - "type": "object", - "id": "RouterBgp" + } }, - "UrlMapValidationResult": { - "type": "object", - "id": "UrlMapValidationResult", - "properties": { - "loadSucceeded": { - "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.", - "type": "boolean" - }, - "loadErrors": { - "items": { - "type": "string" + "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" + ], + "response": { + "$ref": "UrlMap" }, - "type": "array" + "id": "compute.urlMaps.get", + "parameterOrder": [ + "project", + "urlMap" + ], + "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." + } + } }, - "testPassed": { - "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.", - "type": "boolean" + "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" + ] }, - "testFailures": { - "items": { - "$ref": "TestFailure" + "delete": { + "httpMethod": "DELETE", + "description": "Deletes the specified UrlMap resource.", + "response": { + "$ref": "Operation" }, - "type": "array" - } - }, - "description": "Message representing the validation result for a UrlMap." - } - }, - "parameters": { - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "type": "string", - "location": "query" - }, - "alt": { - "description": "Data format for response.", - "type": "string", - "enum": [ - "json", - "media", - "proto" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "default": "json", - "location": "query" - }, - "quotaUser": { - "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" - }, - "userIp": { - "location": "query", - "type": "string", - "description": "Legacy name for parameter that has been superseded by `quotaUser`." - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "uploadType": { - "location": "query", - "type": "string", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "$.xgafv": { - "location": "query", - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "enum": [ - "1", - "2" - ] - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - } - }, - "protocol": "rest", - "servicePath": "compute/v1/", - "version": "v1", - "rootUrl": "https://compute.googleapis.com/", - "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" + "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 + }, + "urlMap": { + "description": "Name of the UrlMap 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}" + }, + "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}" }, - "https://www.googleapis.com/auth/compute.readonly": { - "description": "View your Google Compute Engine resources" + "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", + "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" }, - "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." + "list": { + "httpMethod": "GET", + "flatPath": "projects/{project}/global/urlMaps", + "response": { + "$ref": "UrlMapList" + }, + "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": { + "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": { + "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" + }, + "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." + } + }, + "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": { - "description": "View and manage your Google Compute Engine resources" + "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])?))", + "type": "string", + "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)." + }, + "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}" + } + }, + "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" + }, + "request": { + "$ref": "CacheInvalidationRule" + }, + "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" }, - "https://www.googleapis.com/auth/devstorage.read_only": { - "description": "View your data in Google Cloud Storage" + "aggregatedList": { + "httpMethod": "GET", + "parameterOrder": [ + "project" + ], + "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" + ], + "response": { + "$ref": "UrlMapsAggregatedList" + }, + "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project." }, - "https://www.googleapis.com/auth/devstorage.read_write": { - "description": "Manage your data in Cloud Storage and see the email address of your Google Account" - } - } - } - }, - "icons": { - "x32": "https://www.google.com/images/icons/product/compute_engine-32.png", - "x16": "https://www.google.com/images/icons/product/compute_engine-16.png" - }, - "discoveryVersion": "v1", - "revision": "20220831", - "ownerDomain": "google.com", - "basePath": "/compute/v1/", - "kind": "discovery#restDescription", - "description": "Creates and runs virtual machines on Google Cloud Platform. ", - "resources": { - "httpHealthChecks": { - "methods": { - "patch": { - "id": "compute.httpHealthChecks.patch", + "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" + }, + "parameterOrder": [ + "project", + "urlMap" + ], "request": { - "$ref": "HttpHealthCheck" + "$ref": "UrlMapsValidateRequest" }, "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])?))", + "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 resource to be validated as.", + "location": "path" + } + }, + "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" + }, + "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 }, - "httpHealthCheck": { + "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, - "type": "string", "location": "path", - "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}" + "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query" } }, @@ -35399,519 +22369,833 @@ "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." + } + } + }, + "regionTargetHttpsProxies": { + "methods": { + "patch": { + "request": { + "$ref": "TargetHttpsProxy" + }, "httpMethod": "PATCH", - "path": "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.", - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "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", - "httpHealthCheck" - ] - }, - "update": { + "region", + "targetHttpsProxy" + ], + "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" - ], + ] + }, + "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" }, - "httpHealthCheck": { - "description": "Name of the HttpHealthCheck resource to update.", - "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", "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" + }, + "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" + ], + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}" + }, + "setSslCertificates": { + "httpMethod": "POST", + "parameterOrder": [ + "project", + "region", + "targetHttpsProxy" + ], + "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" + ], + "description": "Replaces SslCertificates for TargetHttpsProxy.", + "id": "compute.regionTargetHttpsProxies.setSslCertificates", + "request": { + "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" + }, + "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "response": { + "$ref": "Operation" + } + }, + "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" + }, + "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])?))", - "type": "string" + "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", - "httpHealthCheck" - ], + "region", + "targetHttpsProxy" + ] + }, + "insert": { "response": { "$ref": "Operation" }, "request": { - "$ref": "HttpHealthCheck" + "$ref": "TargetHttpsProxy" }, - "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", - "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", - "httpMethod": "PUT", - "id": "compute.httpHealthChecks.update" + "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" }, + "list": { + "id": "compute.regionTargetHttpsProxies.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" + ], + "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" + }, + "path": "projects/{project}/regions/{region}/targetHttpsProxies" + } + } + }, + "targetHttpProxies": { + "methods": { "delete": { - "id": "compute.httpHealthChecks.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." + } + }, + "httpMethod": "DELETE", "parameterOrder": [ "project", - "httpHealthCheck" + "targetHttpProxy" ], - "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", - "httpMethod": "DELETE", + "id": "compute.targetHttpProxies.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "description": "Deletes the specified HttpHealthCheck resource.", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "description": "Deletes the specified TargetHttpProxy resource." + }, + "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" + }, "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.", - "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)." - }, - "httpHealthCheck": { - "location": "path", - "description": "Name of the HttpHealthCheck resource to delete.", - "type": "string", + "targetHttpProxy": { "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true + "description": "Name of the TargetHttpProxy resource to return.", + "location": "path", + "required": true, + "type": "string" } }, - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}" + "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." }, - "insert": { + "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" + }, + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.targetHttpProxies.patch", "parameterOrder": [ - "project" + "project", + "targetHttpProxy" ], "request": { - "$ref": "HttpHealthCheck" + "$ref": "TargetHttpProxy" }, - "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "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", + "description": "Project ID for this request.", + "type": "string" + }, + "targetHttpProxy": { + "location": "path", "type": "string", "required": true, - "location": "path" + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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}/global/httpHealthChecks", + } + }, + "aggregatedList": { "response": { - "$ref": "Operation" + "$ref": "TargetHttpProxyAggregatedList" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.httpHealthChecks.insert", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/httpHealthChecks" - }, - "list": { - "flatPath": "projects/{project}/global/httpHealthChecks", + "flatPath": "projects/{project}/aggregated/targetHttpProxies", "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])?))" + "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": { + "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", - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": "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": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", - "type": "string" - }, - "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`)" + "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 } }, - "id": "compute.httpHealthChecks.list", + "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" + ], "parameterOrder": [ "project" ], + "id": "compute.targetHttpProxies.aggregatedList" + }, + "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": "HttpHealthCheckList" + "$ref": "Operation" }, - "path": "projects/{project}/global/httpHealthChecks", + "parameterOrder": [ + "project" + ], + "path": "projects/{project}/global/targetHttpProxies", "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" ], - "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.", - "httpMethod": "GET" + "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" }, - "get": { + "list": { + "id": "compute.targetHttpProxies.list", + "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", + "httpMethod": "GET", "parameterOrder": [ - "project", - "httpHealthCheck" + "project" ], + "flatPath": "projects/{project}/global/targetHttpProxies", "response": { - "$ref": "HttpHealthCheck" + "$ref": "TargetHttpProxyList" }, - "id": "compute.httpHealthChecks.get", - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "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 HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.", - "httpMethod": "GET", + "path": "projects/{project}/global/targetHttpProxies", "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}", + "pageToken": { + "location": "query", "type": "string", - "location": "path" + "description": "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])?))", + "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" + }, + "filter": { "type": "string", - "location": "path", - "description": "Project ID for this request.", - "required": true - } - }, - "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}" - } - } - }, - "nodeTemplates": { - "methods": { - "list": { - "parameters": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." + "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" - }, - "region": { "type": "string", - "required": true, + "description": "Project ID for this request.", + "location": "path" + } + } + }, + "setUrlMap": { + "request": { + "$ref": "UrlMapReference" + }, + "httpMethod": "POST", + "parameters": { + "targetHttpProxy": { "location": "path", - "description": "The name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "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", - "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" + "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 }, - "pageToken": { + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": "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": "Project ID for this request.", + "location": "path" }, - "orderBy": { + "requestId": { "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." + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", - "https://www.googleapis.com/auth/compute.readonly" - ], - "description": "Retrieves a list of node templates available to the specified project.", - "id": "compute.nodeTemplates.list", - "flatPath": "projects/{project}/regions/{region}/nodeTemplates", - "response": { - "$ref": "NodeTemplateList" - }, - "path": "projects/{project}/regions/{region}/nodeTemplates", - "httpMethod": "GET", "parameterOrder": [ "project", - "region" - ] - }, - "getIamPolicy": { - "httpMethod": "GET", + "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", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ], + "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "id": "compute.targetHttpProxies.setUrlMap", "response": { - "$ref": "Policy" - }, - "id": "compute.nodeTemplates.getIamPolicy", - "parameterOrder": [ - "project", - "region", - "resource" - ], + "$ref": "Operation" + } + } + } + }, + "subnetworks": { + "methods": { + "get": { "parameters": { "region": { + "location": "path", "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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])?))", - "description": "Project ID for this request.", + "type": "string", "required": true, - "location": "path" - }, - "optionsRequestedPolicyVersion": { - "format": "int32", - "location": "query", - "type": "integer", - "description": "Requested IAM Policy version." + "location": "path", + "description": "Project ID for this request." }, - "resource": { + "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, - "description": "Name or id of the resource for this request.", - "type": "string" + "required": true } }, - "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy", - "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" + "httpMethod": "GET", + "response": { + "$ref": "Subnetwork" + }, + "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}" }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", + "testIamPermissions": { "parameters": { - "project": { - "location": "path", + "region": { + "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])?))", - "required": true + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "The name of the region 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}" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "type": "string", + "location": "path" }, - "region": { - "description": "The name of the region for this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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" } }, - "id": "compute.nodeTemplates.setIamPolicy", - "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", + "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": "Policy" + "$ref": "TestPermissionsResponse" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "RegionSetPolicyRequest" - } - }, - "aggregatedList": { - "description": "Retrieves an aggregated list of node templates.", - "flatPath": "projects/{project}/aggregated/nodeTemplates", - "id": "compute.nodeTemplates.aggregatedList", - "parameterOrder": [ - "project" - ], - "httpMethod": "GET", + "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" - ], - "path": "projects/{project}/aggregated/nodeTemplates", - "response": { - "$ref": "NodeTemplateAggregatedList" - }, - "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": { - "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])?))" - }, - "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", - "location": "query", - "format": "uint32", - "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" - }, - "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" - }, - "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" - } - } + ] }, "insert": { - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/nodeTemplates", - "path": "projects/{project}/regions/{region}/nodeTemplates", - "description": "Creates a NodeTemplate 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" ], - "request": { - "$ref": "NodeTemplate" + "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": { - "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 - }, "requestId": { - "type": "string", "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", + "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { + "required": true, + "location": "path", + "description": "Name of the region scoping this request.", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" } }, - "response": { - "$ref": "Operation" - }, - "id": "compute.nodeTemplates.insert" - }, - "testIamPermissions": { - "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", "parameterOrder": [ "project", - "region", - "resource" + "region" ], "request": { - "$ref": "TestPermissionsRequest" + "$ref": "Subnetwork" + } + }, + "setIamPolicy": { + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" }, + "httpMethod": "POST", "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" ], - "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.", - "response": { - "$ref": "TestPermissionsResponse" - }, - "httpMethod": "POST", - "id": "compute.nodeTemplates.testIamPermissions", "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 - }, "resource": { + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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": "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", @@ -35920,303 +23204,494 @@ "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" } - } - }, - "delete": { - "httpMethod": "DELETE", + }, + "id": "compute.subnetworks.setIamPolicy", "parameterOrder": [ "project", "region", - "nodeTemplate" + "resource" ], - "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "response": { + "$ref": "Policy" + }, + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy" + }, + "delete": { + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "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" }, + "id": "compute.subnetworks.delete", + "description": "Deletes the specified subnetwork.", + "httpMethod": "DELETE", + "parameterOrder": [ + "project", + "region", + "subnetwork" + ], + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "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)." }, - "nodeTemplate": { - "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": { + "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 }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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", - "description": "The 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).", + "subnetwork": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "location": "path", "type": "string", - "location": "query" + "required": true, + "description": "Name of the Subnetwork resource to delete." } - }, - "description": "Deletes the specified NodeTemplate resource." + } }, - "get": { - "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", - "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", - "response": { - "$ref": "NodeTemplate" - }, - "httpMethod": "GET", + "getIamPolicy": { + "id": "compute.subnetworks.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])?))", - "description": "Project ID for this request.", - "type": "string", - "location": "path", - "required": true - }, "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "required": true, + "description": "The name of the region for this request." }, - "nodeTemplate": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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}" + }, + "project": { "type": "string", - "description": "Name of the node template to return." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" + }, + "optionsRequestedPolicyVersion": { + "location": "query", + "description": "Requested IAM Policy version.", + "format": "int32", + "type": "integer" } }, "parameterOrder": [ "project", "region", - "nodeTemplate" + "resource" ], - "description": "Returns the specified node template. Gets a list of available node templates by making a list() request.", + "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" ], - "id": "compute.nodeTemplates.get" - } - } - }, - "instanceGroupManagers": { - "methods": { - "deletePerInstanceConfigs": { - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", + "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." + }, + "patch": { "request": { - "$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq" + "$ref": "Subnetwork" }, - "description": "Deletes selected per-instance configurations for the managed instance group.", + "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", - "zone", - "instanceGroupManager" + "region", + "subnetwork" ], - "id": "compute.instanceGroupManagers.deletePerInstanceConfigs", "parameters": { - "zone": { + "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", - "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "requestId": { "type": "string", - "required": true + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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, - "description": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "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" }, - "instanceGroupManager": { - "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", - "description": "The name of the managed instance group. It should conform to RFC1035." + "description": "Project ID for this request.", + "location": "path" } }, - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "httpMethod": "POST" + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "id": "compute.subnetworks.patch", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "httpMethod": "PATCH" }, - "setInstanceTemplate": { - "response": { - "$ref": "Operation" + "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])?" + } }, - "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.", + "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", - "zone", - "instanceGroupManager" + "region", + "subnetwork" ], - "id": "compute.instanceGroupManagers.setInstanceTemplate", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", - "httpMethod": "POST", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "response": { + "$ref": "Operation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" + ] + }, + "aggregatedList": { + "parameterOrder": [ + "project" ], + "httpMethod": "GET", "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).", + "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" }, - "zone": { - "location": "path", - "required": true, + "orderBy": { "type": "string", - "description": "The name of the zone where the managed instance group is located." + "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." }, - "instanceGroupManager": { - "description": "The name of the managed instance group.", - "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" }, "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])?))", - "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])?))" + }, + "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`." } }, - "request": { - "$ref": "InstanceGroupManagersSetInstanceTemplateRequest" - } + "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" + ], + "id": "compute.subnetworks.aggregatedList", + "path": "projects/{project}/aggregated/subnetworks", + "description": "Retrieves an aggregated list of subnetworks." }, - "listManagedInstances": { - "httpMethod": "POST", - "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`.", + "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" + ], "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": { - "description": "The name of the zone where the managed instance group is located.", + "project": { + "location": "path", "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])?))" + }, + "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" }, - "instanceGroupManager": { + "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" + ], + "httpMethod": "GET", + "flatPath": "projects/{project}/aggregated/subnetworks/listUsable" + }, + "expandIpCidrRange": { + "parameterOrder": [ + "project", + "region", + "subnetwork" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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" + }, + "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", - "description": "The name of the managed instance group.", "required": true }, - "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", - "format": "uint32", - "type": "integer", - "default": "500" + "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." }, - "pageToken": { + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "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, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": "string" + } + }, + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange" + }, + "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" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.instanceGroupManagers.listManagedInstances", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", - "response": { - "$ref": "InstanceGroupManagersListManagedInstancesResponse" - }, - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "parameterOrder": [ "project", - "zone", - "instanceGroupManager" - ] - }, - "aggregatedList": { - "parameterOrder": [ - "project" + "region" ], - "description": "Retrieves the list of managed instance groups and groups them by zone.", - "path": "projects/{project}/aggregated/instanceGroupManagers", + "httpMethod": "GET", + "response": { + "$ref": "SubnetworkList" + } + } + } + }, + "healthChecks": { + "methods": { + "aggregatedList": { + "httpMethod": "GET", + "response": { + "$ref": "HealthChecksAggregatedList" + }, + "id": "compute.healthChecks.aggregatedList", "parameters": { - "pageToken": { + "project": { "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": "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." }, - "returnPartialSuccess": { - "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" }, - "project": { + "orderBy": { + "location": "query", "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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": { - "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`)", + "type": "integer", "format": "uint32", "minimum": "0", - "location": "query", - "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." - }, - "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" + "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`.", @@ -36224,186 +23699,192 @@ "location": "query" } }, + "path": "projects/{project}/aggregated/healthChecks", + "flatPath": "projects/{project}/aggregated/healthChecks", + "parameterOrder": [ + "project" + ], + "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" - ], - "flatPath": "projects/{project}/aggregated/instanceGroupManagers", - "response": { - "$ref": "InstanceGroupManagerAggregatedList" - }, - "id": "compute.instanceGroupManagers.aggregatedList", - "httpMethod": "GET" + ] }, - "listErrors": { - "id": "compute.instanceGroupManagers.listErrors", + "get": { "response": { - "$ref": "InstanceGroupManagersListErrorsResponse" + "$ref": "HealthCheck" }, - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" - ], - "description": "Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", + "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" ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", "parameters": { - "maxResults": { - "minimum": "0", - "format": "uint32", - "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`)" - }, - "instanceGroupManager": { - "type": "string", + "healthCheck": { "required": true, - "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}." + "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": { - "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, + "location": "path" + } + }, + "httpMethod": "GET", + "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.", + "parameterOrder": [ + "project", + "healthCheck" + ], + "path": "projects/{project}/global/healthChecks/{healthCheck}" + }, + "patch": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "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])?))", - "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" - }, - "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." + "description": "Project ID for this request.", + "location": "path" }, - "zone": { - "type": "string", + "healthCheck": { + "description": "Name of the HealthCheck resource to patch.", "location": "path", - "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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" - }, - "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" + "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": "GET" - }, - "patch": { - "request": { - "$ref": "InstanceGroupManager" - }, "parameterOrder": [ "project", - "zone", - "instanceGroupManager" + "healthCheck" ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", - "httpMethod": "PATCH", - "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.", + "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" }, + "httpMethod": "PATCH", + "id": "compute.healthChecks.patch", + "request": { + "$ref": "HealthCheck" + } + }, + "insert": { + "flatPath": "projects/{project}/global/healthChecks", + "httpMethod": "POST", "parameters": { - "instanceGroupManager": { - "location": "path", - "required": true, - "description": "The name of the instance group manager.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + } + }, + "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.", + "id": "compute.healthChecks.insert", + "request": { + "$ref": "HealthCheck" + }, + "path": "projects/{project}/global/healthChecks", + "parameterOrder": [ + "project" + ], + "response": { + "$ref": "Operation" + } + }, + "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)." }, - "zone": { - "description": "The name of the zone where you want to create the managed instance group.", + "healthCheck": { "location": "path", + "type": "string", "required": true, - "type": "string" + "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}" }, - "requestId": { + "project": { "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)." + "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" ], - "id": "compute.instanceGroupManagers.patch", - "path": "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.", - "id": "compute.instanceGroupManagers.listPerInstanceConfigs", - "httpMethod": "POST", - "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/healthChecks/{healthCheck}", + "description": "Updates a HealthCheck resource in the specified project using the data included in the request.", + "httpMethod": "PUT", + "parameterOrder": [ + "project", + "healthCheck" ], - "response": { - "$ref": "InstanceGroupManagersListPerInstanceConfigsResp" - }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", + "path": "projects/{project}/global/healthChecks/{healthCheck}", + "request": { + "$ref": "HealthCheck" + } + }, + "list": { "parameters": { - "instanceGroupManager": { + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "The name of the managed instance group. It should conform to RFC1035.", - "required": true + "required": true, + "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.", + "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])?))", - "type": "string", - "location": "path", - "description": "Project ID for this request.", - "required": true - }, "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" - }, - "zone": { - "location": "path", - "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", - "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" + "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", @@ -36411,146 +23892,92 @@ "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" } }, - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" - ] - }, - "resize": { + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "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.", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", - "id": "compute.instanceGroupManagers.resize", + "id": "compute.healthChecks.list", + "parameterOrder": [ + "project" + ], + "description": "Retrieves the list of HealthCheck resources available to the specified project." + }, + "delete": { + "id": "compute.healthChecks.delete", "parameters": { - "zone": { - "description": "The name of the zone where the managed instance group is located.", - "type": "string", - "location": "path", - "required": true - }, - "size": { - "location": "query", - "type": "integer", - "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.", - "required": true, - "format": "int32" - }, "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])?))", - "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" + "location": "path" }, - "instanceGroupManager": { - "location": "path", - "required": true, - "description": "The name of the managed instance group.", - "type": "string" - } - }, - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager", - "size" - ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - } - }, - "insert": { - "path": "projects/{project}/zones/{zone}/instanceGroupManagers", - "parameters": { - "zone": { + "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", - "description": "The name of the zone where you want to create the managed instance group." + "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" - }, - "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" } }, - "id": "compute.instanceGroupManagers.insert", - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/zones/{zone}/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 managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.", - "request": { - "$ref": "InstanceGroupManager" - }, "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", - "zone" + "healthCheck" ] - }, + } + } + }, + "resourcePolicies": { + "methods": { "list": { - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone" + "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" ], - "id": "compute.instanceGroupManagers.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", - "description": "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", - "location": "query", - "type": "integer", - "default": "500", - "minimum": "0" - }, - "zone": { - "description": "The name of the zone where the managed instance group is located.", - "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])?))", + "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" @@ -36560,4974 +23987,5166 @@ "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", - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" } }, - "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", + "region" ], - "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers", - "response": { - "$ref": "InstanceGroupManagerList" - } - }, - "setTargetPools": { - "id": "compute.instanceGroupManagers.setTargetPools", "response": { - "$ref": "Operation" + "$ref": "ResourcePolicyList" }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", - "httpMethod": "POST", - "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.", + "flatPath": "projects/{project}/regions/{region}/resourcePolicies", + "path": "projects/{project}/regions/{region}/resourcePolicies", + "id": "compute.resourcePolicies.list" + }, + "getIamPolicy": { "parameterOrder": [ "project", - "zone", - "instanceGroupManager" + "region", + "resource" ], - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "id": "compute.resourcePolicies.getIamPolicy", "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" ], + "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": { - "requestId": { + "project": { + "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)." + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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." }, - "zone": { + "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 + }, + "optionsRequestedPolicyVersion": { + "type": "integer", + "location": "query", + "description": "Requested IAM Policy version.", + "format": "int32" + } + } + }, + "testIamPermissions": { + "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "parameters": { + "resource": { "required": true, - "description": "The name of the zone where the managed instance group is located." + "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." }, - "instanceGroupManager": { + "region": { + "required": true, "location": "path", - "description": "The name of the managed instance group.", "type": "string", - "required": true + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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])?))", "required": true, "type": "string", - "description": "Project ID for this request." + "description": "Project ID for this request.", + "location": "path" } }, - "request": { - "$ref": "InstanceGroupManagersSetTargetPoolsRequest" - } - }, - "deleteInstances": { + "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, + "description": "Returns permissions that a caller has on the specified resource.", "parameterOrder": [ "project", - "zone", - "instanceGroupManager" + "region", + "resource" + ], + "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" + ] + }, + "insert": { + "parameterOrder": [ + "project", + "region" ], + "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" ], "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", "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 managed instance group is located.", + "requestId": { "type": "string", - "location": "path", - "required": true + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { - "type": "string", - "description": "The name of the managed instance group.", + "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": "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.", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", - "id": "compute.instanceGroupManagers.deleteInstances", - "request": { - "$ref": "InstanceGroupManagersDeleteInstancesRequest" - }, - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", - "httpMethod": "POST" + } }, - "createInstances": { - "request": { - "$ref": "InstanceGroupManagersCreateInstancesRequest" - }, + "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" ], - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", - "id": "compute.instanceGroupManagers.createInstances", + "parameterOrder": [ + "project", + "region", + "resourcePolicy" + ], + "id": "compute.resourcePolicies.delete", + "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "parameters": { - "instanceGroupManager": { - "type": "string", - "description": "The name of the managed instance group. It should conform to RFC1035.", + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region for this request.", + "location": "path", "required": true, - "location": "path" + "type": "string" }, - "zone": { + "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", - "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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 } }, - "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.", - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" - ], - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances" + "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}" }, - "abandonInstances": { + "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", - "httpMethod": "POST", + "id": "compute.resourcePolicies.setIamPolicy", "response": { - "$ref": "Operation" + "$ref": "Policy" }, + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", "request": { - "$ref": "InstanceGroupManagersAbandonInstancesRequest" + "$ref": "RegionSetPolicyRequest" }, - "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.", - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" - ], "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])?))" - }, - "instanceGroupManager": { + "region": { + "description": "The name of the region for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, - "description": "The name of the managed instance group.", "location": "path", "type": "string" }, - "zone": { - "type": "string", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", - "description": "The name of the zone where the managed instance group is located.", - "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)." - } - }, - "id": "compute.instanceGroupManagers.abandonInstances" - }, - "get": { - "parameters": { - "zone": { - "type": "string", - "description": "The name of the zone where the managed instance group is located.", "required": true, - "location": "path" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "type": "string" }, "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])?))" - }, - "instanceGroupManager": { "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": "The name of the managed instance group.", - "type": "string" + "description": "Project ID for this request." } }, - "id": "compute.instanceGroupManagers.get", - "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 all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.", "parameterOrder": [ "project", - "zone", - "instanceGroupManager" + "region", + "resource" ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", - "response": { - "$ref": "InstanceGroupManager" - } + "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", + "httpMethod": "POST" }, - "recreateInstances": { - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" + "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" ], - "response": { - "$ref": "Operation" - }, - "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.", "parameters": { - "zone": { - "description": "The name of the zone where the managed instance group is located.", - "type": "string", - "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.", + "location": "query", + "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).", - "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." }, - "instanceGroupManager": { - "type": "string", - "required": true, - "location": "path", - "description": "The name of the managed instance group." + "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": { - "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": "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" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "InstanceGroupManagersRecreateInstancesRequest" - }, - "id": "compute.instanceGroupManagers.recreateInstances", - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances" - }, - "updatePerInstanceConfigs": { - "httpMethod": "POST", - "request": { - "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq" - }, - "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": "GET", + "id": "compute.resourcePolicies.aggregatedList", "response": { - "$ref": "Operation" + "$ref": "ResourcePolicyAggregatedList" }, - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", + "parameterOrder": [ + "project" + ] + }, + "get": { "parameterOrder": [ "project", - "zone", - "instanceGroupManager" + "region", + "resourcePolicy" ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "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.instanceGroupManagers.updatePerInstanceConfigs", + "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "parameters": { - "zone": { - "type": "string", - "required": true, + "resourcePolicy": { "location": "path", - "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035." + "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" }, - "requestId": { + "region": { "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": { "required": true, - "type": "string", - "location": "path", - "description": "The name of the managed instance group. It should conform to RFC1035." + "description": "Name of the region for this request.", + "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])?))", - "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])?))" } - } - }, - "patchPerInstanceConfigs": { + }, "response": { - "$ref": "Operation" + "$ref": "ResourcePolicy" }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", + "description": "Retrieves all information of the specified resource policy.", + "id": "compute.resourcePolicies.get", + "httpMethod": "GET" + } + } + }, + "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", + "https://www.googleapis.com/auth/compute.readonly" ], "httpMethod": "POST", - "request": { - "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq" - }, - "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", + "description": "Returns permissions that a caller has on the specified resource.", "parameterOrder": [ "project", - "zone", - "instanceGroupManager" - ], - "id": "compute.instanceGroupManagers.patchPerInstanceConfigs", - "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" - }, - "instanceGroupManager": { - "required": true, - "location": "path", - "type": "string", - "description": "The name of the managed instance group. It should conform to RFC1035." - }, - "zone": { - "location": "path", - "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", - "type": "string", - "required": true - } - } - }, - "applyUpdatesToInstances": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "resource" ], - "id": "compute.instanceGroupManagers.applyUpdatesToInstances", "request": { - "$ref": "InstanceGroupManagersApplyUpdatesRequest" + "$ref": "TestPermissionsRequest" }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", - "parameterOrder": [ - "project", - "zone", - "instanceGroupManager" - ], - "httpMethod": "POST", "parameters": { - "project": { + "resource": { "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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.", + "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" }, - "zone": { - "description": "The name of the zone where the managed instance group is located. Should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" - }, - "instanceGroupManager": { - "required": true, + "project": { "type": "string", + "required": true, "location": "path", - "description": "The name of the managed instance group, should conform to RFC1035." + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "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." + "id": "compute.instanceTemplates.testIamPermissions", + "path": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions" }, - "delete": { + "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", - "zone", - "instanceGroupManager" + "project" ], + "path": "projects/{project}/global/instanceTemplates", "parameters": { - "instanceGroupManager": { + "project": { + "description": "Project ID for this request.", "required": true, "location": "path", "type": "string", - "description": "The name of the managed instance group to delete." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the zone where the managed instance group is located." - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "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.instanceGroupManagers.delete", - "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", - "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", - "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." - } - } - }, - "regionInstanceGroupManagers": { - "methods": { - "setTargetPools": { - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", - "id": "compute.regionInstanceGroupManagers.setTargetPools", - "httpMethod": "POST", + ], + "request": { + "$ref": "InstanceTemplate" + }, + "httpMethod": "POST" + }, + "setIamPolicy": { "parameterOrder": [ "project", - "region", - "instanceGroupManager" + "resource" ], + "request": { + "$ref": "GlobalSetPolicyRequest" + }, "parameters": { - "instanceGroupManager": { + "resource": { + "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 managed instance group." - }, - "region": { - "description": "Name of the region scoping this request.", - "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).", + "description": "Name or id of the resource for this request.", "type": "string", - "location": "query" + "required": true }, "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])?))", + "location": "path", "type": "string" } }, - "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.", - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest" - }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] - }, - "listManagedInstances": { + ], + "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", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "response": { - "$ref": "RegionInstanceGroupManagersListInstancesResponse" - }, - "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`.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.regionInstanceGroupManagers.listManagedInstances", + "$ref": "Policy" + } + }, + "list": { + "flatPath": "projects/{project}/global/instanceTemplates", + "httpMethod": "GET", + "path": "projects/{project}/global/instanceTemplates", "parameters": { - "instanceGroupManager": { - "type": "string", - "location": "path", - "description": "The name of the managed instance group.", - "required": true - }, - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "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." - }, "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": "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.", + "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.", "required": true, - "location": "path", + "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", - "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" + "location": "query", + "format": "uint32" }, - "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.", + "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", - "region", - "instanceGroupManager" + "project" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "applyUpdatesToInstances": { - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", - "httpMethod": "POST", + "delete": { + "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, "parameters": { - "project": { + "instanceTemplate": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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." + "description": "The name of the instance template to delete.", + "required": true }, - "region": { + "requestId": { "type": "string", - "required": true, - "description": "Name of the region scoping this request, should conform to RFC1035.", - "location": "path" + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { + "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": "The name of the managed instance group, should conform to RFC1035." + "location": "path" } }, - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", + "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" + ] + }, + "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" ], - "parameterOrder": [ - "project", - "region", - "instanceGroupManager" - ], - "id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances", - "request": { - "$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" - }, + "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}", + "id": "compute.instanceTemplates.get", "response": { - "$ref": "Operation" + "$ref": "InstanceTemplate" }, - "description": "Apply updates to selected instances the managed instance group." - }, - "insert": { "parameters": { - "region": { + "project": { + "description": "Project ID for this request.", "required": true, "type": "string", "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" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "location": "path", + "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" + ] + }, + "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." + "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}" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers", - "request": { - "$ref": "InstanceGroupManager" - }, - "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.", + "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": "Operation" + "$ref": "Policy" }, - "id": "compute.regionInstanceGroupManagers.insert", "parameterOrder": [ "project", - "region" + "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "listErrors": { - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy" + } + } + }, + "externalVpnGateways": { + "methods": { + "get": { + "httpMethod": "GET", "response": { - "$ref": "RegionInstanceGroupManagersListErrorsResponse" + "$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}" + }, + "setLabels": { + "parameterOrder": [ + "project", + "resource" + ], + "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" + ], + "response": { + "$ref": "Operation" + }, + "description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.", "parameters": { - "maxResults": { - "format": "uint32", - "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`)", - "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": { + "type": "string", "description": "Project ID for this request.", - "location": "path", "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": { - "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": { + "resource": { "location": "path", - "description": "Name of the region scoping this request. This should conform to RFC1035.", + "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 - }, - "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" - }, - "instanceGroupManager": { - "required": true, - "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" - }, - "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.regionInstanceGroupManagers.listErrors", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "region", - "instanceGroupManager" - ], - "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.externalVpnGateways.setLabels", + "httpMethod": "POST" }, "list": { - "httpMethod": "GET", + "parameterOrder": [ + "project" + ], + "id": "compute.externalVpnGateways.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." + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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", - "required": true, - "description": "Name of the region scoping this request.", - "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.", + "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.", + "location": "query", "type": "boolean" }, - "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" - }, - "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", "type": "string", - "location": "query" + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { - "format": "uint32", "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", - "type": "integer" + "location": "query" } }, - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers", + "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" + ] + }, + "testIamPermissions": { + "id": "compute.externalVpnGateways.testIamPermissions", + "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", + "httpMethod": "POST", "parameterOrder": [ "project", - "region" + "resource" ], - "path": "projects/{project}/regions/{region}/instanceGroupManagers", - "description": "Retrieves the list of managed instance groups that are contained within the specified region.", + "parameters": { + "resource": { + "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 resource for 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." + } + }, + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, "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/externalVpnGateways/{resource}/testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource." + }, + "delete": { + "id": "compute.externalVpnGateways.delete", "response": { - "$ref": "RegionInstanceGroupManagerList" + "$ref": "Operation" }, - "id": "compute.regionInstanceGroupManagers.list" - }, - "setInstanceTemplate": { - "httpMethod": "POST", - "id": "compute.regionInstanceGroupManagers.setInstanceTemplate", + "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" + } + }, + "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "parameterOrder": [ "project", - "region", - "instanceGroupManager" + "externalVpnGateway" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "httpMethod": "DELETE" + }, + "insert": { + "flatPath": "projects/{project}/global/externalVpnGateways", + "id": "compute.externalVpnGateways.insert", "request": { - "$ref": "RegionInstanceGroupManagersSetTemplateRequest" + "$ref": "ExternalVpnGateway" }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "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" - }, - "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])?))", + } + }, + "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" + }, + "parameters": { + "zone": { + "required": true, "location": "path", - "description": "Project ID for this request.", - "required": true + "description": "The name of the zone for this request.", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, - "instanceGroupManager": { + "diskType": { "location": "path", + "description": "Name of the disk type to return.", "type": "string", - "description": "The name of the managed instance group.", - "required": true + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" }, - "region": { + "project": { "location": "path", - "type": "string", - "description": "Name of the region scoping this request.", - "required": true + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected." - }, - "recreateInstances": { - "id": "compute.regionInstanceGroupManagers.recreateInstances", + "parameterOrder": [ + "project", + "zone", + "diskType" + ], "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" ], + "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}", + "id": "compute.diskTypes.get" + }, + "aggregatedList": { "parameterOrder": [ - "project", - "region", - "instanceGroupManager" + "project" ], - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "parameters": { - "instanceGroupManager": { - "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" + }, + "orderBy": { "type": "string", - "required": true, - "description": "Name of the managed instance group." + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" }, - "requestId": { + "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": { + "pageToken": { "type": "string", - "description": "Name of the region scoping this request.", - "location": "path", - "required": true + "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", - "type": "string", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." } }, - "request": { - "$ref": "RegionInstanceGroupManagersRecreateRequest" - }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", - "httpMethod": "POST", + "path": "projects/{project}/aggregated/diskTypes", "response": { - "$ref": "Operation" + "$ref": "DiskTypeAggregatedList" }, - "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." + "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" + ] }, - "patch": { - "request": { - "$ref": "InstanceGroupManager" - }, - "id": "compute.regionInstanceGroupManagers.patch", + "list": { + "path": "projects/{project}/zones/{zone}/diskTypes", "parameterOrder": [ "project", - "region", - "instanceGroupManager" + "zone" ], + "id": "compute.diskTypes.list", "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).", + "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", - "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`." }, - "instanceGroupManager": { - "location": "path", + "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" + }, + "orderBy": { "type": "string", - "description": "The name of the instance group manager.", - "required": true + "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, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", - "location": "path", - "required": true, - "description": "Name of the region scoping 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" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{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.", - "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "httpMethod": "PATCH", + "httpMethod": "GET", + "flatPath": "projects/{project}/zones/{zone}/diskTypes", + "response": { + "$ref": "DiskTypeList" + }, + "description": "Retrieves a list of disk types available to the specified project." + } + } + }, + "zoneOperations": { + "methods": { + "get": { "response": { "$ref": "Operation" - } - }, - "delete": { - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", - "httpMethod": "DELETE", - "description": "Deletes the specified managed instance group and all of the instances in that group.", - "id": "compute.regionInstanceGroupManagers.delete", + }, + "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", + "https://www.googleapis.com/auth/compute.readonly" + ], + "parameterOrder": [ + "project", + "zone", + "operation" ], + "path": "projects/{project}/zones/{zone}/operations/{operation}", "parameters": { - "region": { - "description": "Name of the region scoping 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, + "location": "path", "type": "string" }, - "instanceGroupManager": { + "zone": { "type": "string", - "required": true, - "description": "Name of the managed instance group to delete.", - "location": "path" + "location": "path", + "description": "Name of the zone for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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])?))", + "operation": { "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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" + "type": "string", + "description": "Name of the Operations resource to return." } }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region", - "instanceGroupManager" - ] + "id": "compute.zoneOperations.get", + "httpMethod": "GET", + "description": "Retrieves the specified zone-specific Operations resource." }, - "updatePerInstanceConfigs": { - "request": { - "$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq" - }, - "parameterOrder": [ - "project", - "region", - "instanceGroupManager" - ], - "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", + "delete": { + "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", "parameters": { - "project": { + "zone": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "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 + "required": true, + "description": "Name of the zone for this request." }, - "region": { - "type": "string", + "operation": { "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 region scoping this request, should conform to 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": "Name of the Operations resource to delete." }, - "instanceGroupManager": { + "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": "The name of the managed instance group. It should conform to RFC1035." + "description": "Project ID for this request." } }, - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", - "id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs", - "response": { - "$ref": "Operation" - }, + "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" - ] - }, - "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.", + ], "parameterOrder": [ "project", - "region", - "instanceGroupManager" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "zone", + "operation" ], - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", + "httpMethod": "DELETE" + }, + "wait": { "parameters": { - "instanceGroupManager": { - "description": "Name of the managed instance group.", - "type": "string", - "required": true, - "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, - "type": "string", - "description": "Name of the region scoping this request.", - "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", + "required": true, "type": "string", "description": "Project ID for this request." - } - }, - "request": { - "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest" - }, - "response": { - "$ref": "Operation" - }, - "id": "compute.regionInstanceGroupManagers.deleteInstances" - }, - "resize": { - "parameters": { - "region": { - "description": "Name of the region scoping this request.", - "type": "string", - "location": "path", - "required": true }, - "project": { - "type": "string", - "required": true, + "operation": { "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])?))" - }, - "size": { - "description": "Number of instances that should exist in this instance group manager.", - "minimum": "0", - "location": "query", "required": true, - "type": "integer", - "format": "int32" + "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}" }, - "instanceGroupManager": { - "description": "Name of the managed instance group.", + "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" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.regionInstanceGroupManagers.resize", + "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", + "httpMethod": "POST", + "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", "parameterOrder": [ "project", - "region", - "instanceGroupManager", - "size" + "zone", + "operation" ], - "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" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", - "httpMethod": "POST", - "response": { - "$ref": "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 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" }, - "deletePerInstanceConfigs": { - "request": { - "$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq" - }, + "list": { "response": { - "$ref": "Operation" + "$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", - "region", - "instanceGroupManager" + "zone" ], + "httpMethod": "GET", + "description": "Retrieves a list of Operation resources contained within the specified zone.", + "path": "projects/{project}/zones/{zone}/operations", "parameters": { - "instanceGroupManager": { - "location": "path", - "description": "The name of the managed instance group. It should conform to RFC1035.", + "orderBy": { "type": "string", - "required": true + "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", - "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" - }, - "region": { "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 region scoping this request, should conform to RFC1035.", + "description": "Name of the zone for request.", + "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" + }, + "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" } - }, - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", - "description": "Deletes selected per-instance configurations for the managed instance group.", - "id": "compute.regionInstanceGroupManagers.deletePerInstanceConfigs", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", - "id": "compute.regionInstanceGroupManagers.get", - "httpMethod": "GET", + } + } + } + }, + "regionNetworkFirewallPolicies": { + "methods": { + "setIamPolicy": { "parameterOrder": [ "project", "region", - "instanceGroupManager" - ], - "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" + "resource" ], - "description": "Returns all of the details about the specified managed instance group.", - "response": { - "$ref": "InstanceGroupManager" - }, + "id": "compute.regionNetworkFirewallPolicies.setIamPolicy", + "httpMethod": "POST", + "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy", "parameters": { "region": { - "type": "string", - "description": "Name of the region scoping this request.", "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 }, - "instanceGroupManager": { + "resource": { "required": true, - "description": "Name of the managed instance group to return.", - "location": "path", - "type": "string" + "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, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 } + }, + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "response": { + "$ref": "Policy" } }, - "abandonInstances": { - "id": "compute.regionInstanceGroupManagers.abandonInstances", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", - "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.", + "patchRule": { + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", "parameters": { - "instanceGroupManager": { - "type": "string", + "project": { + "required": true, "location": "path", - "description": "Name of the managed instance group.", - "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", "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "required": true, - "location": "path", - "description": "Name of the region scoping this request." + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "type": "integer", + "location": "query" }, - "project": { + "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Project ID for this request." + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "description": "Name of the region scoping this request." } }, - "request": { - "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region", - "instanceGroupManager" - ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] - }, - "createInstances": { - "response": { - "$ref": "Operation" - }, + ], + "id": "compute.regionNetworkFirewallPolicies.patchRule", + "description": "Patches a rule of the specified priority.", "parameterOrder": [ "project", "region", - "instanceGroupManager" + "firewallPolicy" ], - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", - "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, + "request": { + "$ref": "FirewallPolicyRule" + }, + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", + "httpMethod": "POST" + }, + "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "request": { - "$ref": "RegionInstanceGroupManagersCreateInstancesRequest" - }, - "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.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", - "id": "compute.regionInstanceGroupManagers.createInstances", + "id": "compute.regionNetworkFirewallPolicies.patch", + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "description": "The name of the region where the managed instance group is located. It should conform to RFC1035.", - "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, - "type": "string" + "type": "string", + "description": "Name of the region scoping this request.", + "location": "path" + }, + "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}" }, "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { - "description": "The name of the managed instance group. It should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" } - } - }, - "listPerInstanceConfigs": { + }, + "description": "Patches the specified network firewall policy.", "response": { - "$ref": "RegionInstanceGroupManagersListInstanceConfigsResp" + "$ref": "Operation" }, "parameterOrder": [ "project", "region", - "instanceGroupManager" + "firewallPolicy" ], - "path": "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.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", + "httpMethod": "PATCH", + "request": { + "$ref": "FirewallPolicy" + }, + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}" + }, + "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": { - "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, + "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" }, - "instanceGroupManager": { - "required": true, - "description": "The name of the managed instance group. It should conform to RFC1035.", - "type": "string", - "location": "path" - }, - "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", + "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": { - "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", "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" + "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, - "description": "Name of the region scoping this request, should conform to RFC1035." + "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "location": "query", + "type": "string" }, - "orderBy": { + "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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" } }, - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], - "id": "compute.regionInstanceGroupManagers.listPerInstanceConfigs" - }, - "patchPerInstanceConfigs": { "response": { - "$ref": "Operation" + "$ref": "FirewallPolicyList" }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/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.", - "httpMethod": "POST", + "id": "compute.regionNetworkFirewallPolicies.list" + }, + "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, - "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" - }, - "region": { - "type": "string", - "description": "Name of the region scoping this request, should conform to RFC1035.", - "required": true, - "location": "path" + "type": "string" }, - "requestId": { + "network": { "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": "Network reference", + "required": true }, - "instanceGroupManager": { - "description": "The name of the managed instance group. It should conform to RFC1035.", + "region": { + "type": "string", + "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])?" } }, + "response": { + "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse" + }, + "description": "Returns the effective firewalls on a given network.", + "httpMethod": "GET", + "path": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls" + }, + "insert": { + "description": "Creates a new network firewall policy in the specified project and region.", + "httpMethod": "POST", + "flatPath": "projects/{project}/regions/{region}/firewallPolicies", "request": { - "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq" + "$ref": "FirewallPolicy" }, - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "parameterOrder": [ "project", - "region", - "instanceGroupManager" + "region" ], - "id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] - } - } - }, - "publicAdvertisedPrefixes": { - "methods": { - "patch": { - "parameterOrder": [ - "project", - "publicAdvertisedPrefix" ], - "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", - "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", + "id": "compute.regionNetworkFirewallPolicies.insert", "response": { "$ref": "Operation" }, + "path": "projects/{project}/regions/{region}/firewallPolicies", "parameters": { - "publicAdvertisedPrefix": { - "description": "Name of the PublicAdvertisedPrefix resource to patch.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "location": "query" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", "required": true, - "location": "path" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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 + } + } + }, + "cloneRules": { + "httpMethod": "POST", + "parameters": { + "project": { + "location": "path", "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": { + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "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": "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.", - "request": { - "$ref": "PublicAdvertisedPrefix" - }, - "httpMethod": "PATCH", - "id": "compute.publicAdvertisedPrefixes.patch", "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" }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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": { - "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": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" }, - "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`.", + "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" }, - "orderBy": { + "requestId": { "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" }, - "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", + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "location": "path", + "description": "Name of the region scoping this request.", "type": "string" }, - "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`)", - "type": "integer", - "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])?))", + "firewallPolicy": { "location": "path", - "description": "Project ID for this request.", + "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 } }, - "description": "Lists the PublicAdvertisedPrefixes for a project.", - "id": "compute.publicAdvertisedPrefixes.list", "response": { - "$ref": "PublicAdvertisedPrefixList" - }, - "flatPath": "projects/{project}/global/publicAdvertisedPrefixes", - "httpMethod": "GET", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/global/publicAdvertisedPrefixes" - }, - "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)." - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } + "$ref": "Operation" }, - "description": "Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.", - "httpMethod": "POST", - "id": "compute.publicAdvertisedPrefixes.insert", - "path": "projects/{project}/global/publicAdvertisedPrefixes", + "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": "Operation" + "$ref": "TestPermissionsResponse" }, + "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": "PublicAdvertisedPrefix" + "$ref": "TestPermissionsRequest" }, - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/global/publicAdvertisedPrefixes" - }, - "get": { - "id": "compute.publicAdvertisedPrefixes.get", - "parameterOrder": [ - "project", - "publicAdvertisedPrefix" - ], - "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", - "description": "Returns the specified PublicAdvertisedPrefix 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}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", - "httpMethod": "GET", + "parameterOrder": [ + "project", + "region", + "resource" + ], "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" + } + }, + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions" + }, + "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, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-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 firewall policy to update.", "location": "path", - "type": "string", - "description": "Project ID for this request." + "type": "string" }, - "publicAdvertisedPrefix": { + "requestId": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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 PublicAdvertisedPrefix resource to return." + "description": "Name of the region scoping this request.", + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" } }, - "response": { - "$ref": "PublicAdvertisedPrefix" - } - }, - "delete": { - "id": "compute.publicAdvertisedPrefixes.delete", - "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", - "httpMethod": "DELETE", + "parameterOrder": [ + "project", + "region", + "firewallPolicy" + ], + "httpMethod": "POST", + "request": { + "$ref": "FirewallPolicyRule" + }, "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" + }, + "get": { + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", + "parameterOrder": [ + "project", + "region", + "firewallPolicy" + ], "parameters": { - "requestId": { + "region": { + "location": "path", + "description": "Name of the region scoping this request.", + "required": true, "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])?" }, - "publicAdvertisedPrefix": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "firewallPolicy": { "type": "string", - "description": "Name of the PublicAdvertisedPrefix resource to delete.", + "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 }, "project": { "type": "string", - "required": true, "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 PublicAdvertisedPrefix", - "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", + "id": "compute.regionNetworkFirewallPolicies.get", "response": { - "$ref": "Operation" + "$ref": "FirewallPolicy" }, - "parameterOrder": [ - "project", - "publicAdvertisedPrefix" - ] - } - } - }, - "resourcePolicies": { - "methods": { - "delete": { - "httpMethod": "DELETE", + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "id": "compute.resourcePolicies.delete", - "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}" + }, + "removeRule": { "response": { "$ref": "Operation" }, - "parameterOrder": [ - "project", - "region", - "resourcePolicy" - ], "parameters": { - "region": { + "firewallPolicy": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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": "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).", "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": "string" }, - "resourcePolicy": { - "required": true, + "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])?|[1-9][0-9]{0,19}", - "description": "Name of the resource policy to delete.", - "location": "path" + "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.", - "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])?))", + "location": "path", "required": true } }, - "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", - "description": "Deletes the specified resource policy." - }, - "insert": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], + "id": "compute.regionNetworkFirewallPolicies.removeRule", + "httpMethod": "POST", + "description": "Deletes a rule of the specified priority.", "parameterOrder": [ "project", - "region" + "region", + "firewallPolicy" ], - "id": "compute.resourcePolicies.insert", + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule", + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule" + }, + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "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 for this request.", "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "location": "path", - "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])?))", + "firewallPolicy": { + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "location": "path", - "description": "Project ID for this request.", "type": "string", - "required": true + "description": "Name of the firewall policy to delete." } }, - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/resourcePolicies", - "request": { - "$ref": "ResourcePolicy" - }, - "path": "projects/{project}/regions/{region}/resourcePolicies", - "description": "Creates a new resource policy.", - "httpMethod": "POST" - }, - "aggregatedList": { - "description": "Retrieves an aggregated list of resource policies.", - "id": "compute.resourcePolicies.aggregatedList", - "httpMethod": "GET", + "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", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ], - "path": "projects/{project}/aggregated/resourcePolicies", - "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." - }, - "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." - }, - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "format": "uint32", - "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } - }, "parameterOrder": [ - "project" + "project", + "region", + "firewallPolicy" ], - "flatPath": "projects/{project}/aggregated/resourcePolicies", + "httpMethod": "DELETE", "response": { - "$ref": "ResourcePolicyAggregatedList" + "$ref": "Operation" } }, - "testIamPermissions": { + "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])?))", - "type": "string", - "location": "path", "description": "Project ID for this request.", - "required": true + "required": true, + "type": "string", + "location": "path" }, "region": { - "description": "The name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "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" }, - "resource": { - "required": true, - "location": "path", + "name": { + "description": "The name of the association to get from the firewall policy.", + "location": "query", + "type": "string" + }, + "firewallPolicy": { "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." + "description": "Name of the firewall policy to which the queried association belongs.", + "location": "path", + "required": true } }, - "request": { - "$ref": "TestPermissionsRequest" - }, - "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", + "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" ], - "id": "compute.resourcePolicies.testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" - }, - "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", + "description": "Gets an association with the specified name.", "parameterOrder": [ "project", "region", - "resource" + "firewallPolicy" ], - "httpMethod": "POST", - "description": "Returns permissions that a caller has on the specified resource." + "response": { + "$ref": "FirewallPolicyAssociation" + } }, - "list": { - "id": "compute.resourcePolicies.list", - "path": "projects/{project}/regions/{region}/resourcePolicies", - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "GET", + "getRule": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], - "description": "A list all the resource policies that have been configured for the specified project in specified region.", + "parameterOrder": [ + "project", + "region", + "firewallPolicy" + ], + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule", + "description": "Gets a rule of the specified priority.", + "httpMethod": "GET", "response": { - "$ref": "ResourcePolicyList" + "$ref": "FirewallPolicyRule" }, - "flatPath": "projects/{project}/regions/{region}/resourcePolicies", + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule", + "id": "compute.regionNetworkFirewallPolicies.getRule", "parameters": { - "region": { - "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", - "type": "string", "required": true, - "description": "Name of the region for this request." - }, - "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" - }, - "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", - "description": "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "firewallPolicy": { + "required": true, + "description": "Name of the firewall policy to which the queried rule belongs.", "type": "string", - "location": "query" + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" }, - "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])?))", + "region": { "location": "path", - "type": "string" + "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" } } }, - "get": { - "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "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": { - "resourcePolicy": { - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "resource": { "location": "path", - "description": "Name of the resource policy to retrieve." + "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.", "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])?))" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "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])?" + "type": "string", + "description": "The name of the region for this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" } - }, - "response": { - "$ref": "ResourcePolicy" - }, - "description": "Retrieves all information of the specified resource policy.", - "id": "compute.resourcePolicies.get", - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", - "parameterOrder": [ - "project", - "region", - "resourcePolicy" - ] + } }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "removeAssociation": { "parameterOrder": [ "project", "region", - "resource" + "firewallPolicy" ], - "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", + "description": "Removes an association for the specified network firewall policy.", + "id": "compute.regionNetworkFirewallPolicies.removeAssociation", "httpMethod": "POST", - "id": "compute.resourcePolicies.setIamPolicy", + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", "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.", + "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" }, - "region": { + "project": { "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." + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { - "location": "path", + "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" + }, + "requestId": { "type": "string", - "description": "Name or id of the resource 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)." + }, + "name": { + "location": "query", + "description": "Name for the association that will be removed.", + "type": "string" } }, - "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy" - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "targetSslProxies": { + "methods": { + "setSslCertificates": { "parameterOrder": [ "project", - "region", - "resource" + "targetSslProxy" ], - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "id": "compute.resourcePolicies.getIamPolicy", - "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", + "request": { + "$ref": "TargetSslProxiesSetSslCertificatesRequest" + }, "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" ], "parameters": { - "resource": { + "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}", - "description": "Name or id of the resource for this request.", "required": true, "type": "string", - "location": "path" + "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" + }, + "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": { - "required": true, + "description": "Project ID for this request.", "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])?))" }, - "optionsRequestedPolicyVersion": { + "returnPartialSuccess": { + "type": "boolean", "location": "query", - "format": "int32", - "description": "Requested IAM Policy version.", - "type": "integer" + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." }, - "region": { - "description": "The 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" + }, + "filter": { "type": "string", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" } }, - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy" - } - } - }, - "targetGrpcProxies": { - "methods": { - "insert": { - "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/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", + "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": "Operation" + "$ref": "TargetSslProxyList" }, + "parameterOrder": [ + "project" + ] + }, + "insert": { + "path": "projects/{project}/global/targetSslProxies", "request": { - "$ref": "TargetGrpcProxy" + "$ref": "TargetSslProxy" }, "parameterOrder": [ "project" ], + "flatPath": "projects/{project}/global/targetSslProxies", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.targetSslProxies.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)." - }, "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", - "description": "Project ID for this request.", - "location": "path" + "location": "query" } }, - "path": "projects/{project}/global/targetGrpcProxies", - "flatPath": "projects/{project}/global/targetGrpcProxies", - "id": "compute.targetGrpcProxies.insert", + "response": { + "$ref": "Operation" + }, + "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.", "httpMethod": "POST" }, - "patch": { + "delete": { + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "description": "Deletes the specified TargetSslProxy resource.", "parameters": { "project": { - "required": true, - "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])?))", - "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" + "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)." }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to patch.", + "targetSslProxy": { + "type": "string", "required": true, + "description": "Name of the TargetSslProxy resource to delete.", "location": "path", - "type": "string", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" } }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "id": "compute.targetGrpcProxies.patch", "parameterOrder": [ "project", - "targetGrpcProxy" + "targetSslProxy" ], - "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.", - "request": { - "$ref": "TargetGrpcProxy" - }, - "response": { - "$ref": "Operation" - }, + "id": "compute.targetSslProxies.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "PATCH" - }, - "get": { - "id": "compute.targetGrpcProxies.get", - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { - "$ref": "TargetGrpcProxy" + "$ref": "Operation" }, - "description": "Returns the specified TargetGrpcProxy resource in the given scope.", + "httpMethod": "DELETE" + }, + "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", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ], - "httpMethod": "GET", "parameterOrder": [ "project", - "targetGrpcProxy" + "targetSslProxy" ], + "httpMethod": "POST", + "request": { + "$ref": "TargetSslProxiesSetProxyHeaderRequest" + }, + "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", - "required": true, "type": "string" }, - "targetGrpcProxy": { - "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}", - "type": "string", + "targetSslProxy": { + "location": "path", "required": true, - "location": "path" + "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}" + }, + "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.targetSslProxies.setProxyHeader", + "response": { + "$ref": "Operation" } }, - "list": { - "httpMethod": "GET", - "response": { - "$ref": "TargetGrpcProxyList" - }, - "description": "Lists the TargetGrpcProxies for a project in the given scope.", + "setCertificateMap": { "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`)", - "format": "uint32", - "default": "500", - "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" - }, - "orderBy": { + "targetSslProxy": { + "required": true, "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." + "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 + "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])?))" }, - "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" } }, + "request": { + "$ref": "TargetSslProxiesSetCertificateMapRequest" + }, + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", + "httpMethod": "POST", + "description": "Changes the Certificate Map for TargetSslProxy.", + "id": "compute.targetSslProxies.setCertificateMap", "parameterOrder": [ - "project" + "project", + "targetSslProxy" ], - "flatPath": "projects/{project}/global/targetGrpcProxies", - "path": "projects/{project}/global/targetGrpcProxies", - "id": "compute.targetGrpcProxies.list", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", "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": "Operation" + } }, - "delete": { + "setBackendService": { + "request": { + "$ref": "TargetSslProxiesSetBackendServiceRequest" + }, + "id": "compute.targetSslProxies.setBackendService", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "parameterOrder": [ "project", - "targetGrpcProxy" + "targetSslProxy" ], - "id": "compute.targetGrpcProxies.delete", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", + "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).", - "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])?))", + "targetSslProxy": { "location": "path", - "required": true - }, - "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 delete.", + "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" + "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" + ] + }, + "setSslPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "description": "Deletes the specified TargetGrpcProxy in the given scope", + "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" }, - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "DELETE", - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}" - } - } - }, - "nodeTypes": { - "methods": { - "get": { - "response": { - "$ref": "NodeType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.nodeTypes.get", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone", - "nodeType" - ], + "id": "compute.targetSslProxies.setSslPolicy", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "parameters": { - "zone": { + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "The name of the zone for this request.", - "required": true + "location": "path" }, - "nodeType": { - "description": "Name of the node type to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "requestId": { "type": "string", - "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)." }, "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." + "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])?))" } }, - "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.", - "flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}" + "request": { + "$ref": "SslPolicyReference" + }, + "parameterOrder": [ + "project", + "targetSslProxy" + ] }, - "aggregatedList": { - "httpMethod": "GET", + "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" ], - "description": "Retrieves an aggregated list of node types.", - "id": "compute.nodeTypes.aggregatedList", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/nodeTypes", - "flatPath": "projects/{project}/aggregated/nodeTypes", - "response": { - "$ref": "NodeTypeAggregatedList" - }, + "httpMethod": "GET", "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", - "location": "query", - "minimum": "0" - }, "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" }, - "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": { - "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`." - }, - "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": { + "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}", "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." + "location": "path", + "required": true } - } - }, - "list": { + }, + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "response": { + "$ref": "TargetSslProxy" + }, "parameterOrder": [ "project", - "zone" - ], - "flatPath": "projects/{project}/zones/{zone}/nodeTypes", - "httpMethod": "GET", + "targetSslProxy" + ] + } + } + }, + "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": "NodeTypeList" + "$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}/global/targetGrpcProxies/{targetGrpcProxy}", + "parameterOrder": [ + "project", + "targetGrpcProxy" ], - "path": "projects/{project}/zones/{zone}/nodeTypes", - "id": "compute.nodeTypes.list", "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])?" - }, - "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", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "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", - "type": "integer", - "default": "500", - "format": "uint32", - "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])?))", + "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.", "type": "string", + "location": "path", "required": true - }, - "pageToken": { + } + }, + "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", - "description": "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": { + "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" + }, + "project": { + "description": "Project ID for this request.", + "required": true, "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." + "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": "Retrieves a list of node types available to the specified project." - } - } - }, - "targetVpnGateways": { - "methods": { + "response": { + "$ref": "Operation" + } + }, "insert": { - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", - "path": "projects/{project}/regions/{region}/targetVpnGateways", "parameterOrder": [ - "project", - "region" + "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": { - "region": { - "location": "path", - "description": "Name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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])?))", "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])?))" + "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", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" - }, - "description": "Creates a target VPN gateway 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" ], "request": { - "$ref": "TargetVpnGateway" + "$ref": "TargetGrpcProxy" }, - "httpMethod": "POST", - "id": "compute.targetVpnGateways.insert" + "id": "compute.targetGrpcProxies.insert", + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/global/targetGrpcProxies" }, - "aggregatedList": { - "httpMethod": "GET", - "id": "compute.targetVpnGateways.aggregatedList", - "description": "Retrieves an aggregated list of target VPN gateways.", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/targetVpnGateways", + "list": { "response": { - "$ref": "TargetVpnGatewayAggregatedList" + "$ref": "TargetGrpcProxyList" }, + "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": { - "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.", + "maxResults": { + "default": "500", + "format": "uint32", "location": "query", - "type": "string" + "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": { - "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" + "description": "Project ID for this request.", + "type": "string", + "location": "path", + "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" + "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" - }, - "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", - "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", - "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", + "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" } }, - "flatPath": "projects/{project}/aggregated/targetVpnGateways" + "id": "compute.targetGrpcProxies.list", + "description": "Lists the TargetGrpcProxies for a project in the given scope.", + "httpMethod": "GET", + "path": "projects/{project}/global/targetGrpcProxies" }, "get": { - "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", - "parameterOrder": [ - "project", - "region", - "targetVpnGateway" - ], + "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" ], - "id": "compute.targetVpnGateways.get", - "httpMethod": "GET", + "parameterOrder": [ + "project", + "targetGrpcProxy" + ], "parameters": { - "targetVpnGateway": { - "required": true, + "targetGrpcProxy": { "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 target VPN gateway to return." - }, - "region": { "location": "path", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request.", + "description": "Name of the TargetGrpcProxy resource to return.", "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.", + "type": "string", "location": "path", - "required": true + "required": true, + "description": "Project ID for this request." } - }, - "flatPath": "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.", - "response": { - "$ref": "TargetVpnGateway" } - }, + } + } + }, + "regionOperations": { + "methods": { "list": { "parameters": { - "pageToken": { + "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", - "description": "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" + }, + "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", + "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" + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, - "location": "path", + "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "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": { - "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" + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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": "TargetVpnGatewayList" + "$ref": "OperationList" }, + "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": "Retrieves a list of target VPN gateways available to the specified project and region.", - "path": "projects/{project}/regions/{region}/targetVpnGateways", - "id": "compute.targetVpnGateways.list", - "parameterOrder": [ - "project", - "region" - ], - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways" + "id": "compute.regionOperations.list" }, - "setLabels": { - "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "httpMethod": "POST", + "get": { + "description": "Retrieves the specified region-specific Operations resource.", "parameters": { - "project": { + "operation": { "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 Operations resource to return.", "required": true, - "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" + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" }, "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": "The region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "required": true, + "type": "string" }, - "resource": { + "project": { "type": "string", "location": "path", + "description": "Project ID for this request.", "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." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))" } }, - "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "path": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "GET", + "response": { + "$ref": "Operation" + }, + "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" - ], - "id": "compute.targetVpnGateways.setLabels", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] }, "delete": { "parameters": { - "requestId": { + "operation": { "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)." + "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." }, "region": { "required": true, - "type": "string", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request." - }, - "targetVpnGateway": { - "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 target VPN gateway to delete." + "description": "Name of the region for this request.", + "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])?))", "type": "string", - "description": "Project ID for this request." - } - }, - "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "targetVpnGateway" - ], - "response": { - "$ref": "Operation" - }, - "id": "compute.targetVpnGateways.delete", - "description": "Deletes the specified target VPN gateway." - } - } - }, - "regions": { - "methods": { - "get": { - "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": { - "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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "region": { - "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 region resource to return.", - "type": "string" + "required": true } }, - "httpMethod": "GET", + "id": "compute.regionOperations.delete", + "path": "projects/{project}/regions/{region}/operations/{operation}", + "description": "Deletes the specified region-specific Operations resource.", "parameterOrder": [ "project", - "region" + "region", + "operation" ], - "response": { - "$ref": "Region" - }, - "path": "projects/{project}/regions/{region}", - "id": "compute.regions.get", - "flatPath": "projects/{project}/regions/{region}", + "flatPath": "projects/{project}/regions/{region}/operations/{operation}", + "httpMethod": "DELETE", "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" ] }, - "list": { - "flatPath": "projects/{project}/regions", + "wait": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], + "response": { + "$ref": "Operation" + }, "parameterOrder": [ - "project" + "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": { - "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", + "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region for this request.", + "required": true, "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": "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", - "description": "Project ID for this request." + "required": true, + "type": "string" }, - "pageToken": { - "location": "query", + "operation": { + "location": "path", + "required": true, + "description": "Name of the Operations resource to return.", "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": { - "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.", - "type": "boolean", - "location": "query" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" } }, - "response": { - "$ref": "RegionList" - }, - "path": "projects/{project}/regions", - "id": "compute.regions.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.", - "httpMethod": "GET" + "id": "compute.regionOperations.wait" } } }, - "regionBackendServices": { + "snapshots": { "methods": { - "getHealth": { - "description": "Gets the most recent health check results for this regional BackendService.", - "httpMethod": "POST", + "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", - "region", - "backendService" + "snapshot" ], - "path": "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" ], - "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth", - "response": { - "$ref": "BackendServiceGroupHealth" - }, + "httpMethod": "GET", "parameters": { - "backendService": { + "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", - "description": "Name of the BackendService resource for which to get health.", + "location": "path", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + } + }, + "response": { + "$ref": "Snapshot" + }, + "path": "projects/{project}/global/snapshots/{snapshot}" + }, + "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 }, - "region": { - "description": "Name of the region 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", + "required": true, + "location": "path" + } + }, + "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." + }, + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "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, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "required": true + }, + "optionsRequestedPolicyVersion": { + "location": "query", + "type": "integer", + "description": "Requested IAM Policy version.", + "format": "int32" }, "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])?))", - "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.regionBackendServices.getHealth", - "request": { - "$ref": "ResourceGroupReference" - } + "parameterOrder": [ + "project", + "resource" + ] }, "delete": { - "id": "compute.regionBackendServices.delete", + "flatPath": "projects/{project}/global/snapshots/{snapshot}", + "id": "compute.snapshots.delete", + "parameterOrder": [ + "project", + "snapshot" + ], + "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" ], + "httpMethod": "DELETE", "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "location": "path", + "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, - "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" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" - }, - "backendService": { + } + }, + "response": { + "$ref": "Operation" + } + }, + "testIamPermissions": { + "request": { + "$ref": "TestPermissionsRequest" + }, + "parameters": { + "resource": { "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "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 BackendService resource to delete." + "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])?))", - "required": true, - "location": "path", + "type": "string", "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}/backendServices/{backendService}", - "response": { - "$ref": "Operation" - }, - "description": "Deletes the specified regional BackendService resource.", - "httpMethod": "DELETE", + "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", - "region", - "backendService" + "resource" ], - "path": "projects/{project}/regions/{region}/backendServices/{backendService}" + "httpMethod": "POST", + "description": "Returns permissions that a caller has on the specified resource.", + "response": { + "$ref": "TestPermissionsResponse" + } }, "list": { - "description": "Retrieves the list of regional BackendService resources available to the specified project in the given region.", - "id": "compute.regionBackendServices.list", "response": { - "$ref": "BackendServiceList" + "$ref": "SnapshotList" }, - "flatPath": "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" ], "parameterOrder": [ - "project", - "region" + "project" ], + "flatPath": "projects/{project}/global/snapshots", + "id": "compute.snapshots.list", + "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.", + "maxResults": { + "type": "integer", + "minimum": "0", "location": "query", - "type": "string" - }, - "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." + "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`)" }, "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.", - "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.", + "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" - }, - "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": { - "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`)", - "format": "uint32", - "location": "query" } }, - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/backendServices" + "path": "projects/{project}/global/snapshots", + "description": "Retrieves the list of Snapshot resources contained within the specified project." }, - "getIamPolicy": { - "id": "compute.regionBackendServices.getIamPolicy", - "path": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy", + "insert": { + "path": "projects/{project}/global/snapshots", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ - "project", - "region", - "resource" + "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", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ], - "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.", "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])?))" - }, - "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 + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "requestId": { "type": "string", - "description": "The name of the region for this request.", - "required": true - }, - "optionsRequestedPolicyVersion": { - "format": "int32", "location": "query", - "description": "Requested IAM Policy version.", - "type": "integer" + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "GET", - "response": { - "$ref": "Policy" - } + "flatPath": "projects/{project}/global/snapshots", + "httpMethod": "POST" }, - "update": { - "request": { - "$ref": "BackendService" - }, - "parameterOrder": [ - "project", - "region", - "backendService" - ], - "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", + "setIamPolicy": { "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 - }, - "region": { - "location": "path", - "description": "Name of the region scoping this request.", + "description": "Project ID for this request.", "type": "string", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "required": true }, - "backendService": { + "resource": { + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "type": "string", - "description": "Name of the BackendService resource to update.", - "required": true, - "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" + "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" ], - "response": { - "$ref": "Operation" + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "id": "compute.snapshots.setIamPolicy", + "httpMethod": "POST", + "request": { + "$ref": "GlobalSetPolicyRequest" }, - "httpMethod": "PUT", - "path": "projects/{project}/regions/{region}/backendServices/{backendService}", - "id": "compute.regionBackendServices.update", - "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview ." - }, - "patch": { - "flatPath": "projects/{project}/regions/{region}/backendServices/{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.", - "id": "compute.regionBackendServices.patch", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "PATCH", "response": { - "$ref": "Operation" + "$ref": "Policy" }, + "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy", "parameterOrder": [ "project", - "region", - "backendService" + "resource" ], - "path": "projects/{project}/regions/{region}/backendServices/{backendService}", + "flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy" + } + } + }, + "nodeTypes": { + "methods": { + "get": { "parameters": { - "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." - }, - "backendService": { - "required": true, - "location": "path", + "nodeType": { "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string", - "description": "Name of the BackendService resource to patch." - }, - "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "Name of the node type to return.", "type": "string" - } - }, - "request": { - "$ref": "BackendService" - } - }, - "insert": { - "path": "projects/{project}/regions/{region}/backendServices", - "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.", "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": { - "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" } }, - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "BackendService" - }, + "id": "compute.nodeTypes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "id": "compute.regionBackendServices.insert", - "parameterOrder": [ - "project", - "region" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], - "flatPath": "projects/{project}/regions/{region}/backendServices", - "description": "Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview." - }, - "get": { - "id": "compute.regionBackendServices.get", "response": { - "$ref": "BackendService" + "$ref": "NodeType" }, + "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", - "region", - "backendService" + "zone", + "nodeType" ], - "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", + "flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}" + }, + "aggregatedList": { "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 regional BackendService resource.", - "httpMethod": "GET", + "description": "Retrieves an aggregated list of node types.", "parameters": { - "region": { - "description": "Name of the region scoping this request.", - "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", + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`." }, - "backendService": { + "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", - "required": true, - "description": "Name of the BackendService resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + "description": "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.", - "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])?))", + "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" } }, - "path": "projects/{project}/regions/{region}/backendServices/{backendService}" - }, - "setIamPolicy": { + "httpMethod": "GET", "response": { - "$ref": "Policy" + "$ref": "NodeTypeAggregatedList" }, - "id": "compute.regionBackendServices.setIamPolicy", - "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" - ], "parameterOrder": [ - "project", - "region", - "resource" + "project" ], - "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", - "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "httpMethod": "POST", + "id": "compute.nodeTypes.aggregatedList", + "path": "projects/{project}/aggregated/nodeTypes", + "flatPath": "projects/{project}/aggregated/nodeTypes" + }, + "list": { + "flatPath": "projects/{project}/zones/{zone}/nodeTypes", + "description": "Retrieves a list of node types available to the specified project.", "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, + "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": { - "type": "string", - "description": "The name of the region for this request.", + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "type": "string" }, - "resource": { + "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": { + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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-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" + }, + "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." + }, + "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" } - } - } - } - }, - "networks": { - "methods": { - "addPeering": { + }, + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "description": "Adds a peering to the specified network.", - "path": "projects/{project}/global/networks/{network}/addPeering", "parameterOrder": [ "project", - "network" + "zone" ], + "httpMethod": "GET", + "id": "compute.nodeTypes.list", + "response": { + "$ref": "NodeTypeList" + } + } + } + }, + "backendBuckets": { + "methods": { + "addSignedUrlKey": { "httpMethod": "POST", - "id": "compute.networks.addPeering", - "flatPath": "projects/{project}/global/networks/{network}/addPeering", "response": { "$ref": "Operation" }, - "request": { - "$ref": "NetworksAddPeeringRequest" - }, "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 - }, - "network": { "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 network resource to add peering to." + "location": "path" }, "requestId": { - "type": "string", "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)." + }, + "backendBucket": { + "required": true, + "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" } - } + }, + "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" + }, + "parameterOrder": [ + "project", + "backendBucket" + ] }, - "updatePeering": { - "path": "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.", - "id": "compute.networks.updatePeering", + "delete": { + "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], + "id": "compute.backendBuckets.delete", + "httpMethod": "DELETE", "parameterOrder": [ "project", - "network" + "backendBucket" ], - "httpMethod": "PATCH", + "response": { + "$ref": "Operation" + }, + "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": { - "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).", + "location": "query", "type": "string" }, - "network": { + "backendBucket": { "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the network resource which the updated peering is belonging to.", "required": true, + "description": "Name of the BackendBucket resource to delete.", "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])?))", - "location": "path", - "type": "string", - "required": true } - }, - "request": { - "$ref": "NetworksUpdatePeeringRequest" - }, - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/networks/{network}/updatePeering" + } }, - "removePeering": { + "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", + "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.", + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", + "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" }, - "network": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the network resource to remove peering from.", - "location": "path", - "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" } }, - "description": "Removes a peering from the specified network.", - "path": "projects/{project}/global/networks/{network}/removePeering", "response": { - "$ref": "Operation" + "$ref": "BackendBucketList" }, - "flatPath": "projects/{project}/global/networks/{network}/removePeering", + "id": "compute.backendBuckets.list", + "path": "projects/{project}/global/backendBuckets", + "parameterOrder": [ + "project" + ], + "httpMethod": "GET" + }, + "insert": { + "id": "compute.backendBuckets.insert", "request": { - "$ref": "NetworksRemovePeeringRequest" + "$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", - "network" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "project" ], "httpMethod": "POST", - "id": "compute.networks.removePeering" - }, - "get": { "response": { - "$ref": "Network" + "$ref": "Operation" }, - "parameterOrder": [ - "project", - "network" - ], - "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" - ], - "path": "projects/{project}/global/networks/{network}", - "description": "Returns the specified network. Gets a list of available networks by making a list() request.", "parameters": { - "network": { - "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 of the network to return." - }, "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": "Project ID for this request." + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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/networks/{network}", - "httpMethod": "GET" - }, - "switchToCustomMode": { - "parameterOrder": [ - "project", - "network" - ], - "id": "compute.networks.switchToCustomMode", - "path": "projects/{project}/global/networks/{network}/switchToCustomMode", - "flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode", + "flatPath": "projects/{project}/global/backendBuckets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", + ] + }, + "get": { "parameters": { - "network": { + "project": { + "description": "Project ID for this request.", "required": true, - "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}", - "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" + "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])?))" }, - "project": { + "backendBucket": { "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])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "type": "string", "location": "path", - "type": "string" + "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": { - "$ref": "Operation" - }, - "description": "Switches the network mode from auto subnet mode to custom subnet mode." - }, - "list": { - "id": "compute.networks.list", - "response": { - "$ref": "NetworkList" + "$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" - ], - "path": "projects/{project}/global/networks", + ] + }, + "deleteSignedUrlKey": { + "description": "Deletes a key for validating requests with signed URLs for this backend bucket.", + "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", "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": { + "keyName": { + "description": "The name of the Signed URL Key to delete.", "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.", + "required": true, "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`.", + "backendBucket": { + "required": true, "type": "string", - "location": "query" + "location": "path", + "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035." }, - "maxResults": { - "format": "uint32", + "requestId": { + "type": "string", "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`)" + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "location": "path" } }, - "flatPath": "projects/{project}/global/networks", - "description": "Retrieves the list of networks available to the specified project.", - "httpMethod": "GET", "parameterOrder": [ - "project" - ] + "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" }, - "delete": { - "description": "Deletes the specified network.", + "patch": { + "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/global/networks/{network}", "response": { "$ref": "Operation" }, - "httpMethod": "DELETE", - "id": "compute.networks.delete", "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.", + "type": "string" + }, "requestId": { - "location": "query", "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)." }, - "network": { - "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 network to delete." - }, "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])?))", - "required": true + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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/networks/{network}", - "parameterOrder": [ - "project", - "network" - ] - }, - "listPeeringRoutes": { + "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", - "network" - ], - "path": "projects/{project}/global/networks/{network}/listPeeringRoutes", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "backendBucket" ], + "id": "compute.backendBuckets.patch", + "request": { + "$ref": "BackendBucket" + } + }, + "setEdgeSecurityPolicy": { + "httpMethod": "POST", "parameters": { - "orderBy": { + "requestId": { "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query" }, - "direction": { - "description": "The direction of the exchanged routes.", - "type": "string", - "enum": [ - "INCOMING", - "OUTGOING" - ], - "location": "query", - "enumDescriptions": [ - "For routes exported from peer network.", - "For routes exported from local network." - ] - }, - "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", - "location": "query", - "description": "The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region." - }, "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", - "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`." + "description": "Project ID for this request." }, - "network": { - "description": "Name of the network 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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true - }, - "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`)" - }, - "peeringName": { - "description": "The response will show routes exchanged over the given peering connection.", - "location": "query", - "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" + "location": "path" } }, "response": { - "$ref": "ExchangedPeeringRoutesList" + "$ref": "Operation" }, - "description": "Lists the peering routes exchanged over peering connection.", - "id": "compute.networks.listPeeringRoutes", - "flatPath": "projects/{project}/global/networks/{network}/listPeeringRoutes" + "parameterOrder": [ + "project", + "backendBucket" + ], + "id": "compute.backendBuckets.setEdgeSecurityPolicy", + "request": { + "$ref": "SecurityPolicyReference" + }, + "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" + ] }, - "getEffectiveFirewalls": { - "flatPath": "projects/{project}/global/networks/{network}/getEffectiveFirewalls", + "update": { + "id": "compute.backendBuckets.update", + "request": { + "$ref": "BackendBucket" + }, + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/global/backendBuckets/{backendBucket}", + "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "parameters": { - "network": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "Name of the network 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", - "required": true + "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" } }, + "parameterOrder": [ + "project", + "backendBucket" + ], "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" ], - "path": "projects/{project}/global/networks/{network}/getEffectiveFirewalls", - "id": "compute.networks.getEffectiveFirewalls", - "description": "Returns the effective firewalls on a given network.", + "description": "Updates the specified BackendBucket resource with the data included in the request.", + "httpMethod": "PUT" + } + } + }, + "instanceGroups": { + "methods": { + "setNamedPorts": { "parameterOrder": [ "project", - "network" + "zone", + "instanceGroup" ], - "httpMethod": "GET", - "response": { - "$ref": "NetworksGetEffectiveFirewallsResponse" - } - }, - "insert": { - "httpMethod": "POST", - "id": "compute.networks.insert", - "request": { - "$ref": "Network" - }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", "response": { "$ref": "Operation" }, - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/global/networks", + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", "parameters": { - "project": { - "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" + }, + "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])?))", - "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" + "instanceGroup": { + "location": "path", + "description": "The name of the instance group where the named ports are updated.", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/networks", + "id": "compute.instanceGroups.setNamedPorts", + "httpMethod": "POST", + "description": "Sets the named ports for the specified instance group.", + "request": { + "$ref": "InstanceGroupsSetNamedPortsRequest" + } + }, + "insert": { + "request": { + "$ref": "InstanceGroup" + }, "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." - }, - "patch": { - "parameterOrder": [ - "project", - "network" - ], - "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])?))", + "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" }, - "network": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the network to update.", - "location": "path", + "zone": { "type": "string", - "required": true + "required": true, + "location": "path", + "description": "The name of the zone where you want to create the 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).", - "location": "query" + "type": "string" } }, - "httpMethod": "PATCH", - "path": "projects/{project}/global/networks/{network}", - "id": "compute.networks.patch", - "request": { - "$ref": "Network" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/networks/{network}", - "description": "Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode." - } - } - }, - "regionInstanceGroups": { - "methods": { - "list": { + "flatPath": "projects/{project}/zones/{zone}/instanceGroups", + "httpMethod": "POST", "parameterOrder": [ "project", - "region" + "zone" ], - "id": "compute.regionInstanceGroups.list", - "description": "Retrieves the list of instance group resources contained within the specified region.", + "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": "RegionInstanceGroupList" - }, + "$ref": "Operation" + } + }, + "list": { "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": { - "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": { - "type": "string", - "location": "path", - "description": "Name of the region scoping this request.", - "required": true - }, "maxResults": { - "minimum": "0", "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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`.", - "type": "string", + "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.", - "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])?))" + "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" } }, - "path": "projects/{project}/regions/{region}/instanceGroups", - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/instanceGroups", + "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" - ] + ], + "parameterOrder": [ + "project", + "zone" + ], + "httpMethod": "GET", + "response": { + "$ref": "InstanceGroupList" + }, + "flatPath": "projects/{project}/zones/{zone}/instanceGroups", + "id": "compute.instanceGroups.list", + "path": "projects/{project}/zones/{zone}/instanceGroups" }, "listInstances": { - "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", - "id": "compute.regionInstanceGroups.listInstances", + "response": { + "$ref": "InstanceGroupsListInstances" + }, + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", + "httpMethod": "POST", "parameterOrder": [ "project", - "region", + "zone", "instanceGroup" ], + "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": { - "instanceGroup": { - "description": "Name of the regional instance group for which we want to list the instances.", + "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", - "required": true, - "location": "path" + "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": { + "location": "path", + "type": "string", + "description": "The name of the zone where the instance group is located.", + "required": true }, - "returnPartialSuccess": { + "filter": { "location": "query", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "type": "boolean" + "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." + "description": "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, - "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])?))" }, - "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`.", + "instanceGroup": { "type": "string", - "location": "query" + "required": true, + "description": "The name of the instance group from which you want to generate a list of included instances.", + "location": "path" }, - "region": { - "type": "string", - "description": "Name of the region scoping this request.", - "location": "path", - "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" }, - "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.", + "maxResults": { + "format": "uint32", "location": "query", - "type": "string" + "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`)" } }, - "response": { - "$ref": "RegionInstanceGroupsListInstances" - }, - "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", - "httpMethod": "POST", - "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.", - "request": { - "$ref": "RegionInstanceGroupsListInstancesRequest" - }, + "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" - ] + ], + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances" }, - "setNamedPorts": { - "id": "compute.regionInstanceGroups.setNamedPorts", - "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", - "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", - "request": { - "$ref": "RegionInstanceGroupsSetNamedPortsRequest" + "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" }, - "httpMethod": "POST", - "description": "Sets the named ports for the specified regional instance group.", "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", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "instanceGroup": { - "description": "The name of the regional instance group where the named ports are updated.", - "location": "path", "type": "string", - "required": true + "description": "Project ID for this request." }, - "region": { - "location": "path", + "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, - "description": "Name of the region scoping this request." + "type": "string", + "description": "The name of the instance group to delete.", + "location": "path" } }, + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", + "httpMethod": "DELETE", + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "parameterOrder": [ "project", - "region", + "zone", "instanceGroup" ], - "response": { - "$ref": "Operation" - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] + ], + "id": "compute.instanceGroups.delete" }, - "get": { - "httpMethod": "GET", + "addInstances": { + "id": "compute.instanceGroups.addInstances", "parameters": { - "region": { + "zone": { "location": "path", "required": true, - "description": "Name of the region scoping this request.", - "type": "string" - }, - "instanceGroup": { "type": "string", - "description": "Name of the instance group resource to return.", - "location": "path", - "required": true + "description": "The name of the zone where the instance group is located." }, "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])?))", - "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" + }, + "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" + ], "parameterOrder": [ "project", - "region", + "zone", "instanceGroup" ], - "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}", - "id": "compute.regionInstanceGroups.get", + "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" + }, + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", + "response": { + "$ref": "Operation" + } + }, + "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", + "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." + }, + "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." + } + }, + "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" ], - "description": "Returns the specified instance group resource.", - "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}", "response": { - "$ref": "InstanceGroup" + "$ref": "InstanceGroupAggregatedList" } - } - } - }, - "targetHttpsProxies": { - "methods": { + }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], - "id": "compute.targetHttpsProxies.get", "httpMethod": "GET", "response": { - "$ref": "TargetHttpsProxy" + "$ref": "InstanceGroup" }, - "description": "Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.", - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "parameterOrder": [ "project", - "targetHttpsProxy" + "zone", + "instanceGroup" ], + "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "parameters": { - "project": { - "required": true, - "description": "Project ID for this request.", + "instanceGroup": { "type": "string", + "required": true, + "description": "The name of the instance group.", + "location": "path" + }, + "zone": { + "required": true, + "description": "The name of the zone where the instance group is located.", "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" }, - "targetHttpsProxy": { + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Name of the TargetHttpsProxy resource to return.", "type": "string", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + "description": "Project ID for this request.", + "required": true } }, - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}" + "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." }, - "setQuicOverride": { + "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": { - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", - "required": true, + "instanceGroup": { + "type": "string", "location": "path", - "type": "string" + "description": "The name of the instance group where the specified instances will be removed.", + "required": true }, - "project": { + "zone": { + "location": "path", "type": "string", "required": true, - "location": "path", + "description": "The name of the zone where the instance group is located." + }, + "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", + "description": "Project ID 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" + } + }, + "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" + } + } + } + }, + "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" ], - "description": "Sets the QUIC override policy for TargetHttpsProxy.", + "parameterOrder": [ + "project", + "region" + ], + "path": "projects/{project}/regions/{region}/autoscalers", "request": { - "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" - }, - "response": { - "$ref": "Operation" + "$ref": "Autoscaler" }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", - "id": "compute.targetHttpsProxies.setQuicOverride", + "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" + }, + "list": { "parameterOrder": [ "project", - "targetHttpsProxy" + "region" ], - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride" - }, - "list": { - "flatPath": "projects/{project}/global/targetHttpsProxies", - "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", + "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": "TargetHttpsProxyList" + "$ref": "RegionAutoscalerList" }, + "description": "Retrieves a list of autoscalers contained within the specified region.", + "path": "projects/{project}/regions/{region}/autoscalers", "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.", - "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." }, - "project": { + "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": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-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 region scoping this request.", "type": "string", - "location": "path" + "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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.", + "project": { "type": "string", - "location": "query" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 }, - "maxResults": { + "pageToken": { + "type": "string", "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", - "minimum": "0" + "description": "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", + "orderBy": { + "type": "string", "location": "query", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported." } - }, - "id": "compute.targetHttpsProxies.list", - "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" - ] + } }, - "setCertificateMap": { - "httpMethod": "POST", - "request": { - "$ref": "TargetHttpsProxiesSetCertificateMapRequest" - }, + "get": { + "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", + "httpMethod": "GET", "parameters": { - "project": { - "type": "string", - "required": true, + "region": { + "description": "Name of the region 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])?))", - "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).", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "targetHttpsProxy": { + "project": { + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 + }, + "autoscaler": { + "description": "Name of the autoscaler to return.", + "location": "path", "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.", "required": true, - "location": "path" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" } }, - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", - "description": "Changes the Certificate Map for TargetHttpsProxy.", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "autoscaler" ], - "id": "compute.targetHttpsProxies.setCertificateMap", - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", + "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" - ] - }, - "setSslCertificates": { - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "parameterOrder": [ - "project", - "targetHttpsProxy" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ], + "response": { + "$ref": "Autoscaler" + } + }, + "delete": { "parameters": { - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", + "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", - "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", - "description": "Project ID for this request." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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).", "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}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "description": "Replaces SslCertificates for TargetHttpsProxy.", + "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" ], - "request": { - "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" - }, - "id": "compute.targetHttpsProxies.setSslCertificates", - "httpMethod": "POST", + "parameterOrder": [ + "project", + "region", + "autoscaler" + ], + "id": "compute.regionAutoscalers.delete", "response": { "$ref": "Operation" } }, - "setSslPolicy": { - "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.", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", - "id": "compute.targetHttpsProxies.setSslPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "SslPolicyReference" - }, - "parameterOrder": [ - "project", - "targetHttpsProxy" - ], - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "patch": { + "flatPath": "projects/{project}/regions/{region}/autoscalers", "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])?))", + "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": "path", - "description": "Project ID for this request." + "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)." }, - "targetHttpsProxy": { - "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.", + "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" } - } - }, - "delete": { + }, + "request": { + "$ref": "Autoscaler" + }, "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" + }, + "update": { "response": { "$ref": "Operation" }, + "path": "projects/{project}/regions/{region}/autoscalers", + "httpMethod": "PUT", + "request": { + "$ref": "Autoscaler" + }, + "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" + ], + "parameterOrder": [ + "project", + "region" + ], + "flatPath": "projects/{project}/regions/{region}/autoscalers", "parameters": { - "targetHttpsProxy": { - "location": "path", - "required": true, - "description": "Name of the TargetHttpsProxy resource 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" + }, + "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}" }, - "project": { + "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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}/global/targetHttpsProxies/{targetHttpsProxy}", - "id": "compute.targetHttpsProxies.delete", - "description": "Deletes the specified TargetHttpsProxy resource.", - "parameterOrder": [ - "project", - "targetHttpsProxy" - ], - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", - "httpMethod": "DELETE" - }, - "insert": { - "request": { - "$ref": "TargetHttpsProxy" - }, - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.insert", - "path": "projects/{project}/global/targetHttpsProxies", - "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" + "required": true, + "description": "Project ID for this request." } - }, - "flatPath": "projects/{project}/global/targetHttpsProxies", + } + } + } + }, + "regionHealthChecks": { + "methods": { + "delete": { + "id": "compute.regionHealthChecks.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request." - }, - "patch": { - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, - "id": "compute.targetHttpsProxies.patch", + "parameterOrder": [ + "project", + "region", + "healthCheck" + ], + "description": "Deletes the specified HealthCheck resource.", + "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).", + "location": "query", "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)." }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to patch.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "project": { "type": "string", "required": true, - "location": "path" + "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])?))" }, - "project": { + "region": { "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 region scoping this request.", "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "healthCheck": { "type": "string", - "description": "Project ID for this request." + "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 } }, - "parameterOrder": [ - "project", - "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.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", - "request": { - "$ref": "TargetHttpsProxy" - }, - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", + "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}" }, - "aggregatedList": { - "flatPath": "projects/{project}/aggregated/targetHttpsProxies", - "response": { - "$ref": "TargetHttpsProxyAggregatedList" - }, + "list": { "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], "parameterOrder": [ - "project" + "project", + "region" ], - "id": "compute.targetHttpsProxies.aggregatedList", - "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.", - "path": "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" - }, - "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", - "format": "uint32", - "minimum": "0", - "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])?))", + "required": true, "type": "string", "location": "path", - "required": true, - "description": "Name of the project scoping this request." + "description": "Project ID for this request." }, - "pageToken": { + "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 + }, + "filter": { "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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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`.", + "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" } }, - "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}/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." }, - "setUrlMap": { + "update": { + "response": { + "$ref": "Operation" + }, "request": { - "$ref": "UrlMapReference" + "$ref": "HealthCheck" }, - "parameterOrder": [ - "project", - "targetHttpsProxy" - ], + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" + "location": "path" }, - "targetHttpsProxy": { + "healthCheck": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, - "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", + "description": "Name of the HealthCheck resource to update.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "type": "string" + }, + "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." } }, - "response": { - "$ref": "Operation" - }, - "id": "compute.targetHttpsProxies.setUrlMap", - "description": "Changes the URL map for TargetHttpsProxy.", + "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" - ], - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "httpMethod": "POST" - } - } - }, - "regionDiskTypes": { - "methods": { - "list": { - "response": { - "$ref": "RegionDiskTypeList" + ] + }, + "insert": { + "request": { + "$ref": "HealthCheck" }, - "id": "compute.regionDiskTypes.list", "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", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ], - "description": "Retrieves a list of regional disk types available to the specified project.", - "flatPath": "projects/{project}/regions/{region}/diskTypes", - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/diskTypes", + "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])?))", - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "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" - }, - "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." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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, "location": "path", - "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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" + "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" } + }, + "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": "DiskType" + "$ref": "HealthCheck" }, - "flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}", - "httpMethod": "GET", - "id": "compute.regionDiskTypes.get", - "path": "projects/{project}/regions/{region}/diskTypes/{diskType}", + "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" ], - "parameterOrder": [ - "project", - "region", - "diskType" - ], "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", + "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" }, - "diskType": { - "description": "Name of the disk type to return.", + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true + } + } + }, + "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" }, - "region": { + "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, + "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": "The name of the region for this request.", + "location": "query" + }, + "region": { + "location": "path", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string", + "description": "Name of the region scoping this request." } }, - "description": "Returns the specified regional disk type. Gets a list of available disk types by making a list() request." - } - } - }, - "regionInstances": { - "methods": { - "bulkInsert": { + "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." + } + } + }, + "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" + }, "parameters": { "region": { "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request.", + "type": "string", "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])?))", - "description": "Project ID for this request.", "required": true, - "location": "path", - "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" + "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" ], - "path": "projects/{project}/regions/{region}/instances/bulkInsert", - "httpMethod": "POST", - "description": "Creates multiple instances in a given region. Count specifies the number of instances to create.", - "flatPath": "projects/{project}/regions/{region}/instances/bulkInsert", - "request": { - "$ref": "BulkInsertInstanceResource" - }, - "id": "compute.regionInstances.bulkInsert", + "id": "compute.regionNotificationEndpoints.insert", + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "response": { "$ref": "Operation" - } - } - } - }, - "interconnectAttachments": { - "methods": { - "list": { - "httpMethod": "GET", - "description": "Retrieves the list of interconnect attachments contained within the specified region.", - "response": { - "$ref": "InterconnectAttachmentList" }, - "path": "projects/{project}/regions/{region}/interconnectAttachments", + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.interconnectAttachments.list", - "flatPath": "projects/{project}/regions/{region}/interconnectAttachments", + "https://www.googleapis.com/auth/compute" + ] + }, + "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" + ], + "response": { + "$ref": "NotificationEndpointList" + }, + "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/regions/{region}/notificationEndpoints", + "description": "Lists the NotificationEndpoints for a project in the given region.", "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, + "region": { "type": "string", - "location": "path" + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-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`)", - "default": "500", - "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" + }, + "filter": { + "type": "string", "location": "query", - "format": "uint32", - "minimum": "0" + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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." }, - "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", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "type": "boolean" }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true, + "project": { "type": "string", - "description": "Name of the region for this request." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { - "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", + "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" } } }, - "insert": { - "id": "compute.interconnectAttachments.insert", + "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" ], - "httpMethod": "POST", - "parameterOrder": [ - "project", - "region" - ], - "request": { - "$ref": "InterconnectAttachment" + "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" }, - "flatPath": "projects/{project}/regions/{region}/interconnectAttachments", - "description": "Creates an InterconnectAttachment in the specified project 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)." - }, - "region": { - "type": "string", - "description": "Name of the region for this request.", - "location": "path", + "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, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "validateOnly": { - "location": "query", - "type": "boolean", - "description": "If true, the request will not be committed." + "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", - "description": "Project ID for this request." + "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" } - }, - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/interconnectAttachments" + } }, "get": { - "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", - "response": { - "$ref": "InterconnectAttachment" - }, - "description": "Returns the specified interconnect attachment.", - "flatPath": "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" - ], "httpMethod": "GET", - "id": "compute.interconnectAttachments.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." - }, "region": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region scoping this request.", "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 }, - "interconnectAttachment": { - "required": true, - "description": "Name of the interconnect attachment 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])?))", + "location": "path", + "description": "Project ID for this request.", "type": "string", + "required": true + }, + "notificationEndpoint": { "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + "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" } }, + "id": "compute.regionNotificationEndpoints.get", + "description": "Returns the specified NotificationEndpoint resource in the given region.", + "response": { + "$ref": "NotificationEndpoint" + }, "parameterOrder": [ "project", "region", - "interconnectAttachment" - ] - }, - "aggregatedList": { + "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}" + } + } + }, + "machineImages": { + "methods": { + "get": { + "response": { + "$ref": "MachineImage" + }, "parameterOrder": [ - "project" + "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": { - "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": { - "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", - "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", - "description": "Project ID for this request." - }, - "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`)" - }, - "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", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" }, - "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" + "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" } }, - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/interconnectAttachments", - "response": { - "$ref": "InterconnectAttachmentAggregatedList" - }, - "path": "projects/{project}/aggregated/interconnectAttachments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.interconnectAttachments.aggregatedList", - "description": "Retrieves an aggregated list of interconnect attachments." + ] }, - "setLabels": { - "id": "compute.interconnectAttachments.setLabels", - "path": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels", + "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", - "description": "Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.", + "id": "compute.machineImages.testIamPermissions", "request": { - "$ref": "RegionSetLabelsRequest" + "$ref": "TestPermissionsRequest" }, "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" - }, "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string", - "required": true - }, - "region": { - "description": "The region for 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.", + "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" } }, - "response": { - "$ref": "Operation" - }, + "flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions", "parameterOrder": [ "project", - "region", "resource" ], + "response": { + "$ref": "TestPermissionsResponse" + }, + "description": "Returns permissions that a caller has on the specified resource." + }, + "insert": { + "request": { + "$ref": "MachineImage" + }, + "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" ], - "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels" - }, - "delete": { - "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", - "description": "Deletes the specified interconnect attachment.", - "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + "httpMethod": "POST", + "flatPath": "projects/{project}/global/machineImages", + "path": "projects/{project}/global/machineImages", "parameterOrder": [ - "project", - "region", - "interconnectAttachment" + "project" ], + "response": { + "$ref": "Operation" + }, "parameters": { - "interconnectAttachment": { - "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 attachment to delete.", - "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])?))", "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 for this request.", - "required": true, - "pattern": "[a-z](?:[-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).", "type": "string", + "location": "query" + }, + "sourceInstance": { "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": "Required. Source instance that is used to create the machine image from." } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.interconnectAttachments.delete", + "id": "compute.machineImages.insert" + }, + "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" - } - }, - "patch": { - "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "httpMethod": "PATCH", - "request": { - "$ref": "InterconnectAttachment" - }, - "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}/global/machineImages/{machineImage}", "parameters": { - "region": { - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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" }, "requestId": { @@ -41535,583 +29154,483 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" - }, - "interconnectAttachment": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "machineImage": { "type": "string", "location": "path", - "required": true, - "description": "Name of the interconnect attachment to patch." + "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 } - }, - "parameterOrder": [ - "project", - "region", - "interconnectAttachment" - ], + } + }, + "setIamPolicy": { + "httpMethod": "POST", + "path": "projects/{project}/global/machineImages/{resource}/setIamPolicy", "response": { - "$ref": "Operation" + "$ref": "Policy" }, - "id": "compute.interconnectAttachments.patch", - "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}" - } - } - }, - "backendBuckets": { - "methods": { - "setEdgeSecurityPolicy": { - "id": "compute.backendBuckets.setEdgeSecurityPolicy", - "parameterOrder": [ - "project", - "backendBucket" - ], "request": { - "$ref": "SecurityPolicyReference" + "$ref": "GlobalSetPolicyRequest" }, - "path": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "parameterOrder": [ + "project", + "resource" ], - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy", - "httpMethod": "POST", + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", "parameters": { - "backendBucket": { - "location": "path", - "type": "string", - "required": true, - "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035." - }, - "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 + }, + "resource": { "required": true, + "location": "path", "type": "string", - "description": "Project ID for this request." + "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 edge security policy for the specified backend bucket." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "id": "compute.machineImages.setIamPolicy", + "flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy" }, "list": { - "description": "Retrieves the list of BackendBucket resources available to the specified project.", - "parameterOrder": [ - "project" + "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" ], - "httpMethod": "GET", - "response": { - "$ref": "BackendBucketList" - }, - "path": "projects/{project}/global/backendBuckets", - "id": "compute.backendBuckets.list", + "description": "Retrieves a list of machine images that are contained within the specified project.", "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", - "type": "integer", "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" }, - "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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" - } - }, - "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" - }, - "delete": { - "description": "Deletes the specified BackendBucket 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" - }, - "backendBucket": { - "location": "path", - "type": "string", - "description": "Name of the BackendBucket resource to delete.", - "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.", "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])?))" + "required": true } }, - "path": "projects/{project}/global/backendBuckets/{backendBucket}", - "response": { - "$ref": "Operation" - }, - "httpMethod": "DELETE", + "httpMethod": "GET", "parameterOrder": [ - "project", - "backendBucket" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "project" ], - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", - "id": "compute.backendBuckets.delete" + "id": "compute.machineImages.list", + "response": { + "$ref": "MachineImageList" + } }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/backendBuckets", + "getIamPolicy": { "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).", + "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, - "type": "string" + "required": true } }, - "flatPath": "projects/{project}/global/backendBuckets", "parameterOrder": [ - "project" + "project", + "resource" ], - "id": "compute.backendBuckets.insert", - "httpMethod": "POST", - "request": { - "$ref": "BackendBucket" - }, + "path": "projects/{project}/global/machineImages/{resource}/getIamPolicy", "response": { - "$ref": "Operation" + "$ref": "Policy" }, - "description": "Creates a BackendBucket resource in the specified project using the data included in the request." - }, - "get": { - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "httpMethod": "GET", - "path": "projects/{project}/global/backendBuckets/{backendBucket}", + "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" + } + } + }, + "instanceGroupManagers": { + "methods": { + "listPerInstanceConfigs": { + "httpMethod": "POST", "parameterOrder": [ "project", - "backendBucket" + "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": { - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "path", - "required": true, - "description": "Project ID for this request." + "location": "query" }, - "backendBucket": { + "zone": { "required": true, + "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the BackendBucket resource to return.", "location": "path" - } - }, - "response": { - "$ref": "BackendBucket" - }, - "id": "compute.backendBuckets.get", - "description": "Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request." - }, - "addSignedUrlKey": { - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey", - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "parameters": { + }, "project": { - "type": "string", - "location": "path", "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])?))" }, - "backendBucket": { + "instanceGroupManager": { "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." + "description": "The name of the managed instance group. It should conform to RFC1035." }, - "requestId": { - "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", - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "Adds a key for validating requests with signed URLs for this backend bucket.", - "id": "compute.backendBuckets.addSignedUrlKey", - "parameterOrder": [ - "project", - "backendBucket" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "SignedUrlKey" - }, - "path": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey" - }, - "update": { - "request": { - "$ref": "BackendBucket" - }, - "path": "projects/{project}/global/backendBuckets/{backendBucket}", - "id": "compute.backendBuckets.update", - "parameters": { - "backendBucket": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the BackendBucket resource to update.", - "type": "string", - "required": true, - "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])?))" + "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" }, - "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": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "backendBucket" - ], - "description": "Updates the specified BackendBucket resource with the data included in the request.", - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", - "response": { - "$ref": "Operation" - }, + } + }, + "setTargetPools": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "httpMethod": "PUT" - }, - "patch": { - "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.", - "request": { - "$ref": "BackendBucket" + "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" }, - "path": "projects/{project}/global/backendBuckets/{backendBucket}", + "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": { - "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).", + "location": "query", "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])?))", "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])?))", + "required": true }, - "backendBucket": { - "required": true, - "type": "string", + "zone": { "location": "path", - "description": "Name of the BackendBucket resource to patch.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + "type": "string", + "description": "The name of the zone where the managed instance group is located.", + "required": true } }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.backendBuckets.patch", - "parameterOrder": [ - "project", - "backendBucket" - ], - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", - "httpMethod": "PATCH" - }, - "deleteSignedUrlKey": { - "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", - "id": "compute.backendBuckets.deleteSignedUrlKey", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "backendBucket", - "keyName" - ], "httpMethod": "POST", - "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", + "request": { + "$ref": "InstanceGroupManagersSetTargetPoolsRequest" + } + }, + "deleteInstances": { "parameters": { - "backendBucket": { - "type": "string", - "location": "path", + "zone": { "required": true, - "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035." + "location": "path", + "description": "The name of the zone where the managed instance group is located.", + "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", - "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)." }, - "keyName": { - "required": true, + "instanceGroupManager": { "type": "string", - "location": "query", - "description": "The name of the Signed URL Key to delete." + "required": true, + "description": "The name of the managed instance group.", + "location": "path" }, "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." + "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": "Deletes a key for validating requests with signed URLs for this backend bucket.", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "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" - } - } - } - }, - "regionTargetTcpProxies": { - "methods": { - "get": { + }, + "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", - "https://www.googleapis.com/auth/compute.readonly" - ], - "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", - "id": "compute.regionTargetTcpProxies.get", - "description": "Returns the specified TargetTcpProxy resource.", - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", + "https://www.googleapis.com/auth/compute" + ] + }, + "deletePerInstanceConfigs": { + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "project", - "region", - "targetTcpProxy" + "zone", + "instanceGroupManager" ], - "response": { - "$ref": "TargetTcpProxy" - }, "parameters": { - "targetTcpProxy": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "instanceGroupManager": { + "required": true, "type": "string", - "description": "Name of the TargetTcpProxy resource to return.", - "location": "path", - "required": true + "description": "The name of the managed instance group. It should conform to RFC1035.", + "location": "path" }, - "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])?))", + "zone": { "location": "path", - "required": true + "required": true, + "type": "string", + "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035." }, - "region": { + "project": { "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." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" + ] }, - "delete": { - "description": "Deletes the specified TargetTcpProxy resource.", + "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" ], - "httpMethod": "DELETE", "parameterOrder": [ "project", - "region", - "targetTcpProxy" + "zone", + "instanceGroupManager" ], + "flatPath": "projects/{project}/zones/{zone}/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).", - "type": "string", - "location": "query" - }, - "targetTcpProxy": { - "location": "path", - "description": "Name of the TargetTcpProxy resource to delete.", + "instanceGroupManager": { "type": "string", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" + "description": "The name of the managed instance group.", + "location": "path" }, - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "type": "string", + "zone": { + "description": "The name of the zone where the managed instance group is located.", "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", + "type": "string", "required": true, - "description": "Project ID for this request.", + "description": "Project ID for this request." + }, + "requestId": { "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.regionTargetTcpProxies.delete", - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}" + } }, - "insert": { - "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", + "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", - "region" + "zone", + "instanceGroupManager" ], - "id": "compute.regionTargetTcpProxies.insert", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/targetTcpProxies", "response": { "$ref": "Operation" }, - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], + "request": { + "$ref": "InstanceGroupManagersAbandonInstancesRequest" + }, "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.", - "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 + }, + "instanceGroupManager": { "required": true, + "description": "The name of the managed instance group.", + "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)." - }, - "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 } - }, - "request": { - "$ref": "TargetTcpProxy" } }, - "list": { - "id": "compute.regionTargetTcpProxies.list", + "aggregatedList": { "httpMethod": "GET", "parameterOrder": [ - "project", - "region" - ], - "path": "projects/{project}/regions/{region}/targetTcpProxies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "project" ], + "description": "Retrieves the list of managed instance groups and groups them by zone.", + "flatPath": "projects/{project}/aggregated/instanceGroupManagers", + "response": { + "$ref": "InstanceGroupManagerAggregatedList" + }, "parameters": { - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "orderBy": { "location": "query", - "type": "boolean" - }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "location": "path", - "description": "Name of the region scoping this request.", - "type": "string" + "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." }, - "orderBy": { + "pageToken": { "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": "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", + "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`)", - "location": "query", "minimum": "0" }, "filter": { @@ -42119,102 +29638,197 @@ "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": { + "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": { "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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." + }, + "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" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "id": "compute.instanceGroupManagers.aggregatedList", + "path": "projects/{project}/aggregated/instanceGroupManagers" + }, + "list": { + "httpMethod": "GET", + "parameters": { + "filter": { "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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" + }, + "orderBy": { + "location": "query", "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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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." } }, - "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", "response": { - "$ref": "TargetTcpProxyList" + "$ref": "InstanceGroupManagerList" }, - "flatPath": "projects/{project}/regions/{region}/targetTcpProxies" - } - } - }, - "instances": { - "methods": { - "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", - "httpMethod": "GET", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", - "description": "Returns the screenshot from the specified instance.", - "id": "compute.instances.getScreenshot", + "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", - "instance" - ], + "zone" + ] + }, + "insert": { "response": { - "$ref": "Screenshot" + "$ref": "Operation" }, "parameters": { "zone": { - "description": "The name of the zone for this request.", "type": "string", - "location": "path", + "description": "The name of the zone where you want to create the managed instance group.", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "location": "path" }, - "instance": { - "location": "path", - "description": "Name of the instance scoping this request.", - "required": true, - "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": { - "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])?))", - "type": "string", - "description": "Project ID for this request." + "location": "path" } - } + }, + "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" }, - "setServiceAccount": { + "updatePerInstanceConfigs": { "response": { "$ref": "Operation" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", - "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", + "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", - "instance" + "instanceGroupManager" ], + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", + "httpMethod": "POST", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "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}", + "project": { + "location": "path", + "description": "Project ID for this request.", "required": true, - "description": "Name of the instance resource to start.", + "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", - "type": "string" + "type": "string", + "required": true, + "description": "The name of the managed instance group. It should conform to RFC1035." }, "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." + "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", + "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)." + } + }, + "id": "compute.instanceGroupManagers.updatePerInstanceConfigs", + "request": { + "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patch": { + "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.", + "id": "compute.instanceGroupManagers.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" }, "project": { "description": "Project ID for this request.", @@ -42222,998 +29836,1122 @@ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.", - "httpMethod": "POST", - "request": { - "$ref": "InstancesSetServiceAccountRequest" - }, - "id": "compute.instances.setServiceAccount", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] - }, - "delete": { + ], "parameterOrder": [ "project", "zone", - "instance" + "instanceGroupManager" ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "httpMethod": "PATCH" + }, + "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" ], - "httpMethod": "DELETE", - "description": "Deletes the specified Instance resource. For more information, see Deleting an instance.", + "id": "compute.instanceGroupManagers.setInstanceTemplate", + "request": { + "$ref": "InstanceGroupManagersSetInstanceTemplateRequest" + }, "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", + "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" }, - "instance": { + "requestId": { "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 delete.", - "location": "path", - "required": true + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { + "instanceGroupManager": { "location": "path", - "description": "The name of the zone for this request.", - "type": "string", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "description": "The name of the managed instance group.", + "type": "string" }, - "project": { - "description": "Project ID for this request.", - "type": "string", + "zone": { + "description": "The name of the zone where the managed instance group is located.", "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" } }, - "id": "compute.instances.delete", - "path": "projects/{project}/zones/{zone}/instances/{instance}", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "httpMethod": "POST" + }, + "delete": { + "httpMethod": "DELETE", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "id": "compute.instanceGroupManagers.delete", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], "response": { "$ref": "Operation" - } - }, - "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.", + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "parameters": { - "zone": { - "required": true, + "instanceGroupManager": { "type": "string", + "description": "The name of the managed instance group to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "The name of the zone 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", - "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": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "The instance name for 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])?))", + "type": "string", + "required": true + }, + "zone": { + "type": "string", "required": true, - "type": "string" + "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." + }, + "createInstances": { + "parameters": { + "instanceGroupManager": { + "type": "string", + "description": "The name of the managed instance group. It should conform to RFC1035.", + "required": true, + "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])?))", - "type": "string", "required": true, + "type": "string", + "location": "path", "description": "Project ID for this request." }, - "forceAttach": { + "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", - "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.", - "type": "boolean" + "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" + }, + "id": "compute.instanceGroupManagers.createInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", + "httpMethod": "POST", "parameterOrder": [ "project", "zone", - "instance" + "instanceGroupManager" ], - "request": { - "$ref": "AttachedDisk" - }, - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", - "id": "compute.instances.attachDisk", - "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] - }, - "setMinCpuPlatform": { - "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.", + ], + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", "response": { "$ref": "Operation" + } + }, + "listManagedInstances": { + "response": { + "$ref": "InstanceGroupManagersListManagedInstancesResponse" }, + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "parameterOrder": [ "project", "zone", - "instance" + "instanceGroupManager" ], - "request": { - "$ref": "InstancesSetMinCpuPlatformRequest" - }, - "id": "compute.instances.setMinCpuPlatform", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform", + "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": { - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, + "location": "path", "type": "string", - "location": "path" + "description": "The name of the zone where the managed instance group is located.", + "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).", + "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", - "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." }, - "instance": { + "instanceGroupManager": { + "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", - "location": "path" + "description": "The name of the managed instance group." }, - "project": { + "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", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" + }, + "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" } }, + "id": "compute.instanceGroupManagers.listManagedInstances", "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform" + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances" }, - "getSerialPortOutput": { - "parameterOrder": [ - "project", - "zone", - "instance" - ], - "httpMethod": "GET", - "description": "Returns the last 1 MB of serial port output from the specified instance.", + "get": { "parameters": { - "port": { - "maximum": "4", - "description": "Specifies which COM or serial port to retrieve data from.", - "default": "1", - "minimum": "1", - "location": "query", - "format": "int32", - "type": "integer" - }, - "zone": { - "required": true, + "instanceGroupManager": { "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, + "description": "The name of the managed instance group." }, "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." - }, - "start": { - "location": "query", - "format": "int64", + "required": true, + "description": "Project ID for this request.", "type": "string", - "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." + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 for this request.", + "zone": { "required": true, + "location": "path", "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path" + "description": "The name of the zone where the managed instance group is located." } }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/serialPort", + "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 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" + ], + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "response": { - "$ref": "SerialPortOutput" + "$ref": "InstanceGroupManager" }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/serialPort", - "id": "compute.instances.getSerialPortOutput" + "id": "compute.instanceGroupManagers.get" }, - "removeResourcePolicies": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", - "httpMethod": "POST", - "description": "Removes resource policies from an instance.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", + "resize": { + "response": { + "$ref": "Operation" + }, + "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", - "instance" + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" + "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", - "description": "Project ID for this request.", - "type": "string", "required": true }, "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "The name of the zone where the managed instance group is located.", "location": "path", - "description": "The name of the zone for this request.", - "type": "string", - "required": true + "required": true, + "type": "string" }, - "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.", + "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" + } + }, + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize" + }, + "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 } }, - "id": "compute.instances.removeResourcePolicies", "request": { - "$ref": "InstancesRemoveResourcePoliciesRequest" + "$ref": "InstanceGroupManagersApplyUpdatesRequest" + }, + "response": { + "$ref": "Operation" }, + "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" + ] + }, + "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" - } - }, - "aggregatedList": { + }, + "httpMethod": "POST", + "request": { + "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq" + }, "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.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" }, - "orderBy": { + "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" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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": { + "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": { + "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 }, - "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" + "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" }, - "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`)", + "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", - "default": "500" + "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", - "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": "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": "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.", - "id": "compute.instances.aggregatedList", - "response": { - "$ref": "InstanceAggregatedList" - }, - "httpMethod": "GET", - "path": "projects/{project}/aggregated/instances", - "flatPath": "projects/{project}/aggregated/instances", + "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" - ] - }, - "addResourcePolicies": { + "project", + "zone", + "instanceGroupManager" + ], "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", - "id": "compute.instances.addResourcePolicies", - "request": { - "$ref": "InstancesAddResourcePoliciesRequest" + "$ref": "InstanceGroupManagersListErrorsResponse" }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", + "id": "compute.instanceGroupManagers.listErrors" + } + } + }, + "disks": { + "methods": { + "setLabels": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "project", "zone", - "instance" + "resource" ], - "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.", + "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": { - "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).", - "type": "string", - "location": "query" - }, "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 - }, - "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" - } - } - }, - "deleteAccessConfig": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig", - "description": "Deletes an access config from an instance's network interface.", - "parameters": { - "accessConfig": { "type": "string", - "description": "The name of the access config to delete.", - "location": "query", - "required": true + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, - "networkInterface": { - "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, - "location": "query", - "description": "The name of the network interface." + "type": "string" }, - "instance": { + "resource": { "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, - "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.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "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).", "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", - "location": "path", - "required": true } }, - "id": "compute.instances.deleteAccessConfig", - "httpMethod": "POST", - "response": { - "$ref": "Operation" + "request": { + "$ref": "ZoneSetLabelsRequest" }, - "parameterOrder": [ - "project", - "zone", - "instance", - "accessConfig", - "networkInterface" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig" + "id": "compute.disks.setLabels" }, - "update": { - "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" - }, + "createSnapshot": { + "request": { + "$ref": "Snapshot" + }, + "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", + "httpMethod": "POST", + "id": "compute.disks.createSnapshot", + "parameters": { "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, + "location": "path", + "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])?))", "type": "string", + "location": "path", + "description": "Project ID for this request.", "required": true }, - "mostDisruptiveAllowedAction": { + "guestFlush": { "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 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.", - "type": "string" + "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", + "type": "boolean" }, - "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.", - "enum": [ - "INVALID", - "NO_EFFECT", - "REFRESH", - "RESTART" - ], - "enumDescriptions": [ - "", - "No changes can be made to the instance.", - "The instance will not restart.", - "The instance will restart." - ], + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { + "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, - "description": "Name of the instance resource to update.", - "type": "string", - "location": "path" + "location": "path", + "type": "string" } }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", - "parameterOrder": [ - "project", - "zone", - "instance" - ], - "httpMethod": "PUT", - "id": "compute.instances.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.", "response": { "$ref": "Operation" }, - "path": "projects/{project}/zones/{zone}/instances/{instance}", - "request": { - "$ref": "Instance" - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] + ], + "parameterOrder": [ + "project", + "zone", + "disk" + ], + "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." }, "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", "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" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string", + "location": "path" }, "project": { - "location": "path", "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 }, "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.", - "location": "path", - "required": true + "description": "The name of the zone for this request." } }, - "request": { - "$ref": "TestPermissionsRequest" + "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", + "response": { + "$ref": "TestPermissionsResponse" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", - "httpMethod": "POST", - "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" ], - "description": "Returns permissions that a caller has on the specified resource.", - "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" + "id": "compute.disks.testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" }, "parameterOrder": [ "project", "zone", "resource" - ] + ], + "httpMethod": "POST" }, - "addAccessConfig": { + "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": "Operation" + "$ref": "DiskList" }, + "path": "projects/{project}/zones/{zone}/disks", "parameters": { - "requestId": { + "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "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])?", - "description": "The name of the zone for this request.", "location": "path", - "type": "string", + "description": "The name of the zone for this request.", "required": true }, "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])?))", - "required": true, + "location": "path", "description": "Project ID for this request." }, - "networkInterface": { - "description": "The name of the network interface to add to this instance.", + "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" + } + }, + "id": "compute.disks.list", + "flatPath": "projects/{project}/zones/{zone}/disks", + "description": "Retrieves a list of persistent disks contained within the specified zone.", + "httpMethod": "GET" + }, + "aggregatedList": { + "httpMethod": "GET", + "id": "compute.disks.aggregatedList", + "parameters": { + "filter": { "type": "string", - "required": true, + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" }, - "instance": { - "required": true, + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "The instance name for this request." + "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}/zones/{zone}/instances/{instance}/addAccessConfig", + "flatPath": "projects/{project}/aggregated/disks", "parameterOrder": [ - "project", - "zone", - "instance", - "networkInterface" + "project" ], + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig", - "request": { - "$ref": "AccessConfig" - }, - "description": "Adds an access config to an instance's network interface.", - "httpMethod": "POST", - "id": "compute.instances.addAccessConfig" + "path": "projects/{project}/aggregated/disks" }, - "insert": { - "httpMethod": "POST", - "request": { - "$ref": "Instance" - }, - "path": "projects/{project}/zones/{zone}/instances", - "parameterOrder": [ - "project", - "zone" - ], + "addResourcePolicies": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "parameters": { - "sourceInstanceTemplate": { - "type": "string", - "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" + "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": { - "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", - "required": true - }, - "sourceMachineImage": { - "location": "query", - "type": "string", - "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 " - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "Project ID for this request." }, "zone": { - "location": "path", - "description": "The name of the zone for this request.", "type": "string", + "required": true, + "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true + "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" } }, - "id": "compute.instances.insert", - "flatPath": "projects/{project}/zones/{zone}/instances", - "description": "Creates an instance resource in the specified project using the data included in the request.", - "response": { - "$ref": "Operation" - } - }, - "bulkInsert": { + "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" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "zone", + "disk" ], + "response": { + "$ref": "Operation" + }, "request": { - "$ref": "BulkInsertInstanceResource" + "$ref": "DisksAddResourcePoliciesRequest" }, + "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", + "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies" + }, + "get": { "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", "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])?))" + "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.", "type": "string", "required": true, - "location": "path" + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "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." } }, - "httpMethod": "POST", - "description": "Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.", - "path": "projects/{project}/zones/{zone}/instances/bulkInsert", - "id": "compute.instances.bulkInsert", "response": { - "$ref": "Operation" + "$ref": "Disk" }, - "flatPath": "projects/{project}/zones/{zone}/instances/bulkInsert" + "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." }, - "updateShieldedInstanceConfig": { + "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" + }, "parameters": { - "instance": { + "disk": { "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 instance scoping this request." + "description": "Name of the persistent disk to delete.", + "location": "path" }, - "zone": { - "type": "string", + "project": { "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "The name of the zone for this request.", + "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": { - "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" + "location": "query", + "type": "string" }, - "project": { + "zone": { "required": true, + "pattern": "[a-z](?:[-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])?))", + "description": "The name of the zone for this request.", "location": "path" } + } + }, + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], "parameterOrder": [ "project", "zone", - "instance" + "disk" ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" - }, - "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.", - "id": "compute.instances.updateShieldedInstanceConfig", - "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", - "request": { - "$ref": "ShieldedInstanceConfig" - } - }, - "setShieldedInstanceIntegrityPolicy": { - "id": "compute.instances.setShieldedInstanceIntegrityPolicy", "parameters": { - "instance": { - "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 instance scoping this request.", - "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" + "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])?))", + "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" + }, + "project": { "type": "string", + "description": "Project ID for this request.", "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": { - "required": true, - "pattern": "[a-z](?:[-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}", + "type": "string", + "description": "The name of the persistent disk.", "location": "path", - "description": "The name of the zone for this request.", - "type": "string" + "required": true } }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy", + "id": "compute.disks.resize", + "response": { + "$ref": "Operation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ], - "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.", + ] + }, + "insert": { + "id": "compute.disks.insert", + "request": { + "$ref": "Disk" + }, + "path": "projects/{project}/zones/{zone}/disks", "response": { "$ref": "Operation" }, + "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" + ], "parameterOrder": [ "project", - "zone", - "instance" + "zone" ], - "request": { - "$ref": "ShieldedInstanceIntegrityPolicy" - }, - "httpMethod": "PATCH", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy" - }, - "simulateMaintenanceEvent": { "parameters": { - "instance": { - "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 instance scoping this request." + "sourceImage": { + "location": "query", + "description": "Source image to restore onto a disk. This field is optional.", + "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" }, "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "description": "The name of the zone for this request.", - "location": "path", "type": "string", + "location": "path", + "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", + "required": true, "description": "Project ID for this request.", - "required": true + "type": "string", + "location": "path" } + } + }, + "setIamPolicy": { + "response": { + "$ref": "Policy" }, - "id": "compute.instances.simulateMaintenanceEvent", "parameterOrder": [ "project", "zone", - "instance" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "resource" ], - "response": { - "$ref": "Operation" + "request": { + "$ref": "ZoneSetPolicyRequest" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent", - "httpMethod": "POST", - "path": "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." - }, - "setScheduling": { - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling", + "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": { - "instance": { - "description": "Instance name for this request.", + "zone": { "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "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 zone for this request." }, - "requestId": { + "resource": { + "location": "path", "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.", + "description": "Name or id of the resource for this request.", "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "location": "path" + "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, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "string", + "required": true } }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling", - "request": { - "$ref": "Scheduling" - }, - "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "parameterOrder": [ - "project", - "zone", - "instance" - ], - "response": { - "$ref": "Operation" - }, "httpMethod": "POST" }, - "updateNetworkInterface": { - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", - "httpMethod": "PATCH", - "id": "compute.instances.updateNetworkInterface", - "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.", + "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", + "https://www.googleapis.com/auth/compute.readonly" ], + "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", "parameters": { - "instance": { + "zone": { + "description": "The name of the zone for this request.", "type": "string", "location": "path", - "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}" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, - "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." + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "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.", - "type": "string", - "required": true + "location": "path" }, - "requestId": { + "resource": { "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" - }, - "networkInterface": { - "location": "query", + "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": "The name of the network interface to update." + "location": "path" } }, - "request": { - "$ref": "NetworkInterface" - }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", - "parameterOrder": [ - "project", - "zone", - "instance", - "networkInterface" - ] - }, - "updateDisplayDevice": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", - "id": "compute.instances.updateDisplayDevice", + "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", "parameterOrder": [ "project", "zone", - "instance" + "resource" ], + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "response": { - "$ref": "Operation" - }, - "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.", + "$ref": "Policy" + } + }, + "removeResourcePolicies": { + "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", "request": { - "$ref": "DisplayDevice" + "$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, @@ -43221,391 +30959,468 @@ "description": "The name of the zone for this request.", "location": "path" }, - "instance": { - "type": "string", - "required": true, - "description": "Name of the instance scoping this request.", + "project": { "location": "path", - "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" + "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])?))" }, - "project": { + "disk": { + "description": "The disk name 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])?))", - "location": "path" + "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" - ] - }, - "startWithEncryptionKey": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey", + ], "parameterOrder": [ "project", "zone", - "instance" + "disk" ], - "id": "compute.instances.startWithEncryptionKey", + "id": "compute.disks.removeResourcePolicies" + } + } + }, + "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": { - "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])?))", + "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 }, - "instance": { - "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" + } + }, + "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" + }, + "path": "projects/{project}/global/addresses/{address}", + "parameterOrder": [ + "project", + "address" + ] + }, + "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", - "description": "Name of the instance resource to start." - }, - "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)." + "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." }, - "zone": { + "resource": { "type": "string", "required": true, - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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" } }, - "request": { - "$ref": "InstancesStartWithEncryptionKeyRequest" - }, - "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.", + "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" ], - "httpMethod": "POST", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, "response": { "$ref": "Operation" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey" + "httpMethod": "POST" }, - "get": { + "list": { + "flatPath": "projects/{project}/global/addresses", "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 resource to return." + "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": { - "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" - }, - "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.", - "type": "string" + "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." } }, - "id": "compute.instances.get", "httpMethod": "GET", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", "parameterOrder": [ - "project", - "zone", - "instance" + "project" ], "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 Instance resource. Gets a list of available instances by making a list() request.", - "path": "projects/{project}/zones/{zone}/instances/{instance}", + "path": "projects/{project}/global/addresses", + "description": "Retrieves a list of global addresses.", + "id": "compute.globalAddresses.list", "response": { - "$ref": "Instance" + "$ref": "AddressList" } }, - "setDiskAutoDelete": { + "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" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "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" ], - "id": "compute.instances.setDiskAutoDelete", "parameterOrder": [ "project", - "zone", - "instance", - "autoDelete", - "deviceName" + "address" + ], + "path": "projects/{project}/global/addresses/{address}" + } + } + }, + "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": { - "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])?" + "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" }, - "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" + "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" }, - "instance": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "The instance name for this request.", + "filter": { + "location": "query", "type": "string", - "required": true + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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])?))", - "location": "path", - "description": "Project ID for this request.", "required": true, - "type": "string" + "location": "path", + "description": "Name of the project scoping this request." }, - "deviceName": { + "orderBy": { "type": "string", - "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.", "location": "query", - "pattern": "\\w[\\w.-]{0,254}", - "required": true + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported." }, - "autoDelete": { - "description": "Whether to auto-delete the disk when the instance is deleted.", + "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", - "required": true, - "location": "query" + "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." } - }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", - "description": "Sets the auto-delete flag for a disk attached to an instance.", - "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete" + } }, - "sendDiagnosticInterrupt": { - "description": "Sends diagnostic interrupt to the instance.", - "parameterOrder": [ - "project", - "zone", - "instance" - ], + "update": { + "httpMethod": "PUT", + "path": "projects/{project}/global/backendServices/{backendService}", "parameters": { - "project": { - "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)." + }, + "project": { "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "location": "path", + "required": true, + "description": "Project ID for this request.", + "type": "string" }, - "instance": { + "backendService": { "location": "path", - "description": "Name of the instance scoping this request.", "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 - }, - "zone": { - "type": "string", - "description": "The name of the zone for this request.", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" } }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.instances.sendDiagnosticInterrupt", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", - "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt" - }, - "reset": { - "path": "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" + "request": { + "$ref": "BackendService" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", + "flatPath": "projects/{project}/global/backendServices/{backendService}", + "id": "compute.backendServices.update", "parameterOrder": [ "project", - "zone", - "instance" + "backendService" ], + "response": { + "$ref": "Operation" + }, + "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" - ], - "id": "compute.instances.reset", - "httpMethod": "POST", + ] + }, + "get": { "parameters": { - "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", + "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", - "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)." - }, - "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." + "location": "path" } - } - }, - "setIamPolicy": { - "request": { - "$ref": "ZoneSetPolicyRequest" }, - "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", + "path": "projects/{project}/global/backendServices/{backendService}", "response": { - "$ref": "Policy" + "$ref": "BackendService" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", - "id": "compute.instances.setIamPolicy", + "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.", + "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", - "zone", "resource" ], "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.", + "response": { + "$ref": "Policy" + }, "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" - }, - "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, - "location": "path" + "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", - "required": true + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" } }, - "httpMethod": "POST" + "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." }, - "getIamPolicy": { - "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy", - "path": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy", - "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" - ], - "parameterOrder": [ - "project", - "zone", - "resource" - ], + "setSecurityPolicy": { "response": { - "$ref": "Policy" + "$ref": "Operation" + }, + "request": { + "$ref": "SecurityPolicyReference" }, - "httpMethod": "GET", "parameters": { - "optionsRequestedPolicyVersion": { - "location": "query", - "description": "Requested IAM Policy version.", - "type": "integer", - "format": "int32" - }, - "zone": { + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "The name of the zone for this request." + "location": "path" }, - "resource": { - "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).", "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true + "location": "query" }, - "project": { + "backendService": { + "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", - "location": "path" + "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.", + "type": "string" } }, - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." - }, - "setMachineType": { - "id": "compute.instances.setMachineType", + "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" ], - "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType", - "parameterOrder": [ - "project", - "zone", - "instance" - ], - "description": "Changes the machine type for a stopped instance to the machine type specified in the request.", + "httpMethod": "POST", + "id": "compute.backendServices.setSecurityPolicy" + }, + "deleteSignedUrlKey": { "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).", + "backendService": { "type": "string", - "location": "query" + "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.", + "location": "path", + "required": true }, - "instance": { - "required": true, + "keyName": { + "location": "query", + "description": "The name of the Signed URL Key to delete.", "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." + "required": true }, "project": { "required": true, @@ -43614,824 +31429,888 @@ "type": "string", "location": "path" }, - "zone": { - "description": "The 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).", "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "location": "path" + "location": "query" } }, - "request": { - "$ref": "InstancesSetMachineTypeRequest" - }, "response": { "$ref": "Operation" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType", - "httpMethod": "POST" - }, - "setDeletionProtection": { + "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": { - "deletionProtection": { - "description": "Whether the resource should be protected against deletion.", - "type": "boolean", - "location": "query", - "default": "true" + "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": { + "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": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query" }, - "resource": { + "filter": { "type": "string", - "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}" + "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`." }, - "zone": { - "required": true, - "type": "string", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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" }, - "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 + "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}/zones/{zone}/instances/{resource}/setDeletionProtection", - "id": "compute.instances.setDeletionProtection", + "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" }, - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "description": "Sets deletion protection on the instance.", - "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection" - }, - "start": { - "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.", - "path": "projects/{project}/zones/{zone}/instances/{instance}/start", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start", + "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" }, - "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": { - "location": "path", - "required": true, - "description": "Name of the instance resource to start.", - "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])?))", "type": "string", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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", + "backendService" + ], + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "response": { - "$ref": "Operation" + "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", - "zone", - "instance" + "resource" ], - "httpMethod": "POST", - "id": "compute.instances.start" + "response": { + "$ref": "Policy" + } }, - "stop": { + "setEdgeSecurityPolicy": { + "request": { + "$ref": "SecurityPolicyReference" + }, + "description": "Sets the edge security policy for the specified backend service.", + "flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", "parameterOrder": [ "project", - "zone", - "instance" + "backendService" ], - "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.", "parameters": { - "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" - }, - "instance": { - "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.", - "type": "string", - "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", - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 } }, "httpMethod": "POST", - "id": "compute.instances.stop", + "id": "compute.backendServices.setEdgeSecurityPolicy", + "path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop", - "path": "projects/{project}/zones/{zone}/instances/{instance}/stop" + ] }, - "listReferrers": { - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone", - "instance" + "patch": { + "path": "projects/{project}/global/backendServices/{backendService}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ], - "id": "compute.instances.listReferrers", - "path": "projects/{project}/zones/{zone}/instances/{instance}/referrers", + "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": "InstanceListReferrers" + "$ref": "Operation" }, "parameters": { - "filter": { + "project": { "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 }, - "pageToken": { - "location": "query", + "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." + "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)." }, - "instance": { - "pattern": "-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "backendService": { "required": true, "type": "string", + "description": "Name of the BackendService resource to patch.", "location": "path", - "description": "Name of the target instance scoping this request, or '-' if the request should span over all instances in the container." - }, + "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", - "description": "Project ID for this request.", - "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." + "type": "string" }, - "returnPartialSuccess": { + "backendService": { + "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": { + "requestId": { "location": "query", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "type": "boolean" + "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": { - "required": true, - "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", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "location": "path", + "required": true } }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/referrers", - "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.", + "request": { + "$ref": "BackendService" + }, + "response": { + "$ref": "Operation" + }, "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" ] }, - "list": { + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "projects/{project}/global/backendServices/{backendService}", "parameterOrder": [ "project", - "zone" + "backendService" ], - "path": "projects/{project}/zones/{zone}/instances", - "response": { - "$ref": "InstanceList" - }, + "httpMethod": "DELETE", "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." - }, - "project": { + "backendService": { "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 - }, - "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`." + "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": { - "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", + "requestId": { "location": "query", - "default": "500" + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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", - "location": "query" - }, - "zone": { "location": "path", - "type": "string", "required": true, - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-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" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": "GET", - "flatPath": "projects/{project}/zones/{zone}/instances", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.instances.list", - "description": "Retrieves the list of instances contained within the specified zone." - }, - "detachDisk": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", - "parameterOrder": [ - "project", - "zone", - "instance", - "deviceName" - ], + "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" + }, "response": { "$ref": "Operation" }, - "id": "compute.instances.detachDisk", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", - "description": "Detaches a disk from an instance.", + "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": { - "deviceName": { - "required": true, - "location": "query", - "type": "string", - "description": "The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names." - }, - "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", - "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" - }, - "instance": { - "type": "string", - "description": "Instance name for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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)." } - } + }, + "parameterOrder": [ + "project" + ] }, - "setLabels": { - "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.", - "httpMethod": "POST", + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "project", + "sslPolicy" + ], + "id": "compute.sslPolicies.patch", + "path": "projects/{project}/global/sslPolicies/{sslPolicy}", + "description": "Patches the specified SSL policy with the data included in the request.", "response": { "$ref": "Operation" }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], + "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", "request": { - "$ref": "InstancesSetLabelsRequest" + "$ref": "SslPolicy" }, - "id": "compute.instances.setLabels", - "parameterOrder": [ - "project", - "zone", - "instance" - ], "parameters": { - "zone": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", + "sslPolicy": { "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])?))", + "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "required": true, - "description": "Project ID for this request.", - "location": "path", - "type": "string" + "location": "path" }, "requestId": { - "type": "string", "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": { - "required": true, + "project": { "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 instance scoping this request." + "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])?))" } }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "getGuestAttributes": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes", - "response": { - "$ref": "GuestAttributes" - }, - "description": "Returns the specified guest attributes entry.", + "delete": { "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" + ], + "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.", + "response": { + "$ref": "Operation" + }, + "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", + "parameterOrder": [ + "project", + "sslPolicy" ], "parameters": { - "instance": { - "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 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).", + "location": "query", "type": "string" }, - "variableKey": { - "description": "Specifies the key for the guest attributes entry.", + "sslPolicy": { + "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", "type": "string", - "location": "query" + "required": true, + "location": "path" }, - "queryPath": { - "location": "query", + "project": { "type": "string", - "description": "Specifies the guest attributes path to be queried." - }, - "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Project ID for this request.", "required": true, "location": "path", - "description": "The name of the zone 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])?))" + } + } + }, + "get": { + "path": "projects/{project}/global/sslPolicies/{sslPolicy}", + "httpMethod": "GET", + "response": { + "$ref": "SslPolicy" + }, + "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])?))", - "required": true, + "location": "path" + }, + "sslPolicy": { + "type": "string", "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." } }, - "id": "compute.instances.getGuestAttributes", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone", - "instance" - ] - }, - "updateAccessConfig": { - "path": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig", - "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", - "zone", - "instance", - "networkInterface" + "sslPolicy" ], - "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", - "request": { - "$ref": "AccessConfig" - }, + "id": "compute.sslPolicies.get", + "description": "Lists all of the ordered rules present in a single specified policy.", + "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}" + }, + "aggregatedList": { "response": { - "$ref": "Operation" + "$ref": "SslPoliciesAggregatedList" }, "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.instances.updateAccessConfig", + "httpMethod": "GET", + "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.", "parameters": { - "instance": { - "description": "The instance name 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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "type": "string", - "required": true + "required": true, + "description": "Name of the project scoping this request." }, - "requestId": { + "returnPartialSuccess": { + "type": "boolean", "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": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." }, - "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.", + "location": "query", + "type": "string" }, - "networkInterface": { + "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": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": "The name of the network interface where the access config is attached.", - "type": "string", - "required": true + "type": "string" }, - "zone": { + "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" + }, + "orderBy": { + "location": "query", "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." + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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}/aggregated/sslPolicies", + "flatPath": "projects/{project}/aggregated/sslPolicies", + "parameterOrder": [ + "project" + ], + "id": "compute.sslPolicies.aggregatedList" }, - "setMetadata": { - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata", + "listAvailableFeatures": { + "response": { + "$ref": "SslPoliciesListAvailableFeaturesResponse" + }, + "description": "Lists all features that can be specified in the SSL policy when using custom profile.", + "httpMethod": "GET", + "parameterOrder": [ + "project" + ], "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).", + "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 instance scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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" }, - "zone": { + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true, - "description": "The name of the zone for this request." + "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": { + "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": { - "type": "string", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", + "required": true, + "location": "path" } }, - "id": "compute.instances.setMetadata", - "description": "Sets metadata for the specified instance to the data included in the request.", - "request": { - "$ref": "Metadata" - }, - "httpMethod": "POST", + "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", + "https://www.googleapis.com/auth/compute.readonly" ], - "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone", - "instance" - ] + "id": "compute.sslPolicies.listAvailableFeatures", + "flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures" }, - "setMachineResources": { - "description": "Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.", - "request": { - "$ref": "InstancesSetMachineResourcesRequest" - }, + "list": { + "description": "Lists all the SSL policies that have been configured for the specified project.", + "id": "compute.sslPolicies.list", + "path": "projects/{project}/global/sslPolicies", + "parameterOrder": [ + "project" + ], "response": { - "$ref": "Operation" + "$ref": "SslPoliciesList" }, "parameters": { - "project": { - "location": "path", - "required": true, + "filter": { "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" }, - "requestId": { + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "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": "boolean" }, - "zone": { - "location": "path", - "required": true, + "orderBy": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "The name of the zone for this request." + "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." }, - "instance": { - "description": "Name of the instance scoping this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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" + }, + "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": { + "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" } }, - "httpMethod": "POST", - "id": "compute.instances.setMachineResources", - "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", + "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", + "httpMethod": "GET" + } + } + }, + "regionTargetHttpProxies": { + "methods": { + "delete": { + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", - "parameterOrder": [ - "project", - "zone", - "instance" - ] - }, - "getShieldedInstanceIdentity": { - "response": { - "$ref": "ShieldedInstanceIdentity" - }, "parameters": { - "zone": { - "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": { "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "description": "Name of the region scoping this request.", + "required": true }, - "instance": { + "targetHttpProxy": { "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.", - "location": "path" + "location": "path", + "description": "Name of the TargetHttpProxy resource to delete.", + "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])?))", "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." } }, "parameterOrder": [ "project", - "zone", - "instance" + "region", + "targetHttpProxy" ], + "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" ], - "description": "Returns the Shielded Instance Identity of an instance", - "id": "compute.instances.getShieldedInstanceIdentity", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity", - "httpMethod": "GET", - "path": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity" - }, - "getEffectiveFirewalls": { + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "parameters": { - "instance": { - "type": "string", - "description": "Name of the instance 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.", "required": true, + "type": "string", "location": "path" }, - "zone": { - "type": "string", + "region": { "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, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": "Name of the region scoping this request.", "type": "string" }, - "networkInterface": { - "description": "The name of the network interface to get the effective firewalls.", - "required": true, + "targetHttpProxy": { + "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 TargetHttpProxy resource to return.", + "required": true, + "location": "path" } }, - "id": "compute.instances.getEffectiveFirewalls", - "path": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls", - "description": "Returns effective firewalls applied to an interface of the instance.", - "response": { - "$ref": "InstancesGetEffectiveFirewallsResponse" - }, + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "parameterOrder": [ "project", - "zone", - "instance", - "networkInterface" - ], + "region", + "targetHttpProxy" + ] + }, + "list": { "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}/instances/{instance}/getEffectiveFirewalls" - }, - "setTags": { - "request": { - "$ref": "Tags" - }, - "httpMethod": "POST", - "id": "compute.instances.setTags", - "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags", - "description": "Sets network tags for the specified instance to the data included in the request.", "response": { - "$ref": "Operation" + "$ref": "TargetHttpProxyList" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", + "path": "projects/{project}/regions/{region}/targetHttpProxies", "parameterOrder": [ "project", - "zone", - "instance" + "region" ], + "httpMethod": "GET", + "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", "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": { + "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" }, - "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" + }, + "region": { "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 instance scoping this request." + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region scoping this request.", + "required": true }, - "requestId": { + "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" + }, + "filter": { "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 filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" }, - "zone": { + "project": { + "description": "Project ID for this request.", + "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])?", - "type": "string" + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))" } - } - }, - "suspend": { - "response": { - "$ref": "Operation" }, - "id": "compute.instances.suspend", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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.", + "id": "compute.regionTargetHttpProxies.list" + }, + "insert": { + "path": "projects/{project}/regions/{region}/targetHttpProxies", + "id": "compute.regionTargetHttpProxies.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" - }, - "zone": { + "region": { "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Name of the region scoping this request.", "required": true, - "description": "The name of the zone for this request.", + "location": "path", + "type": "string" + }, + "requestId": { "type": "string", - "location": "path" + "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])?))", - "type": "string", "description": "Project ID for this request.", + "type": "string", "location": "path", "required": true - }, - "instance": { - "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 suspend.", - "type": "string", - "location": "path" } }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend", + "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", + "request": { + "$ref": "TargetHttpProxy" + }, + "response": { + "$ref": "Operation" + }, "httpMethod": "POST", + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "parameterOrder": [ "project", - "zone", - "instance" + "region" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" ] }, - "resume": { - "id": "compute.instances.resume", + "setUrlMap": { "parameters": { - "zone": { - "description": "The name of the zone for this request.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "targetHttpProxy": { "location": "path", - "required": true - }, - "instance": { - "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 resume.", - "location": "path", - "type": "string" + "required": true, + "type": "string", + "description": "Name of the TargetHttpProxy to set a URL map for." }, "requestId": { "type": "string", @@ -44439,23034 +32318,36599 @@ "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": { + "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" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string", + "description": "Name of the region scoping this request." } }, - "description": "Resumes an instance that was suspended using the instances().suspend method.", + "httpMethod": "POST", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "parameterOrder": [ "project", - "zone", - "instance" + "region", + "targetHttpProxy" ], - "httpMethod": "POST", - "response": { - "$ref": "Operation" + "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "request": { + "$ref": "UrlMapReference" }, - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume", - "path": "projects/{project}/zones/{zone}/instances/{instance}/resume", + "id": "compute.regionTargetHttpProxies.setUrlMap", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" - ] + ], + "description": "Changes the URL map for TargetHttpProxy.", + "response": { + "$ref": "Operation" + } } } }, - "regionTargetHttpsProxies": { + "targetVpnGateways": { "methods": { - "patch": { + "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" + }, "parameters": { - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to patch.", + "resource": { + "description": "Name or id of the resource for this request.", + "required": true, "type": "string", - "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true + "location": "path" }, "region": { + "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "Name of the region for this request.", "type": "string", - "required": true + "required": true, + "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", + "type": "string", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 + } + }, + "id": "compute.targetVpnGateways.setLabels", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "region", + "resource" + ], + "response": { + "$ref": "Operation" + }, + "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels" + }, + "insert": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "request": { + "$ref": "TargetVpnGateway" + }, + "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])?", + "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", + "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" + "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": "TargetHttpsProxy" - }, - "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.", - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "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." + }, + "get": { "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" ], - "httpMethod": "PATCH", + "id": "compute.targetVpnGateways.get", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "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", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "targetVpnGateway": { + "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 target VPN gateway to return.", + "required": true + } + }, + "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", - "targetHttpsProxy" + "targetVpnGateway" ], - "id": "compute.regionTargetHttpsProxies.patch" + "httpMethod": "GET" }, - "setSslCertificates": { - "request": { - "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" - }, - "id": "compute.regionTargetHttpsProxies.setSslCertificates", - "httpMethod": "POST", + "list": { "parameterOrder": [ "project", - "region", - "targetHttpsProxy" + "region" + ], + "response": { + "$ref": "TargetVpnGatewayList" + }, + "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}/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": { - "requestId": { - "type": "string", + "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)." + "description": "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": { + "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", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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", + "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", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "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])?))" + "description": "Name of the region for this request." }, - "targetHttpsProxy": { + "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])?))", "type": "string", + "location": "path", + "description": "Project ID for this request.", + "required": true + } + } + }, + "delete": { + "id": "compute.targetVpnGateways.delete", + "description": "Deletes the specified target VPN gateway.", + "parameters": { + "project": { "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 set an SslCertificates resource for.", + "description": "Project ID for this request.", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { + "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" + }, + "targetVpnGateway": { + "description": "Name of the target VPN gateway to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "description": "Replaces SslCertificates for TargetHttpsProxy.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "response": { "$ref": "Operation" }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates" + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameterOrder": [ + "project", + "region", + "targetVpnGateway" + ] }, - "list": { - "path": "projects/{project}/regions/{region}/targetHttpsProxies", - "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", + "aggregatedList": { + "path": "projects/{project}/aggregated/targetVpnGateways", + "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.targetVpnGateways.aggregatedList", + "description": "Retrieves an aggregated list of target VPN gateways.", + "flatPath": "projects/{project}/aggregated/targetVpnGateways", "response": { - "$ref": "TargetHttpsProxyList" + "$ref": "TargetVpnGatewayAggregatedList" }, - "id": "compute.regionTargetHttpsProxies.list", - "parameterOrder": [ - "project", - "region" - ], - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", + "httpMethod": "GET", "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": { + "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", - "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", - "default": "500" + "minimum": "0", + "default": "500", + "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`.", - "location": "query" - }, - "region": { - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping 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])?))", - "type": "string", - "required": true, - "description": "Project ID for this request.", - "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" - }, "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" - } - }, - "httpMethod": "GET" - }, - "insert": { - "path": "projects/{project}/regions/{region}/targetHttpsProxies", - "parameters": { - "project": { + }, + "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": "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." + "location": "query" }, - "requestId": { + "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", - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": "boolean" }, - "region": { + "project": { "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 scoping this request.", + "description": "Project ID for this request.", "required": true } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + } + } + } + } + }, + "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" ], - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", - "id": "compute.regionTargetHttpsProxies.insert", - "request": { - "$ref": "TargetHttpsProxy" - }, - "parameterOrder": [ - "project", - "region" + "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." ], - "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", - "response": { - "$ref": "Operation" + "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)." + ] }, - "httpMethod": "POST" + "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." }, - "delete": { - "id": "compute.regionTargetHttpsProxies.delete", - "response": { - "$ref": "Operation" + "advertisedIpRanges": { + "items": { + "$ref": "RouterAdvertisedIpRange" }, - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "targetHttpsProxy" - ], - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "parameters": { - "region": { - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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" + ] + } + } + }, + "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." + }, + "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": { "type": "string", - "location": "path", - "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).", + "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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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" + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + }, + "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" + ] + } + } + }, + "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" + ], + "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.", + "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 + "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" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to delete.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "location": "path", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "description": "Deletes the specified TargetHttpsProxy resource.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "type": "object" }, - "setUrlMap": { - "parameterOrder": [ - "project", - "region", - "targetHttpsProxy" - ], - "id": "compute.regionTargetHttpsProxies.setUrlMap", - "response": { - "$ref": "Operation" + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "items": { + "items": { + "$ref": "UrlMap" }, - "description": "Changes the URL map for TargetHttpsProxy.", - "request": { - "$ref": "UrlMapReference" + "type": "array", + "description": "A list of UrlMap 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" + } + } + }, + "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" }, - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "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" - }, - "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" - }, - "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" - } + "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" }, - "httpMethod": "POST" + "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" + } }, - "get": { - "response": { - "$ref": "TargetHttpsProxy" + "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" + ] }, - "parameterOrder": [ - "project", - "region", - "targetHttpsProxy" + "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." + }, + "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." ], - "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "id": "compute.regionTargetHttpsProxies.get", - "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" ], - "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.", - "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", - "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])?" - }, - "targetHttpsProxy": { - "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 TargetHttpsProxy resource to return.", - "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])?))" - } + "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." }, - "sslPolicies": { - "methods": { - "aggregatedList": { - "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`)", - "default": "500", - "minimum": "0", - "format": "uint32", - "type": "integer", - "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": { - "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" - }, - "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." - }, - "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." - } - }, - "response": { - "$ref": "SslPoliciesAggregatedList" + "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" }, - "id": "compute.sslPolicies.aggregatedList", - "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.", - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/sslPolicies", - "path": "projects/{project}/aggregated/sslPolicies", - "parameterOrder": [ - "project" + "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" + } + } + }, + "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];" + ], + "type": "string", + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR" + ] + }, + "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." + ], + "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" + ] + }, + "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" + } + }, + "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." + }, + "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." ], - "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" ] }, - "insert": { - "flatPath": "projects/{project}/global/sslPolicies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "description": "Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.", - "request": { - "$ref": "SslPolicy" - }, - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/global/sslPolicies", - "id": "compute.sslPolicies.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])?))", - "type": "string", - "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)." - } + "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." + }, + "name": { + "annotations": { + "required": [ + "compute.interconnects.insert" + ] }, - "parameterOrder": [ - "project" - ] + "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])?" }, - "list": { - "description": "Lists all the SSL policies that have been configured for the specified project.", - "id": "compute.sslPolicies.list", - "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" - }, - "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" - }, - "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", - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer", - "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" - } + "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" }, - "flatPath": "projects/{project}/global/sslPolicies", - "parameterOrder": [ - "project" + "description": "[Output Only] A list of outages expected for this Interconnect.", + "type": "array" + }, + "interconnectType": { + "enum": [ + "DEDICATED", + "IT_PRIVATE", + "PARTNER" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "path": "projects/{project}/global/sslPolicies", - "response": { - "$ref": "SslPoliciesList" + "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" + } + }, + "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" } }, - "patch": { - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", - "parameterOrder": [ - "project", - "sslPolicy" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/sslPolicies/{sslPolicy}", - "request": { - "$ref": "SslPolicy" - }, - "parameters": { - "sslPolicy": { - "type": "string", - "location": "path", - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", - "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" - }, - "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.sslPolicies.patch", - "description": "Patches the specified SSL policy with the data included in the request." + "statusMessage": { + "type": "string", + "description": "[Output Only] An optional, human-readable explanation of the status." }, - "listAvailableFeatures": { - "description": "Lists all features that can be specified in the SSL policy when using custom profile.", - "flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures", - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "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 - }, - "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" - }, - "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`." - } - }, - "id": "compute.sslPolicies.listAvailableFeatures", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" ], - "parameterOrder": [ - "project" + "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)." ], - "response": { - "$ref": "SslPoliciesListAvailableFeaturesResponse" - }, - "httpMethod": "GET", - "path": "projects/{project}/global/sslPolicies/listAvailableFeatures" + "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." }, - "get": { - "id": "compute.sslPolicies.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/sslPolicies/{sslPolicy}", - "parameters": { - "sslPolicy": { - "type": "string", - "location": "path", - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", - "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])?))" - } + "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" + ] }, - "parameterOrder": [ - "project", - "sslPolicy" + "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" ], - "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", - "httpMethod": "GET", - "response": { - "$ref": "SslPolicy" - }, - "description": "Lists all of the ordered rules present in a single specified policy." + "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." + ] }, - "delete": { - "response": { - "$ref": "Operation" + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "NetworkInterface" }, - "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", - "path": "projects/{project}/global/sslPolicies/{sslPolicy}", - "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", - "parameterOrder": [ - "project", - "sslPolicy" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { - "location": "path", - "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", - "required": true, - "type": "string" - } - } - } - } - }, - "machineImages": { - "methods": { - "setIamPolicy": { - "request": { - "$ref": "GlobalSetPolicyRequest" + "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." + }, + "disks": { + "type": "array", + "items": { + "$ref": "AttachedDisk" }, - "parameterOrder": [ - "project", - "resource" + "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." ], - "response": { - "$ref": "Policy" - }, - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" ], - "path": "projects/{project}/global/machineImages/{resource}/setIamPolicy", - "id": "compute.machineImages.setIamPolicy", - "parameters": { - "resource": { - "description": "Name or id of the resource 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}" - }, - "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 - } + "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" } }, - "get": { - "parameterOrder": [ - "project", - "machineImage" - ], - "response": { - "$ref": "MachineImage" - }, - "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." - }, - "machineImage": { - "location": "path", - "description": "The name of the machine image.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true - } + "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" + ] + } + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "guestAccelerators": { + "items": { + "$ref": "AcceleratorConfig" }, - "description": "Returns the specified machine image. Gets a list of available machine 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" + "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" + } + }, + "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." ], - "httpMethod": "GET", - "flatPath": "projects/{project}/global/machineImages/{machineImage}", - "id": "compute.machineImages.get", - "path": "projects/{project}/global/machineImages/{machineImage}" + "type": "string", + "enum": [ + "NO_NAT" + ] }, - "delete": { - "id": "compute.machineImages.delete", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "httpMethod": "DELETE", - "flatPath": "projects/{project}/global/machineImages/{machineImage}", - "parameterOrder": [ - "project", - "machineImage" + "enum": [ + "ALLOW", + "DENY", + "PREFERENCE_UNSPECIFIED" ], - "description": "Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.", - "path": "projects/{project}/global/machineImages/{machineImage}", - "parameters": { - "machineImage": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string", - "description": "The name of the machine image 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])?))", - "required": true, - "type": "string", - "location": "path", - "description": "Project ID for this request." - } - } + "description": "Preference for a given location. Set to either ALLOW or DENY." }, - "testIamPermissions": { - "path": "projects/{project}/global/machineImages/{resource}/testIamPermissions", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" - }, - "parameterOrder": [ - "project", - "resource" - ], - "id": "compute.machineImages.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" + "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." ], - "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": { - "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": "Returns permissions that a caller has on the specified resource." + "description": "This is deprecated and has no effect. Do not use.", + "enum": [ + "DISCHARGED", + "EQUALS", + "IN", + "NOT_EQUALS", + "NOT_IN", + "NO_OP" + ] }, - "insert": { - "request": { - "$ref": "MachineImage" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project" + "svc": { + "description": "This is deprecated and has no effect. Do not use.", + "type": "string" + }, + "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." ], - "flatPath": "projects/{project}/global/machineImages", - "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" - }, - "sourceInstance": { - "location": "query", - "type": "string", - "description": "Required. Source instance that is used to create the machine image from." - }, - "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." - } - }, - "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" ], - "id": "compute.machineImages.insert", - "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.", - "httpMethod": "POST", - "path": "projects/{project}/global/machineImages" + "type": "string", + "description": "This is deprecated and has no effect. Do not use." }, - "list": { - "flatPath": "projects/{project}/global/machineImages", - "path": "projects/{project}/global/machineImages", - "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`)", - "type": "integer", - "minimum": "0", - "location": "query", - "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" - }, - "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 - }, - "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": { - "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." - } - }, - "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" + "sys": { + "enum": [ + "IP", + "NAME", + "NO_ATTR", + "REGION", + "SERVICE" ], - "parameterOrder": [ - "project" + "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": "Retrieves a list of machine images that are contained within the specified project.", - "response": { - "$ref": "MachineImageList" - }, - "httpMethod": "GET" + "description": "This is deprecated and has no effect. Do not use.", + "type": "string" }, - "getIamPolicy": { - "parameterOrder": [ - "project", - "resource" - ], - "parameters": { - "optionsRequestedPolicyVersion": { - "type": "integer", - "description": "Requested IAM Policy version.", - "format": "int32", - "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" - }, - "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" - } - }, - "httpMethod": "GET", - "response": { - "$ref": "Policy" + "values": { + "description": "This is deprecated and has no effect. Do not use.", + "items": { + "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/machineImages/{resource}/getIamPolicy", - "path": "projects/{project}/global/machineImages/{resource}/getIamPolicy", - "id": "compute.machineImages.getIamPolicy", - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." + "type": "array" } } }, - "targetSslProxies": { - "methods": { - "get": { - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", - "id": "compute.targetSslProxies.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/targetSslProxies/{targetSslProxy}", - "description": "Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.", - "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." - }, - "targetSslProxy": { - "required": true, - "type": "string", - "location": "path", - "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}" - } + "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" + }, + "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" }, - "response": { - "$ref": "TargetSslProxy" + "description": "Effective firewalls from firewall policy." + }, + "firewalls": { + "description": "Effective firewalls on the network.", + "items": { + "$ref": "Firewall" }, - "httpMethod": "GET" + "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" }, - "delete": { - "id": "compute.targetSslProxies.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "DELETE", - "response": { - "$ref": "Operation" + "items": { + "type": "object", + "additionalProperties": { + "description": "Name of the scope containing this set of security policies.", + "$ref": "NetworkEdgeSecurityServicesScopedList" }, - "parameters": { - "targetSslProxy": { - "location": "path", - "description": "Name of the TargetSslProxy resource to delete.", - "type": "string", - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - } + "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/targetSslProxies/{targetSslProxy}", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "description": "Deletes the specified TargetSslProxy resource.", - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}" + "type": "array" }, - "setSslPolicy": { - "parameters": { - "project": { + "etag": { + "type": "string" + }, + "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": { "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 + "description": "[Output Only] A human-readable description of the warning code." }, - "targetSslProxy": { + "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", - "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 + "description": "[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)." + "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" } - }, - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.targetSslProxies.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.", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "httpMethod": "POST", - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "SslPolicyReference" } + } + }, + "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" }, - "setProxyHeader": { - "description": "Changes the ProxyHeaderType for TargetSslProxy.", - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "httpMethod": "POST", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", - "request": { - "$ref": "TargetSslProxiesSetProxyHeaderRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "targetSslProxy": { - "location": "path", - "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}", - "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, - "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)." - } + "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" }, - "id": "compute.targetSslProxies.setProxyHeader", - "response": { - "$ref": "Operation" - } + "type": "array", + "description": "A list of PacketMirroring resources." }, - "setSslCertificates": { - "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).", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "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" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.", - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { + "description": "[Output Only] A human-readable description of the warning code.", "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": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } } }, - "request": { - "$ref": "TargetSslProxiesSetSslCertificatesRequest" - }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.targetSslProxies.setSslCertificates", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "description": "Changes SslCertificates for TargetSslProxy.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates" + "description": "[Output Only] Informational warning message.", + "type": "object" + } + } + }, + "NetworkAttachmentAggregatedList": { + "type": "object", + "properties": { + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, - "setBackendService": { - "request": { - "$ref": "TargetSslProxiesSetBackendServiceRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "id": "compute.targetSslProxies.setBackendService", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", - "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", + "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" + }, + "warning": { + "type": "object", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, - "targetSslProxy": { - "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 TargetSslProxy resource whose BackendService resource is to be set.", - "location": "path" + "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\" } " }, - "project": { - "description": "Project ID 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." + ], + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": "[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", - "description": "Changes the BackendService for TargetSslProxy.", - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService" + "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." }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/targetSslProxies", - "flatPath": "projects/{project}/global/targetSslProxies", - "parameterOrder": [ - "project" - ], - "id": "compute.targetSslProxies.insert", - "request": { - "$ref": "TargetSslProxy" - }, - "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])?))", - "description": "Project ID for this request.", - "type": "string", - "location": "path", - "required": true - } - }, - "httpMethod": "POST", - "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.", - "response": { - "$ref": "Operation" + "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" } }, - "list": { - "response": { - "$ref": "TargetSslProxyList" - }, - "flatPath": "projects/{project}/global/targetSslProxies", - "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", - "location": "query", - "minimum": "0", - "type": "integer", - "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.", - "location": "query", - "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])?))", - "type": "string", - "description": "Project ID 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" - }, - "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" - } - }, - "id": "compute.targetSslProxies.list", - "description": "Retrieves the list of TargetSslProxy resources available to the specified project.", - "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/targetSslProxies" + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." }, - "setCertificateMap": { - "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])?))", + "kind": { + "description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.", + "type": "string", + "default": "compute#nodeTypeList" + }, + "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": { "type": "string", - "location": "path", - "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", - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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\" } " }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", - "location": "path", + "message": { "type": "string", - "required": true + "description": "[Output Only] A human-readable description of the warning code." } - }, - "response": { - "$ref": "Operation" - }, - "description": "Changes the Certificate Map for TargetSslProxy.", - "id": "compute.targetSslProxies.setCertificateMap", - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "request": { - "$ref": "TargetSslProxiesSetCertificateMapRequest" - }, - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + } } } }, - "licenses": { - "methods": { - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "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", - "description": "Project ID for this request.", - "required": true - }, - "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" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "GlobalSetPolicyRequest" - }, - "parameterOrder": [ - "project", - "resource" - ], - "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. ", - "path": "projects/{project}/global/licenses/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.licenses.setIamPolicy", - "flatPath": "projects/{project}/global/licenses/{resource}/setIamPolicy" + "NetworkEndpointWithHealthStatus": { + "type": "object", + "properties": { + "networkEndpoint": { + "$ref": "NetworkEndpoint", + "description": "[Output only] The network endpoint;" }, - "get": { - "flatPath": "projects/{project}/global/licenses/{license}", - "id": "compute.licenses.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": "License" - }, - "parameterOrder": [ - "project", - "license" - ], - "parameters": { - "license": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the License resource to return.", - "location": "path", - "required": true - }, - "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])?))" - } + "healths": { + "description": "[Output only] The health status of network endpoint;", + "items": { + "$ref": "HealthStatusForNetworkEndpoint" }, - "path": "projects/{project}/global/licenses/{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. " + "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" }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "path": "projects/{project}/global/licenses/{resource}/getIamPolicy", - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 - }, - "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}", - "required": true, - "location": "path" - } - }, - "httpMethod": "GET", - "flatPath": "projects/{project}/global/licenses/{resource}/getIamPolicy", - "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. ", - "parameterOrder": [ - "project", - "resource" + "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", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "id": "compute.licenses.getIamPolicy" + "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" }, - "testIamPermissions": { - "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])?))" - }, - "resource": { - "type": "string", - "required": true, - "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}" - } - }, - "parameterOrder": [ - "project", - "resource" + "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." + }, + "type": { + "enumDescriptions": [ + "", + "" ], - "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" ], - "request": { - "$ref": "TestPermissionsRequest" - }, - "id": "compute.licenses.testIamPermissions", - "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/licenses/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" + "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." + }, + "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" + }, + "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." + }, + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "NetworkInterface" }, - "flatPath": "projects/{project}/global/licenses/{resource}/testIamPermissions", - "httpMethod": "POST" + "description": "An array of network access configurations for this interface." + }, + "networkPerformanceConfig": { + "description": "Note that for MachineImage, this is not supported yet.", + "$ref": "NetworkPerformanceConfig" }, - "delete": { - "id": "compute.licenses.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "labels": { + "description": "Labels to apply to instances that are created from these properties.", + "additionalProperties": { + "type": "string" }, - "parameterOrder": [ - "project", - "license" - ], - "description": "Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace 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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - }, - "license": { - "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 license resource to delete.", - "required": true - } + "type": "object" + }, + "machineType": { + "annotations": { + "required": [ + "compute.instanceTemplates.insert" + ] }, - "path": "projects/{project}/global/licenses/{license}", - "httpMethod": "DELETE", - "flatPath": "projects/{project}/global/licenses/{license}" + "type": "string", + "description": "The machine type to use for instances that are created from these properties." }, - "list": { - "id": "compute.licenses.list", - "flatPath": "projects/{project}/global/licenses", - "parameterOrder": [ - "project" + "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" ], - "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." ], - "httpMethod": "GET", - "path": "projects/{project}/global/licenses", - "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. ", - "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "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" - }, - "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" - }, - "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." - } - }, - "response": { - "$ref": "LicensesListResponse" + "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" } }, - "insert": { - "parameterOrder": [ - "project" - ], - "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])?))", - "required": true, - "type": "string" - } - }, - "flatPath": "projects/{project}/global/licenses", - "response": { - "$ref": "Operation" + "resourcePolicies": { + "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" + "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" ], - "id": "compute.licenses.insert", - "httpMethod": "POST", - "request": { - "$ref": "License" + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ] + }, + "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" }, - "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. ", - "path": "projects/{project}/global/licenses" + "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." } } }, - "interconnects": { - "methods": { - "delete": { - "id": "compute.interconnects.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "interconnect" - ], - "httpMethod": "DELETE", - "path": "projects/{project}/global/interconnects/{interconnect}", - "flatPath": "projects/{project}/global/interconnects/{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": { - "description": "Name of the interconnect to delete.", - "required": true, - "type": "string", - "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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Operation" + "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" }, - "description": "Deletes the specified interconnect." + "type": "array", + "description": "[Output Only] Unreachable resources." }, - "list": { - "id": "compute.interconnects.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/interconnects", - "path": "projects/{project}/global/interconnects", - "parameterOrder": [ - "project" - ], - "description": "Retrieves the list of interconnect available to the specified project.", - "parameters": { - "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`)", - "minimum": "0", - "default": "500", - "type": "integer" - }, - "pageToken": { - "location": "query", + "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": { "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": { - "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": { - "location": "query", + "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." - }, - "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" + "description": "[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" + ] }, - "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": { + "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" } }, - "httpMethod": "GET", - "response": { - "$ref": "InterconnectList" - } + "type": "object", + "description": "[Output Only] Informational warning message." }, - "getDiagnostics": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "description": "Returns the interconnectDiagnostics for the specified interconnect.", - "path": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "interconnect" - ], - "response": { - "$ref": "InterconnectsGetDiagnosticsResponse" - }, - "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." + "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.", + "type": "string" }, - "interconnect": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "code": { "type": "string", - "description": "Name of the interconnect resource to query.", - "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" + ] + }, + "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" } }, - "id": "compute.interconnects.getDiagnostics", - "flatPath": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics" + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "get": { - "path": "projects/{project}/global/interconnects/{interconnect}", - "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" - ], - "response": { - "$ref": "Interconnect" - }, - "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])?))" - }, - "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.", - "required": true, - "type": "string", - "location": "path" - } + "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" + } + }, + "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" }, - "flatPath": "projects/{project}/global/interconnects/{interconnect}", - "id": "compute.interconnects.get", - "httpMethod": "GET" + "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" }, - "setLabels": { - "description": "Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.", - "response": { - "$ref": "Operation" + "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" }, - "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, + "description": "A list of NodeTemplate resources." + }, + "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" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, - "resource": { - "location": "path", + "code": { "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." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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.interconnects.setLabels", - "path": "projects/{project}/global/interconnects/{resource}/setLabels", - "parameterOrder": [ - "project", - "resource" - ], - "flatPath": "projects/{project}/global/interconnects/{resource}/setLabels", - "request": { - "$ref": "GlobalSetLabelsRequest" } }, - "insert": { - "flatPath": "projects/{project}/global/interconnects", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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)." + }, + "status": { + "enumDescriptions": [ + "The InterconnectLocation is available for provisioning new Interconnects.", + "The InterconnectLocation is closed for provisioning new Interconnects." ], - "id": "compute.interconnects.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])?))", - "description": "Project ID for this request.", - "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)." - } - }, - "path": "projects/{project}/global/interconnects", - "request": { - "$ref": "Interconnect" - }, - "parameterOrder": [ - "project" + "type": "string", + "enum": [ + "AVAILABLE", + "CLOSED" ], - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "description": "Creates a Interconnect in the specified project using the data included in the request." + "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. " }, - "patch": { - "id": "compute.interconnects.patch", - "flatPath": "projects/{project}/global/interconnects/{interconnect}", - "parameterOrder": [ - "project", - "interconnect" - ], - "response": { - "$ref": "Operation" - }, - "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" + }, + "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" + }, + "continent": { + "enum": [ + "AFRICA", + "ASIA_PAC", + "C_AFRICA", + "C_ASIA_PAC", + "C_EUROPE", + "C_NORTH_AMERICA", + "C_SOUTH_AMERICA", + "EUROPE", + "NORTH_AMERICA", + "SOUTH_AMERICA" ], - "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.", - "request": { - "$ref": "Interconnect" - }, - "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).", - "location": "query", - "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" - }, - "interconnect": { - "description": "Name of the interconnect to update.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string", - "location": "path" - } - }, - "path": "projects/{project}/global/interconnects/{interconnect}" + "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": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "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" }, - "addresses": { - "methods": { - "setLabels": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.addresses.setLabels", - "flatPath": "projects/{project}/regions/{region}/addresses/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "description": "Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.", - "response": { - "$ref": "Operation" + "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" }, - "path": "projects/{project}/regions/{region}/addresses/{resource}/setLabels", - "httpMethod": "POST", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "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])?))" - }, - "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 - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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, - "description": "The region for this request.", - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - } - } + "type": "array" }, - "insert": { - "flatPath": "projects/{project}/regions/{region}/addresses", - "path": "projects/{project}/regions/{region}/addresses", - "httpMethod": "POST", - "request": { - "$ref": "Address" + "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" }, - "description": "Creates an address resource in the specified project by using the data included in the request.", - "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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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)." - } + "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" }, - "parameterOrder": [ - "project", - "region" + "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" ], - "id": "compute.addresses.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "Show the health status for each network endpoint. Impacts latency of the call.", + "Health status for network endpoints will not be provided." ], - "response": { - "$ref": "Operation" - } + "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" }, - "aggregatedList": { - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/aggregated/addresses", - "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`)", - "type": "integer", - "format": "uint32", - "default": "500", - "minimum": "0" - }, - "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", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "type": "boolean" + "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\" } " }, - "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" + "description": "[Output Only] A human-readable description of the warning code." }, - "project": { - "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, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { - "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": { - "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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." } + } + }, + "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." }, - "path": "projects/{project}/aggregated/addresses", - "httpMethod": "GET", - "id": "compute.addresses.aggregatedList", - "response": { - "$ref": "AddressAggregatedList" - }, - "description": "Retrieves an aggregated list of addresses.", - "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 TargetVpnGateway resources.", + "type": "object" }, - "delete": { - "id": "compute.addresses.delete", - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "type": "array", + "items": { + "type": "string" + }, + "description": "[Output Only] Unreachable resources." + } + }, + "id": "TargetVpnGatewayAggregatedList" + }, + "DisksScopedList": { + "id": "DisksScopedList", + "type": "object", + "properties": { + "warning": { + "type": "object", + "properties": { + "message": { "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": "[Output Only] A human-readable description of the warning code." }, - "address": { - "location": "path", - "description": "Name of the address resource to delete.", + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true - }, - "region": { - "required": true, - "description": "Name of the region for this request.", - "pattern": "[a-z](?:[-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." }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { + "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)." + } + } + } } }, - "parameterOrder": [ - "project", - "region", - "address" - ], - "response": { - "$ref": "Operation" + "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty." + }, + "disks": { + "type": "array", + "items": { + "$ref": "Disk" }, - "path": "projects/{project}/regions/{region}/addresses/{address}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "DELETE", - "description": "Deletes the specified address resource.", - "flatPath": "projects/{project}/regions/{region}/addresses/{address}" + "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" + }, + "type": "object", + "description": "An object that contains a list of instances scoped by zone." }, - "get": { - "response": { - "$ref": "Address" + "unreachables": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/regions/{region}/addresses/{address}", - "description": "Returns the specified address resource.", - "id": "compute.addresses.get", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project", - "region", - "address" - ], - "path": "projects/{project}/regions/{region}/addresses/{address}", - "parameters": { - "region": { - "description": "Name of the region for this request.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true + "description": "[Output Only] Unreachable resources.", + "type": "array" + }, + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." + }, + "kind": { + "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.", + "default": "compute#instanceAggregatedList", + "type": "string" + }, + "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" }, - "address": { - "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 address resource to return.", - "type": "string" + "message": { + "type": "string", + "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, - "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." + ], + "description": "[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" } } }, - "list": { - "id": "compute.addresses.list", - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/addresses", - "parameterOrder": [ - "project", - "region" - ], - "description": "Retrieves a list of addresses contained within the specified region.", - "path": "projects/{project}/regions/{region}/addresses", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "AddressList" + "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." + } + } + }, + "ServiceAttachmentsScopedList": { + "properties": { + "serviceAttachments": { + "type": "array", + "items": { + "$ref": "ServiceAttachment" }, - "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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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": { + "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": { "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", - "location": "query", - "type": "integer", - "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "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 + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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." + "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\" } " } } } - } + }, + "id": "ServiceAttachmentsScopedList", + "type": "object" }, - "regionAutoscalers": { - "methods": { - "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" - }, - "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 - }, - "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])?))" - }, - "autoscaler": { - "type": "string", - "description": "Name of the autoscaler to delete.", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } + "TargetPoolsAddInstanceRequest": { + "type": "object", + "properties": { + "instances": { + "items": { + "$ref": "InstanceReference" }, - "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "autoscaler" - ], - "response": { - "$ref": "Operation" + "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" }, - "description": "Deletes the specified autoscaler.", - "id": "compute.regionAutoscalers.delete" + "type": "array" }, - "get": { - "description": "Returns the specified autoscaler.", - "httpMethod": "GET", - "response": { - "$ref": "Autoscaler" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project", - "region", - "autoscaler" - ], - "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", - "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 + "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" + }, + "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" + } }, - "autoscaler": { - "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 autoscaler to return." + "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])?", - "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", - "required": true, - "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." + ], + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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}/autoscalers/{autoscaler}", - "id": "compute.regionAutoscalers.get" + } }, - "list": { - "httpMethod": "GET", - "response": { - "$ref": "RegionAutoscalerList" + "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." + ], + "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" + }, + "etag": { + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", + "type": "string", + "format": "byte" + }, + "bindings": { + "items": { + "$ref": "Binding" }, - "id": "compute.regionAutoscalers.list", - "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." - }, - "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": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", + "type": "array" + } + } + }, + "InstanceGroupManagersScopedList": { + "type": "object", + "id": "InstanceGroupManagersScopedList", + "properties": { + "instanceGroupManagers": { + "items": { + "$ref": "InstanceGroupManager" + }, + "type": "array", + "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone." + }, + "warning": { + "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.", + "type": "object", + "properties": { + "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" - }, - "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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." + ] }, - "region": { - "description": "Name of the region scoping this request.", - "required": true, + "message": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." }, - "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" + "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" + } + } + } } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + } + } + } + }, + "HTTPSHealthCheck": { + "properties": { + "proxyHeader": { + "enumDescriptions": [ + "", + "" ], - "flatPath": "projects/{project}/regions/{region}/autoscalers", - "path": "projects/{project}/regions/{region}/autoscalers", - "description": "Retrieves a list of autoscalers contained within the specified region.", - "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.", + "type": "string", + "enum": [ + "NONE", + "PROXY_V1" ] }, - "patch": { - "path": "projects/{project}/regions/{region}/autoscalers", - "parameterOrder": [ - "project", - "region" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "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." ], - "request": { - "$ref": "Autoscaler" - }, - "id": "compute.regionAutoscalers.patch", - "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.", - "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 - }, - "autoscaler": { - "location": "query", - "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}" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", - "type": "string", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true - } - }, - "httpMethod": "PATCH", - "flatPath": "projects/{project}/regions/{region}/autoscalers", - "response": { - "$ref": "Operation" - } + "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" + ] }, - "update": { - "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", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "Name of the region scoping this request." + "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" + } }, - "autoscaler": { - "location": "query", - "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", - "description": "Name of the autoscaler to update." + "description": "[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", - "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])?))" + "description": "[Output Only] A human-readable description of the warning code." } }, - "request": { - "$ref": "Autoscaler" - }, - "path": "projects/{project}/regions/{region}/autoscalers", - "flatPath": "projects/{project}/regions/{region}/autoscalers", - "httpMethod": "PUT", - "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" - ], - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region" - ], - "id": "compute.regionAutoscalers.update" + "type": "object", + "description": "[Output Only] Informational warning message." }, - "insert": { - "flatPath": "projects/{project}/regions/{region}/autoscalers", - "request": { + "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" - }, - "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" - }, - "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": { - "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])?" - } - }, - "path": "projects/{project}/regions/{region}/autoscalers", - "httpMethod": "POST", - "description": "Creates an autoscaler in the specified project using the data included in the request.", - "parameterOrder": [ - "project", - "region" - ], - "id": "compute.regionAutoscalers.insert", - "response": { - "$ref": "Operation" } } - } + }, + "type": "object", + "description": "Contains a list of Autoscaler resources.", + "id": "AutoscalerList" }, - "backendServices": { - "methods": { - "setIamPolicy": { - "request": { - "$ref": "GlobalSetPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "parameters": { - "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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } - }, - "parameterOrder": [ - "project", - "resource" - ], - "flatPath": "projects/{project}/global/backendServices/{resource}/setIamPolicy", - "response": { - "$ref": "Policy" - }, - "httpMethod": "POST", - "path": "projects/{project}/global/backendServices/{resource}/setIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.backendServices.setIamPolicy" + "UrlMapsAggregatedList": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." }, - "setEdgeSecurityPolicy": { - "path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", - "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" - ], - "id": "compute.backendServices.setEdgeSecurityPolicy", - "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 - }, - "backendService": { + "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.", "type": "string", - "required": true, - "description": "Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.", - "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." + ] }, - "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" - } - }, - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", - "request": { - "$ref": "SecurityPolicyReference" - }, - "parameterOrder": [ - "project", - "backendService" - ] - }, - "insert": { - "parameterOrder": [ - "project" - ], - "httpMethod": "POST", - "description": "Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .", - "flatPath": "projects/{project}/global/backendServices", - "path": "projects/{project}/global/backendServices", - "id": "compute.backendServices.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": { - "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": { + "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" + } + } + } } + } + }, + "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." }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "BackendService" + "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" } }, - "getHealth": { - "path": "projects/{project}/global/backendServices/{backendService}/getHealth", - "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }", - "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" - }, - "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 which the queried instance belongs.", - "required": true, - "location": "path", - "type": "string" - } + "aliases": { + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "backendService" + "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": [ + "", + "", + "" ], - "httpMethod": "POST", - "response": { - "$ref": "BackendServiceGroupHealth" - }, - "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth", - "id": "compute.backendServices.getHealth", - "request": { - "$ref": "ResourceGroupReference" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "enum": [ + "ALWAYS_PERSIST", + "DEFAULT_FOR_PROTOCOL", + "NEVER_PERSIST" + ], + "type": "string" }, - "getIamPolicy": { - "flatPath": "projects/{project}/global/backendServices/{resource}/getIamPolicy", - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "path": "projects/{project}/global/backendServices/{resource}/getIamPolicy", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "enableStrongAffinity": { + "type": "boolean", + "description": "Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly." + }, + "trackingMode": { + "enumDescriptions": [ + "", + "", + "" ], - "response": { - "$ref": "Policy" - }, - "id": "compute.backendServices.getIamPolicy", - "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}" - }, - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "location": "query", - "format": "int32", - "type": "integer" - }, - "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])?))" - } - }, - "parameterOrder": [ - "project", - "resource" - ] + "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).", + "type": "string" }, - "delete": { - "path": "projects/{project}/global/backendServices/{backendService}", - "description": "Deletes the specified BackendService resource.", - "response": { - "$ref": "Operation" - }, - "httpMethod": "DELETE", - "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 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])?))", - "type": "string", - "required": true, - "description": "Project ID for this request.", - "location": "path" - } - }, - "flatPath": "projects/{project}/global/backendServices/{backendService}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + } + } + }, + "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" ], - "id": "compute.backendServices.delete", - "parameterOrder": [ - "project", - "backendService" + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" ] }, - "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, - "location": "path", - "description": "Project ID for this request." - }, - "backendService": { - "description": "Name of the BackendService 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}" - } - }, - "response": { - "$ref": "BackendService" - }, - "parameterOrder": [ - "project", - "backendService" - ], - "description": "Returns the specified BackendService resource. Gets a list of available backend services.", - "path": "projects/{project}/global/backendServices/{backendService}", - "id": "compute.backendServices.get", - "flatPath": "projects/{project}/global/backendServices/{backendService}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "httpMethod": "GET" + "httpHealthCheck": { + "$ref": "HTTPHealthCheck" }, - "addSignedUrlKey": { - "response": { - "$ref": "Operation" + "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])?" + }, + "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" }, - "id": "compute.backendServices.addSignedUrlKey", - "request": { - "$ref": "SignedUrlKey" + "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" + }, + "kind": { + "description": "Type of resource.", + "type": "string", + "default": "compute#sslCertificateList" + }, + "items": { + "items": { + "$ref": "SslCertificate" }, - "path": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey", - "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", + "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." + }, + "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\" } " + }, + "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", - "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." - }, - "backendService": { - "location": "path", + "message": { "type": "string", - "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.", - "required": true + "description": "[Output Only] A human-readable description of the warning code." } }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey", - "parameterOrder": [ - "project", - "backendService" - ], - "description": "Adds a key for validating requests with signed URLs for this backend service." + "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" }, - "setSecurityPolicy": { - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "SecurityPolicyReference" - }, - "flatPath": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy", - "parameterOrder": [ - "project", - "backendService" - ], - "path": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy", - "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])?))", - "required": true, - "type": "string", - "description": "Project ID for this request.", - "location": "path" - }, - "backendService": { - "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to 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" - } - }, - "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview", - "id": "compute.backendServices.setSecurityPolicy" + "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" }, - "list": { - "response": { - "$ref": "BackendServiceList" - }, - "path": "projects/{project}/global/backendServices", - "description": "Retrieves the list of BackendService resources 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.", - "type": "string", - "location": "query" - }, - "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" - }, - "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": { - "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." - } - }, - "id": "compute.backendServices.list", - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/global/backendServices", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "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" }, - "update": { - "description": "Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/backendServices/{backendService}", - "id": "compute.backendServices.update", - "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": { - "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": { - "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 BackendService resource to update." - } - }, - "parameterOrder": [ - "project", - "backendService" - ], - "request": { - "$ref": "BackendService" - }, - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/backendServices/{backendService}" + "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" }, - "deleteSignedUrlKey": { - "parameterOrder": [ - "project", - "backendService", - "keyName" - ], - "flatPath": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey", - "path": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey", - "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", - "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)." - }, - "keyName": { - "type": "string", - "description": "The name of the Signed URL Key to delete.", - "required": true, - "location": "query" - }, - "backendService": { - "location": "path", - "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.", - "required": true, - "type": "string" - } - }, - "id": "compute.backendServices.deleteSignedUrlKey", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Deletes a key for validating requests with signed URLs for this backend service.", - "httpMethod": "POST", - "response": { - "$ref": "Operation" + "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" } }, - "aggregatedList": { - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/aggregated/backendServices", - "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": { - "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`.", - "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." - }, - "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": { - "location": "path", - "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])?))" - }, - "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": { - "location": "query", - "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`)" - } - }, - "path": "projects/{project}/aggregated/backendServices", - "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.", - "id": "compute.backendServices.aggregatedList", - "response": { - "$ref": "BackendServiceAggregatedList" + "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" } }, - "patch": { - "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", - "description": "Project ID for this request.", - "required": true - }, - "backendService": { - "type": "string", - "required": true, - "description": "Name of the BackendService resource to patch.", - "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)." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "backendService" - ], - "flatPath": "projects/{project}/global/backendServices/{backendService}", - "path": "projects/{project}/global/backendServices/{backendService}", - "response": { - "$ref": "Operation" - }, - "id": "compute.backendServices.patch", - "request": { - "$ref": "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" + "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" } } }, - "externalVpnGateways": { - "methods": { - "list": { - "parameterOrder": [ - "project" + "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" + } + }, + "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." ], - "httpMethod": "GET", - "id": "compute.externalVpnGateways.list", - "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" - }, - "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" - }, - "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", + "enum": [ + "MATCH_ALL", + "MATCH_ANY", + "NOT_SET" + ] + } + }, + "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" + }, + "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.", "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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.", - "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 + "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\" } " }, - "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": "ExternalVpnGatewayList" - }, - "flatPath": "projects/{project}/global/externalVpnGateways", - "description": "Retrieves the list of ExternalVpnGateway available to the specified project.", - "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" - ] - }, - "setLabels": { - "path": "projects/{project}/global/externalVpnGateways/{resource}/setLabels", - "description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.", - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "GlobalSetLabelsRequest" - }, - "parameterOrder": [ - "project", - "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])?))", - "location": "path", - "description": "Project ID for this request.", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" - }, - "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" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": [ + "" ], - "id": "compute.externalVpnGateways.setLabels", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/setLabels" + "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" + ] }, - "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])?))", - "location": "path", - "type": "string", - "description": "Project ID for this request." - }, - "externalVpnGateway": { - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the externalVpnGateway to return.", - "required": true - } - }, - "parameterOrder": [ - "project", - "externalVpnGateway" + "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" ], - "id": "compute.externalVpnGateways.get", - "description": "Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.", - "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" + "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}/global/externalVpnGateways/{externalVpnGateway}", - "httpMethod": "GET", - "response": { - "$ref": "ExternalVpnGateway" - } + "type": "string" + } + } + }, + "BackendServiceCdnPolicy": { + "type": "object", + "properties": { + "cacheKeyPolicy": { + "description": "The CacheKeyPolicy for this CdnPolicy.", + "$ref": "CacheKeyPolicy" }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/externalVpnGateways", - "parameterOrder": [ - "project" - ], - "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.", - "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}/global/externalVpnGateways", - "response": { - "$ref": "Operation" - }, - "id": "compute.externalVpnGateways.insert", - "description": "Creates a ExternalVpnGateway in the specified project using the data included in the request.", - "request": { - "$ref": "ExternalVpnGateway" + "bypassCacheOnRequestHeaders": { + "type": "array", + "items": { + "$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader" }, - "httpMethod": "POST" + "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." }, - "testIamPermissions": { - "response": { - "$ref": "TestPermissionsResponse" - }, - "description": "Returns permissions that a caller has on the specified resource.", - "httpMethod": "POST", - "parameterOrder": [ - "project", - "resource" + "cacheMode": { + "enum": [ + "CACHE_ALL_STATIC", + "FORCE_CACHE_ALL", + "INVALID_CACHE_MODE", + "USE_ORIGIN_HEADERS" ], - "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", - "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])?))" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "type": "string", - "required": true, - "location": "path", - "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" + "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." ], - "path": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" + "type": "string" + }, + "signedUrlKeyNames": { + "items": { + "type": "string" }, - "id": "compute.externalVpnGateways.testIamPermissions" + "type": "array", + "description": "[Output Only] Names of the keys for signing request URLs." }, - "delete": { - "parameterOrder": [ - "project", - "externalVpnGateway" - ], - "httpMethod": "DELETE", - "id": "compute.externalVpnGateways.delete", - "response": { - "$ref": "Operation" + "negativeCachingPolicy": { + "type": "array", + "items": { + "$ref": "BackendServiceCdnPolicyNegativeCachingPolicy" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", - "description": "Deletes the specified externalVpnGateway.", - "flatPath": "projects/{project}/global/externalVpnGateways/{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)." - }, - "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" - }, - "externalVpnGateway": { - "required": true, - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the externalVpnGateways to delete." - } - } + "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" + }, + "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" }, - "autoscalers": { - "methods": { - "get": { - "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", - "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}/autoscalers/{autoscaler}", - "description": "Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.", - "parameterOrder": [ - "project", - "zone", - "autoscaler" - ], - "httpMethod": "GET", - "response": { - "$ref": "Autoscaler" - }, - "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" - }, - "autoscaler": { - "required": true, - "type": "string", - "description": "Name of the autoscaler to return.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path" - }, - "zone": { - "description": "Name of the zone for this request.", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - } + "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" }, - "id": "compute.autoscalers.get" + "type": "array" }, - "aggregatedList": { - "description": "Retrieves an aggregated list of autoscalers.", - "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." - }, - "maxResults": { - "default": "500", - "type": "integer", - "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`)" - }, - "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" - }, - "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" - }, - "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 - } + "drainAutoAllocatedNatIps": { + "items": { + "type": "string" }, - "path": "projects/{project}/aggregated/autoscalers", - "flatPath": "projects/{project}/aggregated/autoscalers", - "httpMethod": "GET", - "response": { - "$ref": "AutoscalerAggregatedList" + "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", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.autoscalers.aggregatedList", - "parameterOrder": [ - "project" - ] + "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]" }, - "update": { - "response": { - "$ref": "Operation" + "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" + } + }, + "userAllocatedNatIpResources": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/zones/{zone}/autoscalers", - "request": { - "$ref": "Autoscaler" + "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.autoscalers.update", - "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).", - "location": "query", + "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." + ], "type": "string" }, - "autoscaler": { - "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}", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, - "zone": { - "required": true, - "type": "string", - "description": "Name of the zone for this request.", - "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])?))", - "description": "Project ID for this request.", - "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\" } ", + "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" } }, - "httpMethod": "PUT", - "path": "projects/{project}/zones/{zone}/autoscalers", - "description": "Updates an autoscaler in the specified project using the data included in the request.", - "parameterOrder": [ - "project", - "zone" - ] + "description": "[Output Only] Informational warning message." }, - "delete": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", - "description": "Deletes the specified autoscaler.", - "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", - "parameters": { - "autoscaler": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the autoscaler to delete.", - "required": true, - "location": "path" - }, - "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." - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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", - "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)." - } + "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": "HttpHealthCheck" }, - "id": "compute.autoscalers.delete", - "parameterOrder": [ - "project", - "zone", - "autoscaler" - ], - "response": { - "$ref": "Operation" + "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" }, - "httpMethod": "DELETE" + "type": "object" }, - "insert": { - "path": "projects/{project}/zones/{zone}/autoscalers", - "flatPath": "projects/{project}/zones/{zone}/autoscalers", - "parameterOrder": [ - "project", - "zone" - ], - "parameters": { - "requestId": { + "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" + }, + "description": "[Output Only] Unreachable resources." + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "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": { - "description": "Name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-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." + ], + "description": "[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": { - "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 + "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" + } } - }, - "httpMethod": "POST", - "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.", - "response": { - "$ref": "Operation" - }, - "id": "compute.autoscalers.insert", - "request": { - "$ref": "Autoscaler" } + } + }, + "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." }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "AutoscalerList" + "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" }, - "flatPath": "projects/{project}/zones/{zone}/autoscalers", - "parameterOrder": [ - "project", - "zone" - ], - "httpMethod": "GET", - "id": "compute.autoscalers.list", - "description": "Retrieves a list of autoscalers contained within the specified zone.", - "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" - }, - "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, - "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])?))" - }, - "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", - "location": "query", - "format": "uint32", - "minimum": "0" - }, - "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string", - "location": "path", - "description": "Name of the zone for this request." + "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" + }, + "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" }, - "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." }, - "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": { "type": "string", - "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." } - }, - "path": "projects/{project}/zones/{zone}/autoscalers" + } }, - "patch": { - "id": "compute.autoscalers.patch", - "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.", - "flatPath": "projects/{project}/zones/{zone}/autoscalers", - "parameterOrder": [ - "project", - "zone" - ], - "response": { - "$ref": "Operation" - }, - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/zones/{zone}/autoscalers", - "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 - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" - }, - "autoscaler": { - "description": "Name of the autoscaler to patch.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "query", - "type": "string" - }, - "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" - } - }, - "request": { - "$ref": "Autoscaler" + "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" } + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.", + "default": "compute#interconnectList" } - } + }, + "id": "InterconnectList" }, - "targetPools": { - "methods": { - "delete": { - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", - "parameters": { - "region": { - "description": "Name of the region scoping this request.", - "required": true, - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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.", "type": "string" }, - "targetPool": { - "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}", + "code": { "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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." + ] }, - "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": { + "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" + } + } + } } }, - "httpMethod": "DELETE", - "description": "Deletes the specified target pool.", - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "object" + }, + "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" ], - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", - "id": "compute.targetPools.delete" + "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." + ] + } + } + }, + "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" }, - "getHealth": { - "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 - }, - "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": { - "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 which the queried instance belongs.", - "location": "path", - "required": true + "privateKey": { + "description": "A write-only private key in PEM format. Only insert requests will include this field.", + "type": "string" + } + }, + "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" + } + } + } + } } - }, - "response": { - "$ref": "TargetPoolInstanceHealth" - }, - "parameterOrder": [ - "project", - "region", - "targetPool" + } + }, + "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." + }, + "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" + } + }, + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." + }, + "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" ], - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", - "id": "compute.targetPools.getHealth", - "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", - "request": { - "$ref": "InstanceReference" + "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." + ] + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "enabledFeatures": { + "items": { + "type": "string" }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", - "httpMethod": "POST" + "description": "[Output Only] The list of features enabled in the SSL policy.", + "type": "array" }, - "insert": { - "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])?))", + "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": { "type": "string", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "code": { "type": "string", - "required": true, - "description": "Name of the region scoping this request.", - "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" + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", - "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": { + "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" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "TargetPool" - }, - "flatPath": "projects/{project}/regions/{region}/targetPools", - "response": { - "$ref": "Operation" + "description": "[Output Only] Informational warning message.", + "type": "object" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" }, - "id": "compute.targetPools.insert", - "path": "projects/{project}/regions/{region}/targetPools", - "description": "Creates a target pool in the specified project and region using the data included in the request.", - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "POST" + "type": "array" }, - "addInstance": { - "request": { - "$ref": "TargetPoolsAddInstanceRequest" + "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" }, - "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 - }, - "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 - }, - "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 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" + } + } + }, + "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'." + } }, - "targetPool": { - "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 TargetPool resource to add instances to." + "type": "object" + } + }, + "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." + } } - }, - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "description": "Adds an instance to a target pool.", - "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" + }, + "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" + }, + "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." + }, + "operationalStatus": { + "type": "string", + "enumDescriptions": [ + "The interface is unable to communicate with the remote end.", + "The interface has low level communication with the remote end." ], - "id": "compute.targetPools.addInstance" + "description": "The operational status of the link.", + "enum": [ + "LINK_OPERATIONAL_STATUS_DOWN", + "LINK_OPERATIONAL_STATUS_UP" + ] }, - "removeInstance": { - "id": "compute.targetPools.removeInstance", - "request": { - "$ref": "TargetPoolsRemoveInstanceRequest" + "googleDemarc": { + "type": "string", + "description": "The Demarc address assigned by Google and provided in the LoA." + }, + "lacpStatus": { + "$ref": "InterconnectDiagnosticsLinkLACPStatus" + }, + "arpCaches": { + "type": "array", + "items": { + "$ref": "InterconnectDiagnosticsARPEntry" }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", - "parameterOrder": [ - "project", - "region", - "targetPool" + "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" + }, + "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." ], - "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" ], - "httpMethod": "POST", - "response": { - "$ref": "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" - }, - "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 - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", - "required": true - } - }, - "description": "Removes instance URL from a target pool." + "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." }, - "addHealthCheck": { - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "request": { - "$ref": "TargetPoolsAddHealthCheckRequest" - }, - "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 - }, - "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." - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" - }, - "targetPool": { - "description": "Name of the target pool to add a health check to.", - "required": true, - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } - }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", - "id": "compute.targetPools.addHealthCheck", - "response": { - "$ref": "Operation" - }, - "description": "Adds health check URLs to a target pool.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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." }, - "aggregatedList": { - "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", - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "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" - }, - "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" - }, - "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" - } - }, - "id": "compute.targetPools.aggregatedList", - "path": "projects/{project}/aggregated/targetPools", - "response": { - "$ref": "TargetPoolAggregatedList" - }, - "description": "Retrieves an aggregated list of target pools.", - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/targetPools", - "parameterOrder": [ - "project" - ] + "kind": { + "type": "string", + "default": "compute#httpHealthCheck", + "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks." }, - "removeHealthCheck": { - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", - "httpMethod": "POST", - "description": "Removes health check URL from a target pool.", - "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", - "description": "Project ID for this request.", - "location": "path", - "required": true - }, - "targetPool": { - "location": "path", - "description": "Name of the target pool to remove health checks from.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string", - "required": true - }, - "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" - }, - "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.targetPools.removeHealthCheck", - "request": { - "$ref": "TargetPoolsRemoveHealthCheckRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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." }, - "get": { - "parameters": { - "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - }, - "targetPool": { - "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 TargetPool resource to return." - } - }, - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", - "description": "Returns the specified target pool. Gets a list of available target pools by making a list() request.", - "httpMethod": "GET", - "response": { - "$ref": "TargetPool" - }, - "id": "compute.targetPools.get", - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "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." }, - "setBackup": { - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Changes a backup target pool's configurations.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "id": "compute.targetPools.setBackup", - "request": { - "$ref": "TargetReference" + "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." + }, + "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" }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", - "parameters": { - "targetPool": { - "location": "path", - "required": true, - "description": "Name of the TargetPool resource to set a backup pool for.", - "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])?))", - "location": "path", - "required": true, - "description": "Project ID for this request.", - "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" + } }, - "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." + ], "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" + ], + "description": "[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, + "message": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "location": "path" - }, - "failoverRatio": { - "location": "query", - "description": "New failoverRatio value for the target pool.", - "format": "float", - "type": "number" + "description": "[Output Only] A human-readable description of the warning code." } }, - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup" + "type": "object", + "description": "Informational warning which replaces the list of security policies when the list is empty." }, - "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 target pools available to the specified project and region.", - "id": "compute.targetPools.list", - "flatPath": "projects/{project}/regions/{region}/targetPools", - "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." - }, - "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 - }, - "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." - }, - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" - }, - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer", - "default": "500", - "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." - } - }, - "response": { - "$ref": "TargetPoolList" + "networkEdgeSecurityServices": { + "description": "A list of NetworkEdgeSecurityServices contained in this scope.", + "items": { + "$ref": "NetworkEdgeSecurityService" }, - "path": "projects/{project}/regions/{region}/targetPools", - "parameterOrder": [ - "project", - "region" - ] + "type": "array" } } }, - "regionHealthCheckServices": { - "methods": { - "list": { - "description": "Lists all the HealthCheckService resources that have been configured for the specified project in the given region.", - "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": { - "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 - }, - "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" - }, - "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." - }, - "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", - "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" - } - }, - "flatPath": "projects/{project}/regions/{region}/healthCheckServices", - "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}/healthCheckServices", - "id": "compute.regionHealthCheckServices.list", - "response": { - "$ref": "HealthCheckServicesList" - }, - "parameterOrder": [ - "project", - "region" - ] + "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" + } }, - "insert": { - "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string", - "required": true, - "description": "Name of the region scoping this request." + "warning": { + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "requestId": { - "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.", "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" + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 + "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" + } + } + } } }, - "request": { - "$ref": "HealthCheckService" + "type": "object", + "description": "Informational warning which replaces the list of SSL policies when the list is empty." + } + } + }, + "ExchangedPeeringRoutesList": { + "type": "object", + "properties": { + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "items": { + "items": { + "$ref": "ExchangedPeeringRoute" }, - "path": "projects/{project}/regions/{region}/healthCheckServices", - "id": "compute.regionHealthCheckServices.insert", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/healthCheckServices", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.", - "parameterOrder": [ - "project", - "region" - ], - "response": { - "$ref": "Operation" - } + "description": "A list of ExchangedPeeringRoute resources.", + "type": "array" }, - "get": { - "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", - "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." + "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\" } " }, - "healthCheckService": { + "message": { "type": "string", - "location": "path", - "required": true, - "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." }, - "project": { - "description": "Project ID for this request.", - "required": true, + "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" + "description": "[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": "Returns the specified regional HealthCheckService resource.", - "response": { - "$ref": "HealthCheckService" - }, - "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}/healthCheckServices/{healthCheckService}", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "region", - "healthCheckService" - ], - "id": "compute.regionHealthCheckServices.get" + "description": "[Output Only] Informational warning message." }, - "delete": { - "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", - "description": "Deletes the specified regional HealthCheckService.", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", - "id": "compute.regionHealthCheckServices.delete", - "parameterOrder": [ - "project", - "region", - "healthCheckService" - ], - "parameters": { - "healthCheckService": { - "description": "Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.", - "required": true, - "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)." + "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." + } + }, + "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" + } }, - "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])?))", - "location": "path", - "required": true, - "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." + ] }, - "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" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": "Informational warning which replaces the list of network attachments when the list is empty.", + "type": "object" }, - "patch": { - "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", - "id": "compute.regionHealthCheckServices.patch", - "httpMethod": "PATCH", - "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.", - "request": { - "$ref": "HealthCheckService" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "region", - "healthCheckService" - ], - "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", - "parameters": { - "region": { - "location": "path", - "description": "Name of the region scoping this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "healthCheckService": { - "location": "path", - "type": "string", - "required": true, - "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035." - }, - "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])?))", - "required": true, - "location": "path", - "type": "string", - "description": "Project ID for this request." - } + "networkAttachments": { + "description": "A list of NetworkAttachments contained in this scope.", + "type": "array", + "items": { + "$ref": "NetworkAttachment" } } } }, - "sslCertificates": { - "methods": { - "insert": { - "parameterOrder": [ - "project" + "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" + }, + "pscConnectionStatus": { + "description": "[Output Only] The connection status of the PSC Forwarding Rule.", + "enum": [ + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": "Creates a SslCertificate resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/sslCertificates", - "httpMethod": "POST", - "path": "projects/{project}/global/sslCertificates", - "id": "compute.sslCertificates.insert", - "request": { - "$ref": "SslCertificate" - }, - "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" - }, - "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": "string" }, - "get": { - "response": { - "$ref": "SslCertificate" - }, - "httpMethod": "GET", - "id": "compute.sslCertificates.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" + }, + "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" ], - "description": "Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.", - "parameters": { - "sslCertificate": { - "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}", - "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])?))", - "description": "Project ID for this request.", - "location": "path", - "required": true - } + "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." + ], + "type": "string" + }, + "proxyHeader": { + "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.", + "enumDescriptions": [ + "", + "" + ] + }, + "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" }, - "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", - "parameterOrder": [ - "project", - "sslCertificate" - ], - "path": "projects/{project}/global/sslCertificates/{sslCertificate}" + "description": "This is deprecated and has no effect. Do not use." }, - "list": { - "parameterOrder": [ - "project" - ], - "description": "Retrieves the list of SslCertificate resources available to the specified project.", - "path": "projects/{project}/global/sslCertificates", - "httpMethod": "GET", - "id": "compute.sslCertificates.list", - "response": { - "$ref": "SslCertificateList" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - }, - "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`)", - "default": "500", - "type": "integer", - "minimum": "0", - "format": "uint32", - "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": "string" - } + "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" + } + }, + "nats": { + "type": "array", + "items": { + "$ref": "RouterNat" }, - "flatPath": "projects/{project}/global/sslCertificates" + "description": "A list of NAT services created in this router." }, - "delete": { - "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", - "id": "compute.sslCertificates.delete", - "parameterOrder": [ - "project", - "sslCertificate" - ], - "response": { - "$ref": "Operation" + "md5AuthenticationKeys": { + "items": { + "$ref": "RouterMd5AuthenticationKey" }, - "path": "projects/{project}/global/sslCertificates/{sslCertificate}", - "description": "Deletes the specified SslCertificate resource.", - "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" - }, - "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.", - "location": "path", - "type": "string", - "required": true - } + "description": "Keys used for MD5 authentication.", + "type": "array" + }, + "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" + ] + } + }, + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "DELETE" + "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." }, - "aggregatedList": { - "httpMethod": "GET", - "path": "projects/{project}/aggregated/sslCertificates", - "parameterOrder": [ - "project" - ], - "id": "compute.sslCertificates.aggregatedList", - "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": { - "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": "Name of the project scoping 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" - }, - "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", - "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`)" - }, - "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`." - } + "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" + }, + "network": { + "annotations": { + "required": [ + "compute.routers.insert", + "compute.routers.update" + ] }, - "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 SslCertificate resources, regional and global, available to the specified project.", - "flatPath": "projects/{project}/aggregated/sslCertificates", - "response": { - "$ref": "SslCertificateAggregatedList" - } + "description": "URI of the network to which this router belongs.", + "type": "string" } - } + }, + "type": "object" }, - "nodeGroups": { - "methods": { - "setIamPolicy": { - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", - "request": { - "$ref": "ZoneSetPolicyRequest" + "GuestAttributesValue": { + "properties": { + "items": { + "items": { + "$ref": "GuestAttributesEntry" }, - "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" + ] }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "httpMethod": "POST", - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "id": "compute.nodeGroups.setIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "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" - }, - "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." - }, - "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}" - } + "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" } }, - "insert": { - "path": "projects/{project}/zones/{zone}/nodeGroups", - "description": "Creates a NodeGroup resource in the specified project using the data included in the request.", - "response": { - "$ref": "Operation" + "name": { + "description": "URL for the subnetwork resource that will use NAT.", + "type": "string" + } + }, + "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" }, - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + ] + }, + "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])?" + }, + "architecture": { + "description": "The architecture of the image. Valid values are ARM64 or X86_64.", + "type": "string", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" ], - "id": "compute.nodeGroups.insert", - "request": { - "$ref": "NodeGroup" + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ] + }, + "labels": { + "additionalProperties": { + "type": "string" }, - "parameterOrder": [ - "project", - "zone", - "initialNodeCount" + "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." ], - "parameters": { - "initialNodeCount": { - "location": "query", - "format": "int32", - "required": true, - "description": "Initial count of nodes in the node group.", - "type": "integer" - }, - "zone": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the zone for this request.", - "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" - }, - "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 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" + ] }, - "listNodes": { - "id": "compute.nodeGroups.listNodes", - "description": "Lists nodes in the node group.", - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", - "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." - }, - "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])?" - }, - "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", - "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" - }, - "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": { - "description": "Project ID for this request.", - "required": true, + "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." + }, + "id": { + "format": "uint64", + "type": "string", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." + }, + "sourceType": { + "type": "string", + "description": "The type of the image used to create this disk. The default and only valid value is RAW.", + "enumDescriptions": [ + "" + ], + "enum": [ + "RAW" + ], + "default": "RAW" + }, + "rawDisk": { + "description": "The parameters of the raw disk image.", + "properties": { + "containerType": { "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": [ + "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." }, - "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`.", + "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" }, - "nodeGroup": { - "location": "path", - "required": true, + "sha1Checksum": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the NodeGroup resource whose nodes you want to list." + "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." } }, - "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", - "response": { - "$ref": "NodeGroupsListNodes" + "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" }, - "parameterOrder": [ - "project", - "zone", - "nodeGroup" - ] + "description": "Cloud Storage bucket storage location of the image (regional or multi-regional)." }, - "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)." + "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" + }, + "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" + } + }, + "id": "Image" + }, + "RegionDisksRemoveResourcePoliciesRequest": { + "properties": { + "resourcePolicies": { + "items": { + "type": "string" + }, + "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" }, - "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 + "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" + } }, - "project": { - "description": "Project ID for this request.", + "message": { "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" - }, - "nodeGroup": { - "location": "path", - "required": true, - "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}", - "type": "string" + "description": "[Output Only] A human-readable description of the warning code." } + } + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "items": { + "items": { + "$ref": "MachineImage" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." + }, + "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" ], - "httpMethod": "DELETE", - "description": "Deletes the specified NodeGroup resource.", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", - "parameterOrder": [ - "project", - "zone", - "nodeGroup" + "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." ], - "id": "compute.nodeGroups.delete", - "response": { - "$ref": "Operation" + "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." + ], + "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" + } + } + }, + "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" }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}" + "description": "A list of InterconnectAttachmentsScopedList resources." }, - "aggregatedList": { - "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.", - "type": "boolean", - "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": { - "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." - }, - "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])?))" + "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." + }, + "unreachables": { + "items": { + "type": "string" + }, + "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" }, - "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" }, - "maxResults": { - "minimum": "0", - "type": "integer", - "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`)" + "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." } }, - "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" + } + } + }, + "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" + }, + "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" + ] + }, + "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." + }, + "region": { + "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).", + "type": "string" + }, + "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" + } + } + }, + "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" + }, + "deprecated": { + "$ref": "DeprecationStatus", + "description": "[Output Only] The deprecation status associated with this node type." + }, + "cpuPlatform": { + "description": "[Output Only] The CPU platform used by this node type.", + "type": "string" + }, + "zone": { + "description": "[Output Only] The name of the zone where the node 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 node type." + }, + "description": { + "description": "[Output Only] An optional textual description of the resource.", + "type": "string" + } + }, + "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" ], - "id": "compute.nodeGroups.aggregatedList", - "flatPath": "projects/{project}/aggregated/nodeGroups", - "parameterOrder": [ - "project" + "enumDescriptions": [ + "", + "" ], - "response": { - "$ref": "NodeGroupAggregatedList" - }, - "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.", - "path": "projects/{project}/aggregated/nodeGroups", - "httpMethod": "GET" + "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." }, - "patch": { - "httpMethod": "PATCH", - "description": "Updates the specified node group.", - "parameterOrder": [ - "project", - "zone", - "nodeGroup" + "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" ], - "request": { - "$ref": "NodeGroup" - }, - "response": { - "$ref": "Operation" - }, - "parameters": { - "nodeGroup": { - "description": "Name of the NodeGroup resource to update.", - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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.", - "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" - }, - "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." - } + "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" }, - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", - "id": "compute.nodeGroups.patch", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}" + "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." }, - "get": { - "id": "compute.nodeGroups.get", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone", - "nodeGroup" + "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" + } + }, + "advertiseMode": { + "enum": [ + "CUSTOM", + "DEFAULT" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "enumDescriptions": [ + "", + "" ], - "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.", - "response": { - "$ref": "NodeGroup" + "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" + ] }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", - "parameters": { - "nodeGroup": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", - "description": "Name of the node group to return.", - "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", - "required": true, - "location": "path" - }, - "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 - } + "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" + ] } }, - "setNodeTemplate": { - "request": { - "$ref": "NodeGroupsSetNodeTemplateRequest" + "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" }, - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", - "parameterOrder": [ - "project", - "zone", - "nodeGroup" - ], - "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." - }, - "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])?))" - }, - "nodeGroup": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", + "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" + }, + "description": "A list of UrlMaps contained in this scope.", + "type": "array" + }, + "warning": { + "properties": { + "code": { "type": "string", - "required": true, - "description": "Name of the NodeGroup resource to update." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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\" } " } }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", - "id": "compute.nodeGroups.setNodeTemplate", - "response": { - "$ref": "Operation" - }, - "description": "Updates the node template of the node group.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST" + "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" }, - "deleteNodes": { - "request": { - "$ref": "NodeGroupsDeleteNodesRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": [ + "", + "" ], - "description": "Deletes specified nodes from the node group.", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", - "id": "compute.nodeGroups.deleteNodes", - "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])?))", - "description": "Project ID for this request.", - "location": "path", - "type": "string", - "required": true - }, - "nodeGroup": { - "type": "string", - "required": true, - "description": "Name of the NodeGroup resource whose nodes will be deleted.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - }, - "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])?" - } - }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone", - "nodeGroup" + "enum": [ + "DEFAULT", + "TIER_1" ], - "httpMethod": "POST" + "type": "string" + } + } + }, + "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`." }, - "testIamPermissions": { - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", - "parameterOrder": [ - "project", - "zone", - "resource" + "direction": { + "type": "string", + "enumDescriptions": [ + "Indicates that firewall should apply to outgoing traffic.", + "Indicates that firewall should apply to incoming traffic." ], - "response": { - "$ref": "TestPermissionsResponse" - }, - "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", - "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": "Returns permissions that a caller has on the specified resource.", - "id": "compute.nodeGroups.testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, - "parameters": { - "zone": { - "location": "path", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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])?))", - "description": "Project ID for this request.", - "location": "path", - "required": true - }, - "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" - } - } + "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." }, - "addNodes": { - "response": { - "$ref": "Operation" + "kind": { + "type": "string", + "default": "compute#firewall", + "description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules." + }, + "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" }, - "id": "compute.nodeGroups.addNodes", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", - "parameterOrder": [ - "project", - "zone", - "nodeGroup" - ], - "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", - "httpMethod": "POST", - "request": { - "$ref": "NodeGroupsAddNodesRequest" + "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" }, - "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" - }, - "nodeGroup": { - "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 NodeGroup resource.", - "location": "path" - }, - "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." - }, - "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" - } + "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" }, - "description": "Adds specified number of nodes to the node group.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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." }, - "getIamPolicy": { - "id": "compute.nodeGroups.getIamPolicy", - "httpMethod": "GET", - "response": { - "$ref": "Policy" + "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" + }, + "sourceServiceAccounts": { + "items": { + "type": "string" }, - "parameters": { - "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])?))" - }, - "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" - }, - "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 + "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" + }, + "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" + } + }, + "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." + } }, - "optionsRequestedPolicyVersion": { - "type": "integer", - "format": "int32", - "description": "Requested IAM Policy version.", - "location": "query" - } + "type": "object" + } + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "targetServiceAccounts": { + "items": { + "type": "string" }, - "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" - ], - "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", - "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", - "parameterOrder": [ - "project", - "zone", - "resource" - ] + "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" }, - "list": { - "httpMethod": "GET", - "path": "projects/{project}/zones/{zone}/nodeGroups", - "description": "Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.", - "id": "compute.nodeGroups.list", - "response": { - "$ref": "NodeGroupList" + "id": { + "type": "string", + "format": "uint64", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." + }, + "name": { + "annotations": { + "required": [ + "compute.firewalls.insert", + "compute.firewalls.patch" + ] }, - "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}/nodeGroups", - "parameterOrder": [ - "project", - "zone" - ], - "parameters": { - "zone": { - "required": true, - "type": "string", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-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`)", - "minimum": "0", - "default": "500", - "type": "integer", - "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" - }, - "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." - }, - "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." - }, - "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`." + "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." + } } - } + }, + "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" }, - "firewalls": { - "methods": { - "update": { - "parameterOrder": [ - "project", - "firewall" - ], - "flatPath": "projects/{project}/global/firewalls/{firewall}", - "path": "projects/{project}/global/firewalls/{firewall}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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.", - "id": "compute.firewalls.update", - "httpMethod": "PUT", - "parameters": { - "firewall": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the firewall rule to update.", - "required": true, - "location": "path", - "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." - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" + "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" + ] + } + } } }, - "response": { - "$ref": "Operation" - }, - "request": { + "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" + }, + "items": { + "type": "array", + "items": { "$ref": "Firewall" - } + }, + "description": "A list of Firewall resources." }, - "delete": { - "parameterOrder": [ - "project", - "firewall" - ], - "flatPath": "projects/{project}/global/firewalls/{firewall}", - "httpMethod": "DELETE", - "parameters": { - "firewall": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the firewall rule to delete.", - "required": true, - "type": "string" - }, - "project": { - "required": true, - "location": "path", - "description": "Project ID for this request.", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "kind": { + "default": "compute#firewallList", + "type": "string", + "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls." + }, + "warning": { + "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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." + } + } + }, + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } " + }, + "code": { "type": "string", - "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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." + ] } }, - "path": "projects/{project}/global/firewalls/{firewall}", - "description": "Deletes the specified firewall.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "id": "compute.firewalls.delete" + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "insert": { - "parameters": { - "requestId": { + "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": { "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." }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" } }, - "id": "compute.firewalls.insert", - "path": "projects/{project}/global/firewalls", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/firewalls", - "response": { - "$ref": "Operation" + "type": "object", + "description": "Informational warning which replaces the list of forwarding rules when the list is empty." + }, + "forwardingRules": { + "items": { + "$ref": "ForwardingRule" }, - "request": { - "$ref": "Firewall" + "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" }, - "parameterOrder": [ - "project" + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": "Creates a firewall rule in the specified project using the data included in the request." + "type": "string" + } + } + }, + "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" }, - "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])?))" - }, - "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" - } - }, - "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 firewall.", - "response": { - "$ref": "Firewall" + "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" }, - "parameterOrder": [ - "project", - "firewall" - ], - "path": "projects/{project}/global/firewalls/{firewall}", - "flatPath": "projects/{project}/global/firewalls/{firewall}", - "httpMethod": "GET", - "id": "compute.firewalls.get" + "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" }, - "list": { - "httpMethod": "GET", - "id": "compute.firewalls.list", - "flatPath": "projects/{project}/global/firewalls", - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "FirewallList" - }, - "description": "Retrieves the list of firewall rules available to the specified project.", - "path": "projects/{project}/global/firewalls", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameters": { - "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" + "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" }, - "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, + "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" }, - "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." - }, - "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" - }, - "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 human-readable description of the warning code." } - } + }, + "type": "object", + "description": "[Output Only] Informational warning message." }, - "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "firewall": { - "description": "Name of the firewall rule to patch.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", - "type": "string", - "required": true - } + "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" }, - "parameterOrder": [ - "project", - "firewall" - ], - "response": { - "$ref": "Operation" + "description": "A list of BackendServicesScopedList resources." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" }, - "request": { - "$ref": "Firewall" + "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" }, - "flatPath": "projects/{project}/global/firewalls/{firewall}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "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" + }, + "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" ], - "id": "compute.firewalls.patch", - "httpMethod": "PATCH", - "path": "projects/{project}/global/firewalls/{firewall}", - "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." + "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" }, - "regionNetworkEndpointGroups": { - "methods": { - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "path": "projects/{project}/regions/{region}/networkEndpointGroups", - "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" - }, - "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])?))" - }, - "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", - "type": "integer", - "location": "query", - "minimum": "0" - }, - "region": { - "required": true, - "location": "path", - "type": "string", - "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035." - }, - "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.", - "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" - } - }, - "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", - "parameterOrder": [ - "project", - "region" + "description": "The aggregation type of the bundle interface.", + "enum": [ + "BUNDLE_AGGREGATION_TYPE_LACP", + "BUNDLE_AGGREGATION_TYPE_STATIC" ], - "description": "Retrieves the list of regional network endpoint groups available to the specified project in the given region.", - "response": { - "$ref": "NetworkEndpointGroupList" - }, - "id": "compute.regionNetworkEndpointGroups.list" + "type": "string" }, - "insert": { - "description": "Creates a network endpoint group in the specified project using the parameters that are 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)." - }, - "region": { - "description": "The name of the region where you want to create the network endpoint group. It should comply with RFC1035.", - "type": "string", - "required": true, - "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])?))" - } + "links": { + "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.", + "items": { + "$ref": "InterconnectDiagnosticsLinkStatus" }, - "parameterOrder": [ - "project", - "region" + "type": "array" + }, + "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." ], - "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", - "request": { - "$ref": "NetworkEndpointGroup" - }, - "path": "projects/{project}/regions/{region}/networkEndpointGroups", - "id": "compute.regionNetworkEndpointGroups.insert", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "BUNDLE_OPERATIONAL_STATUS_DOWN", + "BUNDLE_OPERATIONAL_STATUS_UP" ], - "httpMethod": "POST" + "description": "The operational status of the bundle interface." }, - "delete": { - "parameterOrder": [ - "project", - "region", - "networkEndpointGroup" + "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" + }, + "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" + }, + "type": "array", + "description": "URLs of the instances to be removed from target pool." + } + } + }, + "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." ], - "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", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "READ_ONLY", + "READ_WRITE" ], - "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", - "id": "compute.regionNetworkEndpointGroups.delete", - "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", - "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" - }, - "networkEndpointGroup": { - "location": "path", - "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", - "type": "string", - "required": true - }, - "region": { - "type": "string", - "required": true, - "location": "path", - "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035." - } - }, - "response": { - "$ref": "Operation" + "type": "string" + }, + "diskSizeGb": { + "type": "string", + "description": "The size of the disk in base-2 GB.", + "format": "int64" + }, + "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" } }, - "get": { - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", - "parameters": { - "networkEndpointGroup": { - "location": "path", - "required": true, - "type": "string", - "description": "The name of the network endpoint group. It should comply with RFC1035." - }, - "region": { - "required": true, - "location": "path", - "type": "string", - "description": "The name of the region where the network endpoint group is located. It should comply with 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" - } + "licenses": { + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "region", - "networkEndpointGroup" + "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": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.", + "type": "string", + "enum": [ + "NVME", + "SCSI" + ] + }, + "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" + }, + "type": { + "type": "string", + "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.", + "enumDescriptions": [ + "", + "" ], - "id": "compute.regionNetworkEndpointGroups.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." + }, + "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": [ + "", + "" ], - "response": { - "$ref": "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." + "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" } } }, - "firewallPolicies": { - "methods": { - "addAssociation": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "id": "compute.firewallPolicies.addAssociation", - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", - "parameterOrder": [ - "firewallPolicy" - ], - "path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", - "description": "Inserts an association for the specified firewall policy.", - "httpMethod": "POST", - "request": { - "$ref": "FirewallPolicyAssociation" - }, - "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": "(firewallPolicies/)?[0-9]{0,20}", - "type": "string", - "required": true, - "description": "Name of the firewall policy to update.", - "location": "path" - }, - "replaceExistingAssociation": { - "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.", - "type": "boolean" - } - } + "NotificationEndpointList": { + "id": "NotificationEndpointList", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." }, - "delete": { - "parameterOrder": [ - "firewallPolicy" - ], - "response": { - "$ref": "Operation" - }, - "description": "Deletes the specified policy.", - "httpMethod": "DELETE", - "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).", + "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" }, - "firewallPolicy": { - "required": true, - "type": "string", - "location": "path", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "description": "Name of the firewall policy to delete." - } - }, - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", - "path": "locations/global/firewallPolicies/{firewallPolicy}", - "id": "compute.firewallPolicies.delete" - }, - "addRule": { - "parameters": { - "firewallPolicy": { - "required": true, - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "location": "path", - "type": "string", - "description": "Name of the firewall policy to update." + "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\" } " }, - "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" + ] } }, - "path": "locations/global/firewallPolicies/{firewallPolicy}/addRule", - "request": { - "$ref": "FirewallPolicyRule" - }, - "description": "Inserts a rule into a firewall policy.", - "response": { - "$ref": "Operation" + "description": "[Output Only] Informational warning message.", + "type": "object" + }, + "items": { + "items": { + "$ref": "NotificationEndpoint" }, - "parameterOrder": [ - "firewallPolicy" - ], - "id": "compute.firewallPolicies.addRule", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule" + "type": "array", + "description": "A list of NotificationEndpoint resources." }, - "cloneRules": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", - "description": "Copies rules to the specified firewall policy.", - "id": "compute.firewallPolicies.cloneRules", - "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." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + } + }, + "type": "object" + }, + "HttpRouteRuleMatch": { + "id": "HttpRouteRuleMatch", + "properties": { + "metadataFilters": { + "items": { + "$ref": "MetadataFilter" }, - "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", - "parameterOrder": [ - "firewallPolicy" - ], - "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" - }, - "firewallPolicy": { - "location": "path", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "required": true, - "description": "Name of the firewall policy to update.", - "type": "string" - }, - "sourceFirewallPolicy": { - "type": "string", - "description": "The firewall policy from which to copy rules.", - "location": "query" - } - } + "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" }, - "insert": { - "flatPath": "locations/global/firewallPolicies", - "path": "locations/global/firewallPolicies", - "description": "Creates a new policy in the specified project using the data included in the request.", - "request": { - "$ref": "FirewallPolicy" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "response": { - "$ref": "Operation" + "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" }, - "id": "compute.firewallPolicies.insert", - "parameters": { - "parentId": { - "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", - "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)." - } - } + "type": "array" }, - "move": { - "id": "compute.firewallPolicies.move", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/move", - "path": "locations/global/firewallPolicies/{firewallPolicy}/move", - "parameterOrder": [ - "firewallPolicy" + "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." ], - "httpMethod": "POST", - "description": "Moves the specified firewall policy.", - "parameters": { - "firewallPolicy": { - "required": true, - "description": "Name of the firewall policy to update.", - "location": "path", - "type": "string", - "pattern": "(firewallPolicies/)?[0-9]{0,20}" + "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" + }, + "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" + } + } + } }, - "parentId": { + "message": { "type": "string", - "description": "The new parent of the firewall policy.", - "location": "query" + "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" - } - }, - "response": { - "$ref": "Operation" - } - }, - "testIamPermissions": { - "parameters": { - "resource": { - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "location": "path", - "required": true, + "code": { "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." + ], + "description": "[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": "TestPermissionsResponse" - }, - "httpMethod": "POST", - "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", - "description": "Returns permissions that a caller has on the specified resource.", - "request": { - "$ref": "TestPermissionsRequest" - }, - "flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions", - "path": "locations/global/firewallPolicies/{resource}/testIamPermissions" + "type": "object" }, - "removeRule": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", - "description": "Deletes a rule of the specified priority.", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "firewallPolicy" - ], - "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", - "id": "compute.firewallPolicies.removeRule", - "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": { - "type": "string", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "location": "path", - "description": "Name of the firewall policy to update.", - "required": true - }, - "priority": { - "location": "query", - "description": "The priority of the rule to remove from the firewall policy.", - "type": "integer", - "format": "int32" - } + "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" } + } + }, + "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" }, - "getAssociation": { - "path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation", - "id": "compute.firewallPolicies.getAssociation", - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation", - "parameterOrder": [ - "firewallPolicy" - ], - "parameters": { - "firewallPolicy": { - "type": "string", - "location": "path", - "description": "Name of the firewall policy to which the queried rule belongs.", - "required": true, - "pattern": "(firewallPolicies/)?[0-9]{0,20}" - }, - "name": { - "description": "The name of the association to get from the firewall policy.", - "location": "query", - "type": "string" - } - }, - "response": { - "$ref": "FirewallPolicyAssociation" - }, - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "status": { + "description": "[Output Only] The status of the instance.", + "enum": [ + "DEPROVISIONING", + "PROVISIONING", + "REPAIRING", + "RUNNING", + "STAGING", + "STOPPED", + "STOPPING", + "SUSPENDED", + "SUSPENDING", + "TERMINATED" ], - "description": "Gets an association with the specified name." - }, - "list": { - "httpMethod": "GET", - "response": { - "$ref": "FirewallPolicyList" - }, - "flatPath": "locations/global/firewallPolicies", - "id": "compute.firewallPolicies.list", - "path": "locations/global/firewallPolicies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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)." ], - "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" - }, - "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" - }, - "parentId": { - "description": "Parent ID for this request.", - "location": "query", - "type": "string" - }, - "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" - }, - "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": "Lists all the policies that have been configured for the specified folder or organization." + "type": "string" }, - "getRule": { - "path": "locations/global/firewallPolicies/{firewallPolicy}/getRule", - "parameters": { - "firewallPolicy": { - "description": "Name of the firewall policy to which the queried rule belongs.", - "location": "path", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "required": true, - "type": "string" - }, - "priority": { - "format": "int32", - "location": "query", - "type": "integer", - "description": "The priority of the rule to get from the firewall policy." - } - }, - "id": "compute.firewallPolicies.getRule", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" ], - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", - "response": { - "$ref": "FirewallPolicyRule" - }, - "httpMethod": "GET", - "description": "Gets a rule of the specified priority.", - "parameterOrder": [ - "firewallPolicy" + "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." ] }, - "removeAssociation": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation", - "id": "compute.firewallPolicies.removeAssociation", - "response": { - "$ref": "Operation" + "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" + ] }, - "httpMethod": "POST", - "parameterOrder": [ - "firewallPolicy" + "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])?" + } + } + }, + "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.", + "" ], - "description": "Removes an association for the specified firewall policy.", - "parameters": { - "name": { - "description": "Name for the attachment that will be removed.", - "location": "query", - "type": "string" - }, - "firewallPolicy": { - "type": "string", - "location": "path", - "required": true, - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "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" - } - }, - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation" + "type": "string", + "enum": [ + "ANY_RESERVATION", + "NO_RESERVATION", + "SPECIFIC_RESERVATION", + "UNSPECIFIED" + ] }, - "getIamPolicy": { - "path": "locations/global/firewallPolicies/{resource}/getIamPolicy", - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "type": "integer", - "location": "query", - "format": "int32" - }, - "resource": { - "location": "path", - "required": true, - "type": "string", - "description": "Name or id of the resource for this request.", - "pattern": "(firewallPolicies/)?[0-9]{0,20}" - } + "values": { + "type": "array", + "items": { + "type": "string" }, - "httpMethod": "GET", - "parameterOrder": [ - "resource" + "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" ], - "flatPath": "locations/global/firewallPolicies/{resource}/getIamPolicy", - "id": "compute.firewallPolicies.getIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "response": { - "$ref": "Policy" + "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" } + } + } + }, + "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." }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" + "instanceState": { + "enumDescriptions": [ + "Matches any status of the instances, running, non-running and others.", + "Instance is in RUNNING state if it is running." ], - "parameters": { - "resource": { - "required": true, - "location": "path", - "description": "Name or id of the resource for this request.", - "type": "string", - "pattern": "(firewallPolicies/)?[0-9]{0,20}" - } - }, - "id": "compute.firewallPolicies.setIamPolicy", - "flatPath": "locations/global/firewallPolicies/{resource}/setIamPolicy", - "path": "locations/global/firewallPolicies/{resource}/setIamPolicy", - "httpMethod": "POST", - "request": { - "$ref": "GlobalOrganizationSetPolicyRequest" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy." + "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" + ] }, - "get": { - "description": "Returns the specified firewall policy.", - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", - "parameters": { - "firewallPolicy": { - "type": "string", - "location": "path", - "required": true, - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "description": "Name of the firewall policy to get." - } - }, - "path": "locations/global/firewallPolicies/{firewallPolicy}", - "response": { - "$ref": "FirewallPolicy" - }, - "httpMethod": "GET", - "parameterOrder": [ - "firewallPolicy" + "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" + }, + "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." + ], + "type": "string", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" ], - "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" - ] + "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." }, - "patch": { - "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" - ], - "parameterOrder": [ - "firewallPolicy" + "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." ], - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" - }, - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", - "id": "compute.firewallPolicies.patch", - "request": { - "$ref": "FirewallPolicy" - }, - "parameters": { - "firewallPolicy": { - "description": "Name of the firewall policy to update.", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "location": "path", - "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)." - } - }, - "path": "locations/global/firewallPolicies/{firewallPolicy}" + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ] }, - "patchRule": { - "parameters": { - "firewallPolicy": { - "description": "Name of the firewall policy to update.", - "location": "path", - "pattern": "(firewallPolicies/)?[0-9]{0,20}", - "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" - }, - "priority": { - "type": "integer", - "format": "int32", - "location": "query", - "description": "The priority of the rule to patch." - } - }, - "request": { - "$ref": "FirewallPolicyRule" - }, - "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", - "path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "replacementMethod": { + "enum": [ + "RECREATE", + "SUBSTITUTE" ], - "httpMethod": "POST", - "id": "compute.firewallPolicies.patchRule", - "description": "Patches a rule of the specified priority.", - "parameterOrder": [ - "firewallPolicy" + "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)" ], - "response": { - "$ref": "Operation" - } + "type": "string" }, - "listAssociations": { - "flatPath": "locations/global/firewallPolicies/listAssociations", - "httpMethod": "GET", - "id": "compute.firewallPolicies.listAssociations", - "parameters": { - "targetResource": { - "type": "string", - "location": "query", - "description": "The target resource to list associations. It is an organization, or a folder." - } - }, - "path": "locations/global/firewallPolicies/listAssociations", - "response": { - "$ref": "FirewallPoliciesListAssociationsResponse" - }, - "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" + "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" ] } } }, - "acceleratorTypes": { - "methods": { - "get": { - "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", - "parameterOrder": [ - "project", - "zone", - "acceleratorType" + "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" ], - "id": "compute.acceleratorTypes.get", - "parameters": { - "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 - }, - "acceleratorType": { - "description": "Name of the accelerator type to return.", - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - } - }, - "description": "Returns the specified accelerator type.", - "path": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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": [ + "", + "", + "", + "", + "", + "" ], - "httpMethod": "GET", - "response": { - "$ref": "AcceleratorType" + "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" } }, - "aggregatedList": { - "parameterOrder": [ - "project" + "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" + }, + "metadata": { + "enumDescriptions": [ + "", + "", + "" ], - "httpMethod": "GET", - "response": { - "$ref": "AcceleratorTypeAggregatedList" + "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" }, - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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": { + "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" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "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`." - }, - "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" + "description": "[Output Only] A human-readable description of the warning code." }, - "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." + "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" }, - "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])?))", + "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", - "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": "Retrieves an aggregated list of accelerator types.", - "path": "projects/{project}/aggregated/acceleratorTypes", - "id": "compute.acceleratorTypes.aggregatedList", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + } + }, + "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" ], - "flatPath": "projects/{project}/aggregated/acceleratorTypes" + "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": [ + "", + "", + "" + ], + "type": "string" }, - "list": { - "id": "compute.acceleratorTypes.list", - "parameters": { - "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." - }, - "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, - "description": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "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", - "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", - "minimum": "0" - }, - "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" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." + }, + "serverId": { + "description": "Server ID associated with this node.", + "type": "string" + }, + "status": { + "enumDescriptions": [ + "", + "", + "", + "", + "" ], - "response": { - "$ref": "AcceleratorTypeList" + "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" }, - "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes", - "httpMethod": "GET", - "description": "Retrieves a list of accelerator types that are available to the specified project.", - "parameterOrder": [ - "project", - "zone" + "type": "array" + }, + "cpuOvercommitType": { + "type": "string", + "enum": [ + "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", + "ENABLED", + "NONE" + ], + "enumDescriptions": [ + "", + "", + "" ], - "path": "projects/{project}/zones/{zone}/acceleratorTypes" + "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." + }, + "instances": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Instances scheduled on this node." + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" } - } + }, + "type": "object", + "id": "NodeGroupNode" }, - "routes": { - "methods": { - "list": { - "parameterOrder": [ - "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" - }, - "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", - "minimum": "0", - "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.", - "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" + "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\" } " }, - "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`.", + "message": { "type": "string", - "location": "query" + "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])?))", + "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.", - "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" + ] } }, - "httpMethod": "GET", - "description": "Retrieves the list of Route resources available to the specified project.", - "response": { - "$ref": "RouteList" - }, - "path": "projects/{project}/global/routes", - "flatPath": "projects/{project}/global/routes", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.routes.list" + "type": "object" }, - "get": { - "id": "compute.routes.get", - "description": "Returns the specified Route resource. Gets a list of available routes by making a list() request.", - "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" - ], - "parameterOrder": [ - "project", - "route" + "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" ], - "path": "projects/{project}/global/routes/{route}", - "httpMethod": "GET", - "response": { - "$ref": "Route" - }, - "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])?))" - }, - "route": { - "required": true, - "type": "string", - "description": "Name of the Route resource to return.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path" - } + "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" } }, - "insert": { - "path": "projects/{project}/global/routes", - "httpMethod": "POST", - "request": { - "$ref": "Route" - }, - "response": { - "$ref": "Operation" - }, - "description": "Creates a Route resource in the specified project using the data included in the request.", - "id": "compute.routes.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "flatPath": "projects/{project}/global/routes", - "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": { - "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" + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" ] }, - "delete": { - "id": "compute.routes.delete", - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "route" + "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}/global/routes/{route}", - "description": "Deletes the specified Route resource.", - "path": "projects/{project}/global/routes/{route}", - "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", - "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 - }, - "route": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the Route resource to delete.", - "type": "string", - "required": true - } + "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" + ] }, - "response": { - "$ref": "Operation" - } + "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" } } }, - "globalOperations": { - "methods": { - "wait": { - "id": "compute.globalOperations.wait", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project", - "operation" - ], - "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 - }, - "operation": { - "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 Operations resource to return." - } - }, - "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`. ", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/operations/{operation}/wait", - "path": "projects/{project}/global/operations/{operation}/wait" + "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." }, - "aggregatedList": { - "parameterOrder": [ - "project" - ], - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/operations", - "path": "projects/{project}/aggregated/operations", - "description": "Retrieves an aggregated list of all operations.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.globalOperations.aggregatedList", - "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.", - "type": "boolean", - "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": { - "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" - }, - "maxResults": { - "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", - "location": "query" - }, - "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])?))" - }, - "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" - } + "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" }, - "response": { - "$ref": "OperationAggregatedList" + "type": "array" + }, + "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" } }, - "list": { - "path": "projects/{project}/global/operations", - "response": { - "$ref": "OperationList" + "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" }, - "flatPath": "projects/{project}/global/operations", - "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 a list of Operation resources contained within the specified project.", - "id": "compute.globalOperations.list", - "httpMethod": "GET", - "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" - }, - "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - }, - "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", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "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" - } + "type": "array" + }, + "creationTimestamp": { + "type": "string", + "description": "[Output Only] Creation timestamp in RFC3339 text format." + }, + "kind": { + "description": "[Output Only] Type of the resource.", + "default": "compute#networkAttachment", + "type": "string" + }, + "connectionEndpoints": { + "description": "[Output Only] An array of connections for all the producers connected to this network attachment.", + "type": "array", + "items": { + "$ref": "NetworkAttachmentConnectedEndpoint" } }, - "delete": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "connectionPreference": { + "enumDescriptions": [ + "", + "", + "" ], - "path": "projects/{project}/global/operations/{operation}", - "parameters": { - "operation": { - "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 Operations resource to delete." - }, - "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])?))" - } - }, - "flatPath": "projects/{project}/global/operations/{operation}", - "parameterOrder": [ - "project", - "operation" + "enum": [ + "ACCEPT_AUTOMATIC", + "ACCEPT_MANUAL", + "INVALID" ], - "id": "compute.globalOperations.delete", - "description": "Deletes the specified Operations resource.", - "httpMethod": "DELETE" + "type": "string" }, - "get": { - "parameterOrder": [ - "project", - "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" - }, - "flatPath": "projects/{project}/global/operations/{operation}", - "description": "Retrieves the specified Operations resource.", - "id": "compute.globalOperations.get", - "path": "projects/{project}/global/operations/{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])?))", - "location": "path", - "type": "string", - "description": "Project ID for this request.", - "required": true - }, - "operation": { - "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}", - "type": "string", - "required": true - } + "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" + ] }, - "httpMethod": "GET" + "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" }, - "networkEdgeSecurityServices": { - "methods": { - "delete": { - "httpMethod": "DELETE", - "parameters": { - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "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": { - "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" - }, - "networkEdgeSecurityService": { - "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 network edge security service to delete." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "description": "Deletes the specified service.", - "id": "compute.networkEdgeSecurityServices.delete", - "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", - "parameterOrder": [ - "project", - "region", - "networkEdgeSecurityService" - ], - "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}" + "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." }, - "patch": { - "httpMethod": "PATCH", - "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", - "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", - "request": { - "$ref": "NetworkEdgeSecurityService" - }, - "description": "Patches the specified policy with the data included in the request.", - "parameterOrder": [ - "project", - "region", - "networkEdgeSecurityService" - ], - "id": "compute.networkEdgeSecurityServices.patch", - "response": { - "$ref": "Operation" - }, - "parameters": { - "paths": { - "type": "string", - "location": "query", - "repeated": 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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "updateMask": { - "location": "query", - "type": "string", - "format": "google-fieldmask", - "description": "Indicates fields to be updated as part of 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])?" - }, - "networkEdgeSecurityService": { - "location": "path", - "required": true, - "description": "Name of the network edge security service to update.", - "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" - ] + "requestPath": { + "type": "string", + "description": "The request path of the HTTPS health check request. The default value is \"/\"." }, - "aggregatedList": { - "description": "Retrieves the list of all NetworkEdgeSecurityService 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" - ], - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices", - "path": "projects/{project}/aggregated/networkEdgeSecurityServices", - "id": "compute.networkEdgeSecurityServices.aggregatedList", - "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": "Name of the project scoping this request." - }, - "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" - }, - "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" - }, - "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" - }, - "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." - } - }, - "response": { - "$ref": "NetworkEdgeSecurityServiceAggregatedList" - }, - "parameterOrder": [ - "project" - ] + "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" }, - "get": { - "parameterOrder": [ - "project", - "region", - "networkEdgeSecurityService" - ], - "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", - "httpMethod": "GET", - "id": "compute.networkEdgeSecurityServices.get", - "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", - "description": "Gets a specified NetworkEdgeSecurityService.", - "response": { - "$ref": "NetworkEdgeSecurityService" + "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." + } + } + }, + "InstanceGroupManagersAbandonInstancesRequest": { + "properties": { + "instances": { + "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": { - "networkEdgeSecurityService": { - "location": "path", - "description": "Name of the network edge security service to get.", - "type": "string", - "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])?))", - "description": "Project ID for this request.", - "required": true, - "type": "string", - "location": "path" - }, - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - } + "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" + ] } }, - "insert": { - "description": "Creates a new service in the specified project using the data included in the request.", - "parameterOrder": [ - "project", - "region" - ], - "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices", - "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" - }, - "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": { - "type": "boolean", - "description": "If true, the request will not be committed.", - "location": "query" - }, - "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" - } - }, - "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices", - "httpMethod": "POST", - "id": "compute.networkEdgeSecurityServices.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "NetworkEdgeSecurityService" + "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" + }, + "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" } } } }, - "targetHttpProxies": { - "methods": { - "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.", - "httpMethod": "GET", - "response": { - "$ref": "TargetHttpProxy" - }, - "parameterOrder": [ - "project", - "targetHttpProxy" + "StatefulPolicyPreservedStateDiskDevice": { + "id": "StatefulPolicyPreservedStateDiskDevice", + "properties": { + "autoDelete": { + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" ], - "parameters": { - "targetHttpProxy": { - "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 TargetHttpProxy resource to return.", - "required": true - }, - "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" - } - }, - "id": "compute.targetHttpProxies.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": [ + "", + "" ], - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}" + "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" }, - "list": { - "response": { - "$ref": "TargetHttpProxyList" - }, - "path": "projects/{project}/global/targetHttpProxies", - "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", - "parameterOrder": [ - "project" + "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" ], - "flatPath": "projects/{project}/global/targetHttpProxies", - "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", - "default": "500", - "type": "integer", - "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." - }, - "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])?))", - "location": "path", - "description": "Project ID for this request.", - "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`." - }, - "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.targetHttpProxies.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": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "type": "string" }, - "patch": { - "id": "compute.targetHttpProxies.patch", - "parameters": { - "targetHttpProxy": { - "type": "string", - "location": "path", - "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "description": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - } + "kind": { + "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", + "type": "string", + "default": "compute#attachedDisk" + }, + "guestOsFeatures": { + "items": { + "$ref": "GuestOsFeature" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "type": { + "enum": [ + "PERSISTENT", + "SCRATCH" ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "TargetHttpProxy" - }, - "parameterOrder": [ - "project", - "targetHttpProxy" + "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.", + "enumDescriptions": [ + "", + "" ], - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "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.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}" + "type": "string" }, - "aggregatedList": { - "parameterOrder": [ - "project" + "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" + }, + "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." + }, + "interface": { + "enumDescriptions": [ + "", + "" ], - "httpMethod": "GET", - "path": "projects/{project}/aggregated/targetHttpProxies", - "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" - }, - "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." - }, - "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", - "minimum": "0", - "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." - }, - "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": { - "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.", - "type": "string", - "location": "query" - } - }, - "id": "compute.targetHttpProxies.aggregatedList", - "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.", - "response": { - "$ref": "TargetHttpProxyAggregatedList" - }, - "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" + "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" ] }, - "insert": { - "httpMethod": "POST", - "flatPath": "projects/{project}/global/targetHttpProxies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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": { - "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" + "mode": { + "type": "string", + "enum": [ + "READ_ONLY", + "READ_WRITE" ], - "request": { - "$ref": "TargetHttpProxy" - }, - "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.", - "path": "projects/{project}/global/targetHttpProxies", - "response": { - "$ref": "Operation" - }, - "id": "compute.targetHttpProxies.insert" + "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." + ] }, - "delete": { - "parameterOrder": [ - "project", - "targetHttpProxy" - ], - "response": { - "$ref": "Operation" - }, - "httpMethod": "DELETE", - "parameters": { - "targetHttpProxy": { - "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 TargetHttpProxy resource to delete.", - "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])?))", - "location": "path", - "type": "string", - "required": true, - "description": "Project ID for this request." - } - }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.targetHttpProxies.delete", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "description": "Deletes the specified TargetHttpProxy resource." + "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": { - "httpMethod": "POST", - "parameterOrder": [ - "project", - "targetHttpProxy" - ], - "request": { - "$ref": "UrlMapReference" - }, - "parameters": { - "targetHttpProxy": { - "required": true, - "location": "path", - "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" - }, - "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": { - "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.targetHttpProxies.setUrlMap", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Changes the URL map for TargetHttpProxy.", - "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "response": { - "$ref": "Operation" + "licenses": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap" + "description": "[Output Only] Any valid publicly visible licenses.", + "type": "array" + }, + "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" }, - "globalForwardingRules": { - "methods": { - "delete": { - "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": { - "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": { - "description": "Name of the ForwardingRule 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}" - } - }, - "response": { - "$ref": "Operation" + "PacketMirroringFilter": { + "type": "object", + "properties": { + "cidrRanges": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "direction": { + "enum": [ + "BOTH", + "EGRESS", + "INGRESS" ], - "parameterOrder": [ - "project", - "forwardingRule" + "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." ], - "id": "compute.globalForwardingRules.delete", - "httpMethod": "DELETE", - "description": "Deletes the specified GlobalForwardingRule resource.", - "path": "projects/{project}/global/forwardingRules/{forwardingRule}" + "type": "string" }, - "get": { - "httpMethod": "GET", - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", - "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.", - "parameters": { - "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 - }, - "forwardingRule": { - "required": true, - "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" - } + "IPProtocols": { + "type": "array", + "items": { + "type": "string" }, - "id": "compute.globalForwardingRules.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." + } + }, + "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": [ + "", + "", + "" ], - "parameterOrder": [ - "project", - "forwardingRule" + "enum": [ + "ACCEPT_AUTOMATIC", + "ACCEPT_MANUAL", + "CONNECTION_PREFERENCE_UNSPECIFIED" ], - "response": { - "$ref": "ForwardingRule" + "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" }, - "path": "projects/{project}/global/forwardingRules/{forwardingRule}" + "description": "[Output Only] An array of connections for all the consumers connected to this service attachment." }, - "insert": { - "parameterOrder": [ - "project" - ], - "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.", - "httpMethod": "POST", - "id": "compute.globalForwardingRules.insert", - "request": { - "$ref": "ForwardingRule" + "natSubnets": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/global/forwardingRules", - "path": "projects/{project}/global/forwardingRules", - "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" - } + "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": "Operation" + "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" + }, + "consumerRejectLists": { + "items": { + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "type": "array", + "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number." }, - "list": { - "parameters": { - "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - }, - "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.", - "type": "boolean", - "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." - }, - "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" - } + "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" + ] }, - "flatPath": "projects/{project}/global/forwardingRules", - "httpMethod": "GET", - "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.", - "id": "compute.globalForwardingRules.list", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/global/forwardingRules", - "response": { - "$ref": "ForwardingRuleList" + "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" + ] } }, - "setLabels": { - "request": { - "$ref": "GlobalSetLabelsRequest" + "domains": { + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "resource" + "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.globalForwardingRules.setLabels", - "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.", - "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])?))" - }, - "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." - } - }, - "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "description": "[Output only] Status of the managed certificate resource.", + "enum": [ + "ACTIVE", + "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", + "PROVISIONING", + "PROVISIONING_FAILED", + "PROVISIONING_FAILED_PERMANENTLY", + "RENEWAL_FAILED" + ] + } + }, + "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." + }, + "name": { + "description": "[Output Only] The name of the firewall policy.", + "type": "string" + }, + "rules": { + "type": "array", + "description": "The rules that apply to the network.", + "items": { + "$ref": "FirewallPolicyRule" + } + }, + "type": { + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "enum": [ + "HIERARCHY", + "NETWORK", + "NETWORK_REGIONAL", + "UNSPECIFIED" ], - "path": "projects/{project}/global/forwardingRules/{resource}/setLabels" + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + }, + "SecurityPolicyDdosProtectionConfig": { + "id": "SecurityPolicyDdosProtectionConfig", + "type": "object", + "properties": { + "ddosProtection": { + "enumDescriptions": [ + "", + "" + ], + "enum": [ + "ADVANCED", + "STANDARD" + ], + "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" }, - "setTarget": { - "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": { - "location": "query", + "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." }, - "forwardingRule": { + "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" + } + }, + "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": "Name of the ForwardingRule resource in which target is to be set.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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." } }, - "response": { + "description": "[Output Only] Informational warning message.", + "type": "object" + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "items": { + "type": "array", + "items": { "$ref": "Operation" }, - "parameterOrder": [ - "project", - "forwardingRule" - ], - "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", - "request": { - "$ref": "TargetReference" + "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" + }, + "signedUrlKeyNames": { + "type": "array", + "items": { + "type": "string" }, - "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.", - "httpMethod": "POST", - "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", - "id": "compute.globalForwardingRules.setTarget", - "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." }, - "patch": { - "request": { - "$ref": "ForwardingRule" + "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" }, - "id": "compute.globalForwardingRules.patch", - "httpMethod": "PATCH", - "path": "projects/{project}/global/forwardingRules/{forwardingRule}", - "parameterOrder": [ - "project", - "forwardingRule" + "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." + }, + "negativeCachingPolicy": { + "items": { + "$ref": "BackendBucketCdnPolicyNegativeCachingPolicy" + }, + "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." ], - "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.", - "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": { - "description": "Name of the ForwardingRule resource to patch.", - "required": true, + "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." + } + }, + "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" + }, + "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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." + ] }, - "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, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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" + }, + "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}/global/forwardingRules/{forwardingRule}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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" + } } } }, - "licenseCodes": { - "methods": { - "testIamPermissions": { - "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. ", - "httpMethod": "POST", - "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 - }, - "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" - } - }, - "request": { - "$ref": "TestPermissionsRequest" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "description": "Inter-packet time interval statistics for control packets." + }, + "bfdSessionInitializationMode": { + "enum": [ + "ACTIVE", + "DISABLED", + "PASSIVE" ], - "id": "compute.licenseCodes.testIamPermissions", - "parameterOrder": [ - "project", - "resource" + "enumDescriptions": [ + "", + "", + "" ], - "flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions", - "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions" + "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" }, - "get": { - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "localDiagnostic": { + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], - "id": "compute.licenseCodes.get", - "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" + "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" + ], + "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" + }, + "localState": { + "enum": [ + "ADMIN_DOWN", + "DOWN", + "INIT", + "STATE_UNSPECIFIED", + "UP" + ], + "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" + } + } + }, + "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" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "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" + ] }, - "licenseCode": { - "location": "path", + "message": { "type": "string", - "description": "Number corresponding to the License code resource to return.", - "pattern": "[0-9]{0,61}?", - "required": true + "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": { + "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" + } } }, - "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. ", - "response": { - "$ref": "LicenseCode" + "type": "object" + }, + "items": { + "type": "object", + "additionalProperties": { + "description": "[Output Only] Name of the scope containing this set of operations.", + "$ref": "OperationsScopedList" }, - "flatPath": "projects/{project}/global/licenseCodes/{licenseCode}" + "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" }, - "targetInstances": { - "methods": { - "list": { - "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.", - "path": "projects/{project}/zones/{zone}/targetInstances", - "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": { - "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`." - }, - "zone": { - "required": true, - "type": "string", - "description": "Name of the zone scoping 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.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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", - "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": { - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - } + "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" + ] }, - "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}/targetInstances", - "id": "compute.targetInstances.list", - "parameterOrder": [ - "project", - "zone" - ], - "response": { - "$ref": "TargetInstanceList" + "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" + }, + "asPaths": { + "type": "array", + "items": { + "$ref": "RouteAsPath" }, - "httpMethod": "GET" + "description": "[Output Only] AS path." }, - "aggregatedList": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.targetInstances.aggregatedList", - "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" - }, - "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": { - "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" - }, - "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`)", - "format": "uint32", - "type": "integer", - "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.", - "location": "path", - "required": true, - "type": "string" - } + "tags": { + "annotations": { + "required": [ + "compute.routes.insert" + ] }, - "response": { - "$ref": "TargetInstanceAggregatedList" + "description": "A list of instance tags to which this route applies.", + "items": { + "type": "string" }, - "httpMethod": "GET", - "path": "projects/{project}/aggregated/targetInstances", - "description": "Retrieves an aggregated list of target instances.", - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/aggregated/targetInstances" + "type": "array" }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "zone", - "targetInstance" - ], - "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 - }, - "zone": { - "required": true, - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the zone scoping this request.", - "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": { + "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" + } }, - "targetInstance": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the TargetInstance resource to delete.", - "required": true, - "location": "path", - "type": "string" - } - }, - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", - "response": { - "$ref": "Operation" + "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" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + ] + } + }, + "routeType": { + "enumDescriptions": [ + "", + "", + "", + "" ], - "description": "Deletes the specified TargetInstance resource.", - "id": "compute.targetInstances.delete", - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}" + "enum": [ + "BGP", + "STATIC", + "SUBNET", + "TRANSIT" + ], + "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" }, - "insert": { - "request": { - "$ref": "TargetInstance" - }, - "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", + "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." + ], + "type": "string", + "enum": [ + "ACTIVE", + "DROPPED", + "INACTIVE", + "PENDING" + ] + }, + "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" }, - "zone": { - "required": true, - "description": "Name of the zone scoping this request.", - "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.", + "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." + "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." + } + } + } } }, - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/targetInstances", - "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.", - "path": "projects/{project}/zones/{zone}/targetInstances", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "zone" - ], - "id": "compute.targetInstances.insert" + "description": "[Output Only] Informational warning message." }, - "get": { - "id": "compute.targetInstances.get", - "parameterOrder": [ - "project", - "zone", - "targetInstance" - ], - "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}/targetInstances/{targetInstance}", - "response": { - "$ref": "TargetInstance" + "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" }, - "parameters": { - "zone": { - "required": true, - "description": "Name of the zone scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string" - }, - "targetInstance": { - "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 TargetInstance resource to return." - }, - "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 - } + "type": "array" + }, + "includeHttpHeaders": { + "type": "array", + "items": { + "type": "string" }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", - "description": "Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request." + "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" + }, + "referenceType": { + "description": "A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF ", + "type": "string" } } }, - "vpnTunnels": { - "methods": { - "delete": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "vpnTunnel": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the VpnTunnel resource to delete.", - "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])?))", - "type": "string", - "description": "Project ID for this request.", - "location": "path", - "required": true + "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" }, - "region": { + "message": { "type": "string", - "required": true, - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "description": "[Output Only] A human-readable description of the warning code." }, - "requestId": { + "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." + ] } }, - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", - "response": { - "$ref": "Operation" + "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." }, - "id": "compute.vpnTunnels.delete", - "parameterOrder": [ - "project", - "region", - "vpnTunnel" - ], - "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", - "description": "Deletes the specified VpnTunnel resource.", - "httpMethod": "DELETE" + "type": "object", + "description": "A list of MachineTypesScopedList resources." }, - "get": { - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", - "id": "compute.vpnTunnels.get", - "parameters": { - "region": { - "required": true, - "description": "Name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string" + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "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)." + } + } + } }, - "vpnTunnel": { - "description": "Name of the VpnTunnel 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}" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "project": { + "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ] } }, - "parameterOrder": [ - "project", - "region", - "vpnTunnel" - ], - "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", - "description": "Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.", - "response": { - "$ref": "VpnTunnel" + "type": "object" + }, + "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" - ], - "httpMethod": "GET" + "type": "array", + "description": "[Output Only] Unreachable resources." }, - "setLabels": { - "id": "compute.vpnTunnels.setLabels", - "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "resource": { - "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", - "location": "path" - }, - "project": { - "description": "Project ID for this request.", + "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" + }, + "type": "array", + "description": "[Output Only] The list of PerInstanceConfig." + }, + "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." + ], "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string", - "description": "The region 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": { + "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).", + "message": { "type": "string", - "location": "query" + "description": "[Output Only] A human-readable description of the warning code." } }, - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "RegionSetLabelsRequest" + "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" + } + }, + "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" }, - "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." + ], + "type": "string", + "enum": [ + "ACTIVE", + "CANCELLED", + "COMPLETED", + "NS_ACTIVE", + "NS_CANCELED" ] }, - "insert": { - "parameters": { - "region": { - "location": "path", - "description": "Name of the region for this request.", - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "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." - }, - "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" + "affectedCircuits": { + "type": "array", + "items": { + "type": "string" }, - "httpMethod": "POST", - "parameterOrder": [ - "project", - "region" + "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected." + }, + "issueType": { + "enum": [ + "IT_OUTAGE", + "IT_PARTIAL_OUTAGE", + "OUTAGE", + "PARTIAL_OUTAGE" ], - "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels", - "id": "compute.vpnTunnels.insert", - "request": { - "$ref": "VpnTunnel" - }, - "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." ], - "path": "projects/{project}/regions/{region}/vpnTunnels" + "type": "string" }, - "aggregatedList": { - "flatPath": "projects/{project}/aggregated/vpnTunnels", - "httpMethod": "GET", - "description": "Retrieves an aggregated list of VPN tunnels.", - "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." - }, - "maxResults": { - "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", - "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." - }, - "filter": { - "location": "query", + "startTime": { + "description": "Scheduled start time for the outage (milliseconds since Unix epoch).", + "type": "string", + "format": "int64" + }, + "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." + ] + }, + "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" + }, + "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." + }, + "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": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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 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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { + "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" + } }, - "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" - }, - "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": "VpnTunnelAggregatedList" - }, - "id": "compute.vpnTunnels.aggregatedList", - "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", - "parameterOrder": [ - "project" - ] + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "list": { - "parameterOrder": [ - "project", - "region" - ], - "description": "Retrieves a list of VpnTunnel resources contained in 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.vpnTunnels.list", - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/vpnTunnels", - "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." - }, - "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" - }, - "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": { - "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." + "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\" } " }, - "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" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "pageToken": { + "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.", - "location": "query" - }, - "maxResults": { - "default": "500", - "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`)" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": "VpnTunnelList" + "description": "Informational warning which replaces the list of addresses when the list is empty." + }, + "targetPools": { + "items": { + "$ref": "TargetPool" }, - "flatPath": "projects/{project}/regions/{region}/vpnTunnels" + "description": "A list of target pools contained in this scope.", + "type": "array" } - } + }, + "id": "TargetPoolsScopedList", + "type": "object" }, - "projects": { - "methods": { - "getXpnResources": { - "description": "Gets service resources (a.k.a service project) associated with this host project.", - "flatPath": "projects/{project}/getXpnResources", - "response": { - "$ref": "ProjectsGetXpnResources" - }, - "httpMethod": "GET", - "parameterOrder": [ - "project" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "maxResults": { - "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", - "default": "500" - }, - "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`.", + "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" + }, + "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." + }, + "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." + } + }, + "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" + }, + "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", + "description": "[Output Only] Informational warning message.", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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": { - "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": { + "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.", - "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", - "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" + ] } + } + }, + "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" }, - "id": "compute.projects.getXpnResources", - "path": "projects/{project}/getXpnResources" + "type": "array", + "description": "[Output Only] The list of errors of the managed instance group." }, - "setDefaultNetworkTier": { - "parameterOrder": [ - "project" - ], - "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", + "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)." + } + } + } + }, + "message": { "type": "string", - "description": "Project ID 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).", - "location": "query", - "type": "string" - } - }, - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "flatPath": "projects/{project}/setDefaultNetworkTier", - "id": "compute.projects.setDefaultNetworkTier", - "request": { - "$ref": "ProjectsSetDefaultNetworkTierRequest" - }, - "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.", - "path": "projects/{project}/setDefaultNetworkTier", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "id": "compute.projects.get", - "httpMethod": "GET", - "parameters": { - "project": { + "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.", - "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])?))" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "path": "projects/{project}", - "response": { - "$ref": "Project" + "description": "Informational warning which replaces the list of packetMirrorings when the list is empty.", + "type": "object" + }, + "packetMirrorings": { + "type": "array", + "items": { + "$ref": "PacketMirroring" }, - "parameterOrder": [ - "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." + "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." }, - "listXpnHosts": { - "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.", - "location": "query", - "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`." - }, - "project": { - "description": "Project ID for this request.", - "required": true, + "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" + ], "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "default": "500", - "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`)" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", + "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\" } " + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" } }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/listXpnHosts", - "description": "Lists all shared VPC host projects visible to the user in an organization.", - "id": "compute.projects.listXpnHosts", - "request": { - "$ref": "ProjectsListXpnHostsRequest" + "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." + }, + "items": { + "description": "A list of NetworkEndpointGroup resources.", + "items": { + "$ref": "NetworkEndpointGroup" }, - "flatPath": "projects/{project}/listXpnHosts", - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "XpnHostList" - } + "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." }, - "enableXpnHost": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/enableXpnHost", - "parameterOrder": [ - "project" - ], - "description": "Enable this project as a shared VPC host project.", - "response": { - "$ref": "Operation" + "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" }, - "path": "projects/{project}/enableXpnHost", - "httpMethod": "POST", - "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": { - "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", + "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" }, - "id": "compute.projects.enableXpnHost" + "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" }, - "disableXpnHost": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "flatPath": "projects/{project}/disableXpnHost", - "path": "projects/{project}/disableXpnHost", - "response": { - "$ref": "Operation" + "sourceNatActiveIps": { + "items": { + "type": "string" }, - "parameterOrder": [ - "project" - ], - "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": "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" }, - "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.disableXpnHost", - "description": "Disable this project as a shared VPC host project." - }, - "moveInstance": { - "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)." + "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" + } + } + } }, - "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, + "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" } }, - "response": { - "$ref": "Operation" - }, - "id": "compute.projects.moveInstance", - "parameterOrder": [ - "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" + }, + "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." ], - "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).", - "flatPath": "projects/{project}/moveInstance", - "path": "projects/{project}/moveInstance", - "request": { - "$ref": "InstanceMoveRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" ] }, - "setUsageExportBucket": { - "flatPath": "projects/{project}/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" + "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" ], - "path": "projects/{project}/setUsageExportBucket", - "request": { - "$ref": "UsageExportLocation" - }, - "id": "compute.projects.setUsageExportBucket", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "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": { - "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" + "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": [ + "", + "" ], - "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." + "type": "string" }, - "getXpnHost": { - "id": "compute.projects.getXpnHost", - "httpMethod": "GET", - "response": { - "$ref": "Project" - }, - "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])?))" - } - }, - "parameterOrder": [ - "project" + "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." + } + }, + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "", + "", + "" ], - "description": "Gets the shared VPC host project that this project links to. May be empty if no link exists.", - "flatPath": "projects/{project}/getXpnHost", - "path": "projects/{project}/getXpnHost" + "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" }, - "enableXpnResource": { - "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.", - "path": "projects/{project}/enableXpnResource", - "httpMethod": "POST", - "flatPath": "projects/{project}/enableXpnResource", - "id": "compute.projects.enableXpnResource", - "request": { - "$ref": "ProjectsEnableXpnResourceRequest" - }, - "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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } - }, - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": { + "type": "string", + "description": "An optional description of this resource. Provide this property when you create the resource." }, - "moveDisk": { - "flatPath": "projects/{project}/moveDisk", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "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": { - "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}/moveDisk", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "DiskMoveRequest" + "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" }, - "description": "Moves a persistent disk from one zone to another.", - "parameterOrder": [ - "project" - ], - "id": "compute.projects.moveDisk" + "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." }, - "disableXpnResource": { - "request": { - "$ref": "ProjectsDisableXpnResourceRequest" + "resources": { + "items": { + "$ref": "ResourceCommitment" }, - "parameterOrder": [ - "project" + "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": [ + "", + "", + "" ], - "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" - } - }, - "id": "compute.projects.disableXpnResource", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "path": "projects/{project}/disableXpnResource", - "httpMethod": "POST", - "flatPath": "projects/{project}/disableXpnResource", - "response": { - "$ref": "Operation" - }, - "description": "Disable a service resource (also known as service project) associated with this host project." + "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": [ + "", + "", + "", + "", + "" + ] }, - "setCommonInstanceMetadata": { - "flatPath": "projects/{project}/setCommonInstanceMetadata", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "kind": { + "type": "string", + "default": "compute#commitment", + "description": "[Output Only] Type of the resource. Always compute#commitment for commitments." + }, + "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" ], - "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])?))", - "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" - } - }, - "path": "projects/{project}/setCommonInstanceMetadata", - "id": "compute.projects.setCommonInstanceMetadata", - "httpMethod": "POST", - "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.", + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], - "request": { - "$ref": "Metadata" - }, - "description": "Sets metadata common to all instances within the specified project using the data included in the request.", - "response": { - "$ref": "Operation" - } + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" } } }, - "packetMirrorings": { - "methods": { - "insert": { - "path": "projects/{project}/regions/{region}/packetMirrorings", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "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" - }, - "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": { - "type": "string", - "description": "Name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true - } - }, - "flatPath": "projects/{project}/regions/{region}/packetMirrorings", - "httpMethod": "POST", - "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.", - "response": { - "$ref": "Operation" - }, - "id": "compute.packetMirrorings.insert", - "parameterOrder": [ - "project", - "region" - ] + "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." }, - "aggregatedList": { - "response": { - "$ref": "PacketMirroringAggregatedList" - }, - "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/packetMirrorings", - "description": "Retrieves an aggregated list of packetMirrorings.", - "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 - }, - "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." - }, - "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", - "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." - }, - "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" - } + "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" }, - "httpMethod": "GET", - "parameterOrder": [ - "project" - ], - "id": "compute.packetMirrorings.aggregatedList", - "flatPath": "projects/{project}/aggregated/packetMirrorings" + "description": "[Output Only] Unreachable resources." }, - "list": { - "response": { - "$ref": "PacketMirroringList" + "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" }, - "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" - }, - "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", - "minimum": "0", - "location": "query", - "default": "500" + "type": "object" + }, + "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" }, - "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - }, - "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" - }, - "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" - }, - "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" } }, - "id": "compute.packetMirrorings.list", - "httpMethod": "GET", - "description": "Retrieves a list of PacketMirroring resources available to the specified project and region.", - "parameterOrder": [ - "project", - "region" - ], - "path": "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" - ], - "flatPath": "projects/{project}/regions/{region}/packetMirrorings" + "description": "[Output Only] Informational warning message.", + "type": "object" + } + }, + "id": "AcceleratorTypeAggregatedList", + "type": "object" + }, + "SubnetworksScopedList": { + "properties": { + "subnetworks": { + "type": "array", + "items": { + "$ref": "Subnetwork" + }, + "description": "A list of subnetworks contained in this scope." }, - "testIamPermissions": { - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "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" - }, - "project": { - "location": "path", - "description": "Project ID for this request.", + "warning": { + "description": "An informational warning that appears when the list of addresses is empty.", + "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])?))", - "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." + ], + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { + "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": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "description": "The name of the region for this request.", - "required": true + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "id": "compute.packetMirrorings.testIamPermissions", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/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}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", - "httpMethod": "POST", - "response": { - "$ref": "TestPermissionsResponse" - }, - "request": { - "$ref": "TestPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource." + "type": "object" + } + }, + "id": "SubnetworksScopedList", + "type": "object" + }, + "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": { + "properties": { + "diskSizeGb": { + "format": "int64", + "type": "string", + "description": "Specifies the size of the disk in base-2 GB." }, - "get": { - "parameterOrder": [ - "project", - "region", - "packetMirroring" + "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": "PacketMirroring" - }, - "description": "Returns the specified PacketMirroring resource.", - "id": "compute.packetMirrorings.get", - "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", - "parameters": { - "packetMirroring": { - "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 PacketMirroring resource to return.", - "type": "string" - }, - "region": { - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "description": "Name of the region for 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])?))" - } - }, - "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", + "enumDescriptions": [ + "", + "" + ] + } + }, + "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" ], - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}" + "type": "string", + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ] }, - "delete": { - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." + }, + "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" + }, + "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" ], - "parameterOrder": [ - "project", - "region", - "packetMirroring" + "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." ], - "description": "Deletes the specified PacketMirroring resource.", - "parameters": { - "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." - }, - "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" - }, - "packetMirroring": { - "required": true, - "type": "string", - "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}", - "location": "path" - } - }, - "id": "compute.packetMirrorings.delete", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}" + "type": "string" }, - "patch": { - "response": { - "$ref": "Operation" + "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" }, - "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.", - "request": { - "$ref": "PacketMirroring" + "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" + ] }, - "parameterOrder": [ - "project", - "region", - "packetMirroring" - ], - "httpMethod": "PATCH", - "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", - "parameters": { - "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])?))", - "required": true, - "type": "string", - "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" - }, - "packetMirroring": { - "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 PacketMirroring resource to patch.", - "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.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "network": { + "annotations": { + "required": [ + "compute.vpnGateways.insert" + ] }, - "id": "compute.packetMirrorings.patch", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}" + "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." } } }, - "regionSslCertificates": { - "methods": { - "insert": { - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "region" + "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" ], - "id": "compute.regionSslCertificates.insert", - "request": { - "$ref": "SslCertificate" + "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" }, - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/sslCertificates", - "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])?))" + "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\" } " }, - "region": { - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-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." + ], + "description": "[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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." } }, - "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", - "path": "projects/{project}/regions/{region}/sslCertificates" + "type": "object" }, - "get": { - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", - "httpMethod": "GET", - "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." - }, - "sslCertificate": { - "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 SslCertificate resource to return.", - "type": "string" - }, - "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" - } - }, - "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 in the specified region. Get a list of available SSL certificates by making a list() request.", - "id": "compute.regionSslCertificates.get", - "response": { - "$ref": "SslCertificate" + "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" + }, + "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" }, - "parameterOrder": [ - "project", - "region", - "sslCertificate" - ] + "description": "[Output Only] Unreachable resources." }, - "delete": { - "description": "Deletes the specified SslCertificate resource in the region.", - "parameterOrder": [ - "project", - "region", - "sslCertificate" - ], - "id": "compute.regionSslCertificates.delete", - "httpMethod": "DELETE", - "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "sslCertificate": { - "required": true, - "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}" + "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" + } + }, + "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" + } }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "message": { "type": "string", - "location": "path", - "required": true, - "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" + "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, + "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" } }, - "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", - "response": { - "$ref": "Operation" - } + "type": "object", + "description": "[Output Only] Informational warning message." + } + } + }, + "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" }, - "list": { - "httpMethod": "GET", - "parameters": { - "orderBy": { - "location": "query", + "items": { + "description": "A list of Address resources.", + "items": { + "$ref": "Address" + }, + "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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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, - "description": "Project ID for this request.", + "message": { "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": { - "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." }, - "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 + "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\" } " } }, - "path": "projects/{project}/regions/{region}/sslCertificates", - "response": { - "$ref": "SslCertificateList" + "description": "[Output Only] Informational warning message.", + "type": "object" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagerUpdateInstanceConfigReq": { + "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", + "type": "object", + "properties": { + "perInstanceConfigs": { + "items": { + "$ref": "PerInstanceConfig" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" ], - "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", - "parameterOrder": [ - "project", - "region" + "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.", + "" + ], + "description": "The type of packets for which inter-packet intervals were computed.", + "type": "string" + }, + "duration": { + "type": "string", + "enumDescriptions": [ + "", + "", + "From BfdSession object creation time.", + "" ], - "id": "compute.regionSslCertificates.list", - "flatPath": "projects/{project}/regions/{region}/sslCertificates" + "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" }, - "interconnectLocations": { - "methods": { - "get": { - "response": { - "$ref": "InterconnectLocation" - }, - "id": "compute.interconnectLocations.get", - "flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}", - "httpMethod": "GET", - "path": "projects/{project}/global/interconnectLocations/{interconnectLocation}", - "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" - }, - "interconnectLocation": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the interconnect location to return.", - "location": "path", - "required": true - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" + }, + "weightError": { + "type": "string", + "enum": [ + "INVALID_WEIGHT", + "MISSING_WEIGHT", + "UNAVAILABLE_WEIGHT", + "WEIGHT_NONE" ], - "description": "Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.", - "parameterOrder": [ - "project", - "interconnectLocation" + "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." ] }, - "list": { - "description": "Retrieves the list of interconnect locations available to the specified project.", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "forwardingRule": { + "type": "string", + "description": "URL of the forwarding rule associated with the health status of the instance." + }, + "healthState": { + "enum": [ + "HEALTHY", + "UNHEALTHY" ], - "id": "compute.interconnectLocations.list", - "flatPath": "projects/{project}/global/interconnectLocations", - "parameterOrder": [ - "project" + "description": "Health state of the instance.", + "enumDescriptions": [ + "", + "" ], - "path": "projects/{project}/global/interconnectLocations", - "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": { - "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])?))" - }, - "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" - }, - "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", - "type": "integer", - "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" - } + "type": "string" + }, + "weight": { + "type": "string" + }, + "annotations": { + "additionalProperties": { + "type": "string" }, - "response": { - "$ref": "InterconnectLocationList" - } + "description": "Metadata defined as annotations for network endpoint.", + "type": "object" } - } + }, + "type": "object" }, - "targetTcpProxies": { - "methods": { - "setBackendService": { - "id": "compute.targetTcpProxies.setBackendService", - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", - "request": { - "$ref": "TargetTcpProxiesSetBackendServiceRequest" - }, - "response": { - "$ref": "Operation" - }, - "description": "Changes the BackendService for TargetTcpProxy.", - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", - "parameterOrder": [ - "project", - "targetTcpProxy" - ], - "httpMethod": "POST", - "parameters": { - "targetTcpProxy": { - "location": "path", - "required": true, - "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}", - "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 - }, - "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" - ] + "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." }, - "list": { - "parameterOrder": [ - "project" - ], - "id": "compute.targetTcpProxies.list", - "response": { - "$ref": "TargetTcpProxyList" - }, - "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 the list of TargetTcpProxy resources available to the specified project.", - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "format": "uint32" - }, - "project": { - "required": true, + "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." + }, + "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": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." }, - "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": { + "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" + } + } + } }, - "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" - }, - "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}/global/targetTcpProxies", - "flatPath": "projects/{project}/global/targetTcpProxies" + "type": "object", + "description": "[Output Only] Informational warning message." }, - "setProxyHeader": { - "httpMethod": "POST", - "description": "Changes the ProxyHeaderType for TargetTcpProxy.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", - "id": "compute.targetTcpProxies.setProxyHeader", - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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 - }, - "targetTcpProxy": { - "location": "path", - "required": true, - "type": "string", - "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "targetTcpProxy" - ], - "request": { - "$ref": "TargetTcpProxiesSetProxyHeaderRequest" - }, - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader" + "kind": { + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.", + "type": "string", + "default": "compute#instanceGroupManagerList" }, - "delete": { - "httpMethod": "DELETE", - "description": "Deletes the specified TargetTcpProxy resource.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.targetTcpProxies.delete", - "parameterOrder": [ - "project", - "targetTcpProxy" - ], - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", - "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.", - "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 - }, - "targetTcpProxy": { - "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 TargetTcpProxy resource to delete.", - "required": true - } - }, - "response": { - "$ref": "Operation" + "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." } }, - "insert": { - "request": { - "$ref": "TargetTcpProxy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.", - "parameters": { - "requestId": { - "location": "query", + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { + "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\" } " + }, + "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" } }, - "httpMethod": "POST", - "id": "compute.targetTcpProxies.insert", - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/global/targetTcpProxies", - "path": "projects/{project}/global/targetTcpProxies" + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "get": { - "parameters": { - "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 to return." - }, - "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" - } + "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" }, - "httpMethod": "GET", - "id": "compute.targetTcpProxies.get", - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", - "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}", - "response": { - "$ref": "TargetTcpProxy" + "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" + }, + "activeNatIps": { + "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].", + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "targetTcpProxy" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "type": "array" } - } + }, + "type": "object" }, - "reservations": { - "methods": { - "getIamPolicy": { - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameters": { - "optionsRequestedPolicyVersion": { - "format": "int32", - "type": "integer", - "description": "Requested IAM Policy version.", - "location": "query" - }, - "project": { + "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" + ], "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "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." + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "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 + "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\" } " } + } + }, + "items": { + "description": "A list of SslPoliciesScopedList resources.", + "additionalProperties": { + "$ref": "SslPoliciesScopedList", + "description": "Name of the scope containing this set of SSL policies." }, - "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", - "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", - "httpMethod": "GET", - "response": { - "$ref": "Policy" + "type": "object" + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "unreachables": { + "type": "array", + "items": { + "type": "string" }, - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "id": "compute.reservations.getIamPolicy" + "description": "[Output Only] Unreachable resources." }, - "setIamPolicy": { - "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", - "parameterOrder": [ - "project", - "zone", - "resource" + "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." + } + }, + "id": "SslPoliciesAggregatedList" + }, + "SecurityPolicyAdvancedOptionsConfig": { + "id": "SecurityPolicyAdvancedOptionsConfig", + "type": "object", + "properties": { + "jsonParsing": { + "enum": [ + "DISABLED", + "STANDARD" ], - "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" - }, - "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": { - "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." - } - }, - "response": { - "$ref": "Policy" - }, - "httpMethod": "POST", - "id": "compute.reservations.setIamPolicy", - "request": { - "$ref": "ZoneSetPolicyRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enumDescriptions": [ + "", + "" ] }, - "list": { - "response": { - "$ref": "ReservationList" - }, - "id": "compute.reservations.list", - "httpMethod": "GET", - "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" + "jsonCustomConfig": { + "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", + "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD." + }, + "logLevel": { + "enumDescriptions": [ + "", + "" ], - "flatPath": "projects/{project}/zones/{zone}/reservations", - "path": "projects/{project}/zones/{zone}/reservations", - "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." - }, - "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`." - }, - "maxResults": { - "minimum": "0", - "format": "uint32", - "default": "500", - "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`)" - }, - "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": { - "description": "Name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string", - "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" - } - }, - "parameterOrder": [ - "project", - "zone" + "type": "string", + "enum": [ + "NORMAL", + "VERBOSE" ] + } + } + }, + "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." }, - "delete": { - "response": { - "$ref": "Operation" + "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" }, - "description": "Deletes the specified reservation.", - "path": "projects/{project}/zones/{zone}/reservations/{reservation}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "zone", - "reservation" - ], - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", - "httpMethod": "DELETE", - "id": "compute.reservations.delete", - "parameters": { - "reservation": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the reservation to delete.", - "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." + "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" + }, + "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" + } + } + } }, - "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." + ], "type": "string", - "description": "Name of the zone 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." }, - "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." } } + } + }, + "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." }, - "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" - }, - "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])?))" - }, - "zone": { - "description": "Name of the zone for this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "location": "path" - } - }, - "flatPath": "projects/{project}/zones/{zone}/reservations", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "collocation": { + "enumDescriptions": [ + "", + "" ], - "request": { - "$ref": "Reservation" - }, - "description": "Creates a new reservation. For more information, read Reserving zonal resources.", - "id": "compute.reservations.insert", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone" + "description": "Specifies network collocation", + "enum": [ + "COLLOCATED", + "UNSPECIFIED_COLLOCATION" ], - "path": "projects/{project}/zones/{zone}/reservations" + "type": "string" }, - "aggregatedList": { - "description": "Retrieves an aggregated list of reservations.", - "id": "compute.reservations.aggregatedList", - "path": "projects/{project}/aggregated/reservations", - "response": { - "$ref": "ReservationAggregatedList" + "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" }, - "flatPath": "projects/{project}/aggregated/reservations", - "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" - ], - "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`)", - "minimum": "0", - "type": "integer", - "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." - }, - "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": "A list of PublicAdvertisedPrefix resources.", + "type": "array" + }, + "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)." + } + } + } }, - "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": { + "description": "[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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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" + }, + "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": "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" }, - "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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "location": "query", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "type": "boolean" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } } }, - "get": { - "httpMethod": "GET", - "id": "compute.reservations.get", - "path": "projects/{project}/zones/{zone}/reservations/{reservation}", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", - "parameters": { - "reservation": { - "description": "Name of the reservation to retrieve.", - "type": "string", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path" + "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." + ], + "type": "string" }, - "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])?))" + "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": { + "message": { "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." + "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", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project", - "zone", - "reservation" - ], - "description": "Retrieves information about the specified reservation.", - "response": { - "$ref": "Reservation" - } + "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." }, - "testIamPermissions": { - "request": { - "$ref": "TestPermissionsRequest" - }, - "path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", - "id": "compute.reservations.testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.", - "httpMethod": "POST", - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "type": { + "enumDescriptions": [ + "", + "" ], - "response": { - "$ref": "TestPermissionsResponse" - }, - "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", - "parameters": { - "project": { - "location": "path", + "description": "Type of the redirect action.", + "type": "string", + "enum": [ + "EXTERNAL_302", + "GOOGLE_RECAPTCHA" + ] + } + } + }, + "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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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." }, - "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" + "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." + } + } + } }, - "resource": { - "required": true, - "description": "Name or id of the resource 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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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])?|[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." + ] } } }, - "update": { - "parameterOrder": [ - "project", - "zone", - "reservation" - ], - "path": "projects/{project}/zones/{zone}/reservations/{reservation}", - "request": { - "$ref": "Reservation" - }, - "description": "Update share settings of the reservation.", - "httpMethod": "PATCH", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", - "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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true, - "description": "Name of the zone for this request." - }, - "reservation": { - "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 reservation to update." - }, - "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" - }, - "updateMask": { - "type": "string", - "format": "google-fieldmask", - "location": "query", - "description": "Update_mask indicates fields to be updated as part of this request." - }, - "paths": { - "repeated": true, - "type": "string", - "location": "query" - } - }, - "response": { - "$ref": "Operation" + "items": { + "items": { + "$ref": "SecurityPolicy" }, - "id": "compute.reservations.update", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ] }, - "resize": { - "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", - "request": { - "$ref": "ReservationsResizeRequest" - }, - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", - "response": { - "$ref": "Operation" + "advertisedRoutes": { + "items": { + "$ref": "Route" }, - "id": "compute.reservations.resize", - "path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", - "parameterOrder": [ - "project", - "zone", - "reservation" + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "", + "", + "" ], - "parameters": { - "reservation": { - "required": true, + "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" + }, + "type": "array", + "description": "A list of VPN tunnels contained in this scope." + }, + "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.", "type": "string", - "location": "path", - "description": "Name of the reservation to update.", - "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" + ] }, - "zone": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the zone for this request.", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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" + } + } + } + } + }, + "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." + ], "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" + ] }, - "project": { - "description": "Project ID for this request.", + "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": "[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": { + "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" } }, - "httpMethod": "POST" + "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" + } + }, + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." } - } + }, + "type": "object" }, - "regionHealthChecks": { - "methods": { - "patch": { - "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "httpMethod": "PATCH", - "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "request": { - "$ref": "HealthCheck" - }, - "parameterOrder": [ - "project", - "region", - "healthCheck" + "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." + }, + "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": [ + "", + "", + "" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "CLOUD_ARMOR", + "CLOUD_ARMOR_EDGE", + "CLOUD_ARMOR_NETWORK" ], - "response": { - "$ref": "Operation" + "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" + }, + "rules": { + "items": { + "$ref": "SecurityPolicyRule" }, - "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.", - "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" - }, - "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", - "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." - }, - "healthCheck": { - "description": "Name of the HealthCheck resource to patch.", - "type": "string", - "required": true, - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } + "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" }, - "id": "compute.regionHealthChecks.patch" + "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" }, - "delete": { - "parameterOrder": [ - "project", - "region", - "healthCheck" + "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" + }, + "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" ], - "parameters": { - "healthCheck": { - "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 HealthCheck resource to delete.", - "location": "path" - }, - "region": { - "required": true, - "location": "path", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "enumDescriptions": [ + "Node may associate with any physical server over its lifetime.", + "Node may associate with minimal physical servers over its lifetime.", + "" + ], + "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" + } + } + } }, - "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" + ] }, - "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 + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "httpMethod": "DELETE", - "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "response": { - "$ref": "Operation" + "description": "Informational warning which replaces the list of backend services when the list is empty." + }, + "targetTcpProxies": { + "items": { + "$ref": "TargetTcpProxy" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.regionHealthChecks.delete", - "description": "Deletes the specified HealthCheck resource.", - "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}" + "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" }, - "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" + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "type": "array", + "items": { + "type": "string" + } + }, + "items": { + "additionalProperties": { + "description": "[Output Only] The name of the scope that contains this set of managed instance groups.", + "$ref": "InstanceGroupManagersScopedList" }, - "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.", - "httpMethod": "GET", - "id": "compute.regionHealthChecks.get", - "parameterOrder": [ - "project", - "region", - "healthCheck" - ], - "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "flatPath": "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}", - "location": "path", + "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": { "type": "string", - "description": "Name of the HealthCheck resource to return.", - "required": true + "description": "[Output Only] A human-readable description of the warning code." }, - "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." + "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\" } " }, - "region": { - "description": "Name of the region scoping 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." + ], "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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." } } }, - "insert": { - "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" + }, + "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." ], - "flatPath": "projects/{project}/regions/{region}/healthChecks", - "httpMethod": "POST", - "request": { - "$ref": "HealthCheck" + "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" }, - "parameterOrder": [ - "project", - "region" + "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.", + "" ], - "path": "projects/{project}/regions/{region}/healthChecks", - "response": { - "$ref": "Operation" - }, - "id": "compute.regionHealthChecks.insert", - "description": "Creates a HealthCheck resource in the specified project using the data included in the request.", - "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, - "description": "Name of the region scoping this request.", - "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])?))", - "type": "string", - "description": "Project ID for this request.", - "location": "path" - } + "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" + ] + }, + "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" } }, - "list": { - "flatPath": "projects/{project}/regions/{region}/healthChecks", - "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": { - "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." - }, - "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])?" - }, - "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" - }, - "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`)", - "format": "uint32", - "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": { - "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`." - } + "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" }, - "id": "compute.regionHealthChecks.list", - "httpMethod": "GET", - "response": { - "$ref": "HealthCheckList" + "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" }, - "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 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." + }, + "localityLbPolicy": { + "enum": [ + "INVALID_LB_POLICY", + "LEAST_REQUEST", + "MAGLEV", + "ORIGINAL_DESTINATION", + "RANDOM", + "RING_HASH", + "ROUND_ROBIN" ], - "path": "projects/{project}/regions/{region}/healthChecks", - "description": "Retrieves the list of HealthCheck resources available to the specified project.", - "parameterOrder": [ - "project", - "region" + "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." ] }, - "update": { - "parameters": { - "region": { - "required": true, - "type": "string", - "location": "path", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "healthCheck": { - "required": true, - "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}" - }, - "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": { - "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", - "healthCheck" + "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." ], - "description": "Updates a HealthCheck resource in the specified project using the data included in the request.", - "httpMethod": "PUT", - "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", - "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" ], - "request": { - "$ref": "HealthCheck" + "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" + }, + "customResponseHeaders": { + "items": { + "type": "string" }, - "response": { - "$ref": "Operation" + "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" }, - "id": "compute.regionHealthChecks.update" + "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." + ], + "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" }, - "zoneOperations": { - "methods": { - "delete": { - "path": "projects/{project}/zones/{zone}/operations/{operation}", - "flatPath": "projects/{project}/zones/{zone}/operations/{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])?))", - "required": true, - "description": "Project ID for this request." - }, - "zone": { - "type": "string", - "location": "path", - "description": "Name of the zone for this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "operation": { - "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 Operations resource to delete." - } + "LocalizedMessage": { + "properties": { + "message": { + "description": "The localized error message in the above locale.", + "type": "string" + }, + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Deletes the specified zone-specific Operations resource.", - "parameterOrder": [ - "project", - "zone", - "operation" - ], - "id": "compute.zoneOperations.delete", - "httpMethod": "DELETE" + "description": "The labels to set for this resource.", + "type": "object" }, - "get": { - "parameterOrder": [ - "project", - "zone", - "operation" - ], - "path": "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": "Retrieves the specified zone-specific Operations resource.", - "httpMethod": "GET", - "id": "compute.zoneOperations.get", - "parameters": { - "operation": { + "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" + } + }, + "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" + ], "type": "string", - "required": true, - "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}", - "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." }, - "zone": { - "required": true, - "description": "Name of the zone for this request.", + "message": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." }, - "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 + "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" + } + } + } } - }, - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/zones/{zone}/operations/{operation}" + } }, - "wait": { - "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" - }, - "operation": { - "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}", - "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" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone", - "operation" - ], - "flatPath": "projects/{project}/zones/{zone}/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 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", - "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", - "httpMethod": "POST" + "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" + } }, - "list": { - "path": "projects/{project}/zones/{zone}/operations", - "httpMethod": "GET", - "id": "compute.zoneOperations.list", - "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" - }, - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer" - }, - "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`.", + "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" }, - "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": { - "description": "Name of the zone for request.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true + "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\" } " }, - "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.", + "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" } }, - "description": "Retrieves a list of Operation resources contained within the specified zone.", - "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" - ], - "response": { - "$ref": "OperationList" + "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", - "zone" - ] + "description": "A list of DiskType resources.", + "type": "array" } - } + }, + "type": "object" }, - "machineTypes": { - "methods": { - "get": { - "description": "Returns the specified machine type. Gets a list of available machine types by making a list() request.", - "flatPath": "projects/{project}/zones/{zone}/machineTypes/{machineType}", - "parameters": { - "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" - }, - "machineType": { - "type": "string", - "location": "path", - "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}", - "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." - } + "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" }, - "id": "compute.machineTypes.get", - "path": "projects/{project}/zones/{zone}/machineTypes/{machineType}", - "parameterOrder": [ - "project", - "zone", - "machineType" - ], - "response": { - "$ref": "MachineType" + "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" }, - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "type": "array" }, - "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" - ], - "description": "Retrieves a list of machine types available to the specified project.", - "response": { - "$ref": "MachineTypeList" - }, - "httpMethod": "GET", - "id": "compute.machineTypes.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": { - "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, - "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" - }, - "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" - }, - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "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}/zones/{zone}/machineTypes", - "path": "projects/{project}/zones/{zone}/machineTypes" + "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" + } }, - "aggregatedList": { - "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" - }, - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - }, - "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" - } - }, - "path": "projects/{project}/aggregated/machineTypes", - "response": { - "$ref": "MachineTypeAggregatedList" + "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" }, - "httpMethod": "GET", - "description": "Retrieves an aggregated list of machine types.", - "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/machineTypes", - "id": "compute.machineTypes.aggregatedList" + "type": "array" } - } + }, + "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/)." }, - "publicDelegatedPrefixes": { - "methods": { - "aggregatedList": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.", - "id": "compute.publicDelegatedPrefixes.aggregatedList", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/publicDelegatedPrefixes", - "response": { - "$ref": "PublicDelegatedPrefixAggregatedList" + "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" }, - "httpMethod": "GET", - "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes", - "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" - }, - "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": { - "description": "Name of the project scoping 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" + "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\" } " }, - "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.", "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "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`." - }, - "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`)", - "format": "uint32", - "type": "integer" + "description": "[Output Only] A human-readable description of the warning code." } } }, - "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": { - "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.", - "type": "string", - "location": "path", - "required": true - }, - "region": { - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "Name of the region of this request." - }, - "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 - } + "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" }, - "id": "compute.publicDelegatedPrefixes.delete", - "description": "Deletes the specified PublicDelegatedPrefix in the given region.", - "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "parameterOrder": [ - "project", - "region", - "publicDelegatedPrefix" - ], - "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "array", + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members." + }, + "ignoreChildExemptions": { + "type": "boolean", + "description": "This is deprecated and has no effect. Do not use." + }, + "logType": { + "description": "The log type that this config enables.", + "type": "string", + "enum": [ + "ADMIN_READ", + "DATA_READ", + "DATA_WRITE", + "LOG_TYPE_UNSPECIFIED" ], - "httpMethod": "DELETE", - "response": { - "$ref": "Operation" + "enumDescriptions": [ + "Admin reads. Example: CloudIAM getIamPolicy", + "Data reads. Example: CloudSQL Users list", + "Data writes. Example: CloudSQL Users create", + "Default case. Should never be this." + ] + } + }, + "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" } }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "description": "Lists the PublicDelegatedPrefixes for a project in the given region.", - "parameterOrder": [ - "project", - "region" - ], - "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes", - "response": { - "$ref": "PublicDelegatedPrefixList" - }, - "id": "compute.publicDelegatedPrefixes.list", - "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." - }, - "region": { - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "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])?))", - "location": "path", - "required": true, - "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." - }, - "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" - }, - "maxResults": { - "format": "uint32", - "minimum": "0", - "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`)" - } + "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" + ] }, - "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes", - "httpMethod": "GET" + "pattern": "[0-9]{0,20}?" }, - "get": { - "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "parameterOrder": [ - "project", - "region", - "publicDelegatedPrefix" + "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." ], - "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "parameters": { - "publicDelegatedPrefix": { - "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 PublicDelegatedPrefix resource to return.", - "location": "path" + "description": "[Output Only] Current state of this License Code.", + "enum": [ + "DISABLED", + "ENABLED", + "RESTRICTED", + "STATE_UNSPECIFIED", + "TERMINATED" + ], + "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" + } + } + }, + "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" + } }, - "region": { - "type": "string", - "description": "Name of the region of this request.", - "required": true, - "location": "path", - "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": { - "description": "Project ID for this request.", - "location": "path", - "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": "[Output Only] A human-readable description of the warning code." } + } + }, + "kind": { + "default": "compute#regionAutoscalerList", + "description": "Type of resource.", + "type": "string" + }, + "items": { + "type": "array", + "items": { + "$ref": "Autoscaler" }, - "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 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" ], - "httpMethod": "GET", - "description": "Returns the specified PublicDelegatedPrefix resource in the given region.", - "response": { - "$ref": "PublicDelegatedPrefix" - }, - "id": "compute.publicDelegatedPrefixes.get" + "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": [ + "", + "" + ] }, - "patch": { - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "portSpecification": { + "type": "string", + "enum": [ + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" ], - "parameters": { - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "required": true - }, - "publicDelegatedPrefix": { + "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. 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": { "type": "string", - "description": "Name of the PublicDelegatedPrefix resource to patch.", - "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" + ] }, - "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": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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\" } " }, - "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" } }, - "request": { - "$ref": "PublicDelegatedPrefix" - }, - "path": "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.", - "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "httpMethod": "PATCH", - "parameterOrder": [ - "project", - "region", - "publicDelegatedPrefix" - ], - "id": "compute.publicDelegatedPrefixes.patch" + "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty." }, - "insert": { - "response": { + "operations": { + "type": "array", + "items": { "$ref": "Operation" }, - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes", - "id": "compute.publicDelegatedPrefixes.insert", - "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.", - "request": { - "$ref": "PublicDelegatedPrefix" - }, - "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." - }, - "region": { - "location": "path", - "required": true, - "description": "Name of the region of 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" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "parameterOrder": [ - "project", - "region" - ] + "type": "string", + "enumDescriptions": [ + "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." } } }, - "globalNetworkEndpointGroups": { - "methods": { - "attachNetworkEndpoints": { - "parameters": { - "networkEndpointGroup": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with 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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } + "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" }, - "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "response": { - "$ref": "Operation" + "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" }, - "description": "Attach a network endpoint to the specified network endpoint group.", - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "request": { - "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest" + "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." + }, + "annotations": { + "additionalProperties": { + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST" + "type": "object", + "description": "Metadata defined as annotations on the network endpoint." }, - "get": { - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", - "response": { - "$ref": "NetworkEndpointGroup" + "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" }, - "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" - ], - "httpMethod": "GET", - "id": "compute.globalNetworkEndpointGroups.get", - "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group. It should comply with RFC1035.", - "type": "string", - "required": true, - "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])?))" - } - } + "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\": \"\")." }, - "listNetworkEndpoints": { - "response": { - "$ref": "NetworkEndpointGroupsListNetworkEndpoints" + "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" }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", - "description": "Lists the network endpoints in the specified network endpoint group.", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints", - "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" - }, - "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" - }, - "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": { - "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])?))" - }, - "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" - }, - "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 - } + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "type": "array" }, - "insert": { - "parameterOrder": [ - "project" - ], - "parameters": { - "project": { - "required": true, - "description": "Project ID for this request.", + "warning": { + "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.", + "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])?))", - "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" + ] }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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" + }, + "message": { "type": "string", - "location": "query" + "description": "[Output Only] A human-readable description of the warning code." } + } + } + }, + "type": "object" + }, + "GlobalNetworkEndpointGroupsDetachEndpointsRequest": { + "properties": { + "networkEndpoints": { + "items": { + "$ref": "NetworkEndpoint" }, - "httpMethod": "POST", - "path": "projects/{project}/global/networkEndpointGroups", - "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.", - "request": { - "$ref": "NetworkEndpointGroup" - }, - "flatPath": "projects/{project}/global/networkEndpointGroups", - "response": { - "$ref": "Operation" + "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" + }, + "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" }, - "id": "compute.globalNetworkEndpointGroups.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd." }, - "delete": { - "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.", - "response": { - "$ref": "Operation" + "guestAccelerators": { + "items": { + "$ref": "AcceleratorConfig" }, - "id": "compute.globalNetworkEndpointGroups.delete", - "parameterOrder": [ - "project", - "networkEndpointGroup" + "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." + } + } + }, + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "", + "" ], - "httpMethod": "DELETE", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", - "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.", - "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])?))" - }, - "networkEndpointGroup": { - "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", - "type": "string", - "required": true, - "location": "path" - } - } + "description": "[Output Only] Status of the zone, either UP or DOWN.", + "type": "string" }, - "detachNetworkEndpoints": { - "parameterOrder": [ - "project", - "networkEndpointGroup" - ], - "parameters": { - "networkEndpointGroup": { - "required": true, - "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", - "location": "path", + "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" + }, + "name": { + "description": "[Output Only] Name of the resource.", + "type": "string" + }, + "availableCpuPlatforms": { + "items": { + "type": "string" + }, + "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." + }, + "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." + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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": { + "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": { + "code": { "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])?))" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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.globalNetworkEndpointGroups.detachNetworkEndpoints", - "request": { - "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" + "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" }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Detach the network endpoint from the specified network endpoint group.", - "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", - "response": { - "$ref": "Operation" + "type": "array", + "description": "Up to 7 intervals/windows, one for each day of the week." + } + }, + "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" }, - "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints" + "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." }, - "list": { - "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" - }, - "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])?))", - "required": true, - "description": "Project ID for this request.", - "location": "path" - }, - "pageToken": { + "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" + }, + "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": { "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." }, - "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`)" + "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\" } " }, - "orderBy": { - "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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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." + ], + "description": "[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": "Retrieves the list of network endpoint groups that are located in the specified project.", - "response": { - "$ref": "NetworkEndpointGroupList" + "description": "Informational warning which replaces the list of backend services when the list is empty.", + "type": "object" + }, + "backendServices": { + "items": { + "$ref": "BackendService" }, - "parameterOrder": [ - "project" - ], - "id": "compute.globalNetworkEndpointGroups.list", - "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" + "description": "A list of BackendServices contained in this scope.", + "type": "array" } } }, - "globalAddresses": { - "methods": { - "setLabels": { - "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.", - "required": true, - "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])?))", - "description": "Project ID for this request.", - "location": "path" - } - }, - "request": { - "$ref": "GlobalSetLabelsRequest" + "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" }, - "id": "compute.globalAddresses.setLabels", - "flatPath": "projects/{project}/global/addresses/{resource}/setLabels", - "httpMethod": "POST", - "parameterOrder": [ - "project", - "resource" - ], - "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" - ], - "path": "projects/{project}/global/addresses/{resource}/setLabels", - "response": { - "$ref": "Operation" - } + "type": "array" }, - "delete": { - "description": "Deletes the specified address resource.", - "parameters": { - "address": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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" + }, + "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." + ], "type": "string", - "required": true, - "description": "Name of the address resource to delete." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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])?))", - "location": "path", - "type": "string", - "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\" } " }, - "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": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "address" - ], - "httpMethod": "DELETE", - "path": "projects/{project}/global/addresses/{address}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.globalAddresses.delete", - "flatPath": "projects/{project}/global/addresses/{address}" + "type": "object" }, - "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/addresses/{address}", - "response": { - "$ref": "Address" - }, - "parameters": { - "address": { - "type": "string", - "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}", - "location": "path", - "required": true + "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" + }, + "warning": { + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "project": { - "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": { + "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" + }, + "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])?))", - "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." + ] } }, - "id": "compute.globalAddresses.get", - "parameterOrder": [ - "project", - "address" - ], - "description": "Returns the specified address resource. Gets a list of available addresses by making a list() request.", - "httpMethod": "GET", - "path": "projects/{project}/global/addresses/{address}" + "type": "object", + "description": "[Output Only] Informational warning message." }, - "list": { - "response": { - "$ref": "AddressList" + "items": { + "items": { + "$ref": "BackendService" }, - "httpMethod": "GET", - "flatPath": "projects/{project}/global/addresses", - "id": "compute.globalAddresses.list", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/global/addresses", - "description": "Retrieves a list of global 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": { - "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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { + "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" + ], "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.", - "location": "query", - "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.", + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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.", - "type": "string", - "location": "query" - } - } - }, - "insert": { - "description": "Creates an address resource in the specified project by using the data included in the request.", - "id": "compute.globalAddresses.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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])?))", - "required": true, - "description": "Project ID for this request.", - "location": "path", + "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).", - "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": { + "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": "Operation" + "description": "[Output Only] Informational warning message." + }, + "items": { + "type": "array", + "items": { + "$ref": "TargetGrpcProxy" }, - "request": { - "$ref": "Address" + "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" + ] }, - "flatPath": "projects/{project}/global/addresses", - "httpMethod": "POST", - "path": "projects/{project}/global/addresses" + "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" } } }, - "serviceAttachments": { - "methods": { - "insert": { - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "POST", - "description": "Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.", - "request": { - "$ref": "ServiceAttachment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/regions/{region}/serviceAttachments", - "id": "compute.serviceAttachments.insert", - "flatPath": "projects/{project}/regions/{region}/serviceAttachments", - "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, - "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", - "required": true, - "location": "path", - "description": "Name of the region of this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - } - }, - "response": { - "$ref": "Operation" - } + "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." }, - "patch": { - "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "parameterOrder": [ - "project", - "region", - "serviceAttachment" + "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" ], - "request": { - "$ref": "ServiceAttachment" - }, - "parameters": { - "region": { - "type": "string", - "description": "The region scoping this request and should conform to RFC1035.", - "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" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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." - }, - "serviceAttachment": { - "required": true, - "type": "string", - "location": "path", - "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." - } - }, - "response": { - "$ref": "Operation" - }, - "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." + "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 " }, - "delete": { - "id": "compute.serviceAttachments.delete", - "httpMethod": "DELETE", - "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", - "parameterOrder": [ - "project", - "region", - "serviceAttachment" + "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." + }, + "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." ], - "description": "Deletes the specified ServiceAttachment in the given scope", - "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" ], - "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 of this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" - }, - "serviceAttachment": { - "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 ServiceAttachment resource to delete." - }, - "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" - } - }, - "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", - "response": { - "$ref": "Operation" - } + "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. " }, - "setIamPolicy": { - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "parameters": { - "region": { - "type": "string", - "location": "path", - "description": "The name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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.", - "type": "string", - "location": "path" - }, - "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.serviceAttachments.setIamPolicy", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "stackType": { + "type": "string", + "enumDescriptions": [ + "The interconnect attachment can have both IPv4 and IPv6 addresses.", + "The interconnect attachment will only be assigned IPv4 addresses." ], - "parameterOrder": [ - "project", - "region", - "resource" + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" ], - "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy" + "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." }, - "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}/regions/{region}/serviceAttachments/{resource}/getIamPolicy", - "id": "compute.serviceAttachments.getIamPolicy", - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{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" + "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" + }, + "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." ], - "parameters": { - "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." - }, - "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": { - "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" - }, - "optionsRequestedPolicyVersion": { - "type": "integer", - "location": "query", - "format": "int32", - "description": "Requested IAM Policy version." - } + "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" + ] + }, + "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" }, - "response": { - "$ref": "Policy" - } + "description": "This field is not available.", + "type": "array" }, - "testIamPermissions": { - "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions", - "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" + "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" + }, + "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" ], - "httpMethod": "POST", - "request": { - "$ref": "TestPermissionsRequest" - }, - "response": { - "$ref": "TestPermissionsResponse" - }, - "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions", - "id": "compute.serviceAttachments.testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.", - "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": { - "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" - }, - "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" - } - } + "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." + ] }, - "get": { - "httpMethod": "GET", - "description": "Returns the specified ServiceAttachment resource in the given scope.", - "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", - "id": "compute.serviceAttachments.get", - "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", - "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 - }, - "serviceAttachment": { - "description": "Name of the ServiceAttachment 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}" - }, - "region": { - "description": "Name of the region of this request.", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - } + "ipsecInternalAddresses": { + "type": "array", + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "region", - "serviceAttachment" - ], - "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 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. " + }, + "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": [ + "", + "", + "" ], - "response": { - "$ref": "ServiceAttachment" - } + "enum": [ + "AVAILABILITY_DOMAIN_1", + "AVAILABILITY_DOMAIN_2", + "AVAILABILITY_DOMAIN_ANY" + ] }, - "list": { - "response": { - "$ref": "ServiceAttachmentList" + "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" }, - "id": "compute.serviceAttachments.list", - "parameterOrder": [ - "project", - "region" + "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" ], - "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" - }, - "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])?))", + "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." + } + } + }, + "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": { "type": "string", - "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`)", - "format": "uint32", - "type": "integer", - "minimum": "0", - "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" + "description": "[Output Only] A human-readable description of the warning code." }, - "pageToken": { - "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.", "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", - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", - "description": "Name of the region of this request.", - "type": "string", - "required": true, - "pattern": "[a-z](?:[-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" + } + } + } } }, - "description": "Lists the ServiceAttachments for a project in the given scope.", - "path": "projects/{project}/regions/{region}/serviceAttachments", - "flatPath": "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" - ] + "type": "object", + "description": "[Output Only] Informational warning message." }, - "aggregatedList": { - "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.", - "parameterOrder": [ - "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`.", - "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", - "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" - }, - "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" + "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." + }, + "items": { + "description": "A list of InstanceWithNamedPorts resources.", + "type": "array", + "items": { + "$ref": "InstanceWithNamedPorts" + } + }, + "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" + }, + "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\" } " }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { "type": "string", - "description": "Name of the project scoping this request.", - "location": "path" - }, - "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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." }, - "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" + "description": "[Output Only] A human-readable description of the warning code." } }, - "flatPath": "projects/{project}/aggregated/serviceAttachments", - "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": "ServiceAttachmentAggregatedList" + "description": "Informational warning which replaces the list of addresses when the list is empty." + }, + "targetInstances": { + "type": "array", + "items": { + "$ref": "TargetInstance" }, - "path": "projects/{project}/aggregated/serviceAttachments", - "id": "compute.serviceAttachments.aggregatedList" + "description": "A list of target instances contained in this scope." } } }, - "regionNotificationEndpoints": { - "methods": { - "insert": { - "id": "compute.regionNotificationEndpoints.insert", - "request": { - "$ref": "NotificationEndpoint" - }, - "response": { - "$ref": "Operation" - }, - "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", - "parameters": { - "region": { - "required": true, - "location": "path", - "description": "Name of the region scoping this request.", - "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", - "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" - } - }, - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", - "path": "projects/{project}/regions/{region}/notificationEndpoints", - "parameterOrder": [ - "project", - "region" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST" + "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" }, - "delete": { - "id": "compute.regionNotificationEndpoints.delete", - "description": "Deletes the specified NotificationEndpoint in the given region", - "parameterOrder": [ - "project", - "region", - "notificationEndpoint" - ], - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "response": { - "$ref": "Operation" - }, - "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." - }, - "notificationEndpoint": { - "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 NotificationEndpoint resource to delete.", - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { + "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" }, - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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" }, - "get": { - "id": "compute.regionNotificationEndpoints.get", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "response": { - "$ref": "NotificationEndpoint" + "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" + ] }, - "parameterOrder": [ - "project", - "region", - "notificationEndpoint" - ], - "description": "Returns the specified NotificationEndpoint resource in the given region.", - "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", - "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])?))" - }, - "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" - }, - "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" - } + "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." + }, + "scalingScheduleStatus": { + "additionalProperties": { + "$ref": "ScalingScheduleStatus" }, - "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] 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" ], - "httpMethod": "GET" + "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" }, - "list": { - "id": "compute.regionNotificationEndpoints.list", - "parameterOrder": [ - "project", - "region" + "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": { + "type": "string", + "enum": [ + "FRIDAY", + "INVALID", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" ], - "description": "Lists the NotificationEndpoints for a project in the given region.", - "httpMethod": "GET", - "response": { - "$ref": "NotificationEndpointList" - }, - "path": "projects/{project}/regions/{region}/notificationEndpoints", - "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" ], - "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." - }, - "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" - }, - "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", - "location": "query", - "minimum": "0", - "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" - }, - "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 - }, - "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": "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." } } }, - "imageFamilyViews": { - "methods": { - "get": { - "parameters": { - "family": { - "description": "Name of the image family to search for.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", - "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." - }, - "zone": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "description": "The name of the zone for this request.", - "location": "path", - "type": "string" - } - }, - "flatPath": "projects/{project}/zones/{zone}/imageFamilyViews/{family}", - "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", - "response": { - "$ref": "ImageFamilyView" + "RegionInstanceGroupManagerPatchInstanceConfigReq": { + "type": "object", + "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs", + "properties": { + "perInstanceConfigs": { + "items": { + "$ref": "PerInstanceConfig" }, - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone", - "family" - ], - "path": "projects/{project}/zones/{zone}/imageFamilyViews/{family}" + "type": "array", + "description": "The list of per-instance configurations to insert or patch on this managed instance group." } - } + }, + "id": "RegionInstanceGroupManagerPatchInstanceConfigReq" }, - "zones": { - "methods": { - "list": { - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/zones", - "httpMethod": "GET", - "description": "Retrieves the list of Zone 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", + "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" + }, + "warning": { + "type": "object", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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." + "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": { - "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": { + "description": "[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": { - "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" - }, - "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." } }, - "flatPath": "projects/{project}/zones", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "ZoneList" + "description": "[Output Only] Informational warning message." + }, + "items": { + "description": "A list of MachineType resources.", + "type": "array", + "items": { + "$ref": "MachineType" + } + }, + "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." }, - "id": "compute.zones.list" + "type": "object" }, - "get": { - "path": "projects/{project}/zones/{zone}", - "flatPath": "projects/{project}/zones/{zone}", - "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 Zone resource. Gets a list of available zones by making a list() request.", - "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." + "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" + }, + "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": { - "description": "Name of the zone 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}" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "httpMethod": "GET", - "id": "compute.zones.get", - "parameterOrder": [ - "project", - "zone" - ], - "response": { - "$ref": "Zone" - } + "description": "[Output Only] Informational warning message." + }, + "unreachables": { + "items": { + "type": "string" + }, + "description": "[Output Only] Unreachable resources.", + "type": "array" + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." } } }, - "diskTypes": { - "methods": { - "get": { - "httpMethod": "GET", - "parameters": { - "diskType": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the disk type to return.", - "required": true, - "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 - }, - "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": "Returns the specified disk type. Gets a list of available disk types by making a list() request.", - "parameterOrder": [ - "project", - "zone", - "diskType" + "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": [ + "", + "", + "" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "enum": [ + "HIERARCHY", + "NETWORK", + "UNSPECIFIED" ], - "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}", - "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}", - "response": { - "$ref": "DiskType" - }, - "id": "compute.diskTypes.get" + "description": "[Output Only] The type of the firewall policy." }, - "aggregatedList": { - "id": "compute.diskTypes.aggregatedList", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/diskTypes", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "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`)", - "type": "integer", - "minimum": "0", - "format": "uint32", - "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" - }, - "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.", - "location": "query", - "type": "boolean" - }, - "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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": { - "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." - } + "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}/aggregated/diskTypes", - "description": "Retrieves an aggregated list of disk types.", - "httpMethod": "GET", - "response": { - "$ref": "DiskTypeAggregatedList" + "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" } }, - "list": { - "description": "Retrieves a list of disk types available to the specified project.", - "response": { - "$ref": "DiskTypeList" + "targetServiceAccounts": { + "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", + "items": { + "type": "string" }, - "path": "projects/{project}/zones/{zone}/diskTypes", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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": [ + "", + "" ], - "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": { - "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": { - "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" - }, - "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" - }, - "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." - }, - "maxResults": { - "location": "query", - "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`)" - } + "enum": [ + "EGRESS", + "INGRESS" + ], + "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" }, - "id": "compute.diskTypes.list", - "flatPath": "projects/{project}/zones/{zone}/diskTypes", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "zone" + "type": "array", + "description": "[Output Only] The AS numbers of the AS Path." + }, + "pathSegmentType": { + "enum": [ + "AS_CONFED_SEQUENCE", + "AS_CONFED_SET", + "AS_SEQUENCE", + "AS_SET" + ], + "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": [ + "", + "", + "", + "" ] } } }, - "regionTargetHttpProxies": { - "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" - ], - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", - "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" + "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" }, - "targetHttpProxy": { - "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", - "location": "path", - "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." + "description": "[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." + ] }, - "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." + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "description": "Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.", - "response": { - "$ref": "TargetHttpProxy" + "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": [ + "", + "" + ], + "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" + ] }, - "id": "compute.regionTargetHttpProxies.get", - "parameterOrder": [ - "project", - "region", - "targetHttpProxy" - ], - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}" + "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" }, - "insert": { - "id": "compute.regionTargetHttpProxies.insert", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", - "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", - "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": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string", - "description": "Name of the region scoping this request." - } + "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" + }, + "resourcePolicies": { + "items": { + "type": "string" }, - "parameterOrder": [ - "project", - "region" - ], - "path": "projects/{project}/regions/{region}/targetHttpProxies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "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" }, - "httpMethod": "POST", - "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", - "request": { - "$ref": "TargetHttpProxy" - } + "type": "object" }, - "setUrlMap": { - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "response": { - "$ref": "Operation" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "parameters": { - "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" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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.", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "targetHttpProxy": { - "location": "path", - "type": "string", - "description": "Name of the TargetHttpProxy 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}" - } + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], + "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" + }, + "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" }, - "id": "compute.regionTargetHttpProxies.setUrlMap", - "request": { - "$ref": "UrlMapReference" + "type": "array" + }, + "licenses": { + "description": "A list of publicly visible licenses. Reserved for Google's use.", + "items": { + "type": "string" }, - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "httpMethod": "POST", - "description": "Changes the URL map for TargetHttpProxy.", - "parameterOrder": [ - "project", - "region", - "targetHttpProxy" - ] + "type": "array" }, - "list": { - "path": "projects/{project}/regions/{region}/targetHttpProxies", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "parameters": { - "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." - }, - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer" - }, - "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" - }, - "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" - }, - "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" - } - }, - "parameterOrder": [ - "project", - "region" + "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" ], - "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", - "response": { - "$ref": "TargetHttpProxyList" + "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" + }, + "licenseCodes": { + "items": { + "type": "string", + "format": "int64" }, - "id": "compute.regionTargetHttpProxies.list", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", - "httpMethod": "GET" + "type": "array", + "description": "Integer license codes indicating which licenses are attached to this disk." }, - "delete": { - "description": "Deletes the specified TargetHttpProxy resource.", - "parameterOrder": [ - "project", - "region", - "targetHttpProxy" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "DELETE", - "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", - "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", - "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" - }, - "region": { - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "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)." - }, - "targetHttpProxy": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the TargetHttpProxy resource to delete.", - "location": "path", - "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." + }, + "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": "Operation" + "type": "array" + } + }, + "type": "object" + }, + "InstancesStartWithEncryptionKeyRequest": { + "properties": { + "disks": { + "type": "array", + "items": { + "$ref": "CustomerEncryptionKeyProtectedDisk" }, - "id": "compute.regionTargetHttpProxies.delete" + "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" }, - "regionOperations": { - "methods": { - "wait": { - "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.regionOperations.wait", - "flatPath": "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`. ", - "path": "projects/{project}/regions/{region}/operations/{operation}/wait", - "parameterOrder": [ - "project", - "region", - "operation" - ], - "parameters": { - "operation": { - "description": "Name of the Operations 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}" + "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" + }, + "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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, + "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." + "description": "[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." + ] }, - "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])?" + "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" } - }, - "response": { - "$ref": "Operation" } }, - "delete": { - "id": "compute.regionOperations.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "status": { + "enumDescriptions": [ + "Resources are being allocated.", + "The node template is currently being deleted.", + "Invalid status.", + "The node template is ready." ], - "flatPath": "projects/{project}/regions/{region}/operations/{operation}", - "path": "projects/{project}/regions/{region}/operations/{operation}", - "description": "Deletes the specified region-specific Operations resource.", - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "operation" + "type": "string", + "enum": [ + "CREATING", + "DELETING", + "INVALID", + "READY" ], - "parameters": { - "region": { - "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." - }, - "operation": { - "type": "string", - "required": true, - "description": "Name of the Operations resource to delete.", - "location": "path", - "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])?))", - "required": true, - "type": "string", - "description": "Project ID for this request." - } - } + "description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING." }, - "list": { - "flatPath": "projects/{project}/regions/{region}/operations", - "response": { - "$ref": "OperationList" - }, - "path": "projects/{project}/regions/{region}/operations", - "httpMethod": "GET", - "description": "Retrieves a list of Operation resources contained within the specified region.", - "id": "compute.regionOperations.list", - "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`)", - "location": "query", - "format": "uint32", - "default": "500", - "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": { - "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])?))" - }, - "region": { - "description": "Name of the region for this request.", - "type": "string", - "required": true, - "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": { - "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", - "region" + "cpuOvercommitType": { + "enum": [ + "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", + "ENABLED", + "NONE" ], - "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": [ + "", + "", + "" ] }, - "get": { - "path": "projects/{project}/regions/{region}/operations/{operation}", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "region", - "operation" - ], - "description": "Retrieves the specified region-specific Operations resource.", - "response": { - "$ref": "Operation" + "nodeAffinityLabels": { + "additionalProperties": { + "type": "string" }, - "parameters": { - "operation": { - "required": true, - "description": "Name of the Operations resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string" - }, - "region": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "location": "path", - "description": "Name of the region for this request." - }, - "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." - } + "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" }, - "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}", - "id": "compute.regionOperations.get" + "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" }, - "images": { - "methods": { - "insert": { - "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])?))", - "type": "string", - "required": true, - "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)." - }, - "forceCreate": { - "type": "boolean", - "description": "Force image creation if true.", - "location": "query" - } - }, - "id": "compute.images.insert", - "path": "projects/{project}/global/images", - "request": { - "$ref": "Image" + "ManagedInstance": { + "type": "object", + "id": "ManagedInstance", + "properties": { + "preservedStateFromConfig": { + "$ref": "PreservedState", + "description": "[Output Only] Preserved state applied from per-instance config for this instance." + }, + "instanceHealth": { + "description": "[Output Only] Health state of the instance per health-check.", + "items": { + "$ref": "ManagedInstanceInstanceHealth" }, - "description": "Creates an image in the specified project using the data included in the request.", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/images", - "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" + "type": "array" + }, + "currentAction": { + "enum": [ + "ABANDONING", + "CREATING", + "CREATING_WITHOUT_RETRIES", + "DELETING", + "NONE", + "RECREATING", + "REFRESHING", + "RESTARTING", + "RESUMING", + "STARTING", + "STOPPING", + "SUSPENDING", + "VERIFYING" ], - "response": { - "$ref": "Operation" - } + "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)." + ], + "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. " }, - "deprecate": { - "id": "compute.images.deprecate", - "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.", + "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." + }, + "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)." + ], + "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.", "type": "string" }, - "image": { - "required": true, + "code": { "type": "string", - "description": "Image name.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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" + ] }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": { + "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": "Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.", - "request": { - "$ref": "DeprecationStatus" - }, - "response": { - "$ref": "Operation" + "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.", + "type": "object" + }, + "instanceGroups": { + "description": "[Output Only] The list of instance groups that are contained in this scope.", + "items": { + "$ref": "InstanceGroup" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/images/{image}/deprecate", - "path": "projects/{project}/global/images/{image}/deprecate", - "parameterOrder": [ - "project", - "image" + "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." + }, + "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" ], - "httpMethod": "POST" + "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." + ] }, - "list": { - "flatPath": "projects/{project}/global/images", - "response": { - "$ref": "ImageList" + "message": { + "type": "string", + "description": "The status message." + } + }, + "id": "AutoscalerStatusDetails" + }, + "NetworkEndpointGroupsAttachEndpointsRequest": { + "id": "NetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "type": "array", + "items": { + "$ref": "NetworkEndpoint" }, - "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": { - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { - "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", - "default": "500", - "minimum": "0", - "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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" - } + "description": "The list of network endpoints to be attached." + } + }, + "type": "object" + }, + "TargetHttpsProxyList": { + "properties": { + "items": { + "description": "A list of TargetHttpsProxy resources.", + "items": { + "$ref": "TargetHttpsProxy" }, - "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.", - "path": "projects/{project}/global/images", - "id": "compute.images.list", - "parameterOrder": [ - "project" - ] + "type": "array" }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "parameters": { - "resource": { - "location": "path", - "required": true, + "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" + }, + "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." + ], "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." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { + "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\" } " + }, + "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." } }, - "request": { - "$ref": "TestPermissionsRequest" - }, - "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." + } + }, + "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" ], - "id": "compute.images.testIamPermissions", - "httpMethod": "POST", - "path": "projects/{project}/global/images/{resource}/testIamPermissions", - "parameterOrder": [ - "project", - "resource" + "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." ], - "flatPath": "projects/{project}/global/images/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" - } + "type": "string" }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "parameterOrder": [ - "project", - "resource" - ], - "flatPath": "projects/{project}/global/images/{resource}/getIamPolicy", - "id": "compute.images.getIamPolicy", - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "type": "integer", - "location": "query", - "format": "int32" - }, - "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": { - "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" + "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" + } } }, - "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": "[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" ], - "httpMethod": "GET", - "response": { - "$ref": "Policy" - } + "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": [ + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "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" }, - "setIamPolicy": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": [ + "", + "", + "", + "" ], - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "project", - "resource" + "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" ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "request": { - "$ref": "GlobalSetPolicyRequest" + "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" + }, + "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" }, - "id": "compute.images.setIamPolicy", - "path": "projects/{project}/global/images/{resource}/setIamPolicy", - "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 - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" - } + "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." }, - "httpMethod": "POST", - "flatPath": "projects/{project}/global/images/{resource}/setIamPolicy" + "type": "object", + "description": "A list of ForwardingRulesScopedList resources." }, - "patch": { - "description": "Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.", - "httpMethod": "PATCH", - "path": "projects/{project}/global/images/{image}", - "parameters": { - "requestId": { + "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." + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "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." }, - "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." + "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" + } + } + } }, - "image": { - "description": "Name of the image resource to patch.", - "type": "string", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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" } }, - "flatPath": "projects/{project}/global/images/{image}", - "request": { - "$ref": "Image" - }, - "id": "compute.images.patch", - "parameterOrder": [ - "project", - "image" - ], - "response": { - "$ref": "Operation" + "type": "object" + } + }, + "id": "ForwardingRuleAggregatedList", + "type": "object" + }, + "GlobalSetPolicyRequest": { + "type": "object", + "id": "GlobalSetPolicyRequest", + "properties": { + "bindings": { + "type": "array", + "items": { + "$ref": "Binding" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings." }, - "delete": { - "path": "projects/{project}/global/images/{image}", - "parameterOrder": [ - "project", - "image" - ], - "description": "Deletes the specified image.", - "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" - }, - "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." - }, - "image": { - "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 image resource to delete." - } - }, - "id": "compute.images.delete", - "flatPath": "projects/{project}/global/images/{image}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - } + "etag": { + "type": "string", + "format": "byte", + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag." }, - "getFromFamily": { - "description": "Returns the latest image that is part of an image family and is not deprecated.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "Image" - }, - "path": "projects/{project}/global/images/family/{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}", - "location": "path", - "required": true, - "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." - } - }, - "id": "compute.images.getFromFamily", - "parameterOrder": [ - "project", - "family" - ], - "flatPath": "projects/{project}/global/images/family/{family}" + "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" }, - "setLabels": { - "path": "projects/{project}/global/images/{resource}/setLabels", - "parameterOrder": [ - "project", - "resource" - ], - "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.", - "response": { - "$ref": "Operation" - }, - "id": "compute.images.setLabels", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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." - }, - "resource": { - "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}", - "required": true - } - }, - "request": { - "$ref": "GlobalSetLabelsRequest" - } + "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" }, - "get": { - "id": "compute.images.get", - "parameterOrder": [ - "project", - "image" - ], - "path": "projects/{project}/global/images/{image}", - "parameters": { - "image": { - "location": "path", - "description": "Name of the image resource to return.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "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])?))" - } - }, - "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 image. Gets a list of available images by making a list() request.", - "flatPath": "projects/{project}/global/images/{image}", - "httpMethod": "GET", - "response": { - "$ref": "Image" + "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." + }, + "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" + }, + "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" + ] } + }, + "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." } } }, - "healthChecks": { - "methods": { - "aggregatedList": { - "id": "compute.healthChecks.aggregatedList", - "path": "projects/{project}/aggregated/healthChecks", - "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" - ], - "flatPath": "projects/{project}/aggregated/healthChecks", - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "HealthChecksAggregatedList" - }, - "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`)", - "default": "500", - "minimum": "0", - "format": "uint32", - "type": "integer", - "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": "Name of the project scoping 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." - }, - "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.", - "type": "boolean", - "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." - } + "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" + }, + "items": { + "type": "array", + "description": "A list of VpnGateway resources.", + "items": { + "$ref": "VpnGateway" } }, - "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" - }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "GET", - "id": "compute.healthChecks.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])?))" - }, - "healthCheck": { - "location": "path", - "required": true, - "description": "Name of the HealthCheck resource to return.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string" - } - }, - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "parameterOrder": [ - "project", - "healthCheck" - ], - "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() 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." }, - "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.", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "id": "compute.healthChecks.patch", - "request": { - "$ref": "HealthCheck" - }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "PATCH", - "parameterOrder": [ - "project", - "healthCheck" - ], - "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).", + "kind": { + "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.", + "default": "compute#vpnGatewayList", + "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.", "type": "string", - "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" + ] }, - "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])?))" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "healthCheck": { - "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 HealthCheck resource to patch." + "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\" } " } } + } + }, + "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." }, - "delete": { - "description": "Deletes the specified HealthCheck resource.", - "parameterOrder": [ - "project", - "healthCheck" - ], - "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" - }, - "healthCheck": { - "required": true, - "description": "Name of the HealthCheck resource to delete.", - "location": "path", - "type": "string", - "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)." - } - }, - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "DELETE", - "id": "compute.healthChecks.delete", - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "kind": { + "description": "Type of resource.", + "default": "compute#imageList", + "type": "string" }, - "list": { - "path": "projects/{project}/global/healthChecks", - "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 HealthCheck resources available to the specified project.", - "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" - }, - "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`.", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "properties": { + "code": { "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", - "type": "integer", - "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`)" + "description": "[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" }, - "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": { + "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\" } " } }, - "response": { - "$ref": "HealthCheckList" - }, - "id": "compute.healthChecks.list", - "flatPath": "projects/{project}/global/healthChecks", - "parameterOrder": [ - "project" - ] + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "update": { - "httpMethod": "PUT", - "description": "Updates a HealthCheck resource in the specified project using the data included in the request.", - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "request": { - "$ref": "HealthCheck" - }, - "response": { - "$ref": "Operation" + "items": { + "type": "array", + "items": { + "$ref": "Image" }, - "parameterOrder": [ - "project", - "healthCheck" - ], - "parameters": { - "healthCheck": { - "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 HealthCheck resource to update.", - "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 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\" } " }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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.healthChecks.update" - }, - "insert": { - "path": "projects/{project}/global/healthChecks", - "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).", + "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": "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" + ] }, - "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])?))", + "message": { "type": "string", - "location": "path", - "description": "Project ID for this request." + "description": "[Output Only] A human-readable description of the warning code." } }, - "request": { - "$ref": "HealthCheck" - }, - "parameterOrder": [ - "project" - ], - "flatPath": "projects/{project}/global/healthChecks", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.healthChecks.insert", - "description": "Creates a HealthCheck resource in the specified project using the data included in the request.", - "response": { - "$ref": "Operation" + "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" + }, + "type": "array" } } }, - "regionSecurityPolicies": { - "methods": { - "get": { - "response": { - "$ref": "SecurityPolicy" - }, - "parameterOrder": [ - "project", - "region", - "securityPolicy" - ], - "id": "compute.regionSecurityPolicies.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}/securityPolicies/{securityPolicy}", - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "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" - }, - "securityPolicy": { - "type": "string", - "location": "path", - "description": "Name of the security policy to get.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true - }, - "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])?" - } + "ServiceAttachmentAggregatedList": { + "properties": { + "unreachables": { + "items": { + "type": "string" }, - "description": "List all of the ordered rules present in a single specified policy." + "description": "[Output Only] Unreachable resources.", + "type": "array" }, - "patch": { - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "description": "Patches the specified policy with the data included in the request.", - "id": "compute.regionSecurityPolicies.patch", - "parameters": { - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "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).", + "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." + ], "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." + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "securityPolicy": { - "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 security policy to update." + "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" + } } }, - "request": { - "$ref": "SecurityPolicy" - }, - "parameterOrder": [ - "project", - "region", - "securityPolicy" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "PATCH", - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}" + "type": "object" }, - "delete": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "region": { - "required": true, - "location": "path", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "securityPolicy": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "items": { + "description": "A list of ServiceAttachmentsScopedList resources.", + "additionalProperties": { + "$ref": "ServiceAttachmentsScopedList", + "description": "Name of the scope containing this set of ServiceAttachments." + }, + "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": { "type": "string", - "location": "path", - "required": true, - "description": "Name of the security policy to delete." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." + ] }, - "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 + "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" + } }, - "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." } }, - "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", - "httpMethod": "DELETE", - "id": "compute.regionSecurityPolicies.delete", - "parameterOrder": [ - "project", - "region", - "securityPolicy" - ], - "description": "Deletes the specified policy.", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}" + "type": "object" }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.regionSecurityPolicies.insert", - "parameterOrder": [ - "project", - "region" - ], - "request": { - "$ref": "SecurityPolicy" - }, - "response": { - "$ref": "Operation" + "items": { + "description": "A list of NetworkEndpointWithHealthStatus resources.", + "items": { + "$ref": "NetworkEndpointWithHealthStatus" }, - "path": "projects/{project}/regions/{region}/securityPolicies", - "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 + "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\" } " }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "location": "path", + "message": { "type": "string", - "description": "Name of the region scoping 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).", + "code": { "type": "string", - "location": "query" - }, - "validateOnly": { - "type": "boolean", - "description": "If true, the request will not be committed.", - "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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." + ] } + } + }, + "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" }, - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", - "description": "Creates a new policy in the specified project using the data included in the request." + "type": "array" }, - "list": { - "id": "compute.regionSecurityPolicies.list", - "path": "projects/{project}/regions/{region}/securityPolicies", - "httpMethod": "GET", - "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", - "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." - }, - "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" + "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\" } " }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "message": { "type": "string", - "location": "path", - "required": true, - "description": "Name of the region scoping this request." + "description": "[Output Only] A human-readable description of the warning code." }, - "project": { - "location": "path", - "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])?))" - }, - "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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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" - ], - "description": "List all the policies that have been configured for the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/securityPolicies", - "response": { - "$ref": "SecurityPolicyList" - }, - "parameterOrder": [ - "project", - "region" - ] + "type": "object" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" } - } + }, + "id": "UsableSubnetworksAggregatedList" }, - "disks": { - "methods": { - "list": { - "id": "compute.disks.list", - "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}/disks", - "flatPath": "projects/{project}/zones/{zone}/disks", - "httpMethod": "GET", - "response": { - "$ref": "DiskList" + "InterconnectAttachmentsScopedList": { + "properties": { + "interconnectAttachments": { + "description": "A list of interconnect attachments contained in this scope.", + "items": { + "$ref": "InterconnectAttachment" }, - "description": "Retrieves a list of persistent disks contained within the specified zone.", - "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`." - }, - "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 - }, - "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": { + "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" }, - "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." + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "orderBy": { + "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." + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "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", - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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.", - "location": "query", - "type": "boolean" + "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\" } " }, - "maxResults": { - "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", - "location": "query" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } } }, - "get": { - "description": "Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.", - "parameters": { - "zone": { - "description": "The name of the zone for this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "location": "path" - }, - "disk": { - "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 persistent disk to return.", - "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 - } - }, - "httpMethod": "GET", - "response": { - "$ref": "Disk" - }, - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", - "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" + "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" ], - "parameterOrder": [ - "project", - "zone", - "disk" + "enumDescriptions": [ + "", + "", + "", + "", + "" ], - "id": "compute.disks.get" + "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR." }, - "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)." - }, - "disk": { - "location": "path", - "type": "string", - "required": true, - "description": "Name of the persistent disk to delete." - }, - "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." - }, - "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." - } - }, - "id": "compute.disks.delete", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/zones/{zone}/disks/{disk}", - "httpMethod": "DELETE", - "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.", - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", - "parameterOrder": [ - "project", - "zone", - "disk" - ] + "acceleratorType": { + "type": "string", + "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR." }, - "insert": { - "httpMethod": "POST", - "request": { - "$ref": "Disk" + "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." + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.disks.insert", - "response": { - "$ref": "Operation" + "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" }, - "path": "projects/{project}/zones/{zone}/disks", - "parameterOrder": [ - "project", - "zone" - ], - "flatPath": "projects/{project}/zones/{zone}/disks", - "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.", - "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" - }, - "sourceImage": { - "location": "query", - "type": "string", - "description": "Source image to restore onto a disk. This field is optional." - }, - "zone": { - "required": true, - "type": "string", - "description": "The name of the zone for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" - } + "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." }, - "setIamPolicy": { - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "response": { - "$ref": "Policy" - }, - "request": { - "$ref": "ZoneSetPolicyRequest" - }, - "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy", - "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." - }, - "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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - } - }, - "path": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy", - "id": "compute.disks.setIamPolicy", - "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" - ], - "httpMethod": "POST" + "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." }, - "addResourcePolicies": { - "response": { - "$ref": "Operation" + "tunnels": { + "description": "List of VPN tunnels that are in this VPN connection.", + "items": { + "$ref": "VpnGatewayStatusTunnel" }, - "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.", - "parameters": { - "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" - }, - "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])?))" - }, - "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" - }, - "disk": { - "type": "string", - "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": "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" }, - "parameterOrder": [ - "project", - "zone", - "disk" + "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" ], - "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", - "request": { - "$ref": "DisksAddResourcePoliciesRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "GVNIC", + "No type specified.", + "VIRTIO" ] }, - "testIamPermissions": { - "request": { - "$ref": "TestPermissionsRequest" - }, - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "id": "compute.disks.testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" - }, - "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", - "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" - }, - "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" - }, - "resource": { - "required": true, - "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}" - } + "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" }, - "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" - ], - "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions" + "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" }, - "createSnapshot": { - "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", - "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])?))" - }, - "guestFlush": { - "type": "boolean", - "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", - "location": "query" - }, - "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." - }, - "disk": { - "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 persistent disk to snapshot." - } + "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" + }, + "ipv6AccessConfigs": { + "items": { + "$ref": "AccessConfig" }, - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", - "parameterOrder": [ - "project", - "zone", - "disk" + "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" ], - "id": "compute.disks.createSnapshot", - "httpMethod": "POST", - "path": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", - "request": { - "$ref": "Snapshot" - }, - "response": { - "$ref": "Operation" - }, - "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.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "This network interface can have external IPv6.", + "This network interface can have internal IPv6." + ] + }, + "stackType": { + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "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." ] }, - "aggregatedList": { - "httpMethod": "GET", - "response": { - "$ref": "DiskAggregatedList" + "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." + }, + "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" }, - "flatPath": "projects/{project}/aggregated/disks", - "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." - }, - "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": { - "description": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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 - }, - "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" - }, - "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." - }, - "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", - "type": "integer", - "location": "query", - "minimum": "0", - "format": "uint32" - } + "type": "array" + }, + "firewallPolicys": { + "items": { + "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, - "id": "compute.disks.aggregatedList", - "description": "Retrieves an aggregated list of persistent disks.", - "parameterOrder": [ - "project" + "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." ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "enum": [ + "SRC_IPS_V1" ], - "path": "projects/{project}/aggregated/disks" + "type": "string" }, - "getIamPolicy": { - "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", - "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" - }, - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "format": "int32", - "location": "query", - "type": "integer" + "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" }, - "zone": { - "description": "The name of the zone for this request.", + "message": { "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true + "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}", + "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": "Name or id of the resource 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." + ] } + } + }, + "items": { + "type": "array", + "items": { + "$ref": "TargetInstance" }, - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", - "response": { - "$ref": "Policy" - }, - "id": "compute.disks.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" - ], - "httpMethod": "GET" + "description": "A list of TargetInstance resources." }, - "setLabels": { - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "path": "projects/{project}/zones/{zone}/disks/{resource}/setLabels", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "description": "Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.", - "id": "compute.disks.setLabels", - "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setLabels", - "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])?))", - "type": "string", - "required": true + "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.", + "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\" } ", + "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" }, - "zone": { - "description": "The name of the zone for this request.", - "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." + ], + "description": "[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": { - "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" } }, - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "ZoneSetLabelsRequest" + "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" } }, - "removeResourcePolicies": { - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone", - "disk" - ], - "id": "compute.disks.removeResourcePolicies", - "path": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", - "description": "Removes resource policies from a disk.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "zone": { - "type": "string", - "location": "path", - "description": "The name of the zone for this request.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "disk": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "The disk name for this request.", - "type": "string", - "required": true + "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)." + } + } + } }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { "type": "string", - "required": true, - "description": "Project ID for this request." + "description": "[Output Only] A human-readable description of the warning code." }, - "requestId": { - "location": "query", + "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)." + "description": "[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" + ] } }, - "httpMethod": "POST", - "request": { - "$ref": "DisksRemoveResourcePoliciesRequest" - } + "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", + "type": "object" }, - "resize": { - "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." - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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}", - "location": "path", - "type": "string", - "description": "The name of the persistent disk.", - "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.", - "required": true, - "location": "path" - } - }, - "description": "Resizes the specified persistent disk. You can only increase the size of the disk.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "zone", - "disk" - ], - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/resize", - "path": "projects/{project}/zones/{zone}/disks/{disk}/resize", - "request": { - "$ref": "DisksResizeRequest" - }, - "httpMethod": "POST", - "id": "compute.disks.resize", - "response": { - "$ref": "Operation" + "targetVpnGateways": { + "description": "[Output Only] A list of target VPN gateways contained in this scope.", + "type": "array", + "items": { + "$ref": "TargetVpnGateway" } } } }, - "regionCommitments": { - "methods": { - "aggregatedList": { - "parameterOrder": [ - "project" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "flatPath": "projects/{project}/aggregated/commitments", - "httpMethod": "GET", - "response": { - "$ref": "CommitmentAggregatedList" - }, - "description": "Retrieves an aggregated list of commitments by 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`)", - "location": "query", - "minimum": "0", - "format": "uint32", - "type": "integer", - "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.", - "location": "query", - "type": "string" - }, - "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": { - "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", - "description": "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])?))", - "required": true, - "location": "path" - } - }, - "path": "projects/{project}/aggregated/commitments", - "id": "compute.regionCommitments.aggregatedList" + "description": "[Output Only] The current detailed instance health state.", + "enum": [ + "DRAINING", + "HEALTHY", + "TIMEOUT", + "UNHEALTHY", + "UNKNOWN" + ] }, - "get": { - "path": "projects/{project}/regions/{region}/commitments/{commitment}", - "parameterOrder": [ - "project", - "region", - "commitment" - ], - "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", - "response": { - "$ref": "Commitment" - }, - "description": "Returns the specified commitment resource. Gets a list of available commitments by making a list() request.", - "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 - }, - "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" - }, - "commitment": { - "location": "path", - "description": "Name of the commitment to return.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true - } - }, - "id": "compute.regionCommitments.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "httpMethod": "GET" + "type": "string", + "enum": [ + "GLOBAL", + "LOCAL_REGION", + "LP_GLOBAL", + "LP_LOCAL_REGION" + ] }, - "update": { - "parameterOrder": [ - "project", - "region", - "commitment" - ], - "response": { - "$ref": "Operation" - }, - "id": "compute.regionCommitments.update", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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.", - "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", - "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" - }, - "commitment": { - "location": "path", - "description": "Name of the commitment for which auto renew is being updated.", - "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).", - "type": "string", - "location": "query" - }, - "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" - }, - "updateMask": { - "type": "string", - "location": "query", - "format": "google-fieldmask", - "description": "update_mask indicates fields to be updated as part of this request." - }, - "paths": { - "location": "query", - "type": "string", - "repeated": true - } - }, - "request": { - "$ref": "Commitment" - }, - "path": "projects/{project}/regions/{region}/commitments/{commitment}" + "region": { + "description": "URL for the region of this location.", + "type": "string" }, - "list": { - "flatPath": "projects/{project}/regions/{region}/commitments", - "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.regionCommitments.list", - "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string", - "description": "Name of the region 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." - }, - "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", - "minimum": "0", - "format": "uint32", - "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" - }, - "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" - }, - "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", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", - "type": "boolean" - } + "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" + ] }, - "httpMethod": "GET", - "response": { - "$ref": "CommitmentList" + "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" }, - "description": "Retrieves a list of commitments contained within the specified region.", - "path": "projects/{project}/regions/{region}/commitments" + "description": "A list of TargetHttpProxy resources." }, - "insert": { - "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": { - "location": "query", + "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." + }, + "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." + ], "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 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", - "location": "path", - "required": true, - "description": "Name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + "description": "[Output Only] A human-readable description of the warning code." + }, + "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" + } } }, - "path": "projects/{project}/regions/{region}/commitments", - "description": "Creates a commitment in the specified project using the data included in the request.", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.regionCommitments.insert", - "request": { - "$ref": "Commitment" - }, - "parameterOrder": [ - "project", - "region" - ], - "flatPath": "projects/{project}/regions/{region}/commitments", - "response": { - "$ref": "Operation" - } + "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." + }, + "disableConnectionDrainOnFailover": { + "type": "boolean", + "description": "This can be set to true only if the protocol is TCP. The default is false." } } }, - "instanceTemplates": { - "methods": { - "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.", - "flatPath": "projects/{project}/global/instanceTemplates", - "path": "projects/{project}/global/instanceTemplates", - "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", + "NodeTypesScopedList": { + "type": "object", + "id": "NodeTypesScopedList", + "properties": { + "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.", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "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" + }, + "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" - ], - "id": "compute.instanceTemplates.insert", - "parameterOrder": [ - "project" - ], - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "InstanceTemplate" + "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" } + } + } + }, + "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" }, - "get": { - "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", - "httpMethod": "GET", - "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.", - "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" - } - }, - "description": "Returns the specified instance template. Gets a list of available instance templates by making a list() request.", - "response": { - "$ref": "InstanceTemplate" - }, - "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}", - "parameterOrder": [ - "project", - "instanceTemplate" - ], - "id": "compute.instanceTemplates.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "sharedSecretHash": { + "type": "string", + "description": "Hash of the shared secret." }, - "getIamPolicy": { - "path": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy", - "flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy", - "id": "compute.instanceTemplates.getIamPolicy", - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "response": { - "$ref": "Policy" + "remoteTrafficSelector": { + "items": { + "type": "string" }, - "parameters": { - "optionsRequestedPolicyVersion": { - "format": "int32", - "description": "Requested IAM Policy version.", - "type": "integer", - "location": "query" - }, - "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 - }, - "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])?))" - } + "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" + "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" + }, + "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." ], - "httpMethod": "GET", - "parameterOrder": [ - "project", - "resource" + "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" ] }, - "list": { - "flatPath": "projects/{project}/global/instanceTemplates", - "response": { - "$ref": "InstanceTemplateList" - }, - "id": "compute.instanceTemplates.list", - "description": "Retrieves a list of instance templates that are contained within 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", - "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" - }, - "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", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer", - "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." - }, - "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}/global/instanceTemplates" + "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" }, - "testIamPermissions": { - "response": { - "$ref": "TestPermissionsResponse" - }, - "parameterOrder": [ - "project", - "resource" - ], - "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}", - "location": "path", - "type": "string", - "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])?))", - "type": "string", - "required": true, - "description": "Project ID for this request.", - "location": "path" - } - }, - "path": "projects/{project}/global/instanceTemplates/{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" - ], - "id": "compute.instanceTemplates.testIamPermissions", - "httpMethod": "POST", - "flatPath": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions" + "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`." }, - "delete": { - "parameterOrder": [ - "project", - "instanceTemplate" - ], - "id": "compute.instanceTemplates.delete", - "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", - "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" - }, - "instanceTemplate": { - "type": "string", - "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 instance template to delete." - }, - "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])?))" - } - }, - "httpMethod": "DELETE", - "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.", - "response": { - "$ref": "Operation" + "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" } }, - "setIamPolicy": { - "path": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.instanceTemplates.setIamPolicy", - "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" - }, - "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}" - } + "sourceDiskEncryptionKeys": { + "items": { + "$ref": "SourceDiskEncryptionKey" }, - "response": { - "$ref": "Policy" + "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" + }, + "name": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string", + "annotations": { + "required": [ + "compute.machineImages.insert" + ] }, - "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.", - "parameterOrder": [ - "project", - "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." + }, + "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": [ + "", + "", + "", + "", + "" ], - "flatPath": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy", - "request": { - "$ref": "GlobalSetPolicyRequest" - } + "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" + }, + "kind": { + "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", + "default": "compute#machineImage", + "type": "string" + }, + "storageLocations": { + "items": { + "type": "string" + }, + "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." } } }, - "globalPublicDelegatedPrefixes": { - "methods": { - "get": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" ], - "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "description": "Returns the specified global PublicDelegatedPrefix resource.", - "parameters": { - "publicDelegatedPrefix": { - "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 return.", - "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])?))", - "type": "string", - "description": "Project ID for this request.", - "required": true - } - }, - "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "id": "compute.globalPublicDelegatedPrefixes.get", - "response": { - "$ref": "PublicDelegatedPrefix" + "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." + ] + }, + "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" }, - "parameterOrder": [ - "project", - "publicDelegatedPrefix" - ], - "httpMethod": "GET" + "description": "A list of NodeGroup resources.", + "type": "array" }, - "list": { - "id": "compute.globalPublicDelegatedPrefixes.list", - "parameters": { - "pageToken": { - "location": "query", + "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": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." + }, + "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." + ], "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." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" }, - "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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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`)", - "default": "500", - "format": "uint32", - "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": { + "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": "Lists the global PublicDelegatedPrefixes for a project.", - "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", - "flatPath": "projects/{project}/global/publicDelegatedPrefixes", - "path": "projects/{project}/global/publicDelegatedPrefixes", - "response": { - "$ref": "PublicDelegatedPrefixList" - } + "type": "object" }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/publicDelegatedPrefixes", - "httpMethod": "POST", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/global/publicDelegatedPrefixes", - "id": "compute.globalPublicDelegatedPrefixes.insert", - "description": "Creates a global PublicDelegatedPrefix 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])?))", - "location": "path", - "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)." - } - }, - "request": { - "$ref": "PublicDelegatedPrefix" - }, - "response": { - "$ref": "Operation" - } + "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." }, - "delete": { - "httpMethod": "DELETE", - "description": "Deletes the specified global PublicDelegatedPrefix.", - "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "endpoint": { + "type": "string", + "description": "The url of a connected endpoint." + }, + "status": { + "enum": [ + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" ], - "id": "compute.globalPublicDelegatedPrefixes.delete", - "parameterOrder": [ - "project", - "publicDelegatedPrefix" + "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.", + "" + ] + } + }, + "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" ], - "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "parameters": { - "publicDelegatedPrefix": { - "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 PublicDelegatedPrefix resource 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" - }, - "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": "string", + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "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." }, - "patch": { - "response": { - "$ref": "Operation" + "tags": { + "items": { + "type": "string" }, - "id": "compute.globalPublicDelegatedPrefixes.patch", - "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])?))", - "description": "Project ID for this request.", - "location": "path", - "type": "string", - "required": true - }, - "publicDelegatedPrefix": { - "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 PublicDelegatedPrefix resource to patch." - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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": "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" }, - "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", - "parameterOrder": [ - "project", - "publicDelegatedPrefix" - ], - "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.", - "httpMethod": "PATCH", - "request": { - "$ref": "PublicDelegatedPrefix" - } + "type": "array" } } }, - "securityPolicies": { - "methods": { - "addRule": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "SecurityPolicyRule" - }, - "parameterOrder": [ - "project", - "securityPolicy" - ], - "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", - "response": { - "$ref": "Operation" - }, - "description": "Inserts a rule into a security policy.", - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", - "httpMethod": "POST", - "id": "compute.securityPolicies.addRule", - "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" - }, - "validateOnly": { - "location": "query", - "type": "boolean", - "description": "If true, the request will not be committed." - }, - "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" - } + "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" } + } + } + }, + "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" }, - "aggregatedList": { - "response": { - "$ref": "SecurityPoliciesAggregatedList" - }, - "flatPath": "projects/{project}/aggregated/securityPolicies", - "id": "compute.securityPolicies.aggregatedList", - "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/securityPolicies", - "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": { - "type": "string", - "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])?))", - "required": true - }, - "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", - "minimum": "0", - "default": "500", - "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." - }, - "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`." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "httpMethod": "GET" + "enableSecureBoot": { + "type": "boolean", + "description": "Defines whether the instance has Secure Boot enabled. Disabled by default." }, - "list": { - "path": "projects/{project}/global/securityPolicies", - "response": { - "$ref": "SecurityPolicyList" + "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" }, - "id": "compute.securityPolicies.list", - "description": "List 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": { - "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", - "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`)" - }, - "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.", + "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": { "type": "string", - "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.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { - "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." }, - "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." + "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\" } " } }, - "flatPath": "projects/{project}/global/securityPolicies", - "httpMethod": "GET" - }, - "get": { - "parameterOrder": [ - "project", - "securityPolicy" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "SecurityPolicy" - }, - "id": "compute.securityPolicies.get", - "httpMethod": "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, - "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" + ] }, - "securityPolicy": { - "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 security policy to get.", + "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\" } " + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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 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" }, - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", - "path": "projects/{project}/global/securityPolicies/{securityPolicy}", - "description": "List all of the ordered rules present in a single specified policy." + "type": "array", + "description": "[Output Only] Unreachable resources." }, - "listPreconfiguredExpressionSets": { - "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", - "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" - }, - "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])?))" - }, - "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": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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`." - }, - "maxResults": { - "default": "500", - "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`)" - } + "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" }, - "flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", - "parameterOrder": [ - "project" - ], - "id": "compute.securityPolicies.listPreconfiguredExpressionSets", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", - "httpMethod": "GET", - "response": { - "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" - } + "type": "array", + "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value." }, - "delete": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "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": { + "$ref": "Firewall" }, - "description": "Deletes the specified policy.", - "id": "compute.securityPolicies.delete", - "path": "projects/{project}/global/securityPolicies/{securityPolicy}", - "parameters": { - "securityPolicy": { - "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 security policy to delete." - }, - "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 - }, - "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": "Effective firewalls on the instance." + }, + "firewallPolicys": { + "description": "Effective firewalls from firewall policies.", + "type": "array", + "items": { + "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + } + } + }, + "id": "InstancesGetEffectiveFirewallsResponse", + "type": "object" + }, + "AddressesScopedList": { + "id": "AddressesScopedList", + "properties": { + "addresses": { + "items": { + "$ref": "Address" }, - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "securityPolicy" - ], - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}" + "description": "[Output Only] A list of addresses contained in this scope.", + "type": "array" }, - "getRule": { - "parameters": { - "securityPolicy": { - "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 security policy to which the queried rule belongs." + "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" }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" }, - "priority": { - "description": "The priority of the rule to get from the security policy.", - "location": "query", - "type": "integer", - "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" } - }, - "id": "compute.securityPolicies.getRule", - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", - "description": "Gets a rule at the specified priority.", - "parameterOrder": [ - "project", - "securityPolicy" - ], - "response": { - "$ref": "SecurityPolicyRule" - }, - "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + } + } + }, + "type": "object" + }, + "HealthCheckServicesList": { + "id": "HealthCheckServicesList", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." }, - "insert": { - "parameterOrder": [ - "project" - ], - "request": { - "$ref": "SecurityPolicy" - }, - "flatPath": "projects/{project}/global/securityPolicies", - "description": "Creates a new policy in the specified project using the data included in the request.", - "parameters": { - "validateOnly": { - "description": "If true, the request will not be committed.", - "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])?))", + "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#healthCheckServicesList for lists of HealthCheckServices.", + "type": "string", + "default": "compute#healthCheckServicesList" + }, + "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", - "description": "Project ID for this request.", - "required": true, - "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" + ] }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", + "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\" } " + }, + "message": { "type": "string", - "location": "query" + "description": "[Output Only] A human-readable description of the warning code." } - }, - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.securityPolicies.insert", - "path": "projects/{project}/global/securityPolicies" + } }, - "patch": { - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", - "response": { - "$ref": "Operation" + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "items": { + "items": { + "$ref": "HealthCheckService" }, - "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. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", - "parameters": { - "project": { - "description": "Project ID for this request.", + "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": { "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": "[Output Only] A human-readable description of the warning code." }, - "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 update.", - "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": { + "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": { - "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", - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" + ], + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response." } }, - "request": { - "$ref": "SecurityPolicy" - }, - "id": "compute.securityPolicies.patch", - "parameterOrder": [ - "project", - "securityPolicy" - ], - "path": "projects/{project}/global/securityPolicies/{securityPolicy}" + "type": "object", + "description": "[Output Only] Informational warning message." }, - "patchRule": { - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", - "httpMethod": "POST", - "parameterOrder": [ - "project", - "securityPolicy" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "SecurityPolicyRule" - }, - "id": "compute.securityPolicies.patchRule", - "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])?))" - }, - "securityPolicy": { - "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 security policy to update." - }, - "validateOnly": { - "location": "query", - "type": "boolean", - "description": "If true, the request will not be committed." - }, - "priority": { - "format": "int32", - "location": "query", - "type": "integer", - "description": "The priority of the rule to patch." - } + "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." }, - "description": "Patches a rule at the specified priority.", - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule" + "type": "object" }, - "removeRule": { - "parameterOrder": [ - "project", - "securityPolicy" + "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" + } + }, + "proxyHeader": { + "type": "string", + "enumDescriptions": [ + "", + "" ], - "id": "compute.securityPolicies.removeRule", - "path": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "NONE", + "PROXY_V1" ], - "description": "Deletes a rule at the specified priority.", - "response": { - "$ref": "Operation" - }, - "httpMethod": "POST", - "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule", - "parameters": { - "securityPolicy": { - "type": "string", - "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" - }, - "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" - }, - "priority": { - "description": "The priority of the rule to remove from the security policy.", - "format": "int32", - "location": "query", - "type": "integer" - } - } + "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE." }, - "setLabels": { - "path": "projects/{project}/global/securityPolicies/{resource}/setLabels", - "id": "compute.securityPolicies.setLabels", - "flatPath": "projects/{project}/global/securityPolicies/{resource}/setLabels", - "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": { - "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 - } + "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" + }, + "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" }, - "httpMethod": "POST", - "request": { - "$ref": "GlobalSetLabelsRequest" + "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" }, - "description": "Sets the labels on a security policy. 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": "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" ], - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "resource" + "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." ] } - } + }, + "id": "Subsetting" }, - "globalOrganizationOperations": { - "methods": { - "list": { - "path": "locations/global/operations", - "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", - "httpMethod": "GET", - "id": "compute.globalOrganizationOperations.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", + "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" + }, + "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" + }, + "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" }, - "parentId": { - "type": "string", - "location": "query", - "description": "Parent 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.", + "code": { "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" - }, - "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": "[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." + ] }, - "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", - "format": "uint32", - "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" } }, - "description": "Retrieves a list of Operation resources contained within the specified organization.", - "response": { - "$ref": "OperationList" + "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)." }, - "get": { - "response": { - "$ref": "Operation" - }, - "path": "locations/global/operations/{operation}", - "httpMethod": "GET", - "parameterOrder": [ - "operation" + "instantiateFrom": { + "enum": [ + "ATTACH_READ_ONLY", + "BLANK", + "CUSTOM_IMAGE", + "DEFAULT", + "DO_NOT_INCLUDE", + "SOURCE_IMAGE", + "SOURCE_IMAGE_FAMILY" ], - "parameters": { - "operation": { - "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 Operations resource to return." - }, - "parentId": { - "description": "Parent ID for this request.", - "type": "string", - "location": "query" - } - }, - "id": "compute.globalOrganizationOperations.get", - "description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.", - "flatPath": "locations/global/operations/{operation}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "delete": { - "parameters": { - "parentId": { - "description": "Parent ID for this request.", - "location": "query", - "type": "string" - }, - "operation": { - "description": "Name of the Operations resource to delete.", - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true - } - }, - "parameterOrder": [ - "operation" + "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." ], - "httpMethod": "DELETE", - "description": "Deletes the specified Operations resource.", - "path": "locations/global/operations/{operation}", - "flatPath": "locations/global/operations/{operation}", - "id": "compute.globalOrganizationOperations.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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." + }, + "deviceName": { + "type": "string", + "description": "Specifies the device name of the disk to which the configurations apply to." } } }, - "regionSslPolicies": { - "methods": { - "list": { - "parameterOrder": [ - "project", - "region" + "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" ], - "httpMethod": "GET", - "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])?))" - }, - "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", - "location": "query", - "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`)" - }, - "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": { - "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" - }, - "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])?" - } + "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." + ], + "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" + }, + "targetSize": { + "type": "integer", + "annotations": { + "required": [ + "compute.instanceGroupManagers.insert", + "compute.regionInstanceGroupManagers.insert" + ] }, - "id": "compute.regionSslPolicies.list", - "path": "projects/{project}/regions/{region}/sslPolicies", - "response": { - "$ref": "SslPoliciesList" + "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" + ] }, - "description": "Lists all the SSL policies that have been configured for the specified project and region.", - "flatPath": "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": "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." }, - "patch": { - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" + "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" }, - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - }, - "sslPolicy": { - "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", - "required": true, - "location": "path", - "type": "string" - }, - "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])?" - } + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "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" + }, + "autoHealingPolicies": { + "description": "The autohealing policy for this managed instance group. You can specify only one value.", + "type": "array", + "items": { + "$ref": "InstanceGroupManagerAutoHealingPolicy" + } + }, + "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" + }, + "filter": { + "enum": [ + "ALL", + "ERRORS_ONLY", + "TRANSLATIONS_ONLY" ], - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "parameterOrder": [ - "project", - "region", - "sslPolicy" + "enumDescriptions": [ + "Export logs for all (successful and unsuccessful) connections.", + "Export logs for connection failures only.", + "Export logs for successful connections only." ], - "id": "compute.regionSslPolicies.patch", - "request": { - "$ref": "SslPolicy" - }, - "description": "Patches the specified SSL policy with the data included in the request.", - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}" + "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." }, - "listAvailableFeatures": { - "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." - }, - "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.", - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-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." - }, - "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" - }, - "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", - "type": "boolean", - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false." - } - }, - "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", - "description": "Lists all features that can be specified in the SSL policy when using custom profile.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." + }, + "type": { + "enum": [ + "HIERARCHY", + "NETWORK", + "NETWORK_REGIONAL", + "UNSPECIFIED" ], - "response": { - "$ref": "SslPoliciesListAvailableFeaturesResponse" + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "" + ], + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL." + }, + "rules": { + "items": { + "$ref": "FirewallPolicyRule" }, - "id": "compute.regionSslPolicies.listAvailableFeatures", - "parameterOrder": [ - "project", - "region" + "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" ], - "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures" + "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." + ] }, - "get": { - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "id": "compute.regionSslPolicies.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" + }, + "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" ], - "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 - }, - "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" - }, - "region": { - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "type": "string" - } - }, - "httpMethod": "GET", - "description": "Lists all of the ordered rules present in a single specified policy.", - "response": { - "$ref": "SslPolicy" - }, - "parameterOrder": [ - "project", - "region", - "sslPolicy" + "enumDescriptions": [ + "New VMs in this subnet can have both IPv4 and IPv6 addresses.", + "New VMs in this subnet will only be assigned IPv4 addresses." ] }, - "delete": { - "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "response": { - "$ref": "Operation" + "enum": [ + "INTERNAL_HTTPS_LOAD_BALANCER", + "PRIVATE", + "PRIVATE_RFC_1918", + "PRIVATE_SERVICE_CONNECT", + "REGIONAL_MANAGED_PROXY" + ], + "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." + }, + "state": { + "enumDescriptions": [ + "Subnetwork is being drained.", + "Subnetwork is ready for use." + ], + "enum": [ + "DRAINING", + "READY" + ], + "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." + }, + "ipv6AccessType": { + "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." + ], + "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" + }, + "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" }, - "id": "compute.regionSslPolicies.delete", - "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", - "parameterOrder": [ - "project", - "region", - "sslPolicy" + "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" ], - "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, - "description": "Project ID for this request.", + "enumDescriptions": [ + "The ACTIVE subnet that is currently used.", + "The BACKUP subnet that could be promoted to ACTIVE." + ], + "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" + } + } + }, + "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": { "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": "[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" + ] }, - "sslPolicy": { - "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", - "required": true, + "message": { "type": "string", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." }, - "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" + "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" } + } + }, + "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": "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." + "description": "[Output Only] Unreachable resources.", + "type": "array" }, - "insert": { - "flatPath": "projects/{project}/regions/{region}/sslPolicies", - "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])?))" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "required": true, - "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" + }, + "items": { + "type": "object", + "additionalProperties": { + "description": "The name of the scope that contains this set of instance groups.", + "$ref": "InstanceGroupsScopedList" }, - "request": { - "$ref": "SslPolicy" + "description": "A list of InstanceGroupsScopedList resources." + } + }, + "type": "object" + }, + "SecurityPolicyReference": { + "type": "object", + "properties": { + "securityPolicy": { + "type": "string" + } + }, + "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" + } + }, + "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" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "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": "POST", - "parameterOrder": [ - "project", - "region" + "enum": [ + "ANNOUNCED", + "DELETING", + "INITIALIZING", + "READY_TO_ANNOUNCE" ], - "id": "compute.regionSslPolicies.insert", - "description": "Creates a new policy in the specified project and region using the data included in the request.", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/sslPolicies" + "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" }, - "regionDisks": { - "methods": { - "delete": { - "id": "compute.regionDisks.delete", - "parameterOrder": [ - "project", - "region", - "disk" + "LogConfigCloudAuditOptions": { + "id": "LogConfigCloudAuditOptions", + "properties": { + "authorizationLoggingOptions": { + "$ref": "AuthorizationLoggingOptions", + "description": "This is deprecated and has no effect. Do not use." + }, + "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." ], - "path": "projects/{project}/regions/{region}/disks/{disk}", - "response": { - "$ref": "Operation" - }, - "httpMethod": "DELETE", - "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.", - "flatPath": "projects/{project}/regions/{region}/disks/{disk}", - "parameters": { - "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." - }, - "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.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "disk": { - "location": "path", - "required": true, - "description": "Name of the regional persistent disk to delete.", - "type": "string" - } - }, - "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" }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "id": "compute.regionDisks.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}/regions/{region}/disks/{resource}/getIamPolicy", - "flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", - "httpMethod": "GET", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "region": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "type": "string", - "description": "The name of the region for this request." - }, - "optionsRequestedPolicyVersion": { - "location": "query", - "description": "Requested IAM Policy version.", - "format": "int32", - "type": "integer" - }, - "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 - }, - "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" - } + "name": { + "description": "Header name.", + "type": "string" + } + }, + "type": "object", + "id": "UrlMapTestHeader" + }, + "TargetInstanceAggregatedList": { + "id": "TargetInstanceAggregatedList", + "type": "object", + "properties": { + "unreachables": { + "items": { + "type": "string" }, - "response": { - "$ref": "Policy" - } + "type": "array", + "description": "[Output Only] Unreachable resources." }, - "get": { - "description": "Returns a specified regional persistent disk.", - "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}/disks/{disk}", - "parameterOrder": [ - "project", - "region", - "disk" - ], - "flatPath": "projects/{project}/regions/{region}/disks/{disk}", - "id": "compute.regionDisks.get", - "parameters": { - "disk": { - "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 regional persistent disk to return.", - "type": "string" + "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." + }, + "type": "object", + "description": "A list of TargetInstance resources." + }, + "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" }, - "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." }, - "region": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "code": { "type": "string", - "location": "path", - "description": "Name of the region 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." + ] } }, - "response": { - "$ref": "Disk" - } + "type": "object" }, - "testIamPermissions": { - "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" + "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" }, - "parameterOrder": [ - "project", - "region", - "resource" + "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" ], - "parameters": { - "region": { - "required": true, - "description": "The name of the region for this request.", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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.", - "location": "path", - "type": "string", - "required": true - }, - "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 - } - }, - "id": "compute.regionDisks.testIamPermissions", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", - "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." ], - "response": { - "$ref": "TestPermissionsResponse" + "type": "string" + } + }, + "id": "DistributionPolicy" + }, + "RouterAggregatedList": { + "id": "RouterAggregatedList", + "type": "object", + "properties": { + "unreachables": { + "items": { + "type": "string" }, - "description": "Returns permissions that a caller has on the specified resource." + "type": "array", + "description": "[Output Only] Unreachable resources." }, - "setIamPolicy": { - "parameters": { - "region": { + "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" + }, + "type": "object", + "description": "A list of Router resources." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "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.", "type": "string", - "required": true, - "location": "path", - "description": "The name of the region for this request.", - "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." + ] }, - "resource": { - "required": true, - "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}", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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])?))" + "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" } - }, - "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" - ], - "id": "compute.regionDisks.setIamPolicy", - "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "project", - "region", - "resource" - ], - "path": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", - "httpMethod": "POST" + } + }, + "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" }, - "removeResourcePolicies": { - "description": "Removes resource policies from a regional disk.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies", - "parameterOrder": [ - "project", - "region", - "disk" - ], - "id": "compute.regionDisks.removeResourcePolicies", - "path": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies", - "request": { - "$ref": "RegionDisksRemoveResourcePoliciesRequest" - }, - "response": { - "$ref": "Operation" + "items": { + "type": "array", + "items": { + "$ref": "VpnTunnel" }, - "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 - }, - "requestId": { - "location": "query", + "description": "A list of VpnTunnel 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": { + "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": { - "description": "The name of the region for this request.", - "required": true, - "type": "string", - "location": "path", - "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": { + "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" }, - "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.", + "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" + ] } }, - "httpMethod": "POST" + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "setLabels": { - "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" - }, - "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}" + "kind": { + "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", + "type": "string", + "default": "compute#vpnTunnelList" + }, + "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.", + "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)." + "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" }, - "region": { - "type": "string", - "description": "The region for this request.", - "required": true, - "location": "path", - "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" } }, - "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels", - "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "response": { - "$ref": "Operation" - }, - "id": "compute.regionDisks.setLabels", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "description": "Sets the labels on the target regional disk.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST" + "description": "Informational warning which replaces the list of backend services when the list is empty." }, - "createSnapshot": { - "request": { - "$ref": "Snapshot" + "targetHttpProxies": { + "description": "A list of TargetHttpProxies contained in this scope.", + "items": { + "$ref": "TargetHttpProxy" }, - "path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", - "parameterOrder": [ - "project", - "region", - "disk" + "type": "array" + } + }, + "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.", + "" ], - "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", - "httpMethod": "POST", - "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.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enum": [ + "MANAGED", + "SELF_MANAGED", + "TYPE_UNSPECIFIED" ], - "response": { - "$ref": "Operation" - }, - "id": "compute.regionDisks.createSnapshot", - "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", - "description": "Name of the region for this request.", - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "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": { - "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 regional persistent disk to snapshot.", - "required": true - } + "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" + }, + "type": "array" }, - "list": { - "httpMethod": "GET", - "parameters": { - "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" + "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" + } }, - "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" }, - "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 - }, - "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.", + "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" - }, - "region": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request.", - "required": true, - "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." - }, - "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" } }, - "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", + "id": "PublicDelegatedPrefixesScopedList" + }, + "TargetVpnGateway": { + "properties": { + "status": { + "enumDescriptions": [ + "", + "", + "", + "" ], - "id": "compute.regionDisks.list", - "response": { - "$ref": "DiskList" - }, - "parameterOrder": [ - "project", - "region" + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "READY" ], - "path": "projects/{project}/regions/{region}/disks", - "description": "Retrieves the list of persistent disks contained within the specified region.", - "flatPath": "projects/{project}/regions/{region}/disks" + "description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.", + "type": "string" }, - "resize": { - "parameterOrder": [ - "project", - "region", - "disk" - ], - "response": { - "$ref": "Operation" + "forwardingRules": { + "type": "array", + "items": { + "type": "string" }, - "id": "compute.regionDisks.resize", - "description": "Resizes the specified regional persistent disk.", - "parameters": { - "project": { - "required": true, - "type": "string", - "description": "The project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "region": { - "type": "string", - "description": "Name of the region for this request.", - "required": true, - "location": "path", - "pattern": "[a-z](?:[-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}", - "type": "string", - "location": "path", - "description": "Name of the regional persistent disk.", - "required": true - } + "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" + ] }, - "path": "projects/{project}/regions/{region}/disks/{disk}/resize", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "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." + }, + "name": { + "type": "string", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "annotations": { + "required": [ + "compute.targetVpnGateways.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." + } + }, + "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" ], - "flatPath": "projects/{project}/regions/{region}/disks/{disk}/resize", - "httpMethod": "POST", - "request": { - "$ref": "RegionDisksResizeRequest" + "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.", + "" + ], + "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" } + } + } + }, + "InterconnectDiagnosticsLinkLACPStatus": { + "id": "InterconnectDiagnosticsLinkLACPStatus", + "type": "object", + "properties": { + "neighborSystemId": { + "description": "System ID of the port on the neighbor's side of the LACP exchange.", + "type": "string" }, - "insert": { - "path": "projects/{project}/regions/{region}/disks", - "parameterOrder": [ - "project", - "region" + "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." ], - "flatPath": "projects/{project}/regions/{region}/disks", - "response": { - "$ref": "Operation" - }, - "description": "Creates a persistent regional disk in the specified project using the data included in the request.", - "parameters": { - "sourceImage": { - "location": "query", - "type": "string", - "description": "Source image to restore onto a disk. This field is optional." - }, - "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": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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", - "location": "path", - "description": "Name of the region for this request.", - "required": true - } - }, - "request": { - "$ref": "Disk" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enum": [ + "ACTIVE", + "DETACHED" ], - "id": "compute.regionDisks.insert", - "httpMethod": "POST" + "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. " }, - "addResourcePolicies": { - "path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", - "id": "compute.regionDisks.addResourcePolicies", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region", - "disk" + "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": "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.", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", - "parameters": { - "disk": { - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", - "description": "The disk name 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", - "description": "Project ID for this request.", - "required": true - }, - "region": { - "location": "path", - "required": true, - "description": "The name of the region for this request.", - "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)." - } + "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" + } + }, + "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" }, - "request": { - "$ref": "RegionDisksAddResourcePoliciesRequest" + "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\"]." + } + } + }, + "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" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "zone": { + "type": "string", + "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment." + }, + "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" + } + }, + "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." + ], + "type": "string", + "enum": [ + "CREATING", + "DELETING", + "INVALID", + "READY", + "UPDATING" + ], + "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" + }, + "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" + ], + "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." ] } } }, - "regionUrlMaps": { - "methods": { - "validate": { - "parameterOrder": [ - "project", - "region", - "urlMap" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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.", - "id": "compute.regionUrlMaps.validate", - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", - "response": { - "$ref": "UrlMapsValidateResponse" - }, - "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])?))", - "location": "path", - "required": true - }, - "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": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the UrlMap resource to be validated as.", - "type": "string", - "location": "path" - } - }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate" + "ResourcePolicy": { + "type": "object", + "properties": { + "snapshotSchedulePolicy": { + "description": "Resource policy for persistent disks for creating snapshots.", + "$ref": "ResourcePolicySnapshotSchedulePolicy" }, - "get": { - "id": "compute.regionUrlMaps.get", - "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.", - "parameterOrder": [ - "project", - "region", - "urlMap" + "status": { + "type": "string", + "enum": [ + "CREATING", + "DELETING", + "EXPIRED", + "INVALID", + "READY" ], - "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." ], - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "response": { - "$ref": "UrlMap" - }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "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" - }, - "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." - }, - "urlMap": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the UrlMap resource to return.", - "location": "path", - "type": "string" - } - }, - "httpMethod": "GET" + "description": "[Output Only] The status of resource policy creation." }, - "update": { - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "request": { - "$ref": "UrlMap" - }, - "parameters": { - "urlMap": { - "description": "Name of the UrlMap resource to update.", - "location": "path", - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - }, - "requestId": { - "type": "string", - "location": "query", - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency." - }, - "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": { - "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 - } - }, - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "id": "compute.regionUrlMaps.update", - "parameterOrder": [ - "project", - "region", - "urlMap" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "PUT", - "description": "Updates the specified UrlMap resource with the data included in the request." + "groupPlacementPolicy": { + "$ref": "ResourcePolicyGroupPlacementPolicy", + "description": "Resource policy for instances for placement configuration." }, - "insert": { - "request": { - "$ref": "UrlMap" + "description": { + "type": "string" + }, + "instanceSchedulePolicy": { + "$ref": "ResourcePolicyInstanceSchedulePolicy", + "description": "Resource policy for scheduling instance operations." + }, + "name": { + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "annotations": { + "required": [ + "compute.instances.insert" + ] }, - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/urlMaps", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": "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" ], - "path": "projects/{project}/regions/{region}/urlMaps", - "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])?))", - "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.", - "type": "string", - "location": "path" - }, - "requestId": { - "type": "string", - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", - "location": "query" - } + "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" }, - "id": "compute.regionUrlMaps.insert", - "parameterOrder": [ - "project", - "region" - ], - "description": "Creates a UrlMap resource in the specified project using the data included in the request." + "description": "This is deprecated and has no effect. Do not use.", + "type": "array" }, - "list": { - "id": "compute.regionUrlMaps.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}/urlMaps", - "httpMethod": "GET", - "response": { - "$ref": "UrlMapList" + "ins": { + "items": { + "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." - }, - "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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", - "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`)" - }, - "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" - }, - "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" - } + "type": "array", + "description": "This is deprecated and has no effect. Do not use." + }, + "logConfigs": { + "type": "array", + "items": { + "$ref": "LogConfig" }, - "flatPath": "projects/{project}/regions/{region}/urlMaps", - "parameterOrder": [ - "project", - "region" - ], - "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region." + "description": "This is deprecated and has no effect. Do not use." }, - "delete": { - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "urlMap" + "notIns": { + "type": "array", + "description": "This is deprecated and has no effect. Do not use.", + "items": { + "type": "string" + } + }, + "permissions": { + "description": "This is deprecated and has no effect. Do not use.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "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" ], - "response": { - "$ref": "Operation" - }, - "description": "Deletes the specified UrlMap resource.", - "parameters": { - "requestId": { - "type": "string", - "location": "query", - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency." - }, - "urlMap": { - "type": "string", - "required": true, - "description": "Name of the UrlMap resource to delete.", - "location": "path", - "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, - "description": "Project ID for this request.", - "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": "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.regionUrlMaps.delete" + "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." }, - "patch": { - "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 patch.", - "location": "path", - "type": "string", - "required": true - }, - "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": { - "location": "query", - "type": "string", - "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency." - }, - "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])?))" - } - }, - "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", - "parameterOrder": [ - "project", - "region", - "urlMap" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "status": { + "enumDescriptions": [ + "", + "" ], - "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.", - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" + "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" }, - "id": "compute.regionUrlMaps.patch", - "request": { - "$ref": "UrlMap" + "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" } } + }, + "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" + } } }, - "regionNetworkFirewallPolicies": { - "methods": { - "testIamPermissions": { - "id": "compute.regionNetworkFirewallPolicies.testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.", - "httpMethod": "POST", - "request": { - "$ref": "TestPermissionsRequest" - }, - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "location": "path", + "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" + } + }, + "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" + } + }, + "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" + }, + "warning": { + "properties": { + "message": { "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." + "description": "[Output Only] A human-readable description of the warning code." }, - "resource": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "code": { "type": "string", - "description": "Name or id of the resource for this request.", - "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" + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "type": "string", - "required": true, - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "The name of the region for this request." + "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" } }, - "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/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}/firewallPolicies/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" + "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" + }, + "kind": { + "type": "string", + "description": "Type of resource.", + "default": "compute#httpsHealthCheckList" + }, + "items": { + "type": "array", + "description": "A list of HttpsHealthCheck resources.", + "items": { + "$ref": "HttpsHealthCheck" } + } + }, + "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" }, - "addRule": { - "parameterOrder": [ - "project", - "region", - "firewallPolicy" - ], - "id": "compute.regionNetworkFirewallPolicies.addRule", - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule", - "description": "Inserts a rule into a network firewall policy.", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "instances": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule", - "request": { - "$ref": "FirewallPolicyRule" + "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" }, - "parameters": { - "firewallPolicy": { - "type": "string", - "location": "path", - "required": true, - "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}" - }, - "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", - "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)." - }, - "maxPriority": { - "format": "int32", - "location": "query", - "type": "integer", - "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority." - }, - "minPriority": { - "format": "int32", - "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.", - "type": "integer" - }, - "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" - } + "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" + }, + "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" + }, + "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" + }, + "items": { + "description": "A list of Node resources.", + "type": "array", + "items": { + "$ref": "NodeGroupNode" } }, - "get": { - "description": "Returns the specified network firewall policy.", - "parameterOrder": [ - "project", - "region", - "firewallPolicy" - ], - "httpMethod": "GET", - "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" + "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" }, - "region": { - "location": "path", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-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" + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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": { - "location": "path", - "description": "Name of the firewall policy to get.", - "required": true, - "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" } }, - "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/{firewallPolicy}", - "response": { - "$ref": "FirewallPolicy" - }, - "id": "compute.regionNetworkFirewallPolicies.get", - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}" + "description": "[Output Only] Informational warning message." }, - "getRule": { - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule", - "response": { - "$ref": "FirewallPolicyRule" - }, - "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 - }, - "priority": { - "description": "The priority of the rule to get from the firewall policy.", - "format": "int32", - "type": "integer", - "location": "query" + "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" + }, + "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" + } }, - "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, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, - "firewallPolicy": { - "description": "Name of the firewall policy to which the queried rule belongs.", - "location": "path", - "required": true, - "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" } }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/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" - ], - "httpMethod": "GET", - "description": "Gets a rule of the specified priority.", - "id": "compute.regionNetworkFirewallPolicies.getRule" + "description": "[Output Only] Informational warning message." }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy", - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/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", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "httpMethod": "GET", - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "type": "integer", - "format": "int32", - "location": "query" - }, - "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 - }, - "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": { - "description": "The name of the region for this request.", - "required": true, - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" - } + "items": { + "description": "A list of InstanceWithNamedPorts resources.", + "type": "array", + "items": { + "$ref": "InstanceWithNamedPorts" + } + } + }, + "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" } }, - "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." - }, - "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": { - "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", - "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", - "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, - "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": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true, - "type": "string", - "description": "Name of the region scoping this request." - } + "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" }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies", - "id": "compute.regionNetworkFirewallPolicies.list", - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/firewallPolicies", - "description": "Lists all the network firewall policies that have been configured for the specified 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" - ], - "response": { - "$ref": "FirewallPolicyList" + "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" } }, - "getAssociation": { - "parameters": { - "name": { - "type": "string", - "location": "query", - "description": "The name of the association to get from the firewall policy." - }, - "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 - }, - "firewallPolicy": { - "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", - "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 scoping this request." - } - }, - "response": { - "$ref": "FirewallPolicyAssociation" + "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" }, - "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" + "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" ], - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "enumDescriptions": [ + "", + "" ], - "description": "Gets an association with the specified name.", - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation", - "httpMethod": "GET" + "type": "string", + "description": "[Output Only] The status of the sub public delegated prefix." }, - "patch": { - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "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" + } + } + }, + "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." ], - "request": { - "$ref": "FirewallPolicy" - }, - "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])?))", - "location": "path", - "description": "Project ID for this request.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region scoping this request.", - "required": true, - "type": "string" - }, - "firewallPolicy": { - "required": true, - "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", - "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" - }, - "description": "Patches the specified network firewall policy.", - "id": "compute.regionNetworkFirewallPolicies.patch", - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ] }, - "cloneRules": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "ipCidrRange": { + "description": "The range of internal addresses that are owned by this subnetwork.", + "type": "string" + }, + "role": { + "enum": [ + "ACTIVE", + "BACKUP" + ], + "enumDescriptions": [ + "The ACTIVE subnet that is currently used.", + "The BACKUP subnet that could be promoted to ACTIVE." + ], + "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." + }, + "ipv6AccessType": { + "type": "string", + "enum": [ + "EXTERNAL", + "INTERNAL" ], - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "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": "Copies rules to the specified network firewall policy.", - "httpMethod": "POST", - "id": "compute.regionNetworkFirewallPolicies.cloneRules", - "parameters": { - "sourceFirewallPolicy": { - "type": "string", - "location": "query", - "description": "The firewall policy from which to copy rules." - }, - "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" - }, - "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": { - "type": "string", - "required": true, - "description": "Name of the firewall policy to update.", - "location": "path", - "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.", - "location": "path", - "type": "string", - "required": true - } + "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." + }, + "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." + ], + "enum": [ + "INTERNAL_HTTPS_LOAD_BALANCER", + "PRIVATE", + "PRIVATE_RFC_1918", + "PRIVATE_SERVICE_CONNECT", + "REGIONAL_MANAGED_PROXY" + ], + "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" + } + } + }, + "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" }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules" + "type": "array" }, - "delete": { - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", - "response": { - "$ref": "Operation" + "bestRoutes": { + "type": "array", + "items": { + "$ref": "Route" }, - "description": "Deletes 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])?))", - "description": "Project ID for this request.", - "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" - }, - "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." - }, - "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 - } + "description": "Best routes for this router's network." + }, + "network": { + "description": "URI of the network to which this router belongs.", + "type": "string" + }, + "bestRoutesForRouter": { + "type": "array", + "description": "Best routes learned by this router.", + "items": { + "$ref": "Route" + } + }, + "natStatus": { + "items": { + "$ref": "RouterStatusNatStatus" }, - "httpMethod": "DELETE", - "id": "compute.regionNetworkFirewallPolicies.delete", - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "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" + } + }, + "shareType": { + "enumDescriptions": [ + "Default value.", + "Shared-reservation is open to entire Organization", + "Default value. This value is unused.", + "Shared-reservation is open to specific projects" ], - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", - "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" + ], + "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." }, - "setIamPolicy": { - "parameterOrder": [ - "project", - "region", - "resource" + "state": { + "enumDescriptions": [ + "", + "" ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "parameters": { - "region": { + "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" + ], + "type": "string" + } + }, + "id": "FirewallPolicyRuleSecureTag" + }, + "TargetSslProxiesSetBackendServiceRequest": { + "properties": { + "service": { + "description": "The URL of the new BackendService resource for the targetSslProxy.", + "type": "string" + } + }, + "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": [ + "", + "" + ], + "enum": [ + "GLOBAL", + "REGIONAL" + ], + "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." + }, + "warning": { + "properties": { + "message": { "type": "string", - "required": true, - "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 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": "Project ID for this request." + "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\" } " }, - "resource": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path", + "code": { "type": "string", - "description": "Name or id of the resource 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." + ], + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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", - "id": "compute.regionNetworkFirewallPolicies.setIamPolicy", - "response": { - "$ref": "Policy" - }, - "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "patchRule": { - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", - "id": "compute.regionNetworkFirewallPolicies.patchRule", - "description": "Patches a rule of the specified priority.", - "request": { - "$ref": "FirewallPolicyRule" - }, - "parameters": { - "priority": { - "description": "The priority of the rule to patch.", - "type": "integer", - "location": "query", - "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" - }, - "firewallPolicy": { - "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}", - "type": "string", - "required": true, - "location": "path" + "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" }, - "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).", + "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" }, - "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])?" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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" + } + } + } + }, + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "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" }, - "parameterOrder": [ - "project", - "region", - "firewallPolicy" - ], - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule" + "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." }, - "removeAssociation": { - "response": { - "$ref": "Operation" + "allowMethods": { + "description": "Specifies the content for the Access-Control-Allow-Methods header.", + "items": { + "type": "string" }, - "parameters": { - "name": { - "type": "string", - "description": "Name for the association that will be removed.", - "location": "query" - }, - "firewallPolicy": { - "required": true, - "description": "Name of the firewall policy to update.", + "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": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "location": "path" + "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." + ], "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" + "description": "[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": { - "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 + "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" } }, - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", - "id": "compute.regionNetworkFirewallPolicies.removeAssociation", - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", - "description": "Removes an association for the specified network firewall policy.", - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "type": "object", + "description": "[Output Only] Informational warning message." + }, + "items": { + "type": "array", + "items": { + "$ref": "Project" + }, + "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." ], - "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.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" ], - "httpMethod": "POST" + "type": "string" }, - "addAssociation": { - "request": { - "$ref": "FirewallPolicyAssociation" - }, - "response": { - "$ref": "Operation" - }, - "id": "compute.regionNetworkFirewallPolicies.addAssociation", - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation", - "httpMethod": "POST", - "description": "Inserts an association for the specified network firewall policy.", - "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" - }, - "replaceExistingAssociation": { - "location": "query", - "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" - }, - "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])?" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" - }, - "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 update." - } - }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation", - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "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" ], - "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." + ], + "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." }, - "getEffectiveFirewalls": { - "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" + "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." + } + } + } }, - "network": { - "type": "string", - "required": true, - "location": "query", - "description": "Network reference" + "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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." } }, - "httpMethod": "GET", - "parameterOrder": [ - "project", - "region", - "network" - ], - "description": "Returns the effective firewalls on a given network.", - "id": "compute.regionNetworkFirewallPolicies.getEffectiveFirewalls", - "response": { - "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse" + "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." + }, + "items": { + "items": { + "$ref": "SslPolicy" }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls", - "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/getEffectiveFirewalls" + "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" }, - "removeRule": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "architecture": { + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" ], - "parameterOrder": [ - "project", - "region", - "firewallPolicy" + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" ], - "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule", - "id": "compute.regionNetworkFirewallPolicies.removeRule", - "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", - "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" - }, - "region": { - "type": "string", - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "required": true - }, - "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 update.", - "location": "path", - "required": true - }, - "priority": { - "location": "query", - "description": "The priority of the rule to remove from the firewall policy.", - "type": "integer", - "format": "int32" - } - }, - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule", - "description": "Deletes a rule of the specified priority.", - "response": { - "$ref": "Operation" - } + "description": "[Output Only] The architecture of the attached disk.", + "type": "string" }, - "insert": { - "path": "projects/{project}/regions/{region}/firewallPolicies", - "description": "Creates a new network firewall policy in the specified project and region.", - "request": { - "$ref": "FirewallPolicy" - }, - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/firewallPolicies", - "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" - }, - "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", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path" - } - }, - "httpMethod": "POST", - "parameterOrder": [ - "project", - "region" + "kind": { + "default": "compute#savedDisk", + "type": "string", + "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks." + }, + "storageBytes": { + "description": "[Output Only] Size of the individual disk snapshot used by this machine image.", + "type": "string", + "format": "int64" + }, + "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" ], - "id": "compute.regionNetworkFirewallPolicies.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enumDescriptions": [ + "", + "" ] } } }, - "instanceGroups": { - "methods": { - "delete": { - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", - "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.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", - "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])?))", - "type": "string", - "required": true, - "description": "Project ID for this request.", - "location": "path" - }, - "zone": { + "RouterList": { + "id": "RouterList", + "type": "object", + "properties": { + "warning": { + "type": "object", + "properties": { + "code": { "type": "string", - "location": "path", - "required": true, - "description": "The name of the zone where the 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" + ], + "description": "[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." + ] }, - "instanceGroup": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the instance group to delete." + "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" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "parameterOrder": [ - "project", - "zone", - "instanceGroup" - ], - "response": { - "$ref": "Operation" + "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" }, - "id": "compute.instanceGroups.delete" + "description": "[Output Only] Unreachable resources." }, - "aggregatedList": { - "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" - }, - "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": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "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": "query" - }, - "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`)", - "format": "uint32", - "minimum": "0", - "default": "500" - }, - "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." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" + ] }, - "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": { + "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": { - "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`." + "description": "[Output Only] A human-readable description of the warning code." } }, - "flatPath": "projects/{project}/aggregated/instanceGroups", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/instanceGroups", - "description": "Retrieves the list of instance groups and sorts them by zone.", - "httpMethod": "GET", - "response": { - "$ref": "InstanceGroupAggregatedList" - }, - "id": "compute.instanceGroups.aggregatedList", - "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." }, - "insert": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "zone" - ], - "description": "Creates an instance group in the specified project using the parameters that are included in the request.", - "httpMethod": "POST", - "request": { - "$ref": "InstanceGroup" + "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" }, - "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).", - "location": "query", - "type": "string" - }, - "zone": { - "type": "string", - "description": "The name of the zone where you want to create the instance group.", - "location": "path", - "required": true - } + "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" + ] }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroups", - "path": "projects/{project}/zones/{zone}/instanceGroups", - "response": { - "$ref": "Operation" + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "subnetworks": { + "type": "array", + "items": { + "type": "string" }, - "id": "compute.instanceGroups.insert" + "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network." }, - "list": { - "id": "compute.instanceGroups.list", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" + }, + "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" + }, + "networkFirewallPolicyEnforcementOrder": { + "enumDescriptions": [ + "", + "" ], - "httpMethod": "GET", - "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.", - "path": "projects/{project}/zones/{zone}/instanceGroups", - "response": { - "$ref": "InstanceGroupList" + "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" }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroups", - "parameters": { - "filter": { + "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": { "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 human-readable description of the warning code." }, - "project": { + "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-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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." }, - "orderBy": { + "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\" } " + } + } + } + } + }, + "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": { + "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" + ], "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" + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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, + "message": { "type": "string", - "description": "The name of the zone where the instance group is located." - }, - "maxResults": { - "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`)", - "format": "uint32" + "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": { + "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" } + } + }, + "acceleratorTypes": { + "type": "array", + "items": { + "$ref": "AcceleratorType" }, - "parameterOrder": [ - "project", - "zone" - ] + "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" }, - "addInstances": { - "httpMethod": "POST", - "id": "compute.instanceGroups.addInstances", - "parameterOrder": [ - "project", - "zone", - "instanceGroup" + "healthState": { + "description": "Health state of the network endpoint determined based on the health checks configured.", + "enumDescriptions": [ + "", + "", + "", + "" ], - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", - "parameters": { - "instanceGroup": { - "description": "The name of the instance group where you are adding instances.", - "location": "path", - "type": "string", - "required": true - }, - "zone": { - "type": "string", - "required": true, - "location": "path", - "description": "The name of the zone where the 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" - }, - "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" - } + "enum": [ + "DRAINING", + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ], + "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" + } + }, + "srcSecureTags": { + "items": { + "$ref": "FirewallPolicyRuleSecureTag" }, - "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.", - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", - "request": { - "$ref": "InstanceGroupsAddInstancesRequest" + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "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" } }, - "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.", - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", - "response": { - "$ref": "Operation" - }, - "parameters": { - "instanceGroup": { + "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." + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "message": { "type": "string", - "description": "The name of the instance group where the specified instances will be removed.", - "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" + "description": "[Output Only] A human-readable description of the warning code." }, - "zone": { - "location": "path", + "code": { "type": "string", - "required": true, - "description": "The name of the zone where the 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" + ], + "description": "[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": { - "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": { + "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" } }, - "httpMethod": "POST", - "request": { - "$ref": "InstanceGroupsRemoveInstancesRequest" - }, - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", - "id": "compute.instanceGroups.removeInstances", - "parameterOrder": [ - "project", - "zone", - "instanceGroup" + "type": "object" + }, + "kind": { + "default": "compute#snapshotList", + "description": "Type of resource.", + "type": "string" + }, + "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" + }, + "myDiscriminator": { + "description": "The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880", + "type": "integer", + "format": "uint32" + }, + "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": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], - "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" ] }, - "setNamedPorts": { - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", - "parameterOrder": [ - "project", - "zone", - "instanceGroup" + "state": { + "enumDescriptions": [ + "", + "", + "", + "", + "" ], - "request": { - "$ref": "InstanceGroupsSetNamedPortsRequest" - }, - "description": "Sets the named ports for the specified instance group.", - "id": "compute.instanceGroups.setNamedPorts", - "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": { - "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" - }, - "instanceGroup": { - "location": "path", - "required": true, - "type": "string", - "description": "The name of the instance group where the named ports are updated." - }, - "zone": { - "description": "The name of the zone where the instance group is located.", - "type": "string", - "location": "path", - "required": true - } + "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" } }, - "get": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "response": { - "$ref": "InstanceGroup" - }, - "httpMethod": "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.", - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", - "id": "compute.instanceGroups.get", - "parameterOrder": [ - "project", - "zone", - "instanceGroup" - ], - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", - "parameters": { - "instanceGroup": { - "type": "string", - "description": "The name of the instance group.", - "location": "path", - "required": true - }, - "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" - }, - "zone": { - "description": "The name of the zone where the instance group is located.", - "location": "path", - "type": "string", - "required": true - } + "email": { + "type": "string", + "description": "Email address of the service account." + } + } + }, + "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" } }, - "listInstances": { - "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameters": { - "zone": { - "description": "The name of the zone where the instance group is located.", - "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" - }, - "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" - }, - "instanceGroup": { - "location": "path", - "required": true, - "description": "The name of the instance group from which you want to generate a list of included instances.", - "type": "string" - }, - "maxResults": { - "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", - "location": "query" + "keks": { + "description": "The Key Exchange Key (KEK).", + "type": "array", + "items": { + "$ref": "FileContentBuffer" + } + }, + "pk": { + "$ref": "FileContentBuffer", + "description": "The Platform Key (PK)." + }, + "dbxs": { + "description": "The forbidden key database (dbx).", + "items": { + "$ref": "FileContentBuffer" + }, + "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" + }, + "items": { + "items": { + "$ref": "InterconnectAttachment" + }, + "description": "A list of InterconnectAttachment resources.", + "type": "array" + }, + "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" }, - "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.", + "code": { "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.", + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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" + ] }, - "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" } }, - "id": "compute.instanceGroups.listInstances", - "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", - "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.", - "parameterOrder": [ - "project", - "zone", - "instanceGroup" - ], - "request": { - "$ref": "InstanceGroupsListInstancesRequest" - }, - "httpMethod": "POST", - "response": { - "$ref": "InstanceGroupsListInstances" - } + "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." } } }, - "forwardingRules": { - "methods": { - "aggregatedList": { - "flatPath": "projects/{project}/aggregated/forwardingRules", - "id": "compute.forwardingRules.aggregatedList", - "description": "Retrieves an aggregated list of forwarding rules.", - "path": "projects/{project}/aggregated/forwardingRules", - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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": [ + "", + "", + "" ], - "parameters": { - "maxResults": { - "type": "integer", - "format": "uint32", - "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" - }, - "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" - }, - "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." - }, - "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])?))" - }, - "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" - } - }, - "response": { - "$ref": "ForwardingRuleAggregatedList" - }, - "parameterOrder": [ - "project" + "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." }, - "setTarget": { - "id": "compute.forwardingRules.setTarget", - "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", - "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).", - "type": "string", - "location": "query" - }, - "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])?))" - }, - "forwardingRule": { - "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 ForwardingRule resource in which target is to be set." - }, - "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." - } - }, - "description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", - "parameterOrder": [ - "project", - "region", - "forwardingRule" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "TargetReference" + "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" } }, - "list": { - "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", - "path": "projects/{project}/regions/{region}/forwardingRules", - "response": { - "$ref": "ForwardingRuleList" - }, - "description": "Retrieves a list of ForwardingRule resources available to the specified project and region.", - "parameters": { - "maxResults": { - "type": "integer", - "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`)", - "format": "uint32" - }, - "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" - }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "location": "path", - "description": "Name of the region scoping this request.", - "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" - }, - "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." - }, - "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" - } + "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" }, - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/forwardingRules", - "parameterOrder": [ - "project", - "region" - ] + "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" }, - "get": { - "parameterOrder": [ - "project", - "region", - "forwardingRule" + "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" + } + }, + "sessionAffinity": { + "type": "string", + "enum": [ + "CLIENT_IP", + "CLIENT_IP_NO_DESTINATION", + "CLIENT_IP_PORT_PROTO", + "CLIENT_IP_PROTO", + "GENERATED_COOKIE", + "HEADER_FIELD", + "HTTP_COOKIE", + "NONE" ], - "id": "compute.forwardingRules.get", - "parameters": { - "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" - }, - "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." - }, - "forwardingRule": { - "description": "Name of the ForwardingRule 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}" - } - }, - "description": "Returns the specified ForwardingRule resource.", - "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", - "response": { - "$ref": "ForwardingRule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ] }, - "patch": { - "parameters": { - "forwardingRule": { - "required": true, - "description": "Name of the ForwardingRule resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string" - }, - "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": { - "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, - "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", - "id": "compute.forwardingRules.patch", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "region", - "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.", - "httpMethod": "PATCH", - "request": { - "$ref": "ForwardingRule" + "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" }, - "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}" + "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" }, - "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" - }, - "region": { - "location": "path", + "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" + }, + "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", - "required": true, - "description": "Name of the region scoping this request.", - "pattern": "[a-z](?:[-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" + ] }, - "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])?))", + "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" + }, + "message": { "type": "string", - "required": true, - "description": "Project ID for this request." + "description": "[Output Only] A human-readable description of the warning code." } }, - "path": "projects/{project}/regions/{region}/forwardingRules", - "parameterOrder": [ - "project", - "region" - ], - "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.", - "id": "compute.forwardingRules.insert", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/forwardingRules", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "ForwardingRule" - } + "type": "object", + "description": "[Output Only] Informational warning message." }, - "setLabels": { - "httpMethod": "POST", - "response": { - "$ref": "Operation" + "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" }, - "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels", - "parameterOrder": [ - "project", - "region", - "resource" + "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" + }, + "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" ], - "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels", - "id": "compute.forwardingRules.setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "" ], - "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" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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", - "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": { - "required": true, - "location": "path", - "type": "string", - "description": "The region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - } - } + "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." }, - "delete": { - "httpMethod": "DELETE", - "id": "compute.forwardingRules.delete", - "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", - "parameterOrder": [ - "project", - "region", - "forwardingRule" - ], - "response": { - "$ref": "Operation" - }, - "description": "Deletes the specified ForwardingRule resource.", - "flatPath": "projects/{project}/regions/{region}/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": { - "location": "path", + "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." + } + }, + "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" + ], "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 delete.", - "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." }, - "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." + "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": { - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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.", + "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" - ] + "description": "[Output Only] Informational warning message." + }, + "items": { + "items": { + "$ref": "InstanceGroup" + }, + "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" }, - "snapshots": { - "methods": { - "getIamPolicy": { - "path": "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" - ], - "parameters": { - "optionsRequestedPolicyVersion": { - "format": "int32", - "description": "Requested IAM Policy version.", - "location": "query", - "type": "integer" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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, - "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}" - } - }, - "parameterOrder": [ - "project", - "resource" - ], - "flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy", - "id": "compute.snapshots.getIamPolicy", - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "response": { - "$ref": "Policy" - }, - "httpMethod": "GET" + "NetworkAttachmentList": { + "id": "NetworkAttachmentList", + "type": "object", + "properties": { + "kind": { + "type": "string", + "default": "compute#networkAttachmentList" }, - "setIamPolicy": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "id": "compute.snapshots.setIamPolicy", - "response": { - "$ref": "Policy" - }, - "flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy", - "request": { - "$ref": "GlobalSetPolicyRequest" - }, - "parameters": { - "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}", + "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": { + "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." + ], "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": { - "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", - "resource" - ] - }, - "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).", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "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" + "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" } }, - "flatPath": "projects/{project}/global/snapshots", - "path": "projects/{project}/global/snapshots", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "request": { - "$ref": "Snapshot" + "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" }, - "id": "compute.snapshots.insert", - "response": { - "$ref": "Operation" + "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" }, - "parameterOrder": [ - "project" + "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" ], - "httpMethod": "POST", - "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." + "enumDescriptions": [ + "Delete the VM.", + "Default value. This value is unused.", + "Stop the VM without storing in-memory content. default action." + ] }, - "setLabels": { - "parameterOrder": [ - "project", - "resource" + "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" ], - "description": "Sets the labels on a snapshot. 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" + "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." + ] + }, + "provisioningModel": { + "enumDescriptions": [ + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." ], - "request": { - "$ref": "GlobalSetLabelsRequest" - }, - "flatPath": "projects/{project}/global/snapshots/{resource}/setLabels", - "path": "projects/{project}/global/snapshots/{resource}/setLabels", - "httpMethod": "POST", - "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])?))" - }, - "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}" - } - }, - "id": "compute.snapshots.setLabels" + "type": "string", + "enum": [ + "SPOT", + "STANDARD" + ], + "description": "Specifies the provisioning model of the instance." }, - "delete": { - "path": "projects/{project}/global/snapshots/{snapshot}", - "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" - }, - "snapshot": { - "description": "Name of the Snapshot resource to delete.", - "type": "string", - "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" - } + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." + }, + "xpnProjectStatus": { + "enum": [ + "HOST", + "UNSPECIFIED_XPN_PROJECT_STATUS" ], - "response": { - "$ref": "Operation" + "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": [ + "", + "" + ] + }, + "quotas": { + "type": "array", + "items": { + "$ref": "Quota" }, - "parameterOrder": [ - "project", - "snapshot" - ], - "id": "compute.snapshots.delete", - "httpMethod": "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.", - "flatPath": "projects/{project}/global/snapshots/{snapshot}" + "description": "[Output Only] Quotas assigned to this project." }, - "get": { - "description": "Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.", - "parameterOrder": [ - "project", - "snapshot" + "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" ], - "parameters": { - "snapshot": { - "type": "string", - "description": "Name of the Snapshot resource to return.", - "required": true, - "location": "path", - "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" - } - }, - "id": "compute.snapshots.get", - "flatPath": "projects/{project}/global/snapshots/{snapshot}", - "httpMethod": "GET", - "path": "projects/{project}/global/snapshots/{snapshot}", - "response": { - "$ref": "Snapshot" + "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." + ], + "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "type": "array", + "description": "Restricted features enabled for use on this project." }, - "list": { - "description": "Retrieves the list of Snapshot resources contained within the specified project.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "vmDnsSetting": { + "enumDescriptions": [ + "", + "", + "", + "" ], - "parameterOrder": [ - "project" + "type": "string", + "enum": [ + "GLOBAL_DEFAULT", + "UNSPECIFIED_VM_DNS_SETTING", + "ZONAL_DEFAULT", + "ZONAL_ONLY" ], - "httpMethod": "GET", - "response": { - "$ref": "SnapshotList" - }, - "flatPath": "projects/{project}/global/snapshots", - "id": "compute.snapshots.list", - "path": "projects/{project}/global/snapshots", - "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" - }, - "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." - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." - }, - "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" - }, - "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] 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" } }, - "testIamPermissions": { - "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])?))" - }, - "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" - } - }, - "flatPath": "projects/{project}/global/snapshots/{resource}/testIamPermissions", - "path": "projects/{project}/global/snapshots/{resource}/testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.", - "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" + "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" ], - "request": { - "$ref": "TestPermissionsRequest" + "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" }, - "parameterOrder": [ - "project", - "resource" + "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" ], - "response": { - "$ref": "TestPermissionsResponse" - }, - "httpMethod": "POST" + "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" } } }, - "urlMaps": { - "methods": { - "update": { - "description": "Updates the specified UrlMap resource with the data included in the request.", - "id": "compute.urlMaps.update", - "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 + "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" + }, + "items": { + "type": "array", + "items": { + "$ref": "Subnetwork" + }, + "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" + }, + "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" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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" }, - "urlMap": { - "location": "path", - "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" + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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 UrlMap resource to update.", - "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." } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" + }, + "preservedState": { + "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.", + "$ref": "PreservedState" + }, + "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." ], - "request": { - "$ref": "UrlMap" + "type": "string", + "enum": [ + "APPLYING", + "DELETING", + "EFFECTIVE", + "NONE", + "UNAPPLIED", + "UNAPPLIED_DELETION" + ] + } + } + }, + "InstanceGroupsAddInstancesRequest": { + "type": "object", + "properties": { + "instances": { + "type": "array", + "items": { + "$ref": "InstanceReference" }, - "path": "projects/{project}/global/urlMaps/{urlMap}", - "parameterOrder": [ - "project", - "urlMap" + "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" ], - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "httpMethod": "PUT", - "response": { - "$ref": "Operation" - } - }, - "patch": { - "parameters": { - "urlMap": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the UrlMap resource to patch.", - "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": { - "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)." - } - }, - "path": "projects/{project}/global/urlMaps/{urlMap}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "parameterOrder": [ - "project", - "urlMap" + "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." ], - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "request": { - "$ref": "UrlMap" - }, - "httpMethod": "PATCH", - "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.", - "id": "compute.urlMaps.patch", - "response": { - "$ref": "Operation" - } + "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" + ] }, - "list": { - "flatPath": "projects/{project}/global/urlMaps", - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "UrlMapList" - }, - "path": "projects/{project}/global/urlMaps", - "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 UrlMap resources available to the specified project.", - "id": "compute.urlMaps.list", - "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." - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "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", - "minimum": "0", - "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" - }, - "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" - } - }, - "httpMethod": "GET" + "requestPath": { + "description": "The request path of the HTTP health check request. The default value is /.", + "type": "string" }, - "insert": { - "httpMethod": "POST", - "description": "Creates a UrlMap resource in the specified project using the data included in the request.", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/urlMaps", - "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" - }, - "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.urlMaps.insert", - "path": "projects/{project}/global/urlMaps", - "request": { - "$ref": "UrlMap" - }, - "parameterOrder": [ - "project" + "portName": { + "description": "Not supported.", + "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.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "proxyHeader": { + "enumDescriptions": [ + "", + "" ], - "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.", + "enum": [ + "NONE", + "PROXY_V1" ] }, - "get": { - "httpMethod": "GET", - "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.", - "parameterOrder": [ - "project", - "urlMap" - ], - "path": "projects/{project}/global/urlMaps/{urlMap}", - "id": "compute.urlMaps.get", - "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])?))" + "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" + }, + "type": "object", + "description": "A list of AddressesScopedList resources." + }, + "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.", + "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" }, - "urlMap": { - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the UrlMap resource to return.", + "message": { "type": "string", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." } + } + }, + "unreachables": { + "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" - ], - "response": { - "$ref": "UrlMap" + "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" }, - "flatPath": "projects/{project}/global/urlMaps/{urlMap}" + "description": "[Required] List of specifications of per-instance configs." + } + } + }, + "UrlMap": { + "type": "object", + "id": "UrlMap", + "properties": { + "description": { + "type": "string", + "description": "An optional description of this resource. Provide this property when you create the resource." }, - "delete": { - "parameterOrder": [ - "project", - "urlMap" - ], - "description": "Deletes the specified UrlMap resource.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "id": "compute.urlMaps.delete", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "path": "projects/{project}/global/urlMaps/{urlMap}", - "response": { - "$ref": "Operation" + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "tests": { + "type": "array", + "items": { + "$ref": "UrlMapTest" }, - "httpMethod": "DELETE", - "parameters": { - "urlMap": { + "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" + }, + "type": "array", + "description": "The list of host rules to use against the URL." + }, + "pathMatchers": { + "items": { + "$ref": "PathMatcher" + }, + "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])?" + }, + "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" + }, + "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" + ], "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 delete." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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.", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + "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": { - "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": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } } }, - "validate": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate", - "id": "compute.urlMaps.validate", - "parameters": { - "project": { + "commitments": { + "type": "array", + "description": "[Output Only] A list of commitments contained in this scope.", + "items": { + "$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" + }, + "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", - "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." + ] }, - "urlMap": { - "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}", - "required": true + "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\" } " + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } + } + } + }, + "type": "object" + }, + "PreservedState": { + "type": "object", + "description": "Preserved state for a given instance.", + "id": "PreservedState", + "properties": { + "metadata": { + "additionalProperties": { + "type": "string" }, - "httpMethod": "POST", - "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.", - "path": "projects/{project}/global/urlMaps/{urlMap}/validate", - "request": { - "$ref": "UrlMapsValidateRequest" + "type": "object", + "description": "Preserved metadata defined for this instance." + }, + "disks": { + "additionalProperties": { + "$ref": "PreservedStatePreservedDisk" }, - "response": { - "$ref": "UrlMapsValidateResponse" + "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." + }, + "healthStatus": { + "items": { + "$ref": "HealthStatus" }, - "parameterOrder": [ - "project", - "urlMap" - ] + "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." + } + }, + "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" }, - "invalidateCache": { - "parameterOrder": [ - "project", - "urlMap" + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "proxyHeader": { + "enum": [ + "NONE", + "PROXY_V1" ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "", + "" ], - "id": "compute.urlMaps.invalidateCache", - "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": { - "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)." - }, - "urlMap": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the UrlMap scoping this request.", - "location": "path", - "type": "string", - "required": true - } - }, - "httpMethod": "POST", - "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", - "request": { - "$ref": "CacheInvalidationRule" - }, - "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)." + "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." }, - "aggregatedList": { - "response": { - "$ref": "UrlMapsAggregatedList" - }, - "flatPath": "projects/{project}/aggregated/urlMaps", - "httpMethod": "GET", - "parameterOrder": [ - "project" + "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." + }, + "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" ], - "id": "compute.urlMaps.aggregatedList", - "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." - }, - "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", - "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" - }, - "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])?))", - "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." - }, - "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", - "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": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project.", - "path": "projects/{project}/aggregated/urlMaps", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + "enumDescriptions": [ + "", + "Autoscaling is disabled.", + "Autocaling is fully enabled.", + "Autoscaling will only scale out and will not remove nodes." + ], + "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" + }, + "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" + }, + "intervalSec": { + "description": "Interval over which the threshold is computed.", + "type": "integer", + "format": "int32" } } }, - "routers": { - "methods": { - "preview": { - "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.", - "httpMethod": "POST", - "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" + "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" ], - "response": { - "$ref": "RoutersPreviewResponse" - }, - "request": { - "$ref": "Router" - }, - "parameters": { - "router": { - "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 Router resource to query.", - "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" - }, - "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])?" - } - }, - "path": "projects/{project}/regions/{region}/routers/{router}/preview", - "parameterOrder": [ - "project", - "region", - "router" + "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." ] }, - "patch": { - "id": "compute.routers.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", - "description": "Project ID for this request.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "required": true, - "description": "Name of the region for this request.", - "location": "path", - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" - }, - "router": { - "location": "path", - "required": true, - "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}", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "PATCH", - "path": "projects/{project}/regions/{region}/routers/{router}", - "flatPath": "projects/{project}/regions/{region}/routers/{router}", - "request": { - "$ref": "Router" - }, - "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.", - "parameterOrder": [ - "project", - "region", - "router" - ], - "response": { - "$ref": "Operation" + "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" + ] } }, - "delete": { - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/regions/{region}/routers/{router}", - "id": "compute.routers.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "description": "Name of the region for this request.", - "location": "path", - "type": "string" - }, - "router": { - "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 delete.", - "type": "string", - "location": "path" - }, - "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 - }, - "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", - "region", - "router" - ], - "httpMethod": "DELETE", - "path": "projects/{project}/regions/{region}/routers/{router}", - "description": "Deletes the specified Router resource." + "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." }, - "getRouterStatus": { - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", - "id": "compute.routers.getRouterStatus", - "description": "Retrieves runtime information of the specified router.", - "response": { - "$ref": "RouterStatusResponse" - }, - "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" - }, - "router": { - "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 Router resource to query." - }, - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "location": "path", - "description": "Name of the region for this request.", - "type": "string", - "required": true - } + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "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.", + "type": "array", + "items": { + "$ref": "ExternalVpnGatewayInterface" + } + }, + "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" }, - "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/{router}/getRouterStatus", - "parameterOrder": [ - "project", - "region", - "router" - ] + "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." }, - "get": { - "response": { - "$ref": "Router" + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + } + } + }, + "RegionInstanceGroupManagersDeleteInstancesRequest": { + "id": "RegionInstanceGroupManagersDeleteInstancesRequest", + "properties": { + "instances": { + "type": "array", + "items": { + "type": "string" }, - "id": "compute.routers.get", - "flatPath": "projects/{project}/regions/{region}/routers/{router}", - "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" - ], - "parameters": { - "router": { - "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 return.", - "location": "path" + "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]." + }, + "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." + }, + "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)." + } + } + } }, - "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.", + "code": { "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." + ], + "description": "[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 for this request.", - "required": true, - "type": "string", - "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.", + "type": "string" } - }, - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/routers/{router}", - "description": "Returns the specified Router resource. Gets a list of available routers by making a list() request." + } }, - "insert": { - "description": "Creates a Router resource in the specified project and region using the data included in the request.", - "response": { - "$ref": "Operation" + "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" + }, + "etag": { + "type": "string" + }, + "unreachables": { + "items": { + "type": "string" }, - "request": { - "$ref": "Router" + "type": "array", + "description": "[Output Only] Unreachable resources." + }, + "items": { + "type": "object", + "additionalProperties": { + "$ref": "ResourcePoliciesScopedList", + "description": "Name of the scope containing this set of resourcePolicies." }, - "id": "compute.routers.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])?))", - "type": "string", - "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).", - "location": "query", - "type": "string" - }, - "region": { - "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": "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" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/regions/{region}/routers", - "path": "projects/{project}/regions/{region}/routers", - "parameterOrder": [ - "project", - "region" - ], - "httpMethod": "POST" + "description": "This is deprecated and has no effect. Do not use.", + "type": "array" }, - "getNatMappingInfo": { - "response": { - "$ref": "VmEndpointNatMappingsList" + "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" + }, + "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." + }, + "kind": { + "default": "compute#diskAggregatedList", + "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.", + "type": "string" + }, + "unreachables": { + "items": { + "type": "string" }, - "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", - "path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", - "parameters": { - "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" + "description": "[Output Only] Unreachable resources.", + "type": "array" + }, + "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" }, - "router": { - "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "code": { "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.", - "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" + "description": "[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." + ] }, - "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": { - "type": "string", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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" - }, - "maxResults": { - "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`)", - "format": "uint32", - "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." } - }, - "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 runtime Nat mapping information of VM endpoints.", - "parameterOrder": [ - "project", - "region", - "router" - ], - "id": "compute.routers.getNatMappingInfo" + } }, - "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" - }, - "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." - }, - "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", - "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": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request.", - "location": "path", - "required": true - }, - "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])?))" - } - }, - "parameterOrder": [ - "project", - "region" - ], - "id": "compute.routers.list", - "description": "Retrieves a list of Router resources available to the specified project.", - "path": "projects/{project}/regions/{region}/routers", - "response": { - "$ref": "RouterList" + "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" }, - "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", - "httpMethod": "GET" + "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" }, - "update": { - "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.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "region", - "router" - ], - "id": "compute.routers.update", - "parameters": { - "region": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request.", - "location": "path", - "required": true - }, - "router": { - "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", - "required": true + "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.", + "type": "string" }, - "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.", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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." }, - "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": { + "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" } - }, - "request": { - "$ref": "Router" - }, - "path": "projects/{project}/regions/{region}/routers/{router}", - "response": { - "$ref": "Operation" } }, - "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.", - "type": "string", - "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." - }, - "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", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "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." - }, - "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": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value 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" - } + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" }, - "response": { - "$ref": "RouterAggregatedList" + "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" + }, + "items": { + "additionalProperties": { + "description": "Name of the scope containing this set of packetMirrorings.", + "$ref": "PacketMirroringsScopedList" }, - "flatPath": "projects/{project}/aggregated/routers", - "id": "compute.routers.aggregatedList", - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/aggregated/routers", - "httpMethod": "GET", - "description": "Retrieves an aggregated list of routers." + "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" } } }, - "vpnGateways": { - "methods": { - "testIamPermissions": { - "response": { - "$ref": "TestPermissionsResponse" + "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" + } + } + }, + "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" }, - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "region": { - "required": true, - "description": "The name of the region for this request.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "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}", - "type": "string", - "location": "path", - "required": true - }, - "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." - } + "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" }, - "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" - ], - "request": { - "$ref": "TestPermissionsRequest" + "type": "array", + "description": "Headers to add the response before sending the response back to the client." + }, + "requestHeadersToAdd": { + "items": { + "$ref": "HttpHeaderOption" }, - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions" + "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" }, - "getStatus": { - "parameterOrder": [ - "project", - "region", - "vpnGateway" - ], - "httpMethod": "GET", - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", - "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." + "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" + }, + "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" + }, + "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": { + "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" + } + } + } + }, + "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" + }, + "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" + }, + "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 License resources.", + "type": "array", + "items": { + "$ref": "License" + } + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "type": "object", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "vpnGateway": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "description": "Name of the VPN gateway to return.", - "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\" } ", + "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" }, - "region": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "description": "Name of the region for this request.", - "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.", + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", - "id": "compute.vpnGateways.getStatus", - "response": { - "$ref": "VpnGatewaysGetStatusResponse" - }, - "description": "Returns the status for the specified VPN gateway.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] + } + } + }, + "id": "LicensesListResponse", + "type": "object" + }, + "TargetVpnGatewayList": { + "properties": { + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." }, - "get": { - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "parameterOrder": [ - "project", - "region", - "vpnGateway" - ], - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "httpMethod": "GET", - "response": { - "$ref": "VpnGateway" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "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." + "kind": { + "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", + "type": "string", + "default": "compute#targetVpnGatewayList" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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 + "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" }, - "vpnGateway": { - "description": "Name of the VPN gateway 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}" + "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" + } + } + } } }, - "description": "Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.", - "id": "compute.vpnGateways.get" + "type": "object" }, - "delete": { - "response": { - "$ref": "Operation" + "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" }, - "parameters": { - "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 - }, - "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)." - }, - "vpnGateway": { - "description": "Name of the VPN gateway to delete.", - "location": "path", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "type": "array", + "description": "A list of TargetVpnGateway resources." + } + }, + "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" }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": { "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." + ], + "description": "[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": { + "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." + } + } + } } }, - "id": "compute.vpnGateways.delete", - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "region", - "vpnGateway" - ], - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "description": "Deletes the specified VPN gateway.", - "httpMethod": "DELETE" + "type": "object", + "description": "Informational warning which replaces the list of routers when the list is empty." }, - "aggregatedList": { - "response": { - "$ref": "VpnGatewayAggregatedList" + "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" }, - "parameterOrder": [ - "project" + "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" ], - "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." - }, - "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`.", - "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": { - "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." - }, - "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": { - "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": "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" + "enumDescriptions": [ + "", + "", + "" ], - "flatPath": "projects/{project}/aggregated/vpnGateways", - "description": "Retrieves an aggregated list of VPN gateways." + "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`." }, - "insert": { - "flatPath": "projects/{project}/regions/{region}/vpnGateways", - "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 - }, - "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" + "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" } - }, - "request": { - "$ref": "VpnGateway" - }, - "description": "Creates a VPN gateway 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" - ], - "path": "projects/{project}/regions/{region}/vpnGateways", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "id": "compute.vpnGateways.insert" + } }, - "setLabels": { - "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "id": "compute.vpnGateways.setLabels", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "region": { - "required": true, - "description": "The region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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])?))" - }, - "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}", - "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" + "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" + }, + "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." + } } }, - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels" + "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.", + "type": "array" }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "id": "compute.vpnGateways.list", - "path": "projects/{project}/regions/{region}/vpnGateways", - "parameterOrder": [ - "project", - "region" - ], - "flatPath": "projects/{project}/regions/{region}/vpnGateways", - "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.", - "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`." - }, - "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", - "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" - }, - "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": { - "type": "string", - "required": true, - "description": "Name of the region for this request.", - "location": "path", - "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" - } - }, - "response": { - "$ref": "VpnGatewayList" - }, - "description": "Retrieves a list of VPN gateways available to the specified project and region." + "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" + }, + "insertTime": { + "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.", + "type": "string" + }, + "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" + }, + "statusMessage": { + "description": "[Output Only] An optional textual description of the current status of the operation.", + "type": "string" + }, + "zone": { + "type": "string", + "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations." + }, + "startTime": { + "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.", + "type": "string" + }, + "targetId": { + "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.", + "type": "string", + "format": "uint64" } } }, - "networkEndpointGroups": { - "methods": { - "insert": { - "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.", - "id": "compute.networkEndpointGroups.insert", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "zone" - ], - "path": "projects/{project}/zones/{zone}/networkEndpointGroups", - "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": { - "type": "string", - "required": true, - "description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.", - "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" - } - }, - "httpMethod": "POST", - "request": { - "$ref": "NetworkEndpointGroup" - } + "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": { + "description": "Configuration options for L7 DDoS detection.", + "properties": { + "enable": { + "type": "boolean", + "description": "If set to true, enables CAAP for L7 DDoS detection." }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "zone", - "networkEndpointGroup" + "ruleVisibility": { + "type": "string", + "enum": [ + "PREMIUM", + "STANDARD" ], - "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.", - "httpMethod": "DELETE", - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "enumDescriptions": [ + "", + "" ], - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", - "parameters": { - "networkEndpointGroup": { - "location": "path", - "type": "string", - "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", - "required": true - }, - "zone": { - "type": "string", - "required": true, - "location": "path", - "description": "The name of the zone where the network endpoint group is located. It should comply with 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])?))", - "type": "string", - "required": true, - "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.networkEndpointGroups.delete" + "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." }, - "list": { - "description": "Retrieves the list of network endpoint groups that are located in the specified project and zone.", - "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])?))" - }, - "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" - }, - "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" - }, - "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" - }, - "zone": { - "location": "path", - "type": "string", - "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", - "required": true - } - }, - "httpMethod": "GET", - "id": "compute.networkEndpointGroups.list", - "parameterOrder": [ - "project", - "zone" + "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)." ], - "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": "NetworkEndpointGroupList" - }, - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups", - "path": "projects/{project}/zones/{zone}/networkEndpointGroups" + "type": "string" }, - "aggregatedList": { - "description": "Retrieves the list of network endpoint groups and sorts them by zone.", - "id": "compute.networkEndpointGroups.aggregatedList", - "path": "projects/{project}/aggregated/networkEndpointGroups", - "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", - "response": { - "$ref": "NetworkEndpointGroupAggregatedList" - }, - "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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "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" - }, - "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": { - "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", - "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" - } + "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" }, - "flatPath": "projects/{project}/aggregated/networkEndpointGroups" + "description": "[Output Only] The list of PerInstanceConfig.", + "type": "array" }, - "listNetworkEndpoints": { - "httpMethod": "POST", - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", - "parameters": { - "maxResults": { - "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`)", - "default": "500", - "minimum": "0" - }, - "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": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", - "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" - }, - "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" + "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" }, - "networkEndpointGroup": { + "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", - "required": true, - "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." - }, - "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" + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ] }, - "orderBy": { + "message": { "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": "[Output Only] A human-readable description of the warning code." } }, - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", - "request": { - "$ref": "NetworkEndpointGroupsListEndpointsRequest" - }, - "response": { - "$ref": "NetworkEndpointGroupsListNetworkEndpoints" + "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." + }, + "ipv6EndpointType": { + "enum": [ + "NETLB", + "VM" + ], + "type": "string", + "enumDescriptions": [ + "Reserved IPv6 address can be used on network load balancer.", + "Reserved IPv6 address can be used on VM." + ], + "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" }, - "id": "compute.networkEndpointGroups.listNetworkEndpoints", - "parameterOrder": [ - "project", - "zone", - "networkEndpointGroup" + "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.*" + }, + "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", - "https://www.googleapis.com/auth/compute.readonly" + "type": "string", + "enum": [ + "FIXED_STANDARD", + "PREMIUM", + "STANDARD", + "STANDARD_OVERRIDES_FIXED_STANDARD" ], - "description": "Lists the network endpoints in the specified network endpoint group." + "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." }, - "testIamPermissions": { - "parameterOrder": [ - "project", - "zone", - "resource" + "kind": { + "type": "string", + "description": "[Output Only] Type of the resource. Always compute#address for addresses.", + "default": "compute#address" + }, + "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." ], - "id": "compute.networkEndpointGroups.testIamPermissions", - "parameters": { - "zone": { - "required": true, - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "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}", - "description": "Name or id of the resource for this request.", - "required": true, - "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])?))", - "description": "Project ID for this request.", - "required": true, - "location": "path" - } - }, - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{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" + "enum": [ + "DNS_RESOLVER", + "GCE_ENDPOINT", + "IPSEC_INTERCONNECT", + "NAT_AUTO", + "PRIVATE_SERVICE_CONNECT", + "SERVERLESS", + "SHARED_LOADBALANCER_VIP", + "VPC_PEERING" ], - "httpMethod": "POST", - "response": { - "$ref": "TestPermissionsResponse" - }, - "description": "Returns permissions that a caller has on the specified resource.", - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions" + "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. " }, - "attachNetworkEndpoints": { - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "request": { - "$ref": "NetworkEndpointGroupsAttachEndpointsRequest" - }, - "parameterOrder": [ - "project", - "zone", - "networkEndpointGroup" + "ipVersion": { + "enumDescriptions": [ + "", + "", + "" ], - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "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", + "enum": [ + "IPV4", + "IPV6", + "UNSPECIFIED_VERSION" + ] + }, + "addressType": { + "enum": [ + "EXTERNAL", + "INTERNAL", + "UNSPECIFIED_TYPE" ], - "id": "compute.networkEndpointGroups.attachNetworkEndpoints", - "description": "Attach a list of network endpoints to the specified network endpoint group.", - "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 - }, - "networkEndpointGroup": { - "required": true, - "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", + "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 " + } + }, + "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" + ], "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." }, - "zone": { - "required": true, - "type": "string", - "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", - "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)." + "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" + } } } }, - "get": { - "response": { - "$ref": "NetworkEndpointGroup" + "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" }, - "parameterOrder": [ - "project", - "zone", - "networkEndpointGroup" - ], - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", - "httpMethod": "GET", - "parameters": { - "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." + "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" + }, + "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": { + "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" }, - "networkEndpointGroup": { - "location": "path", - "required": true, - "description": "The name of the network endpoint group. It should comply with RFC1035.", + "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])?))", - "description": "Project ID for this request.", - "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" } }, - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", - "id": "compute.networkEndpointGroups.get", - "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" - ] + "description": "[Output Only] Informational warning message.", + "type": "object" + } + }, + "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" }, - "detachNetworkEndpoints": { - "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", - "parameters": { - "networkEndpointGroup": { - "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", - "type": "string", - "location": "path", - "required": true - }, - "project": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." + }, + "warning": { + "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, - "description": "Project ID for this request.", - "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", + "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" }, - "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." + "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" } }, - "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", - "response": { - "$ref": "Operation" + "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" }, - "parameterOrder": [ - "project", - "zone", - "networkEndpointGroup" - ], - "request": { - "$ref": "NetworkEndpointGroupsDetachEndpointsRequest" + "type": "array" + }, + "items": { + "additionalProperties": { + "$ref": "TargetTcpProxiesScopedList", + "description": "Name of the scope containing this set of TargetTcpProxies." }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "description": "Detach a list of network endpoints from the specified network endpoint group.", - "id": "compute.networkEndpointGroups.detachNetworkEndpoints" + "type": "object", + "description": "A list of TargetTcpProxiesScopedList resources." } - } + }, + "id": "TargetTcpProxyAggregatedList", + "type": "object" }, - "subnetworks": { - "methods": { - "setPrivateIpGoogleAccess": { - "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])?", - "description": "Name of the region scoping this request.", - "type": "string", - "location": "path", - "required": true - }, - "subnetwork": { - "description": "Name of the Subnetwork resource.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string", - "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." - } - }, - "request": { - "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" - }, - "response": { - "$ref": "Operation" + "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" + ], + "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": [ + "", + "", + "", + "", + "", + "", + "" + ] + }, + "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" }, - "parameterOrder": [ - "project", - "region", - "subnetwork" + "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" ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", - "id": "compute.subnetworks.setPrivateIpGoogleAccess", - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", - "httpMethod": "POST" + "type": "string" }, - "setIamPolicy": { - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", - "id": "compute.subnetworks.setIamPolicy", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "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}" - }, - "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])?))" - }, - "region": { - "type": "string", - "location": "path", - "required": true, - "description": "The name of the region for this request.", - "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" + }, + "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" }, - "request": { - "$ref": "RegionSetPolicyRequest" + "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" }, - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy." + "enum": [ + "FIXED_STANDARD", + "PREMIUM", + "STANDARD", + "STANDARD_OVERRIDES_FIXED_STANDARD" + ] }, - "delete": { - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "description": "Deletes the specified subnetwork.", - "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": { - "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.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "location": "path", - "required": true - }, - "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 delete.", - "location": "path", - "type": "string" - } - }, - "response": { - "$ref": "Operation" - }, - "id": "compute.subnetworks.delete", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "httpMethod": "DELETE", - "parameterOrder": [ - "project", - "region", - "subnetwork" + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" ] }, - "listUsable": { - "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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" - }, - "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" + "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" + ], + "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" }, - "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" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" }, - "project": { - "location": "path", + "code": { "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." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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." } + } + }, + "items": { + "description": "A list of TargetPool resources.", + "items": { + "$ref": "TargetPool" }, - "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}/aggregated/subnetworks/listUsable", - "response": { - "$ref": "UsableSubnetworksAggregatedList" + "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." + }, + "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" }, - "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", - "parameterOrder": [ - "project" - ], - "id": "compute.subnetworks.listUsable", - "description": "Retrieves an aggregated list of all usable subnetworks in the project." + "type": "array" }, - "testIamPermissions": { - "parameterOrder": [ - "project", - "region", - "resource" + "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." ], - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", - "response": { - "$ref": "TestPermissionsResponse" - }, - "id": "compute.subnetworks.testIamPermissions", - "httpMethod": "POST", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.", - "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "description": "The name of the region for this request.", - "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])?))", - "required": true, - "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}", - "type": "string", - "required": true, - "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" + "enum": [ + "DISABLE", + "ENABLE", + "NONE" ] }, - "getIamPolicy": { - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", - "httpMethod": "GET", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", - "response": { - "$ref": "Policy" + "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" + }, + "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" + } + } + }, + "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" }, - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "parameters": { - "region": { - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string", - "required": true, - "description": "The name of the region for this request.", - "location": "path" + "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" + }, + "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\" } " }, - "project": { + "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])?))", - "required": true, - "location": "path" - }, - "optionsRequestedPolicyVersion": { - "format": "int32", - "description": "Requested IAM Policy version.", - "type": "integer", - "location": "query" + "description": "[Output Only] A human-readable description of the warning code." }, - "resource": { - "required": true, - "description": "Name or id of the resource for this request.", + "code": { "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "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" + ] } + } + }, + "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" + }, + "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" }, - "id": "compute.subnetworks.getIamPolicy", - "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" - ] + "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" + }, + "name": { + "annotations": { + "required": [ + "compute.snapshots.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])?", + "type": "string" }, - "get": { - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "parameterOrder": [ - "project", - "region", - "subnetwork" - ], - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "id": "compute.subnetworks.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": { - "subnetwork": { - "description": "Name of the Subnetwork 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}" - }, - "region": { - "type": "string", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "description": "Name of the region scoping this request.", - "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])?))", - "location": "path", - "required": true, - "description": "Project ID for this request." - } + "storageLocations": { + "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", + "items": { + "type": "string" }, - "description": "Returns the specified subnetwork. Gets a list of available subnetworks list() request.", - "response": { - "$ref": "Subnetwork" + "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" } }, - "insert": { - "request": { - "$ref": "Subnetwork" - }, - "parameterOrder": [ - "project", - "region" + "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" + }, + "status": { + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "READY", + "UPLOADING" ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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." ], - "httpMethod": "POST", - "path": "projects/{project}/regions/{region}/subnetworks", - "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", - "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", - "required": true, - "description": "Name of the region scoping this request.", - "location": "path" - } - }, - "flatPath": "projects/{project}/regions/{region}/subnetworks", - "description": "Creates a subnetwork in the specified project using the data included in the request.", - "id": "compute.subnetworks.insert" + "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING." }, - "patch": { - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "request": { - "$ref": "Subnetwork" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" - }, - "httpMethod": "PATCH", - "parameterOrder": [ - "project", - "region", - "subnetwork" + "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" + }, + "snapshotType": { + "type": "string", + "enumDescriptions": [ + "", + "" ], - "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.", - "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", - "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])?))", - "type": "string", - "description": "Project ID for this request.", - "location": "path", - "required": true - }, - "drainTimeoutSeconds": { - "location": "query", - "format": "int32", - "type": "integer", - "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." - }, - "subnetwork": { - "location": "path", - "type": "string", - "description": "Name of the Subnetwork resource to patch.", - "required": true, - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "id": "compute.subnetworks.patch" + "description": "Indicates the type of the snapshot.", + "enum": [ + "ARCHIVE", + "STANDARD" + ] }, - "expandIpCidrRange": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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": [ + "", + "" ], - "response": { - "$ref": "Operation" - }, - "id": "compute.subnetworks.expandIpCidrRange", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "request": { - "$ref": "SubnetworksExpandIpCidrRangeRequest" - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "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" - }, - "subnetwork": { - "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 Subnetwork resource 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.", - "required": true, - "type": "string" - }, - "region": { - "required": true, - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - } - }, - "httpMethod": "POST", - "description": "Expands the IP CIDR range of the subnetwork to a specified value.", - "parameterOrder": [ - "project", - "region", - "subnetwork" + "enum": [ + "UPDATING", + "UP_TO_DATE" ] }, - "aggregatedList": { - "response": { - "$ref": "SubnetworkAggregatedList" - }, - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" ], - "description": "Retrieves an aggregated list of subnetworks.", - "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" - }, - "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." - }, - "maxResults": { - "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", - "format": "uint32" - }, - "project": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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": { - "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": { - "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" - } - }, - "path": "projects/{project}/aggregated/subnetworks", - "flatPath": "projects/{project}/aggregated/subnetworks", - "id": "compute.subnetworks.aggregatedList", - "parameterOrder": [ - "project" + "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.", + "type": "string", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" ] }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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" + } + }, + "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" ], - "path": "projects/{project}/regions/{region}/subnetworks", - "httpMethod": "GET", - "description": "Retrieves a list of subnetworks available to the specified project.", - "id": "compute.subnetworks.list", - "flatPath": "projects/{project}/regions/{region}/subnetworks", - "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" - }, - "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." - }, - "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": { - "default": "500", - "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`)" - }, - "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.", - "required": true, - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" - }, - "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" - } - }, - "parameterOrder": [ - "project", - "region" + "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." + ], + "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" + } + } + }, + "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" + ], + "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" + } + }, + "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)" ], - "response": { - "$ref": "SubnetworkList" + "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" + }, + "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." + }, + "rules": { + "type": "array", + "description": "A list of rules associated with this NAT.", + "items": { + "$ref": "RouterNatRule" } + }, + "drainNatIps": { + "type": "array", + "items": { + "type": "string" + }, + "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." } } }, - "networkFirewallPolicies": { - "methods": { - "addAssociation": { - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation", - "id": "compute.networkFirewallPolicies.addAssociation", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "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.", - "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", - "required": true, - "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" - }, - "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}" - } - }, - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation", - "request": { - "$ref": "FirewallPolicyAssociation" - }, - "description": "Inserts an association for the specified firewall policy." + "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" }, - "getRule": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "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." ], - "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", + "enum": [ + "FOUND", + "MOVED_PERMANENTLY_DEFAULT", + "PERMANENT_REDIRECT", + "SEE_OTHER", + "TEMPORARY_REDIRECT" + ] + }, + "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" + }, + "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." + }, + "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." + ], "type": "string", - "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" + ] }, - "firewallPolicy": { - "location": "path", + "message": { "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 rule belongs.", - "required": true + "description": "[Output Only] A human-readable description of the warning code." }, - "priority": { - "format": "int32", - "type": "integer", - "location": "query", - "description": "The priority of the rule to get from the firewall policy." + "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" + } } }, - "httpMethod": "GET", - "id": "compute.networkFirewallPolicies.getRule", - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", - "response": { - "$ref": "FirewallPolicyRule" + "type": "object", + "description": "[Output Only] An informational warning that appears when the nodeGroup list is empty." + }, + "nodeGroups": { + "items": { + "$ref": "NodeGroup" }, - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", - "description": "Gets a rule of the specified priority." + "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" }, - "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" - ], - "response": { - "$ref": "FirewallPolicyAssociation" + "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" }, - "description": "Gets an association with the specified name.", - "id": "compute.networkFirewallPolicies.getAssociation", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation", - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "query", - "description": "The name of the association to get from the firewall policy.", + "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" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "type": "object", + "properties": { + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "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." + ], "type": "string" }, - "firewallPolicy": { - "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 which the queried association belongs.", - "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", - "description": "Project ID for this request.", - "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\" } " } } }, - "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" - ], - "parameters": { - "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 get." - }, - "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])?))" - } - }, - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "response": { - "$ref": "FirewallPolicy" - }, - "httpMethod": "GET", - "id": "compute.networkFirewallPolicies.get", - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}" + "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." }, - "delete": { - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "description": "Deletes the specified policy.", - "id": "compute.networkFirewallPolicies.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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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": { - "description": "Name of the firewall policy to delete.", - "required": true, - "type": "string", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}" - } + "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" + ] }, - "httpMethod": "DELETE", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}", - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", - "response": { - "$ref": "Operation" + "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." + }, + "region": { + "description": "[Output Only] URI of the region where the packetMirroring resides.", + "type": "string" + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "network": { + "annotations": { + "required": [ + "compute.packetMirrorings.insert" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "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" }, - "removeAssociation": { - "httpMethod": "POST", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation", - "description": "Removes an association for the specified firewall policy.", - "parameterOrder": [ - "project", - "firewallPolicy" + "enable": { + "enum": [ + "FALSE", + "TRUE" ], - "id": "compute.networkFirewallPolicies.removeAssociation", - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation", - "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." - }, - "firewallPolicy": { - "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 firewall policy to update." - }, - "name": { - "location": "query", - "type": "string", - "description": "Name for the attachment that will be removed." - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "enumDescriptions": [ + "", + "" + ], + "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." + } + } + }, + "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." }, - "cloneRules": { - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules", - "id": "compute.networkFirewallPolicies.cloneRules", - "httpMethod": "POST", - "response": { - "$ref": "Operation" - }, - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules", - "parameterOrder": [ - "project", - "firewallPolicy" + "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" ], - "description": "Copies rules to the specified firewall policy.", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Guest CPUs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "The total number of snapshots allowed for a single project.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], - "parameters": { - "sourceFirewallPolicy": { - "description": "The firewall policy from which to copy rules.", - "location": "query", - "type": "string" - }, - "firewallPolicy": { - "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 firewall policy to update." - }, - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[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] Name of the quota metric." }, - "patch": { - "parameters": { - "requestId": { + "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": { "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." }, - "firewallPolicy": { - "location": "path", - "required": true, - "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}", - "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": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, 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": { - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-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" + ], "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." } - }, - "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.", - "id": "compute.networkFirewallPolicies.patch", - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "FirewallPolicy" - }, - "httpMethod": "PATCH", - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}" + } }, - "getIamPolicy": { - "id": "compute.networkFirewallPolicies.getIamPolicy", - "response": { - "$ref": "Policy" + "items": { + "items": { + "$ref": "HealthCheck" }, - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "parameterOrder": [ - "project", - "resource" - ], - "flatPath": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy", - "httpMethod": "GET", - "path": "projects/{project}/global/firewallPolicies/{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": { - "type": "integer", - "format": "int32", - "description": "Requested IAM Policy version.", - "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" - }, - "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" - } - } + "description": "A list of HealthCheck resources.", + "type": "array" }, - "addRule": { - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "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" ], - "parameterOrder": [ - "project", - "firewallPolicy" + "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": "FirewallPolicyRule" - }, - "httpMethod": "POST", - "description": "Inserts a rule into a firewall policy.", - "parameters": { - "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 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" - }, - "maxPriority": { - "type": "integer", - "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", - "location": "query" - }, - "minPriority": { - "type": "integer", - "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." - }, - "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." - } - }, - "id": "compute.networkFirewallPolicies.addRule", - "response": { - "$ref": "Operation" - }, - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule" + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", + "type": "string" }, - "patchRule": { - "description": "Patches a rule of the specified priority.", - "httpMethod": "POST", - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", - "response": { - "$ref": "Operation" + "deletionProtection": { + "type": "boolean", + "description": "Whether the instance created from this machine image should be protected against deletion." + }, + "labels": { + "additionalProperties": { + "type": "string" }, - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", - "request": { - "$ref": "FirewallPolicyRule" + "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" + }, + "guestAccelerators": { + "items": { + "$ref": "AcceleratorConfig" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "id": "compute.networkFirewallPolicies.patchRule", - "parameters": { - "priority": { - "type": "integer", - "description": "The priority of the rule to patch.", - "format": "int32", - "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)." - }, - "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 update.", - "type": "string", - "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])?))", - "description": "Project ID for this request.", - "required": true - } - } + "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", + "type": "array" }, - "removeRule": { - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "response": { - "$ref": "Operation" + "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" + }, + "description": { + "description": "An optional text description for the instances that are created from this machine image.", + "type": "string" + }, + "serviceAccounts": { + "items": { + "$ref": "ServiceAccount" }, - "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", - "description": "Deletes a rule of the specified priority.", - "id": "compute.networkFirewallPolicies.removeRule", - "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", - "parameterOrder": [ - "project", - "firewallPolicy" - ], - "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])?))" - }, - "priority": { - "description": "The priority of the rule to remove from the firewall policy.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "firewallPolicy": { - "location": "path", - "required": true, - "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}" - }, - "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": "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." + }, + "networkInterfaces": { + "description": "An array of network access configurations for this interface.", + "type": "array", + "items": { + "$ref": "NetworkInterface" } }, - "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": { - "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.", - "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`.", + "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." + }, + "disks": { + "type": "array", + "items": { + "$ref": "SavedAttachedDisk" + }, + "description": "An array of disks that are associated with the instances that are created from this machine image." + } + }, + "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.", "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." - }, - "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." + "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": { - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` 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", - "type": "integer" + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" } }, - "parameterOrder": [ - "project" - ], - "path": "projects/{project}/global/firewallPolicies", - "id": "compute.networkFirewallPolicies.list", - "response": { - "$ref": "FirewallPolicyList" + "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" }, - "flatPath": "projects/{project}/global/firewallPolicies", - "description": "Lists all the policies that have been configured for the specified project." + "type": "array" }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", - "id": "compute.networkFirewallPolicies.setIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "email": { + "description": "Email address of the service account.", + "type": "string" + } + }, + "description": "A service account." + }, + "SchedulingNodeAffinity": { + "properties": { + "operator": { + "enum": [ + "IN", + "NOT_IN", + "OPERATOR_UNSPECIFIED" ], - "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])?))", - "required": true, - "type": "string", - "location": "path", - "description": "Project ID for this request." - }, - "resource": { - "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}", - "required": true - } - }, - "parameterOrder": [ - "project", - "resource" + "enumDescriptions": [ + "Requires Compute Engine to seek for matched nodes.", + "Requires Compute Engine to avoid certain nodes.", + "" ], - "path": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", - "httpMethod": "POST" + "type": "string", + "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity." }, - "insert": { - "path": "projects/{project}/global/firewallPolicies", - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "projects/{project}/global/firewallPolicies", - "description": "Creates a new policy in the specified project using the data included in the request.", - "id": "compute.networkFirewallPolicies.insert", - "parameters": { - "requestId": { + "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" + } + }, + "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" + ], "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)." + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of 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", - "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" - } - }, - "response": { - "$ref": "Operation" - }, - "request": { - "$ref": "FirewallPolicy" - }, - "parameterOrder": [ - "project" - ] - }, - "testIamPermissions": { - "response": { - "$ref": "TestPermissionsResponse" - }, - "id": "compute.networkFirewallPolicies.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" - ], - "httpMethod": "POST", - "path": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions", - "flatPath": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions", - "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", + "message": { + "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, - "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}" + "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", - "resource" - ], - "request": { - "$ref": "TestPermissionsRequest" + "type": "object" + }, + "vpnGateways": { + "type": "array", + "description": "[Output Only] A list of VPN gateways contained in this scope.", + "items": { + "$ref": "VpnGateway" } } - } + }, + "type": "object" }, - "httpsHealthChecks": { - "methods": { - "update": { - "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.", - "id": "compute.httpsHealthChecks.update", - "parameterOrder": [ - "project", - "httpsHealthCheck" - ], - "httpMethod": "PUT", - "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "parameters": { - "httpsHealthCheck": { - "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}", - "type": "string", - "location": "path" + "CommitmentAggregatedList": { + "id": "CommitmentAggregatedList", + "properties": { + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "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." + ], + "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])?))", - "type": "string", - "description": "Project 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": { + "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": { + "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." } }, - "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "request": { - "$ref": "HttpsHealthCheck" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "delete": { - "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "response": { - "$ref": "Operation" + "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" }, - "description": "Deletes the specified HttpsHealthCheck resource.", - "id": "compute.httpsHealthChecks.delete", - "parameterOrder": [ - "project", - "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])?))", - "required": true, - "location": "path", - "type": "string" - }, - "httpsHealthCheck": { - "required": true, + "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" + }, + "warning": { + "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 HttpsHealthCheck resource to delete.", - "location": "path" + "description": "[Output Only] A human-readable description of the warning code." }, - "requestId": { - "location": "query", + "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)." + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_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": { + "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\" } " } }, - "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "DELETE" + "description": "[Output Only] Informational warning message.", + "type": "object" }, - "insert": { - "response": { - "$ref": "Operation" + "kind": { + "default": "compute#vpnTunnelAggregatedList", + "type": "string", + "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels." + }, + "unreachables": { + "type": "array", + "items": { + "type": "string" }, - "path": "projects/{project}/global/httpsHealthChecks", - "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.", - "request": { - "$ref": "HttpsHealthCheck" + "description": "[Output Only] Unreachable resources." + }, + "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" }, - "id": "compute.httpsHealthChecks.insert", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "httpMethod": "POST", - "flatPath": "projects/{project}/global/httpsHealthChecks", - "parameterOrder": [ - "project" - ], - "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", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-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": "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" } }, - "patch": { - "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "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.", - "id": "compute.httpsHealthChecks.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" - }, - "httpsHealthCheck": { - "required": true, - "description": "Name of the HttpsHealthCheck resource to patch.", - "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])?))", - "description": "Project ID for this request.", - "required": true, - "location": "path", - "type": "string" - } - }, - "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "httpMethod": "PATCH", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "project", - "httpsHealthCheck" + "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" + }, + "ruleMappings": { + "type": "array", + "description": "Information about mappings provided by rules in this NAT.", + "items": { + "$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings" + } + }, + "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." ], - "request": { - "$ref": "HttpsHealthCheck" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "type": "string", + "enum": [ + "AND", + "NO_AGGREGATION" ] }, - "get": { - "description": "Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.", - "response": { - "$ref": "HttpsHealthCheck" + "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" }, - "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", - "parameters": { - "httpsHealthCheck": { - "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 HttpsHealthCheck resource to return.", - "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." - } + "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}/global/httpsHealthChecks/{httpsHealthCheck}", - "httpMethod": "GET", - "id": "compute.httpsHealthChecks.get", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameterOrder": [ - "project", - "httpsHealthCheck" - ] + "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." }, - "list": { - "response": { - "$ref": "HttpsHealthCheckList" + "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" + }, + "notificationEndpoints": { + "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.httpsHealthChecks.list", - "parameterOrder": [ - "project" - ], - "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.", - "httpMethod": "GET", - "flatPath": "projects/{project}/global/httpsHealthChecks", - "path": "projects/{project}/global/httpsHealthChecks", - "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." - }, - "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`.", - "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" - }, - "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" - } - } + "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": "Represents a Health-Check as a Service resource.", + "type": "object", + "id": "HealthCheckService" } }, - "documentationLink": "https://cloud.google.com/compute/", + "title": "Compute Engine API", + "protocol": "rest", "id": "compute:v1", - "name": "compute", - "mtlsRootUrl": "https://compute.mtls.googleapis.com/", - "baseUrl": "https://compute.googleapis.com/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/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/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" + } + } + } + }, + "ownerName": "Google", + "revision": "20221126", + "basePath": "/compute/v1/", + "description": "Creates and runs virtual machines on Google Cloud Platform. ", + "rootUrl": "https://compute.googleapis.com/" } diff --git a/google/cloud/compute/v1/compute_gapic.yaml b/google/cloud/compute/v1/compute_gapic.yaml index aa1cc85a2..101e4488f 100755 --- a/google/cloud/compute/v1/compute_gapic.yaml +++ b/google/cloud/compute/v1/compute_gapic.yaml @@ -14,7 +14,7 @@ # Generated by the disco-to-proto3-converter. DO NOT EDIT! # Source Discovery file: compute.v1.json -# Source file revision: 20220831 +# Source file revision: 20221126 # API name: compute # API version: v1 @@ -910,6 +910,20 @@ interfaces: poll_delay_multiplier: 1.5 max_poll_delay_millis: 20000 total_poll_timeout_millis: 600000 +- name: google.cloud.compute.v1.NetworkAttachments + methods: + - name: Delete + long_running: + initial_poll_delay_millis: 500 + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 20000 + total_poll_timeout_millis: 600000 + - name: Insert + long_running: + initial_poll_delay_millis: 500 + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 20000 + total_poll_timeout_millis: 600000 - name: google.cloud.compute.v1.NetworkEdgeSecurityServices methods: - name: Delete diff --git a/google/cloud/compute/v1/compute_grpc_service_config.json b/google/cloud/compute/v1/compute_grpc_service_config.json index c81563533..90b2d440f 100755 --- a/google/cloud/compute/v1/compute_grpc_service_config.json +++ b/google/cloud/compute/v1/compute_grpc_service_config.json @@ -282,6 +282,18 @@ }, { "service" : "google.cloud.compute.v1.MachineTypes", "method" : "List" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "AggregatedList" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "Get" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "GetIamPolicy" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "List" }, { "service" : "google.cloud.compute.v1.NetworkEdgeSecurityServices", "method" : "AggregatedList" @@ -708,6 +720,9 @@ }, { "service" : "google.cloud.compute.v1.TargetSslProxies", "method" : "List" + }, { + "service" : "google.cloud.compute.v1.TargetTcpProxies", + "method" : "AggregatedList" }, { "service" : "google.cloud.compute.v1.TargetTcpProxies", "method" : "Get" @@ -1272,6 +1287,18 @@ }, { "service" : "google.cloud.compute.v1.MachineImages", "method" : "TestIamPermissions" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "Delete" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "Insert" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "SetIamPolicy" + }, { + "service" : "google.cloud.compute.v1.NetworkAttachments", + "method" : "TestIamPermissions" }, { "service" : "google.cloud.compute.v1.NetworkEdgeSecurityServices", "method" : "Delete" diff --git a/google/cloud/connectors/v1/BUILD.bazel b/google/cloud/connectors/v1/BUILD.bazel index c86271f9b..551c7df34 100644 --- a/google/cloud/connectors/v1/BUILD.bazel +++ b/google/cloud/connectors/v1/BUILD.bazel @@ -81,6 +81,7 @@ java_gapic_library( srcs = [":connectors_proto_with_info"], gapic_yaml = None, grpc_service_config = "connectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", test_deps = [ ":connectors_java_grpc", @@ -146,6 +147,7 @@ go_gapic_library( grpc_service_config = "connectors_grpc_service_config.json", importpath = "cloud.google.com/go/connectors/apiv1;connectors", metadata = True, + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", transport = "grpc+rest", deps = [ @@ -153,8 +155,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -191,6 +193,7 @@ py_gapic_library( name = "connectors_py_gapic", srcs = [":connectors_proto"], grpc_service_config = "connectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", transport = "grpc", deps = [ @@ -242,7 +245,9 @@ php_gapic_library( name = "connectors_php_gapic", srcs = [":connectors_proto_with_info"], grpc_service_config = "connectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", + transport = "grpc+rest", deps = [ ":connectors_php_grpc", ":connectors_php_proto", @@ -275,7 +280,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "connectors_grpc_service_config.json", package = "google.cloud.connectors.v1", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -316,6 +323,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-connectors-v1", ], grpc_service_config = "connectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", deps = [ ":connectors_ruby_grpc", @@ -360,6 +368,7 @@ csharp_gapic_library( srcs = [":connectors_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "connectors_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "connectors_v1.yaml", deps = [ ":connectors_csharp_grpc", diff --git a/google/cloud/contactcenterinsights/v1/BUILD.bazel b/google/cloud/contactcenterinsights/v1/BUILD.bazel index a194b6191..61f30800f 100644 --- a/google/cloud/contactcenterinsights/v1/BUILD.bazel +++ b/google/cloud/contactcenterinsights/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( name = "contactcenterinsights_java_gapic", srcs = [":contactcenterinsights_proto_with_info"], grpc_service_config = "contactcenterinsights_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":contactcenterinsights_java_grpc", ], @@ -133,13 +134,14 @@ go_gapic_library( grpc_service_config = "contactcenterinsights_grpc_service_config.json", importpath = "cloud.google.com/go/contactcenterinsights/apiv1;contactcenterinsights", metadata = True, + rest_numeric_enums = True, service_yaml = "contactcenterinsights_v1.yaml", transport = "grpc+rest", deps = [ ":contactcenterinsights_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -181,6 +183,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=contact_center_insights", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -228,7 +231,9 @@ php_gapic_library( name = "contactcenterinsights_php_gapic", srcs = [":contactcenterinsights_proto_with_info"], grpc_service_config = "contactcenterinsights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contactcenterinsights_v1.yaml", + transport = "grpc+rest", deps = [ ":contactcenterinsights_php_grpc", ":contactcenterinsights_php_proto", @@ -261,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "contactcenterinsights_grpc_service_config.json", package = "google.cloud.contactcenterinsights.v1", + rest_numeric_enums = True, service_yaml = "contactcenterinsights_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=contactcenterinsights", ], grpc_service_config = "contactcenterinsights_grpc_service_config.json", + 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", deps = [ @@ -350,6 +358,7 @@ csharp_gapic_library( srcs = [":contactcenterinsights_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "contactcenterinsights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contactcenterinsights_v1.yaml", deps = [ ":contactcenterinsights_csharp_grpc", diff --git a/google/cloud/contactcenterinsights/v1/contact_center_insights.proto b/google/cloud/contactcenterinsights/v1/contact_center_insights.proto index c5956b93f..1ecf43216 100644 --- a/google/cloud/contactcenterinsights/v1/contact_center_insights.proto +++ b/google/cloud/contactcenterinsights/v1/contact_center_insights.proto @@ -121,6 +121,33 @@ service ContactCenterInsights { option (google.api.method_signature) = "name"; } + // Analyzes multiple conversations in a single request. + rpc BulkAnalyzeConversations(BulkAnalyzeConversationsRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/conversations:bulkAnalyze" + body: "*" + }; + option (google.api.method_signature) = "parent,filter,analysis_percentage"; + option (google.longrunning.operation_info) = { + response_type: "BulkAnalyzeConversationsResponse" + metadata_type: "BulkAnalyzeConversationsMetadata" + }; + } + + // Imports conversations and processes them according to the user's + // configuration. + rpc IngestConversations(IngestConversationsRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/conversations:ingest" + body: "*" + }; + option (google.api.method_signature) = "parent"; + option (google.longrunning.operation_info) = { + response_type: "IngestConversationsResponse" + metadata_type: "IngestConversationsMetadata" + }; + } + // Export insights data to a destination defined in the request body. rpc ExportInsightsData(ExportInsightsDataRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -237,6 +264,14 @@ service ContactCenterInsights { option (google.api.method_signature) = "issue,update_mask"; } + // Deletes an issue. + rpc DeleteIssue(DeleteIssueRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/issueModels/*/issues/*}" + }; + option (google.api.method_signature) = "name"; + } + // Gets an issue model's statistics. rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest) returns (CalculateIssueModelStatsResponse) { option (google.api.http) = { @@ -456,6 +491,9 @@ message CreateAnalysisOperationMetadata { type: "contactcenterinsights.googleapis.com/Conversation" } ]; + + // Output only. The annotator selector used for the analysis (if any). + AnnotatorSelector annotator_selector = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Request to create a conversation. @@ -559,6 +597,73 @@ message DeleteConversationRequest { bool force = 2; } +// The request to ingest conversations. +message IngestConversationsRequest { + // Configuration for Cloud Storage bucket sources. + message GcsSource { + // Required. The Cloud Storage bucket containing source objects. + string bucket_uri = 1 [(google.api.field_behavior) = REQUIRED]; + } + + // Configuration for processing transcript objects. + message TranscriptObjectConfig { + // Required. The medium transcript objects represent. + Conversation.Medium medium = 1 [(google.api.field_behavior) = REQUIRED]; + } + + // Configuration that applies to all conversations. + message ConversationConfig { + // An opaque, user-specified string representing the human agent who handled + // the conversations. + string agent_id = 1; + } + + // Configuration for an external data store containing objects that will + // be converted to conversations. + oneof source { + // A cloud storage bucket source. + GcsSource gcs_source = 2; + } + + // Configuration for converting individual `source` objects to conversations. + oneof object_config { + // Configuration for when `source` contains conversation transcripts. + TranscriptObjectConfig transcript_object_config = 3; + } + + // Required. The parent resource for new conversations. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Configuration that applies to all conversations. + ConversationConfig conversation_config = 4; +} + +// The metadata for an IngestConversations operation. +message IngestConversationsMetadata { + // 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. The original request for ingest. + 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]; +} + +// The response to an IngestConversations operation. +message IngestConversationsResponse { + +} + // The request to create an analysis. message CreateAnalysisRequest { // Required. The parent resource of the analysis. @@ -631,6 +736,59 @@ message DeleteAnalysisRequest { ]; } +// The request to analyze conversations in bulk. +message BulkAnalyzeConversationsRequest { + // Required. The parent resource to create analyses in. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Required. Filter used to select the subset of conversations to analyze. + string filter = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Percentage of selected conversation to analyze, between + // [0, 100]. + float analysis_percentage = 3 [(google.api.field_behavior) = REQUIRED]; + + // 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 = 8; +} + +// The metadata for a bulk analyze conversations operation. +message BulkAnalyzeConversationsMetadata { + // The time the operation was created. + google.protobuf.Timestamp create_time = 1; + + // The time the operation finished running. + google.protobuf.Timestamp end_time = 2; + + // The original request for bulk analyze. + BulkAnalyzeConversationsRequest request = 3; + + // The number of requested analyses that have completed successfully so far. + int32 completed_analyses_count = 4; + + // The number of requested analyses that have failed so far. + int32 failed_analyses_count = 5; + + // Total number of analyses requested. Computed by the number of conversations + // returned by `filter` multiplied by `analysis_percentage` in the request. + int32 total_requested_analyses_count = 6; +} + +// The response for a bulk analyze conversations operation. +message BulkAnalyzeConversationsResponse { + // Count of successful analyses. + int32 successful_analysis_count = 1; + + // Count of failed analyses. + int32 failed_analysis_count = 2; +} + // The request to export insights. message ExportInsightsDataRequest { // A BigQuery Table Reference. @@ -891,6 +1049,17 @@ message UpdateIssueRequest { google.protobuf.FieldMask update_mask = 2; } +// The request to delete an issue. +message DeleteIssueRequest { + // Required. The name of the issue to delete. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "contactcenterinsights.googleapis.com/Issue" + } + ]; +} + // Request to get statistics of an issue model. message CalculateIssueModelStatsRequest { // Required. The resource name of the issue model to query against. diff --git a/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml b/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml index 61af22367..c610755bd 100644 --- a/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml +++ b/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml @@ -8,6 +8,8 @@ apis: - name: google.longrunning.Operations types: +- name: google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsMetadata +- name: google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsResponse - name: google.cloud.contactcenterinsights.v1.CreateAnalysisOperationMetadata - name: google.cloud.contactcenterinsights.v1.CreateIssueModelMetadata - name: google.cloud.contactcenterinsights.v1.DeleteIssueModelMetadata @@ -15,6 +17,8 @@ types: - name: google.cloud.contactcenterinsights.v1.DeployIssueModelResponse - name: google.cloud.contactcenterinsights.v1.ExportInsightsDataMetadata - name: google.cloud.contactcenterinsights.v1.ExportInsightsDataResponse +- name: google.cloud.contactcenterinsights.v1.IngestConversationsMetadata +- name: google.cloud.contactcenterinsights.v1.IngestConversationsResponse - name: google.cloud.contactcenterinsights.v1.UndeployIssueModelMetadata - name: google.cloud.contactcenterinsights.v1.UndeployIssueModelResponse @@ -37,3 +41,6 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/cloud/contactcenterinsights/v1/resources.proto b/google/cloud/contactcenterinsights/v1/resources.proto index bac8515aa..715eff611 100644 --- a/google/cloud/contactcenterinsights/v1/resources.proto +++ b/google/cloud/contactcenterinsights/v1/resources.proto @@ -227,6 +227,10 @@ message Analysis { // 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. + AnnotatorSelector annotator_selector = 8; } // The conversation source, which is a combination of transcript and audio. @@ -356,6 +360,9 @@ message CallAnnotation { // Data specifying a phrase match. PhraseMatchData phrase_match_data = 17; + + // Data specifying an issue match. + IssueMatchData issue_match_data = 18; } // The channel of the audio where the annotation occurs. For single-channel @@ -579,6 +586,12 @@ message SentimentData { float score = 2; } +// The data for an issue match annotation. +message IssueMatchData { + // Information about the issue's assignment. + IssueAssignment issue_assignment = 1; +} + // The issue model resource. message IssueModel { option (google.api.resource) = { @@ -670,6 +683,10 @@ message Issue { // Output only. The most recent time that this issue was updated. 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]; } // Aggregated statistics about an issue model. @@ -828,6 +845,10 @@ message Settings { // Percentage of conversations created using Dialogflow runtime integration // to analyze automatically, between [0, 100]. double runtime_integration_analysis_percentage = 1; + + // 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; } // Immutable. The resource name of the settings resource. @@ -1114,3 +1135,46 @@ message View { // String with specific view properties. string value = 5; } + +// Selector of all available annotators and phrase matchers to run. +message AnnotatorSelector { + // Whether to run the interruption annotator. + bool run_interruption_annotator = 1; + + // Whether to run the silence annotator. + bool run_silence_annotator = 2; + + // Whether to run the active phrase matcher annotator(s). + bool run_phrase_matcher_annotator = 3; + + // The list of phrase matchers to run. If not provided, all active phrase + // matchers will be used. If inactive phrase matchers are provided, they will + // not be used. Phrase matchers will be run only if + // 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" + }]; + + // Whether to run the sentiment annotator. + bool run_sentiment_annotator = 5; + + // Whether to run the entity annotator. + bool run_entity_annotator = 6; + + // Whether to run the intent annotator. + bool run_intent_annotator = 7; + + // Whether to run the issue model annotator. A model should have already been + // deployed for this to take effect. + bool run_issue_model_annotator = 8; + + // The issue model to run. If not provided, the most recently deployed topic + // model will be used. The provided issue model will only be used for + // inference if the issue model is deployed and if run_issue_model_annotator + // 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" + }]; +} diff --git a/google/cloud/contentwarehouse/v1/BUILD.bazel b/google/cloud/contentwarehouse/v1/BUILD.bazel index 2b9ad8ce0..0b1ab9c0a 100644 --- a/google/cloud/contentwarehouse/v1/BUILD.bazel +++ b/google/cloud/contentwarehouse/v1/BUILD.bazel @@ -90,6 +90,7 @@ java_gapic_library( srcs = [":contentwarehouse_proto_with_info"], gapic_yaml = None, grpc_service_config = "contentwarehouse_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", test_deps = [ ":contentwarehouse_java_grpc", @@ -109,13 +110,13 @@ java_gapic_test( test_classes = [ "com.google.cloud.contentwarehouse.v1.DocumentLinkServiceClientHttpJsonTest", "com.google.cloud.contentwarehouse.v1.DocumentLinkServiceClientTest", -# "com.google.cloud.contentwarehouse.v1.DocumentSchemaServiceClientHttpJsonTest", + # "com.google.cloud.contentwarehouse.v1.DocumentSchemaServiceClientHttpJsonTest", "com.google.cloud.contentwarehouse.v1.DocumentSchemaServiceClientTest", -# "com.google.cloud.contentwarehouse.v1.DocumentServiceClientHttpJsonTest", + # "com.google.cloud.contentwarehouse.v1.DocumentServiceClientHttpJsonTest", "com.google.cloud.contentwarehouse.v1.DocumentServiceClientTest", -# "com.google.cloud.contentwarehouse.v1.RuleSetServiceClientHttpJsonTest", + # "com.google.cloud.contentwarehouse.v1.RuleSetServiceClientHttpJsonTest", "com.google.cloud.contentwarehouse.v1.RuleSetServiceClientTest", -# "com.google.cloud.contentwarehouse.v1.SynonymSetServiceClientHttpJsonTest", + # "com.google.cloud.contentwarehouse.v1.SynonymSetServiceClientHttpJsonTest", "com.google.cloud.contentwarehouse.v1.SynonymSetServiceClientTest", ], runtime_deps = [":contentwarehouse_java_gapic_test"], @@ -124,6 +125,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-contentwarehouse-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":contentwarehouse_java_gapic", @@ -131,7 +133,6 @@ java_gapic_assembly_gradle_pkg( ":contentwarehouse_java_proto", ":contentwarehouse_proto", ], - include_samples = True, ) ############################################################################## @@ -165,9 +166,9 @@ go_gapic_library( grpc_service_config = "contentwarehouse_grpc_service_config.json", importpath = "cloud.google.com/go/contentwarehouse/apiv1;contentwarehouse", metadata = True, + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", transport = "grpc+rest", - rest_numeric_enums = True, deps = [ ":contentwarehouse_go_proto", "//google/iam/v1:iam_go_proto", @@ -187,8 +188,8 @@ go_gapic_assembly_pkg( name = "gapi-cloud-contentwarehouse-v1-go", deps = [ ":contentwarehouse_go_gapic", - ":contentwarehouse_go_gapic_srcjar-test.srcjar", ":contentwarehouse_go_gapic_srcjar-metadata.srcjar", + ":contentwarehouse_go_gapic_srcjar-test.srcjar", ":contentwarehouse_go_proto", ], ) @@ -207,24 +208,25 @@ py_gapic_library( name = "contentwarehouse_py_gapic", srcs = [":contentwarehouse_proto"], grpc_service_config = "contentwarehouse_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", deps = [ + "//google/cloud/documentai/v1:documentai_py_proto", "//google/iam/v1:iam_policy_py_proto", ], ) -# TODO(b/246640328): Test fails due to a dependency on docai at runtime -# py_test( -# name = "contentwarehouse_py_gapic_test", -# srcs = [ -# "contentwarehouse_py_gapic_pytest.py", -# "contentwarehouse_py_gapic_test.py", -# ], -# legacy_create_init = False, -# deps = [ -# ":contentwarehouse_py_gapic", -# ], -#) +py_test( + name = "contentwarehouse_py_gapic_test", + srcs = [ + "contentwarehouse_py_gapic_pytest.py", + "contentwarehouse_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [ + ":contentwarehouse_py_gapic", + ], +) # Open Source Packages py_gapic_assembly_pkg( @@ -260,7 +262,9 @@ php_gapic_library( name = "contentwarehouse_php_gapic", srcs = [":contentwarehouse_proto_with_info"], grpc_service_config = "contentwarehouse_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", + transport = "grpc+rest", deps = [ ":contentwarehouse_php_grpc", ":contentwarehouse_php_proto", @@ -293,7 +297,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "contentwarehouse_grpc_service_config.json", package = "google.cloud.contentwarehouse.v1", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,8 +318,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", ) @@ -336,6 +342,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-contentwarehouse-v1", ], grpc_service_config = "contentwarehouse_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", deps = [ ":contentwarehouse_ruby_grpc", @@ -380,6 +387,7 @@ csharp_gapic_library( srcs = [":contentwarehouse_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "contentwarehouse_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "contentwarehouse_v1.yaml", deps = [ ":contentwarehouse_csharp_grpc", diff --git a/google/cloud/contentwarehouse/v1/document.proto b/google/cloud/contentwarehouse/v1/document.proto index bd19863df..5ec6c2ec6 100644 --- a/google/cloud/contentwarehouse/v1/document.proto +++ b/google/cloud/contentwarehouse/v1/document.proto @@ -28,8 +28,6 @@ option java_outer_classname = "DocumentProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; // Defines the structure for content warehouse document proto. -// -// Next ID: 20 message Document { option (google.api.resource) = { type: "contentwarehouse.googleapis.com/Document" @@ -186,10 +184,6 @@ message Property { // Timestamp property values. // It is not supported by CMEK compliant deployment. TimestampArray timestamp_values = 9; - - // Boolean property values. - // It is not supported by CMEK compliant deployment. - BooleanArray boolean_values = 10; } } @@ -230,12 +224,6 @@ message TimestampArray { repeated TimestampValue values = 1; } -// Boolean values. -message BooleanArray { - // List of bool values. - repeated bool values = 1; -} - // Timestamp value type. message TimestampValue { oneof value { diff --git a/google/cloud/contentwarehouse/v1/document_schema.proto b/google/cloud/contentwarehouse/v1/document_schema.proto index 58f9ac55e..fae52e4c5 100644 --- a/google/cloud/contentwarehouse/v1/document_schema.proto +++ b/google/cloud/contentwarehouse/v1/document_schema.proto @@ -60,8 +60,6 @@ message DocumentSchema { } // Defines the metadata for a schema property. -// -// Next ID: 18 message PropertyDefinition { // Required. The name of the metadata property. // Must be unique within a document schema and is case insensitive. @@ -117,10 +115,6 @@ message PropertyDefinition { // Timestamp property. // It is not supported by CMEK compliant deployment. TimestampTypeOptions timestamp_type_options = 16; - - // Boolean property. - // It is not supported by CMEK compliant deployment. - BooleanTypeOptions boolean_type_options = 17; } } @@ -154,11 +148,6 @@ message TimestampTypeOptions { } -// Configurations for a boolean property. -message BooleanTypeOptions { - -} - // Configurations for a nested structured data property. message PropertyTypeOptions { // Required. List of property definitions. @@ -169,4 +158,9 @@ message PropertyTypeOptions { message EnumTypeOptions { // Required. List of possible enum values. repeated string possible_values = 1 [(google.api.field_behavior) = REQUIRED]; + + // Make sure the Enum property value provided in the document is in the + // possile value list during document creation. The validation check runs by + // default. + bool validation_check_disabled = 2; } diff --git a/google/cloud/contentwarehouse/v1/document_schema_service.proto b/google/cloud/contentwarehouse/v1/document_schema_service.proto index 62d0bfa3e..9c5706950 100644 --- a/google/cloud/contentwarehouse/v1/document_schema_service.proto +++ b/google/cloud/contentwarehouse/v1/document_schema_service.proto @@ -28,6 +28,9 @@ option java_multiple_files = true; option java_outer_classname = "DocumentSchemaServiceProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; +// (go/id-aip-list) to add a finite deadline and enable fail_fast. + +// This service lets you manage document schema. service DocumentSchemaService { option (google.api.default_host) = "contentwarehouse.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; @@ -43,14 +46,16 @@ service DocumentSchemaService { // Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the // Document Schema is non-empty and does not equal the existing name. - // Supports only appending new properties and updating existing properties - // will result into INVALID_ARGUMENT. + // Supports only appending new properties, adding new ENUM possible values, + // and updating the [EnumTypeOptions.validation_check_disabled][google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled] flag for + // ENUM possible values. Updating existing properties will result into + // INVALID_ARGUMENT. rpc UpdateDocumentSchema(UpdateDocumentSchemaRequest) returns (DocumentSchema) { option (google.api.http) = { patch: "/v1/{name=projects/*/locations/*/documentSchemas/*}" body: "*" }; - option (google.api.method_signature) = "document_schema"; + option (google.api.method_signature) = "name,document_schema"; } // Gets a document schema. Returns NOT_FOUND if the document schema does not @@ -63,7 +68,8 @@ service DocumentSchemaService { } // Deletes a document schema. Returns NOT_FOUND if the document schema does - // not exist. + // not exist. Returns BAD_REQUEST if the document schema has documents + // depending on it. rpc DeleteDocumentSchema(DeleteDocumentSchemaRequest) returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/documentSchemas/*}" diff --git a/google/cloud/contentwarehouse/v1/document_service.proto b/google/cloud/contentwarehouse/v1/document_service.proto index c844fe1b8..e0c1c8750 100644 --- a/google/cloud/contentwarehouse/v1/document_service.proto +++ b/google/cloud/contentwarehouse/v1/document_service.proto @@ -32,6 +32,7 @@ option java_multiple_files = true; option java_outer_classname = "DocumentServiceProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; +// This service lets you manage document. service DocumentService { option (google.api.default_host) = "contentwarehouse.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; @@ -69,7 +70,7 @@ service DocumentService { body: "*" } }; - option (google.api.method_signature) = "document"; + option (google.api.method_signature) = "name,document"; } // Deletes a document. Returns NOT_FOUND if the document does not exist. @@ -212,7 +213,10 @@ message SearchDocumentsResponse { // The total number of matched documents which is available only if the client // set [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size] to `true`. Otherwise, the - // value will be `-1`. + // value will be `-1`. `total_size` will max at "100,000". If this + // is returned, then it can be assumed that the count is equal to or greater + // than 100,000. Typically a UI would handle this condition by displaying + // "of many", for example: "Displaying 10 of many". int32 total_size = 3; // Additional information for the API invocation, such as the request tracking diff --git a/google/cloud/contentwarehouse/v1/document_service_request.proto b/google/cloud/contentwarehouse/v1/document_service_request.proto index f6782c320..635bfdb65 100644 --- a/google/cloud/contentwarehouse/v1/document_service_request.proto +++ b/google/cloud/contentwarehouse/v1/document_service_request.proto @@ -73,8 +73,6 @@ message CreateDocumentRequest { } // Request message for DocumentService.GetDocument. -// -// Next ID: 4 message GetDocumentRequest { // Required. The name of the document to retrieve. // Format: @@ -139,6 +137,7 @@ message DeleteDocumentRequest { RequestMetadata request_metadata = 2; } +// Request message for DocumentService.SearchDocuments. message SearchDocumentsRequest { // Required. The parent, which owns this collection of documents. // Format: projects/{project_number}/locations/{location}. @@ -205,7 +204,7 @@ message SearchDocumentsRequest { // // * Histogram facet (aka filterable properties): Facet names with format // <schema id>.<facet>. Facets will have the - // format of: [a-zA-Z][a-zA-Z0-9_:/-.]. If the facet is a child + // format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child // facet, then the parent hierarchy needs to be specified separated by // dots in the prefix after the schema id. Thus, the format for a multi- // level facet is: <schema id>.<parent facet name>. @@ -227,7 +226,9 @@ message SearchDocumentsRequest { // Optional. Controls if the search document request requires the return of a total size // of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. // - // Enabling this flag may adversely impact performance. + // Enabling this flag may adversely impact performance. Hint: If this is + // used with pagination, set this flag on the initial query but set this + // to false on subsequent page calls (keep the total count locally). // // Defaults to false. bool require_total_size = 10; diff --git a/google/cloud/contentwarehouse/v1/filters.proto b/google/cloud/contentwarehouse/v1/filters.proto index 7a6654b77..52e39ca90 100644 --- a/google/cloud/contentwarehouse/v1/filters.proto +++ b/google/cloud/contentwarehouse/v1/filters.proto @@ -24,7 +24,6 @@ option java_multiple_files = true; option java_outer_classname = "FiltersProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; -// NEXT_ID: 13 message DocumentQuery { // The query string that matches against the full text of the document and // the searchable properties. diff --git a/google/cloud/contentwarehouse/v1/rule_engine.proto b/google/cloud/contentwarehouse/v1/rule_engine.proto index 81c7f36c7..7badc7b78 100644 --- a/google/cloud/contentwarehouse/v1/rule_engine.proto +++ b/google/cloud/contentwarehouse/v1/rule_engine.proto @@ -19,8 +19,6 @@ package google.cloud.contentwarehouse.v1; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/iam/v1/policy.proto"; -import "google/protobuf/duration.proto"; -import "google/protobuf/timestamp.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse"; option java_multiple_files = true; @@ -28,7 +26,6 @@ option java_outer_classname = "RuleEngineProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; // Represents a set of rules from a single customer. -// Next id: 9 message RuleSet { option (google.api.resource) = { type: "contentwarehouse.googleapis.com/RuleSet" @@ -50,30 +47,6 @@ message RuleSet { // List of rules given by the customer. repeated Rule rules = 3; - - // Records the user defined time after which the rule-set will become active. - google.protobuf.Timestamp start_time = 4; - - oneof expiration { - // The timestamp after which RuleSet will not be executed by Policy Engine. - google.protobuf.Timestamp expire_time = 5; - - // Input only. The TTL (time to live) of the RuleSet. - // - // If it is set, [expire_time][google.cloud.contentwarehouse.v1.RuleSet.expire_time] is set as current timestamp plus [ttl][google.cloud.contentwarehouse.v1.RuleSet.ttl]. - // The derived [expire_time][google.cloud.contentwarehouse.v1.RuleSet.expire_time] is returned in the output and [ttl][google.cloud.contentwarehouse.v1.RuleSet.ttl] is left - // blank when retrieving the [RuleSet][google.cloud.contentwarehouse.v1.RuleSet]. - // - // If it is set, the RuleSet is not available for execution after current - // timestamp plus [ttl][google.cloud.contentwarehouse.v1.RuleSet.ttl]. However, the RuleSet can still be retrieved by - // [RuleSetService.GetRuleSet][google.cloud.contentwarehouse.v1.RuleSetService.GetRuleSet] and [RuleSetService.ListRuleSets][google.cloud.contentwarehouse.v1.RuleSetService.ListRuleSets]. - google.protobuf.Duration ttl = 7 [(google.api.field_behavior) = INPUT_ONLY]; - } - - // The schedule with which the Ruleset is applied. - // - // The presence of this field means that the ruleset is asynchronous. - Schedule schedule = 8; } // Represents the rule for a content warehouse trigger. @@ -84,20 +57,8 @@ message Rule { // Trigger for create document action. ON_CREATE = 1; - // Trigger for read document action. - ON_READ = 2; - - // Trigger for search document action. - ON_SEARCH = 3; - // Trigger for update document action. ON_UPDATE = 4; - - // Trigger for delete document action. - ON_DELETE = 5; - - // Trigger for asynchronous document actions. - ASYNC = 6; } // Short description of the rule and its context. @@ -118,12 +79,6 @@ message Rule { // List of actions that are executed when the rule is satisfied. repeated Action actions = 5; - - // Priority of the rule for execution sequence preference. - float priority = 6; - - // Indicates if the policy is currently in use or not. - bool enabled = 7; } // Represents the action triggered by Rule Engine when the rule is true. @@ -147,12 +102,6 @@ message Action { // Action publish to Pub/Sub operation. PublishAction publish_to_pub_sub = 6; - // Action performing context evaluation operation. - ContextEvaluationAction context_evaluation_action = 7; - - // Action process expired data. - ExpiredDataHandlingAction expired_data_handling_action = 8; - // Action removing a document from a folder. RemoveFromFolderAction remove_from_folder_action = 9; @@ -205,39 +154,6 @@ message DataUpdateAction { map entries = 1; } -// Represents the folder schema and corresponding condition. -message FolderSchemaCondition { - // Name of the folder schema consisting of the properties to be evaluated. - // Format: - // projects/{project_number}/locations/{location}/documentSchemas/{document_id}. - string folder_schema = 1 [(google.api.resource_reference) = { - type: "contentwarehouse.googleapis.com/DocumentSchema" - }]; - - // The filter condition. - // The syntax for this expression is a subset of SQL syntax. - // - // Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left - // of the operator is a property name and the right of the operator is a - // number or a quoted string. You must escape backslash (\\) and quote (\") - // characters. Supported functions are `LOWER([property_name])` to perform a - // case insensitive match and `EMPTY([property_name])` to filter on the - // existence of a key. - // - // Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting - // (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 - // comparisons or functions are allowed in the expression. The expression must - // be < 6000 bytes in length. - // Example: "DOC.SSN = FOLDER.ssn" - // In the above example, SSN property from the document under - // process is evaluated against folders' ssn property. - // The document under process will be added under the folder if the condition - // is evaluated as true. - // Note: FOLDER prefix is used to refer to target folder's properties. - // DOC prefix is used to refer to properties in the under process document. - string condition = 2; -} - // Represents the action responsible for adding document under a folder. message AddToFolderAction { // Names of the folder under which new document is to be added. @@ -246,11 +162,6 @@ message AddToFolderAction { repeated string folders = 1 [(google.api.resource_reference) = { type: "contentwarehouse.googleapis.com/Document" }]; - - // If the folders info is not available then populate FolderSchemaConditions - // for finding matching folders dynamically. - // Filter conditions used to derive specific folders dynamically. - repeated FolderSchemaCondition folder_schema_conditions = 2; } // Represents the action responsible for remove a document from a specific @@ -277,62 +188,6 @@ message PublishAction { repeated string messages = 2; } -// Represents the action responsible for performing context evaluation. -message ContextEvaluationAction { - // User Cloud Function for context evaluation. - message CloudFunctionInfo { - // Url of the Cloud Function. The Cloud Function needs to live inside - // consumer project. - string cloud_function = 3; - } - - // Settings of user's webhook. - message Webhook { - // URL string for receiving a POST request every time webhook is triggered. - string uri = 8; - } - - // Settings of service directory for webhook under VPCSC. - message WebhookWithServiceDirectory { - // The service directory service resource name. - string service = 9; - - // Detailed webhook settings. - Webhook webhook = 10; - } - - // Filter condition for the documents to be included in the evaluation. - string condition = 1; - - // Name of the variables input for the context evaluation. - repeated string variable_names = 2; - - oneof ContextEvaluationMethod { - // User Cloud Function for the context evaluation. - CloudFunctionInfo cloud_function_info = 4; - - // User's webhook address for the context evaluation. - Webhook webhook = 6; - - // User's webhook address integrated with service-directory. - WebhookWithServiceDirectory webhook_with_service_directory = 7; - } - - // Optional. cloud Pub/Sub topic-id. If specified, information of the - // updated documents will be published to this topic. - string topic_id = 5 [(google.api.field_behavior) = OPTIONAL]; -} - -// Represents the action responsible for handling expired data. -message ExpiredDataHandlingAction { - // Filter condition for the documents to be included in the evaluation. - string condition = 1; - - // Expired data handling will publish errors to the Pub/Sub using topic-id - // provided. - string topic_id = 2; -} - // Represents the action responsible for deleting the document. message DeleteDocumentAction { // Boolean field to select between hard vs soft delete options. @@ -419,18 +274,3 @@ message ActionOutput { // Action execution output message. string output_message = 3; } - -// Represents the schedule with which asynchronous RuleSets are applied. -enum Schedule { - // Unspecified schedule. - SCHEDULE_UNSPECIFIED = 0; - - // Policy should be applied every calendar day at 00:00 PST. - SCHEDULE_DAILY = 1; - - // Policy should be applied every Sunday at 00:00 PST. - SCHEDULE_WEEKLY = 2; - - // Policy should be applied the 1st of every calendar month at 00:00 PST. - SCHEDULE_MONTHLY = 3; -} diff --git a/google/cloud/contentwarehouse/v1/ruleset_service.proto b/google/cloud/contentwarehouse/v1/ruleset_service.proto index cb398c0b4..091367eab 100644 --- a/google/cloud/contentwarehouse/v1/ruleset_service.proto +++ b/google/cloud/contentwarehouse/v1/ruleset_service.proto @@ -27,6 +27,7 @@ option java_multiple_files = true; option java_outer_classname = "RuleSetServiceProto"; option java_package = "com.google.cloud.contentwarehouse.v1"; +// Service to manage customer specific RuleSets. service RuleSetService { option (google.api.default_host) = "contentwarehouse.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; @@ -55,7 +56,7 @@ service RuleSetService { patch: "/v1/{name=projects/*/locations/*/ruleSets/*}" body: "*" }; - option (google.api.method_signature) = "rule_set"; + option (google.api.method_signature) = "name,rule_set"; } // Deletes a ruleset. Returns NOT_FOUND if the document does not exist. @@ -73,13 +74,4 @@ service RuleSetService { }; option (google.api.method_signature) = "parent"; } - - // Runs asynchronous RuleSets. - rpc ProcessAsyncRuleSets(ProcessAsyncRuleSetsRequest) returns (ProcessAsyncRuleSetsResponse) { - option (google.api.http) = { - post: "/v1/{location=projects/*/locations/*}:processAsyncRuleSets" - body: "*" - }; - option (google.api.method_signature) = "location"; - } } diff --git a/google/cloud/contentwarehouse/v1/ruleset_service_request.proto b/google/cloud/contentwarehouse/v1/ruleset_service_request.proto index cd482e077..61d125106 100644 --- a/google/cloud/contentwarehouse/v1/ruleset_service_request.proto +++ b/google/cloud/contentwarehouse/v1/ruleset_service_request.proto @@ -19,7 +19,6 @@ package google.cloud.contentwarehouse.v1; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/contentwarehouse/v1/rule_engine.proto"; -import "google/protobuf/timestamp.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse"; option java_multiple_files = true; @@ -117,39 +116,3 @@ message ListRuleSetsResponse { // If this field is omitted, there are no subsequent pages. string next_page_token = 2; } - -// Request message for RuleSetService.ProcessAsyncRuleSets. -message ProcessAsyncRuleSetsRequest { - // Required. The Location under which all async rules are stored. - string location = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "contentwarehouse.googleapis.com/Location" - } - ]; - - // Required. The frequency category of async rules to process. - Schedule schedule = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Timestamp to override inferred execution time. - google.protobuf.Timestamp execution_time = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Document name filter to process only a subset of Documents. - repeated string document_names = 4 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "contentwarehouse.googleapis.com/Document" - } - ]; -} - -// Response message for RuleSetService.ProcessAsyncRuleSets. -message ProcessAsyncRuleSetsResponse { - // True if the processing of asynchronous policies was entirely - // successful. - bool success = 1; - - // Contains the errors encountered during the processing of asynchronous - // policies. - repeated RuleEngineOutput errors = 2; -} diff --git a/google/cloud/contentwarehouse/v1/synonymset_service.proto b/google/cloud/contentwarehouse/v1/synonymset_service.proto index 3ee1f6e56..39acfd112 100644 --- a/google/cloud/contentwarehouse/v1/synonymset_service.proto +++ b/google/cloud/contentwarehouse/v1/synonymset_service.proto @@ -61,7 +61,7 @@ service SynonymSetService { patch: "/v1/{name=projects/*/locations/*/synonymSets/*}" body: "synonym_set" }; - option (google.api.method_signature) = "synonym_set"; + option (google.api.method_signature) = "name,synonym_set"; } // Deletes a SynonymSet for a given context. diff --git a/google/cloud/datacatalog/v1/BUILD.bazel b/google/cloud/datacatalog/v1/BUILD.bazel index 4d7f5d6e6..2186698c1 100644 --- a/google/cloud/datacatalog/v1/BUILD.bazel +++ b/google/cloud/datacatalog/v1/BUILD.bazel @@ -85,6 +85,7 @@ java_gapic_library( name = "datacatalog_java_gapic", srcs = [":datacatalog_proto_with_info"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":datacatalog_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -149,8 +150,9 @@ go_gapic_library( grpc_service_config = "datacatalog_grpc_service_config.json", importpath = "cloud.google.com/go/datacatalog/apiv1;datacatalog", metadata = True, + rest_numeric_enums = False, service_yaml = "datacatalog_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":datacatalog_go_proto", "//google/iam/v1:iam_go_proto", @@ -189,6 +191,7 @@ py_gapic_library( name = "datacatalog_py_gapic", srcs = [":datacatalog_proto"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -239,6 +242,8 @@ php_gapic_library( name = "datacatalog_php_gapic", srcs = [":datacatalog_proto_with_info"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":datacatalog_php_grpc", ":datacatalog_php_proto", @@ -271,8 +276,11 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datacatalog_grpc_service_config.json", main_service = "DataCatalog", + mixins = "none", package = "google.cloud.datacatalog.v1", + rest_numeric_enums = False, service_yaml = "datacatalog_v1.yaml", + transport = "grpc", deps = [], ) @@ -317,6 +325,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/data-catalog", ], grpc_service_config = "datacatalog_grpc_service_config.json", + 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", deps = [ @@ -362,6 +371,7 @@ csharp_gapic_library( srcs = [":datacatalog_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "datacatalog_v1.yaml", deps = [ ":datacatalog_csharp_grpc", diff --git a/google/cloud/datacatalog/v1/bigquery.proto b/google/cloud/datacatalog/v1/bigquery.proto index f9ce23464..4be42ebba 100644 --- a/google/cloud/datacatalog/v1/bigquery.proto +++ b/google/cloud/datacatalog/v1/bigquery.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.datacatalog.v1; +import "google/api/field_behavior.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.DataCatalog.V1"; diff --git a/google/cloud/datacatalog/v1/datacatalog.proto b/google/cloud/datacatalog/v1/datacatalog.proto index 7c33ca947..4508e0766 100644 --- a/google/cloud/datacatalog/v1/datacatalog.proto +++ b/google/cloud/datacatalog/v1/datacatalog.proto @@ -1035,16 +1035,16 @@ message Entry { // for entries with the `FILESET` type. GcsFilesetSpec gcs_fileset_spec = 6; - // Specification that applies to a BigQuery table. Valid only for - // entries with the `TABLE` type. - BigQueryTableSpec bigquery_table_spec = 12; + // Output only. Specification that applies to a BigQuery table. Valid only + // for entries with the `TABLE` type. + BigQueryTableSpec bigquery_table_spec = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` - // name pattern. + // Output only. Specification for a group of BigQuery tables with + // the `[prefix]YYYYMMDD` name pattern. // // For more information, see [Introduction to partitioned tables] // (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). - BigQueryDateShardedSpec bigquery_date_sharded_spec = 15; + BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Type- and system-specific information. Specifications for types contain @@ -1098,13 +1098,13 @@ message Entry { // Timestamps from the underlying resource, not from the Data Catalog // entry. // - // Output only when the entry has a type listed in the `EntryType` enum. - // For entries with `user_specified_type`, this field is optional and defaults - // to an empty timestamp. + // Output only when the entry has a system listed in the `IntegratedSystem` + // enum. For entries with `user_specified_system`, this field is optional + // and defaults to an empty timestamp. SystemTimestamps source_system_timestamps = 7; - // Output only. Resource usage statistics. - UsageSignal usage_signal = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Resource usage statistics. + UsageSignal usage_signal = 13; // Cloud labels attached to the entry. // @@ -1138,9 +1138,9 @@ message DatabaseTableSpec { // Type of this table. TableType type = 1; - // Fields specific to a Dataplex table and present only in the Dataplex table - // entries. - DataplexTableSpec dataplex_table = 2; + // Output only. Fields specific to a Dataplex table and present only in the + // Dataplex table entries. + DataplexTableSpec dataplex_table = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Specification that applies to a fileset. Valid only for entries with the @@ -1153,8 +1153,10 @@ message FilesetSpec { // Specification that applies to a data source connection. Valid only for // entries with the `DATA_SOURCE_CONNECTION` type. +// Only one of internal specs can be set at the time, and cannot +// be changed later. message DataSourceConnectionSpec { - // Fields specific to BigQuery connections. + // Output only. Fields specific to BigQuery connections. BigQueryConnectionSpec bigquery_connection_spec = 1; } @@ -1667,7 +1669,7 @@ enum EntryType { // Default unknown type. ENTRY_TYPE_UNSPECIFIED = 0; - // Output only. The entry type that has a GoogleSQL schema, including + // The entry type that has a GoogleSQL schema, including // logical views. TABLE = 2; diff --git a/google/cloud/datacatalog/v1/datacatalog_v1.yaml b/google/cloud/datacatalog/v1/datacatalog_v1.yaml index f7ba1df05..b7b07e093 100644 --- a/google/cloud/datacatalog/v1/datacatalog_v1.yaml +++ b/google/cloud/datacatalog/v1/datacatalog_v1.yaml @@ -7,6 +7,8 @@ apis: - name: google.cloud.datacatalog.v1.DataCatalog - name: google.cloud.datacatalog.v1.PolicyTagManager - name: google.cloud.datacatalog.v1.PolicyTagManagerSerialization +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations documentation: summary: |- diff --git a/google/cloud/datacatalog/v1/usage.proto b/google/cloud/datacatalog/v1/usage.proto index 781004267..d778e5121 100644 --- a/google/cloud/datacatalog/v1/usage.proto +++ b/google/cloud/datacatalog/v1/usage.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.datacatalog.v1; +import "google/api/field_behavior.proto"; import "google/protobuf/timestamp.proto"; option cc_enable_arenas = true; @@ -58,8 +59,8 @@ message UsageSignal { // The end timestamp of the duration of usage statistics. google.protobuf.Timestamp update_time = 1; - // Usage statistics over each of the predefined time ranges. + // Output only. BigQuery usage statistics over each of the predefined time ranges. // // Supported time ranges are `{"24H", "7D", "30D"}`. - map usage_within_time_range = 2; + map usage_within_time_range = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/datacatalog/v1beta1/BUILD.bazel b/google/cloud/datacatalog/v1beta1/BUILD.bazel index 661981304..75d9526e1 100644 --- a/google/cloud/datacatalog/v1beta1/BUILD.bazel +++ b/google/cloud/datacatalog/v1beta1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "datacatalog_java_gapic", srcs = [":datacatalog_proto_with_info"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":datacatalog_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -134,6 +135,7 @@ go_gapic_library( srcs = [":datacatalog_proto_with_info"], grpc_service_config = "datacatalog_grpc_service_config.json", importpath = "cloud.google.com/go/datacatalog/apiv1beta1;datacatalog", + rest_numeric_enums = False, service_yaml = "datacatalog_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -173,6 +175,7 @@ py_gapic_library( name = "datacatalog_py_gapic", srcs = [":datacatalog_proto"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -223,6 +226,8 @@ php_gapic_library( name = "datacatalog_php_gapic", srcs = [":datacatalog_proto_with_info"], grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":datacatalog_php_grpc", ":datacatalog_php_proto", @@ -255,8 +260,11 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datacatalog_grpc_service_config.json", main_service = "DataCatalog", + mixins = "none", package = "google.cloud.datacatalog.v1beta1", + rest_numeric_enums = False, service_yaml = "datacatalog_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -294,6 +302,7 @@ ruby_cloud_gapic_library( name = "datacatalog_ruby_gapic", srcs = [":datacatalog_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-datacatalog-v1beta1"], + rest_numeric_enums = False, deps = [ ":datacatalog_ruby_grpc", ":datacatalog_ruby_proto", @@ -337,6 +346,7 @@ csharp_gapic_library( srcs = [":datacatalog_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datacatalog_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "datacatalog_v1beta1.yaml", deps = [ ":datacatalog_csharp_grpc", diff --git a/google/cloud/dataform/BUILD.bazel b/google/cloud/dataform/BUILD.bazel index a87c57fec..4cb8362c5 100644 --- a/google/cloud/dataform/BUILD.bazel +++ b/google/cloud/dataform/BUILD.bazel @@ -1 +1,39 @@ +# This build file includes a target for the Ruby wrapper library for +# google-cloud-dataform. + +# 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 dataform. +# Ruby wrapper clients are versionless, but are generated from source protos +# for a particular service version, v1beta1 in this case. +ruby_cloud_gapic_library( + name = "dataform_ruby_wrapper", + srcs = ["//google/cloud/dataform/v1beta1:dataform_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-dataform", + "ruby-cloud-wrapper-of=v1beta1:0.0", + "ruby-cloud-product-url=https://cloud.google.com/dataform", + "ruby-cloud-api-id=dataform.googleapis.com", + "ruby-cloud-api-shortname=dataform", + ], + ruby_cloud_description = "Dataform is a service for data analysts to develop, test, version control, and schedule complex SQL workflows for data transformation in BigQuery.", + ruby_cloud_title = "Dataform", +) + +# Open Source package. +ruby_gapic_assembly_pkg( + name = "google-cloud-dataform-ruby", + deps = [ + ":dataform_ruby_wrapper", + ], +) diff --git a/google/cloud/dataform/v1alpha2/BUILD.bazel b/google/cloud/dataform/v1alpha2/BUILD.bazel index fc58e6efd..642c72d0c 100644 --- a/google/cloud/dataform/v1alpha2/BUILD.bazel +++ b/google/cloud/dataform/v1alpha2/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":dataform_proto_with_info"], gapic_yaml = None, grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", test_deps = [ ":dataform_java_grpc", @@ -137,6 +138,7 @@ go_gapic_library( grpc_service_config = "dataform_grpc_service_config.json", importpath = "cloud.google.com/go/dataform/apiv1alpha2;dataform", metadata = True, + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", transport = "grpc+rest", deps = [ @@ -177,11 +179,12 @@ py_gapic_library( name = "dataform_py_gapic", srcs = [":dataform_proto"], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", - ] + ], ) py_test( @@ -228,7 +231,9 @@ php_gapic_library( name = "dataform_php_gapic", srcs = [":dataform_proto_with_info"], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", + transport = "grpc+rest", deps = [ ":dataform_php_grpc", ":dataform_php_proto", @@ -261,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dataform_grpc_service_config.json", package = "google.cloud.dataform.v1alpha2", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,6 +307,7 @@ ruby_cloud_gapic_library( srcs = [":dataform_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-dataform-v1alpha2"], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", deps = [ ":dataform_ruby_grpc", @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":dataform_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1alpha2.yaml", deps = [ ":dataform_csharp_grpc", diff --git a/google/cloud/dataform/v1beta1/BUILD.bazel b/google/cloud/dataform/v1beta1/BUILD.bazel index 991266415..bfe126a21 100644 --- a/google/cloud/dataform/v1beta1/BUILD.bazel +++ b/google/cloud/dataform/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":dataform_proto_with_info"], gapic_yaml = None, grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", test_deps = [ ":dataform_java_grpc", @@ -137,6 +138,7 @@ go_gapic_library( grpc_service_config = "dataform_grpc_service_config.json", importpath = "cloud.google.com/go/dataform/apiv1beta1;dataform", metadata = True, + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -177,6 +179,7 @@ py_gapic_library( name = "dataform_py_gapic", srcs = [":dataform_proto"], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", transport = "grpc", ) @@ -215,7 +218,9 @@ php_gapic_library( name = "dataform_php_gapic", srcs = [":dataform_proto_with_info"], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":dataform_php_grpc", ":dataform_php_proto", @@ -248,7 +253,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dataform_grpc_service_config.json", package = "google.cloud.dataform.v1beta1", + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -285,8 +292,16 @@ ruby_grpc_library( ruby_cloud_gapic_library( name = "dataform_ruby_gapic", srcs = [":dataform_proto_with_info"], - extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-dataform-v1beta1"], + extra_protoc_parameters = [ + "ruby-cloud-api-id=dataform.googleapis.com", + "ruby-cloud-api-shortname=dataform", + "ruby-cloud-gem-name=google-cloud-dataform-v1beta1", + "ruby-cloud-product-url=https://cloud.google.com/dataform", + ], grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, + ruby_cloud_description = "Dataform is a service for data analysts to develop, test, version control, and schedule complex SQL workflows for data transformation in BigQuery.", + ruby_cloud_title = "Dataform V1beta1", service_yaml = "dataform_v1beta1.yaml", deps = [ ":dataform_ruby_grpc", @@ -331,6 +346,7 @@ csharp_gapic_library( srcs = [":dataform_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataform_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataform_v1beta1.yaml", deps = [ ":dataform_csharp_grpc", diff --git a/google/cloud/datafusion/v1/BUILD.bazel b/google/cloud/datafusion/v1/BUILD.bazel index 433cba82b..da2689d90 100644 --- a/google/cloud/datafusion/v1/BUILD.bazel +++ b/google/cloud/datafusion/v1/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( name = "datafusion_java_gapic", srcs = [":datafusion_proto_with_info"], grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":datafusion_java_grpc", ], @@ -128,13 +129,14 @@ go_gapic_library( grpc_service_config = "datafusion_grpc_service_config.json", importpath = "cloud.google.com/go/datafusion/apiv1;datafusion", metadata = True, + rest_numeric_enums = True, service_yaml = "datafusion_v1.yaml", transport = "grpc+rest", deps = [ ":datafusion_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -175,6 +177,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=data_fusion", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -222,7 +225,9 @@ php_gapic_library( name = "datafusion_php_gapic", srcs = [":datafusion_proto_with_info"], grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datafusion_v1.yaml", + transport = "grpc+rest", deps = [ ":datafusion_php_grpc", ":datafusion_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datafusion_grpc_service_config.json", package = "google.cloud.datafusion.v1", + rest_numeric_enums = True, service_yaml = "datafusion_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -299,6 +306,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/data-fusion", ], grpc_service_config = "datafusion_grpc_service_config.json", + 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", deps = [ @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":datafusion_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datafusion_v1.yaml", deps = [ ":datafusion_csharp_grpc", diff --git a/google/cloud/datafusion/v1beta1/BUILD.bazel b/google/cloud/datafusion/v1beta1/BUILD.bazel index 6a24bd0bf..30733daff 100644 --- a/google/cloud/datafusion/v1beta1/BUILD.bazel +++ b/google/cloud/datafusion/v1beta1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "datafusion_java_gapic", srcs = [":datafusion_proto_with_info"], grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":datafusion_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -134,14 +135,15 @@ go_gapic_library( grpc_service_config = "datafusion_grpc_service_config.json", importpath = "cloud.google.com/go/datafusion/apiv1beta1;datafusion", metadata = True, + rest_numeric_enums = True, service_yaml = "datafusion_v1beta1.yaml", transport = "grpc+rest", deps = [ ":datafusion_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -177,6 +179,7 @@ py_gapic_library( name = "datafusion_py_gapic", srcs = [":datafusion_proto"], grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -227,7 +230,9 @@ php_gapic_library( name = "datafusion_php_gapic", srcs = [":datafusion_proto_with_info"], grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datafusion_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":datafusion_php_grpc", ":datafusion_php_proto", @@ -260,7 +265,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datafusion_grpc_service_config.json", package = "google.cloud.datafusion.v1beta1", + rest_numeric_enums = True, service_yaml = "datafusion_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -304,6 +311,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/data-fusion", ], grpc_service_config = "datafusion_grpc_service_config.json", + 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", deps = [ @@ -349,6 +357,7 @@ csharp_gapic_library( srcs = [":datafusion_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datafusion_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datafusion_v1beta1.yaml", deps = [ ":datafusion_csharp_grpc", diff --git a/google/cloud/datalabeling/v1beta1/BUILD.bazel b/google/cloud/datalabeling/v1beta1/BUILD.bazel index a9e495a49..e26610631 100644 --- a/google/cloud/datalabeling/v1beta1/BUILD.bazel +++ b/google/cloud/datalabeling/v1beta1/BUILD.bazel @@ -72,9 +72,11 @@ java_gapic_library( name = "datalabeling_java_gapic", srcs = [":datalabeling_proto_with_info"], grpc_service_config = "datalabeling_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":datalabeling_java_grpc", ], + transport = "grpc", deps = [ ":datalabeling_java_proto", ], @@ -92,6 +94,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-datalabeling-v1beta1-java", include_samples = True, + transport = "grpc", deps = [ ":datalabeling_java_gapic", ":datalabeling_java_grpc", @@ -128,12 +131,14 @@ go_gapic_library( srcs = [":datalabeling_proto_with_info"], grpc_service_config = "datalabeling_grpc_service_config.json", importpath = "cloud.google.com/go/datalabeling/apiv1beta1;datalabeling", + rest_numeric_enums = True, service_yaml = "datalabeling_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":datalabeling_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -169,6 +174,7 @@ py_gapic_library( name = "datalabeling_py_gapic", srcs = [":datalabeling_proto"], grpc_service_config = "datalabeling_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -215,7 +221,9 @@ php_gapic_library( name = "datalabeling_php_gapic", srcs = [":datalabeling_proto_with_info"], grpc_service_config = "datalabeling_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datalabeling_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":datalabeling_php_grpc", ":datalabeling_php_proto", @@ -249,7 +257,9 @@ nodejs_gapic_library( grpc_service_config = "datalabeling_grpc_service_config.json", main_service = "datalabeling", package = "google.cloud.datalabeling.v1beta1", + rest_numeric_enums = True, service_yaml = "datalabeling_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -294,6 +304,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=datalabeling", ], grpc_service_config = "datalabeling_grpc_service_config.json", + 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", deps = [ @@ -339,6 +350,7 @@ csharp_gapic_library( srcs = [":datalabeling_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datalabeling_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datalabeling_v1beta1.yaml", deps = [ ":datalabeling_csharp_grpc", diff --git a/google/cloud/dataplex/v1/BUILD.bazel b/google/cloud/dataplex/v1/BUILD.bazel index 6d03ee6fc..93111dd01 100644 --- a/google/cloud/dataplex/v1/BUILD.bazel +++ b/google/cloud/dataplex/v1/BUILD.bazel @@ -82,6 +82,7 @@ java_gapic_library( srcs = [":dataplex_proto_with_info"], gapic_yaml = None, grpc_service_config = "dataplex_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataplex_v1.yaml", test_deps = [ ":dataplex_java_grpc", @@ -152,15 +153,16 @@ go_gapic_library( grpc_service_config = "dataplex_grpc_service_config.json", importpath = "cloud.google.com/go/dataplex/apiv1;dataplex", metadata = True, + rest_numeric_enums = True, service_yaml = "dataplex_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":dataplex_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", + "@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", ], ) @@ -197,6 +199,7 @@ py_gapic_library( name = "dataplex_py_gapic", srcs = [":dataplex_proto"], grpc_service_config = "dataplex_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataplex_v1.yaml", transport = "grpc", deps = [ @@ -248,7 +251,9 @@ php_gapic_library( name = "dataplex_php_gapic", srcs = [":dataplex_proto_with_info"], grpc_service_config = "dataplex_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataplex_v1.yaml", + transport = "grpc+rest", deps = [ ":dataplex_php_grpc", ":dataplex_php_proto", @@ -280,10 +285,12 @@ nodejs_gapic_library( src = ":dataplex_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "dataplex_grpc_service_config.json", - package = "google.cloud.dataplex.v1", - service_yaml = "dataplex_v1.yaml", # Content service defines IAM RPCs, force override mixins to remove IAM mixins = "google.cloud.location.Locations;google.longrunning.Operations", + package = "google.cloud.dataplex.v1", + rest_numeric_enums = True, + service_yaml = "dataplex_v1.yaml", + transport = "grpc", deps = [], ) @@ -327,6 +334,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/dataplex/", ], grpc_service_config = "dataplex_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dataplex is an intelligent data fabric that provides a way to centrally manage, monitor, and govern your data across data lakes, data warehouses and data marts, and make this data securely accessible to a variety of analytics and data science tools.", ruby_cloud_title = "Dataplex V1", service_yaml = "dataplex_v1.yaml", @@ -373,6 +381,7 @@ csharp_gapic_library( srcs = [":dataplex_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataplex_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataplex_v1.yaml", deps = [ ":dataplex_csharp_grpc", diff --git a/google/cloud/dataplex/v1/analyze.proto b/google/cloud/dataplex/v1/analyze.proto index 6f987fafa..ece76eb5a 100644 --- a/google/cloud/dataplex/v1/analyze.proto +++ b/google/cloud/dataplex/v1/analyze.proto @@ -42,7 +42,8 @@ message Environment { // Optional. Size in GB of the disk. Default is 100 GB. int32 disk_size_gb = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Total number of nodes in the sessions created for this environment. + // Optional. Total number of nodes in the sessions created for this + // environment. int32 node_count = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. Max configurable nodes. @@ -58,18 +59,21 @@ message Environment { // Optional. List of Java jars to be included in the runtime environment. // Valid input includes Cloud Storage URIs to Jar binaries. // For example, gs://bucket-name/my/path/to/file.jar - repeated string java_libraries = 2 [(google.api.field_behavior) = OPTIONAL]; + repeated string java_libraries = 2 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A list of python packages to be installed. // Valid formats include Cloud Storage URI to a PIP installable library. // For example, gs://bucket-name/my/path/to/lib.tar.gz - repeated string python_packages = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Spark properties to provide configuration for use in sessions created - // for this environment. The properties to set on daemon config files. - // Property keys are specified in `prefix:property` format. - // The prefix must be "spark". - map properties = 4 [(google.api.field_behavior) = OPTIONAL]; + repeated string python_packages = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Spark properties to provide configuration for use in sessions + // created for this environment. The properties to set on daemon config + // files. Property keys are specified in `prefix:property` format. The + // prefix must be "spark". + map properties = 4 + [(google.api.field_behavior) = OPTIONAL]; } // Hardware config @@ -80,7 +84,8 @@ message Environment { // Software config oneof runtime { - // Required. Software Runtime Configuration for analyze interactive workloads. + // Required. Software Runtime Configuration for analyze interactive + // workloads. OsImageRuntime os_image = 100 [(google.api.field_behavior) = REQUIRED]; } } @@ -88,19 +93,20 @@ message Environment { message SessionSpec { // Optional. The idle time configuration of the session. The session will be // auto-terminated at the end of this period. - google.protobuf.Duration max_idle_duration = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If True, this causes sessions to be pre-created and available for faster - // startup to enable interactive exploration use-cases. This defaults to - // False to avoid additional billed charges. - // These can only be set to True for the environment with name set to - // "default", and with default configuration. + google.protobuf.Duration max_idle_duration = 1 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. If True, this causes sessions to be pre-created and available + // for faster startup to enable interactive exploration use-cases. This + // defaults to False to avoid additional billed charges. These can only be + // set to True for the environment with name set to "default", and with + // default configuration. bool enable_fast_startup = 2 [(google.api.field_behavior) = OPTIONAL]; } message SessionStatus { - // Output only. Queries over sessions to mark whether the environment is currently - // active or not + // Output only. Queries over sessions to mark whether the environment is + // currently active or not bool active = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -124,15 +130,18 @@ message Environment { // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the environment. This ID will be - // different if the environment is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the environment. This + // ID will be different if the environment is deleted and re-created with the + // same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Environment creation time. - 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 when the environment 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. User defined labels for the environment. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -144,15 +153,18 @@ message Environment { State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Infrastructure specification for the Environment. - InfrastructureSpec infrastructure_spec = 100 [(google.api.field_behavior) = REQUIRED]; + InfrastructureSpec infrastructure_spec = 100 + [(google.api.field_behavior) = REQUIRED]; // Optional. Configuration for sessions created for this environment. SessionSpec session_spec = 101 [(google.api.field_behavior) = OPTIONAL]; // Output only. Status of sessions created for this environment. - SessionStatus session_status = 102 [(google.api.field_behavior) = OUTPUT_ONLY]; + SessionStatus session_status = 102 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. URI Endpoints to access sessions associated with the Environment. + // Output only. URI Endpoints to access sessions associated with the + // Environment. Endpoints endpoints = 200 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -202,20 +214,23 @@ message Content { } ]; - // Output only. System generated globally unique ID for the content. This ID will be - // different if the content is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the content. This ID + // will be different if the content is deleted and re-created with the same + // name. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The path for the Content file, represented as directory structure. - // Unique within a lake. - // Limited to alphanumerics, hyphens, underscores, dots and slashes. + // Required. The path for the Content file, represented as directory + // structure. Unique within a lake. Limited to alphanumerics, hyphens, + // underscores, dots and slashes. string path = 3 [(google.api.field_behavior) = REQUIRED]; // Output only. Content creation time. - 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 when the content 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. User defined labels for the content. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -258,7 +273,8 @@ message Session { string user_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Session start 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]; State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/dataplex/v1/content.proto b/google/cloud/dataplex/v1/content.proto index cd335a58c..9064de5c3 100644 --- a/google/cloud/dataplex/v1/content.proto +++ b/google/cloud/dataplex/v1/content.proto @@ -34,7 +34,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // ContentService manages Notebook and SQL Scripts for Dataplex. service ContentService { option (google.api.default_host) = "dataplex.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 content. rpc CreateContent(CreateContentRequest) returns (Content) { @@ -90,7 +91,8 @@ service ContentService { // // Caller must have Google IAM `dataplex.content.getIamPolicy` permission // on the resource. - 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=projects/*/locations/*/lakes/*/contentitems/**}:getIamPolicy" additional_bindings { @@ -105,7 +107,8 @@ service ContentService { // // Caller must have Google IAM `dataplex.content.setIamPolicy` permission // on the resource. - 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/*/lakes/*/contentitems/**}:setIamPolicy" body: "*" @@ -126,7 +129,8 @@ service ContentService { // 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/*/lakes/*/contentitems/**}:testIamPermissions" body: "*" @@ -155,9 +159,7 @@ message CreateContentRequest { // projects/{project_id}/locations/{location_id}/lakes/{lake_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Content resource. @@ -171,7 +173,8 @@ message CreateContentRequest { // Update content request. message UpdateContentRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -200,18 +203,16 @@ message ListContentRequest { // projects/{project_id}/locations/{location_id}/lakes/{lake_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of content to return. The service may return fewer than - // this value. If unspecified, at most 10 content will be returned. The + // Optional. Maximum number of content to return. The service may return fewer + // than this value. If unspecified, at most 10 content 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 `ListContent` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListContent` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListContent` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/dataplex/v1/logs.proto b/google/cloud/dataplex/v1/logs.proto index 51e48e46e..0cec18480 100644 --- a/google/cloud/dataplex/v1/logs.proto +++ b/google/cloud/dataplex/v1/logs.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.dataplex.v1; +import "google/api/resource.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; @@ -221,7 +222,7 @@ message SessionEvent { // An unspecified event type. EVENT_TYPE_UNSPECIFIED = 0; - // Event for start of a session. + // Event when the session is assigned to a user. START = 1; // Event for stop of a session. @@ -229,6 +230,10 @@ message SessionEvent { // Query events in the session. QUERY = 3; + + // Event for creation of a cluster. It is not yet assigned to a user. + // This comes before START in the sequence + CREATE = 4; } // Execution details of the query. @@ -267,7 +272,8 @@ message SessionEvent { // The log message. string message = 1; - // The information about the user that created the session. + // The information about the user that created the session. It will be the + // email address of the user. string user_id = 2; // Unique identifier for the session. @@ -281,4 +287,14 @@ message SessionEvent { // The execution details of the query. QueryDetail query = 5; } + + // 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. + 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; } diff --git a/google/cloud/dataplex/v1/metadata.proto b/google/cloud/dataplex/v1/metadata.proto index 290d94066..5aac7eb14 100644 --- a/google/cloud/dataplex/v1/metadata.proto +++ b/google/cloud/dataplex/v1/metadata.proto @@ -32,7 +32,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // partitions. service MetadataService { option (google.api.default_host) = "dataplex.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 metadata entity. rpc CreateEntity(CreateEntityRequest) returns (Entity) { @@ -115,9 +116,7 @@ message CreateEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Entity resource. @@ -147,13 +146,11 @@ message DeleteEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; - // Required. The etag associated with the entity, which can be retrieved with a - // [GetEntity][] request. + // Required. The etag associated with the entity, which can be retrieved with + // a [GetEntity][] request. string etag = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -176,17 +173,16 @@ message ListEntitiesRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Specify the entity view to make a partial list request. EntityView view = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Maximum number of entities to return. The service may return fewer than - // this value. If unspecified, 100 entities will be returned by default. The - // maximum value is 500; larger values will will be truncated to 500. + // Optional. Maximum number of entities to return. The service may return + // fewer than this value. If unspecified, 100 entities will be returned by + // default. The maximum value is 500; larger values will will be truncated to + // 500. int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Page token received from a previous `ListEntities` call. Provide @@ -195,8 +191,8 @@ message ListEntitiesRequest { // page token. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The following filter parameters can be added to the URL to limit the - // entities returned by the API: + // Optional. The following filter parameters can be added to the URL to limit + // the entities returned by the API: // // - Entity ID: ?filter="id=entityID" // - Asset ID: ?filter="asset=assetID" @@ -237,9 +233,7 @@ message GetEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Optional. Used to select the subset of entity information to return. @@ -253,24 +247,23 @@ message ListPartitionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; - // Optional. Maximum number of partitions to return. The service may return fewer than - // this value. If unspecified, 100 partitions will be returned by default. The - // maximum page size is 500; larger values will will be truncated to 500. + // Optional. Maximum number of partitions to return. The service may return + // fewer than this value. If unspecified, 100 partitions will be returned by + // default. The maximum page size is 500; larger values will will be truncated + // to 500. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListPartitions` call. Provide - // this to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListPartitions` must match the call that provided the - // page token. + // Optional. Page token received from a previous `ListPartitions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListPartitions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Filter the partitions returned to the caller using a key value pair - // expression. Supported operators and syntax: + // Optional. Filter the partitions returned to the caller using a key value + // pair expression. Supported operators and syntax: // // - logic operators: AND, OR // - comparison operators: <, >, >=, <= ,=, != @@ -297,9 +290,7 @@ message CreatePartitionRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Required. Partition resource. @@ -325,10 +316,7 @@ message DeletePartitionRequest { ]; // Optional. The etag associated with the partition. - string etag = 2 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + string etag = 2 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // List metadata partitions response. @@ -378,17 +366,18 @@ message Entity { message CompatibilityStatus { // Provides compatibility information for a specific metadata store. message Compatibility { - // Output only. Whether the entity is compatible and can be represented in the metadata - // store. + // Output only. Whether the entity is compatible and can be represented in + // the metadata store. bool compatible = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Provides additional detail if the entity is incompatible with the - // metadata store. + // Output only. Provides additional detail if the entity is incompatible + // with the metadata store. string reason = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. Whether this entity is compatible with Hive Metastore. - Compatibility hive_metastore = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + Compatibility hive_metastore = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Whether this entity is compatible with BigQuery. Compatibility bigquery = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -398,23 +387,23 @@ message Entity { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Optional. Display name must be shorter than or equal to 256 characters. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. User friendly longer description text. Must be shorter than or equal to - // 1024 characters. + // Optional. User friendly longer description text. Must be shorter than or + // equal to 1024 characters. string description = 3 [(google.api.field_behavior) = OPTIONAL]; // Output only. The time when the entity 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. The time when the entity 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]; // Required. A user-provided entity ID. It is mutable, and will be used as the // published table name. Specifying a new ID in an update entity @@ -424,8 +413,8 @@ message Entity { // characters. string id = 7 [(google.api.field_behavior) = REQUIRED]; - // Optional. The etag associated with the entity, which can be retrieved with a - // [GetEntity][] request. Required for update and delete requests. + // Optional. The etag associated with the entity, which can be retrieved with + // a [GetEntity][] request. Required for update and delete requests. string etag = 8 [(google.api.field_behavior) = OPTIONAL]; // Required. Immutable. The type of entity. @@ -434,8 +423,9 @@ message Entity { (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The ID of the asset associated with the storage location containing the - // entity data. The entity must be with in the same zone with the asset. + // Required. Immutable. The ID of the asset associated with the storage + // location containing the entity data. The entity must be with in the same + // zone with the asset. string asset = 11 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -451,9 +441,9 @@ message Entity { (google.api.field_behavior) = IMMUTABLE ]; - // Optional. The set of items within the data path constituting the data in the entity, - // represented as a glob path. - // Example: `gs://bucket/path/to/data/**/*.csv`. + // Optional. The set of items within the data path constituting the data in + // the entity, represented as a glob path. Example: + // `gs://bucket/path/to/data/**/*.csv`. string data_path_pattern = 13 [(google.api.field_behavior) = OPTIONAL]; // Output only. The name of the associated Data Catalog entry. @@ -470,7 +460,8 @@ message Entity { StorageFormat format = 16 [(google.api.field_behavior) = REQUIRED]; // Output only. Metadata stores that the entity is compatible with. - CompatibilityStatus compatibility = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + CompatibilityStatus compatibility = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The description of the data structure and layout. // The schema is not included in list responses. It is only included in @@ -497,26 +488,23 @@ message Partition { } ]; - // Required. Immutable. The set of values representing the partition, which correspond to the - // partition schema defined in the parent entity. + // Required. Immutable. The set of values representing the partition, which + // correspond to the partition schema defined in the parent entity. repeated string values = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The location of the entity data within the partition, for example, - // `gs://bucket/path/to/entity/key1=value1/key2=value2`. - // Or `projects//datasets//tables/` + // Required. Immutable. The location of the entity data within the partition, + // for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or + // `projects//datasets//tables/` string location = 3 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; // Optional. The etag for this partition. - string etag = 4 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + string etag = 4 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // Schema information describing the structure and layout of the data. @@ -595,8 +583,8 @@ message Schema { // and must begin with a letter or underscore. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. User friendly field description. Must be less than or equal to 1024 - // characters. + // Optional. User friendly field description. Must be less than or equal to + // 1024 characters. string description = 2 [(google.api.field_behavior) = OPTIONAL]; // Required. The type of field. @@ -614,9 +602,9 @@ message Schema { // filtering ability due to performance consideration. **Note:** // Partition fields are immutable. message PartitionField { - // Required. Partition field name must consist of letters, numbers, and underscores - // only, with a maximum of length of 256 characters, - // and must begin with a letter or underscore.. + // Required. Partition field name must consist of letters, numbers, and + // underscores only, with a maximum of length of 256 characters, and must + // begin with a letter or underscore.. string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. Immutable. The type of field. @@ -637,8 +625,8 @@ message Schema { HIVE_COMPATIBLE = 1; } - // Required. Set to `true` if user-managed or `false` if managed by Dataplex. The - // default is `false` (managed by Dataplex). + // Required. Set to `true` if user-managed or `false` if managed by Dataplex. + // The default is `false` (managed by Dataplex). // // - Set to `false`to enable Dataplex discovery to update the schema. // including new data discovery, schema inference, and schema evolution. @@ -656,11 +644,13 @@ message Schema { // **Note:** BigQuery SchemaFields are immutable. repeated SchemaField fields = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The sequence of fields describing the partition structure in entities. - // If this field is empty, there are no partitions within the data. - repeated PartitionField partition_fields = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The sequence of fields describing the partition structure in + // entities. If this field is empty, there are no partitions within the data. + repeated PartitionField partition_fields = 3 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. The structure of paths containing partition data within the entity. + // Optional. The structure of paths containing partition data within the + // entity. PartitionStyle partition_style = 4 [(google.api.field_behavior) = OPTIONAL]; } @@ -668,12 +658,12 @@ message Schema { message StorageFormat { // Describes CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and - // "ISO-8859-1". Defaults to UTF-8 if unspecified. + // Optional. The character encoding of the data. Accepts "US-ASCII", + // "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified. string encoding = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. Defaults to 0. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. Defaults to 0. int32 header_rows = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The delimiter used to separate values. Defaults to ','. @@ -687,8 +677,8 @@ message StorageFormat { // Describes JSON data format. message JsonOptions { - // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and - // "ISO-8859-1". Defaults to UTF-8 if not specified. + // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" + // and "ISO-8859-1". Defaults to UTF-8 if not specified. string encoding = 1 [(google.api.field_behavior) = OPTIONAL]; } @@ -746,13 +736,14 @@ message StorageFormat { BZIP2 = 3; } - // Output only. The data format associated with the stored data, which represents - // content type values. The value is inferred from mime type. + // Output only. The data format associated with the stored data, which + // represents content type values. The value is inferred from mime type. Format format = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The compression type associated with the stored data. // If unspecified, the data is uncompressed. - CompressionFormat compression_format = 2 [(google.api.field_behavior) = OPTIONAL]; + CompressionFormat compression_format = 2 + [(google.api.field_behavior) = OPTIONAL]; // Required. The mime type descriptor for the data. Must match the pattern // {type}/{subtype}. Supported values: diff --git a/google/cloud/dataplex/v1/resources.proto b/google/cloud/dataplex/v1/resources.proto index e07caac23..86af8432b 100644 --- a/google/cloud/dataplex/v1/resources.proto +++ b/google/cloud/dataplex/v1/resources.proto @@ -86,23 +86,23 @@ message Lake { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the lake. This ID will be - // different if the lake is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the lake. This ID will + // be different if the lake is deleted and re-created with the same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the lake 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 when the lake 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. User-defined labels for the lake. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -113,8 +113,9 @@ message Lake { // Output only. Current state of the lake. State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Service account associated with this lake. This service account must be - // authorized to access or operate on resources managed by the lake. + // Output only. Service account associated with this lake. This service + // account must be authorized to access or operate on resources managed by the + // lake. string service_account = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Settings to manage lake and Dataproc Metastore service instance @@ -125,7 +126,8 @@ message Lake { AssetStatus asset_status = 103 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Metastore status of the lake. - MetastoreStatus metastore_status = 104 [(google.api.field_behavior) = OUTPUT_ONLY]; + MetastoreStatus metastore_status = 104 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Aggregated status of the underlying assets of a lake or zone. @@ -181,8 +183,8 @@ message Zone { MULTI_REGION = 2; } - // Required. Immutable. The location type of the resources that are allowed to be attached to the - // assets within this zone. + // Required. Immutable. The location type of the resources that are allowed + // to be attached to the assets within this zone. LocationType location_type = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -193,11 +195,12 @@ message Zone { message DiscoverySpec { // Describe CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. int32 header_rows = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The delimiter being used to separate values. This defaults to ','. + // Optional. The delimiter being used to separate values. This defaults to + // ','. string delimiter = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The character encoding of the data. The default is UTF-8. @@ -222,18 +225,20 @@ message Zone { // Required. Whether discovery is enabled. bool enabled = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The list of patterns to apply for selecting data to include during - // discovery if only a subset of the data should considered. For Cloud - // Storage bucket assets, these are interpreted as glob patterns used to - // match object names. For BigQuery dataset assets, these are - // interpreted as patterns to match table names. - repeated string include_patterns = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The list of patterns to apply for selecting data to exclude during - // discovery. For Cloud Storage bucket assets, these are interpreted as - // glob patterns used to match object names. For BigQuery dataset assets, + // Optional. The list of patterns to apply for selecting data to include + // during discovery if only a subset of the data should considered. For + // Cloud Storage bucket assets, these are interpreted as glob patterns used + // to match object names. For BigQuery dataset assets, these are interpreted + // as patterns to match table names. + repeated string include_patterns = 2 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The list of patterns to apply for selecting data to exclude + // during discovery. For Cloud Storage bucket assets, these are interpreted + // as glob patterns used to match object names. For BigQuery dataset assets, // these are interpreted as patterns to match table names. - repeated string exclude_patterns = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated string exclude_patterns = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for CSV data. CsvOptions csv_options = 4 [(google.api.field_behavior) = OPTIONAL]; @@ -243,15 +248,15 @@ message Zone { // Determines when discovery is triggered. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // discovery periodically. Successive discovery runs must be scheduled at - // least 60 minutes apart. - // The default value is to run discovery every 60 minutes. - // 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 * * * *". + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running discovery periodically. Successive discovery runs must be + // scheduled at least 60 minutes apart. The default value is to run + // discovery every 60 minutes. 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 * * * *`. string schedule = 10 [(google.api.field_behavior) = OPTIONAL]; } } @@ -260,23 +265,23 @@ message Zone { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the zone. This ID will be - // different if the zone is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the zone. This ID will + // be different if the zone is deleted and re-created with the same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the zone 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 when the zone 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. User defined labels for the zone. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -293,11 +298,12 @@ message Zone { (google.api.field_behavior) = IMMUTABLE ]; - // Optional. Specification of the discovery feature applied to data in this zone. + // Optional. Specification of the discovery feature applied to data in this + // zone. DiscoverySpec discovery_spec = 103 [(google.api.field_behavior) = OPTIONAL]; - // Required. Specification of the resources that are referenced by the assets within - // this zone. + // Required. Specification of the resources that are referenced by the assets + // within this zone. ResourceSpec resource_spec = 104 [(google.api.field_behavior) = REQUIRED]; // Output only. Aggregated status of the underlying assets of the zone. @@ -329,16 +335,12 @@ message Action { } // Action details for resource references in assets that cannot be located. - message MissingResource { - - } + message MissingResource {} // Action details for unauthorized resource issues raised to indicate that the // service account associated with the lake instance is not authorized to // access or manage the resource associated with an asset. - message UnauthorizedResource { - - } + message UnauthorizedResource {} // Failed to apply security policy to the managed resource(s) under a // lake, zone or an asset. For a lake or zone resource, one or more underlying @@ -416,14 +418,10 @@ message Action { } // Action details for absence of data detected by discovery. - message MissingData { - - } + message MissingData {} // Action details for invalid data arrangement. - message InvalidDataOrganization { - - } + message InvalidDataOrganization {} // The category of issue associated with the action. Category category = 1; @@ -440,36 +438,28 @@ message Action { // `projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}`. string name = 5 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Action" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Action" } ]; // Output only. The relative resource name of the lake, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string lake = 6 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Output only. The relative resource name of the zone, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string zone = 7 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Output only. The relative resource name of the asset, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string asset = 8 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; // The list of data locations associated with this action. Cloud Storage @@ -552,11 +542,12 @@ message Asset { message DiscoverySpec { // Describe CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. int32 header_rows = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The delimiter being used to separate values. This defaults to ','. + // Optional. The delimiter being used to separate values. This defaults to + // ','. string delimiter = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The character encoding of the data. The default is UTF-8. @@ -581,18 +572,20 @@ message Asset { // Optional. Whether discovery is enabled. bool enabled = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The list of patterns to apply for selecting data to include during - // discovery if only a subset of the data should considered. For Cloud - // Storage bucket assets, these are interpreted as glob patterns used to - // match object names. For BigQuery dataset assets, these are interpreted as - // patterns to match table names. - repeated string include_patterns = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The list of patterns to apply for selecting data to exclude during - // discovery. For Cloud Storage bucket assets, these are interpreted as - // glob patterns used to match object names. For BigQuery dataset assets, + // Optional. The list of patterns to apply for selecting data to include + // during discovery if only a subset of the data should considered. For + // Cloud Storage bucket assets, these are interpreted as glob patterns used + // to match object names. For BigQuery dataset assets, these are interpreted + // as patterns to match table names. + repeated string include_patterns = 2 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The list of patterns to apply for selecting data to exclude + // during discovery. For Cloud Storage bucket assets, these are interpreted + // as glob patterns used to match object names. For BigQuery dataset assets, // these are interpreted as patterns to match table names. - repeated string exclude_patterns = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated string exclude_patterns = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for CSV data. CsvOptions csv_options = 4 [(google.api.field_behavior) = OPTIONAL]; @@ -602,15 +595,15 @@ message Asset { // Determines when discovery is triggered. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // discovery periodically. Successive discovery runs must be scheduled at - // least 60 minutes apart. - // The default value is to run discovery every 60 minutes. - // 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 * * * *". + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running discovery periodically. Successive discovery runs must be + // scheduled at least 60 minutes apart. The default value is to run + // discovery every 60 minutes. 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 * * * *`. string schedule = 10 [(google.api.field_behavior) = OPTIONAL]; } } @@ -629,8 +622,8 @@ message Asset { BIGQUERY_DATASET = 2; } - // Immutable. Relative name of the cloud resource that contains the data that is - // being managed within a lake. For example: + // Immutable. Relative name of the cloud resource that contains the data + // that is being managed within a lake. For example: // `projects/{project_number}/buckets/{bucket_id}` // `projects/{project_number}/datasets/{dataset_id}` string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -725,23 +718,24 @@ message Asset { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the asset. This ID will be - // different if the asset is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the asset. This ID + // will be different if the asset is deleted and re-created with the same + // name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the asset 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 when the asset 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. User defined labels for the asset. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -756,19 +750,23 @@ message Asset { ResourceSpec resource_spec = 100 [(google.api.field_behavior) = REQUIRED]; // Output only. Status of the resource referenced by this asset. - ResourceStatus resource_status = 101 [(google.api.field_behavior) = OUTPUT_ONLY]; + ResourceStatus resource_status = 101 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Status of the security policy applied to resource referenced by this asset. - SecurityStatus security_status = 103 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Status of the security policy applied to resource referenced + // by this asset. + SecurityStatus security_status = 103 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Specification of the discovery feature applied to data referenced by this - // asset. - // When this spec is left unset, the asset will use the spec set on the parent - // zone. + // Optional. Specification of the discovery feature applied to data referenced + // by this asset. When this spec is left unset, the asset will use the spec + // set on the parent zone. DiscoverySpec discovery_spec = 106 [(google.api.field_behavior) = OPTIONAL]; - // Output only. Status of the discovery feature applied to data referenced by this asset. - DiscoveryStatus discovery_status = 107 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Status of the discovery feature applied to data referenced by + // this asset. + DiscoveryStatus discovery_status = 107 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // State of a resource. diff --git a/google/cloud/dataplex/v1/service.proto b/google/cloud/dataplex/v1/service.proto index f7995c07b..d23ca8e2f 100644 --- a/google/cloud/dataplex/v1/service.proto +++ b/google/cloud/dataplex/v1/service.proto @@ -40,7 +40,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // systems including Cloud Storage and BigQuery. service DataplexService { option (google.api.default_host) = "dataplex.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 lake resource. rpc CreateLake(CreateLakeRequest) returns (google.longrunning.Operation) { @@ -311,7 +312,8 @@ service DataplexService { } // Create an environment resource. - rpc CreateEnvironment(CreateEnvironmentRequest) returns (google.longrunning.Operation) { + rpc CreateEnvironment(CreateEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/lakes/*}/environments" body: "environment" @@ -324,7 +326,8 @@ service DataplexService { } // Update the environment resource. - rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (google.longrunning.Operation) { + rpc UpdateEnvironment(UpdateEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{environment.name=projects/*/locations/*/lakes/*/environments/*}" body: "environment" @@ -338,7 +341,8 @@ service DataplexService { // Delete the environment resource. All the child resources must have been // deleted before environment deletion can be initiated. - rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.longrunning.Operation) { + rpc DeleteEnvironment(DeleteEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/lakes/*/environments/*}" }; @@ -350,7 +354,8 @@ service DataplexService { } // Lists environments under the given lake. - rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { + rpc ListEnvironments(ListEnvironmentsRequest) + returns (ListEnvironmentsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/lakes/*}/environments" }; @@ -407,7 +412,8 @@ message CreateLakeRequest { // Update lake request. message UpdateLakeRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -424,9 +430,7 @@ message DeleteLakeRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; } @@ -442,13 +446,13 @@ message ListLakesRequest { } ]; - // Optional. Maximum number of Lakes to return. The service may return fewer than this - // value. If unspecified, at most 10 lakes will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of Lakes to return. The service may return fewer + // than this value. If unspecified, at most 10 lakes 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 `ListLakes` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListLakes` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListLakes` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -478,20 +482,18 @@ message ListLakeActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListLakeActions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters - // provided to `ListLakeActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListLakeActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListLakeActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -511,9 +513,7 @@ message GetLakeRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; } @@ -523,9 +523,7 @@ message CreateZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Zone identifier. @@ -550,7 +548,8 @@ message CreateZoneRequest { // Update zone request. message UpdateZoneRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -567,9 +566,7 @@ message DeleteZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; } @@ -579,18 +576,16 @@ message ListZonesRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of zones to return. The service may return fewer than this - // value. If unspecified, at most 10 zones will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of zones to return. The service may return fewer + // than this value. If unspecified, at most 10 zones will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZones` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListZones` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListZones` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -617,20 +612,18 @@ message ListZoneActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZoneActions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters - // provided to `ListZoneActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListZoneActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListZoneActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -640,9 +633,7 @@ message GetZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; } @@ -652,9 +643,7 @@ message CreateAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Asset identifier. @@ -678,7 +667,8 @@ message CreateAssetRequest { // Update asset request. message UpdateAssetRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -695,9 +685,7 @@ message DeleteAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; } @@ -707,18 +695,16 @@ message ListAssetsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; - // Optional. Maximum number of asset to return. The service may return fewer than - // this value. If unspecified, at most 10 assets will be returned. The + // Optional. Maximum number of asset to return. The service may return fewer + // than this value. If unspecified, at most 10 assets will be returned. The // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListAssets` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListAssets` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListAssets` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -746,20 +732,18 @@ message ListAssetActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListAssetActions` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListAssetActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListAssetActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListAssetActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -769,19 +753,19 @@ message GetAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; } // Represents the metadata of a 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]; @@ -794,8 +778,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. @@ -808,9 +793,7 @@ message CreateTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Task identifier. @@ -827,7 +810,8 @@ message CreateTaskRequest { // Update task request. message UpdateTaskRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -844,9 +828,7 @@ message DeleteTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; } @@ -856,18 +838,16 @@ message ListTasksRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of tasks to return. The service may return fewer than this - // value. If unspecified, at most 10 tasks will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of tasks to return. The service may return fewer + // than this value. If unspecified, at most 10 tasks will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZones` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListZones` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListZones` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -897,9 +877,7 @@ message GetTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; } @@ -909,9 +887,7 @@ message GetJobRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; } @@ -921,18 +897,16 @@ message ListJobsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; - // Optional. Maximum number of jobs to return. The service may return fewer than - // this value. If unspecified, at most 10 jobs will be returned. The + // Optional. Maximum number of jobs to return. The service may return fewer + // than this value. If unspecified, at most 10 jobs will be returned. The // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListJobs` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListJobs` call. Provide this + // to retrieve the subsequent page. When paginating, all other parameters // provided to `ListJobs` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -954,9 +928,7 @@ message CancelJobRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; } @@ -966,9 +938,7 @@ message CreateEnvironmentRequest { // `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Environment identifier. @@ -990,7 +960,8 @@ message CreateEnvironmentRequest { // Update environment request. message UpdateEnvironmentRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -1019,20 +990,19 @@ message ListEnvironmentsRequest { // `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of environments to return. The service may return fewer than - // this value. If unspecified, at most 10 environments will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of environments to return. The service may return + // fewer than this value. If unspecified, at most 10 environments will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListEnvironments` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListEnvironments` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListEnvironments` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListEnvironments` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Filter request. @@ -1075,24 +1045,24 @@ message ListSessionsRequest { } ]; - // Optional. Maximum number of sessions to return. The service may return fewer than - // this value. If unspecified, at most 10 sessions will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of sessions to return. The service may return + // fewer than this value. If unspecified, at most 10 sessions will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListSessions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListSessions` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListSessions` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Filter request. The following `mode` filter is supported to return only the - // sessions belonging to the requester when the mode is USER and return - // sessions of all the users when the mode is ADMIN. When no filter is sent - // default to USER mode. - // NOTE: When the mode is ADMIN, the requester should have - // `dataplex.environments.listAllSessions` permission to list all sessions, - // in absence of the permission, the request fails. + // Optional. Filter request. The following `mode` filter is supported to + // return only the sessions belonging to the requester when the mode is USER + // and return sessions of all the users when the mode is ADMIN. When no filter + // is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + // should have `dataplex.environments.listAllSessions` permission to list all + // sessions, in absence of the permission, the request fails. // // mode = ADMIN | USER string filter = 4 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/dataplex/v1/tasks.proto b/google/cloud/dataplex/v1/tasks.proto index 8ca33dac1..6aa028636 100644 --- a/google/cloud/dataplex/v1/tasks.proto +++ b/google/cloud/dataplex/v1/tasks.proto @@ -61,24 +61,24 @@ message Task { // Optional. A list of python packages to be installed. // Valid formats include Cloud Storage URI to a PIP installable library. // For example, gs://bucket-name/my/path/to/lib.tar.gz - repeated string python_packages = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Override to common configuration of open source components installed on - // the Dataproc cluster. - // The properties to set on daemon config files. - // Property keys are specified in `prefix:property` format, for example - // `core:hadoop.tmp.dir`. - // For more information, see [Cluster + repeated string python_packages = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Override to common configuration of open source components + // installed on the Dataproc cluster. The properties to set on daemon + // config files. Property keys are specified in `prefix:property` format, + // for example `core:hadoop.tmp.dir`. For more information, see [Cluster // properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - map properties = 4 [(google.api.field_behavior) = OPTIONAL]; + map properties = 4 + [(google.api.field_behavior) = OPTIONAL]; } // Cloud VPC Network used to run the infrastructure. message VpcNetwork { // The Cloud VPC network identifier. oneof network_name { - // Optional. The Cloud VPC network in which the job is run. By default, the Cloud - // VPC network named Default within the project is used. + // Optional. The Cloud VPC network in which the job is run. By default, + // the Cloud VPC network named Default within the project is used. string network = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud VPC sub-network in which the job is run. @@ -131,7 +131,8 @@ message Task { // Optional. The first run of the task will be after this time. // If not specified, the task will run shortly after being submitted if // ON_DEMAND and based on the schedule if RECURRING. - google.protobuf.Timestamp start_time = 6 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp start_time = 6 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Prevent the task from executing. // This does not cancel already running tasks. It is intended to temporarily @@ -144,13 +145,13 @@ message Task { // Trigger only applies for RECURRING tasks. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // tasks 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 * * * *". + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running tasks 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 RECURRING tasks. string schedule = 100 [(google.api.field_behavior) = OPTIONAL]; } @@ -177,13 +178,15 @@ message Task { // used. string service_account = 5 [(google.api.field_behavior) = REQUIRED]; - // Optional. The project in which jobs are run. By default, the project containing the - // Lake is used. If a project is provided, the - // [ExecutionSpec.service_account][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account] must belong to this project. + // Optional. The project in which jobs are run. By default, the project + // containing the Lake is used. If a project is provided, the + // [ExecutionSpec.service_account][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account] + // must belong to this project. string project = 7 [(google.api.field_behavior) = OPTIONAL]; // Optional. The maximum duration after which the job execution is expired. - google.protobuf.Duration max_job_execution_lifetime = 8 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration max_job_execution_lifetime = 8 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud KMS key to use for encryption, of the form: // `projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}`. @@ -225,23 +228,47 @@ message Task { string sql_script = 105; } - // Optional. Cloud Storage URIs of files to be placed in the working directory of each - // executor. + // Optional. Cloud Storage URIs of files to be placed in the working + // directory of each executor. repeated string file_uris = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Cloud Storage URIs of archives to be extracted into the working directory - // of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and - // .zip. + // Optional. Cloud Storage URIs of archives to be extracted into the working + // directory of each executor. Supported file types: .jar, .tar, .tar.gz, + // .tgz, and .zip. repeated string archive_uris = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Infrastructure specification for the execution. - InfrastructureSpec infrastructure_spec = 6 [(google.api.field_behavior) = OPTIONAL]; + InfrastructureSpec infrastructure_spec = 6 + [(google.api.field_behavior) = OPTIONAL]; + } + + // Config for running scheduled notebooks. + message NotebookTaskConfig { + // Required. Path to input notebook. This can be the Cloud Storage URI of + // the notebook file or the path to a Notebook Content. The execution args + // are accessible as environment variables + // (`TASK_key=value`). + string notebook = 4 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Infrastructure specification for the execution. + InfrastructureSpec infrastructure_spec = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Cloud Storage URIs of files to be placed in the working + // directory of each executor. + repeated string file_uris = 5 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Cloud Storage URIs of archives to be extracted into the working + // directory of each executor. Supported file types: .jar, .tar, .tar.gz, + // .tgz, and .zip. + repeated string archive_uris = 6 [(google.api.field_behavior) = OPTIONAL]; } // Status of the task execution (e.g. Jobs). message ExecutionStatus { // Output only. Last update time of the status. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. latest job execution Job latest_job = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -252,20 +279,20 @@ message Task { // tasks/{task_id}. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; - // Output only. System generated globally unique ID for the task. This ID will be - // different if the task is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the task. This ID will + // be different if the task is deleted and re-created with the same name. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the task 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 time when the task 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. Description of the task. string description = 5 [(google.api.field_behavior) = OPTIONAL]; @@ -286,12 +313,16 @@ message Task { ExecutionSpec execution_spec = 101 [(google.api.field_behavior) = REQUIRED]; // Output only. Status of the latest task executions. - ExecutionStatus execution_status = 201 [(google.api.field_behavior) = OUTPUT_ONLY]; + ExecutionStatus execution_status = 201 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Task template specific user-specified config. oneof config { // Config related to running custom Spark tasks. SparkTaskConfig spark = 300; + + // Config related to running scheduled Notebooks. + NotebookTaskConfig notebook = 302; } } @@ -337,19 +368,19 @@ message Job { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; // Output only. System generated globally unique ID for the job. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the job was started. - google.protobuf.Timestamp start_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the job ended. - google.protobuf.Timestamp end_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Execution state for the job. State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -361,7 +392,8 @@ message Job { // Output only. The underlying service running a job. Service service = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The full resource name for the job run under a particular service. + // Output only. The full resource name for the job run under a particular + // service. string service_job = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Additional information about the current state. diff --git a/google/cloud/dataproc/BUILD.bazel b/google/cloud/dataproc/BUILD.bazel index 192ecee57..6f44e5ca0 100644 --- a/google/cloud/dataproc/BUILD.bazel +++ b/google/cloud/dataproc/BUILD.bazel @@ -22,7 +22,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-dataproc", "ruby-cloud-env-prefix=DATAPROC", - "ruby-cloud-wrapper-of=v1:0.7", + "ruby-cloud-wrapper-of=v1:0.14", "ruby-cloud-product-url=https://cloud.google.com/dataproc", "ruby-cloud-api-id=dataproc.googleapis.com", "ruby-cloud-api-shortname=dataproc", diff --git a/google/cloud/dataproc/v1/BUILD.bazel b/google/cloud/dataproc/v1/BUILD.bazel index 5eeb45672..cbb0569e9 100644 --- a/google/cloud/dataproc/v1/BUILD.bazel +++ b/google/cloud/dataproc/v1/BUILD.bazel @@ -19,6 +19,7 @@ proto_library( "operations.proto", "shared.proto", "workflow_templates.proto", + "node_groups.proto", ], deps = [ "//google/api:annotations_proto", @@ -69,6 +70,7 @@ java_gapic_library( srcs = [":dataproc_proto_with_info"], gapic_yaml = "dataproc_gapic.yaml", grpc_service_config = "dataproc_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":dataproc_java_grpc", ], @@ -90,6 +92,8 @@ java_gapic_test( "com.google.cloud.dataproc.v1.JobControllerClientTest", "com.google.cloud.dataproc.v1.WorkflowTemplateServiceClientHttpJsonTest", "com.google.cloud.dataproc.v1.WorkflowTemplateServiceClientTest", + "com.google.cloud.dataproc.v1.NodeGroupControllerClientHttpJsonTest", + "com.google.cloud.dataproc.v1.NodeGroupControllerClientTest", ], runtime_deps = [":dataproc_java_gapic_test"], ) @@ -134,13 +138,14 @@ go_gapic_library( srcs = [":dataproc_proto_with_info"], grpc_service_config = "dataproc_grpc_service_config.json", importpath = "cloud.google.com/go/dataproc/apiv1;dataproc", + rest_numeric_enums = True, service_yaml = "dataproc_v1.yaml", transport = "grpc+rest", deps = [ ":dataproc_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -176,6 +181,7 @@ py_gapic_library( name = "dataproc_py_gapic", srcs = [":dataproc_proto"], grpc_service_config = "dataproc_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -223,7 +229,9 @@ php_gapic_library( srcs = [":dataproc_proto_with_info"], gapic_yaml = "dataproc_gapic.yaml", grpc_service_config = "dataproc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataproc_v1.yaml", + transport = "grpc+rest", deps = [ ":dataproc_php_grpc", ":dataproc_php_proto", @@ -257,7 +265,9 @@ nodejs_gapic_library( grpc_service_config = "dataproc_grpc_service_config.json", main_service = "dataproc", package = "google.cloud.dataproc.v1", + rest_numeric_enums = True, service_yaml = "dataproc_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -302,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=dataproc", ], grpc_service_config = "dataproc_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", ruby_cloud_title = "Cloud Dataproc V1", deps = [ @@ -347,6 +358,7 @@ csharp_gapic_library( srcs = [":dataproc_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataproc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataproc_v1.yaml", deps = [ ":dataproc_csharp_grpc", diff --git a/google/cloud/dataproc/v1/clusters.proto b/google/cloud/dataproc/v1/clusters.proto index 9550278b9..11611fbf6 100644 --- a/google/cloud/dataproc/v1/clusters.proto +++ b/google/cloud/dataproc/v1/clusters.proto @@ -43,12 +43,14 @@ option (google.api.resource_definition) = { // of Compute Engine instances. service ClusterController { 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 cluster in a project. The returned // [Operation.metadata][google.longrunning.Operation.metadata] will be // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). - rpc CreateCluster(CreateClusterRequest) returns (google.longrunning.Operation) { + rpc CreateCluster(CreateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/projects/{project_id}/regions/{region}/clusters" body: "cluster" @@ -63,14 +65,17 @@ service ClusterController { // Updates a cluster in a project. The returned // [Operation.metadata][google.longrunning.Operation.metadata] will be // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). - // The cluster must be in a [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error + // The cluster must be in a + // [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error // is returned. - rpc UpdateCluster(UpdateClusterRequest) returns (google.longrunning.Operation) { + rpc UpdateCluster(UpdateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}" body: "cluster" }; - option (google.api.method_signature) = "project_id,region,cluster_name,cluster,update_mask"; + option (google.api.method_signature) = + "project_id,region,cluster_name,cluster,update_mask"; option (google.longrunning.operation_info) = { response_type: "Cluster" metadata_type: "google.cloud.dataproc.v1.ClusterOperationMetadata" @@ -104,7 +109,8 @@ service ClusterController { // Deletes a cluster in a project. The returned // [Operation.metadata][google.longrunning.Operation.metadata] will be // [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). - rpc DeleteCluster(DeleteClusterRequest) returns (google.longrunning.Operation) { + rpc DeleteCluster(DeleteClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}" }; @@ -139,7 +145,8 @@ service ClusterController { // [Operation.response][google.longrunning.Operation.response] // contains // [DiagnoseClusterResults](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults). - rpc DiagnoseCluster(DiagnoseClusterRequest) returns (google.longrunning.Operation) { + rpc DiagnoseCluster(DiagnoseClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}:diagnose" body: "*" @@ -158,8 +165,10 @@ message Cluster { // Required. The Google Cloud Platform project ID that the cluster belongs to. string project_id = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The cluster name. Cluster names within a project must be - // unique. Names of deleted clusters can be reused. + // Required. The cluster name, which must be unique within a project. + // The name must start with a lowercase letter, and can contain + // up to 51 lowercase letters, numbers, and hyphens. It cannot end + // with a hyphen. The name of a deleted cluster can be reused. string cluster_name = 2 [(google.api.field_behavior) = REQUIRED]; // Optional. The cluster config for a cluster of Compute Engine Instances. @@ -167,14 +176,17 @@ message Cluster { // when clusters are updated. ClusterConfig config = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The virtual cluster config, 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/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster). - // Note that Dataproc may set default values, and values may change when - // clusters are updated. Exactly one of config or virtualClusterConfig must be - // specified. - VirtualClusterConfig virtual_cluster_config = 10 [(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). + // Dataproc may set default values, and values may change when + // clusters are updated. Exactly one of + // [config][google.cloud.dataproc.v1.Cluster.config] or + // [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config] + // must be specified. + VirtualClusterConfig virtual_cluster_config = 10 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The labels to associate with this cluster. // Label **keys** must contain 1 to 63 characters, and must conform to @@ -189,7 +201,8 @@ message Cluster { ClusterStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The previous cluster status. - repeated ClusterStatus status_history = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ClusterStatus status_history = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. A cluster UUID (Unique Universal Identifier). Dataproc // generates this value when it creates the cluster. @@ -217,15 +230,13 @@ message ClusterConfig { // a Cloud Storage bucket.** string config_bucket = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, - // such as Spark and MapReduce history files. - // If you do not specify a temp bucket, - // Dataproc will determine a Cloud Storage location (US, - // ASIA, or EU) for your cluster's temp bucket according to the - // Compute Engine zone where your cluster is deployed, and then create - // and manage this project-level, per-location bucket. The default bucket has - // a TTL of 90 days, but you can use any TTL (or none) if you specify a - // bucket (see + // Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs + // data, such as Spark and MapReduce history files. If you do not specify a + // temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or + // EU) for your cluster's temp bucket according to the Compute Engine zone + // where your cluster is deployed, and then create and manage this + // project-level, per-location bucket. The default bucket has a TTL of 90 + // days, but you can use any TTL (or none) if you specify a bucket (see // [Dataproc staging and temp // buckets](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). // **This field requires a Cloud Storage bucket name, not a `gs://...` URI to @@ -234,19 +245,23 @@ message ClusterConfig { // Optional. The shared Compute Engine config settings for // all instances in a cluster. - GceClusterConfig gce_cluster_config = 8 [(google.api.field_behavior) = OPTIONAL]; + GceClusterConfig gce_cluster_config = 8 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Compute Engine config settings for // the cluster's master instance. - InstanceGroupConfig master_config = 9 [(google.api.field_behavior) = OPTIONAL]; + InstanceGroupConfig master_config = 9 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Compute Engine config settings for // the cluster's worker instances. - InstanceGroupConfig worker_config = 10 [(google.api.field_behavior) = OPTIONAL]; + InstanceGroupConfig worker_config = 10 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Compute Engine config settings for // a cluster's secondary worker instances - InstanceGroupConfig secondary_worker_config = 12 [(google.api.field_behavior) = OPTIONAL]; + InstanceGroupConfig secondary_worker_config = 12 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The config settings for cluster software. SoftwareConfig software_config = 13 [(google.api.field_behavior) = OPTIONAL]; @@ -264,36 +279,46 @@ message ClusterConfig { // else // ... worker specific actions ... // fi - repeated NodeInitializationAction initialization_actions = 11 [(google.api.field_behavior) = OPTIONAL]; + repeated NodeInitializationAction initialization_actions = 11 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Encryption settings for the cluster. - EncryptionConfig encryption_config = 15 [(google.api.field_behavior) = OPTIONAL]; + EncryptionConfig encryption_config = 15 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Autoscaling config for the policy associated with the cluster. // Cluster does not autoscale if this field is unset. - AutoscalingConfig autoscaling_config = 18 [(google.api.field_behavior) = OPTIONAL]; + AutoscalingConfig autoscaling_config = 18 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Security settings for the cluster. SecurityConfig security_config = 16 [(google.api.field_behavior) = OPTIONAL]; // Optional. Lifecycle setting for the cluster. - LifecycleConfig lifecycle_config = 17 [(google.api.field_behavior) = OPTIONAL]; + LifecycleConfig lifecycle_config = 17 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Port/endpoint configuration for this cluster EndpointConfig endpoint_config = 19 [(google.api.field_behavior) = OPTIONAL]; // Optional. Metastore configuration. - MetastoreConfig metastore_config = 20 [(google.api.field_behavior) = OPTIONAL]; + MetastoreConfig metastore_config = 20 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The config for Dataproc metrics. - DataprocMetricConfig dataproc_metric_config = 23 [(google.api.field_behavior) = OPTIONAL]; + DataprocMetricConfig dataproc_metric_config = 23 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The node group settings. + repeated AuxiliaryNodeGroup auxiliary_node_groups = 25 + [(google.api.field_behavior) = OPTIONAL]; } -// Dataproc cluster config for a cluster that does not directly control the +// 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/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster). +// cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke). message VirtualClusterConfig { - // Optional. A Storage bucket used to stage job + // Optional. A Cloud Storage bucket used to stage job // dependencies, config files, and job driver console output. // If you do not specify a staging bucket, Cloud // Dataproc will determine a Cloud Storage location (US, @@ -307,12 +332,15 @@ message VirtualClusterConfig { string staging_bucket = 1 [(google.api.field_behavior) = OPTIONAL]; oneof infrastructure_config { - // Required. The configuration for running the Dataproc cluster on Kubernetes. - KubernetesClusterConfig kubernetes_cluster_config = 6 [(google.api.field_behavior) = REQUIRED]; + // Required. The configuration for running the Dataproc cluster on + // Kubernetes. + KubernetesClusterConfig kubernetes_cluster_config = 6 + [(google.api.field_behavior) = REQUIRED]; } // Optional. Configuration of auxiliary services used by this cluster. - AuxiliaryServicesConfig auxiliary_services_config = 7 [(google.api.field_behavior) = OPTIONAL]; + AuxiliaryServicesConfig auxiliary_services_config = 7 + [(google.api.field_behavior) = OPTIONAL]; } // Auxiliary services configuration for a Cluster. @@ -321,14 +349,16 @@ message AuxiliaryServicesConfig { MetastoreConfig metastore_config = 1 [(google.api.field_behavior) = OPTIONAL]; // 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]; } // Endpoint config for this cluster message EndpointConfig { // Output only. The map of port descriptions to URLs. Will only be populated // if enable_http_port_access is true. - map http_ports = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + map http_ports = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. If true, enable http access to specific ports on the cluster // from external sources. Defaults to false. @@ -366,7 +396,8 @@ message GceClusterConfig { // fields](https://cloud.google.com/compute/docs/reference/rest/v1/instances). enum PrivateIpv6GoogleAccess { // If unspecified, Compute Engine default behavior will apply, which - // is the same as [INHERIT_FROM_SUBNETWORK][google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess.INHERIT_FROM_SUBNETWORK]. + // is the same as + // [INHERIT_FROM_SUBNETWORK][google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess.INHERIT_FROM_SUBNETWORK]. PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED = 0; // Private access to and from Google Services configuration @@ -429,7 +460,8 @@ message GceClusterConfig { 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 [(google.api.field_behavior) = OPTIONAL]; + PrivateIpv6GoogleAccess private_ipv6_google_access = 12 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The [Dataproc service // account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) @@ -458,7 +490,8 @@ message GceClusterConfig { // * https://www.googleapis.com/auth/bigtable.admin.table // * https://www.googleapis.com/auth/bigtable.data // * https://www.googleapis.com/auth/devstorage.full_control - repeated string service_account_scopes = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated string service_account_scopes = 3 + [(google.api.field_behavior) = OPTIONAL]; // The Compute Engine tags to add to all instances (see [Tagging // instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). @@ -470,21 +503,28 @@ message GceClusterConfig { map metadata = 5; // Optional. Reservation Affinity for consuming Zonal reservation. - ReservationAffinity reservation_affinity = 11 [(google.api.field_behavior) = OPTIONAL]; + ReservationAffinity reservation_affinity = 11 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Node Group Affinity for sole-tenant clusters. - NodeGroupAffinity node_group_affinity = 13 [(google.api.field_behavior) = OPTIONAL]; + NodeGroupAffinity node_group_affinity = 13 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. Shielded Instance Config for clusters using [Compute Engine Shielded + // Optional. Shielded Instance Config for clusters using [Compute Engine + // Shielded // VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm). - ShieldedInstanceConfig shielded_instance_config = 14 [(google.api.field_behavior) = OPTIONAL]; + ShieldedInstanceConfig shielded_instance_config = 14 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Confidential Instance Config for clusters using [Confidential // VMs](https://cloud.google.com/compute/confidential-vm/docs). - ConfidentialInstanceConfig confidential_instance_config = 15 [(google.api.field_behavior) = OPTIONAL]; + ConfidentialInstanceConfig confidential_instance_config = 15 + [(google.api.field_behavior) = OPTIONAL]; } // Node Group Affinity for clusters using sole-tenant node groups. +// **The Dataproc `NodeGroupAffinity` resource is not related to the +// Dataproc [NodeGroup][google.cloud.dataproc.v1.NodeGroup] resource.** message NodeGroupAffinity { // Required. The URI of a // sole-tenant [node group @@ -515,17 +555,15 @@ message ShieldedInstanceConfig { // Confidential Instance Config for clusters using [Confidential // VMs](https://cloud.google.com/compute/confidential-vm/docs) message ConfidentialInstanceConfig { - // Optional. Defines whether the instance should have confidential compute enabled. + // Optional. Defines whether the instance should have confidential compute + // enabled. bool enable_confidential_compute = 1 [(google.api.field_behavior) = OPTIONAL]; } // The config settings for Compute Engine resources in // an instance group, such as a master or worker group. message InstanceGroupConfig { - // Controls the use of - // [preemptible instances] - // (https://cloud.google.com/compute/docs/instances/preemptible) - // within the group. + // Controls the use of preemptible instances within the group. enum Preemptibility { // Preemptibility is unspecified, the system will choose the // appropriate setting for each instance group. @@ -537,9 +575,12 @@ message InstanceGroupConfig { // value for Master and Worker instance groups. NON_PREEMPTIBLE = 1; - // Instances are preemptible. + // Instances are [preemptible] + // (https://cloud.google.com/compute/docs/instances/preemptible). // - // This option is allowed only for secondary worker groups. + // This option is allowed only for [secondary worker] + // (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) + // groups. PREEMPTIBLE = 2; } @@ -553,7 +594,8 @@ message InstanceGroupConfig { // Output only. The list of instance names. Dataproc derives the names // from `cluster_name`, `num_instances`, and the instance group. - repeated string instance_names = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string instance_names = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The Compute Engine image resource used for cluster instances. // @@ -609,11 +651,13 @@ message InstanceGroupConfig { // Output only. The config for Compute Engine Instance Group // Manager that manages this group. // This is only used for preemptible instance groups. - ManagedGroupConfig managed_group_config = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + ManagedGroupConfig managed_group_config = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The Compute Engine accelerator configuration for these // instances. - repeated AcceleratorConfig accelerators = 8 [(google.api.field_behavior) = OPTIONAL]; + repeated AcceleratorConfig accelerators = 8 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Specifies the minimum cpu platform for the Instance Group. // See [Dataproc -> Minimum CPU @@ -628,7 +672,8 @@ message ManagedGroupConfig { string instance_template_name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The name of the Instance Group Manager for this group. - string instance_group_manager_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + string instance_group_manager_name = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Specifies the type and number of accelerator cards attached to the instances @@ -669,7 +714,7 @@ message DiskConfig { // Optional. Size in GB of the boot disk (default is 500GB). int32 boot_disk_size_gb = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Number of attached SSDs, from 0 to 4 (default is 0). + // Optional. Number of attached SSDs, from 0 to 8 (default is 0). // If SSDs are not attached, the boot disk is used to store runtime logs and // [HDFS](https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. // If one or more SSDs are attached, this runtime bulk @@ -685,6 +730,59 @@ message DiskConfig { string local_ssd_interface = 4 [(google.api.field_behavior) = OPTIONAL]; } +// Node group identification and configuration information. +message AuxiliaryNodeGroup { + // Required. Node group configuration. + NodeGroup node_group = 1 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A node group ID. Generated if not specified. + // + // The ID must contain only letters (a-z, A-Z), numbers (0-9), + // underscores (_), and hyphens (-). Cannot begin or end with underscore + // or hyphen. Must consist of from 3 to 33 characters. + string node_group_id = 2 [(google.api.field_behavior) = OPTIONAL]; +} + +// Dataproc Node Group. +// **The Dataproc `NodeGroup` resource is not related to the +// Dataproc [NodeGroupAffinity][google.cloud.dataproc.v1.NodeGroupAffinity] +// resource.** +message NodeGroup { + option (google.api.resource) = { + type: "dataproc.googleapis.com/NodeGroup" + pattern: "projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{node_group}" + }; + + // Node group roles. + enum Role { + // Required unspecified role. + ROLE_UNSPECIFIED = 0; + + // Job drivers run on the node group. + DRIVER = 1; + } + + // The Node group [resource name](https://aip.dev/122). + string name = 1; + + // Required. Node group roles. + repeated Role roles = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The node group instance group configuration. + InstanceGroupConfig node_group_config = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Node group labels. + // + // * Label **keys** must consist of from 1 to 63 characters and conform to + // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). + // * Label **values** can be empty. If specified, they must consist of from + // 1 to 63 characters and conform to [RFC 1035] + // (https://www.ietf.org/rfc/rfc1035.txt). + // * The node group must have no more than 32 labels. + map labels = 4 [(google.api.field_behavior) = OPTIONAL]; +} + // Specifies an executable to run on a fully configured node and a // timeout period for executable completion. message NodeInitializationAction { @@ -698,7 +796,8 @@ message NodeInitializationAction { // Cluster creation fails with an explanatory error message (the // name of the executable that caused the error and the exceeded timeout // period) if the executable is not completed at end of the timeout period. - google.protobuf.Duration execution_timeout = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration execution_timeout = 2 + [(google.api.field_behavior) = OPTIONAL]; } // The status of a cluster and its instances. @@ -771,7 +870,8 @@ message ClusterStatus { // Output only. Time when this state was entered (see JSON representation of // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)). - google.protobuf.Timestamp state_start_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp state_start_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Additional state information that includes // status reported by the agent. @@ -790,13 +890,14 @@ message SecurityConfig { // Specifies Kerberos related configuration. message KerberosConfig { - // Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set - // this field to true to enable Kerberos on a cluster. + // Optional. Flag to indicate whether to Kerberize the cluster (default: + // false). Set this field to true to enable Kerberos on a cluster. bool enable_kerberos = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud Storage URI of a KMS encrypted file containing the root // principal password. - string root_principal_password_uri = 2 [(google.api.field_behavior) = OPTIONAL]; + string root_principal_password_uri = 2 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The uri of the KMS key used to encrypt various sensitive // files. @@ -837,12 +938,14 @@ message KerberosConfig { // Optional. The admin server (IP or hostname) for the remote trusted realm in // a cross realm trust relationship. - string cross_realm_trust_admin_server = 11 [(google.api.field_behavior) = OPTIONAL]; + string cross_realm_trust_admin_server = 11 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud Storage URI of a KMS encrypted file containing the // shared password between the on-cluster Kerberos realm and the remote // trusted realm, in a cross realm trust relationship. - string cross_realm_trust_shared_password_uri = 12 [(google.api.field_behavior) = OPTIONAL]; + string cross_realm_trust_shared_password_uri = 12 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud Storage URI of a KMS encrypted file containing the // master key of the KDC database. @@ -862,7 +965,8 @@ message KerberosConfig { // secure multi-tenancy user mappings. message IdentityConfig { // Required. Map of user to service account. - map user_service_account_mapping = 1 [(google.api.field_behavior) = REQUIRED]; + map user_service_account_mapping = 1 + [(google.api.field_behavior) = REQUIRED]; } // Specifies the selection and config of software inside the cluster. @@ -897,7 +1001,8 @@ message SoftwareConfig { map properties = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The set of components to activate on the cluster. - repeated Component optional_components = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated Component optional_components = 3 + [(google.api.field_behavior) = OPTIONAL]; } // Specifies the cluster auto-delete schedule configuration. @@ -907,27 +1012,32 @@ message LifecycleConfig { // deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON // representation of // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). - google.protobuf.Duration idle_delete_ttl = 1 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration idle_delete_ttl = 1 + [(google.api.field_behavior) = OPTIONAL]; // Either the exact time the cluster should be deleted at or // the cluster maximum age. oneof ttl { - // Optional. The time when cluster will be auto-deleted (see JSON representation of + // Optional. The time when cluster will be auto-deleted (see JSON + // representation of // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)). - google.protobuf.Timestamp auto_delete_time = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp auto_delete_time = 2 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The lifetime duration of cluster. The cluster will be // auto-deleted at the end of this period. Minimum value is 10 minutes; // maximum value is 14 days (see JSON representation of // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). - google.protobuf.Duration auto_delete_ttl = 3 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration auto_delete_ttl = 3 + [(google.api.field_behavior) = OPTIONAL]; } // Output only. The time when cluster became idle (most recent job finished) // and became eligible for deletion due to idleness (see JSON representation // of // [Timestamp](https://developers.google.com/protocol-buffers/docs/proto3#json)). - google.protobuf.Timestamp idle_start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp idle_start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Specifies a Metastore configuration. @@ -945,7 +1055,6 @@ message MetastoreConfig { ]; } - // Dataproc metric config. message DataprocMetricConfig { // A source for the collection of Dataproc OSS metrics (see [available OSS @@ -1014,7 +1123,8 @@ message DataprocMetricConfig { // sources is unaffected. For example, if both `SPARK` andd `YARN` metric // sources are enabled, and overrides are provided for Spark metrics only, // all default YARN metrics will be collected. - repeated string metric_overrides = 2 [(google.api.field_behavior) = OPTIONAL]; + repeated string metric_overrides = 2 + [(google.api.field_behavior) = OPTIONAL]; } // Required. Metrics sources to enable. @@ -1045,11 +1155,12 @@ message CreateClusterRequest { // Required. The cluster to create. Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A unique ID used to identify the request. If the server receives two + // Optional. A unique ID used to identify the request. If the server receives + // two // [CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s // with the same id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend - // is returned. + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -1059,7 +1170,8 @@ message CreateClusterRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Failure action when primary worker creation fails. - FailureAction action_on_failed_primary_workers = 5 [(google.api.field_behavior) = OPTIONAL]; + FailureAction action_on_failed_primary_workers = 5 + [(google.api.field_behavior) = OPTIONAL]; } // A request to update a cluster. @@ -1086,7 +1198,8 @@ message UpdateClusterRequest { // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). // // Only supported on Dataproc image versions 1.2 and higher. - google.protobuf.Duration graceful_decommission_timeout = 6 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration graceful_decommission_timeout = 6 + [(google.api.field_behavior) = OPTIONAL]; // Required. Specifies the path, relative to `Cluster`, of // the field to update. For example, to change the number of workers @@ -1139,14 +1252,15 @@ message UpdateClusterRequest { // // //
- google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 4 + [(google.api.field_behavior) = REQUIRED]; // Optional. A unique ID used to identify the request. If the server // receives two // [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s // with the same id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -1176,8 +1290,8 @@ message StopClusterRequest { // receives two // [StopClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s // with the same id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // Recommendation: Set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -1207,8 +1321,8 @@ message StartClusterRequest { // receives two // [StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s // with the same id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // Recommendation: Set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -1238,8 +1352,8 @@ message DeleteClusterRequest { // receives two // [DeleteClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s // with the same id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). diff --git a/google/cloud/dataproc/v1/dataproc_v1.yaml b/google/cloud/dataproc/v1/dataproc_v1.yaml index b47627018..7f1d640fa 100644 --- a/google/cloud/dataproc/v1/dataproc_v1.yaml +++ b/google/cloud/dataproc/v1/dataproc_v1.yaml @@ -8,6 +8,7 @@ apis: - name: google.cloud.dataproc.v1.BatchController - name: google.cloud.dataproc.v1.ClusterController - name: google.cloud.dataproc.v1.JobController +- name: google.cloud.dataproc.v1.NodeGroupController - name: google.cloud.dataproc.v1.WorkflowTemplateService types: @@ -15,6 +16,7 @@ types: - name: google.cloud.dataproc.v1.ClusterOperationMetadata - name: google.cloud.dataproc.v1.DiagnoseClusterResults - name: google.cloud.dataproc.v1.JobMetadata +- name: google.cloud.dataproc.v1.NodeGroupOperationMetadata - name: google.cloud.dataproc.v1.WorkflowMetadata documentation: @@ -120,6 +122,10 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.dataproc.v1.NodeGroupController.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.cloud.dataproc.v1.WorkflowTemplateService.*' oauth: canonical_scopes: |- diff --git a/google/cloud/dataproc/v1/jobs.proto b/google/cloud/dataproc/v1/jobs.proto index 823a12cf8..e9dcf9cc6 100644 --- a/google/cloud/dataproc/v1/jobs.proto +++ b/google/cloud/dataproc/v1/jobs.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. @@ -32,7 +32,8 @@ option java_package = "com.google.cloud.dataproc.v1"; // The JobController provides methods to manage jobs. service JobController { 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"; // Submits a job to a cluster. rpc SubmitJob(SubmitJobRequest) returns (Job) { @@ -44,7 +45,8 @@ service JobController { } // Submits job to a cluster. - rpc SubmitJobAsOperation(SubmitJobRequest) returns (google.longrunning.Operation) { + rpc SubmitJobAsOperation(SubmitJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/projects/{project_id}/regions/{region}/jobs:submitAsOperation" body: "*" @@ -198,7 +200,7 @@ message HadoopJob { LoggingConfig logging_config = 8 [(google.api.field_behavior) = OPTIONAL]; } -// A Dataproc job for running [Apache Spark](http://spark.apache.org/) +// A Dataproc job for running [Apache Spark](https://spark.apache.org/) // applications on YARN. message SparkJob { // Required. The specification of the main method to call to drive the job. @@ -323,7 +325,8 @@ message HiveJob { // Optional. Mapping of query variable names to values (equivalent to the // Hive command: `SET name="value";`). - map script_variables = 4 [(google.api.field_behavior) = OPTIONAL]; + map script_variables = 4 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A mapping of property names and values, used to configure Hive. // Properties that conflict with values set by the Dataproc API may be @@ -338,7 +341,7 @@ message HiveJob { } // A Dataproc job for running [Apache Spark -// SQL](http://spark.apache.org/sql/) queries. +// SQL](https://spark.apache.org/sql/) queries. message SparkSqlJob { // Required. The sequence of Spark SQL queries to execute, specified as // either an HCFS file URI or as a list of queries. @@ -352,7 +355,8 @@ message SparkSqlJob { // Optional. Mapping of query variable names to values (equivalent to the // Spark SQL command: SET `name="value";`). - map script_variables = 3 [(google.api.field_behavior) = OPTIONAL]; + map script_variables = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A mapping of property names to values, used to configure // Spark SQL's SparkConf. Properties that conflict with values set by the @@ -386,7 +390,8 @@ message PigJob { // Optional. Mapping of query variable names to values (equivalent to the Pig // command: `name=[value]`). - map script_variables = 4 [(google.api.field_behavior) = OPTIONAL]; + map script_variables = 4 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A mapping of property names to values, used to configure Pig. // Properties that conflict with values set by the Dataproc API may be @@ -480,8 +485,10 @@ message JobPlacement { // the job is submitted. string cluster_uuid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Cluster labels to identify a cluster where the job will be submitted. - map cluster_labels = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Cluster labels to identify a cluster where the job will be + // submitted. + map cluster_labels = 3 + [(google.api.field_behavior) = OPTIONAL]; } // Dataproc job status. @@ -560,7 +567,8 @@ message JobStatus { ]; // Output only. The time when this state was entered. - google.protobuf.Timestamp state_start_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp state_start_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Additional state information, which includes // status reported by the agent. @@ -569,8 +577,8 @@ message JobStatus { // Encapsulates the full scoping used to reference a job. message JobReference { - // Optional. The ID of the Google Cloud Platform project that the job belongs to. If - // specified, must match the request project ID. + // Optional. The ID of the Google Cloud Platform project that the job belongs + // to. If specified, must match the request project ID. string project_id = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The job ID, which must be unique within the project. @@ -680,22 +688,26 @@ message Job { JobStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The previous job status. - repeated JobStatus status_history = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated JobStatus status_history = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The collection of YARN applications spun up by this job. // // **Beta** Feature: This report is available for testing purposes only. It // may be changed before final release. - repeated YarnApplication yarn_applications = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated YarnApplication yarn_applications = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. A URI pointing to the location of the stdout of the job's // driver program. - string driver_output_resource_uri = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + string driver_output_resource_uri = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. If present, the location of miscellaneous control files // which may be used as part of job setup and handling. If not present, // control files may be placed in the same location as `driver_output_uri`. - string driver_control_files_uri = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + string driver_control_files_uri = 15 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The labels to associate with this job. // Label **keys** must contain 1 to 63 characters, and must conform to @@ -714,11 +726,24 @@ message Job { // may be reused over time. string job_uuid = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Indicates whether the job is completed. If the value is `false`, - // the job is still in progress. If `true`, the job is completed, and + // Output only. Indicates whether the job is completed. If the value is + // `false`, the job is still in progress. If `true`, the job is completed, and // `status.state` field will indicate if it was successful, failed, // or cancelled. bool done = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. Driver scheduling configuration. + DriverSchedulingConfig driver_scheduling_config = 27 + [(google.api.field_behavior) = OPTIONAL]; +} + +// Driver scheduling configuration. +message DriverSchedulingConfig { + // Required. The amount of memory in MB the driver is requesting. + int32 memory_mb = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The number of vCPUs the driver is requesting. + int32 vcores = 2 [(google.api.field_behavior) = REQUIRED]; } // Job scheduling options. @@ -727,27 +752,26 @@ message JobScheduling { // a result of driver exiting with non-zero code before job is // reported failed. // - // A job may be reported as thrashing if driver exits with non-zero code - // 4 times within 10 minute window. + // A job may be reported as thrashing if the driver exits with a non-zero code + // four times within a 10-minute window. // // Maximum value is 10. // - // **Note:** Currently, this restartable job option is - // not supported in Dataproc - // [workflow - // template](https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template) - // jobs. + // **Note:** This restartable job option is not supported in Dataproc + // [workflow templates] + // (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template). int32 max_failures_per_hour = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Maximum number of times in total a driver may be restarted as a result of - // driver exiting with non-zero code before job is reported failed. + // Optional. Maximum total number of times a driver may be restarted as a + // result of the driver exiting with a non-zero code. After the maximum number + // is reached, the job will be reported as failed. + // // Maximum value is 240. // // **Note:** Currently, this restartable job option is // not supported in Dataproc // [workflow - // template](https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template) - // jobs. + // templates](https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template). int32 max_failures_total = 2 [(google.api.field_behavior) = OPTIONAL]; } @@ -790,7 +814,8 @@ message JobMetadata { string operation_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Job submission 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]; } // A request to get the resource representation for a job in a project. @@ -843,7 +868,8 @@ message ListJobsRequest { // (default = match ALL jobs). // // If `filter` is provided, `jobStateMatcher` will be ignored. - JobStateMatcher job_state_matcher = 5 [(google.api.field_behavior) = OPTIONAL]; + JobStateMatcher job_state_matcher = 5 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A filter constraining the jobs to list. Filters are // case-sensitive and have the following syntax: @@ -883,7 +909,8 @@ message UpdateJobRequest { // labels, and the `PATCH` request body would specify the new // value. Note: Currently, labels is the only // field that can be updated. - google.protobuf.FieldMask update_mask = 5 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 5 + [(google.api.field_behavior) = REQUIRED]; } // A list of jobs in a project. diff --git a/google/cloud/dataproc/v1/node_groups.proto b/google/cloud/dataproc/v1/node_groups.proto new file mode 100644 index 000000000..0abc22382 --- /dev/null +++ b/google/cloud/dataproc/v1/node_groups.proto @@ -0,0 +1,174 @@ +// 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.dataproc.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/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 java_multiple_files = true; +option java_outer_classname = "NodeGroupsProto"; +option java_package = "com.google.cloud.dataproc.v1"; +option (google.api.resource_definition) = { + type: "dataproc.googleapis.com/ClusterRegion" + pattern: "projects/{project}/regions/{region}/clusters/{cluster}" +}; + +// The `NodeGroupControllerService` provides methods to manage node groups +// of Compute Engine managed instances. +service NodeGroupController { + option (google.api.default_host) = "dataproc.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; + + // Creates a node group in a cluster. The returned + // [Operation.metadata][google.longrunning.Operation.metadata] is + // [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata). + rpc CreateNodeGroup(CreateNodeGroupRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/regions/*/clusters/*}/nodeGroups" + body: "node_group" + }; + option (google.api.method_signature) = "parent,node_group,node_group_id"; + option (google.longrunning.operation_info) = { + response_type: "NodeGroup" + metadata_type: "google.cloud.dataproc.v1.NodeGroupOperationMetadata" + }; + } + + // Resizes a node group in a cluster. The returned + // [Operation.metadata][google.longrunning.Operation.metadata] is + // [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata). + rpc ResizeNodeGroup(ResizeNodeGroupRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}:resize" + body: "*" + }; + option (google.api.method_signature) = "name,size"; + option (google.longrunning.operation_info) = { + response_type: "NodeGroup" + metadata_type: "google.cloud.dataproc.v1.NodeGroupOperationMetadata" + }; + } + + // Gets the resource representation for a node group in a + // cluster. + rpc GetNodeGroup(GetNodeGroupRequest) returns (NodeGroup) { + option (google.api.http) = { + get: "/v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}" + }; + option (google.api.method_signature) = "name"; + } +} + +// A request to create a node group. +message CreateNodeGroupRequest { + // Required. The parent resource where this node group will be created. + // Format: `projects/{project}/regions/{region}/clusters/{cluster}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "dataproc.googleapis.com/NodeGroup" + } + ]; + + // Required. The node group to create. + NodeGroup node_group = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. An optional node group ID. Generated if not specified. + // + // The ID must contain only letters (a-z, A-Z), numbers (0-9), + // underscores (_), and hyphens (-). Cannot begin or end with underscore + // or hyphen. Must consist of from 3 to 33 characters. + string node_group_id = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A unique ID used to identify the request. If the server receives + // two + // [CreateNodeGroupRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests) + // with the same ID, the second request is ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. + // + // Recommendation: Set this value to a + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). + // + // The ID must contain only letters (a-z, A-Z), numbers (0-9), + // underscores (_), and hyphens (-). The maximum length is 40 characters. + string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// A request to resize a node group. +message ResizeNodeGroupRequest { + // Required. The name of the node group to resize. + // Format: + // `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}` + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The number of running instances for the node group to maintain. + // The group adds or removes instances to maintain the number of instances + // specified by this parameter. + int32 size = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A unique ID used to identify the request. If the server receives + // two + // [ResizeNodeGroupRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests) + // with the same ID, the second request is ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. + // + // Recommendation: Set this value to a + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). + // + // The ID must contain only letters (a-z, A-Z), numbers (0-9), + // 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 + // 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 + // without interrupting jobs in progress. This timeout specifies how long to + // wait for jobs in progress to finish before forcefully removing nodes (and + // potentially interrupting jobs). Default timeout is 0 (for forceful + // decommission), and the maximum allowed timeout is 1 day. (see JSON + // representation of + // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). + // + // Only supported on Dataproc image versions 1.2 and higher. + google.protobuf.Duration graceful_decommission_timeout = 4 + [(google.api.field_behavior) = OPTIONAL]; +} + +// A request to get a node group . +message GetNodeGroupRequest { + // Required. The name of the node group to retrieve. + // Format: + // `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "dataproc.googleapis.com/NodeGroup" + } + ]; +} diff --git a/google/cloud/dataproc/v1/operations.proto b/google/cloud/dataproc/v1/operations.proto index e12bd299a..854d9eda6 100644 --- a/google/cloud/dataproc/v1/operations.proto +++ b/google/cloud/dataproc/v1/operations.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. @@ -87,7 +87,8 @@ message ClusterOperationStatus { string details = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time this state was entered. - google.protobuf.Timestamp state_start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp state_start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Metadata describing the operation. @@ -102,7 +103,8 @@ message ClusterOperationMetadata { ClusterOperationStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The previous operation status. - repeated ClusterOperationStatus status_history = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ClusterOperationStatus status_history = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The operation type. string operation_type = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -116,3 +118,49 @@ message ClusterOperationMetadata { // Output only. Errors encountered during operation execution. repeated string warnings = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; } + +// Metadata describing the node group operation. +message NodeGroupOperationMetadata { + // Operation type for node group resources. + enum NodeGroupOperationType { + // Node group operation type is unknown. + NODE_GROUP_OPERATION_TYPE_UNSPECIFIED = 0; + + // Create node group operation type. + CREATE = 1; + + // Update node group operation type. + UPDATE = 2; + + // Delete node group operation type. + DELETE = 3; + + // Resize node group operation type. + RESIZE = 4; + } + + // Output only. Node group ID for the operation. + string node_group_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Cluster UUID associated with the node group operation. + string cluster_uuid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Current operation status. + ClusterOperationStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The previous operation status. + repeated ClusterOperationStatus status_history = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The operation type. + NodeGroupOperationType operation_type = 5; + + // Output only. Short description of operation. + string description = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Labels associated with the operation. + map labels = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Errors encountered during operation execution. + repeated string warnings = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/cloud/dataqna/v1alpha/BUILD.bazel b/google/cloud/dataqna/v1alpha/BUILD.bazel index a3a958f5e..3988a296e 100644 --- a/google/cloud/dataqna/v1alpha/BUILD.bazel +++ b/google/cloud/dataqna/v1alpha/BUILD.bazel @@ -74,6 +74,7 @@ java_gapic_library( name = "dataqna_java_gapic", srcs = [":dataqna_proto_with_info"], grpc_service_config = "dataqna_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":dataqna_java_grpc", ], @@ -134,6 +135,7 @@ go_gapic_library( srcs = [":dataqna_proto_with_info"], grpc_service_config = "dataqna_grpc_service_config.json", importpath = "cloud.google.com/go/dataqna/apiv1alpha;dataqna", + rest_numeric_enums = False, service_yaml = "dataqna_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -172,7 +174,11 @@ py_gapic_library( name = "dataqna_py_gapic", srcs = [":dataqna_proto"], grpc_service_config = "dataqna_grpc_service_config.json", - transport = "grpc+rest", + opt_args = [ + "warehouse-package-name=google-cloud-data-qna", + ], + rest_numeric_enums = False, + transport = "grpc", ) py_test( @@ -218,6 +224,8 @@ php_gapic_library( name = "dataqna_php_gapic", srcs = [":dataqna_proto_with_info"], grpc_service_config = "dataqna_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":dataqna_php_grpc", ":dataqna_php_proto", @@ -250,7 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dataqna_grpc_service_config.json", package = "google.cloud.dataqna.v1alpha", + rest_numeric_enums = False, service_yaml = "dataqna_v1alpha.yaml", + transport = "grpc", deps = [], ) @@ -296,6 +306,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=dataqna", ], grpc_service_config = "dataqna_grpc_service_config.json", + 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", deps = [ @@ -341,6 +352,7 @@ csharp_gapic_library( srcs = [":dataqna_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataqna_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "dataqna_v1alpha.yaml", deps = [ ":dataqna_csharp_grpc", diff --git a/google/cloud/datastream/v1/BUILD.bazel b/google/cloud/datastream/v1/BUILD.bazel index f6d66982e..d0221b0ff 100644 --- a/google/cloud/datastream/v1/BUILD.bazel +++ b/google/cloud/datastream/v1/BUILD.bazel @@ -74,6 +74,7 @@ java_gapic_library( srcs = [":datastream_proto_with_info"], gapic_yaml = None, grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", test_deps = [ ":datastream_java_grpc", @@ -139,6 +140,7 @@ go_gapic_library( grpc_service_config = "datastream_grpc_service_config.json", importpath = "cloud.google.com/go/datastream/apiv1;datastream", metadata = True, + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", transport = "grpc+rest", deps = [ @@ -146,8 +148,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -184,6 +186,7 @@ py_gapic_library( name = "datastream_py_gapic", srcs = [":datastream_proto"], grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", transport = "grpc", deps = [ @@ -235,7 +238,9 @@ php_gapic_library( name = "datastream_php_gapic", srcs = [":datastream_proto_with_info"], grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", + transport = "grpc+rest", deps = [ ":datastream_php_grpc", ":datastream_php_proto", @@ -268,7 +273,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datastream_grpc_service_config.json", package = "google.cloud.datastream.v1", + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/datastream/", ], grpc_service_config = "datastream_grpc_service_config.json", + 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 V1", service_yaml = "datastream_v1.yaml", @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":datastream_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1.yaml", deps = [ ":datastream_csharp_grpc", diff --git a/google/cloud/datastream/v1alpha1/BUILD.bazel b/google/cloud/datastream/v1alpha1/BUILD.bazel index 6a8165f6e..5a2324f7c 100644 --- a/google/cloud/datastream/v1alpha1/BUILD.bazel +++ b/google/cloud/datastream/v1alpha1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "datastream_java_gapic", srcs = [":datastream_proto_with_info"], grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":datastream_java_grpc", ], @@ -130,13 +131,14 @@ go_gapic_library( grpc_service_config = "datastream_grpc_service_config.json", importpath = "cloud.google.com/go/datastream/apiv1alpha1;datastream", metadata = True, + rest_numeric_enums = True, service_yaml = "datastream_v1alpha1.yaml", transport = "grpc+rest", deps = [ ":datastream_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -173,6 +175,7 @@ py_gapic_library( name = "datastream_py_gapic", srcs = [":datastream_proto"], grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -220,7 +223,9 @@ php_gapic_library( name = "datastream_php_gapic", srcs = [":datastream_proto_with_info"], grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1alpha1.yaml", + transport = "grpc+rest", deps = [ ":datastream_php_grpc", ":datastream_php_proto", @@ -253,7 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datastream_grpc_service_config.json", package = "google.cloud.datastream.v1alpha1", + rest_numeric_enums = True, service_yaml = "datastream_v1alpha1.yaml", + transport = "grpc+rest", deps = [], ) @@ -297,6 +304,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=datastream", ], grpc_service_config = "datastream_grpc_service_config.json", + 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", deps = [ @@ -342,6 +350,7 @@ csharp_gapic_library( srcs = [":datastream_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datastream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastream_v1alpha1.yaml", deps = [ ":datastream_csharp_grpc", diff --git a/google/cloud/deploy/v1/BUILD.bazel b/google/cloud/deploy/v1/BUILD.bazel index 764bfb000..aa46b67b8 100644 --- a/google/cloud/deploy/v1/BUILD.bazel +++ b/google/cloud/deploy/v1/BUILD.bazel @@ -81,7 +81,7 @@ java_gapic_library( srcs = [":deploy_proto_with_info"], gapic_yaml = None, grpc_service_config = "clouddeploy_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", test_deps = [ ":deploy_java_grpc", @@ -148,7 +148,7 @@ go_gapic_library( grpc_service_config = "clouddeploy_grpc_service_config.json", importpath = "cloud.google.com/go/deploy/apiv1;deploy", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", transport = "grpc+rest", deps = [ @@ -156,8 +156,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -194,7 +194,7 @@ py_gapic_library( name = "deploy_py_gapic", srcs = [":deploy_proto"], grpc_service_config = "clouddeploy_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", transport = "grpc", deps = [ @@ -246,8 +246,9 @@ php_gapic_library( name = "deploy_php_gapic", srcs = [":deploy_proto_with_info"], grpc_service_config = "clouddeploy_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", + transport = "grpc+rest", deps = [ ":deploy_php_grpc", ":deploy_php_proto", @@ -280,8 +281,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "clouddeploy_grpc_service_config.json", package = "google.cloud.deploy.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -326,7 +328,7 @@ ruby_cloud_gapic_library( "ruby-cloud-yard-strict=false", ], grpc_service_config = "clouddeploy_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud Deploy is a managed service that automates delivery of your applications to a series of target environments in a defined promotion sequence.", ruby_cloud_title = "Google Cloud Deploy V1", service_yaml = "clouddeploy_v1.yaml", @@ -373,7 +375,7 @@ csharp_gapic_library( srcs = [":deploy_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "clouddeploy_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "clouddeploy_v1.yaml", deps = [ ":deploy_csharp_grpc", diff --git a/google/cloud/dialogflow/cx/v3/BUILD.bazel b/google/cloud/dialogflow/cx/v3/BUILD.bazel index 54fc7a832..7e947d8a9 100644 --- a/google/cloud/dialogflow/cx/v3/BUILD.bazel +++ b/google/cloud/dialogflow/cx/v3/BUILD.bazel @@ -96,6 +96,7 @@ java_gapic_library( srcs = [":cx_proto_with_info"], gapic_yaml = None, grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", test_deps = [ ":cx_java_grpc", @@ -191,14 +192,15 @@ go_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", importpath = "cloud.google.com/go/dialogflow/cx/apiv3;cx", metadata = True, + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", transport = "grpc+rest", deps = [ ":cx_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -229,6 +231,7 @@ load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", "py_gapic_library", + "py_test", ) py_gapic_library( @@ -238,21 +241,25 @@ py_gapic_library( opt_args = [ "python-gapic-name=dialogflowcx", "python-gapic-namespace=google.cloud", + "warehouse-package-name=google-cloud-dialogflow-cx", ], + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", transport = "grpc", + deps = [ + ], ) # Uncomment once https://github.com/googleapis/gapic-generator-python/issues/1376 is fixed -#py_test( -# name = "cx_py_gapic_test", -# srcs = [ -# "cx_py_gapic_pytest.py", -# "cx_py_gapic_test.py", -# ], -# legacy_create_init = False, -# deps = [":cx_py_gapic"], -#) +# py_test( +# name = "cx_py_gapic_test", +# srcs = [ +# "cx_py_gapic_pytest.py", +# "cx_py_gapic_test.py", +# ], +# legacy_create_init = False, +# deps = [":cx_py_gapic"], +# ) # Open Source Packages py_gapic_assembly_pkg( @@ -288,7 +295,9 @@ php_gapic_library( name = "cx_php_gapic", srcs = [":cx_proto_with_info"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", + transport = "grpc+rest", deps = [ ":cx_php_grpc", ":cx_php_proto", @@ -320,10 +329,12 @@ nodejs_gapic_library( src = ":cx_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "dialogflow_grpc_service_config.json", + mixins = "google.longrunning.Operations;google.cloud.location.Locations", package = "google.cloud.dialogflow.cx.v3", + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -368,6 +379,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/dialogflow", ], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow CX, providing an advanced agent type suitable for large or very complex agents.", ruby_cloud_title = "Dialogflow CX V3", service_yaml = "dialogflow_v3.yaml", @@ -414,6 +426,7 @@ csharp_gapic_library( srcs = [":cx_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3.yaml", deps = [ ":cx_csharp_grpc", diff --git a/google/cloud/dialogflow/cx/v3/advanced_settings.proto b/google/cloud/dialogflow/cx/v3/advanced_settings.proto index 4cb0fefcd..d2de5b1fc 100644 --- a/google/cloud/dialogflow/cx/v3/advanced_settings.proto +++ b/google/cloud/dialogflow/cx/v3/advanced_settings.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.dialogflow.cx.v3; +import "google/api/field_behavior.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3"; diff --git a/google/cloud/dialogflow/cx/v3/security_settings.proto b/google/cloud/dialogflow/cx/v3/security_settings.proto index ae8bd1694..5948f6bfd 100644 --- a/google/cloud/dialogflow/cx/v3/security_settings.proto +++ b/google/cloud/dialogflow/cx/v3/security_settings.proto @@ -231,10 +231,11 @@ message SecuritySettings { OGG = 3; } - // Cloud Storage bucket to export audio record to. You need to grant - // `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Storage Object - // Admin` role in this bucket. + // Cloud Storage bucket to export audio record to. + // Setting this field would grant the Storage Object Creator role to + // the Dialogflow Service Agent. + // API caller that tries to modify this field should have the permission of + // storage.buckets.setIamPolicy. string gcs_bucket = 1; // Filename pattern for exported audio. @@ -322,15 +323,11 @@ message SecuritySettings { // purged due to retention policy, we may still hold it in backup storage for // a few days without allowing direct readings. oneof data_retention { - // Retains data in interaction logging for the specified number of days. - // This does not apply to Cloud logging, which is owned by the user - not - // Dialogflow. - // User must set a value lower than Dialogflow's default 365d TTL. Setting a - // value higher than that has no effect. - // A missing value or setting to 0 also means we use Dialogflow's default - // TTL. - // Note: Interaction logging is a limited access feature. Talk to your - // Google representative to check availability for you. + // Retains the data for the specified number of days. + // User must set a value lower than Dialogflow's default 365d TTL (30 days + // for Agent Assist traffic), higher value will be ignored and use default. + // Setting a value higher than that has no effect. A missing value or + // setting to 0 also means we use default TTL. int32 retention_window_days = 6; } diff --git a/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel b/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel index de13e9b88..23013c7c3 100644 --- a/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel +++ b/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel @@ -96,6 +96,7 @@ java_gapic_library( srcs = [":cx_proto_with_info"], gapic_yaml = None, grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", test_deps = [ ":cx_java_grpc", @@ -191,14 +192,15 @@ go_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", importpath = "cloud.google.com/go/dialogflow/cx/apiv3beta1;cx", metadata = True, + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", transport = "grpc+rest", deps = [ ":cx_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -229,6 +231,7 @@ load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", "py_gapic_library", + "py_test", ) py_gapic_library( @@ -238,21 +241,25 @@ py_gapic_library( opt_args = [ "python-gapic-name=dialogflowcx", "python-gapic-namespace=google.cloud", + "warehouse-package-name=google-cloud-dialogflow-cx", ], + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", transport = "grpc", + deps = [ + ], ) # Uncomment once https://github.com/googleapis/gapic-generator-python/issues/1376 is fixed -#py_test( -# name = "cx_py_gapic_test", -# srcs = [ -# "cx_py_gapic_pytest.py", -# "cx_py_gapic_test.py", -# ], -# legacy_create_init = False, -# deps = [":cx_py_gapic"], -#) +# py_test( +# name = "cx_py_gapic_test", +# srcs = [ +# "cx_py_gapic_pytest.py", +# "cx_py_gapic_test.py", +# ], +# legacy_create_init = False, +# deps = [":cx_py_gapic"], +# ) # Open Source Packages py_gapic_assembly_pkg( @@ -288,7 +295,9 @@ php_gapic_library( name = "cx_php_gapic", srcs = [":cx_proto_with_info"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", + transport = "grpc+rest", deps = [ ":cx_php_grpc", ":cx_php_proto", @@ -321,9 +330,10 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dialogflow_grpc_service_config.json", package = "google.cloud.dialogflow.cx.v3beta1", + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -368,6 +378,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/dialogflow", ], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow CX, providing an advanced agent type suitable for large or very complex agents.", ruby_cloud_title = "Dialogflow CX V3beta1", service_yaml = "dialogflow_v3beta1.yaml", @@ -414,6 +425,7 @@ csharp_gapic_library( srcs = [":cx_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v3beta1.yaml", deps = [ ":cx_csharp_grpc", diff --git a/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto b/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto index a828f6662..051f8259f 100644 --- a/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto +++ b/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.cloud.dialogflow.cx.v3beta1; +import "google/api/field_behavior.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1"; diff --git a/google/cloud/dialogflow/cx/v3beta1/security_settings.proto b/google/cloud/dialogflow/cx/v3beta1/security_settings.proto index 366c6292c..bcb11f4fa 100644 --- a/google/cloud/dialogflow/cx/v3beta1/security_settings.proto +++ b/google/cloud/dialogflow/cx/v3beta1/security_settings.proto @@ -231,10 +231,11 @@ message SecuritySettings { OGG = 3; } - // Cloud Storage bucket to export audio record to. You need to grant - // `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Storage Object - // Admin` role in this bucket. + // Cloud Storage bucket to export audio record to. + // Setting this field would grant the Storage Object Creator role to + // the Dialogflow Service Agent. + // API caller that tries to modify this field should have the permission of + // storage.buckets.setIamPolicy. string gcs_bucket = 1; // Filename pattern for exported audio. @@ -325,12 +326,10 @@ message SecuritySettings { // Retains data in interaction logging for the specified number of days. // This does not apply to Cloud logging, which is owned by the user - not // Dialogflow. - // User must set a value lower than Dialogflow's default 365d TTL. Setting a - // value higher than that has no effect. - // A missing value or setting to 0 also means we use Dialogflow's default - // TTL. - // Note: Interaction logging is a limited access feature. Talk to your - // Google representative to check availability for you. + // User must set a value lower than Dialogflow's default 365d TTL (30 days + // for Agent Assist traffic), higher value will be ignored and use default. + // Setting a value higher than that has no effect. A missing value or + // setting to 0 also means we use default TTL. int32 retention_window_days = 6; } diff --git a/google/cloud/dialogflow/v2/BUILD.bazel b/google/cloud/dialogflow/v2/BUILD.bazel index fd7b4905f..1319b627c 100644 --- a/google/cloud/dialogflow/v2/BUILD.bazel +++ b/google/cloud/dialogflow/v2/BUILD.bazel @@ -98,6 +98,7 @@ java_gapic_library( srcs = [":dialogflow_proto_with_info"], gapic_yaml = None, grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", test_deps = [ ":dialogflow_java_grpc", @@ -195,14 +196,15 @@ go_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", importpath = "cloud.google.com/go/dialogflow/apiv2;dialogflow", metadata = True, + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", transport = "grpc+rest", deps = [ ":dialogflow_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -240,8 +242,11 @@ py_gapic_library( name = "dialogflow_py_gapic", srcs = [":dialogflow_proto"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -288,7 +293,9 @@ php_gapic_library( name = "dialogflow_php_gapic", srcs = [":dialogflow_proto_with_info"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", + transport = "grpc+rest", deps = [ ":dialogflow_php_grpc", ":dialogflow_php_proto", @@ -322,9 +329,10 @@ nodejs_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", main_service = "dialogflow", package = "google.cloud.dialogflow.v2", + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -368,6 +376,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/dialogflow", ], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow ES, providing the standard agent type suitable for small and simple agents.", ruby_cloud_title = "Dialogflow V2", service_yaml = "dialogflow_v2.yaml", @@ -414,6 +423,7 @@ csharp_gapic_library( srcs = [":dialogflow_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2.yaml", deps = [ ":dialogflow_csharp_grpc", diff --git a/google/cloud/dialogflow/v2/audio_config.proto b/google/cloud/dialogflow/v2/audio_config.proto index 98258ee23..b86a9d3a1 100644 --- a/google/cloud/dialogflow/v2/audio_config.proto +++ b/google/cloud/dialogflow/v2/audio_config.proto @@ -369,6 +369,67 @@ message OutputAudioConfig { SynthesizeSpeechConfig synthesize_speech_config = 3; } +// [DTMF](https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling) +// digit in Telephony Gateway. +enum TelephonyDtmf { + // Not specified. This value may be used to indicate an absent digit. + TELEPHONY_DTMF_UNSPECIFIED = 0; + + // Number: '1'. + DTMF_ONE = 1; + + // Number: '2'. + DTMF_TWO = 2; + + // Number: '3'. + DTMF_THREE = 3; + + // Number: '4'. + DTMF_FOUR = 4; + + // Number: '5'. + DTMF_FIVE = 5; + + // Number: '6'. + DTMF_SIX = 6; + + // Number: '7'. + DTMF_SEVEN = 7; + + // Number: '8'. + DTMF_EIGHT = 8; + + // Number: '9'. + DTMF_NINE = 9; + + // Number: '0'. + DTMF_ZERO = 10; + + // Letter: 'A'. + DTMF_A = 11; + + // Letter: 'B'. + DTMF_B = 12; + + // Letter: 'C'. + DTMF_C = 13; + + // Letter: 'D'. + DTMF_D = 14; + + // Asterisk/star: '*'. + DTMF_STAR = 15; + + // Pound/diamond/hash/square/gate/octothorpe: '#'. + DTMF_POUND = 16; +} + +// A wrapper of repeated TelephonyDtmf digits. +message TelephonyDtmfEvents { + // A sequence of TelephonyDtmf digits. + repeated TelephonyDtmf dtmf_events = 1; +} + // Configures speech transcription for [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]. message SpeechToTextConfig { // The speech model used in speech to text. @@ -379,4 +440,13 @@ message SpeechToTextConfig { // version of the specified model for the language does not exist, then it // would emit an error. SpeechModelVariant speech_model_variant = 1; + + // Which Speech model to select. Select the model best suited to your domain + // to get best results. If a model is not explicitly specified, then a default + // model is used. + // Refer to + // [Cloud Speech API + // documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) + // for more details. + string model = 2; } diff --git a/google/cloud/dialogflow/v2/conversation_dataset.proto b/google/cloud/dialogflow/v2/conversation_dataset.proto index cc35e1c84..282bdda39 100644 --- a/google/cloud/dialogflow/v2/conversation_dataset.proto +++ b/google/cloud/dialogflow/v2/conversation_dataset.proto @@ -306,7 +306,12 @@ message ImportConversationDataOperationResponse { // Metadata for [ConversationDatasets][CreateConversationDataset]. message CreateConversationDatasetOperationMetadata { - + // The resource name of the conversation dataset that will be created. Format: + // `projects//locations//conversationDatasets/` + string conversation_dataset = 1 [(google.api.resource_reference) = { + type: "dialogflow.googleapis.com/ConversationDataset" + }]; } // Metadata for [ConversationDatasets][DeleteConversationDataset]. diff --git a/google/cloud/dialogflow/v2/conversation_profile.proto b/google/cloud/dialogflow/v2/conversation_profile.proto index 56cc8e47e..d1a33bb80 100644 --- a/google/cloud/dialogflow/v2/conversation_profile.proto +++ b/google/cloud/dialogflow/v2/conversation_profile.proto @@ -669,13 +669,13 @@ message SuggestionFeature { // Unspecified feature type. TYPE_UNSPECIFIED = 0; - // Run article suggestion model. + // Run article suggestion model for chat. ARTICLE_SUGGESTION = 1; - // Run FAQ model. + // Run FAQ model for chat. FAQ = 2; - // Run smart reply model. + // Run smart reply model for chat. SMART_REPLY = 3; } diff --git a/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json b/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json index f704b3a68..9e94fc79a 100755 --- a/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json +++ b/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json @@ -32,6 +32,9 @@ { "service": "google.cloud.dialogflow.v2.Environments" }, + { + "service": "google.cloud.dialogflow.v2.FeatureCreationFlows" + }, { "service": "google.cloud.dialogflow.v2.Fulfillments" }, diff --git a/google/cloud/dialogflow/v2/dialogflow_v2.yaml b/google/cloud/dialogflow/v2/dialogflow_v2.yaml index 8c5fb07fa..a7191749f 100644 --- a/google/cloud/dialogflow/v2/dialogflow_v2.yaml +++ b/google/cloud/dialogflow/v2/dialogflow_v2.yaml @@ -110,6 +110,8 @@ backend: deadline: 60.0 - selector: google.cloud.dialogflow.v2.Participants.AnalyzeContent deadline: 220.0 + - selector: google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent + deadline: 220.0 - selector: 'google.cloud.dialogflow.v2.SessionEntityTypes.*' deadline: 60.0 - selector: google.cloud.dialogflow.v2.Sessions.DetectIntent diff --git a/google/cloud/dialogflow/v2/participant.proto b/google/cloud/dialogflow/v2/participant.proto index 35b6106e3..f6b385077 100644 --- a/google/cloud/dialogflow/v2/participant.proto +++ b/google/cloud/dialogflow/v2/participant.proto @@ -109,6 +109,24 @@ service Participants { option (google.api.method_signature) = "participant,event_input"; } + // Adds a text (chat, for example), or audio (phone recording, for example) + // message from a participant into the conversation. + // Note: This method is only available through the gRPC API (not REST). + // + // The top-level message sent to the client by the server is + // `StreamingAnalyzeContentResponse`. Multiple response messages can be + // returned in order. The first one or more messages contain the + // `recognition_result` field. Each result represents a more complete + // transcript of what the user said. The next message contains the + // `reply_text` field and potentially the `reply_audio` field. The message can + // also contain the `automated_agent_reply` field. + // + // Note: Always use agent versions for production traffic + // sent to virtual agents. See [Versions and + // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). + rpc StreamingAnalyzeContent(stream StreamingAnalyzeContentRequest) returns (stream StreamingAnalyzeContentResponse) { + } + // Gets suggested articles for a participant based on specific historical // messages. rpc SuggestArticles(SuggestArticlesRequest) returns (SuggestArticlesResponse) { @@ -190,6 +208,36 @@ message Participant { // media stream to this participant. This field can be updated. string sip_recording_media_label = 6 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Obfuscated user id that should be associated with the created participant. + // + // You can specify a user id as follows: + // + // 1. If you set this field in + // [CreateParticipantRequest][google.cloud.dialogflow.v2.CreateParticipantRequest.participant] or + // [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant], + // Dialogflow adds the obfuscated user id with the participant. + // + // 2. If you set this field in + // [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id] or + // [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id], + // Dialogflow will update [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id]. + // + // Dialogflow returns an error if you try to add a user id for a + // non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.END_USER] participant. + // + // Dialogflow uses this user id for billing and measurement purposes. For + // example, Dialogflow determines whether a user in one conversation returned + // in a later conversation. + // + // Note: + // + // * Please never pass raw user ids to Dialogflow. Always obfuscate your user + // id first. + // * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a + // hash function like SHA-512. + // * The length of the user id must be <= 256 characters. + string obfuscated_external_user_id = 7 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Key-value filters on the metadata of documents returned by article // suggestion. If specified, article suggestion only returns suggested // documents that match all filters in their [Document.metadata][google.cloud.dialogflow.v2.Document.metadata]. Multiple @@ -425,6 +473,171 @@ message AnalyzeContentResponse { DtmfParameters dtmf_parameters = 9; } +// The top-level message sent by the client to the +// [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent] method. +// +// Multiple request messages should be sent in order: +// +// 1. The first message must contain +// [participant][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant], +// [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] and optionally +// [query_params][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.query_params]. If you want +// to receive an audio response, it should also contain +// [reply_audio_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.reply_audio_config]. +// The message must not contain +// [input][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input]. +// +// 2. If [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message +// was set to [audio_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.audio_config], +// all subsequent messages must contain +// [input_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input_audio] to continue +// with Speech recognition. +// However, note that: +// +// * Dialogflow will bill you for the audio so far. +// * Dialogflow discards all Speech recognition results in favor of the +// text input. +// +// 3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set +// to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.text_config], then the second message +// must contain only [input_text][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input_text]. +// Moreover, you must not send more than two messages. +// +// After you sent all input, you must half-close or abort the request stream. +message StreamingAnalyzeContentRequest { + // Required. The name of the participant this text comes from. + // Format: `projects//locations//conversations//participants/`. + string participant = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "dialogflow.googleapis.com/Participant" + } + ]; + + // The input config. + oneof config { + // Instructs the speech recognizer how to process the speech audio. + InputAudioConfig audio_config = 2; + + // The natural language text to be processed. + InputTextConfig text_config = 3; + } + + // Speech synthesis configuration. + // The speech synthesis settings for a virtual agent that may be configured + // for the associated conversation profile are not used when calling + // StreamingAnalyzeContent. If this configuration is not supplied, speech + // synthesis is disabled. + OutputAudioConfig reply_audio_config = 4; + + // The input. + oneof input { + // The input audio content to be recognized. Must be sent if `audio_config` + // is set in the first message. The complete audio over all streaming + // messages must not exceed 1 minute. + bytes input_audio = 5; + + // The UTF-8 encoded natural language text to be processed. Must be sent if + // `text_config` is set in the first message. Text length must not exceed + // 256 bytes for virtual agent interactions. The `input_text` field can be + // only sent once. + string input_text = 6; + + // The DTMF digits used to invoke intent and fill in parameter value. + // + // This input is ignored if the previous response indicated that DTMF input + // is not accepted. + TelephonyDtmfEvents input_dtmf = 9; + } + + // Parameters for a Dialogflow virtual-agent query. + QueryParameters query_params = 7; + + // Parameters for a human assist query. + AssistQueryParameters assist_query_params = 8; + + // Additional parameters to be put into Dialogflow CX session parameters. To + // remove a parameter from the session, clients should explicitly set the + // parameter value to null. + // + // Note: this field should only be used if you are connecting to a Dialogflow + // CX agent. + google.protobuf.Struct cx_parameters = 13; + + // Enable partial virtual agent responses. If this flag is not enabled, + // response stream still contains only one final response even if some + // `Fulfillment`s in Dialogflow virtual agent have been configured to return + // partial responses. + bool enable_partial_automated_agent_reply = 12; +} + +// The top-level message returned from the `StreamingAnalyzeContent` method. +// +// Multiple response messages can be returned in order: +// +// 1. If the input was set to streaming audio, the first one or more messages +// contain `recognition_result`. Each `recognition_result` represents a more +// complete transcript of what the user said. The last `recognition_result` +// has `is_final` set to `true`. +// +// 2. In virtual agent stage: if `enable_partial_automated_agent_reply` is +// true, the following N (currently 1 <= N <= 4) messages +// contain `automated_agent_reply` and optionally `reply_audio` +// returned by the virtual agent. The first (N-1) +// `automated_agent_reply`s will have `automated_agent_reply_type` set to +// `PARTIAL`. The last `automated_agent_reply` has +// `automated_agent_reply_type` set to `FINAL`. +// If `enable_partial_automated_agent_reply` is not enabled, response stream +// only contains the final reply. +// +// In human assist stage: the following N (N >= 1) messages contain +// `human_agent_suggestion_results`, `end_user_suggestion_results` or +// `message`. +message StreamingAnalyzeContentResponse { + // The result of speech recognition. + StreamingRecognitionResult recognition_result = 1; + + // The output text content. + // This field is set if an automated agent responded with a text for the user. + string reply_text = 2; + + // The audio data bytes encoded as specified in the request. + // This field is set if: + // + // - The `reply_audio_config` field is specified in the request. + // - The automated agent, which this output comes from, responded with audio. + // In such case, the `reply_audio.config` field contains settings used to + // synthesize the speech. + // + // In some scenarios, multiple output audio fields may be present in the + // response structure. In these cases, only the top-most-level audio output + // has content. + OutputAudio reply_audio = 3; + + // Only set if a Dialogflow automated agent has responded. + // Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] + // and [AutomatedAgentReply.detect_intent_response.output_audio_config][] + // are always empty, use [reply_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio] instead. + AutomatedAgentReply automated_agent_reply = 4; + + // Message analyzed by CCAI. + Message message = 6; + + // The suggestions for most recent human agent. The order is the same as + // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of + // [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config]. + repeated SuggestionResult human_agent_suggestion_results = 7; + + // The suggestions for end user. The order is the same as + // [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of + // [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config]. + repeated SuggestionResult end_user_suggestion_results = 8; + + // Indicates the parameters of DTMF. + DtmfParameters dtmf_parameters = 10; +} + // The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles]. message SuggestArticlesRequest { // Required. The name of the participant to fetch suggestion for. @@ -623,6 +836,11 @@ message AutomatedAgentReply { // later reply message arrives. e.g. if the agent specified some music as // partial response, it can be cancelled. bool allow_cancellation = 8; + + // The unique identifier of the current Dialogflow CX conversation page. + // Format: `projects//locations//agents//flows//pages/`. + string cx_current_page = 11; } // Represents article answer. @@ -720,6 +938,14 @@ message SuggestionResult { } } +// Defines the language used in the input text. +message InputTextConfig { + // Required. The language of this conversational query. See [Language + // Support](https://cloud.google.com/dialogflow/docs/reference/language) + // for a list of the currently supported language codes. + string language_code = 1 [(google.api.field_behavior) = REQUIRED]; +} + // Represents a part of a message possibly annotated with an entity. The part // can be an entity or purely a part of the message between two entities or // message start/end. diff --git a/google/cloud/dialogflow/v2/session.proto b/google/cloud/dialogflow/v2/session.proto index 107e02060..85119ecc5 100644 --- a/google/cloud/dialogflow/v2/session.proto +++ b/google/cloud/dialogflow/v2/session.proto @@ -689,7 +689,9 @@ message SentimentAnalysisResult { } // The sentiment, such as positive/negative feeling or association, for a unit -// of analysis, such as the query text. +// of analysis, such as the query text. See: +// https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values +// for how to interpret the result. message Sentiment { // Sentiment score between -1.0 (negative sentiment) and 1.0 (positive // sentiment). diff --git a/google/cloud/dialogflow/v2beta1/BUILD.bazel b/google/cloud/dialogflow/v2beta1/BUILD.bazel index 9cfa1a410..22956d5b9 100644 --- a/google/cloud/dialogflow/v2beta1/BUILD.bazel +++ b/google/cloud/dialogflow/v2beta1/BUILD.bazel @@ -96,6 +96,7 @@ java_gapic_library( srcs = [":dialogflow_proto_with_info"], gapic_yaml = None, grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", test_deps = [ ":dialogflow_java_grpc", @@ -189,14 +190,15 @@ go_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", importpath = "cloud.google.com/go/dialogflow/apiv2beta1;dialogflow", metadata = True, + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", transport = "grpc+rest", deps = [ ":dialogflow_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -234,8 +236,11 @@ py_gapic_library( name = "dialogflow_py_gapic", srcs = [":dialogflow_proto"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -282,7 +287,9 @@ php_gapic_library( name = "dialogflow_php_gapic", srcs = [":dialogflow_proto_with_info"], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", + transport = "grpc+rest", deps = [ ":dialogflow_php_grpc", ":dialogflow_php_proto", @@ -316,9 +323,10 @@ nodejs_gapic_library( grpc_service_config = "dialogflow_grpc_service_config.json", main_service = "dialogflow", package = "google.cloud.dialogflow.v2beta1", + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -362,6 +370,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/dialogflow", ], grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. This client is for Dialogflow ES, providing the standard agent type suitable for small and simple agents.", ruby_cloud_title = "Dialogflow V2beta1", service_yaml = "dialogflow_v2beta1.yaml", @@ -408,6 +417,7 @@ csharp_gapic_library( srcs = [":dialogflow_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dialogflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dialogflow_v2beta1.yaml", deps = [ ":dialogflow_csharp_grpc", diff --git a/google/cloud/dialogflow/v2beta1/audio_config.proto b/google/cloud/dialogflow/v2beta1/audio_config.proto index c72899df7..b9e83b20b 100644 --- a/google/cloud/dialogflow/v2beta1/audio_config.proto +++ b/google/cloud/dialogflow/v2beta1/audio_config.proto @@ -111,7 +111,8 @@ message SpeechContext { float boost = 2; } -// Variant of the specified [Speech model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. +// Variant of the specified [Speech +// model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. // // See the [Cloud Speech // documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) @@ -140,8 +141,8 @@ enum SpeechModelVariant { // Use an enhanced model variant: // // * If an enhanced variant does not exist for the given - // [model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] and request language, Dialogflow falls - // back to the standard variant. + // [model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] and + // request language, Dialogflow falls back to the standard variant. // // The [Cloud Speech // documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) @@ -198,10 +199,12 @@ message InputAudioConfig { // the same session do not necessarily need to specify the same language. string language_code = 3; - // If `true`, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.v2beta1.SpeechWordInfo] in - // [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] with information about the recognized speech - // words, e.g. start and end time offsets. If false or unspecified, Speech - // doesn't return any word-level information. + // If `true`, Dialogflow returns + // [SpeechWordInfo][google.cloud.dialogflow.v2beta1.SpeechWordInfo] in + // [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] + // with information about the recognized speech words, e.g. start and end time + // offsets. If false or unspecified, Speech doesn't return any word-level + // information. bool enable_word_info = 13; // A list of strings containing words and phrases that the speech @@ -236,7 +239,8 @@ message InputAudioConfig { // for more details. string model = 7; - // Which variant of the [Speech model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. + // Which variant of the [Speech + // model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use. SpeechModelVariant model_variant = 10; // If `false` (default), recognition does not cease until the @@ -251,7 +255,9 @@ message InputAudioConfig { // over StreamingDetectIntentRequest.single_utterance. bool single_utterance = 8; - // Only used in [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and + // Only used in + // [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] + // and // [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent]. // If `false` and recognition doesn't return any result, trigger // `NO_SPEECH_RECOGNIZED` event to Dialogflow agent. @@ -287,9 +293,10 @@ message VoiceSelectionParams { // Optional. The preferred gender of the voice. If not set, the service will // choose a voice based on the other parameters such as language_code and - // [name][google.cloud.dialogflow.v2beta1.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a - // voice of the appropriate gender is not available, the synthesizer should - // substitute a voice with a different gender rather than failing the request. + // [name][google.cloud.dialogflow.v2beta1.VoiceSelectionParams.name]. Note + // that this is only a preference, not requirement. If a voice of the + // appropriate gender is not available, the synthesizer should substitute a + // voice with a different gender rather than failing the request. SsmlVoiceGender ssml_gender = 2; } @@ -355,7 +362,8 @@ enum OutputAudioEncoding { // text-to-speech settings applied to the agent. message OutputAudioConfig { // Required. Audio encoding of the synthesized audio content. - OutputAudioEncoding audio_encoding = 1 [(google.api.field_behavior) = REQUIRED]; + OutputAudioEncoding audio_encoding = 1 + [(google.api.field_behavior) = REQUIRED]; // The synthesis sample rate (in hertz) for this audio. If not // provided, then the synthesizer will use the default sample rate based on @@ -429,14 +437,26 @@ message TelephonyDtmfEvents { repeated TelephonyDtmf dtmf_events = 1; } -// Configures speech transcription for [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile]. +// Configures speech transcription for +// [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile]. message SpeechToTextConfig { // The speech model used in speech to text. // `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as - // `USE_ENHANCED`. It can be overridden in [AnalyzeContentRequest][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest] and - // [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest] request. - // If enhanced model variant is specified and an enhanced - // version of the specified model for the language does not exist, then it - // would emit an error. + // `USE_ENHANCED`. It can be overridden in + // [AnalyzeContentRequest][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest] + // and + // [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest] + // request. If enhanced model variant is specified and an enhanced version of + // the specified model for the language does not exist, then it would emit an + // error. SpeechModelVariant speech_model_variant = 1; + + // Which Speech model to select. Select the model best suited to your domain + // to get best results. If a model is not explicitly specified, then a default + // model is used. + // Refer to + // [Cloud Speech API + // documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) + // for more details. + string model = 2; } diff --git a/google/cloud/dialogflow/v2beta1/conversation.proto b/google/cloud/dialogflow/v2beta1/conversation.proto index d044b4be0..432d8c080 100644 --- a/google/cloud/dialogflow/v2beta1/conversation.proto +++ b/google/cloud/dialogflow/v2beta1/conversation.proto @@ -132,6 +132,21 @@ service Conversations { }; option (google.api.method_signature) = "parent"; } + + // Suggest summary for a conversation based on specific historical messages. + // The range of the messages to be used for summary can be specified in the + // request. + rpc SuggestConversationSummary(SuggestConversationSummaryRequest) returns (SuggestConversationSummaryResponse) { + option (google.api.http) = { + post: "/v2beta1/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummary" + body: "*" + additional_bindings { + post: "/v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:suggestConversationSummary" + body: "*" + } + }; + option (google.api.method_signature) = "conversation"; + } } // Represents a conversation. @@ -411,3 +426,69 @@ message ListMessagesResponse { // no more results in the list. string next_page_token = 2; } + +// The request message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. +message SuggestConversationSummaryRequest { + // Required. The conversation to fetch suggestion for. + // Format: `projects//locations//conversations/`. + string conversation = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "dialogflow.googleapis.com/Conversation" + } + ]; + + // The name of the latest conversation message used as context for + // compiling suggestion. If empty, the latest message of the conversation will + // be used. + // + // Format: `projects//locations//conversations//messages/`. + string latest_message = 3 [(google.api.resource_reference) = { + type: "dialogflow.googleapis.com/Message" + }]; + + // Max number of messages prior to and including + // [latest_message] to use as context when compiling the + // suggestion. By default 500 and at most 1000. + int32 context_size = 4; +} + +// The response message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. +message SuggestConversationSummaryResponse { + // Generated summary for a conversation. + message Summary { + // The summary content that is concatenated into one string. + string text = 1; + + // The summary content that is divided into sections. The key is the + // section's name and the value is the section's content. There is no + // specific format for the key or value. + map text_sections = 4; + + // The name of the answer record. Format: + // "projects//answerRecords/" + string answer_record = 3 [(google.api.resource_reference) = { + type: "dialogflow.googleapis.com/AnswerRecord" + }]; + } + + // Generated summary. + Summary summary = 1; + + // The name of the latest conversation message used as context for + // compiling suggestion. + // + // Format: `projects//locations//conversations//messages/`. + string latest_message = 2 [(google.api.resource_reference) = { + type: "dialogflow.googleapis.com/Message" + }]; + + // Number of messages prior to and including + // [last_conversation_message][] used to compile the suggestion. It may be + // smaller than the [SuggestSummaryRequest.context_size][] field in the + // request if there weren't that many messages in the conversation. + int32 context_size = 3; +} diff --git a/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json b/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json index d03c5bd8d..af87dcf15 100755 --- a/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json +++ b/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json @@ -74,6 +74,9 @@ { "service": "google.cloud.dialogflow.v2beta1.Environments" }, + { + "service": "google.cloud.dialogflow.v2beta1.FeatureCreationFlows" + }, { "service": "google.cloud.dialogflow.v2beta1.Fulfillments" }, @@ -201,6 +204,15 @@ } ], "timeout": "220s" + }, + { + "name": [ + { + "service": "google.cloud.dialogflow.v2beta1.Conversations", + "method": "StreamingListUpcomingCallCompanionEvents" + } + ], + "timeout": "600s" } ] } diff --git a/google/cloud/dialogflow/v2beta1/participant.proto b/google/cloud/dialogflow/v2beta1/participant.proto index 1d3489fe1..887a84015 100644 --- a/google/cloud/dialogflow/v2beta1/participant.proto +++ b/google/cloud/dialogflow/v2beta1/participant.proto @@ -494,6 +494,11 @@ message AutomatedAgentReply { // later reply message arrives. e.g. if the agent specified some music as // partial response, it can be cancelled. bool allow_cancellation = 8; + + // The unique identifier of the current Dialogflow CX conversation page. + // Format: `projects//locations//agents//flows//pages/`. + string cx_current_page = 11; } // The type of Human Agent Assistant API suggestion to perform, and the maximum @@ -505,14 +510,17 @@ message SuggestionFeature { // Unspecified feature type. TYPE_UNSPECIFIED = 0; - // Run article suggestion model. + // Run article suggestion model for chat. ARTICLE_SUGGESTION = 1; // Run FAQ model. FAQ = 2; - // Run smart reply model. + // Run smart reply model for chat. SMART_REPLY = 3; + + // Run conversation summarization model for chat. + CONVERSATION_SUMMARIZATION = 8; } // Type of Human Agent Assistant API feature to request. diff --git a/google/cloud/dialogflow/v2beta1/session.proto b/google/cloud/dialogflow/v2beta1/session.proto index ac64e7127..4f45bce45 100644 --- a/google/cloud/dialogflow/v2beta1/session.proto +++ b/google/cloud/dialogflow/v2beta1/session.proto @@ -827,7 +827,9 @@ message SentimentAnalysisResult { } // The sentiment, such as positive/negative feeling or association, for a unit -// of analysis, such as the query text. +// of analysis, such as the query text. See: +// https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values +// for how to interpret the result. message Sentiment { // Sentiment score between -1.0 (negative sentiment) and 1.0 (positive // sentiment). diff --git a/google/cloud/discoveryengine/v1beta/BUILD.bazel b/google/cloud/discoveryengine/v1beta/BUILD.bazel index bcf89d20b..1746cef34 100644 --- a/google/cloud/discoveryengine/v1beta/BUILD.bazel +++ b/google/cloud/discoveryengine/v1beta/BUILD.bazel @@ -81,7 +81,7 @@ java_gapic_library( srcs = [":discoveryengine_proto_with_info"], gapic_yaml = None, grpc_service_config = "discoveryengine_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", test_deps = [ ":discoveryengine_java_grpc", @@ -157,8 +157,8 @@ go_gapic_library( ":discoveryengine_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -196,7 +196,7 @@ py_gapic_library( name = "discoveryengine_py_gapic", srcs = [":discoveryengine_proto"], grpc_service_config = "discoveryengine_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -247,8 +247,9 @@ php_gapic_library( name = "discoveryengine_php_gapic", srcs = [":discoveryengine_proto_with_info"], grpc_service_config = "discoveryengine_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", + transport = "grpc+rest", deps = [ ":discoveryengine_php_grpc", ":discoveryengine_php_proto", @@ -281,8 +282,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "discoveryengine_grpc_service_config.json", package = "google.cloud.discoveryengine.v1beta", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -321,7 +323,7 @@ ruby_cloud_gapic_library( srcs = [":discoveryengine_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-discoveryengine-v1beta"], grpc_service_config = "discoveryengine_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", deps = [ ":discoveryengine_ruby_grpc", @@ -366,7 +368,7 @@ csharp_gapic_library( srcs = [":discoveryengine_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "discoveryengine_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "discoveryengine_v1beta.yaml", deps = [ ":discoveryengine_csharp_grpc", diff --git a/google/cloud/discoveryengine/v1beta/discoveryengine_v1beta.yaml b/google/cloud/discoveryengine/v1beta/discoveryengine_v1beta.yaml index b9e293c27..f705655e3 100644 --- a/google/cloud/discoveryengine/v1beta/discoveryengine_v1beta.yaml +++ b/google/cloud/discoveryengine/v1beta/discoveryengine_v1beta.yaml @@ -38,12 +38,15 @@ http: - selector: google.longrunning.Operations.GetOperation get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}' additional_bindings: + - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}' - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/operations/*}' - get: '/v1beta/{name=projects/*/locations/*/operations/*}' - get: '/v1beta/{name=projects/*/operations/*}' - selector: google.longrunning.Operations.ListOperations - get: '/v1beta/{name=projects/*/locations/*/dataStores/*}/operations' + get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*}/operations' additional_bindings: + - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*}/operations' + - get: '/v1beta/{name=projects/*/locations/*/dataStores/*}/operations' - get: '/v1beta/{name=projects/*/locations/*}/operations' - get: '/v1beta/{name=projects/*}/operations' diff --git a/google/cloud/discoveryengine/v1beta/import_config.proto b/google/cloud/discoveryengine/v1beta/import_config.proto index 4ed571e38..a2b2cf8ff 100644 --- a/google/cloud/discoveryengine/v1beta/import_config.proto +++ b/google/cloud/discoveryengine/v1beta/import_config.proto @@ -141,7 +141,7 @@ message ImportUserEventsRequest { // The desired location of errors incurred during the Import. Cannot be set // for inline user event imports. - ImportErrorConfig errors_config = 5; + ImportErrorConfig error_config = 5; } // Response of the ImportUserEventsRequest. If the long running @@ -153,7 +153,7 @@ message ImportUserEventsResponse { // Echoes the destination for the complete errors if this field was set in // the request. - ImportErrorConfig errors_config = 2; + ImportErrorConfig error_config = 2; // Count of user events imported with complete existing Documents. int64 joined_events_count = 3; @@ -244,7 +244,7 @@ message ImportDocumentsRequest { ]; // The desired location of errors incurred during the Import. - ImportErrorConfig errors_config = 5; + ImportErrorConfig error_config = 5; // The mode of reconciliation between existing documents and the documents to // be imported. Defaults to @@ -261,5 +261,5 @@ message ImportDocumentsResponse { repeated google.rpc.Status error_samples = 1; // Echoes the destination for the complete errors in the request if set. - ImportErrorConfig errors_config = 2; + ImportErrorConfig error_config = 2; } diff --git a/google/cloud/discoveryengine/v1beta/recommendation_service.proto b/google/cloud/discoveryengine/v1beta/recommendation_service.proto index 8efe0df37..14304006a 100644 --- a/google/cloud/discoveryengine/v1beta/recommendation_service.proto +++ b/google/cloud/discoveryengine/v1beta/recommendation_service.proto @@ -137,6 +137,25 @@ message RecommendRequest { // This gives request-level control and adjusts recommendation results // based on Document category. map params = 6; + + // The user labels applied to a resource must meet the following requirements: + // + // * Each resource can have multiple labels, up to a maximum of 64. + // * Each label must be a key-value pair. + // * Keys have a minimum length of 1 character and a maximum length of 63 + // characters and cannot be empty. Values can be empty and have a maximum + // length of 63 characters. + // * Keys and values can contain only lowercase letters, numeric characters, + // underscores, and dashes. All characters must use UTF-8 encoding, and + // international characters are allowed. + // * The key portion of a label must be unique. However, you can use the same + // key with multiple resources. + // * Keys must start with a lowercase letter or international character. + // + // See [Google Cloud + // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + // for more details. + map user_labels = 8; } // Response message for Recommend method. diff --git a/google/cloud/discoveryengine/v1beta/user_event.proto b/google/cloud/discoveryengine/v1beta/user_event.proto index 6a10cdbb4..0e2af5afc 100644 --- a/google/cloud/discoveryengine/v1beta/user_event.proto +++ b/google/cloud/discoveryengine/v1beta/user_event.proto @@ -17,6 +17,7 @@ syntax = "proto3"; package google.cloud.discoveryengine.v1beta; import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; import "google/cloud/discoveryengine/v1beta/common.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; @@ -389,7 +390,12 @@ message DocumentInfo { // Required. The Document resource full name, of the form: // projects//locations//dataStores//branches//documents/ - string name = 2 [(google.api.field_behavior) = REQUIRED]; + string name = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "discoveryengine.googleapis.com/Document" + } + ]; } // Quantity of the Document associated with the user event. Defaults to 1. @@ -409,8 +415,8 @@ message DocumentInfo { // Detailed panel information associated with a user event. message PanelInfo { - // The panel ID. - string panel_id = 2; + // Required. The panel ID. + string panel_id = 2 [(google.api.field_behavior) = REQUIRED]; // The display name of the panel. string display_name = 3; diff --git a/google/cloud/documentai/v1/BUILD.bazel b/google/cloud/documentai/v1/BUILD.bazel index 801ad2fe0..b589d2a34 100644 --- a/google/cloud/documentai/v1/BUILD.bazel +++ b/google/cloud/documentai/v1/BUILD.bazel @@ -86,6 +86,7 @@ java_gapic_library( srcs = [":documentai_proto_with_info"], gapic_yaml = None, grpc_service_config = "documentai_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", test_deps = [ ":documentai_java_grpc", @@ -156,14 +157,15 @@ go_gapic_library( grpc_service_config = "documentai_v1_grpc_service_config.json", importpath = "cloud.google.com/go/documentai/apiv1;documentai", metadata = True, + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", transport = "grpc+rest", deps = [ ":documentai_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -192,14 +194,21 @@ load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", "py_gapic_library", + "py_proto_library", "py_test", ) +py_proto_library( + name = "documentai_py_proto", + deps = [":documentai_proto"], +) + py_gapic_library( name = "documentai_py_gapic", srcs = [":documentai_proto"], grpc_service_config = "documentai_v1_grpc_service_config.json", opt_args = ["autogen-snippets"], + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", transport = "grpc", deps = [ @@ -250,7 +259,9 @@ php_gapic_library( name = "documentai_php_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", + transport = "grpc+rest", deps = [ ":documentai_php_grpc", ":documentai_php_proto", @@ -283,7 +294,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "documentai_v1_grpc_service_config.json", package = "google.cloud.documentai.v1", + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -329,6 +342,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/document-ai/", ], grpc_service_config = "documentai_v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Document AI uses machine learning on a single cloud-based platform to automatically classify, extract, and enrich data within your documents to unlock insights.", ruby_cloud_title = "Document AI V1", service_yaml = "documentai_v1.yaml", @@ -375,6 +389,7 @@ csharp_gapic_library( srcs = [":documentai_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "documentai_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1.yaml", deps = [ ":documentai_csharp_grpc", diff --git a/google/cloud/documentai/v1/barcode.proto b/google/cloud/documentai/v1/barcode.proto index 28e588d6c..bb841771a 100644 --- a/google/cloud/documentai/v1/barcode.proto +++ b/google/cloud/documentai/v1/barcode.proto @@ -28,40 +28,42 @@ option ruby_package = "Google::Cloud::DocumentAI::V1"; message Barcode { // Format of a barcode. // The supported formats are: - // CODE_128: Code 128 type. - // CODE_39: Code 39 type. - // CODE_93: Code 93 type. - // CODABAR: Codabar type. - // DATA_MATRIX: 2D Data Matrix type. - // ITF: ITF type. - // EAN_13: EAN-13 type. - // EAN_8: EAN-8 type. - // QR_CODE: 2D QR code type. - // UPC_A: UPC-A type. - // UPC_E: UPC-E type. - // PDF417: PDF417 type. - // AZTEC: 2D Aztec code type. - // DATABAR: GS1 DataBar code type. + // + // - `CODE_128`: Code 128 type. + // - `CODE_39`: Code 39 type. + // - `CODE_93`: Code 93 type. + // - `CODABAR`: Codabar type. + // - `DATA_MATRIX`: 2D Data Matrix type. + // - `ITF`: ITF type. + // - `EAN_13`: EAN-13 type. + // - `EAN_8`: EAN-8 type. + // - `QR_CODE`: 2D QR code type. + // - `UPC_A`: UPC-A type. + // - `UPC_E`: UPC-E type. + // - `PDF417`: PDF417 type. + // - `AZTEC`: 2D Aztec code type. + // - `DATABAR`: GS1 DataBar code type. string format = 1; // Value format describes the format of the value that a barcode // encodes. // The supported formats are: - // CONTACT_INFO: Contact information. - // EMAIL: Email address. - // ISBN: ISBN identifier. - // PHONE: Phone number. - // PRODUCT: Product. - // SMS: SMS message. - // TEXT: Text string. - // URL: URL address. - // WIFI: Wifi information. - // GEO: Geo-localization. - // CALENDAR_EVENT: Calendar event. - // DRIVER_LICENSE: Driver's license. + // + // - `CONTACT_INFO`: Contact information. + // - `EMAIL`: Email address. + // - `ISBN`: ISBN identifier. + // - `PHONE`: Phone number. + // - `PRODUCT`: Product. + // - `SMS`: SMS message. + // - `TEXT`: Text string. + // - `URL`: URL address. + // - `WIFI`: Wifi information. + // - `GEO`: Geo-localization. + // - `CALENDAR_EVENT`: Calendar event. + // - `DRIVER_LICENSE`: Driver's license. string value_format = 2; // Raw value encoded in the barcode. - // For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + // For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. string raw_value = 3; } diff --git a/google/cloud/documentai/v1/document.proto b/google/cloud/documentai/v1/document.proto index d8bbf6b57..680cf8828 100644 --- a/google/cloud/documentai/v1/document.proto +++ b/google/cloud/documentai/v1/document.proto @@ -50,7 +50,8 @@ message Document { // Total number of shards. int64 shard_count = 2; - // The index of the first character in [Document.text][google.cloud.documentai.v1.Document.text] in the overall + // The index of the first character in + // [Document.text][google.cloud.documentai.v1.Document.text] in the overall // document global text. int64 text_offset = 3; } @@ -67,7 +68,8 @@ message Document { string unit = 2; } - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1.Document.text]. TextAnchor text_anchor = 1; // Text color. @@ -91,6 +93,10 @@ message Document { // Font size. FontSize font_size = 7; + + // Font family such as `Arial`, `Times New Roman`. + // https://www.w3schools.com/cssref/pr_font_font-family.asp + string font_family = 8; } // A page in a [Document][google.cloud.documentai.v1.Document]. @@ -164,62 +170,71 @@ message Document { PAGE_LEFT = 4; } - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1.Document.text]. TextAnchor text_anchor = 1; - // Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this - // layout is for. e.g. confidence can be for a single token, a table, - // a visual element, etc. depending on context. Range [0, 1]. + // Confidence of the current + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] within + // context of the object this layout is for. e.g. confidence can be for a + // single token, a table, a visual element, etc. depending on context. + // Range `[0, 1]`. float confidence = 2; - // The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + // The bounding polygon for the + // [Layout][google.cloud.documentai.v1.Document.Page.Layout]. BoundingPoly bounding_poly = 3; - // Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + // Detected orientation for the + // [Layout][google.cloud.documentai.v1.Document.Page.Layout]. Orientation orientation = 4; } // A block has a set of lines (collected into paragraphs) that have a // common line-spacing and orientation. message Block { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Block][google.cloud.documentai.v1.Document.Page.Block]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Block][google.cloud.documentai.v1.Document.Page.Block]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A collection of lines that a human would perceive as a paragraph. message Paragraph { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A collection of tokens that a human would perceive as a line. // Does not cross column boundaries, can be horizontal, vertical, etc. message Line { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Line][google.cloud.documentai.v1.Document.Page.Line]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Line][google.cloud.documentai.v1.Document.Page.Line]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A detected token. message Token { - // Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + // Detected break at the end of a + // [Token][google.cloud.documentai.v1.Document.Page.Token]. message DetectedBreak { // Enum to denote the type of break found. enum Type { @@ -240,22 +255,25 @@ message Document { Type type = 1; } - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Token][google.cloud.documentai.v1.Document.Page.Token]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Token][google.cloud.documentai.v1.Document.Page.Token]. Layout layout = 1; - // Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + // Detected break at the end of a + // [Token][google.cloud.documentai.v1.Document.Page.Token]. DetectedBreak detected_break = 2; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 3; - // The history of this annotation. - Provenance provenance = 4; + // The history of this annotation. + Provenance provenance = 4 [deprecated = true]; } // A detected symbol. message Symbol { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. Layout layout = 1; // A list of detected languages together with confidence. @@ -265,10 +283,12 @@ message Document { // Detected non-text visual elements e.g. checkbox, signature etc. on the // page. message VisualElement { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. Layout layout = 1; - // Type of the [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + // Type of the + // [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. string type = 2; // A list of detected languages together with confidence. @@ -285,7 +305,8 @@ message Document { // A cell representation inside the table. message TableCell { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. Layout layout = 1; // How many rows this cell spans. @@ -298,7 +319,8 @@ message Document { repeated DetectedLanguage detected_languages = 4; } - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Table][google.cloud.documentai.v1.Document.Page.Table]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [Table][google.cloud.documentai.v1.Document.Page.Table]. Layout layout = 1; // Header rows of the table. @@ -309,15 +331,20 @@ message Document { // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 4; + + // The history of this table. + Provenance provenance = 5; } // A form field detected on the page. message FormField { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. `Address`, `Email`, - // `Grand total`, `Phone number`, etc. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + // [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. + // e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. Layout field_name = 1; - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + // [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. Layout field_value = 2; // A list of detected languages for name together with confidence. @@ -328,9 +355,10 @@ message Document { // If the value is non-textual, this field represents the type. Current // valid values are: - // - blank (this indicates the field_value is normal text) - // - "unfilled_checkbox" - // - "filled_checkbox" + // + // - blank (this indicates the `field_value` is normal text) + // - `unfilled_checkbox` + // - `filled_checkbox` string value_type = 5; // Created for Labeling UI to export key text. @@ -349,27 +377,59 @@ message Document { // A detected barcode. message DetectedBarcode { - // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + // [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + // [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. Layout layout = 1; - // Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + // Detailed barcode information of the + // [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. Barcode barcode = 2; } // Detected language for a structural component. message DetectedLanguage { - // The BCP-47 language code, such as "en-US" or "sr-Latn". For more + // The BCP-47 language code, such as `en-US` or `sr-Latn`. For more // information, see // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. string language_code = 1; - // Confidence of detected language. Range [0, 1]. + // Confidence of detected language. Range `[0, 1]`. float confidence = 2; } - // 1-based index for current [Page][google.cloud.documentai.v1.Document.Page] in a parent [Document][google.cloud.documentai.v1.Document]. - // Useful when a page is taken out of a [Document][google.cloud.documentai.v1.Document] for individual - // processing. + // Image Quality Scores for the page image + message ImageQualityScores { + // Image Quality Defects + message DetectedDefect { + // Name of the defect type. Supported values are: + // + // - `quality/defect_blurry` + // - `quality/defect_noisy` + // - `quality/defect_dark` + // - `quality/defect_faint` + // - `quality/defect_text_too_small` + // - `quality/defect_document_cutoff` + // - `quality/defect_text_cutoff` + // - `quality/defect_glare` + string type = 1; + + // Confidence of detected defect. Range `[0, 1]` where 1 indicates + // strong confidence of that the defect exists. + float confidence = 2; + } + + // The overall quality score. Range `[0, 1]` where 1 is perfect quality. + float quality_score = 1; + + // A list of detected defects. + repeated DetectedDefect detected_defects = 2; + } + + // 1-based index for current + // [Page][google.cloud.documentai.v1.Document.Page] in a parent + // [Document][google.cloud.documentai.v1.Document]. Useful when a page is + // taken out of a [Document][google.cloud.documentai.v1.Document] for + // individual processing. int32 page_number = 1; // Rendered image for this page. This image is preprocessed to remove any @@ -422,8 +482,11 @@ message Document { // A list of detected barcodes. repeated DetectedBarcode detected_barcodes = 15; + // Image Quality Scores. + ImageQualityScores image_quality_scores = 17; + // The history of this page. - Provenance provenance = 16; + Provenance provenance = 16 [deprecated = true]; } // An entity that could be a phrase in the text or a property that belongs to @@ -467,10 +530,11 @@ message Document { // Optional. An optional field to store a normalized string. // For some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will be - // normalized. For example, some processors may not generate float - // or int normalized text by default. + // normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. // // Below are sample formats mapped to structured values. + // // - Money/Currency type (`money_value`) is in the ISO 4217 text format. // - Date type (`date_value`) is in the ISO 8601 text format. // - Datetime type (`datetime_value`) is in the ISO 8601 text format. @@ -478,48 +542,51 @@ message Document { } // Optional. Provenance of the entity. - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1.Document.text]. TextAnchor text_anchor = 1 [(google.api.field_behavior) = OPTIONAL]; // Required. Entity type from a schema e.g. `Address`. string type = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity - // is not present in the document, this field will be empty. + // Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. string mention_text = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Deprecated. Use `id` field instead. string mention_id = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Confidence of detected Schema entity. Range [0, 1]. + // Optional. Confidence of detected Schema entity. Range `[0, 1]`. float confidence = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Represents the provenance of this entity wrt. the location on the - // page where it was found. + // Optional. Represents the provenance of this entity wrt. the location on + // the page where it was found. PageAnchor page_anchor = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. Canonical id. This will be a unique value in the entity list // for this document. string id = 7 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Normalized entity value. Absent if the extracted value could not be - // converted or the type (e.g. address) is not supported for certain + // Optional. Normalized entity value. Absent if the extracted value could + // not be converted or the type (e.g. address) is not supported for certain // parsers. This field is also only populated for certain supported document // types. - NormalizedValue normalized_value = 9 [(google.api.field_behavior) = OPTIONAL]; + NormalizedValue normalized_value = 9 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. Entities can be nested to form a hierarchical data structure representing - // the content in the document. + // Optional. Entities can be nested to form a hierarchical data structure + // representing the content in the document. repeated Entity properties = 10 [(google.api.field_behavior) = OPTIONAL]; // Optional. The history of this annotation. Provenance provenance = 11 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Whether the entity will be redacted for de-identification purposes. + // Optional. Whether the entity will be redacted for de-identification + // purposes. bool redacted = 12 [(google.api.field_behavior) = OPTIONAL]; } - // Relationship between [Entities][google.cloud.documentai.v1.Document.Entity]. + // Relationship between + // [Entities][google.cloud.documentai.v1.Document.Entity]. message EntityRelation { // Subject entity id. string subject_id = 1; @@ -531,21 +598,28 @@ message Document { string relation = 3; } - // Text reference indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + // Text reference indexing into the + // [Document.text][google.cloud.documentai.v1.Document.text]. message TextAnchor { - // A text segment in the [Document.text][google.cloud.documentai.v1.Document.text]. The indices may be out of bounds - // which indicate that the text extends into another document shard for - // large sharded documents. See [ShardInfo.text_offset][google.cloud.documentai.v1.Document.ShardInfo.text_offset] + // A text segment in the + // [Document.text][google.cloud.documentai.v1.Document.text]. The indices + // may be out of bounds which indicate that the text extends into another + // document shard for large sharded documents. See + // [ShardInfo.text_offset][google.cloud.documentai.v1.Document.ShardInfo.text_offset] message TextSegment { - // [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1.Document.text]. + // [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + // start UTF-8 char index in the + // [Document.text][google.cloud.documentai.v1.Document.text]. int64 start_index = 1; - // [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + // [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + // half open end UTF-8 char index in the // [Document.text][google.cloud.documentai.v1.Document.text]. int64 end_index = 2; } - // The text segments from the [Document.text][google.cloud.documentai.v1.Document.text]. + // The text segments from the + // [Document.text][google.cloud.documentai.v1.Document.text]. repeated TextSegment text_segments = 1; // Contains the content of the text span so that users do @@ -554,9 +628,10 @@ message Document { string content = 2; } - // Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1.Document.pages]. - // Page anchors can be cross-page, consist of multiple bounding polygons and - // optionally reference specific layout element types. + // Referencing the visual context of the entity in the + // [Document.pages][google.cloud.documentai.v1.Document.pages]. Page anchors + // can be cross-page, consist of multiple bounding polygons and optionally + // reference specific layout element types. message PageAnchor { // Represents a weak reference to a page element within a document. message PageRef { @@ -565,47 +640,65 @@ message Document { // Layout Unspecified. LAYOUT_TYPE_UNSPECIFIED = 0; - // References a [Page.blocks][google.cloud.documentai.v1.Document.Page.blocks] element. + // References a + // [Page.blocks][google.cloud.documentai.v1.Document.Page.blocks] + // element. BLOCK = 1; - // References a [Page.paragraphs][google.cloud.documentai.v1.Document.Page.paragraphs] element. + // References a + // [Page.paragraphs][google.cloud.documentai.v1.Document.Page.paragraphs] + // element. PARAGRAPH = 2; - // References a [Page.lines][google.cloud.documentai.v1.Document.Page.lines] element. + // References a + // [Page.lines][google.cloud.documentai.v1.Document.Page.lines] element. LINE = 3; - // References a [Page.tokens][google.cloud.documentai.v1.Document.Page.tokens] element. + // References a + // [Page.tokens][google.cloud.documentai.v1.Document.Page.tokens] + // element. TOKEN = 4; - // References a [Page.visual_elements][google.cloud.documentai.v1.Document.Page.visual_elements] element. + // References a + // [Page.visual_elements][google.cloud.documentai.v1.Document.Page.visual_elements] + // element. VISUAL_ELEMENT = 5; - // Refrrences a [Page.tables][google.cloud.documentai.v1.Document.Page.tables] element. + // Refrrences a + // [Page.tables][google.cloud.documentai.v1.Document.Page.tables] + // element. TABLE = 6; - // References a [Page.form_fields][google.cloud.documentai.v1.Document.Page.form_fields] element. + // References a + // [Page.form_fields][google.cloud.documentai.v1.Document.Page.form_fields] + // element. FORM_FIELD = 7; } - // Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using - // [Document.pages][page_refs.page] to locate the related page element. - // This field is skipped when its value is the default 0. See + // Required. Index into the + // [Document.pages][google.cloud.documentai.v1.Document.pages] element, + // for example using + // `[Document.pages][page_refs.page]` to locate the related page element. + // This field is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. int64 page = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The type of the layout element that is being referenced if any. + // Optional. The type of the layout element that is being referenced if + // any. LayoutType layout_type = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] instead. - string layout_id = 3 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + // Optional. Deprecated. Use + // [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] + // instead. + string layout_id = 3 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; - // Optional. Identifies the bounding polygon of a layout element on the page. + // Optional. Identifies the bounding polygon of a layout element on the + // page. BoundingPoly bounding_poly = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Confidence of detected page element, if applicable. Range [0, 1]. + // Optional. Confidence of detected page element, if applicable. Range + // `[0, 1]`. float confidence = 5 [(google.api.field_behavior) = OPTIONAL]; } @@ -716,8 +809,9 @@ message Document { // This message is used for text changes aka. OCR corrections. message TextChange { // Provenance of the correction. - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. There can only be a - // single `TextAnchor.text_segments` element. If the start and + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1.Document.text]. There can + // only be a single `TextAnchor.text_segments` element. If the start and // end index of the text segment are the same, the text change is inserted // before that index. TextAnchor text_anchor = 1; @@ -726,7 +820,7 @@ message Document { string changed_text = 2; // The history of this annotation. - repeated Provenance provenance = 3; + repeated Provenance provenance = 3 [deprecated = true]; } // Original source document from the user. @@ -752,22 +846,25 @@ message Document { // Optional. UTF-8 encoded text in reading order from the document. string text = 4 [(google.api.field_behavior) = OPTIONAL]; - // Placeholder. Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. - repeated Style text_styles = 5; + // Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. + repeated Style text_styles = 5 [deprecated = true]; // Visual page layout for the [Document][google.cloud.documentai.v1.Document]. repeated Page pages = 6; - // A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, - // entities in this list may cross shard boundaries. + // A list of entities detected on + // [Document.text][google.cloud.documentai.v1.Document.text]. For document + // shards, entities in this list may cross shard boundaries. repeated Entity entities = 7; - // Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities]. + // Placeholder. Relationship among + // [Document.entities][google.cloud.documentai.v1.Document.entities]. repeated EntityRelation entity_relations = 8; - // Placeholder. A list of text corrections made to [Document.text]. This is - // usually used for annotating corrections to OCR mistakes. Text changes for - // a given revision may not overlap with each other. + // Placeholder. A list of text corrections made to + // [Document.text][google.cloud.documentai.v1.Document.text]. This is usually + // used for annotating corrections to OCR mistakes. Text changes for a given + // revision may not overlap with each other. repeated TextChange text_changes = 14; // Information about the sharding if this document is sharded part of a larger diff --git a/google/cloud/documentai/v1/document_io.proto b/google/cloud/documentai/v1/document_io.proto index 17630a035..d56086336 100644 --- a/google/cloud/documentai/v1/document_io.proto +++ b/google/cloud/documentai/v1/document_io.proto @@ -16,6 +16,8 @@ syntax = "proto3"; package google.cloud.documentai.v1; +import "google/protobuf/field_mask.proto"; + option csharp_namespace = "Google.Cloud.DocumentAI.V1"; option go_package = "google.golang.org/genproto/googleapis/cloud/documentai/v1;documentai"; option java_multiple_files = true; @@ -30,7 +32,7 @@ message RawDocument { bytes content = 1; // An IANA MIME type (RFC6838) indicating the nature and format of the - // [content]. + // [content][google.cloud.documentai.v1.RawDocument.content]. string mime_type = 2; } @@ -59,7 +61,7 @@ message GcsPrefix { message BatchDocumentsInputConfig { // The source. oneof source { - // The set of documents that match the specified Cloud Storage [gcs_prefix]. + // The set of documents that match the specified Cloud Storage `gcs_prefix`. GcsPrefix gcs_prefix = 1; // The set of documents individually specified on Cloud Storage. @@ -72,8 +74,25 @@ message BatchDocumentsInputConfig { message DocumentOutputConfig { // The configuration used when outputting documents. message GcsOutputConfig { + // The sharding config for the output document. + message ShardingConfig { + // The number of pages per shard. + int32 pages_per_shard = 1; + + // The number of overlapping pages between consecutive shards. + int32 pages_overlap = 2; + } + // The Cloud Storage uri (a directory) of the output. string gcs_uri = 1; + + // Specifies which fields to include in the output documents. + // Only supports top level document and pages field so it must be in the + // form of `{document_field_name}` or `pages.{page_field_name}`. + google.protobuf.FieldMask field_mask = 2; + + // Specifies the sharding config for the output document. + ShardingConfig sharding_config = 3; } // The destination of the results. diff --git a/google/cloud/documentai/v1/document_processor_service.proto b/google/cloud/documentai/v1/document_processor_service.proto index 9c944f259..016d99a8e 100644 --- a/google/cloud/documentai/v1/document_processor_service.proto +++ b/google/cloud/documentai/v1/document_processor_service.proto @@ -53,7 +53,8 @@ option (google.api.resource_definition) = { // structured information from unstructured or semi-structured documents. service DocumentProcessorService { option (google.api.default_host) = "documentai.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"; // Processes a single document. rpc ProcessDocument(ProcessRequest) returns (ProcessResponse) { @@ -70,7 +71,8 @@ service DocumentProcessorService { // LRO endpoint to batch process many documents. The output is written // to Cloud Storage as JSON in the [Document] format. - rpc BatchProcessDocuments(BatchProcessRequest) returns (google.longrunning.Operation) { + rpc BatchProcessDocuments(BatchProcessRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/processors/*}:batchProcess" body: "*" @@ -88,7 +90,8 @@ service DocumentProcessorService { // Fetches processor types. Note that we do not use ListProcessorTypes here // because it is not paginated. - rpc FetchProcessorTypes(FetchProcessorTypesRequest) returns (FetchProcessorTypesResponse) { + rpc FetchProcessorTypes(FetchProcessorTypesRequest) + returns (FetchProcessorTypesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}:fetchProcessorTypes" }; @@ -96,7 +99,8 @@ service DocumentProcessorService { } // Lists the processor types that exist. - rpc ListProcessorTypes(ListProcessorTypesRequest) returns (ListProcessorTypesResponse) { + rpc ListProcessorTypes(ListProcessorTypesRequest) + returns (ListProcessorTypesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/processorTypes" }; @@ -120,7 +124,8 @@ service DocumentProcessorService { } // Gets a processor version detail. - rpc GetProcessorVersion(GetProcessorVersionRequest) returns (ProcessorVersion) { + rpc GetProcessorVersion(GetProcessorVersionRequest) + returns (ProcessorVersion) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/processors/*/processorVersions/*}" }; @@ -128,7 +133,8 @@ service DocumentProcessorService { } // Lists all versions of a processor. - rpc ListProcessorVersions(ListProcessorVersionsRequest) returns (ListProcessorVersionsResponse) { + rpc ListProcessorVersions(ListProcessorVersionsRequest) + returns (ListProcessorVersionsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/processors/*}/processorVersions" }; @@ -137,7 +143,8 @@ service DocumentProcessorService { // Deletes the processor version, all artifacts under the processor version // will be deleted. - rpc DeleteProcessorVersion(DeleteProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc DeleteProcessorVersion(DeleteProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/processors/*/processorVersions/*}" }; @@ -149,7 +156,8 @@ service DocumentProcessorService { } // Deploys the processor version. - rpc DeployProcessorVersion(DeployProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc DeployProcessorVersion(DeployProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/processors/*/processorVersions/*}:deploy" body: "*" @@ -162,7 +170,8 @@ service DocumentProcessorService { } // Undeploys the processor version. - rpc UndeployProcessorVersion(UndeployProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc UndeployProcessorVersion(UndeployProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/processors/*/processorVersions/*}:undeploy" body: "*" @@ -186,7 +195,8 @@ service DocumentProcessorService { // Deletes the processor, unloads all deployed model artifacts if it was // enabled and then deletes all artifacts associated with this processor. - rpc DeleteProcessor(DeleteProcessorRequest) returns (google.longrunning.Operation) { + rpc DeleteProcessor(DeleteProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/processors/*}" }; @@ -198,7 +208,8 @@ service DocumentProcessorService { } // Enables a processor - rpc EnableProcessor(EnableProcessorRequest) returns (google.longrunning.Operation) { + rpc EnableProcessor(EnableProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/processors/*}:enable" body: "*" @@ -210,7 +221,8 @@ service DocumentProcessorService { } // Disables a processor - rpc DisableProcessor(DisableProcessorRequest) returns (google.longrunning.Operation) { + rpc DisableProcessor(DisableProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/processors/*}:disable" body: "*" @@ -221,10 +233,13 @@ service DocumentProcessorService { }; } - // Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in - // [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and + // Set the default (active) version of a + // [Processor][google.cloud.documentai.v1.Processor] that will be used in + // [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] + // and // [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]. - rpc SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{processor=projects/*/locations/*/processors/*}:setDefaultProcessorVersion" body: "*" @@ -237,7 +252,8 @@ service DocumentProcessorService { // Send a document for Human Review. The input document should be processed by // the specified processor. - rpc ReviewDocument(ReviewDocumentRequest) returns (google.longrunning.Operation) { + rpc ReviewDocument(ReviewDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{human_review_config=projects/*/locations/*/processors/*/humanReviewConfig}:reviewDocument" body: "*" @@ -261,17 +277,19 @@ message ProcessRequest { RawDocument raw_document = 5; } - // Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + // Required. The resource name of the + // [Processor][google.cloud.documentai.v1.Processor] or // [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - // to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - // its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - // `projects/{project}/locations/{location}/processors/{processor}`, or + // to use for processing. If a + // [Processor][google.cloud.documentai.v1.Processor] is specified, the server + // will use its [default + // version][google.cloud.documentai.v1.Processor.default_processor_version]. + // Format: `projects/{project}/locations/{location}/processors/{processor}`, + // or // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "*" - } + (google.api.resource_reference) = { type: "*" } ]; // Whether Human Review feature should be skipped for this request. Default to @@ -279,6 +297,8 @@ message ProcessRequest { bool skip_human_review = 3; // Specifies which fields to include in ProcessResponse's document. + // Only supports top level document and pages field so it must be in the form + // of `{document_field_name}` or `pages.{page_field_name}`. google.protobuf.FieldMask field_mask = 6; } @@ -330,16 +350,15 @@ message ProcessResponse { // Request message for batch process document method. message BatchProcessRequest { - // Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + // Required. The resource name of + // [Processor][google.cloud.documentai.v1.Processor] or // [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. // Format: `projects/{project}/locations/{location}/processors/{processor}`, // or // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "*" - } + (google.api.resource_reference) = { type: "*" } ]; // The input documents for batch process. @@ -354,9 +373,7 @@ message BatchProcessRequest { } // Response message for batch process document method. -message BatchProcessResponse { - -} +message BatchProcessResponse {} // The long running operation metadata for batch process method. message BatchProcessMetadata { @@ -471,8 +488,8 @@ message ListProcessorTypesResponse { // Request message for list all processors belongs to a project. message ListProcessorsRequest { - // Required. The parent (project and location) which owns this collection of Processors. - // Format: `projects/{project}/locations/{location}` + // Required. The parent (project and location) which owns this collection of + // Processors. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -523,8 +540,9 @@ message GetProcessorVersionRequest { // Request message for list all processor versions belongs to a processor. message ListProcessorVersionsRequest { - // Required. The parent (project, location and processor) to list all versions. - // Format: `projects/{project}/locations/{location}/processors/{processor}` + // Required. The parent (project, location and processor) to list all + // versions. Format: + // `projects/{project}/locations/{location}/processors/{processor}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -580,9 +598,7 @@ message DeployProcessorVersionRequest { } // Response message for the deploy processor version method. -message DeployProcessorVersionResponse { - -} +message DeployProcessorVersionResponse {} // The long running operation metadata for deploy processor version method. message DeployProcessorVersionMetadata { @@ -602,9 +618,7 @@ message UndeployProcessorVersionRequest { } // Response message for the undeploy processor version method. -message UndeployProcessorVersionResponse { - -} +message UndeployProcessorVersionResponse {} // The long running operation metadata for the undeploy processor version // method. @@ -617,8 +631,8 @@ message UndeployProcessorVersionMetadata { // a regionalized backend service, and if the processor type is not available // on that region, the creation will fail. message CreateProcessorRequest { - // Required. The parent (project and location) under which to create the processor. - // Format: `projects/{project}/locations/{location}` + // Required. The parent (project and location) under which to create the + // processor. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -626,8 +640,9 @@ message CreateProcessorRequest { } ]; - // Required. The processor to be created, requires [processor_type] and [display_name] - // to be set. Also, the processor is under CMEK if CMEK fields are set. + // Required. The processor to be created, requires [processor_type] and + // [display_name] to be set. Also, the processor is under CMEK if CMEK fields + // are set. Processor processor = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -661,9 +676,7 @@ message EnableProcessorRequest { // Response message for the enable processor method. // Intentionally empty proto for adding fields in future. -message EnableProcessorResponse { - -} +message EnableProcessorResponse {} // The long running operation metadata for enable processor method. message EnableProcessorMetadata { @@ -684,9 +697,7 @@ message DisableProcessorRequest { // Response message for the disable processor method. // Intentionally empty proto for adding fields in future. -message DisableProcessorResponse { - -} +message DisableProcessorResponse {} // The long running operation metadata for disable processor method. message DisableProcessorMetadata { @@ -696,7 +707,9 @@ message DisableProcessorMetadata { // Request message for the set default processor version method. message SetDefaultProcessorVersionRequest { - // Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. + // Required. The resource name of the + // [Processor][google.cloud.documentai.v1.Processor] to change default + // version. string processor = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -704,8 +717,9 @@ message SetDefaultProcessorVersionRequest { } ]; - // Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - // Format: + // Required. The resource name of child + // [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + // default. Format: // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` string default_processor_version = 2 [ (google.api.field_behavior) = REQUIRED, @@ -716,9 +730,7 @@ message SetDefaultProcessorVersionRequest { } // Response message for set default processor version method. -message SetDefaultProcessorVersionResponse { - -} +message SetDefaultProcessorVersionResponse {} // The long running operation metadata for set default processor version // method. @@ -745,8 +757,8 @@ message ReviewDocumentRequest { Document inline_document = 4; } - // Required. The resource name of the HumanReviewConfig that the document will be - // reviewed with. + // Required. The resource name of the HumanReviewConfig that the document will + // be reviewed with. string human_review_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/documentai/v1/document_schema.proto b/google/cloud/documentai/v1/document_schema.proto index 24bd42285..679a6ee59 100644 --- a/google/cloud/documentai/v1/document_schema.proto +++ b/google/cloud/documentai/v1/document_schema.proto @@ -86,15 +86,16 @@ message DocumentSchema { // Name of the type. It must be unique within the schema file and // cannot be a 'Common Type'. Besides that we use the following naming // conventions: - // - *use snake_casing* - // - name matching is case-insensitive + // + // - *use `snake_casing`* + // - name matching is case-sensitive // - Maximum 64 characters. // - Must start with a letter. // - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward // compatibility internal infrastructure and tooling can handle any ascii // character) - // - The '/' is sometimes used to denote a property of a type. For example - // line_item/amount. This convention is deprecated, but will still be + // - The `/` is sometimes used to denote a property of a type. For example + // `line_item/amount`. This convention is deprecated, but will still be // honored for backward compatibility. string name = 1; diff --git a/google/cloud/documentai/v1/processor.proto b/google/cloud/documentai/v1/processor.proto index b7eb95ef3..ac599e987 100644 --- a/google/cloud/documentai/v1/processor.proto +++ b/google/cloud/documentai/v1/processor.proto @@ -18,6 +18,7 @@ package google.cloud.documentai.v1; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; +import "google/cloud/documentai/v1/document_schema.proto"; import "google/protobuf/timestamp.proto"; option csharp_namespace = "Google.Cloud.DocumentAI.V1"; @@ -45,9 +46,10 @@ message ProcessorVersion { google.protobuf.Timestamp deprecation_time = 1; // If set, the processor version that will be used as a replacement. - string replacement_processor_version = 2 [(google.api.resource_reference) = { - type: "documentai.googleapis.com/ProcessorVersion" - }]; + string replacement_processor_version = 2 + [(google.api.resource_reference) = { + type: "documentai.googleapis.com/ProcessorVersion" + }]; } // The possible states of the processor version. @@ -85,6 +87,9 @@ message ProcessorVersion { // The display name of the processor version. string display_name = 2; + // The schema of the processor version. Describes the output. + DocumentSchema document_schema = 12; + // The state of the processor version. State state = 6; @@ -125,14 +130,14 @@ message Processor { // The processor is disabled. DISABLED = 2; - // The processor is being enabled, will become ENABLED if successful. + // The processor is being enabled, will become `ENABLED` if successful. ENABLING = 3; - // The processor is being disabled, will become DISABLED if successful. + // The processor is being disabled, will become `DISABLED` if successful. DISABLING = 4; - // The processor is being created, will become either ENABLED (for - // successful creation) or FAILED (for failed ones). + // The processor is being created, will become either `ENABLED` (for + // successful creation) or `FAILED` (for failed ones). // Once a processor is in this state, it can then be used for document // processing, but the feature dependencies of the processor might not be // fully created yet. @@ -154,7 +159,7 @@ message Processor { (google.api.field_behavior) = OUTPUT_ONLY ]; - // The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. + // The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. // To get a list of processors types, see // [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes]. string type = 2; @@ -167,10 +172,11 @@ message Processor { // The default processor version. string default_processor_version = 9 [(google.api.resource_reference) = { - type: "documentai.googleapis.com/ProcessorVersion" - }]; + type: "documentai.googleapis.com/ProcessorVersion" + }]; - // Output only. Immutable. The http endpoint that can be called to invoke processing. + // Output only. Immutable. The http endpoint that can be called to invoke + // processing. string process_endpoint = 6 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.field_behavior) = IMMUTABLE diff --git a/google/cloud/documentai/v1/processor_type.proto b/google/cloud/documentai/v1/processor_type.proto index dd5ef4700..a54274532 100644 --- a/google/cloud/documentai/v1/processor_type.proto +++ b/google/cloud/documentai/v1/processor_type.proto @@ -42,10 +42,10 @@ message ProcessorType { } // The resource name of the processor type. - // Format: projects/{project}/processorTypes/{processor_type} + // Format: `projects/{project}/processorTypes/{processor_type}` string name = 1; - // The type of the processor, e.g., "invoice_parsing". + // The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. string type = 2; // The processor category, used by UI to group processor types. @@ -60,4 +60,7 @@ message ProcessorType { // Launch stage of the processor type google.api.LaunchStage launch_stage = 8; + + // A set of Cloud Storage URIs of sample documents for this processor. + repeated string sample_document_uris = 9; } diff --git a/google/cloud/documentai/v1beta1/BUILD.bazel b/google/cloud/documentai/v1beta1/BUILD.bazel index cd46265e1..8b18f24ff 100644 --- a/google/cloud/documentai/v1beta1/BUILD.bazel +++ b/google/cloud/documentai/v1beta1/BUILD.bazel @@ -71,9 +71,11 @@ java_gapic_library( name = "documentai_java_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":documentai_java_grpc", ], + transport = "grpc", deps = [ ":documentai_java_proto", ], @@ -91,6 +93,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-documentai-v1beta1-java", include_samples = True, + transport = "grpc", deps = [ ":documentai_java_gapic", ":documentai_java_grpc", @@ -128,12 +131,14 @@ go_gapic_library( srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_grpc_service_config.json", importpath = "cloud.google.com/go/documentai/apiv1beta1;documentai", + rest_numeric_enums = True, service_yaml = "//google/cloud/documentai:documentai_v1beta1.yaml", + transport = "grpc", deps = [ ":documentai_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -168,6 +173,7 @@ py_gapic_library( name = "documentai_py_gapic", srcs = [":documentai_proto"], grpc_service_config = "documentai_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -215,7 +221,9 @@ php_gapic_library( name = "documentai_php_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/documentai:documentai_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":documentai_php_grpc", ":documentai_php_proto", @@ -248,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "documentai_grpc_service_config.json", package = "google.cloud.documentai.v1beta1", + rest_numeric_enums = True, service_yaml = "//google/cloud/documentai:documentai_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -286,6 +296,7 @@ ruby_cloud_gapic_library( name = "documentai_ruby_gapic", srcs = [":documentai_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-documentai-v1beta1"], + rest_numeric_enums = True, deps = [ ":documentai_ruby_grpc", ":documentai_ruby_proto", @@ -329,6 +340,7 @@ csharp_gapic_library( srcs = [":documentai_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "documentai_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/documentai:documentai_v1beta1.yaml", deps = [ ":documentai_csharp_grpc", diff --git a/google/cloud/documentai/v1beta2/BUILD.bazel b/google/cloud/documentai/v1beta2/BUILD.bazel index 69029a54e..7f185d700 100644 --- a/google/cloud/documentai/v1beta2/BUILD.bazel +++ b/google/cloud/documentai/v1beta2/BUILD.bazel @@ -71,9 +71,11 @@ java_gapic_library( name = "documentai_java_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_v1beta2_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":documentai_java_grpc", ], + transport = "grpc", deps = [ ":documentai_java_proto", ], @@ -91,6 +93,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-documentai-v1beta2-java", include_samples = True, + transport = "grpc", deps = [ ":documentai_java_gapic", ":documentai_java_grpc", @@ -128,12 +131,14 @@ go_gapic_library( srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_v1beta2_grpc_service_config.json", importpath = "cloud.google.com/go/documentai/apiv1beta2;documentai", + rest_numeric_enums = True, service_yaml = "documentai_v1beta2.yaml", + transport = "grpc", deps = [ ":documentai_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -168,6 +173,7 @@ py_gapic_library( name = "documentai_py_gapic", srcs = [":documentai_proto"], grpc_service_config = "documentai_v1beta2_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -215,6 +221,8 @@ php_gapic_library( name = "documentai_php_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_v1beta2_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":documentai_php_grpc", ":documentai_php_proto", @@ -247,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "documentai_v1beta2_grpc_service_config.json", package = "google.cloud.documentai.v1beta2", + rest_numeric_enums = True, service_yaml = "documentai_v1beta2.yaml", + transport = "grpc", deps = [], ) @@ -285,6 +295,7 @@ ruby_cloud_gapic_library( name = "documentai_ruby_gapic", srcs = [":documentai_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-documentai-v1beta2"], + rest_numeric_enums = True, deps = [ ":documentai_ruby_grpc", ":documentai_ruby_proto", @@ -328,6 +339,7 @@ csharp_gapic_library( srcs = [":documentai_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "documentai_v1beta2_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1beta2.yaml", deps = [ ":documentai_csharp_grpc", diff --git a/google/cloud/documentai/v1beta3/BUILD.bazel b/google/cloud/documentai/v1beta3/BUILD.bazel index 970cc901e..26072d590 100644 --- a/google/cloud/documentai/v1beta3/BUILD.bazel +++ b/google/cloud/documentai/v1beta3/BUILD.bazel @@ -26,6 +26,7 @@ proto_library( "document_io.proto", "document_processor_service.proto", "document_schema.proto", + "evaluation.proto", "geometry.proto", "operation_metadata.proto", "processor.proto", @@ -86,6 +87,7 @@ java_gapic_library( srcs = [":documentai_proto_with_info"], gapic_yaml = None, grpc_service_config = "documentai_v1beta3_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", test_deps = [ ":documentai_java_grpc", @@ -156,14 +158,15 @@ go_gapic_library( grpc_service_config = "documentai_v1beta3_grpc_service_config.json", importpath = "cloud.google.com/go/documentai/apiv1beta3;documentai", metadata = True, + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", transport = "grpc+rest", deps = [ ":documentai_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -200,6 +203,7 @@ py_gapic_library( srcs = [":documentai_proto"], grpc_service_config = "documentai_v1beta3_grpc_service_config.json", opt_args = ["autogen-snippets"], + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", transport = "grpc", deps = [ @@ -250,7 +254,9 @@ php_gapic_library( name = "documentai_php_gapic", srcs = [":documentai_proto_with_info"], grpc_service_config = "documentai_v1beta3_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", + transport = "grpc+rest", deps = [ ":documentai_php_grpc", ":documentai_php_proto", @@ -283,7 +289,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "documentai_v1beta3_grpc_service_config.json", package = "google.cloud.documentai.v1beta3", + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", + transport = "grpc+rest", deps = [], ) @@ -329,6 +337,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/document-ai/", ], grpc_service_config = "documentai_v1beta3_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Document AI uses machine learning on a single cloud-based platform to automatically classify, extract, and enrich data within your documents to unlock insights.", ruby_cloud_title = "Document AI V1beta3", service_yaml = "documentai_v1beta3.yaml", @@ -375,6 +384,7 @@ csharp_gapic_library( srcs = [":documentai_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "documentai_v1beta3_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "documentai_v1beta3.yaml", deps = [ ":documentai_csharp_grpc", diff --git a/google/cloud/documentai/v1beta3/barcode.proto b/google/cloud/documentai/v1beta3/barcode.proto index 7c7050a86..9b063faf2 100644 --- a/google/cloud/documentai/v1beta3/barcode.proto +++ b/google/cloud/documentai/v1beta3/barcode.proto @@ -28,40 +28,42 @@ option ruby_package = "Google::Cloud::DocumentAI::V1beta3"; message Barcode { // Format of a barcode. // The supported formats are: - // CODE_128: Code 128 type. - // CODE_39: Code 39 type. - // CODE_93: Code 93 type. - // CODABAR: Codabar type. - // DATA_MATRIX: 2D Data Matrix type. - // ITF: ITF type. - // EAN_13: EAN-13 type. - // EAN_8: EAN-8 type. - // QR_CODE: 2D QR code type. - // UPC_A: UPC-A type. - // UPC_E: UPC-E type. - // PDF417: PDF417 type. - // AZTEC: 2D Aztec code type. - // DATABAR: GS1 DataBar code type. + // + // - `CODE_128`: Code 128 type. + // - `CODE_39`: Code 39 type. + // - `CODE_93`: Code 93 type. + // - `CODABAR`: Codabar type. + // - `DATA_MATRIX`: 2D Data Matrix type. + // - `ITF`: ITF type. + // - `EAN_13`: EAN-13 type. + // - `EAN_8`: EAN-8 type. + // - `QR_CODE`: 2D QR code type. + // - `UPC_A`: UPC-A type. + // - `UPC_E`: UPC-E type. + // - `PDF417`: PDF417 type. + // - `AZTEC`: 2D Aztec code type. + // - `DATABAR`: GS1 DataBar code type. string format = 1; // Value format describes the format of the value that a barcode // encodes. // The supported formats are: - // CONTACT_INFO: Contact information. - // EMAIL: Email address. - // ISBN: ISBN identifier. - // PHONE: Phone number. - // PRODUCT: Product. - // SMS: SMS message. - // TEXT: Text string. - // URL: URL address. - // WIFI: Wifi information. - // GEO: Geo-localization. - // CALENDAR_EVENT: Calendar event. - // DRIVER_LICENSE: Driver's license. + // + // - `CONTACT_INFO`: Contact information. + // - `EMAIL`: Email address. + // - `ISBN`: ISBN identifier. + // - `PHONE`: Phone number. + // - `PRODUCT`: Product. + // - `SMS`: SMS message. + // - `TEXT`: Text string. + // - `URL`: URL address. + // - `WIFI`: Wifi information. + // - `GEO`: Geo-localization. + // - `CALENDAR_EVENT`: Calendar event. + // - `DRIVER_LICENSE`: Driver's license. string value_format = 2; // Raw value encoded in the barcode. - // For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + // For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. string raw_value = 3; } diff --git a/google/cloud/documentai/v1beta3/document.proto b/google/cloud/documentai/v1beta3/document.proto index 809a64ea4..89f4d2e21 100644 --- a/google/cloud/documentai/v1beta3/document.proto +++ b/google/cloud/documentai/v1beta3/document.proto @@ -50,8 +50,9 @@ message Document { // Total number of shards. int64 shard_count = 2; - // The index of the first character in [Document.text][google.cloud.documentai.v1beta3.Document.text] in the overall - // document global text. + // The index of the first character in + // [Document.text][google.cloud.documentai.v1beta3.Document.text] in the + // overall document global text. int64 text_offset = 3; } @@ -67,7 +68,8 @@ message Document { string unit = 2; } - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. TextAnchor text_anchor = 1; // Text color. @@ -91,6 +93,10 @@ message Document { // Font size. FontSize font_size = 7; + + // Font family such as `Arial`, `Times New Roman`. + // https://www.w3schools.com/cssref/pr_font_font-family.asp + string font_family = 8; } // A page in a [Document][google.cloud.documentai.v1beta3.Document]. @@ -164,62 +170,71 @@ message Document { PAGE_LEFT = 4; } - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. TextAnchor text_anchor = 1; - // Confidence of the current [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] within context of the object this - // layout is for. e.g. confidence can be for a single token, a table, - // a visual element, etc. depending on context. Range [0, 1]. + // Confidence of the current + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] within + // context of the object this layout is for. e.g. confidence can be for a + // single token, a table, a visual element, etc. depending on context. + // Range `[0, 1]`. float confidence = 2; - // The bounding polygon for the [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout]. + // The bounding polygon for the + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout]. BoundingPoly bounding_poly = 3; - // Detected orientation for the [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout]. + // Detected orientation for the + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout]. Orientation orientation = 4; } // A block has a set of lines (collected into paragraphs) that have a // common line-spacing and orientation. message Block { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Block][google.cloud.documentai.v1beta3.Document.Page.Block]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Block][google.cloud.documentai.v1beta3.Document.Page.Block]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A collection of lines that a human would perceive as a paragraph. message Paragraph { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1beta3.Document.Page.Paragraph]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Paragraph][google.cloud.documentai.v1beta3.Document.Page.Paragraph]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A collection of tokens that a human would perceive as a line. // Does not cross column boundaries, can be horizontal, vertical, etc. message Line { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Line][google.cloud.documentai.v1beta3.Document.Page.Line]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Line][google.cloud.documentai.v1beta3.Document.Page.Line]. Layout layout = 1; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 2; // The history of this annotation. - Provenance provenance = 3; + Provenance provenance = 3 [deprecated = true]; } // A detected token. message Token { - // Detected break at the end of a [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. + // Detected break at the end of a + // [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. message DetectedBreak { // Enum to denote the type of break found. enum Type { @@ -240,22 +255,25 @@ message Document { Type type = 1; } - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. Layout layout = 1; - // Detected break at the end of a [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. + // Detected break at the end of a + // [Token][google.cloud.documentai.v1beta3.Document.Page.Token]. DetectedBreak detected_break = 2; // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 3; - // The history of this annotation. - Provenance provenance = 4; + // The history of this annotation. + Provenance provenance = 4 [deprecated = true]; } // A detected symbol. message Symbol { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1beta3.Document.Page.Symbol]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Symbol][google.cloud.documentai.v1beta3.Document.Page.Symbol]. Layout layout = 1; // A list of detected languages together with confidence. @@ -265,10 +283,12 @@ message Document { // Detected non-text visual elements e.g. checkbox, signature etc. on the // page. message VisualElement { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement]. Layout layout = 1; - // Type of the [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement]. + // Type of the + // [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement]. string type = 2; // A list of detected languages together with confidence. @@ -285,7 +305,8 @@ message Document { // A cell representation inside the table. message TableCell { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1beta3.Document.Page.Table.TableCell]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [TableCell][google.cloud.documentai.v1beta3.Document.Page.Table.TableCell]. Layout layout = 1; // How many rows this cell spans. @@ -298,7 +319,8 @@ message Document { repeated DetectedLanguage detected_languages = 4; } - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Table][google.cloud.documentai.v1beta3.Document.Page.Table]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [Table][google.cloud.documentai.v1beta3.Document.Page.Table]. Layout layout = 1; // Header rows of the table. @@ -309,15 +331,21 @@ message Document { // A list of detected languages together with confidence. repeated DetectedLanguage detected_languages = 4; + + // The history of this table. + Provenance provenance = 5; } // A form field detected on the page. message FormField { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g. `Address`, `Email`, - // `Grand total`, `Phone number`, etc. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the + // [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] + // name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. Layout field_name = 1; - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] value. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the + // [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] + // value. Layout field_value = 2; // A list of detected languages for name together with confidence. @@ -328,9 +356,10 @@ message Document { // If the value is non-textual, this field represents the type. Current // valid values are: - // - blank (this indicates the field_value is normal text) - // - "unfilled_checkbox" - // - "filled_checkbox" + // + // - blank (this indicates the `field_value` is normal text) + // - `unfilled_checkbox` + // - `filled_checkbox` string value_type = 5; // Created for Labeling UI to export key text. @@ -349,27 +378,59 @@ message Document { // A detected barcode. message DetectedBarcode { - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode]. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for + // [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode]. Layout layout = 1; - // Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode]. + // Detailed barcode information of the + // [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode]. Barcode barcode = 2; } // Detected language for a structural component. message DetectedLanguage { - // The BCP-47 language code, such as "en-US" or "sr-Latn". For more + // The BCP-47 language code, such as `en-US` or `sr-Latn`. For more // information, see // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. string language_code = 1; - // Confidence of detected language. Range [0, 1]. + // Confidence of detected language. Range `[0, 1]`. float confidence = 2; } - // 1-based index for current [Page][google.cloud.documentai.v1beta3.Document.Page] in a parent [Document][google.cloud.documentai.v1beta3.Document]. - // Useful when a page is taken out of a [Document][google.cloud.documentai.v1beta3.Document] for individual - // processing. + // Image Quality Scores for the page image + message ImageQualityScores { + // Image Quality Defects + message DetectedDefect { + // Name of the defect type. Supported values are: + // + // - `quality/defect_blurry` + // - `quality/defect_noisy` + // - `quality/defect_dark` + // - `quality/defect_faint` + // - `quality/defect_text_too_small` + // - `quality/defect_document_cutoff` + // - `quality/defect_text_cutoff` + // - `quality/defect_glare` + string type = 1; + + // Confidence of detected defect. Range `[0, 1]` where 1 indicates + // strong confidence of that the defect exists. + float confidence = 2; + } + + // The overall quality score. Range `[0, 1]` where 1 is perfect quality. + float quality_score = 1; + + // A list of detected defects. + repeated DetectedDefect detected_defects = 2; + } + + // 1-based index for current + // [Page][google.cloud.documentai.v1beta3.Document.Page] in a parent + // [Document][google.cloud.documentai.v1beta3.Document]. Useful when a page + // is taken out of a [Document][google.cloud.documentai.v1beta3.Document] + // for individual processing. int32 page_number = 1; // Rendered image for this page. This image is preprocessed to remove any @@ -378,13 +439,15 @@ message Document { Image image = 13; // Transformation matrices that were applied to the original document image - // to produce [Page.image][google.cloud.documentai.v1beta3.Document.Page.image]. + // to produce + // [Page.image][google.cloud.documentai.v1beta3.Document.Page.image]. repeated Matrix transforms = 14; // Physical dimension of the page. Dimension dimension = 2; - // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the page. + // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the + // page. Layout layout = 3; // A list of detected languages together with confidence. @@ -422,8 +485,11 @@ message Document { // A list of detected barcodes. repeated DetectedBarcode detected_barcodes = 15; + // Image Quality Scores. + ImageQualityScores image_quality_scores = 17; + // The history of this page. - Provenance provenance = 16; + Provenance provenance = 16 [deprecated = true]; } // An entity that could be a phrase in the text or a property that belongs to @@ -467,10 +533,11 @@ message Document { // Optional. An optional field to store a normalized string. // For some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will be - // normalized. For example, some processors may not generate float - // or int normalized text by default. + // normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. // // Below are sample formats mapped to structured values. + // // - Money/Currency type (`money_value`) is in the ISO 4217 text format. // - Date type (`date_value`) is in the ISO 8601 text format. // - Datetime type (`datetime_value`) is in the ISO 8601 text format. @@ -478,48 +545,51 @@ message Document { } // Optional. Provenance of the entity. - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. TextAnchor text_anchor = 1 [(google.api.field_behavior) = OPTIONAL]; // Required. Entity type from a schema e.g. `Address`. string type = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity - // is not present in the document, this field will be empty. + // Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. string mention_text = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Deprecated. Use `id` field instead. string mention_id = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Confidence of detected Schema entity. Range [0, 1]. + // Optional. Confidence of detected Schema entity. Range `[0, 1]`. float confidence = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Represents the provenance of this entity wrt. the location on the - // page where it was found. + // Optional. Represents the provenance of this entity wrt. the location on + // the page where it was found. PageAnchor page_anchor = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. Canonical id. This will be a unique value in the entity list // for this document. string id = 7 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Normalized entity value. Absent if the extracted value could not be - // converted or the type (e.g. address) is not supported for certain + // Optional. Normalized entity value. Absent if the extracted value could + // not be converted or the type (e.g. address) is not supported for certain // parsers. This field is also only populated for certain supported document // types. - NormalizedValue normalized_value = 9 [(google.api.field_behavior) = OPTIONAL]; + NormalizedValue normalized_value = 9 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. Entities can be nested to form a hierarchical data structure representing - // the content in the document. + // Optional. Entities can be nested to form a hierarchical data structure + // representing the content in the document. repeated Entity properties = 10 [(google.api.field_behavior) = OPTIONAL]; // Optional. The history of this annotation. Provenance provenance = 11 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Whether the entity will be redacted for de-identification purposes. + // Optional. Whether the entity will be redacted for de-identification + // purposes. bool redacted = 12 [(google.api.field_behavior) = OPTIONAL]; } - // Relationship between [Entities][google.cloud.documentai.v1beta3.Document.Entity]. + // Relationship between + // [Entities][google.cloud.documentai.v1beta3.Document.Entity]. message EntityRelation { // Subject entity id. string subject_id = 1; @@ -531,21 +601,28 @@ message Document { string relation = 3; } - // Text reference indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // Text reference indexing into the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. message TextAnchor { - // A text segment in the [Document.text][google.cloud.documentai.v1beta3.Document.text]. The indices may be out of bounds - // which indicate that the text extends into another document shard for - // large sharded documents. See [ShardInfo.text_offset][google.cloud.documentai.v1beta3.Document.ShardInfo.text_offset] + // A text segment in the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. The + // indices may be out of bounds which indicate that the text extends into + // another document shard for large sharded documents. See + // [ShardInfo.text_offset][google.cloud.documentai.v1beta3.Document.ShardInfo.text_offset] message TextSegment { - // [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment] + // start UTF-8 char index in the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. int64 start_index = 1; - // [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + // [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment] + // half open end UTF-8 char index in the // [Document.text][google.cloud.documentai.v1beta3.Document.text]. int64 end_index = 2; } - // The text segments from the [Document.text][google.cloud.documentai.v1beta3.Document.text]. + // The text segments from the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. repeated TextSegment text_segments = 1; // Contains the content of the text span so that users do @@ -554,8 +631,9 @@ message Document { string content = 2; } - // Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1beta3.Document.pages]. - // Page anchors can be cross-page, consist of multiple bounding polygons and + // Referencing the visual context of the entity in the + // [Document.pages][google.cloud.documentai.v1beta3.Document.pages]. Page + // anchors can be cross-page, consist of multiple bounding polygons and // optionally reference specific layout element types. message PageAnchor { // Represents a weak reference to a page element within a document. @@ -565,47 +643,66 @@ message Document { // Layout Unspecified. LAYOUT_TYPE_UNSPECIFIED = 0; - // References a [Page.blocks][google.cloud.documentai.v1beta3.Document.Page.blocks] element. + // References a + // [Page.blocks][google.cloud.documentai.v1beta3.Document.Page.blocks] + // element. BLOCK = 1; - // References a [Page.paragraphs][google.cloud.documentai.v1beta3.Document.Page.paragraphs] element. + // References a + // [Page.paragraphs][google.cloud.documentai.v1beta3.Document.Page.paragraphs] + // element. PARAGRAPH = 2; - // References a [Page.lines][google.cloud.documentai.v1beta3.Document.Page.lines] element. + // References a + // [Page.lines][google.cloud.documentai.v1beta3.Document.Page.lines] + // element. LINE = 3; - // References a [Page.tokens][google.cloud.documentai.v1beta3.Document.Page.tokens] element. + // References a + // [Page.tokens][google.cloud.documentai.v1beta3.Document.Page.tokens] + // element. TOKEN = 4; - // References a [Page.visual_elements][google.cloud.documentai.v1beta3.Document.Page.visual_elements] element. + // References a + // [Page.visual_elements][google.cloud.documentai.v1beta3.Document.Page.visual_elements] + // element. VISUAL_ELEMENT = 5; - // Refrrences a [Page.tables][google.cloud.documentai.v1beta3.Document.Page.tables] element. + // Refrrences a + // [Page.tables][google.cloud.documentai.v1beta3.Document.Page.tables] + // element. TABLE = 6; - // References a [Page.form_fields][google.cloud.documentai.v1beta3.Document.Page.form_fields] element. + // References a + // [Page.form_fields][google.cloud.documentai.v1beta3.Document.Page.form_fields] + // element. FORM_FIELD = 7; } - // Required. Index into the [Document.pages][google.cloud.documentai.v1beta3.Document.pages] element, for example using - // [Document.pages][page_refs.page] to locate the related page element. - // This field is skipped when its value is the default 0. See + // Required. Index into the + // [Document.pages][google.cloud.documentai.v1beta3.Document.pages] + // element, for example using + // `[Document.pages][page_refs.page]` to locate the related page element. + // This field is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. int64 page = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The type of the layout element that is being referenced if any. + // Optional. The type of the layout element that is being referenced if + // any. LayoutType layout_type = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] instead. - string layout_id = 3 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + // Optional. Deprecated. Use + // [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] + // instead. + string layout_id = 3 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; - // Optional. Identifies the bounding polygon of a layout element on the page. + // Optional. Identifies the bounding polygon of a layout element on the + // page. BoundingPoly bounding_poly = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Confidence of detected page element, if applicable. Range [0, 1]. + // Optional. Confidence of detected page element, if applicable. Range + // `[0, 1]`. float confidence = 5 [(google.api.field_behavior) = OPTIONAL]; } @@ -716,17 +813,18 @@ message Document { // This message is used for text changes aka. OCR corrections. message TextChange { // Provenance of the correction. - // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text]. There can only be a - // single `TextAnchor.text_segments` element. If the start and - // end index of the text segment are the same, the text change is inserted - // before that index. + // Text anchor indexing into the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. There + // can only be a single `TextAnchor.text_segments` element. If the start + // and end index of the text segment are the same, the text change is + // inserted before that index. TextAnchor text_anchor = 1; // The text that replaces the text identified in the `text_anchor`. string changed_text = 2; // The history of this annotation. - repeated Provenance provenance = 3; + repeated Provenance provenance = 3 [deprecated = true]; } // Original source document from the user. @@ -752,20 +850,25 @@ message Document { // Optional. UTF-8 encoded text in reading order from the document. string text = 4 [(google.api.field_behavior) = OPTIONAL]; - // Placeholder. Styles for the [Document.text][google.cloud.documentai.v1beta3.Document.text]. - repeated Style text_styles = 5; + // Styles for the + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. + repeated Style text_styles = 5 [deprecated = true]; - // Visual page layout for the [Document][google.cloud.documentai.v1beta3.Document]. + // Visual page layout for the + // [Document][google.cloud.documentai.v1beta3.Document]. repeated Page pages = 6; - // A list of entities detected on [Document.text][google.cloud.documentai.v1beta3.Document.text]. For document shards, - // entities in this list may cross shard boundaries. + // A list of entities detected on + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. For + // document shards, entities in this list may cross shard boundaries. repeated Entity entities = 7; - // Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1beta3.Document.entities]. + // Placeholder. Relationship among + // [Document.entities][google.cloud.documentai.v1beta3.Document.entities]. repeated EntityRelation entity_relations = 8; - // Placeholder. A list of text corrections made to [Document.text]. This is + // Placeholder. A list of text corrections made to + // [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is // usually used for annotating corrections to OCR mistakes. Text changes for // a given revision may not overlap with each other. repeated TextChange text_changes = 14; diff --git a/google/cloud/documentai/v1beta3/document_io.proto b/google/cloud/documentai/v1beta3/document_io.proto index a0d410c8c..d6a7fb1c4 100644 --- a/google/cloud/documentai/v1beta3/document_io.proto +++ b/google/cloud/documentai/v1beta3/document_io.proto @@ -16,6 +16,8 @@ syntax = "proto3"; package google.cloud.documentai.v1beta3; +import "google/protobuf/field_mask.proto"; + option csharp_namespace = "Google.Cloud.DocumentAI.V1Beta3"; option go_package = "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3;documentai"; option java_multiple_files = true; @@ -30,7 +32,7 @@ message RawDocument { bytes content = 1; // An IANA MIME type (RFC6838) indicating the nature and format of the - // [content]. + // [content][google.cloud.documentai.v1beta3.RawDocument.content]. string mime_type = 2; } @@ -59,7 +61,7 @@ message GcsPrefix { message BatchDocumentsInputConfig { // The source. oneof source { - // The set of documents that match the specified Cloud Storage [gcs_prefix]. + // The set of documents that match the specified Cloud Storage `gcs_prefix`. GcsPrefix gcs_prefix = 1; // The set of documents individually specified on Cloud Storage. @@ -72,8 +74,25 @@ message BatchDocumentsInputConfig { message DocumentOutputConfig { // The configuration used when outputting documents. message GcsOutputConfig { + // The sharding config for the output document. + message ShardingConfig { + // The number of pages per shard. + int32 pages_per_shard = 1; + + // The number of overlapping pages between consecutive shards. + int32 pages_overlap = 2; + } + // The Cloud Storage uri (a directory) of the output. string gcs_uri = 1; + + // Specifies which fields to include in the output documents. + // Only supports top level document and pages field so it must be in the + // form of `{document_field_name}` or `pages.{page_field_name}`. + google.protobuf.FieldMask field_mask = 2; + + // Specifies the sharding config for the output document. + ShardingConfig sharding_config = 3; } // The destination of the results. @@ -82,3 +101,10 @@ message DocumentOutputConfig { GcsOutputConfig gcs_output_config = 1; } } + +// Config for Document OCR. +message OcrConfig { + // Enables special handling for PDFs with existing text information. Results + // in better text extraction quality in such PDF inputs. + bool enable_native_pdf_parsing = 3; +} diff --git a/google/cloud/documentai/v1beta3/document_processor_service.proto b/google/cloud/documentai/v1beta3/document_processor_service.proto index 952db5904..7561517ec 100644 --- a/google/cloud/documentai/v1beta3/document_processor_service.proto +++ b/google/cloud/documentai/v1beta3/document_processor_service.proto @@ -23,6 +23,7 @@ import "google/api/resource.proto"; import "google/cloud/documentai/v1beta3/document.proto"; import "google/cloud/documentai/v1beta3/document_io.proto"; import "google/cloud/documentai/v1beta3/document_schema.proto"; +import "google/cloud/documentai/v1beta3/evaluation.proto"; import "google/cloud/documentai/v1beta3/operation_metadata.proto"; import "google/cloud/documentai/v1beta3/processor.proto"; import "google/cloud/documentai/v1beta3/processor_type.proto"; @@ -53,7 +54,8 @@ option (google.api.resource_definition) = { // structured information from unstructured or semi-structured documents. service DocumentProcessorService { option (google.api.default_host) = "documentai.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"; // Processes a single document. rpc ProcessDocument(ProcessRequest) returns (ProcessResponse) { @@ -70,7 +72,8 @@ service DocumentProcessorService { // LRO endpoint to batch process many documents. The output is written // to Cloud Storage as JSON in the [Document] format. - rpc BatchProcessDocuments(BatchProcessRequest) returns (google.longrunning.Operation) { + rpc BatchProcessDocuments(BatchProcessRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{name=projects/*/locations/*/processors/*}:batchProcess" body: "*" @@ -88,7 +91,8 @@ service DocumentProcessorService { // Fetches processor types. Note that we do not use ListProcessorTypes here // because it is not paginated. - rpc FetchProcessorTypes(FetchProcessorTypesRequest) returns (FetchProcessorTypesResponse) { + rpc FetchProcessorTypes(FetchProcessorTypesRequest) + returns (FetchProcessorTypesResponse) { option (google.api.http) = { get: "/v1beta3/{parent=projects/*/locations/*}:fetchProcessorTypes" }; @@ -96,7 +100,8 @@ service DocumentProcessorService { } // Lists the processor types that exist. - rpc ListProcessorTypes(ListProcessorTypesRequest) returns (ListProcessorTypesResponse) { + rpc ListProcessorTypes(ListProcessorTypesRequest) + returns (ListProcessorTypesResponse) { option (google.api.http) = { get: "/v1beta3/{parent=projects/*/locations/*}/processorTypes" }; @@ -119,8 +124,25 @@ service DocumentProcessorService { option (google.api.method_signature) = "name"; } + // Trains a new processor version. + // Operation metadata is returned as + // cloud_documentai_core.TrainProcessorVersionMetadata. + rpc TrainProcessorVersion(TrainProcessorVersionRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta3/{parent=projects/*/locations/*/processors/*}/processorVersions:train" + body: "*" + }; + option (google.api.method_signature) = "parent,processor_version"; + option (google.longrunning.operation_info) = { + response_type: "TrainProcessorVersionResponse" + metadata_type: "TrainProcessorVersionMetadata" + }; + } + // Gets a processor version detail. - rpc GetProcessorVersion(GetProcessorVersionRequest) returns (ProcessorVersion) { + rpc GetProcessorVersion(GetProcessorVersionRequest) + returns (ProcessorVersion) { option (google.api.http) = { get: "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*}" }; @@ -128,7 +150,8 @@ service DocumentProcessorService { } // Lists all versions of a processor. - rpc ListProcessorVersions(ListProcessorVersionsRequest) returns (ListProcessorVersionsResponse) { + rpc ListProcessorVersions(ListProcessorVersionsRequest) + returns (ListProcessorVersionsResponse) { option (google.api.http) = { get: "/v1beta3/{parent=projects/*/locations/*/processors/*}/processorVersions" }; @@ -137,7 +160,8 @@ service DocumentProcessorService { // Deletes the processor version, all artifacts under the processor version // will be deleted. - rpc DeleteProcessorVersion(DeleteProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc DeleteProcessorVersion(DeleteProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*}" }; @@ -149,7 +173,8 @@ service DocumentProcessorService { } // Deploys the processor version. - rpc DeployProcessorVersion(DeployProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc DeployProcessorVersion(DeployProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*}:deploy" body: "*" @@ -162,7 +187,8 @@ service DocumentProcessorService { } // Undeploys the processor version. - rpc UndeployProcessorVersion(UndeployProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc UndeployProcessorVersion(UndeployProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*}:undeploy" body: "*" @@ -186,7 +212,8 @@ service DocumentProcessorService { // Deletes the processor, unloads all deployed model artifacts if it was // enabled and then deletes all artifacts associated with this processor. - rpc DeleteProcessor(DeleteProcessorRequest) returns (google.longrunning.Operation) { + rpc DeleteProcessor(DeleteProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta3/{name=projects/*/locations/*/processors/*}" }; @@ -198,7 +225,8 @@ service DocumentProcessorService { } // Enables a processor - rpc EnableProcessor(EnableProcessorRequest) returns (google.longrunning.Operation) { + rpc EnableProcessor(EnableProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{name=projects/*/locations/*/processors/*}:enable" body: "*" @@ -210,7 +238,8 @@ service DocumentProcessorService { } // Disables a processor - rpc DisableProcessor(DisableProcessorRequest) returns (google.longrunning.Operation) { + rpc DisableProcessor(DisableProcessorRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{name=projects/*/locations/*/processors/*}:disable" body: "*" @@ -221,10 +250,13 @@ service DocumentProcessorService { }; } - // Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in - // [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and + // Set the default (active) version of a + // [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in + // [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] + // and // [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]. - rpc SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest) returns (google.longrunning.Operation) { + rpc SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{processor=projects/*/locations/*/processors/*}:setDefaultProcessorVersion" body: "*" @@ -237,7 +269,8 @@ service DocumentProcessorService { // Send a document for Human Review. The input document should be processed by // the specified processor. - rpc ReviewDocument(ReviewDocumentRequest) returns (google.longrunning.Operation) { + rpc ReviewDocument(ReviewDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta3/{human_review_config=projects/*/locations/*/processors/*/humanReviewConfig}:reviewDocument" body: "*" @@ -248,6 +281,45 @@ service DocumentProcessorService { metadata_type: "ReviewDocumentOperationMetadata" }; } + + // Evaluates a ProcessorVersion against annotated documents, producing an + // Evaluation. + rpc EvaluateProcessorVersion(EvaluateProcessorVersionRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta3/{processor_version=projects/*/locations/*/processors/*/processorVersions/*}:evaluateProcessorVersion" + body: "*" + }; + option (google.api.method_signature) = "processor_version"; + option (google.longrunning.operation_info) = { + response_type: "EvaluateProcessorVersionResponse" + metadata_type: "EvaluateProcessorVersionMetadata" + }; + } + + // Retrieves a specific evaluation. + rpc GetEvaluation(GetEvaluationRequest) returns (Evaluation) { + option (google.api.http) = { + get: "/v1beta3/{name=projects/*/locations/*/processors/*/processorVersions/*/evaluations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Retrieves a set of evaluations for a given processor version. + rpc ListEvaluations(ListEvaluationsRequest) + returns (ListEvaluationsResponse) { + option (google.api.http) = { + get: "/v1beta3/{parent=projects/*/locations/*/processors/*/processorVersions/*}/evaluations" + }; + option (google.api.method_signature) = "parent"; + } +} + +// Options for Process API +message ProcessOptions { + // Only applicable to "Document OCR Processor". Returns error if set on other + // processor types. + OcrConfig ocr_config = 1; } // Request message for the process document method. @@ -261,17 +333,19 @@ message ProcessRequest { RawDocument raw_document = 5; } - // Required. The resource name of the [Processor][google.cloud.documentai.v1beta3.Processor] or + // Required. The resource name of the + // [Processor][google.cloud.documentai.v1beta3.Processor] or // [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] - // to use for processing. If a [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the server will use - // its [default version][google.cloud.documentai.v1beta3.Processor.default_processor_version]. Format: - // `projects/{project}/locations/{location}/processors/{processor}`, or + // to use for processing. If a + // [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the + // server will use its [default + // version][google.cloud.documentai.v1beta3.Processor.default_processor_version]. + // Format: `projects/{project}/locations/{location}/processors/{processor}`, + // or // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "*" - } + (google.api.resource_reference) = { type: "*" } ]; // The document payload, the [content] and [mime_type] fields must be set. @@ -282,7 +356,12 @@ message ProcessRequest { bool skip_human_review = 3; // Specifies which fields to include in ProcessResponse's document. + // Only supports top level document and pages field so it must be in the form + // of `{document_field_name}` or `pages.{page_field_name}`. google.protobuf.FieldMask field_mask = 6; + + // Inference-time options for the process API + ProcessOptions process_options = 7; } // The status of human review on a processed document. @@ -360,16 +439,15 @@ message BatchProcessRequest { string gcs_destination = 1; } - // Required. The resource name of [Processor][google.cloud.documentai.v1beta3.Processor] or + // Required. The resource name of + // [Processor][google.cloud.documentai.v1beta3.Processor] or // [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]. // Format: `projects/{project}/locations/{location}/processors/{processor}`, // or // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "*" - } + (google.api.resource_reference) = { type: "*" } ]; // The input config for each single document in the batch process. @@ -387,12 +465,13 @@ message BatchProcessRequest { // Whether Human Review feature should be skipped for this request. Default to // false. bool skip_human_review = 4; + + // Inference-time options for the process API + ProcessOptions process_options = 7; } // Response message for batch process document method. -message BatchProcessResponse { - -} +message BatchProcessResponse {} // The long running operation metadata for batch process method. message BatchProcessMetadata { @@ -513,8 +592,8 @@ message ListProcessorTypesResponse { // Request message for list all processors belongs to a project. message ListProcessorsRequest { - // Required. The parent (project and location) which owns this collection of Processors. - // Format: `projects/{project}/locations/{location}` + // Required. The parent (project and location) which owns this collection of + // Processors. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -565,8 +644,9 @@ message GetProcessorVersionRequest { // Request message for list all processor versions belongs to a processor. message ListProcessorVersionsRequest { - // Required. The parent (project, location and processor) to list all versions. - // Format: `projects/{project}/locations/{location}/processors/{processor}` + // Required. The parent (project, location and processor) to list all + // versions. Format: + // `projects/{project}/locations/{location}/processors/{processor}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -622,9 +702,7 @@ message DeployProcessorVersionRequest { } // Response message for the deploy processor version method. -message DeployProcessorVersionResponse { - -} +message DeployProcessorVersionResponse {} // The long running operation metadata for deploy processor version method. message DeployProcessorVersionMetadata { @@ -644,9 +722,7 @@ message UndeployProcessorVersionRequest { } // Response message for the undeploy processor version method. -message UndeployProcessorVersionResponse { - -} +message UndeployProcessorVersionResponse {} // The long running operation metadata for the undeploy processor version // method. @@ -659,8 +735,8 @@ message UndeployProcessorVersionMetadata { // a regionalized backend service, and if the processor type is not available // on that region, the creation will fail. message CreateProcessorRequest { - // Required. The parent (project and location) under which to create the processor. - // Format: `projects/{project}/locations/{location}` + // Required. The parent (project and location) under which to create the + // processor. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -668,8 +744,9 @@ message CreateProcessorRequest { } ]; - // Required. The processor to be created, requires [processor_type] and [display_name] - // to be set. Also, the processor is under CMEK if CMEK fields are set. + // Required. The processor to be created, requires [processor_type] and + // [display_name] to be set. Also, the processor is under CMEK if CMEK fields + // are set. Processor processor = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -703,9 +780,7 @@ message EnableProcessorRequest { // Response message for the enable processor method. // Intentionally empty proto for adding fields in future. -message EnableProcessorResponse { - -} +message EnableProcessorResponse {} // The long running operation metadata for enable processor method. message EnableProcessorMetadata { @@ -726,9 +801,7 @@ message DisableProcessorRequest { // Response message for the disable processor method. // Intentionally empty proto for adding fields in future. -message DisableProcessorResponse { - -} +message DisableProcessorResponse {} // The long running operation metadata for disable processor method. message DisableProcessorMetadata { @@ -738,7 +811,9 @@ message DisableProcessorMetadata { // Request message for the set default processor version method. message SetDefaultProcessorVersionRequest { - // Required. The resource name of the [Processor][google.cloud.documentai.v1beta3.Processor] to change default version. + // Required. The resource name of the + // [Processor][google.cloud.documentai.v1beta3.Processor] to change default + // version. string processor = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -746,8 +821,9 @@ message SetDefaultProcessorVersionRequest { } ]; - // Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to use as default. - // Format: + // Required. The resource name of child + // [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to use + // as default. Format: // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` string default_processor_version = 2 [ (google.api.field_behavior) = REQUIRED, @@ -758,9 +834,7 @@ message SetDefaultProcessorVersionRequest { } // Response message for set default processor version method. -message SetDefaultProcessorVersionResponse { - -} +message SetDefaultProcessorVersionResponse {} // The long running operation metadata for set default processor version // method. @@ -769,6 +843,81 @@ message SetDefaultProcessorVersionMetadata { CommonOperationMetadata common_metadata = 1; } +// Request message for the create processor version method. +message TrainProcessorVersionRequest { + // The input data used to train a new `ProcessorVersion`. + message InputData { + // The documents used for training the new version. + BatchDocumentsInputConfig training_documents = 3; + + // The documents used for testing the trained version. + BatchDocumentsInputConfig test_documents = 4; + } + + // Required. The parent (project, location and processor) to create the new + // version for. Format: + // `projects/{project}/locations/{location}/processors/{processor}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "documentai.googleapis.com/ProcessorVersion" + } + ]; + + // Required. The processor version to be created. + ProcessorVersion processor_version = 2 + [(google.api.field_behavior) = REQUIRED]; + + // Optional. The schema the processor version will be trained with. + DocumentSchema document_schema = 10 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The input data used to train the `ProcessorVersion`. + InputData input_data = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The processor version to use as a base for training. This + // processor version must be a child of `parent`. Format: + // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + string base_processor_version = 8 [(google.api.field_behavior) = OPTIONAL]; +} + +// The response for the TrainProcessorVersion method. +message TrainProcessorVersionResponse { + // The resource name of the processor version produced by training. + string processor_version = 1; +} + +// The metadata that represents a processor version being created. +message TrainProcessorVersionMetadata { + // The dataset validation information. + // This includes any and all errors with documents and the dataset. + message DatasetValidation { + // The total number of document errors. + int32 document_error_count = 3; + + // The total number of dataset errors. + int32 dataset_error_count = 4; + + // Error information pertaining to specific documents. A maximum of 10 + // document errors will be returned. + // Any document with errors will not be used throughout training. + repeated google.rpc.Status document_errors = 1; + + // Error information for the dataset as a whole. A maximum of 10 dataset + // errors will be returned. + // A single dataset error is terminal for training. + repeated google.rpc.Status dataset_errors = 2; + } + + // The basic metadata of the long running operation. + CommonOperationMetadata common_metadata = 1; + + // The training dataset validation information. + DatasetValidation training_dataset_validation = 2; + + // The test dataset validation information. + DatasetValidation test_dataset_validation = 3; +} + // Request message for review document method. message ReviewDocumentRequest { // The priority level of the human review task. @@ -787,8 +936,8 @@ message ReviewDocumentRequest { Document inline_document = 4; } - // Required. The resource name of the HumanReviewConfig that the document will be - // reviewed with. + // Required. The resource name of the HumanReviewConfig that the document will + // be reviewed with. string human_review_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -876,3 +1025,80 @@ message ReviewDocumentOperationMetadata { // The Crowd Compute question ID. string question_id = 6; } + +// Evaluates the given ProcessorVersion against the supplied documents. +message EvaluateProcessorVersionRequest { + // Required. The resource name of the + // [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to + // evaluate. + // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + string processor_version = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "documentai.googleapis.com/ProcessorVersion" + } + ]; + + // Optional. The documents used in the evaluation. If unspecified, use the + // processor's dataset as evaluation input. + BatchDocumentsInputConfig evaluation_documents = 3 + [(google.api.field_behavior) = OPTIONAL]; +} + +// Metadata of the EvaluateProcessorVersion method. +message EvaluateProcessorVersionMetadata { + // The basic metadata of the long running operation. + CommonOperationMetadata common_metadata = 1; +} + +// Metadata of the EvaluateProcessorVersion method. +message EvaluateProcessorVersionResponse { + // The resource name of the created evaluation. + string evaluation = 2; +} + +// Retrieves a specific Evaluation. +message GetEvaluationRequest { + // Required. The resource name of the + // [Evaluation][google.cloud.documentai.v1beta3.Evaluation] to get. + // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "documentai.googleapis.com/Evaluation" + } + ]; +} + +// Retrieves a list of evaluations for a given ProcessorVersion. +message ListEvaluationsRequest { + // Required. The resource name of the + // [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to + // list evaluations for. + // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "documentai.googleapis.com/ProcessorVersion" + } + ]; + + // The standard list page size. + // If unspecified, at most 5 evaluations will be returned. + // The maximum value is 100; values above 100 will be coerced to 100. + int32 page_size = 2; + + // A page token, received from a previous `ListEvaluations` call. + // Provide this to retrieve the subsequent page. + string page_token = 3; +} + +// The response from ListEvaluations. +message ListEvaluationsResponse { + // The evaluations requested. + repeated Evaluation evaluations = 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/google/cloud/documentai/v1beta3/document_schema.proto b/google/cloud/documentai/v1beta3/document_schema.proto index 214e56864..5a470dfa1 100644 --- a/google/cloud/documentai/v1beta3/document_schema.proto +++ b/google/cloud/documentai/v1beta3/document_schema.proto @@ -86,15 +86,16 @@ message DocumentSchema { // Name of the type. It must be unique within the schema file and // cannot be a 'Common Type'. Besides that we use the following naming // conventions: - // - *use snake_casing* - // - name matching is case-insensitive + // + // - *use `snake_casing`* + // - name matching is case-sensitive // - Maximum 64 characters. // - Must start with a letter. // - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward // compatibility internal infrastructure and tooling can handle any ascii // character) - // - The '/' is sometimes used to denote a property of a type. For example - // line_item/amount. This convention is deprecated, but will still be + // - The `/` is sometimes used to denote a property of a type. For example + // `line_item/amount`. This convention is deprecated, but will still be // honored for backward compatibility. string name = 1; diff --git a/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml b/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml index d38e3cda8..32b9c1c4c 100644 --- a/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml +++ b/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml @@ -19,10 +19,14 @@ types: - name: google.cloud.documentai.v1beta3.DisableProcessorResponse - name: google.cloud.documentai.v1beta3.EnableProcessorMetadata - name: google.cloud.documentai.v1beta3.EnableProcessorResponse +- name: google.cloud.documentai.v1beta3.EvaluateProcessorVersionMetadata +- name: google.cloud.documentai.v1beta3.EvaluateProcessorVersionResponse - name: google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata - name: google.cloud.documentai.v1beta3.ReviewDocumentResponse - name: google.cloud.documentai.v1beta3.SetDefaultProcessorVersionMetadata - name: google.cloud.documentai.v1beta3.SetDefaultProcessorVersionResponse +- name: google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata +- name: google.cloud.documentai.v1beta3.TrainProcessorVersionResponse - name: google.cloud.documentai.v1beta3.UndeployProcessorVersionMetadata - name: google.cloud.documentai.v1beta3.UndeployProcessorVersionResponse diff --git a/google/cloud/documentai/v1beta3/evaluation.proto b/google/cloud/documentai/v1beta3/evaluation.proto new file mode 100644 index 000000000..c6aa30e7a --- /dev/null +++ b/google/cloud/documentai/v1beta3/evaluation.proto @@ -0,0 +1,164 @@ +// 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.documentai.v1beta3; + +import "google/api/resource.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.DocumentAI.V1Beta3"; +option go_package = "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3;documentai"; +option java_multiple_files = true; +option java_outer_classname = "DocumentAiEvaluation"; +option java_package = "com.google.cloud.documentai.v1beta3"; +option php_namespace = "Google\\Cloud\\DocumentAI\\V1beta3"; +option ruby_package = "Google::Cloud::DocumentAI::V1beta3"; + +// An evaluation of a ProcessorVersion's performance. +message Evaluation { + option (google.api.resource) = { + type: "documentai.googleapis.com/Evaluation" + pattern: "projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}" + }; + + // Evaluation counters for the documents that were used. + message Counters { + // How many documents were sent for evaluation. + int32 input_documents_count = 1; + + // How many documents were not included in the evaluation as they didn't + // pass validation. + int32 invalid_documents_count = 2; + + // How many documents were not included in the evaluation as Document AI + // failed to process them. + int32 failed_documents_count = 3; + + // How many documents were used in the evaluation. + int32 evaluated_documents_count = 4; + } + + // Evaluation metrics, either in aggregate or about a specific entity. + message Metrics { + // The calculated precision. + float precision = 1; + + // The calculated recall. + float recall = 2; + + // The calculated f1 score. + float f1_score = 3; + + // The amount of occurrences in predicted documents. + int32 predicted_occurrences_count = 4; + + // The amount of occurrences in ground truth documents. + int32 ground_truth_occurrences_count = 5; + + // The amount of documents with a predicted occurrence. + int32 predicted_document_count = 10; + + // The amount of documents with a ground truth occurrence. + int32 ground_truth_document_count = 11; + + // The amount of true positives. + int32 true_positives_count = 6; + + // The amount of false positives. + int32 false_positives_count = 7; + + // The amount of false negatives. + int32 false_negatives_count = 8; + + // The amount of documents that had an occurrence of this label. + int32 total_documents_count = 9; + } + + // Evaluations metrics, at a specific confidence level. + message ConfidenceLevelMetrics { + // The confidence level. + float confidence_level = 1; + + // The metrics at the specific confidence level. + Metrics metrics = 2; + } + + // Metrics across multiple confidence levels. + message MultiConfidenceMetrics { + // A type that determines how metrics should be interpreted. + enum MetricsType { + // The metrics type is unspecified. By default, metrics without a + // particular specification are for leaf entity types (i.e., top-level + // entity types without child types, or child types which are not + // parent types themselves). + METRICS_TYPE_UNSPECIFIED = 0; + + // Indicates whether metrics for this particular label type represent an + // aggregate of metrics for other types instead of being based on actual + // TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf) + // entity types are an aggregate of metrics for their children. + AGGREGATE = 1; + } + + // Metrics across confidence levels with fuzzy matching enabled. + repeated ConfidenceLevelMetrics confidence_level_metrics = 1; + + // Metrics across confidence levels with only exact matching. + repeated ConfidenceLevelMetrics confidence_level_metrics_exact = 4; + + // The calculated area under the precision recall curve (AUPRC), computed by + // integrating over all confidence thresholds. + float auprc = 2; + + // The Estimated Calibration Error (ECE) of the confidence of the predicted + // entities. + float estimated_calibration_error = 3; + + // The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching + // only. + float auprc_exact = 5; + + // The ECE for the predicted entities with fuzzy matching disabled, i.e., + // exact matching only. + float estimated_calibration_error_exact = 6; + + // The metrics type for the label. + MetricsType metrics_type = 7; + } + + // The resource name of the evaluation. + // Format: + // `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + string name = 1; + + // The time that the evaluation was created. + google.protobuf.Timestamp create_time = 2; + + // Counters for the documents used in the evaluation. + Counters document_counters = 5; + + // Metrics for all the entities in aggregate. + MultiConfidenceMetrics all_entities_metrics = 3; + + // Metrics across confidence levels, for different entities. + map entity_metrics = 4; + + // The KMS key name used for encryption. + string kms_key_name = 6; + + // The KMS key version with which data is encrypted. + string kms_key_version_name = 7; +} diff --git a/google/cloud/documentai/v1beta3/processor.proto b/google/cloud/documentai/v1beta3/processor.proto index b7019bf4d..970e2b979 100644 --- a/google/cloud/documentai/v1beta3/processor.proto +++ b/google/cloud/documentai/v1beta3/processor.proto @@ -18,6 +18,7 @@ package google.cloud.documentai.v1beta3; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; +import "google/cloud/documentai/v1beta3/document_schema.proto"; import "google/protobuf/timestamp.proto"; option csharp_namespace = "Google.Cloud.DocumentAI.V1Beta3"; @@ -45,9 +46,10 @@ message ProcessorVersion { google.protobuf.Timestamp deprecation_time = 1; // If set, the processor version that will be used as a replacement. - string replacement_processor_version = 2 [(google.api.resource_reference) = { - type: "documentai.googleapis.com/ProcessorVersion" - }]; + string replacement_processor_version = 2 + [(google.api.resource_reference) = { + type: "documentai.googleapis.com/ProcessorVersion" + }]; } // The possible states of the processor version. @@ -85,6 +87,9 @@ message ProcessorVersion { // The display name of the processor version. string display_name = 2; + // The schema of the processor version. Describes the output. + DocumentSchema document_schema = 12; + // The state of the processor version. State state = 6; @@ -125,14 +130,14 @@ message Processor { // The processor is disabled. DISABLED = 2; - // The processor is being enabled, will become ENABLED if successful. + // The processor is being enabled, will become `ENABLED` if successful. ENABLING = 3; - // The processor is being disabled, will become DISABLED if successful. + // The processor is being disabled, will become `DISABLED` if successful. DISABLING = 4; - // The processor is being created, will become either ENABLED (for - // successful creation) or FAILED (for failed ones). + // The processor is being created, will become either `ENABLED` (for + // successful creation) or `FAILED` (for failed ones). // Once a processor is in this state, it can then be used for document // processing, but the feature dependencies of the processor might not be // fully created yet. @@ -154,7 +159,7 @@ message Processor { (google.api.field_behavior) = OUTPUT_ONLY ]; - // The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. + // The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. // To get a list of processors types, see // [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes]. string type = 2; @@ -167,10 +172,11 @@ message Processor { // The default processor version. string default_processor_version = 9 [(google.api.resource_reference) = { - type: "documentai.googleapis.com/ProcessorVersion" - }]; + type: "documentai.googleapis.com/ProcessorVersion" + }]; - // Output only. Immutable. The http endpoint that can be called to invoke processing. + // Output only. Immutable. The http endpoint that can be called to invoke + // processing. string process_endpoint = 6 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.field_behavior) = IMMUTABLE diff --git a/google/cloud/documentai/v1beta3/processor_type.proto b/google/cloud/documentai/v1beta3/processor_type.proto index a2799e301..1d9f6fa3a 100644 --- a/google/cloud/documentai/v1beta3/processor_type.proto +++ b/google/cloud/documentai/v1beta3/processor_type.proto @@ -42,10 +42,10 @@ message ProcessorType { } // The resource name of the processor type. - // Format: projects/{project}/processorTypes/{processor_type} + // Format: `projects/{project}/processorTypes/{processor_type}` string name = 1; - // The type of the processor, e.g., "invoice_parsing". + // The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. string type = 2; // The processor category, used by UI to group processor types. @@ -60,4 +60,7 @@ message ProcessorType { // Launch stage of the processor type google.api.LaunchStage launch_stage = 8; + + // A set of Cloud Storage URIs of sample documents for this processor. + repeated string sample_document_uris = 9; } diff --git a/google/cloud/domains/v1/BUILD.bazel b/google/cloud/domains/v1/BUILD.bazel index 92ac5e3e9..2d93f085e 100644 --- a/google/cloud/domains/v1/BUILD.bazel +++ b/google/cloud/domains/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":domains_proto_with_info"], gapic_yaml = None, grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1.yaml", test_deps = [ ":domains_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "domains_grpc_service_config.json", importpath = "cloud.google.com/go/domains/apiv1;domains", metadata = True, + rest_numeric_enums = True, service_yaml = "domains_v1.yaml", transport = "grpc+rest", deps = [ ":domains_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -178,6 +180,7 @@ py_gapic_library( name = "domains_py_gapic", srcs = [":domains_proto"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -225,7 +228,9 @@ php_gapic_library( name = "domains_php_gapic", srcs = [":domains_proto_with_info"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1.yaml", + transport = "grpc+rest", deps = [ ":domains_php_grpc", ":domains_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "domains_grpc_service_config.json", package = "google.cloud.domains.v1", + rest_numeric_enums = True, service_yaml = "domains_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/domains", ], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Domains API provides registration, management and configuration of domain names.", ruby_cloud_title = "Cloud Domains V1", deps = [ @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":domains_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1.yaml", deps = [ ":domains_csharp_grpc", diff --git a/google/cloud/domains/v1alpha2/BUILD.bazel b/google/cloud/domains/v1alpha2/BUILD.bazel index 9281a7eae..37175572a 100644 --- a/google/cloud/domains/v1alpha2/BUILD.bazel +++ b/google/cloud/domains/v1alpha2/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":domains_proto_with_info"], gapic_yaml = None, grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1alpha2.yaml", test_deps = [ ":domains_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "domains_grpc_service_config.json", importpath = "cloud.google.com/go/domains/apiv1alpha2;domains", metadata = True, + rest_numeric_enums = True, service_yaml = "domains_v1alpha2.yaml", transport = "grpc+rest", deps = [ ":domains_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -178,6 +180,7 @@ py_gapic_library( name = "domains_py_gapic", srcs = [":domains_proto"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -225,7 +228,9 @@ php_gapic_library( name = "domains_php_gapic", srcs = [":domains_proto_with_info"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1alpha2.yaml", + transport = "grpc+rest", deps = [ ":domains_php_grpc", ":domains_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "domains_grpc_service_config.json", package = "google.cloud.domains.v1alpha2", + rest_numeric_enums = True, service_yaml = "domains_v1alpha2.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/domains", ], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Domains API provides registration, management and configuration of domain names.", ruby_cloud_title = "Cloud Domains V1alpha2", deps = [ @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":domains_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1alpha2.yaml", deps = [ ":domains_csharp_grpc", diff --git a/google/cloud/domains/v1beta1/BUILD.bazel b/google/cloud/domains/v1beta1/BUILD.bazel index af58f8dd3..b822ddcae 100644 --- a/google/cloud/domains/v1beta1/BUILD.bazel +++ b/google/cloud/domains/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":domains_proto_with_info"], gapic_yaml = None, grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1beta1.yaml", test_deps = [ ":domains_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "domains_grpc_service_config.json", importpath = "cloud.google.com/go/domains/apiv1beta1;domains", metadata = True, + rest_numeric_enums = True, service_yaml = "domains_v1beta1.yaml", transport = "grpc+rest", deps = [ ":domains_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -178,6 +180,7 @@ py_gapic_library( name = "domains_py_gapic", srcs = [":domains_proto"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -225,7 +228,9 @@ php_gapic_library( name = "domains_php_gapic", srcs = [":domains_proto_with_info"], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":domains_php_grpc", ":domains_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "domains_grpc_service_config.json", package = "google.cloud.domains.v1beta1", + rest_numeric_enums = True, service_yaml = "domains_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/domains", ], grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Domains API provides registration, management and configuration of domain names.", ruby_cloud_title = "Cloud Domains V1beta1", deps = [ @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":domains_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "domains_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "domains_v1beta1.yaml", deps = [ ":domains_csharp_grpc", diff --git a/google/cloud/edgecontainer/v1/BUILD.bazel b/google/cloud/edgecontainer/v1/BUILD.bazel index ead93b6d4..9d51dc7dc 100644 --- a/google/cloud/edgecontainer/v1/BUILD.bazel +++ b/google/cloud/edgecontainer/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":edgecontainer_proto_with_info"], gapic_yaml = None, grpc_service_config = "edgecontainer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = None, test_deps = [ ":edgecontainer_java_grpc", @@ -134,13 +135,14 @@ go_gapic_library( grpc_service_config = "edgecontainer_grpc_service_config.json", importpath = "cloud.google.com/go/edgecontainer/apiv1;edgecontainer", metadata = True, + rest_numeric_enums = True, service_yaml = None, transport = "grpc+rest", deps = [ ":edgecontainer_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -176,6 +178,7 @@ py_gapic_library( name = "edgecontainer_py_gapic", srcs = [":edgecontainer_proto"], grpc_service_config = "edgecontainer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = None, transport = "grpc", deps = [ @@ -226,7 +229,9 @@ php_gapic_library( name = "edgecontainer_php_gapic", srcs = [":edgecontainer_proto_with_info"], grpc_service_config = "edgecontainer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = None, + transport = "grpc+rest", deps = [ ":edgecontainer_php_grpc", ":edgecontainer_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "edgecontainer_grpc_service_config.json", package = "google.cloud.edgecontainer.v1", + rest_numeric_enums = True, service_yaml = None, + transport = "grpc+rest", deps = [], ) @@ -298,6 +305,7 @@ ruby_cloud_gapic_library( srcs = [":edgecontainer_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-edgecontainer-v1"], grpc_service_config = "edgecontainer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = None, deps = [ ":edgecontainer_ruby_grpc", @@ -342,6 +350,7 @@ csharp_gapic_library( srcs = [":edgecontainer_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "edgecontainer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = None, deps = [ ":edgecontainer_csharp_grpc", diff --git a/google/cloud/edgecontainer/v1/edgecontainer_grpc_service_config.json b/google/cloud/edgecontainer/v1/edgecontainer_grpc_service_config.json index 6a702f359..63a6cde7c 100644 --- a/google/cloud/edgecontainer/v1/edgecontainer_grpc_service_config.json +++ b/google/cloud/edgecontainer/v1/edgecontainer_grpc_service_config.json @@ -9,6 +9,7 @@ { "service": "google.cloud.edgecontainer.v1.EdgeContainer", "method": "GetVpnConnection" }, { "service": "google.cloud.edgecontainer.v1.EdgeContainer", "method": "ListMachines" }, { "service": "google.cloud.edgecontainer.v1.EdgeContainer", "method": "GetMachine" } + ], "timeout": "60s", "retryPolicy": { diff --git a/google/cloud/edgecontainer/v1/resources.proto b/google/cloud/edgecontainer/v1/resources.proto index 74560de25..093e55bc5 100644 --- a/google/cloud/edgecontainer/v1/resources.proto +++ b/google/cloud/edgecontainer/v1/resources.proto @@ -97,13 +97,6 @@ message Cluster { // Optional. Cluster-wide maintenance policy configuration. MaintenancePolicy maintenance_policy = 12 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The control plane release version - string control_plane_version = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The lowest release version among all worker nodes. This field can be empty - // if the cluster does not have any worker nodes. - string node_version = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Cluster-wide networking configuration. @@ -226,9 +219,6 @@ message NodePool { // Optional. Local disk encryption options. This field is only used when enabling CMEK // support. LocalDiskEncryption local_disk_encryption = 9 [(google.api.field_behavior) = OPTIONAL]; - - // Output only. The lowest release version among all worker nodes. - string node_version = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; } // A Google Distributed Cloud Edge machine capable of acting as a Kubernetes @@ -265,8 +255,9 @@ message Machine { // The Google Distributed Cloud Edge zone of this machine. string zone = 6; - // Output only. The software version of the machine. - string version = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Whether the machine is disabled. If disabled, the machine is unable to + // enter service. + bool disabled = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } // A VPN connection . @@ -282,12 +273,13 @@ message VpnConnection { // the cluster project. string project_id = 1; - // The service account in the VPC project configured by user. It is used to + // Optional. The service account in the VPC project configured by user. It is used to // create/delete Cloud Router and Cloud HA VPNs for VPN connection. If this // SA is changed during/after a VPN connection is created, you need to - // remove the Cloud Router and Cloud VPN resources in |project_id|. Must be - // set if |project_id| is set. - string service_account = 2; + // remove the Cloud Router and Cloud VPN resources in |project_id|. + // It is in the form of + // service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com. + string service_account = 2 [(google.api.field_behavior) = OPTIONAL]; } // The created connection details. @@ -378,9 +370,9 @@ message VpnConnection { // The network ID of VPC to connect to. string vpc = 8; - // Project detail of the VPC network. Required if VPC is in a different + // Optional. Project detail of the VPC network. Required if VPC is in a different // project than the cluster project. - VpcProject vpc_project = 11; + VpcProject vpc_project = 11 [(google.api.field_behavior) = OPTIONAL]; // Whether this VPN connection has HA enabled on cluster side. If enabled, // when creating VPN connection we will attempt to use 2 ANG floating IPs. diff --git a/google/cloud/enterpriseknowledgegraph/v1/BUILD.bazel b/google/cloud/enterpriseknowledgegraph/v1/BUILD.bazel index 0b95f51fc..a01d98fcb 100644 --- a/google/cloud/enterpriseknowledgegraph/v1/BUILD.bazel +++ b/google/cloud/enterpriseknowledgegraph/v1/BUILD.bazel @@ -17,15 +17,27 @@ load( "@com_google_googleapis_imports//:imports.bzl", "cc_grpc_library", "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", "java_gapic_assembly_gradle_pkg", "java_gapic_library", "java_gapic_test", "java_grpc_library", "java_proto_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", "proto_library_with_info", "py_gapic_assembly_pkg", "py_gapic_library", "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", ) # This is an API workspace, having public visibility by default makes perfect sense. @@ -45,7 +57,9 @@ proto_library( "//google/api:resource_proto", "//google/rpc:status_proto", "@com_google_protobuf//:empty_proto", + "@com_google_protobuf//:struct_proto", "@com_google_protobuf//:timestamp_proto", + "@com_google_protobuf//:wrappers_proto", ], ) @@ -75,6 +89,7 @@ java_gapic_library( srcs = [":enterpriseknowledgegraph_proto_with_info"], gapic_yaml = None, grpc_service_config = "enterpriseknowledgegraph_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "enterpriseknowledgegraph_v1.yaml", test_deps = [ ":enterpriseknowledgegraph_java_grpc", @@ -114,6 +129,7 @@ py_gapic_library( ":enterpriseknowledgegraph_proto", ], grpc_service_config = "enterpriseknowledgegraph_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "enterpriseknowledgegraph_v1.yaml", transport = "grpc+rest", deps = [ @@ -151,3 +167,117 @@ cc_grpc_library( grpc_only = True, deps = [":enterpriseknowledgegraph_cc_proto"], ) + +############################################################################## +# PHP +############################################################################## + +php_proto_library( + name = "enterpriseknowledgegraph_php_proto", + deps = [":enterpriseknowledgegraph_proto"], +) + +php_grpc_library( + name = "enterpriseknowledgegraph_php_grpc", + srcs = [":enterpriseknowledgegraph_proto"], + deps = [":enterpriseknowledgegraph_php_proto"], +) + +php_gapic_library( + name = "enterpriseknowledgegraph_php_gapic", + srcs = [":enterpriseknowledgegraph_proto_with_info"], + grpc_service_config = "enterpriseknowledgegraph_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "enterpriseknowledgegraph_v1.yaml", + transport = "grpc+rest", + deps = [ + ":enterpriseknowledgegraph_php_grpc", + ":enterpriseknowledgegraph_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-enterpriseknowledgegraph-v1-php", + deps = [ + ":enterpriseknowledgegraph_php_gapic", + ":enterpriseknowledgegraph_php_grpc", + ":enterpriseknowledgegraph_php_proto", + ], +) + +############################################################################## +# Ruby +############################################################################## +ruby_proto_library( + name = "enterpriseknowledgegraph_ruby_proto", + deps = [":enterpriseknowledgegraph_proto"], +) + +ruby_grpc_library( + name = "enterpriseknowledgegraph_ruby_grpc", + srcs = [":enterpriseknowledgegraph_proto"], + deps = [":enterpriseknowledgegraph_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "enterpriseknowledgegraph_ruby_gapic", + srcs = [":enterpriseknowledgegraph_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-enterpriseknowledgegraph-v1", + ], + grpc_service_config = "enterpriseknowledgegraph_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "enterpriseknowledgegraph_v1.yaml", + deps = [ + ":enterpriseknowledgegraph_ruby_grpc", + ":enterpriseknowledgegraph_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-enterpriseknowledgegraph-v1-ruby", + deps = [ + ":enterpriseknowledgegraph_ruby_gapic", + ":enterpriseknowledgegraph_ruby_grpc", + ":enterpriseknowledgegraph_ruby_proto", + ], +) + +############################################################################## +# C# +############################################################################## +csharp_proto_library( + name = "enterpriseknowledgegraph_csharp_proto", + deps = [":enterpriseknowledgegraph_proto"], +) + +csharp_grpc_library( + name = "enterpriseknowledgegraph_csharp_grpc", + srcs = [":enterpriseknowledgegraph_proto"], + deps = [":enterpriseknowledgegraph_csharp_proto"], +) + +csharp_gapic_library( + name = "enterpriseknowledgegraph_csharp_gapic", + srcs = [":enterpriseknowledgegraph_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "enterpriseknowledgegraph_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "enterpriseknowledgegraph_v1.yaml", + deps = [ + ":enterpriseknowledgegraph_csharp_grpc", + ":enterpriseknowledgegraph_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-enterpriseknowledgegraph-v1-csharp", + deps = [ + ":enterpriseknowledgegraph_csharp_gapic", + ":enterpriseknowledgegraph_csharp_grpc", + ":enterpriseknowledgegraph_csharp_proto", + ], +) diff --git a/google/cloud/enterpriseknowledgegraph/v1/job_state.proto b/google/cloud/enterpriseknowledgegraph/v1/job_state.proto index b4ee4b750..7893ecfe2 100644 --- a/google/cloud/enterpriseknowledgegraph/v1/job_state.proto +++ b/google/cloud/enterpriseknowledgegraph/v1/job_state.proto @@ -20,6 +20,9 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/enterpriseknowl option java_multiple_files = true; option java_outer_classname = "JobStateProto"; option java_package = "com.google.cloud.enterpriseknowledgegraph.v1"; +option php_namespace = "Google\\Cloud\\EnterpriseKnowledgeGraph\\V1"; +option ruby_package = "Google::Cloud::EnterpriseKnowledgeGraph::V1"; +option csharp_namespace = "Google.Cloud.EnterpriseKnowledgeGraph.V1"; // Describes the state of a job. enum JobState { diff --git a/google/cloud/enterpriseknowledgegraph/v1/operation_metadata.proto b/google/cloud/enterpriseknowledgegraph/v1/operation_metadata.proto index 8e57a2a96..6e1230423 100644 --- a/google/cloud/enterpriseknowledgegraph/v1/operation_metadata.proto +++ b/google/cloud/enterpriseknowledgegraph/v1/operation_metadata.proto @@ -22,6 +22,9 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/enterpriseknowl option java_multiple_files = true; option java_outer_classname = "OperationMetadataProto"; option java_package = "com.google.cloud.enterpriseknowledgegraph.v1"; +option php_namespace = "Google\\Cloud\\EnterpriseKnowledgeGraph\\V1"; +option ruby_package = "Google::Cloud::EnterpriseKnowledgeGraph::V1"; +option csharp_namespace = "Google.Cloud.EnterpriseKnowledgeGraph.V1"; // The common metadata for long running operations. message CommonOperationMetadata { diff --git a/google/cloud/enterpriseknowledgegraph/v1/service.proto b/google/cloud/enterpriseknowledgegraph/v1/service.proto index 8ab1ae4c6..74bb53e9c 100644 --- a/google/cloud/enterpriseknowledgegraph/v1/service.proto +++ b/google/cloud/enterpriseknowledgegraph/v1/service.proto @@ -23,13 +23,18 @@ import "google/api/resource.proto"; import "google/cloud/enterpriseknowledgegraph/v1/job_state.proto"; import "google/cloud/enterpriseknowledgegraph/v1/operation_metadata.proto"; import "google/protobuf/empty.proto"; +import "google/protobuf/struct.proto"; import "google/protobuf/timestamp.proto"; +import "google/protobuf/wrappers.proto"; import "google/rpc/status.proto"; +option csharp_namespace = "Google.Cloud.EnterpriseKnowledgeGraph.V1"; option go_package = "google.golang.org/genproto/googleapis/cloud/enterpriseknowledgegraph/v1;enterpriseknowledgegraph"; option java_multiple_files = true; option java_outer_classname = "ServiceProto"; option java_package = "com.google.cloud.enterpriseknowledgegraph.v1"; +option php_namespace = "Google\\Cloud\\EnterpriseKnowledgeGraph\\V1"; +option ruby_package = "Google::Cloud::EnterpriseKnowledgeGraph::V1"; option (google.api.resource_definition) = { type: "bigquery.googleapis.com/Dataset" pattern: "projects/{project}/datasets/{dataset}" @@ -39,8 +44,12 @@ option (google.api.resource_definition) = { pattern: "projects/{project}/datasets/{dataset}/tables/{table}" }; option (google.api.resource_definition) = { - type: "enterpriseknowledgegraph.googleapis.com/Location" - pattern: "projects/{project}/locations/{location}" + type: "enterpriseknowledgegraph.googleapis.com/CloudKnowledgeGraphEntity" + pattern: "projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}" +}; +option (google.api.resource_definition) = { + type: "enterpriseknowledgegraph.googleapis.com/PublicKnowledgeGraphEntity" + pattern: "projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}" }; // APIs for enterprise knowledge graph product. @@ -99,6 +108,38 @@ service EnterpriseKnowledgeGraphService { }; option (google.api.method_signature) = "name"; } + + // Finds the Cloud KG entities with CKG ID(s). + rpc Lookup(LookupRequest) returns (LookupResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/cloudKnowledgeGraphEntities:Lookup" + }; + option (google.api.method_signature) = "parent,ids"; + } + + // Searches the Cloud KG entities with entity name. + rpc Search(SearchRequest) returns (SearchResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/cloudKnowledgeGraphEntities:Search" + }; + option (google.api.method_signature) = "parent,query"; + } + + // Finds the public KG entities with public KG ID(s). + rpc LookupPublicKg(LookupPublicKgRequest) returns (LookupPublicKgResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/publicKnowledgeGraphEntities:Lookup" + }; + option (google.api.method_signature) = "parent,ids"; + } + + // Searches the public KG entities with entity name. + rpc SearchPublicKg(SearchPublicKgRequest) returns (SearchPublicKgResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/publicKnowledgeGraphEntities:Search" + }; + option (google.api.method_signature) = "parent,query"; + } } // The desired input location and metadata. @@ -140,7 +181,7 @@ message InputConfig { // Optional. Provide the bigquery table containing the previous results if // cluster ID stability is desired. Format is - // “projects/*/datasets/*/tables/*". + // `projects/*/datasets/*/tables/*`. string previous_result_bigquery_table = 3 [ (google.api.field_behavior) = OPTIONAL, (google.api.resource_reference) = { type: "bigquery.googleapis.com/Table" } @@ -149,7 +190,7 @@ message InputConfig { // The input config for BigQuery tables. message BigQueryInputConfig { - // Required. Format is “projects/*/datasets/*/tables/*”. + // Required. Format is `projects/*/datasets/*/tables/*`. string bigquery_table = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "bigquery.googleapis.com/Table" } @@ -173,9 +214,10 @@ message ReconConfig { message Options { // If true, separate clusters by their geographic region (from geocoding). // Uses the following entity features: - // - schema.org/addressLocality - // - schema.org/addressRegion - // - schema.org/addressCountry + // + // - schema.org/addressLocality + // - schema.org/addressRegion + // - schema.org/addressCountry // Warning: processing will no longer be regionalized! bool enable_geocoding_separation = 100; } @@ -233,7 +275,7 @@ message CreateEntityReconciliationJobRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "enterpriseknowledgegraph.googleapis.com/Location" + child_type: "enterpriseknowledgegraph.googleapis.com/EntityReconciliationJob" } ]; @@ -263,7 +305,7 @@ message ListEntityReconciliationJobsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "enterpriseknowledgegraph.googleapis.com/Location" + child_type: "enterpriseknowledgegraph.googleapis.com/EntityReconciliationJob" } ]; @@ -356,3 +398,159 @@ message EntityReconciliationJob { // Optional. Recon configs to adjust the clustering behavior. ReconConfig recon_config = 9 [(google.api.field_behavior) = OPTIONAL]; } + +// Request message for +// [EnterpriseKnowledgeGraphService.Lookup][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Lookup]. +message LookupRequest { + // Required. The name of the Entity's parent resource. + // Format: + // `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "enterpriseknowledgegraph.googleapis.com/CloudKnowledgeGraphEntity" + } + ]; + + // Required. The list of entity ids to be used for lookup. + repeated string ids = 2 [(google.api.field_behavior) = REQUIRED]; + + // The list of language codes (defined in ISO 693) to run the query with, + // e.g. 'en'. + repeated string languages = 3; +} + +// Response message for +// [EnterpriseKnowledgeGraphService.Lookup][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Lookup]. +message LookupResponse { + // The local context applicable for the response. See more details at + // http://www.w3.org/TR/json-ld/#context-definitions. + google.protobuf.Value context = 1; + + // The schema type of top-level JSON-LD object, e.g. ItemList. + google.protobuf.Value type = 2; + + // The item list of search results. + google.protobuf.ListValue item_list_element = 3; +} + +// Request message for +// [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search]. +message SearchRequest { + // Required. The name of the Entity's parent resource. + // Format: + // `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "enterpriseknowledgegraph.googleapis.com/CloudKnowledgeGraphEntity" + } + ]; + + // Required. The literal query string for search. + string query = 2 [(google.api.field_behavior) = REQUIRED]; + + // The list of language codes (defined in ISO 693) to run the query with, + // e.g. 'en'. + repeated string languages = 3; + + // Restricts returned entities with these types, e.g. Person + // (as defined in http://schema.org/Person). If multiple types are specified, + // returned entities will contain one or more of these types. + repeated string types = 4; + + // Limits the number of entities to be returned. + google.protobuf.Int32Value limit = 6; +} + +// Response message for +// [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search]. +message SearchResponse { + // The local context applicable for the response. See more details at + // http://www.w3.org/TR/json-ld/#context-definitions. + google.protobuf.Value context = 1; + + // The schema type of top-level JSON-LD object, e.g. ItemList. + google.protobuf.Value type = 2; + + // The item list of search results. + google.protobuf.ListValue item_list_element = 3; +} + +// Request message for +// [EnterpriseKnowledgeGraphService.LookupPublicKg][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.LookupPublicKg]. +message LookupPublicKgRequest { + // Required. The name of the Entity's parent resource. + // Format: + // `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "enterpriseknowledgegraph.googleapis.com/PublicKnowledgeGraphEntity" + } + ]; + + // Required. The list of entity ids to be used for lookup. + repeated string ids = 2 [(google.api.field_behavior) = REQUIRED]; + + // The list of language codes (defined in ISO 693) to run the query with, + // e.g. 'en'. + repeated string languages = 3; +} + +// Response message for +// [EnterpriseKnowledgeGraphService.LookupPublicKg][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.LookupPublicKg]. +message LookupPublicKgResponse { + // The local context applicable for the response. See more details at + // http://www.w3.org/TR/json-ld/#context-definitions. + google.protobuf.Value context = 1; + + // The schema type of top-level JSON-LD object, e.g. ItemList. + google.protobuf.Value type = 2; + + // The item list of search results. + google.protobuf.ListValue item_list_element = 3; +} + +// Request message for +// [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search]. +message SearchPublicKgRequest { + // Required. The name of the Entity's parent resource. + // Format: + // `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "enterpriseknowledgegraph.googleapis.com/PublicKnowledgeGraphEntity" + } + ]; + + // Required. The literal query string for search. + string query = 2 [(google.api.field_behavior) = REQUIRED]; + + // The list of language codes (defined in ISO 693) to run the query with, + // e.g. 'en'. + repeated string languages = 3; + + // Restricts returned entities with these types, e.g. Person + // (as defined in http://schema.org/Person). If multiple types are specified, + // returned entities will contain one or more of these types. + repeated string types = 4; + + // Limits the number of entities to be returned. + google.protobuf.Int32Value limit = 6; +} + +// Response message for +// [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search]. +message SearchPublicKgResponse { + // The local context applicable for the response. See more details at + // http://www.w3.org/TR/json-ld/#context-definitions. + google.protobuf.Value context = 1; + + // The schema type of top-level JSON-LD object, e.g. ItemList. + google.protobuf.Value type = 2; + + // The item list of search results. + google.protobuf.ListValue item_list_element = 3; +} diff --git a/google/cloud/essentialcontacts/v1/BUILD.bazel b/google/cloud/essentialcontacts/v1/BUILD.bazel index 05bf9592d..4998c7941 100644 --- a/google/cloud/essentialcontacts/v1/BUILD.bazel +++ b/google/cloud/essentialcontacts/v1/BUILD.bazel @@ -87,6 +87,7 @@ java_gapic_library( name = "essentialcontacts_java_gapic", srcs = [":essentialcontacts_proto_with_info"], grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":essentialcontacts_java_grpc", ], @@ -134,6 +135,7 @@ go_gapic_library( grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", importpath = "cloud.google.com/go/essentialcontacts/apiv1;essentialcontacts", metadata = True, + rest_numeric_enums = True, service_yaml = "essentialcontacts_v1.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=essential_contacts", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -204,7 +207,9 @@ php_gapic_library( name = "essentialcontacts_php_gapic", srcs = [":essentialcontacts_proto_with_info"], grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "essentialcontacts_v1.yaml", + transport = "grpc+rest", deps = [ ":essentialcontacts_php_grpc", ":essentialcontacts_php_proto", @@ -228,7 +233,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", package = "google.cloud.essentialcontacts.v1", + rest_numeric_enums = True, service_yaml = "essentialcontacts_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -262,6 +269,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=essentialcontacts", ], grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Many Google Cloud services, such as Cloud Billing, send out notifications to share important information with Google Cloud users. By default, these notifications are sent to members with certain Identity and Access Management (IAM) roles. With Essential Contacts, you can customize who receives notifications by providing your own list of contacts.", ruby_cloud_title = "Essential Contacts V1", deps = [ @@ -296,6 +304,7 @@ csharp_gapic_library( srcs = [":essentialcontacts_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "essentialcontacts_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "essentialcontacts_v1.yaml", deps = [ ":essentialcontacts_csharp_grpc", diff --git a/google/cloud/eventarc/publishing/v1/BUILD.bazel b/google/cloud/eventarc/publishing/v1/BUILD.bazel index 3c24600f7..734ef95b1 100644 --- a/google/cloud/eventarc/publishing/v1/BUILD.bazel +++ b/google/cloud/eventarc/publishing/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "publishing_proto", @@ -38,18 +69,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "publishing_java_proto", deps = [":publishing_proto"], @@ -66,6 +85,7 @@ java_gapic_library( srcs = [":publishing_proto_with_info"], gapic_yaml = None, grpc_service_config = "eventarcpublishing_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarcpublishing_v1.yaml", test_deps = [ ":publishing_java_grpc", @@ -99,17 +119,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "publishing_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -124,8 +133,9 @@ go_gapic_library( name = "publishing_go_gapic", srcs = [":publishing_proto_with_info"], grpc_service_config = "eventarcpublishing_grpc_service_config.json", - importpath = "cloud.google.com/go/eventarc/publishing/apiv1;publishing", + importpath = "cloud.google.com/go/eventarc/publishing/apiv1;publisher", metadata = True, + rest_numeric_enums = True, service_yaml = "eventarcpublishing_v1.yaml", transport = "grpc+rest", deps = [ @@ -151,26 +161,20 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "publishing_py_gapic", srcs = [":publishing_proto"], grpc_service_config = "eventarcpublishing_grpc_service_config.json", opt_args = [ - "warehouse-package-name=google-cloud-eventarc-publishing", - "python-gapic-namespace=google.cloud", "python-gapic-name=eventarc_publishing", + "python-gapic-namespace=google.cloud", + "warehouse-package-name=google-cloud-eventarc-publishing", ], + rest_numeric_enums = True, + service_yaml = "eventarcpublishing_v1.yaml", transport = "grpc+rest", + deps = [ + ], ) py_test( @@ -191,17 +195,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "publishing_php_proto", deps = [":publishing_proto"], @@ -217,7 +210,9 @@ php_gapic_library( name = "publishing_php_gapic", srcs = [":publishing_proto_with_info"], grpc_service_config = "eventarcpublishing_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarcpublishing_v1.yaml", + transport = "grpc+rest", deps = [ ":publishing_php_grpc", ":publishing_php_proto", @@ -234,15 +229,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "publishing_nodejs_gapic", package_name = "@google-cloud/eventarc-publishing", @@ -250,7 +236,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "eventarcpublishing_grpc_service_config.json", package = "google.cloud.eventarc.publishing.v1", + rest_numeric_enums = True, service_yaml = "eventarcpublishing_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -262,17 +250,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "publishing_ruby_proto", deps = [":publishing_proto"], @@ -288,15 +265,17 @@ ruby_cloud_gapic_library( name = "publishing_ruby_gapic", srcs = [":publishing_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-eventarc-publishing-v1", - "ruby-cloud-env-prefix=EVENTARC", - "ruby-cloud-product-url=https://cloud.google.com/eventarc/", "ruby-cloud-api-id=eventarcpublishing.googleapis.com", "ruby-cloud-api-shortname=eventarcpublishing", + "ruby-cloud-env-prefix=EVENTARC", + "ruby-cloud-gem-name=google-cloud-eventarc-publishing-v1", + "ruby-cloud-product-url=https://cloud.google.com/eventarc/", ], grpc_service_config = "eventarcpublishing_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Eventarc lets you asynchronously deliver events from Google services, SaaS, and your own apps using loosely coupled services that react to state changes. Eventarc requires no infrastructure management — you can optimize productivity and costs while building a modern, event-driven solution.", ruby_cloud_title = "Eventarc Publishing V1", + service_yaml = "eventarcpublishing_v1.yaml", deps = [ ":publishing_ruby_grpc", ":publishing_ruby_proto", @@ -313,17 +292,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "publishing_csharp_proto", deps = [":publishing_proto"], @@ -340,6 +308,7 @@ csharp_gapic_library( srcs = [":publishing_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "eventarcpublishing_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarcpublishing_v1.yaml", deps = [ ":publishing_csharp_grpc", @@ -357,15 +326,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "publishing_cc_proto", deps = [":publishing_proto"], diff --git a/google/cloud/eventarc/publishing/v1/publisher.proto b/google/cloud/eventarc/publishing/v1/publisher.proto index ce4153bb9..b68f1ece8 100644 --- a/google/cloud/eventarc/publishing/v1/publisher.proto +++ b/google/cloud/eventarc/publishing/v1/publisher.proto @@ -11,7 +11,6 @@ // 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.eventarc.publishing.v1; @@ -54,16 +53,17 @@ option ruby_package = "Google::Cloud::Eventarc::Publishing::V1"; // Publisher allows an event provider to publish events to Eventarc. service Publisher { option (google.api.default_host) = "eventarcpublishing.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"; // Publish events to a ChannelConnection in a partner's project. - rpc PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest) returns (PublishChannelConnectionEventsResponse) { + rpc PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest) + returns (PublishChannelConnectionEventsResponse) { option (google.api.http) = { post: "/v1/{channel_connection=projects/*/locations/*/channelConnections/*}:publishEvents" body: "*" }; } - // Publish events to a subscriber's channel. rpc PublishEvents(PublishEventsRequest) returns (PublishEventsResponse) { option (google.api.http) = { @@ -72,33 +72,37 @@ service Publisher { }; } } - // The request message for the PublishChannelConnectionEvents method. message PublishChannelConnectionEventsRequest { // The channel_connection that the events are published from. For example: // `projects/{partner_project_id}/locations/{location}/channelConnections/{channel_connection_id}`. string channel_connection = 1; - // The CloudEvents v1.0 events to publish. No other types are allowed. + // If this field is set, then the `text_events` fields must not be set. repeated google.protobuf.Any events = 2; + // The text representation of events to publish. + // CloudEvent v1.0 in JSON format is the only allowed type. Refer to + // https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md + // for specification. + // If this field is set, then the `events` fields must not be set. + repeated string text_events = 3; } - // The response message for the PublishChannelConnectionEvents method. -message PublishChannelConnectionEventsResponse { - -} - +message PublishChannelConnectionEventsResponse {} // The request message for the PublishEvents method. message PublishEventsRequest { // The full name of the channel to publish to. For example: // `projects/{project}/locations/{location}/channels/{channel-id}`. string channel = 1; - // The CloudEvents v1.0 events to publish. No other types are allowed. + // If this field is set, then the `text_events` fields must not be set. repeated google.protobuf.Any events = 2; + // The text representation of events to publish. + // CloudEvent v1.0 in JSON format is the only allowed type. Refer to + // https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md + // for specification. + // If this field is set, then the `events` fields must not be set. + repeated string text_events = 3; } - // The response message for the PublishEvents method. -message PublishEventsResponse { - -} +message PublishEventsResponse {} diff --git a/google/cloud/eventarc/v1/BUILD.bazel b/google/cloud/eventarc/v1/BUILD.bazel index 013e885f3..b1594ab89 100644 --- a/google/cloud/eventarc/v1/BUILD.bazel +++ b/google/cloud/eventarc/v1/BUILD.bazel @@ -25,6 +25,7 @@ proto_library( "channel_connection.proto", "discovery.proto", "eventarc.proto", + "google_channel_config.proto", "trigger.proto", ], deps = [ @@ -44,6 +45,8 @@ proto_library_with_info( deps = [ ":eventarc_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", + "//google/iam/v1:iam_policy_proto", ], ) @@ -75,14 +78,19 @@ java_gapic_library( srcs = [":eventarc_proto_with_info"], gapic_yaml = None, grpc_service_config = "eventarc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", test_deps = [ ":eventarc_java_grpc", + "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", ], transport = "grpc+rest", deps = [ ":eventarc_java_proto", "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", ], ) @@ -137,13 +145,16 @@ go_gapic_library( grpc_service_config = "eventarc_grpc_service_config.json", importpath = "cloud.google.com/go/eventarc/apiv1;eventarc", metadata = True, + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", transport = "grpc+rest", deps = [ ":eventarc_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,8 +190,12 @@ py_gapic_library( name = "eventarc_py_gapic", srcs = [":eventarc_proto"], grpc_service_config = "eventarc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", transport = "grpc", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], ) py_test( @@ -227,7 +242,9 @@ php_gapic_library( name = "eventarc_php_gapic", srcs = [":eventarc_proto_with_info"], grpc_service_config = "eventarc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", + transport = "grpc+rest", deps = [ ":eventarc_php_grpc", ":eventarc_php_proto", @@ -260,7 +277,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "eventarc_grpc_service_config.json", package = "google.cloud.eventarc.v1", + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,8 +324,10 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/eventarc/", ], grpc_service_config = "eventarc_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Eventarc lets you asynchronously deliver events from Google services, SaaS, and your own apps using loosely coupled services that react to state changes. Eventarc requires no infrastructure management — you can optimize productivity and costs while building a modern, event-driven solution.", ruby_cloud_title = "Eventarc V1", + service_yaml = "eventarc_v1.yaml", deps = [ ":eventarc_ruby_grpc", ":eventarc_ruby_proto", @@ -350,6 +371,7 @@ csharp_gapic_library( srcs = [":eventarc_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "eventarc_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "eventarc_v1.yaml", deps = [ ":eventarc_csharp_grpc", diff --git a/google/cloud/eventarc/v1/channel.proto b/google/cloud/eventarc/v1/channel.proto index 11627e450..9c5395580 100644 --- a/google/cloud/eventarc/v1/channel.proto +++ b/google/cloud/eventarc/v1/channel.proto @@ -56,40 +56,45 @@ message Channel { // event provider. ACTIVE = 2; - // The INACTIVE state means that the Channel cannot receive events + // The INACTIVE state indicates that the Channel cannot receive events // permanently. There are two possible cases this state can happen: + // // 1. The SaaS provider disconnected from this Channel. // 2. The Channel activation token has expired but the SaaS provider // wasn't connected. + // // To re-establish a Connection with a provider, the subscriber // should create a new Channel and give it to the provider. INACTIVE = 3; } - // Required. The resource name of the channel. Must be unique within the location - // on the project and must be in + // Required. The resource name of the channel. Must be unique within the + // location on the project and must be in // `projects/{project}/locations/{location}/channels/{channel_id}` format. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Output only. Server assigned unique identifier for the channel. The value is a UUID4 - // string and guaranteed to remain unchanged until the resource is deleted. + // Output only. Server assigned unique identifier for the channel. The value + // is a UUID4 string and guaranteed to remain unchanged until the resource is + // deleted. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The creation time. - 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. The last-modified time. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The name of the event provider (e.g. Eventarc SaaS partner) associated + // The name of the event provider (e.g. Eventarc SaaS partner) associated // with the channel. This provider will be granted permissions to publish // events to the channel. Format: // `projects/{project}/locations/{location}/providers/{provider_id}`. - string provider = 7 [(google.api.field_behavior) = REQUIRED]; + string provider = 7; oneof transport { - // Output only. The name of the Pub/Sub topic created and managed by Eventarc system as - // a transport for the event delivery. Format: + // Output only. The name of the Pub/Sub topic created and managed by + // Eventarc system as a transport for the event delivery. Format: // `projects/{project}/topics/{topic_id}`. string pubsub_topic = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -97,7 +102,19 @@ message Channel { // Output only. The state of a Channel. State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The activation token for the channel. The token must be used by the - // provider to register the channel for publishing. + // Output only. The activation token for the channel. The token must be used + // by the provider to register the channel for publishing. string activation_token = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. Resource name of a KMS crypto key (managed by the user) used to + // encrypt/decrypt their event data. + // + // It must match the pattern + // `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + string crypto_key_name = 11 [ + (google.api.field_behavior) = OPTIONAL, + (google.api.resource_reference) = { + type: "cloudkms.googleapis.com/CryptoKey" + } + ]; } diff --git a/google/cloud/eventarc/v1/channel_connection.proto b/google/cloud/eventarc/v1/channel_connection.proto index ae1e0f7de..576b5cc59 100644 --- a/google/cloud/eventarc/v1/channel_connection.proto +++ b/google/cloud/eventarc/v1/channel_connection.proto @@ -59,12 +59,10 @@ message ChannelConnection { ]; // Output only. The creation time. - 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. The last-modified time. - google.protobuf.Timestamp update_time = 7 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Input only. Activation token for the channel. The token will be used // during the creation of ChannelConnection to bind the channel with the diff --git a/google/cloud/eventarc/v1/eventarc.proto b/google/cloud/eventarc/v1/eventarc.proto index 69310678a..44d46fce3 100644 --- a/google/cloud/eventarc/v1/eventarc.proto +++ b/google/cloud/eventarc/v1/eventarc.proto @@ -23,6 +23,7 @@ import "google/api/resource.proto"; import "google/cloud/eventarc/v1/channel.proto"; import "google/cloud/eventarc/v1/channel_connection.proto"; import "google/cloud/eventarc/v1/discovery.proto"; +import "google/cloud/eventarc/v1/google_channel_config.proto"; import "google/cloud/eventarc/v1/trigger.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/field_mask.proto"; @@ -206,6 +207,23 @@ service Eventarc { metadata_type: "OperationMetadata" }; } + + // Get a GoogleChannelConfig + rpc GetGoogleChannelConfig(GetGoogleChannelConfigRequest) returns (GoogleChannelConfig) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/googleChannelConfig}" + }; + option (google.api.method_signature) = "name"; + } + + // Update a single GoogleChannelConfig + rpc UpdateGoogleChannelConfig(UpdateGoogleChannelConfigRequest) returns (GoogleChannelConfig) { + option (google.api.http) = { + patch: "/v1/{google_channel_config.name=projects/*/locations/*/googleChannelConfig}" + body: "google_channel_config" + }; + option (google.api.method_signature) = "google_channel_config,update_mask"; + } } // The request message for the GetTrigger method. @@ -230,6 +248,7 @@ message ListTriggersRequest { ]; // The maximum number of triggers to return on each page. + // // Note: The service may send fewer. int32 page_size = 2; @@ -245,6 +264,11 @@ message ListTriggersRequest { // specify descending order for a field, append a `desc` suffix; for example: // `name desc, trigger_id`. string order_by = 4; + + // Filter field. Used to filter the Triggers to be listed. Possible filters + // are described in https://google.aip.dev/160. For example, using + // "?filter=destination:gke" would list only Triggers with a gke destination. + string filter = 5; } // The response message for the `ListTriggers` method. @@ -252,7 +276,7 @@ message ListTriggersResponse { // The requested triggers, up to the number specified in `page_size`. repeated Trigger triggers = 1; - // A page token that can be sent to ListTriggers to request the next page. + // A page token that can be sent to `ListTriggers` to request the next page. // If this is empty, then there are no more pages. string next_page_token = 2; @@ -345,6 +369,7 @@ message ListChannelsRequest { ]; // The maximum number of channels to return on each page. + // // Note: The service may send fewer. int32 page_size = 2; @@ -367,7 +392,7 @@ message ListChannelsResponse { // The requested channels, up to the number specified in `page_size`. repeated Channel channels = 1; - // A page token that can be sent to ListChannels to request the next page. + // A page token that can be sent to `ListChannels` to request the next page. // If this is empty, then there are no more pages. string next_page_token = 2; @@ -472,7 +497,7 @@ message ListProvidersResponse { // The requested providers, up to the number specified in `page_size`. repeated Provider providers = 1; - // A page token that can be sent to ListProviders to request the next page. + // A page token that can be sent to `ListProviders` to request the next page. // If this is empty, then there are no more pages. string next_page_token = 2; @@ -502,6 +527,7 @@ message ListChannelConnectionsRequest { ]; // The maximum number of channel connections to return on each page. + // // Note: The service may send fewer responses. int32 page_size = 2; @@ -519,7 +545,7 @@ message ListChannelConnectionsResponse { // `page_size`. repeated ChannelConnection channel_connections = 1; - // A page token that can be sent to ListChannelConnections to request the + // A page token that can be sent to `ListChannelConnections` to request the // next page. // If this is empty, then there are no more pages. string next_page_token = 2; @@ -556,6 +582,28 @@ message DeleteChannelConnectionRequest { ]; } +// The request message for the UpdateGoogleChannelConfig method. +message UpdateGoogleChannelConfigRequest { + // Required. The config to be updated. + GoogleChannelConfig google_channel_config = 1 [(google.api.field_behavior) = REQUIRED]; + + // The fields to be updated; only fields explicitly provided are updated. + // If no field mask is provided, all provided fields in the request are + // updated. To update all fields, provide a field mask of "*". + google.protobuf.FieldMask update_mask = 2; +} + +// The request message for the GetGoogleChannelConfig method. +message GetGoogleChannelConfigRequest { + // Required. The name of the config to get. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "eventarc.googleapis.com/GoogleChannelConfig" + } + ]; +} + // Represents the metadata of the long-running operation. message OperationMetadata { // Output only. The time the operation was created. diff --git a/google/cloud/eventarc/v1/eventarc_v1.yaml b/google/cloud/eventarc/v1/eventarc_v1.yaml index 4d17b8c8a..fd10d8afd 100644 --- a/google/cloud/eventarc/v1/eventarc_v1.yaml +++ b/google/cloud/eventarc/v1/eventarc_v1.yaml @@ -5,11 +5,20 @@ title: Eventarc API apis: - name: google.cloud.eventarc.v1.Eventarc +- name: google.cloud.location.Locations +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.eventarc.v1.OperationMetadata documentation: + summary: 'Build event-driven applications on Google Cloud Platform.' + overview: |- + Eventarc lets you asynchronously deliver events from Google services, SaaS, + and your own apps using loosely coupled services that react to state + changes. Eventarc requires no infrastructure management — you can optimize + productivity and costs while building an event-driven solution. rules: - selector: google.cloud.location.Locations.GetLocation description: Gets information about a location. diff --git a/google/cloud/eventarc/v1/google_channel_config.proto b/google/cloud/eventarc/v1/google_channel_config.proto new file mode 100644 index 000000000..2b440b57d --- /dev/null +++ b/google/cloud/eventarc/v1/google_channel_config.proto @@ -0,0 +1,65 @@ +// 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.eventarc.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.Eventarc.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/eventarc/v1;eventarc"; +option java_multiple_files = true; +option java_outer_classname = "GoogleChannelConfigProto"; +option java_package = "com.google.cloud.eventarc.v1"; +option php_namespace = "Google\\Cloud\\Eventarc\\V1"; +option ruby_package = "Google::Cloud::Eventarc::V1"; +option (google.api.resource_definition) = { + type: "cloudkms.googleapis.com/CryptoKey" + pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}" +}; + +// A GoogleChannelConfig is a resource that stores the custom settings +// respected by Eventarc first-party triggers in the matching region. +// Once configured, first-party event data will be protected +// using the specified custom managed encryption key instead of Google-managed +// encryption keys. +message GoogleChannelConfig { + option (google.api.resource) = { + type: "eventarc.googleapis.com/GoogleChannelConfig" + pattern: "projects/{project}/locations/{location}/googleChannelConfig" + singular: "googleChannelConfig" + }; + + // Required. The resource name of the config. Must be in the format of, + // `projects/{project}/locations/{location}/googleChannelConfig`. + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The last-modified time. + google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. Resource name of a KMS crypto key (managed by the user) used to + // encrypt/decrypt their event data. + // + // It must match the pattern + // `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + string crypto_key_name = 7 [ + (google.api.field_behavior) = OPTIONAL, + (google.api.resource_reference) = { + type: "cloudkms.googleapis.com/CryptoKey" + } + ]; +} diff --git a/google/cloud/eventarc/v1/trigger.proto b/google/cloud/eventarc/v1/trigger.proto index 45f8a8463..c4ede775f 100644 --- a/google/cloud/eventarc/v1/trigger.proto +++ b/google/cloud/eventarc/v1/trigger.proto @@ -19,6 +19,7 @@ package google.cloud.eventarc.v1; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/protobuf/timestamp.proto"; +import "google/rpc/code.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/eventarc/v1;eventarc"; option java_multiple_files = true; @@ -36,6 +37,11 @@ option (google.api.resource_definition) = { type: "run.googleapis.com/Service" pattern: "*" }; +option (google.api.resource_definition) = { + type: "workflows.googleapis.com/Workflow" + pattern: "projects/{project}/locations/{location}/workflows/{workflow}" +}; + // A representation of the trigger resource. message Trigger { @@ -61,7 +67,7 @@ message Trigger { // Output only. The last-modified time. google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. null The list of filters that applies to event attributes. Only events that + // Required. Unordered list. The list of filters that applies to event attributes. Only events that // match all the provided filters are sent to the destination. repeated EventFilter event_filters = 8 [ (google.api.field_behavior) = UNORDERED_LIST, @@ -106,6 +112,9 @@ message Trigger { // You must provide a channel to receive events from Eventarc SaaS partners. string channel = 13 [(google.api.field_behavior) = OPTIONAL]; + // Output only. The reason(s) why a trigger is in FAILED state. + map conditions = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. This checksum is computed by the server based on the value of other // fields, and might be sent only on create requests to ensure that the // client has an up-to-date value before proceeding. @@ -130,6 +139,15 @@ message EventFilter { string operator = 3 [(google.api.field_behavior) = OPTIONAL]; } +// A condition that is part of the trigger state computation. +message StateCondition { + // The canonical code of the condition. + google.rpc.Code code = 1; + + // Human-readable message. + string message = 2; +} + // Represents a target of an invocation over HTTP. message Destination { oneof descriptor { @@ -146,6 +164,14 @@ message Destination { // A GKE service capable of receiving events. The service should be running // in the same project as the trigger. GKE gke = 3; + + // The resource name of the Workflow whose Executions are triggered by + // the events. The Workflow resource should be deployed in the same project + // as the trigger. + // Format: `projects/{project}/locations/{location}/workflows/{workflow}` + string workflow = 4 [(google.api.resource_reference) = { + type: "workflows.googleapis.com/Workflow" + }]; } } diff --git a/google/cloud/filer/v1beta1/file_grpc_service_config.json b/google/cloud/filer/v1beta1/file_grpc_service_config.json new file mode 100644 index 000000000..d155adeaa --- /dev/null +++ b/google/cloud/filer/v1beta1/file_grpc_service_config.json @@ -0,0 +1,48 @@ +{ + "methodConfig": [ + { + "name": [ + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "ListInstances" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "GetInstance" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "ListBackups" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "GetBackup" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "ListSnapshots" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "GetSnapshots" } + ], + "timeout": "60s", + "retryPolicy": { + "initialBackoff": "0.250s", + "maxBackoff": "32s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": [ + "UNAVAILABLE" + ] + } + }, + { + "name": [ + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "CreateInstance" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "RestoreInstance" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "CreateBackup" } + ], + "timeout": "60000s" + }, + { + "name": [ + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "UpdateInstance" } + ], + "timeout": "14400s" + }, + { + "name": [ + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "DeleteInstance" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "DeleteBackup" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "UpdateBackup" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "CreateSnapshot" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "DeleteSnapshot" }, + { "service": "google.cloud.filestore.v1beta1.CloudFilestoreManager", "method": "UpdateSnapshot" } + ], + "timeout": "600s" + } + ] +} diff --git a/google/cloud/filestore/v1/BUILD.bazel b/google/cloud/filestore/v1/BUILD.bazel index 4de936dcf..6a978e056 100644 --- a/google/cloud/filestore/v1/BUILD.bazel +++ b/google/cloud/filestore/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":filestore_proto_with_info"], gapic_yaml = None, grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "file_v1.yaml", test_deps = [ ":filestore_java_grpc", @@ -135,14 +136,15 @@ go_gapic_library( grpc_service_config = "file_grpc_service_config.json", importpath = "cloud.google.com/go/filestore/apiv1;filestore", metadata = True, + rest_numeric_enums = True, service_yaml = "file_v1.yaml", transport = "grpc+rest", deps = [ ":filestore_go_proto", "//google/cloud/common:common_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -178,6 +180,7 @@ py_gapic_library( name = "filestore_py_gapic", srcs = [":filestore_proto"], grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/cloud/common:common_py_proto", @@ -228,7 +231,9 @@ php_gapic_library( name = "filestore_php_gapic", srcs = [":filestore_proto_with_info"], grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "file_v1.yaml", + transport = "grpc+rest", deps = [ ":filestore_php_grpc", ":filestore_php_proto", @@ -261,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "file_grpc_service_config.json", package = "google.cloud.filestore.v1", + rest_numeric_enums = True, service_yaml = "file_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-extra-dependencies=google-cloud-common=~> 1.0", ], grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Filestore instances are fully managed NFS file servers on Google Cloud for use with applications running on Compute Engine virtual machines (VMs) instances or Google Kubernetes Engine clusters.", ruby_cloud_title = "Filestore V1", deps = [ @@ -352,6 +360,7 @@ csharp_gapic_library( srcs = [":filestore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "file_v1.yaml", deps = [ ":filestore_csharp_grpc", diff --git a/google/cloud/filestore/v1beta1/BUILD.bazel b/google/cloud/filestore/v1beta1/BUILD.bazel index 780497258..5023d17e5 100644 --- a/google/cloud/filestore/v1beta1/BUILD.bazel +++ b/google/cloud/filestore/v1beta1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":filestore_proto_with_info"], gapic_yaml = "file_gapic.yaml", grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":filestore_java_grpc", ], @@ -137,14 +138,16 @@ go_gapic_library( grpc_service_config = "file_grpc_service_config.json", importpath = "cloud.google.com/go/filestore/apiv1beta1;filestore", metadata = True, + rest_numeric_enums = True, service_yaml = "file_v1beta1.yaml", transport = "grpc+rest", deps = [ ":filestore_go_proto", "//google/cloud/common:common_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -221,7 +224,9 @@ php_gapic_library( srcs = [":filestore_proto_with_info"], gapic_yaml = "file_gapic.yaml", grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "file_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":filestore_php_grpc", ":filestore_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "file_grpc_service_config.json", package = "google.cloud.filestore.v1beta1", + rest_numeric_enums = True, service_yaml = "file_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,6 +307,7 @@ ruby_cloud_gapic_library( "ruby-cloud-extra-dependencies=google-cloud-common=~> 1.0", ], grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Filestore instances are fully managed NFS file servers on Google Cloud for use with applications running on Compute Engine virtual machines (VMs) instances or Google Kubernetes Engine clusters.", ruby_cloud_title = "Filestore V1beta1", deps = [ @@ -345,6 +353,7 @@ csharp_gapic_library( srcs = [":filestore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "file_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "file_v1beta1.yaml", deps = [ ":filestore_csharp_grpc", diff --git a/google/cloud/filestore/v1beta1/cloud_filestore_service.proto b/google/cloud/filestore/v1beta1/cloud_filestore_service.proto index eff847105..bf600312e 100644 --- a/google/cloud/filestore/v1beta1/cloud_filestore_service.proto +++ b/google/cloud/filestore/v1beta1/cloud_filestore_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,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/common/operation_metadata.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; @@ -32,17 +33,17 @@ option java_outer_classname = "CloudFilestoreServiceProto"; option java_package = "com.google.cloud.filestore.v1beta1"; option php_namespace = "Google\\Cloud\\Filestore\\V1beta1"; -// Configures and manages Cloud Filestore resources. +// Configures and manages Filestore resources. // -// Cloud Filestore Manager v1beta1. +// Filestore Manager v1beta1. // -// The `file.googleapis.com` service implements the Cloud Filestore API and +// The `file.googleapis.com` service implements the Filestore API and // defines the following model for managing resources: // * The service works with a collection of cloud projects, named: `/projects/*` // * Each project has a collection of available locations, named: `/locations/*` // * Each location has a collection of instances and backups, named: // `/instances/*` and `/backups/*` respectively. -// * As such, Cloud Filestore instances are resources of the form: +// * As such, Filestore instances are resources of the form: // `/projects/{project_id}/locations/{location_id}/instances/{instance_id}` // backups are resources of the form: // `/projects/{project_id}/locations/{location_id}/backup/{backup_id}` @@ -120,6 +121,18 @@ service CloudFilestoreManager { }; } + // Revert an existing instance's file system to a specified snapshot. + rpc RevertInstance(RevertInstanceRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{name=projects/*/locations/*/instances/*}:revert" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "Instance" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + // Deletes an instance. rpc DeleteInstance(DeleteInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -132,6 +145,61 @@ service CloudFilestoreManager { }; } + // Lists all snapshots in a project for either a specified location + // or for all locations. + rpc ListSnapshots(ListSnapshotsRequest) returns (ListSnapshotsResponse) { + option (google.api.http) = { + get: "/v1beta1/{parent=projects/*/locations/*/instances/*}/snapshots" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a specific snapshot. + rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot) { + option (google.api.http) = { + get: "/v1beta1/{name=projects/*/locations/*/instances/*/snapshots/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a snapshot. + rpc CreateSnapshot(CreateSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{parent=projects/*/locations/*/instances/*}/snapshots" + body: "snapshot" + }; + option (google.api.method_signature) = "parent,snapshot,snapshot_id"; + option (google.longrunning.operation_info) = { + response_type: "Snapshot" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + + // Deletes a snapshot. + rpc DeleteSnapshot(DeleteSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1beta1/{name=projects/*/locations/*/instances/*/snapshots/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + + // Updates the settings of a specific snapshot. + rpc UpdateSnapshot(UpdateSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1beta1/{snapshot.name=projects/*/locations/*/instances/*/snapshots/*}" + body: "snapshot" + }; + option (google.api.method_signature) = "snapshot,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Snapshot" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + // Lists all backups in a project for either a specified location or for all // locations. rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse) { @@ -186,11 +254,65 @@ service CloudFilestoreManager { metadata_type: "google.cloud.common.OperationMetadata" }; } + + // Lists all shares for a specified instance. + rpc ListShares(ListSharesRequest) returns (ListSharesResponse) { + option (google.api.http) = { + get: "/v1beta1/{parent=projects/*/locations/*/instances/*}/shares" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a specific share. + rpc GetShare(GetShareRequest) returns (Share) { + option (google.api.http) = { + get: "/v1beta1/{name=projects/*/locations/*/instances/*/shares/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a share. + rpc CreateShare(CreateShareRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{parent=projects/*/locations/*/instances/*}/shares" + body: "share" + }; + option (google.api.method_signature) = "parent,share,share_id"; + option (google.longrunning.operation_info) = { + response_type: "Share" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + + // Deletes a share. + rpc DeleteShare(DeleteShareRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1beta1/{name=projects/*/locations/*/instances/*/shares/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } + + // Updates the settings of a specific share. + rpc UpdateShare(UpdateShareRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1beta1/{share.name=projects/*/locations/*/instances/*/shares/*}" + body: "share" + }; + option (google.api.method_signature) = "share,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Share" + metadata_type: "google.cloud.common.OperationMetadata" + }; + } } // Network configuration for the instance. message NetworkConfig { - // Internet protocol versions supported by Cloud Filestore. + // Internet protocol versions supported by Filestore. enum AddressMode { // Internet protocol not set. ADDRESS_MODE_UNSPECIFIED = 0; @@ -199,6 +321,20 @@ message NetworkConfig { MODE_IPV4 = 1; } + // Available connection modes. + enum ConnectMode { + // ConnectMode not set. + CONNECT_MODE_UNSPECIFIED = 0; + + // Connect via direct peering to the Filestore service. + DIRECT_PEERING = 1; + + // Connect to your Filestore instance using Private Service + // Access. Private services access provides an IP address range for multiple + // Google Cloud services, including Filestore. + PRIVATE_SERVICE_ACCESS = 2; + } + // The name of the Google Compute Engine // [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the // instance is connected. @@ -208,28 +344,46 @@ message NetworkConfig { // assigned. For this version, only MODE_IPV4 is supported. repeated AddressMode modes = 3; - // A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the - // [internal IP address + // Optional, reserved_ip_range can have one of the following two types of + // values. + // + // * CIDR range value when using DIRECT_PEERING connect mode. + // * [Allocated IP address + // range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) + // when using PRIVATE_SERVICE_ACCESS connect mode. + // + // When the name of an allocated IP address range is specified, it must be one + // of the ranges associated with the private service access connection. + // When specified as a direct CIDR value, it must be a /29 CIDR block for + // Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for + // Enterprise tier in one of the [internal IP address // ranges](https://www.arin.net/reference/research/statistics/address_filters/) // that identifies the range of IP addresses reserved for this instance. For - // example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap - // with either existing subnets or assigned IP address ranges for other Cloud - // Filestore instances in the selected VPC network. + // example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The + // range you specify can't overlap with either existing subnets or assigned IP + // address ranges for other Filestore instances in the selected VPC + // network. string reserved_ip_range = 4; - // Output only. IPv4 addresses in the format - // `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format + // Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or + // IPv6 addresses in the format // `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`. repeated string ip_addresses = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The network connect mode of the Filestore instance. + // If not provided, the connect mode defaults to DIRECT_PEERING. + ConnectMode connect_mode = 6; } // File share configuration for the instance. message FileShareConfig { - // The name of the file share (must be 16 characters or less). + // The name of the file share (must be 32 characters or less for + // Enterprise and High Scale SSD tiers and 16 characters or less for all other + // tiers). string name = 1; // File share capacity in gigabytes (GB). - // Cloud Filestore defines 1 GB as 1024^3 bytes. + // Filestore defines 1 GB as 1024^3 bytes. int64 capacity_gb = 2; // The source that this file share has been restored from. Empty if the file @@ -307,7 +461,7 @@ message NfsExportOptions { int64 anon_gid = 5; } -// A Cloud Filestore instance. +// A Filestore instance. message Instance { option (google.api.resource) = { type: "file.googleapis.com/Instance" @@ -340,6 +494,19 @@ message Instance { // The instance is restoring a snapshot or backup to an existing file share // and may be unusable during this time. RESTORING = 7; + + // The instance is suspended. You can get further details from + // the `suspension_reasons` field of the `Instance` resource. + SUSPENDED = 8; + + // The instance is reverting to a snapshot. + REVERTING = 9; + + // The instance is in the process of becoming suspended. + SUSPENDING = 10; + + // The instance is in the process of becoming active. + RESUMING = 11; } // Available service tiers. @@ -366,6 +533,19 @@ message Instance { // HIGH_SCALE instances offer expanded capacity and performance scaling // capabilities. HIGH_SCALE_SSD = 6; + + // ENTERPRISE instances offer the features and availability needed for + // mission-critical workloads. + ENTERPRISE = 7; + } + + // SuspensionReason contains the possible reasons for a suspension. + enum SuspensionReason { + // Not set. + SUSPENSION_REASON_UNSPECIFIED = 0; + + // The KMS key used by the instance is either revoked or denied access to. + KMS_KEY_ISSUE = 1; } // Output only. The resource name of the instance, in the format @@ -404,12 +584,37 @@ message Instance { // Output only. Reserved for future use. google.protobuf.BoolValue satisfies_pzs = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // KMS key name used for data encryption. + string kms_key_name = 14; + + // Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. + repeated SuspensionReason suspension_reasons = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The max capacity of the instance. + int64 max_capacity_gb = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The increase/decrease capacity step size. + int64 capacity_step_size_gb = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The max number of shares allowed. + int64 max_share_count = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). + // This capacity can be increased up to `max_capacity_gb` GB in multipliers + // of `capacity_step_size_gb` GB. + int64 capacity_gb = 19; + + // Indicates whether this instance uses a multi-share configuration with which + // it can have more than one file-share or none at all. File-shares are added, + // updated and removed through the separate file-share APIs. + bool multi_share_enabled = 20; } // CreateInstanceRequest creates an instance. message CreateInstanceRequest { // Required. The instance's project and location, in the format - // `projects/{project_id}/locations/{location}`. In Cloud Filestore, + // `projects/{project_id}/locations/{location}`. In Filestore, // locations map to GCP zones, for example **us-west1-b**. string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -456,7 +661,7 @@ message UpdateInstanceRequest { Instance instance = 2 [(google.api.field_behavior) = REQUIRED]; } -// RestoreInstanceRequest restores an existing instances's file share from a +// RestoreInstanceRequest restores an existing instance's file share from a // snapshot or backup. message RestoreInstanceRequest { // Required. The resource name of the instance, in the format @@ -468,7 +673,7 @@ message RestoreInstanceRequest { } ]; - // Required. Name of the file share in the Cloud Filestore instance that the snapshot + // Required. Name of the file share in the Filestore instance that the snapshot // is being restored to. string file_share = 2 [(google.api.field_behavior) = REQUIRED]; @@ -487,6 +692,24 @@ message RestoreInstanceRequest { } } +// RevertInstanceRequest reverts the given instance's file share to the +// specified snapshot. +message RevertInstanceRequest { + // Required. projects/{project_id}/locations/{location_id}/instances/{instance_id}. + // The resource name of the instance, in the format + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Instance" + } + ]; + + // Required. The snapshot resource ID, in the format 'my-snapshot', where the specified + // ID is the {snapshot_id} of the fully qualified name like + // projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id} + string target_snapshot_id = 2 [(google.api.field_behavior) = REQUIRED]; +} + // DeleteInstanceRequest deletes an instance. message DeleteInstanceRequest { // Required. The instance resource name, in the format @@ -497,6 +720,10 @@ message DeleteInstanceRequest { type: "file.googleapis.com/Instance" } ]; + + // If set to true, any snapshots of the instance will also be deleted. + // (Otherwise, the request will only work if the instance has no snapshots.) + bool force = 2; } // ListInstancesRequest lists instances. @@ -545,7 +772,7 @@ message ListInstancesResponse { repeated string unreachable = 3; } -// A Cloud Filestore snapshot. +// A Filestore snapshot. message Snapshot { option (google.api.resource) = { type: "file.googleapis.com/Snapshot" @@ -588,7 +815,99 @@ message Snapshot { int64 filesystem_used_bytes = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// A Cloud Filestore backup. +// CreateSnapshotRequest creates a snapshot. +message CreateSnapshotRequest { + // Required. The Filestore Instance to create the snapshots of, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Instance" + } + ]; + + // Required. The ID to use for the snapshot. + // The ID must be unique within the specified instance. + // + // This value must start with a lowercase letter followed by up to 62 + // lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + string snapshot_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. A snapshot resource + Snapshot snapshot = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// GetSnapshotRequest gets the state of a snapshot. +message GetSnapshotRequest { + // Required. The snapshot resource name, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Snapshot" + } + ]; +} + +// DeleteSnapshotRequest deletes a snapshot. +message DeleteSnapshotRequest { + // Required. The snapshot resource name, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Snapshot" + } + ]; +} + +// UpdateSnapshotRequest updates description and/or labels for a snapshot. +message UpdateSnapshotRequest { + // Required. Mask of fields to update. At least one path must be supplied in this + // field. + google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. A snapshot resource + Snapshot snapshot = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// ListSnapshotsRequest lists snapshots. +message ListSnapshotsRequest { + // Required. The instance for which to retrieve snapshot information, + // in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Instance" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value to use if there are additional + // results to retrieve for this list request. + string page_token = 3; + + // Sort results. Supported values are "name", "name desc" or "" (unsorted). + string order_by = 4; + + // List filter. + string filter = 5; +} + +// ListSnapshotsResponse is the result of ListSnapshotsRequest. +message ListSnapshotsResponse { + // A list of snapshots in the project for the specified instance. + repeated Snapshot snapshots = 1; + + // The token you can use to retrieve the next page of results. Not returned + // if there are no more results in the list. + string next_page_token = 2; +} + +// A Filestore backup. message Backup { option (google.api.resource) = { type: "file.googleapis.com/Backup" @@ -638,18 +957,18 @@ message Backup { // this number is expected to change with backup creation/deletion. int64 storage_bytes = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - // The resource name of the source Cloud Filestore instance, in the format + // The resource name of the source Filestore instance, in the format // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, // used to create this backup. string source_instance = 8 [(google.api.resource_reference) = { type: "file.googleapis.com/Instance" }]; - // Name of the file share in the source Cloud Filestore instance that the + // Name of the file share in the source Filestore instance that the // backup is created from. string source_file_share = 9; - // Output only. The service tier of the source Cloud Filestore instance that this backup + // Output only. The service tier of the source Filestore instance that this backup // is created from. Instance.Tier source_instance_tier = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -658,12 +977,15 @@ message Backup { // Output only. Reserved for future use. google.protobuf.BoolValue satisfies_pzs = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Immutable. KMS key name used for data encryption. + string kms_key_name = 13 [(google.api.field_behavior) = IMMUTABLE]; } // CreateBackupRequest creates a backup. message CreateBackupRequest { // Required. The backup's project and location, in the format - // `projects/{project_id}/locations/{location}`. In Cloud Filestore, + // `projects/{project_id}/locations/{location}`. In Filestore, // backup locations map to GCP regions, for example **us-west1**. string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -721,7 +1043,7 @@ message GetBackupRequest { message ListBackupsRequest { // Required. The project and location for which to retrieve backup information, // in the format `projects/{project_id}/locations/{location}`. - // In Cloud Filestore, backup locations map to GCP regions, + // In Filestore, backup locations map to GCP regions, // for example **us-west1**. // To retrieve backup information for all locations, use "-" for the // `{location}` value. @@ -764,3 +1086,157 @@ message ListBackupsResponse { // Locations that could not be reached. repeated string unreachable = 3; } + +// A Filestore share. +message Share { + option (google.api.resource) = { + type: "file.googleapis.com/Share" + pattern: "projects/{project}/locations/{location}/instances/{instance}/shares/{share}" + }; + + // The share state. + enum State { + // State not set. + STATE_UNSPECIFIED = 0; + + // Share is being created. + CREATING = 1; + + // Share is ready for use. + READY = 3; + + // Share is being deleted. + DELETING = 4; + } + + // Output only. The resource name of the share, in the format + // `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The mount name of the share. Must be 63 characters or less and consist of + // uppercase or lowercase letters, numbers, and underscores. + string mount_name = 2; + + // A description of the share with 2048 characters or less. Requests with + // longer descriptions will be rejected. + string description = 3; + + // File share capacity in gigabytes (GB). Filestore defines 1 GB as + // 1024^3 bytes. Must be greater than 0. + int64 capacity_gb = 4; + + // Nfs Export Options. + // There is a limit of 10 export options per file share. + repeated NfsExportOptions nfs_export_options = 5; + + // Output only. The share state. + State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the share was created. + google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Resource labels to represent user provided metadata. + map labels = 8; +} + +// CreateShareRequest creates a share. +message CreateShareRequest { + // Required. The Filestore Instance to create the share for, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Instance" + } + ]; + + // Required. The ID to use for the share. + // The ID must be unique within the specified instance. + // + // This value must start with a lowercase letter followed by up to 62 + // lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + string share_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. A share resource + Share share = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// GetShareRequest gets the state of a share. +message GetShareRequest { + // Required. The share resource name, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}/shares/{share_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Share" + } + ]; +} + +// DeleteShareRequest deletes a share. +message DeleteShareRequest { + // Required. The share resource name, in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}/share/{share_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Share" + } + ]; +} + +// ListSharesRequest lists shares. +message ListSharesRequest { + // Required. The instance for which to retrieve share information, + // in the format + // `projects/{project_id}/locations/{location}/instances/{instance_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "file.googleapis.com/Instance" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value to use if there are additional + // results to retrieve for this list request. + string page_token = 3; + + // Sort results. Supported values are "name", "name desc" or "" (unsorted). + string order_by = 4; + + // List filter. + string filter = 5; +} + +// ListSharesResponse is the result of ListSharesRequest. +message ListSharesResponse { + // A list of shares in the project for the specified instance. + repeated Share shares = 1; + + // The token you can use to retrieve the next page of results. Not returned + // if there are no more results in the list. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// UpdateShareRequest updates the settings of a share. +message UpdateShareRequest { + // Required. A share resource. + // Only fields specified in update_mask are updated. + Share share = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Mask of fields to update. At least one path must be supplied in this + // field. + // The elements of the repeated paths field may only include these fields: + // + // * "description" + // * "capacity_gb" + // * "labels" + // * "nfs_export_options" + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/filestore/v1beta1/file_gapic.yaml b/google/cloud/filestore/v1beta1/file_gapic.yaml index 071db78e3..ccc3196c3 100644 --- a/google/cloud/filestore/v1beta1/file_gapic.yaml +++ b/google/cloud/filestore/v1beta1/file_gapic.yaml @@ -9,33 +9,70 @@ interfaces: # The default client-side timeouts cause the client to give up on the request early, # so the following configuration increases it: # See go/client-self-service#configure-long-running-operation-polling-timeouts-optional + # See also retry timeouts in: google/cloud/filer/v1beta1/file_grpc_service_config.json - name: CreateInstance long_running: - initial_poll_delay_millis: 60000 # 1 minutes + initial_poll_delay_millis: 30000 # 30 seconds poll_delay_multiplier: 1.5 - max_poll_delay_millis: 360000 # 6 minutes + max_poll_delay_millis: 60000 # 1 minute total_poll_timeout_millis: 7200000 # 120 minutes - name: DeleteSnapshot long_running: - initial_poll_delay_millis: 60000 # 1 minutes + initial_poll_delay_millis: 30000 # 30 seconds poll_delay_multiplier: 1.5 - max_poll_delay_millis: 360000 # 6 minutes + max_poll_delay_millis: 60000 # 1 minute total_poll_timeout_millis: 7200000 # 120 minutes - name: DeleteInstance long_running: - initial_poll_delay_millis: 60000 # 1 minutes + initial_poll_delay_millis: 30000 # 30 seconds poll_delay_multiplier: 1.5 - max_poll_delay_millis: 360000 # 6 minutes - total_poll_timeout_millis: 900000 # 15 minutes + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 1200000 # 20 minutes - name: UpdateInstance long_running: - initial_poll_delay_millis: 60000 # 1 minutes + initial_poll_delay_millis: 30000 # 30 seconds poll_delay_multiplier: 1.5 - max_poll_delay_millis: 360000 # 6 minutes + max_poll_delay_millis: 60000 # 1 minute total_poll_timeout_millis: 900000 # 15 minutes - name: RestoreInstance long_running: - initial_poll_delay_millis: 60000 # 1 minutes + initial_poll_delay_millis: 30000 # 30 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 7200000 # 120 minutes + - name: RevertInstance + long_running: + initial_poll_delay_millis: 30000 # 30 seconds poll_delay_multiplier: 1.5 - max_poll_delay_millis: 360000 # 6 minutes + max_poll_delay_millis: 60000 # 1 minute total_poll_timeout_millis: 7200000 # 120 minutes + - name: CreateBackup + long_running: + initial_poll_delay_millis: 30000 # 30 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 7200000 # 120 minutes + - name: DeleteBackup + long_running: + initial_poll_delay_millis: 10000 # 10 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 660000 # 11 minutes + - name: UpdateBackup + long_running: + initial_poll_delay_millis: 10000 # 10 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 660000 # 11 minutes + - name: CreateSnapshot + long_running: + initial_poll_delay_millis: 10000 # 10 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 660000 # 11 minutes + - name: UpdateSnapshot + long_running: + initial_poll_delay_millis: 10000 # 10 seconds + poll_delay_multiplier: 1.5 + max_poll_delay_millis: 60000 # 1 minute + total_poll_timeout_millis: 660000 # 11 minutes diff --git a/google/cloud/filestore/v1beta1/file_v1beta1.yaml b/google/cloud/filestore/v1beta1/file_v1beta1.yaml index 12b0a8138..a06cca64d 100644 --- a/google/cloud/filestore/v1beta1/file_v1beta1.yaml +++ b/google/cloud/filestore/v1beta1/file_v1beta1.yaml @@ -5,6 +5,8 @@ title: Cloud Filestore API apis: - name: google.cloud.filestore.v1beta1.CloudFilestoreManager +- name: google.cloud.location.Locations +- name: google.longrunning.Operations documentation: summary: |- diff --git a/google/cloud/functions/v1/BUILD.bazel b/google/cloud/functions/v1/BUILD.bazel index 7d90fad67..5d0372584 100644 --- a/google/cloud/functions/v1/BUILD.bazel +++ b/google/cloud/functions/v1/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( srcs = [":functions_proto_with_info"], gapic_yaml = None, grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", test_deps = [ ":functions_java_grpc", @@ -139,14 +140,15 @@ go_gapic_library( grpc_service_config = "functions_grpc_service_config.json", importpath = "cloud.google.com/go/functions/apiv1;functions", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", transport = "grpc+rest", deps = [ ":functions_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], @@ -184,6 +186,7 @@ py_gapic_library( name = "functions_py_gapic", srcs = [":functions_proto"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", transport = "grpc", deps = [ @@ -235,7 +238,9 @@ php_gapic_library( name = "functions_php_gapic", srcs = [":functions_proto_with_info"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", + transport = "grpc+rest", deps = [ ":functions_php_grpc", ":functions_php_proto", @@ -268,7 +273,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "functions_grpc_service_config.json", package = "google.cloud.functions.v1", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -313,6 +320,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/functions", ], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Functions API manages lightweight user-provided functions executed in response to events.", ruby_cloud_title = "Cloud Functions V1", deps = [ @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":functions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v1.yaml", deps = [ ":functions_csharp_grpc", diff --git a/google/cloud/functions/v2/BUILD.bazel b/google/cloud/functions/v2/BUILD.bazel index 58690e183..d5abe27ba 100644 --- a/google/cloud/functions/v2/BUILD.bazel +++ b/google/cloud/functions/v2/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":functions_proto_with_info"], gapic_yaml = None, grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", test_deps = [ ":functions_java_grpc", @@ -138,6 +139,7 @@ go_gapic_library( grpc_service_config = "functions_grpc_service_config.json", importpath = "cloud.google.com/go/functions/apiv2;functions", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", transport = "grpc+rest", deps = [ @@ -145,8 +147,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -183,6 +185,7 @@ py_gapic_library( name = "functions_py_gapic", srcs = [":functions_proto"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", transport = "grpc", deps = [ @@ -234,7 +237,9 @@ php_gapic_library( name = "functions_php_gapic", srcs = [":functions_proto_with_info"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", + transport = "grpc+rest", deps = [ ":functions_php_grpc", ":functions_php_proto", @@ -267,7 +272,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "functions_grpc_service_config.json", package = "google.cloud.functions.v2", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/functions", ], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Functions API manages lightweight user-provided functions executed in response to events.", ruby_cloud_title = "Cloud Functions V2", service_yaml = "cloudfunctions_v2.yaml", @@ -358,6 +366,7 @@ csharp_gapic_library( srcs = [":functions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2.yaml", deps = [ ":functions_csharp_grpc", diff --git a/google/cloud/functions/v2alpha/BUILD.bazel b/google/cloud/functions/v2alpha/BUILD.bazel index 16299253a..eafe60146 100644 --- a/google/cloud/functions/v2alpha/BUILD.bazel +++ b/google/cloud/functions/v2alpha/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "functions_proto", @@ -45,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "functions_java_proto", deps = [":functions_proto"], @@ -73,6 +92,7 @@ java_gapic_library( srcs = [":functions_proto_with_info"], gapic_yaml = None, grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", test_deps = [ ":functions_java_grpc", @@ -100,6 +120,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-functions-v2alpha-java", + include_samples = True, transport = "grpc+rest", deps = [ ":functions_java_gapic", @@ -109,17 +130,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "functions_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -137,6 +147,7 @@ go_gapic_library( grpc_service_config = "functions_grpc_service_config.json", importpath = "cloud.google.com/go/functions/apiv2alpha;functions", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", transport = "grpc+rest", deps = [ @@ -144,8 +155,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -168,20 +179,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "functions_py_gapic", srcs = [":functions_proto"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", transport = "grpc", deps = [ @@ -207,17 +209,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_php_proto", deps = [":functions_proto"], @@ -233,7 +224,9 @@ php_gapic_library( name = "functions_php_gapic", srcs = [":functions_proto_with_info"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", + transport = "grpc+rest", deps = [ ":functions_php_grpc", ":functions_php_proto", @@ -250,15 +243,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "functions_nodejs_gapic", package_name = "@google-cloud/functions", @@ -266,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "functions_grpc_service_config.json", package = "google.cloud.functions.v2alpha", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,17 +264,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_ruby_proto", deps = [":functions_proto"], @@ -307,6 +282,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-functions-v2alpha", ], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":functions_ruby_grpc", ":functions_ruby_proto", @@ -323,17 +299,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_csharp_proto", deps = [":functions_proto"], @@ -350,6 +315,7 @@ csharp_gapic_library( srcs = [":functions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2alpha.yaml", deps = [ ":functions_csharp_grpc", @@ -367,15 +333,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "functions_cc_proto", deps = [":functions_proto"], diff --git a/google/cloud/functions/v2beta/BUILD.bazel b/google/cloud/functions/v2beta/BUILD.bazel index 8c7388de7..a907a3ed0 100644 --- a/google/cloud/functions/v2beta/BUILD.bazel +++ b/google/cloud/functions/v2beta/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "functions_proto", @@ -45,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "functions_java_proto", deps = [":functions_proto"], @@ -73,6 +92,7 @@ java_gapic_library( srcs = [":functions_proto_with_info"], gapic_yaml = None, grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", test_deps = [ ":functions_java_grpc", @@ -100,6 +120,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-functions-v2beta-java", + include_samples = True, transport = "grpc+rest", deps = [ ":functions_java_gapic", @@ -109,17 +130,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "functions_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -137,6 +147,7 @@ go_gapic_library( grpc_service_config = "functions_grpc_service_config.json", importpath = "cloud.google.com/go/functions/apiv2beta;functions", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", transport = "grpc+rest", deps = [ @@ -144,8 +155,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", ], ) @@ -168,20 +179,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "functions_py_gapic", srcs = [":functions_proto"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", transport = "grpc", deps = [ @@ -207,17 +209,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_php_proto", deps = [":functions_proto"], @@ -233,7 +224,9 @@ php_gapic_library( name = "functions_php_gapic", srcs = [":functions_proto_with_info"], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", + transport = "grpc+rest", deps = [ ":functions_php_grpc", ":functions_php_proto", @@ -250,15 +243,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "functions_nodejs_gapic", package_name = "@google-cloud/functions", @@ -266,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "functions_grpc_service_config.json", package = "google.cloud.functions.v2beta", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,17 +264,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_ruby_proto", deps = [":functions_proto"], @@ -307,6 +282,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-functions-v2beta", ], grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":functions_ruby_grpc", ":functions_ruby_proto", @@ -323,17 +299,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "functions_csharp_proto", deps = [":functions_proto"], @@ -350,6 +315,7 @@ csharp_gapic_library( srcs = [":functions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "functions_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudfunctions_v2beta.yaml", deps = [ ":functions_csharp_grpc", @@ -367,15 +333,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "functions_cc_proto", deps = [":functions_proto"], diff --git a/google/cloud/gaming/v1/BUILD.bazel b/google/cloud/gaming/v1/BUILD.bazel index 6d60d493c..8ed7b47b3 100644 --- a/google/cloud/gaming/v1/BUILD.bazel +++ b/google/cloud/gaming/v1/BUILD.bazel @@ -78,6 +78,7 @@ java_gapic_library( name = "gaming_java_gapic", srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":gaming_java_grpc", ], @@ -142,13 +143,14 @@ go_gapic_library( srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", importpath = "cloud.google.com/go/gaming/apiv1;gaming", + rest_numeric_enums = True, service_yaml = "gameservices_v1.yaml", transport = "grpc+rest", deps = [ ":gaming_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -187,6 +189,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-game-servers", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -234,7 +237,9 @@ php_gapic_library( name = "gaming_php_gapic", srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gameservices_v1.yaml", + transport = "grpc+rest", deps = [ ":gaming_php_grpc", ":gaming_php_proto", @@ -267,7 +272,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "gaming_grpc_service_config.json", package = "google.cloud.gaming.v1", + rest_numeric_enums = True, service_yaml = "gameservices_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,6 +319,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=gameservices", ], grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "With Game Servers, studios and publishers can deploy and manage their game server infrastructure hosted on multiple Agones clusters around the world through a single interface.", ruby_cloud_title = "Cloud Gaming V1", deps = [ @@ -357,6 +365,7 @@ csharp_gapic_library( srcs = [":gaming_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gameservices_v1.yaml", deps = [ ":gaming_csharp_grpc", diff --git a/google/cloud/gaming/v1beta/BUILD.bazel b/google/cloud/gaming/v1beta/BUILD.bazel index 7220119c5..e7468bd1d 100644 --- a/google/cloud/gaming/v1beta/BUILD.bazel +++ b/google/cloud/gaming/v1beta/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( name = "gaming_java_gapic", srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":gaming_java_grpc", ], @@ -133,13 +134,14 @@ go_gapic_library( srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", importpath = "cloud.google.com/go/gaming/apiv1beta;gaming", + rest_numeric_enums = True, service_yaml = "gameservices_v1beta.yaml", transport = "grpc+rest", deps = [ ":gaming_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -178,6 +180,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-game-servers", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -225,6 +228,8 @@ php_gapic_library( name = "gaming_php_gapic", srcs = [":gaming_proto_with_info"], grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":gaming_php_grpc", ":gaming_php_proto", @@ -257,7 +262,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "gaming_grpc_service_config.json", package = "google.cloud.gaming.v1beta", + rest_numeric_enums = True, service_yaml = "gameservices_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( name = "gaming_ruby_gapic", srcs = [":gaming_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-gaming-v1beta"], + rest_numeric_enums = True, deps = [ ":gaming_ruby_grpc", ":gaming_ruby_proto", @@ -338,6 +346,7 @@ csharp_gapic_library( srcs = [":gaming_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "gaming_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gameservices_v1beta.yaml", deps = [ ":gaming_csharp_grpc", diff --git a/google/cloud/gkebackup/v1/BUILD.bazel b/google/cloud/gkebackup/v1/BUILD.bazel index ed7aba877..5000f5332 100644 --- a/google/cloud/gkebackup/v1/BUILD.bazel +++ b/google/cloud/gkebackup/v1/BUILD.bazel @@ -95,6 +95,7 @@ java_gapic_library( srcs = [":gkebackup_proto_with_info"], gapic_yaml = None, grpc_service_config = "gkebackup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkebackup_v1.yaml", test_deps = [ ":gkebackup_java_grpc", @@ -145,13 +146,14 @@ go_gapic_library( grpc_service_config = "gkebackup_grpc_service_config.json", importpath = "cloud.google.com/go/gkebackup/apiv1;gkebackup", metadata = True, + rest_numeric_enums = True, service_yaml = "gkebackup_v1.yaml", transport = "grpc+rest", deps = [ ":gkebackup_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -182,6 +184,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=gke_backup", ], + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -218,7 +221,9 @@ php_gapic_library( name = "gkebackup_php_gapic", srcs = [":gkebackup_proto_with_info"], grpc_service_config = "gkebackup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkebackup_v1.yaml", + transport = "grpc+rest", deps = [ ":gkebackup_php_grpc", ":gkebackup_php_proto", @@ -242,7 +247,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "gkebackup_grpc_service_config.json", package = "google.cloud.gkebackup.v1", + rest_numeric_enums = True, service_yaml = "gkebackup_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -275,6 +282,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/", ], grpc_service_config = "gkebackup_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Backup for GKE lets you protect, manage, and restore your containerized applications and data for stateful workloads running on Google Kubernetes Engine clusters.", ruby_cloud_title = "Backup for GKE V1", deps = [ @@ -309,6 +317,7 @@ csharp_gapic_library( srcs = [":gkebackup_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "gkebackup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkebackup_v1.yaml", deps = [ ":gkebackup_csharp_grpc", diff --git a/google/cloud/gkeconnect/gateway/v1beta1/BUILD.bazel b/google/cloud/gkeconnect/gateway/v1beta1/BUILD.bazel index 2f2d3c324..935e3fb19 100644 --- a/google/cloud/gkeconnect/gateway/v1beta1/BUILD.bazel +++ b/google/cloud/gkeconnect/gateway/v1beta1/BUILD.bazel @@ -65,9 +65,11 @@ java_gapic_library( name = "gateway_java_gapic", srcs = [":gateway_proto_with_info"], grpc_service_config = "connectgw_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":gateway_java_grpc", ], + transport = "grpc", deps = [ ":gateway_java_proto", "//google/api:api_java_proto", @@ -86,6 +88,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-gkeconnect-gateway-v1beta1-java", include_samples = True, + transport = "grpc", deps = [ ":gateway_java_gapic", ":gateway_java_grpc", @@ -122,7 +125,9 @@ go_gapic_library( grpc_service_config = "connectgw_grpc_service_config.json", importpath = "cloud.google.com/go/gkeconnect/gateway/apiv1beta1;gateway", metadata = True, + rest_numeric_enums = False, service_yaml = "connectgateway_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":gateway_go_proto", "//google/api:httpbody_go_proto", @@ -162,6 +167,7 @@ py_gapic_library( srcs = [":gateway_proto"], grpc_service_config = "connectgw_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-gke-connect-gateway"], + rest_numeric_enums = False, transport = "grpc", ) @@ -209,7 +215,9 @@ php_gapic_library( name = "gateway_php_gapic", srcs = [":gateway_proto_with_info"], grpc_service_config = "connectgw_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "connectgateway_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":gateway_php_grpc", ":gateway_php_proto", @@ -242,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "connectgw_grpc_service_config.json", package = "google.cloud.gkeconnect.gateway.v1beta1", + rest_numeric_enums = False, service_yaml = "connectgateway_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -287,6 +297,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=connectgateway", ], grpc_service_config = "connectgw_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "The Connect gateway builds on the power of fleets to let Anthos users connect to and run commands against registered Anthos clusters in a simple, consistent, and secured way, whether the clusters are on Google Cloud, other public clouds, or on premises, and makes it easier to automate DevOps processes across all your clusters.", ruby_cloud_title = "Connect Gateway V1beta1", deps = [ @@ -332,6 +343,7 @@ csharp_gapic_library( srcs = [":gateway_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "connectgw_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "connectgateway_v1beta1.yaml", deps = [ ":gateway_csharp_grpc", diff --git a/google/cloud/gkehub/v1/BUILD.bazel b/google/cloud/gkehub/v1/BUILD.bazel index 5b31f4978..7b32e5f06 100644 --- a/google/cloud/gkehub/v1/BUILD.bazel +++ b/google/cloud/gkehub/v1/BUILD.bazel @@ -85,6 +85,7 @@ java_gapic_library( srcs = [":gkehub_proto_with_info"], gapic_yaml = None, grpc_service_config = "v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1.yaml", test_deps = [ ":gkehub_java_grpc", @@ -147,13 +148,14 @@ go_gapic_library( grpc_service_config = "v1_grpc_service_config.json", importpath = "cloud.google.com/go/gkehub/apiv1;gkehub", metadata = True, + rest_numeric_enums = True, service_yaml = "gkehub_v1.yaml", transport = "grpc+rest", deps = [ ":gkehub_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -189,6 +191,7 @@ py_gapic_library( srcs = [":gkehub_proto"], grpc_service_config = "v1_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-gke-hub"], + rest_numeric_enums = True, transport = "grpc", ) @@ -239,7 +242,9 @@ php_gapic_library( name = "gkehub_php_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1.yaml", + transport = "grpc+rest", deps = [ ":gkehub_php_grpc", ":gkehub_php_proto", @@ -272,7 +277,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "v1_grpc_service_config.json", package = "google.cloud.gkehub.v1", + rest_numeric_enums = True, service_yaml = "gkehub_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -323,6 +330,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/anthos/clusters/docs", ], grpc_service_config = "v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The GKE Hub API centrally manages features and services on all your Kubernetes clusters running in a variety of environments, including Google cloud, on premises in customer datacenters, or other third party clouds.", ruby_cloud_title = "GKE Hub V1", deps = [ @@ -368,6 +376,7 @@ csharp_gapic_library( srcs = [":gkehub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1.yaml", deps = [ ":gkehub_csharp_grpc", diff --git a/google/cloud/gkehub/v1/configmanagement/BUILD.bazel b/google/cloud/gkehub/v1/configmanagement/BUILD.bazel index 8d8a7f0c7..71b0661c3 100644 --- a/google/cloud/gkehub/v1/configmanagement/BUILD.bazel +++ b/google/cloud/gkehub/v1/configmanagement/BUILD.bazel @@ -68,6 +68,7 @@ load( py_gapic_library( name = "configmanagement_py_gapic", srcs = [":configmanagement_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1/multiclusteringress/BUILD.bazel b/google/cloud/gkehub/v1/multiclusteringress/BUILD.bazel index 639aae837..33ec6974f 100644 --- a/google/cloud/gkehub/v1/multiclusteringress/BUILD.bazel +++ b/google/cloud/gkehub/v1/multiclusteringress/BUILD.bazel @@ -67,6 +67,7 @@ load( py_gapic_library( name = "multiclusteringress_py_gapic", srcs = [":multiclusteringress_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha/BUILD.bazel b/google/cloud/gkehub/v1alpha/BUILD.bazel index b76f7d437..03cda5871 100644 --- a/google/cloud/gkehub/v1alpha/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/BUILD.bazel @@ -91,6 +91,7 @@ java_gapic_library( name = "gkehub_java_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "v1alpha_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":gkehub_java_grpc", ] + _JAVA_GRPC_SUBPACKAGE_DEPS, @@ -154,13 +155,14 @@ go_gapic_library( grpc_service_config = "v1alpha_grpc_service_config.json", importpath = "cloud.google.com/go/gkehub/apiv1alpha;gkehub", metadata = True, + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha.yaml", transport = "grpc+rest", deps = [ ":gkehub_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -196,6 +198,7 @@ py_gapic_library( srcs = [":gkehub_proto"], grpc_service_config = "v1alpha_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-gke-hub"], + rest_numeric_enums = True, transport = "grpc", ) @@ -249,7 +252,9 @@ php_gapic_library( name = "gkehub_php_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":gkehub_php_grpc", ":gkehub_php_proto", @@ -282,7 +287,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "v1alpha_grpc_service_config.json", package = "google.cloud.gkehub.v1alpha", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -326,6 +333,7 @@ ruby_cloud_gapic_library( srcs = [":gkehub_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-gkehub-v1alpha"], grpc_service_config = "v1alpha_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":gkehub_ruby_grpc", ":gkehub_ruby_proto", @@ -369,6 +377,7 @@ csharp_gapic_library( srcs = [":gkehub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "v1alpha_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha.yaml", deps = [ ":gkehub_csharp_grpc", diff --git a/google/cloud/gkehub/v1alpha/cloudauditlogging/BUILD.bazel b/google/cloud/gkehub/v1alpha/cloudauditlogging/BUILD.bazel index b5c083a3e..b4a771182 100644 --- a/google/cloud/gkehub/v1alpha/cloudauditlogging/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/cloudauditlogging/BUILD.bazel @@ -67,6 +67,7 @@ load( py_gapic_library( name = "cloudauditlogging_py_gapic", srcs = [":cloudauditlogging_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha/configmanagement/BUILD.bazel b/google/cloud/gkehub/v1alpha/configmanagement/BUILD.bazel index da05d7aef..3042c3bed 100644 --- a/google/cloud/gkehub/v1alpha/configmanagement/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/configmanagement/BUILD.bazel @@ -68,6 +68,7 @@ load( py_gapic_library( name = "configmanagement_py_gapic", srcs = [":configmanagement_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha/metering/BUILD.bazel b/google/cloud/gkehub/v1alpha/metering/BUILD.bazel index 9bdc8fa9c..891c4bbaf 100644 --- a/google/cloud/gkehub/v1alpha/metering/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/metering/BUILD.bazel @@ -68,6 +68,7 @@ load( py_gapic_library( name = "metering_py_gapic", srcs = [":metering_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha/multiclusteringress/BUILD.bazel b/google/cloud/gkehub/v1alpha/multiclusteringress/BUILD.bazel index fd91bc335..361036f63 100644 --- a/google/cloud/gkehub/v1alpha/multiclusteringress/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/multiclusteringress/BUILD.bazel @@ -67,6 +67,7 @@ load( py_gapic_library( name = "multiclusteringress_py_gapic", srcs = [":multiclusteringress_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha/servicemesh/BUILD.bazel b/google/cloud/gkehub/v1alpha/servicemesh/BUILD.bazel index 4fb9d9972..fcc357831 100644 --- a/google/cloud/gkehub/v1alpha/servicemesh/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha/servicemesh/BUILD.bazel @@ -70,6 +70,7 @@ load( py_gapic_library( name = "servicemesh_py_gapic", srcs = [":servicemesh_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1alpha2/BUILD.bazel b/google/cloud/gkehub/v1alpha2/BUILD.bazel index 6998f0543..5a02675bf 100644 --- a/google/cloud/gkehub/v1alpha2/BUILD.bazel +++ b/google/cloud/gkehub/v1alpha2/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":gkehub_proto_with_info"], gapic_yaml = None, grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha2.yaml", test_deps = [ ":gkehub_java_grpc", @@ -131,13 +132,14 @@ go_gapic_library( grpc_service_config = "membership_grpc_service_config.json", importpath = "cloud.google.com/go/gkehub/apiv1alpha2;gkehub", metadata = True, + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha2.yaml", transport = "grpc+rest", deps = [ ":gkehub_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -174,6 +176,7 @@ py_gapic_library( srcs = [":gkehub_proto"], grpc_service_config = "membership_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-gke-hub"], + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( name = "gkehub_php_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha2.yaml", + transport = "grpc+rest", deps = [ ":gkehub_php_grpc", ":gkehub_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "membership_grpc_service_config.json", package = "google.cloud.gkehub.v1alpha2", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha2.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( srcs = [":gkehub_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-gkehub-v1alpha2"], grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":gkehub_ruby_grpc", ":gkehub_ruby_proto", @@ -336,6 +344,7 @@ csharp_gapic_library( srcs = [":gkehub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1alpha2.yaml", deps = [ ":gkehub_csharp_grpc", diff --git a/google/cloud/gkehub/v1beta/BUILD.bazel b/google/cloud/gkehub/v1beta/BUILD.bazel index 00a9f612c..e5abea52a 100644 --- a/google/cloud/gkehub/v1beta/BUILD.bazel +++ b/google/cloud/gkehub/v1beta/BUILD.bazel @@ -85,6 +85,7 @@ java_gapic_library( name = "gkehub_java_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "v1beta_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":gkehub_java_grpc", ] + _JAVA_GRPC_SUBPACKAGE_DEPS, @@ -146,13 +147,14 @@ go_gapic_library( grpc_service_config = "v1beta_grpc_service_config.json", importpath = "cloud.google.com/go/gkehub/apiv1beta;gkehub", metadata = True, + rest_numeric_enums = True, service_yaml = "gkehub_v1beta.yaml", transport = "grpc+rest", deps = [ ":gkehub_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -190,6 +192,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-gke-hub", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -241,7 +244,9 @@ php_gapic_library( name = "gkehub_php_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "v1beta_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta.yaml", + transport = "grpc+rest", deps = [ ":gkehub_php_grpc", ":gkehub_php_proto", @@ -274,7 +279,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "v1beta_grpc_service_config.json", package = "google.cloud.gkehub.v1beta", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -322,6 +329,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/anthos/clusters/docs", ], grpc_service_config = "v1beta_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The GKE Hub API centrally manages features and services on all your Kubernetes clusters running in a variety of environments, including Google cloud, on premises in customer datacenters, or other third party clouds.", ruby_cloud_title = "GKE Hub V1beta", deps = [ @@ -367,6 +375,7 @@ csharp_gapic_library( srcs = [":gkehub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "v1beta_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta.yaml", deps = [ ":gkehub_csharp_grpc", diff --git a/google/cloud/gkehub/v1beta/configmanagement/BUILD.bazel b/google/cloud/gkehub/v1beta/configmanagement/BUILD.bazel index 69dea50b3..258c2e158 100644 --- a/google/cloud/gkehub/v1beta/configmanagement/BUILD.bazel +++ b/google/cloud/gkehub/v1beta/configmanagement/BUILD.bazel @@ -68,6 +68,7 @@ load( py_gapic_library( name = "configmanagement_py_gapic", srcs = [":configmanagement_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1beta/metering/BUILD.bazel b/google/cloud/gkehub/v1beta/metering/BUILD.bazel index d10ba2b56..d248817d0 100644 --- a/google/cloud/gkehub/v1beta/metering/BUILD.bazel +++ b/google/cloud/gkehub/v1beta/metering/BUILD.bazel @@ -68,6 +68,7 @@ load( py_gapic_library( name = "metering_py_gapic", srcs = [":metering_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1beta/multiclusteringress/BUILD.bazel b/google/cloud/gkehub/v1beta/multiclusteringress/BUILD.bazel index c6e56548a..38d2159b5 100644 --- a/google/cloud/gkehub/v1beta/multiclusteringress/BUILD.bazel +++ b/google/cloud/gkehub/v1beta/multiclusteringress/BUILD.bazel @@ -67,6 +67,7 @@ load( py_gapic_library( name = "multiclusteringress_py_gapic", srcs = [":multiclusteringress_proto"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/cloud/gkehub/v1beta1/BUILD.bazel b/google/cloud/gkehub/v1beta1/BUILD.bazel index 56916a01f..4489a6560 100644 --- a/google/cloud/gkehub/v1beta1/BUILD.bazel +++ b/google/cloud/gkehub/v1beta1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":gkehub_proto_with_info"], gapic_yaml = "memberships_gapic.yaml", grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", test_deps = [ ":gkehub_java_grpc", @@ -143,6 +144,7 @@ go_gapic_library( grpc_service_config = "membership_grpc_service_config.json", importpath = "cloud.google.com/go/gkehub/apiv1beta1;gkehub", metadata = True, + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -150,8 +152,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -188,6 +190,7 @@ py_gapic_library( srcs = [":gkehub_proto"], grpc_service_config = "membership_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-gke-hub"], + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", transport = "grpc", deps = [ @@ -239,7 +242,9 @@ php_gapic_library( name = "gkehub_php_gapic", srcs = [":gkehub_proto_with_info"], grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":gkehub_php_grpc", ":gkehub_php_proto", @@ -272,7 +277,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "membership_grpc_service_config.json", package = "google.cloud.gkehub.v1beta1", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -317,6 +324,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/anthos/clusters/docs", ], grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The GKE Hub API centrally manages features and services on all your Kubernetes clusters running in a variety of environments, including Google cloud, on premises in customer datacenters, or other third party clouds.", ruby_cloud_title = "GKE Hub V1beta1", service_yaml = "gkehub_v1beta1.yaml", @@ -363,6 +371,7 @@ csharp_gapic_library( srcs = [":gkehub_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "membership_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gkehub_v1beta1.yaml", deps = [ ":gkehub_csharp_grpc", diff --git a/google/cloud/gkemulticloud/v1/BUILD.bazel b/google/cloud/gkemulticloud/v1/BUILD.bazel index 6addb85a6..3ae5af72c 100644 --- a/google/cloud/gkemulticloud/v1/BUILD.bazel +++ b/google/cloud/gkemulticloud/v1/BUILD.bazel @@ -74,6 +74,7 @@ java_gapic_library( srcs = [":gkemulticloud_proto_with_info"], gapic_yaml = None, grpc_service_config = "gkemulticloud_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", test_deps = [ ":gkemulticloud_java_grpc", @@ -137,13 +138,14 @@ go_gapic_library( grpc_service_config = "gkemulticloud_grpc_service_config.json", importpath = "cloud.google.com/go/gkemulticloud/apiv1;gkemulticloud", metadata = True, + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":gkemulticloud_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -184,8 +186,9 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=gke_multicloud", ], + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", - transport = "grpc+rest", + transport = "grpc", ) py_test( @@ -232,7 +235,9 @@ php_gapic_library( name = "gkemulticloud_php_gapic", srcs = [":gkemulticloud_proto_with_info"], grpc_service_config = "gkemulticloud_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", + transport = "grpc+rest", deps = [ ":gkemulticloud_php_grpc", ":gkemulticloud_php_proto", @@ -265,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "gkemulticloud_grpc_service_config.json", package = "google.cloud.gkemulticloud.v1", + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", + transport = "grpc", deps = [], ) @@ -309,6 +316,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/anthos/clusters/docs/multi-cloud", ], grpc_service_config = "gkemulticloud_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "Anthos Multi-Cloud provides a way to manage Kubernetes clusters that run on AWS and Azure infrastructure using the Anthos Multi-Cloud API. Combined with Connect, you can manage Kubernetes clusters on Google Cloud, AWS, and Azure from the Google Cloud Console.", ruby_cloud_title = "Anthos Multi-Cloud V1", deps = [ @@ -354,6 +362,7 @@ csharp_gapic_library( srcs = [":gkemulticloud_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "gkemulticloud_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "gkemulticloud_v1.yaml", deps = [ ":gkemulticloud_csharp_grpc", diff --git a/google/cloud/gsuiteaddons/v1/BUILD.bazel b/google/cloud/gsuiteaddons/v1/BUILD.bazel index 82f5aba24..cc36609de 100644 --- a/google/cloud/gsuiteaddons/v1/BUILD.bazel +++ b/google/cloud/gsuiteaddons/v1/BUILD.bazel @@ -92,6 +92,7 @@ java_gapic_library( name = "gsuiteaddons_java_gapic", srcs = [":gsuiteaddons_proto_with_info"], grpc_service_config = "gsuiteaddons_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":gsuiteaddons_java_grpc", ], @@ -145,6 +146,7 @@ go_gapic_library( srcs = [":gsuiteaddons_proto_with_info"], grpc_service_config = "gsuiteaddons_grpc_service_config.json", importpath = "cloud.google.com/go/gsuiteaddons/apiv1;gsuiteaddons", + rest_numeric_enums = True, service_yaml = "gsuiteaddons_v1.yaml", transport = "grpc+rest", deps = [ @@ -176,20 +178,16 @@ py_gapic_library( name = "gsuiteaddons_py_gapic", srcs = [":gsuiteaddons_proto"], grpc_service_config = "gsuiteaddons_grpc_service_config.json", - opt_args = [ - "warehouse-package-name=google-cloud-workspace-add-ons", - "python-gapic-namespace=google.cloud", - "python-gapic-name=workspace_add_ons", - ], + rest_numeric_enums = True, transport = "grpc", deps = [ - "//google/apps/script/type:type_py_original_proto", - "//google/apps/script/type/calendar:calendar_py_original_proto", - "//google/apps/script/type/docs:docs_py_original_proto", - "//google/apps/script/type/drive:drive_py_original_proto", - "//google/apps/script/type/gmail:gmail_py_original_proto", - "//google/apps/script/type/sheets:sheets_py_original_proto", - "//google/apps/script/type/slides:slides_py_original_proto", + "//google/apps/script/type:type_py_proto", + "//google/apps/script/type/calendar:calendar_py_proto", + "//google/apps/script/type/docs:docs_py_proto", + "//google/apps/script/type/drive:drive_py_proto", + "//google/apps/script/type/gmail:gmail_py_proto", + "//google/apps/script/type/sheets:sheets_py_proto", + "//google/apps/script/type/slides:slides_py_proto", ], ) @@ -205,7 +203,7 @@ py_test( # Open Source Packages py_gapic_assembly_pkg( - name = "google-cloud-workspace-add-ons-v1-py", + name = "gsuiteaddons-v1-py", deps = [ ":gsuiteaddons_py_gapic", ], @@ -226,6 +224,8 @@ php_gapic_library( name = "gsuiteaddons_php_gapic", srcs = [":gsuiteaddons_proto_with_info"], grpc_service_config = "gsuiteaddons_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":gsuiteaddons_php_grpc", ":gsuiteaddons_php_proto", @@ -249,7 +249,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "gsuiteaddons_grpc_service_config.json", package = "google.cloud.gsuiteaddons.v1", + rest_numeric_enums = True, service_yaml = "gsuiteaddons_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +295,7 @@ ruby_cloud_gapic_library( "ruby-cloud-path-override=g_suite_add_ons=gsuite_add_ons", ], grpc_service_config = "gsuiteaddons_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Add-ons are customized applications that integrate with Google Workspace productivity applications.", ruby_cloud_title = "Google Workspace Add-ons V1", deps = [ @@ -327,6 +330,7 @@ csharp_gapic_library( srcs = [":gsuiteaddons_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "gsuiteaddons_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "gsuiteaddons_v1.yaml", deps = [ ":gsuiteaddons_csharp_grpc", diff --git a/google/cloud/iap/v1/BUILD.bazel b/google/cloud/iap/v1/BUILD.bazel index 576c39863..7b5a15b91 100644 --- a/google/cloud/iap/v1/BUILD.bazel +++ b/google/cloud/iap/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":iap_proto_with_info"], gapic_yaml = None, grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iap_v1.yaml", test_deps = [ ":iap_java_grpc", @@ -138,6 +139,7 @@ go_gapic_library( grpc_service_config = "iap_grpc_service_config.json", importpath = "cloud.google.com/go/iap/apiv1;iap", metadata = True, + rest_numeric_enums = True, service_yaml = "iap_v1.yaml", transport = "grpc+rest", deps = [ @@ -179,6 +181,7 @@ py_gapic_library( name = "iap_py_gapic", srcs = [":iap_proto"], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -229,7 +232,9 @@ php_gapic_library( name = "iap_php_gapic", srcs = [":iap_proto_with_info"], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iap_v1.yaml", + transport = "grpc+rest", deps = [ ":iap_php_grpc", ":iap_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iap_grpc_service_config.json", package = "google.cloud.iap.v1", + rest_numeric_enums = True, service_yaml = "iap_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/iap/", ], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "IAP lets you establish a central authorization layer for applications accessed by HTTPS, so you can use an application-level access control model instead of relying on network-level firewalls.", ruby_cloud_title = "Identity-Aware Proxy V1", deps = [ @@ -352,6 +360,7 @@ csharp_gapic_library( srcs = [":iap_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iap_v1.yaml", deps = [ ":iap_csharp_grpc", diff --git a/google/cloud/iap/v1beta1/BUILD.bazel b/google/cloud/iap/v1beta1/BUILD.bazel index 8b6e7d9d9..70ec434fe 100644 --- a/google/cloud/iap/v1beta1/BUILD.bazel +++ b/google/cloud/iap/v1beta1/BUILD.bazel @@ -66,6 +66,7 @@ java_gapic_library( name = "iap_java_gapic", srcs = [":iap_proto_with_info"], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":iap_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -127,6 +128,7 @@ go_gapic_library( grpc_service_config = "iap_grpc_service_config.json", importpath = "cloud.google.com/go/iap/apiv1beta1;iap", metadata = True, + rest_numeric_enums = True, service_yaml = "iap_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -167,6 +169,7 @@ py_gapic_library( name = "iap_py_gapic", srcs = [":iap_proto"], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -217,7 +220,9 @@ php_gapic_library( name = "iap_php_gapic", srcs = [":iap_proto_with_info"], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iap_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":iap_php_grpc", ":iap_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iap_grpc_service_config.json", package = "google.cloud.iap.v1beta1", + rest_numeric_enums = True, service_yaml = "iap_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=iap", ], grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "IAP lets you establish a central authorization layer for applications accessed by HTTPS, so you can use an application-level access control model instead of relying on network-level firewalls.", ruby_cloud_title = "Identity-Aware Proxy V1beta1", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":iap_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iap_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iap_v1beta1.yaml", deps = [ ":iap_csharp_grpc", diff --git a/google/cloud/identitytoolkit/v2/BUILD.bazel b/google/cloud/identitytoolkit/v2/BUILD.bazel index a030132ae..55c30fb43 100644 --- a/google/cloud/identitytoolkit/v2/BUILD.bazel +++ b/google/cloud/identitytoolkit/v2/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( srcs = [":identitytoolkit_proto_with_info"], gapic_yaml = None, grpc_service_config = "identitytoolkit_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "identitytoolkit_v2.yaml", test_deps = [ ":identitytoolkit_java_grpc", @@ -131,6 +132,7 @@ go_gapic_library( grpc_service_config = "identitytoolkit_grpc_service_config.json", importpath = "cloud.google.com/go/identitytoolkit/apiv2;identitytoolkit", metadata = True, + rest_numeric_enums = True, service_yaml = "identitytoolkit_v2.yaml", transport = "grpc+rest", deps = [ @@ -175,6 +177,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=identity_toolkit", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -222,7 +225,9 @@ php_gapic_library( name = "identitytoolkit_php_gapic", srcs = [":identitytoolkit_proto_with_info"], grpc_service_config = "identitytoolkit_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "identitytoolkit_v2.yaml", + transport = "grpc+rest", deps = [ ":identitytoolkit_php_grpc", ":identitytoolkit_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "identitytoolkit_grpc_service_config.json", package = "google.cloud.identitytoolkit.v2", + rest_numeric_enums = True, service_yaml = "identitytoolkit_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -299,6 +306,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/identity-platform/docs/reference/rest", ], grpc_service_config = "identitytoolkit_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", ruby_cloud_title = "Identity Platform V2", deps = [ @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":identitytoolkit_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "identitytoolkit_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "identitytoolkit_v2.yaml", deps = [ ":identitytoolkit_csharp_grpc", diff --git a/google/cloud/identitytoolkit/v2/account_management_service.proto b/google/cloud/identitytoolkit/v2/account_management_service.proto index 62118b1ed..45ba7dfb6 100644 --- a/google/cloud/identitytoolkit/v2/account_management_service.proto +++ b/google/cloud/identitytoolkit/v2/account_management_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. @@ -17,9 +17,9 @@ syntax = "proto3"; package google.cloud.identitytoolkit.v2; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/cloud/identitytoolkit/v2/mfa_info.proto"; -import "google/api/client.proto"; option csharp_namespace = "Google.Cloud.IdentityToolkit.V2"; option go_package = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/v2;identitytoolkit"; @@ -89,6 +89,7 @@ message FinalizeMfaEnrollmentResponse { // MFA verified enrollment information. oneof auxiliary_auth_info { + // Auxiliary auth info specific to phone auth. FinalizeMfaPhoneResponseInfo phone_auth_info = 3; } } diff --git a/google/cloud/identitytoolkit/v2/authentication_service.proto b/google/cloud/identitytoolkit/v2/authentication_service.proto index af3f9371a..06d161b07 100644 --- a/google/cloud/identitytoolkit/v2/authentication_service.proto +++ b/google/cloud/identitytoolkit/v2/authentication_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. @@ -17,9 +17,9 @@ syntax = "proto3"; package google.cloud.identitytoolkit.v2; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/cloud/identitytoolkit/v2/mfa_info.proto"; -import "google/api/client.proto"; option csharp_namespace = "Google.Cloud.IdentityToolkit.V2"; option go_package = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/v2;identitytoolkit"; diff --git a/google/cloud/identitytoolkit/v2/mfa_info.proto b/google/cloud/identitytoolkit/v2/mfa_info.proto index ff9502f90..0c1be801f 100644 --- a/google/cloud/identitytoolkit/v2/mfa_info.proto +++ b/google/cloud/identitytoolkit/v2/mfa_info.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. diff --git a/google/cloud/ids/v1/BUILD.bazel b/google/cloud/ids/v1/BUILD.bazel index 654ac22e3..ac02e306a 100644 --- a/google/cloud/ids/v1/BUILD.bazel +++ b/google/cloud/ids/v1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":ids_proto_with_info"], gapic_yaml = "ids_gapic.yaml", grpc_service_config = "ids_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "ids_v1.yaml", test_deps = [ ":ids_java_grpc", @@ -131,13 +132,14 @@ go_gapic_library( grpc_service_config = "ids_grpc_service_config.json", importpath = "cloud.google.com/go/ids/apiv1;ids", metadata = True, + rest_numeric_enums = True, service_yaml = "ids_v1.yaml", transport = "grpc+rest", deps = [ ":ids_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -173,6 +175,7 @@ py_gapic_library( name = "ids_py_gapic", srcs = [":ids_proto"], grpc_service_config = "ids_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( srcs = [":ids_proto_with_info"], gapic_yaml = "ids_gapic.yaml", grpc_service_config = "ids_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "ids_v1.yaml", + transport = "grpc+rest", deps = [ ":ids_php_grpc", ":ids_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "ids_grpc_service_config.json", package = "google.cloud.ids.v1", + rest_numeric_enums = True, service_yaml = "ids_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -299,6 +306,7 @@ ruby_cloud_gapic_library( "ruby-cloud-namespace-override=Ids=IDS", ], grpc_service_config = "ids_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud IDS is an intrusion detection service that provides threat detection for intrusions, malware, spyware, and command-and-control attacks on your network. Cloud IDS works by creating a Google-managed peered network with mirrored VMs. Traffic in the peered network is mirrored, and then inspected by Palo Alto Networks threat protection technologies to provide advanced threat detection. You can mirror all traffic or you can mirror filtered traffic, based on protocol, IP address range, or ingress and egress.", ruby_cloud_title = "Cloud IDS V1", deps = [ @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":ids_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "ids_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "ids_v1.yaml", deps = [ ":ids_csharp_grpc", diff --git a/google/cloud/iot/v1/BUILD.bazel b/google/cloud/iot/v1/BUILD.bazel index 49be129d6..f7588bf14 100644 --- a/google/cloud/iot/v1/BUILD.bazel +++ b/google/cloud/iot/v1/BUILD.bazel @@ -64,6 +64,7 @@ java_gapic_library( name = "iot_java_gapic", srcs = [":iot_proto_with_info"], grpc_service_config = "cloudiot_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":iot_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -125,6 +126,7 @@ go_gapic_library( srcs = [":iot_proto_with_info"], grpc_service_config = "cloudiot_grpc_service_config.json", importpath = "cloud.google.com/go/iot/apiv1;iot", + rest_numeric_enums = True, service_yaml = "cloudiot_v1.yaml", transport = "grpc+rest", deps = [ @@ -164,6 +166,7 @@ py_gapic_library( name = "iot_py_gapic", srcs = [":iot_proto"], grpc_service_config = "cloudiot_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -213,6 +216,8 @@ php_gapic_library( name = "iot_php_gapic", srcs = [":iot_proto_with_info"], grpc_service_config = "cloudiot_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":iot_php_grpc", ":iot_php_proto", @@ -246,7 +251,9 @@ nodejs_gapic_library( grpc_service_config = "cloudiot_grpc_service_config.json", main_service = "iot", package = "google.cloud.iot.v1", + rest_numeric_enums = True, service_yaml = "cloudiot_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -291,6 +298,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudiot", ], grpc_service_config = "cloudiot_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.", ruby_cloud_title = "Cloud IoT V1", deps = [ @@ -336,6 +344,7 @@ csharp_gapic_library( srcs = [":iot_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudiot_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudiot_v1.yaml", deps = [ ":iot_csharp_grpc", diff --git a/google/cloud/kms/v1/BUILD.bazel b/google/cloud/kms/v1/BUILD.bazel index f3424cd00..bb95c8604 100644 --- a/google/cloud/kms/v1/BUILD.bazel +++ b/google/cloud/kms/v1/BUILD.bazel @@ -37,6 +37,7 @@ proto_library_with_info( deps = [ ":kms_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", "//google/iam/v1:iam_policy_proto", "//google/iam/v1:policy_proto", ], @@ -71,14 +72,17 @@ java_gapic_library( name = "kms_java_gapic", srcs = [":kms_proto_with_info"], grpc_service_config = "cloudkms_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudkms_v1.yaml", test_deps = [ ":kms_java_grpc", + "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], transport = "grpc+rest", deps = [ ":kms_java_proto", + "//google/cloud/location:location_java_proto", "//google/iam/v1:iam_java_proto", ], ) @@ -134,10 +138,12 @@ go_gapic_library( srcs = [":kms_proto_with_info"], grpc_service_config = "cloudkms_grpc_service_config.json", importpath = "cloud.google.com/go/kms/apiv1;kms", + rest_numeric_enums = True, service_yaml = "cloudkms_v1.yaml", transport = "grpc+rest", deps = [ ":kms_go_proto", + "//google/cloud/location:location_go_proto", "//google/iam/v1:iam_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], @@ -177,6 +183,7 @@ py_gapic_library( srcs = [":kms_proto"], grpc_service_config = "cloudkms_grpc_service_config.json", opt_args = ["add-iam-methods"], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -228,7 +235,9 @@ php_grpc_library( php_gapic_library( name = "kms_php_gapic", srcs = [":kms_proto_with_info"], + rest_numeric_enums = True, service_yaml = "cloudkms_v1.yaml", + transport = "grpc+rest", deps = [ ":kms_php_grpc", ":kms_php_proto", @@ -263,7 +272,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudkms_grpc_service_config.json", package = "google.cloud.kms.v1", + rest_numeric_enums = True, service_yaml = "cloudkms_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,14 +316,15 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-kms-v1", "ruby-cloud-env-prefix=KMS", - "ruby-cloud-common-services=google.iam.v1.IAMPolicy=google.cloud.kms.v1.KeyManagementService", "ruby-cloud-product-url=https://cloud.google.com/kms", "ruby-cloud-api-id=cloudkms.googleapis.com", "ruby-cloud-api-shortname=cloudkms", ], grpc_service_config = "cloudkms_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.", ruby_cloud_title = "Cloud Key Management Service (KMS) V1", + service_yaml = "cloudkms_v1.yaml", deps = [ ":kms_ruby_grpc", ":kms_ruby_proto", @@ -358,6 +370,7 @@ csharp_gapic_library( srcs = [":kms_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudkms_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudkms_v1.yaml", deps = [ ":kms_csharp_grpc", diff --git a/google/cloud/kms/v1/cloudkms_v1.yaml b/google/cloud/kms/v1/cloudkms_v1.yaml index 416dcaf26..1352bbcff 100644 --- a/google/cloud/kms/v1/cloudkms_v1.yaml +++ b/google/cloud/kms/v1/cloudkms_v1.yaml @@ -6,6 +6,7 @@ title: Cloud Key Management Service (KMS) API apis: - name: google.cloud.kms.v1.EkmService - name: google.cloud.kms.v1.KeyManagementService +- name: google.cloud.location.Locations - name: google.iam.v1.IAMPolicy types: @@ -56,6 +57,7 @@ http: additional_bindings: - get: '/v1/{resource=projects/*/locations/*/keyRings/*/cryptoKeys/*}:getIamPolicy' - get: '/v1/{resource=projects/*/locations/*/keyRings/*/importJobs/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/ekmConfig}:getIamPolicy' - get: '/v1/{resource=projects/*/locations/*/ekmConnections/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1/{resource=projects/*/locations/*/keyRings/*}:setIamPolicy' @@ -65,6 +67,8 @@ http: body: '*' - post: '/v1/{resource=projects/*/locations/*/keyRings/*/importJobs/*}:setIamPolicy' body: '*' + - post: '/v1/{resource=projects/*/locations/*/ekmConfig}:setIamPolicy' + body: '*' - post: '/v1/{resource=projects/*/locations/*/ekmConnections/*}:setIamPolicy' body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions @@ -75,6 +79,8 @@ http: body: '*' - post: '/v1/{resource=projects/*/locations/*/keyRings/*/importJobs/*}:testIamPermissions' body: '*' + - post: '/v1/{resource=projects/*/locations/*/ekmConfig}:testIamPermissions' + body: '*' - post: '/v1/{resource=projects/*/locations/*/ekmConnections/*}:testIamPermissions' body: '*' diff --git a/google/cloud/kms/v1/ekm_service.proto b/google/cloud/kms/v1/ekm_service.proto index de8669dbf..c179d4a6c 100644 --- a/google/cloud/kms/v1/ekm_service.proto +++ b/google/cloud/kms/v1/ekm_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. @@ -85,7 +85,8 @@ service EkmService { } } -// Request message for [KeyManagementService.ListEkmConnections][]. +// Request message for +// [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections]. message ListEkmConnectionsRequest { // Required. The resource name of the location associated with the // [EkmConnections][google.cloud.kms.v1.EkmConnection] to list, in the format @@ -123,7 +124,8 @@ message ListEkmConnectionsRequest { string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [KeyManagementService.ListEkmConnections][]. +// Response message for +// [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections]. message ListEkmConnectionsResponse { // The list of [EkmConnections][google.cloud.kms.v1.EkmConnection]. repeated EkmConnection ekm_connections = 1; @@ -138,7 +140,8 @@ message ListEkmConnectionsResponse { int32 total_size = 3; } -// Request message for [KeyManagementService.GetEkmConnection][]. +// Request message for +// [EkmService.GetEkmConnection][google.cloud.kms.v1.EkmService.GetEkmConnection]. message GetEkmConnectionRequest { // Required. The [name][google.cloud.kms.v1.EkmConnection.name] of the // [EkmConnection][google.cloud.kms.v1.EkmConnection] to get. @@ -150,7 +153,8 @@ message GetEkmConnectionRequest { ]; } -// Request message for [KeyManagementService.CreateEkmConnection][]. +// Request message for +// [EkmService.CreateEkmConnection][google.cloud.kms.v1.EkmService.CreateEkmConnection]. message CreateEkmConnectionRequest { // Required. The resource name of the location associated with the // [EkmConnection][google.cloud.kms.v1.EkmConnection], in the format @@ -171,7 +175,8 @@ message CreateEkmConnectionRequest { EkmConnection ekm_connection = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [KeyManagementService.UpdateEkmConnection][]. +// Request message for +// [EkmService.UpdateEkmConnection][google.cloud.kms.v1.EkmService.UpdateEkmConnection]. message UpdateEkmConnectionRequest { // Required. [EkmConnection][google.cloud.kms.v1.EkmConnection] with updated // values. @@ -263,7 +268,8 @@ message EkmConnection { string hostname = 3 [(google.api.field_behavior) = REQUIRED]; // Required. A list of leaf server certificates used to authenticate HTTPS - // connections to the EKM replica. + // connections to the EKM replica. Currently, a maximum of 10 + // [Certificate][google.cloud.kms.v1.Certificate] is supported. repeated Certificate server_certificates = 4 [(google.api.field_behavior) = REQUIRED]; } @@ -286,8 +292,7 @@ message EkmConnection { // supported. repeated ServiceResolver service_resolvers = 3; - // This checksum is computed by the server based on the value of other fields, - // and may be sent on update requests to ensure the client has an up-to-date - // value before proceeding. - string etag = 5; + // Optional. Etag of the currently stored + // [EkmConnection][google.cloud.kms.v1.EkmConnection]. + string etag = 5 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/google/cloud/kms/v1/resources.proto b/google/cloud/kms/v1/resources.proto index 5029f3e03..fa89122c8 100644 --- a/google/cloud/kms/v1/resources.proto +++ b/google/cloud/kms/v1/resources.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. @@ -235,6 +235,9 @@ message KeyOperationAttestation { // Cavium HSM attestation compressed with gzip. Note that this format is // defined by Cavium and subject to change at any time. + // + // See + // https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. CAVIUM_V1_COMPRESSED = 3; // Cavium HSM attestation V2 compressed with gzip. This is a new format @@ -403,6 +406,18 @@ message CryptoKeyVersion { // HMAC-SHA256 signing with a 256 bit key. HMAC_SHA256 = 32; + // HMAC-SHA1 signing with a 160 bit key. + HMAC_SHA1 = 33; + + // HMAC-SHA384 signing with a 384 bit key. + HMAC_SHA384 = 34; + + // HMAC-SHA512 signing with a 512 bit key. + HMAC_SHA512 = 35; + + // HMAC-SHA224 signing with a 224 bit key. + HMAC_SHA224 = 36; + // Algorithm representing symmetric encryption by an external key manager. EXTERNAL_SYMMETRIC_ENCRYPTION = 18; } @@ -676,6 +691,34 @@ message ImportJob { // [RSA AES key wrap // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). RSA_OAEP_4096_SHA1_AES_256 = 2; + + // This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping + // scheme defined in the PKCS #11 standard. In summary, this involves + // wrapping the raw key with an ephemeral AES key, and wrapping the + // ephemeral AES key with a 3072 bit RSA key. For more details, see + // [RSA AES key wrap + // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). + RSA_OAEP_3072_SHA256_AES_256 = 3; + + // This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping + // scheme defined in the PKCS #11 standard. In summary, this involves + // wrapping the raw key with an ephemeral AES key, and wrapping the + // ephemeral AES key with a 4096 bit RSA key. For more details, see + // [RSA AES key wrap + // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). + RSA_OAEP_4096_SHA256_AES_256 = 4; + + // This ImportMethod represents RSAES-OAEP with a 3072 bit RSA key. The + // key material to be imported is wrapped directly with the RSA key. Due + // to technical limitations of RSA wrapping, this method cannot be used to + // wrap RSA keys for import. + RSA_OAEP_3072_SHA256 = 5; + + // This ImportMethod represents RSAES-OAEP with a 4096 bit RSA key. The + // key material to be imported is wrapped directly with the RSA key. Due + // to technical limitations of RSA wrapping, this method cannot be used to + // wrap RSA keys for import. + RSA_OAEP_4096_SHA256 = 6; } // The state of the [ImportJob][google.cloud.kms.v1.ImportJob], indicating if diff --git a/google/cloud/kms/v1/service.proto b/google/cloud/kms/v1/service.proto index 565678da3..938f1e255 100644 --- a/google/cloud/kms/v1/service.proto +++ b/google/cloud/kms/v1/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. @@ -797,33 +797,56 @@ message ImportCryptoKeyVersionRequest { // material. string import_job = 4 [(google.api.field_behavior) = REQUIRED]; - // Required. The incoming wrapped key material that is to be imported. + // Optional. The wrapped key material to import. + // + // Before wrapping, key material must be formatted. If importing symmetric key + // material, the expected key material format is plain bytes. If importing + // asymmetric key material, the expected key material format is PKCS#8-encoded + // DER (the PrivateKeyInfo structure from RFC 5208). + // + // When wrapping with import methods + // ([RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] + // or + // [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256] + // or + // [RSA_OAEP_3072_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256_AES_256] + // or + // [RSA_OAEP_4096_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA256_AES_256]), + // + // this field must contain the concatenation of: + //
    + //
  1. An ephemeral AES-256 wrapping key wrapped with the + // [public_key][google.cloud.kms.v1.ImportJob.public_key] using + // RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty + // label. + //
    2. + //
  2. The formatted key to be imported, wrapped with the ephemeral AES-256 + // key using AES-KWP (RFC 5649). + //
    3. + //
+ // + // This format is the same as the format produced by PKCS#11 mechanism + // CKM_RSA_AES_KEY_WRAP. + // + // When wrapping with import methods + // ([RSA_OAEP_3072_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256] + // or + // [RSA_OAEP_4096_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA256]), + // + // this field must contain the formatted key to be imported, wrapped with the + // [public_key][google.cloud.kms.v1.ImportJob.public_key] using RSAES-OAEP + // with SHA-256, MGF1 with SHA-256, and an empty label. + bytes wrapped_key = 8 [(google.api.field_behavior) = OPTIONAL]; + + // This field is legacy. Use the field + // [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.wrapped_key] + // instead. oneof wrapped_key_material { - // Wrapped key material produced with - // [RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] - // or - // [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256]. - // - // This field contains the concatenation of two wrapped keys: - //
    - //
  1. An ephemeral AES-256 wrapping key wrapped with the - // [public_key][google.cloud.kms.v1.ImportJob.public_key] using - // RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an - // empty label. - //
    2. - //
  2. The key to be imported, wrapped with the ephemeral AES-256 key - // using AES-KWP (RFC 5649). - //
    3. - //
- // - // If importing symmetric key material, it is expected that the unwrapped - // key contains plain bytes. If importing asymmetric key material, it is - // expected that the unwrapped key is in PKCS#8-encoded DER format (the - // PrivateKeyInfo structure from RFC 5208). - // - // This format is the same as the format produced by PKCS#11 mechanism - // CKM_RSA_AES_KEY_WRAP. - bytes rsa_aes_wrapped_key = 5; + // Optional. This field has the same meaning as + // [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.wrapped_key]. + // Prefer to use that field in new work. Either that field or this field + // (but not both) must be specified. + bytes rsa_aes_wrapped_key = 5 [(google.api.field_behavior) = OPTIONAL]; } } @@ -935,7 +958,9 @@ message EncryptRequest { // // The maximum size depends on the key version's // [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. - // For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the + // For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE], + // [EXTERNAL][google.cloud.kms.v1.ProtectionLevel.EXTERNAL], and + // [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] keys, the // plaintext must be no larger than 64KiB. For // [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of // the plaintext and additional_authenticated_data fields must be no larger @@ -948,8 +973,10 @@ message EncryptRequest { // // The maximum size depends on the key version's // [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level]. - // For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the AAD - // must be no larger than 64KiB. For + // For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE], + // [EXTERNAL][google.cloud.kms.v1.ProtectionLevel.EXTERNAL], and + // [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] keys the + // AAD must be no larger than 64KiB. For // [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of // the plaintext and additional_authenticated_data fields must be no larger // than 8KiB. diff --git a/google/cloud/language/v1/BUILD.bazel b/google/cloud/language/v1/BUILD.bazel index c0099cbe1..5c6e880df 100644 --- a/google/cloud/language/v1/BUILD.bazel +++ b/google/cloud/language/v1/BUILD.bazel @@ -66,7 +66,7 @@ java_gapic_library( srcs = [":language_proto_with_info"], gapic_yaml = None, grpc_service_config = "language_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", test_deps = [ ":language_java_grpc", @@ -127,7 +127,7 @@ go_gapic_library( grpc_service_config = "language_grpc_service_config.json", importpath = "cloud.google.com/go/language/apiv1;language", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", transport = "grpc+rest", deps = [ @@ -167,7 +167,7 @@ py_gapic_library( name = "language_py_gapic", srcs = [":language_proto"], grpc_service_config = "language_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", transport = "grpc", deps = [ @@ -218,8 +218,9 @@ php_gapic_library( name = "language_php_gapic", srcs = [":language_proto_with_info"], grpc_service_config = "language_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", + transport = "grpc+rest", deps = [ ":language_php_grpc", ":language_php_proto", @@ -252,8 +253,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "language_grpc_service_config.json", package = "google.cloud.language.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -298,7 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/natural-language", ], grpc_service_config = "language_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations.", ruby_cloud_title = "Natural Language V1", service_yaml = "language_v1.yaml", @@ -345,7 +347,7 @@ csharp_gapic_library( srcs = [":language_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "language_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "language_v1.yaml", deps = [ ":language_csharp_grpc", diff --git a/google/cloud/language/v1beta2/BUILD.bazel b/google/cloud/language/v1beta2/BUILD.bazel index 82038c354..cbd23c0f7 100644 --- a/google/cloud/language/v1beta2/BUILD.bazel +++ b/google/cloud/language/v1beta2/BUILD.bazel @@ -66,6 +66,7 @@ java_gapic_library( srcs = [":language_proto_with_info"], gapic_yaml = None, grpc_service_config = "language_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", test_deps = [ ":language_java_grpc", @@ -126,6 +127,7 @@ go_gapic_library( grpc_service_config = "language_grpc_service_config.json", importpath = "cloud.google.com/go/language/apiv1beta2;language", metadata = True, + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", transport = "grpc+rest", deps = [ @@ -165,8 +167,9 @@ py_gapic_library( name = "language_py_gapic", srcs = [":language_proto"], grpc_service_config = "language_grpc_service_config.json", - transport = "grpc", + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", + transport = "grpc", deps = [ ], ) @@ -215,7 +218,9 @@ php_gapic_library( name = "language_php_gapic", srcs = [":language_proto_with_info"], grpc_service_config = "language_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", + transport = "grpc+rest", deps = [ ":language_php_grpc", ":language_php_proto", @@ -248,7 +253,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "language_grpc_service_config.json", package = "google.cloud.language.v1beta2", + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/natural-language", ], grpc_service_config = "language_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations.", ruby_cloud_title = "Natural Language V1beta2", service_yaml = "language_v1beta2.yaml", @@ -339,6 +347,7 @@ csharp_gapic_library( srcs = [":language_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "language_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "language_v1beta2.yaml", deps = [ ":language_csharp_grpc", diff --git a/google/cloud/lifesciences/v2beta/BUILD.bazel b/google/cloud/lifesciences/v2beta/BUILD.bazel index 635232fd2..ce9b725f1 100644 --- a/google/cloud/lifesciences/v2beta/BUILD.bazel +++ b/google/cloud/lifesciences/v2beta/BUILD.bazel @@ -39,6 +39,7 @@ proto_library_with_info( deps = [ ":lifesciences_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -68,13 +69,19 @@ java_grpc_library( java_gapic_library( name = "lifesciences_java_gapic", srcs = [":lifesciences_proto_with_info"], + gapic_yaml = None, grpc_service_config = "lifesciences_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "lifesciences_v2beta.yaml", test_deps = [ ":lifesciences_java_grpc", + "//google/cloud/location:location_java_grpc", ], transport = "grpc+rest", deps = [ ":lifesciences_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) @@ -129,13 +136,15 @@ go_gapic_library( grpc_service_config = "lifesciences_grpc_service_config.json", importpath = "cloud.google.com/go/lifesciences/apiv2beta;lifesciences", metadata = True, + rest_numeric_enums = True, service_yaml = "lifesciences_v2beta.yaml", transport = "grpc+rest", deps = [ ":lifesciences_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -173,7 +182,11 @@ py_gapic_library( srcs = [":lifesciences_proto"], grpc_service_config = "lifesciences_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-life-sciences"], + rest_numeric_enums = True, + service_yaml = "lifesciences_v2beta.yaml", transport = "grpc+rest", + deps = [ + ], ) py_test( @@ -220,7 +233,9 @@ php_gapic_library( name = "lifesciences_php_gapic", srcs = [":lifesciences_proto_with_info"], grpc_service_config = "lifesciences_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "lifesciences_v2beta.yaml", + transport = "grpc+rest", deps = [ ":lifesciences_php_grpc", ":lifesciences_php_proto", @@ -253,7 +268,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "lifesciences_grpc_service_config.json", package = "google.cloud.lifesciences.v2beta", + rest_numeric_enums = True, service_yaml = "lifesciences_v2beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -291,16 +308,18 @@ ruby_cloud_gapic_library( name = "lifesciences_ruby_gapic", srcs = [":lifesciences_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-life_sciences-v2beta", - "ruby-cloud-env-prefix=LIFE_SCIENCES", - "ruby-cloud-product-url=https://cloud.google.com/life-sciences/", "ruby-cloud-api-id=lifesciences.googleapis.com", "ruby-cloud-api-shortname=lifesciences", + "ruby-cloud-env-prefix=LIFE_SCIENCES", + "ruby-cloud-gem-name=google-cloud-life_sciences-v2beta", + "ruby-cloud-product-url=https://cloud.google.com/life-sciences/", "ruby-cloud-service-override=WorkflowsServiceV2Beta=WorkflowsService", ], grpc_service_config = "lifesciences_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. It also enables advanced insights and operational workflows using highly scalable and compliant infrastructure.", ruby_cloud_title = "Cloud Life Sciences V2beta", + service_yaml = "lifesciences_v2beta.yaml", deps = [ ":lifesciences_ruby_grpc", ":lifesciences_ruby_proto", @@ -344,6 +363,7 @@ csharp_gapic_library( srcs = [":lifesciences_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "lifesciences_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "lifesciences_v2beta.yaml", deps = [ ":lifesciences_csharp_grpc", @@ -364,4 +384,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "lifesciences_cc_proto", + deps = [":lifesciences_proto"], +) + +cc_grpc_library( + name = "lifesciences_cc_grpc", + srcs = [":lifesciences_proto"], + grpc_only = True, + deps = [":lifesciences_cc_proto"], +) diff --git a/google/cloud/lifesciences/v2beta/lifesciences_v2beta.yaml b/google/cloud/lifesciences/v2beta/lifesciences_v2beta.yaml index c3b14c1a7..5f0c0f984 100644 --- a/google/cloud/lifesciences/v2beta/lifesciences_v2beta.yaml +++ b/google/cloud/lifesciences/v2beta/lifesciences_v2beta.yaml @@ -5,6 +5,8 @@ title: Cloud Life Sciences API apis: - name: google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta +- name: google.cloud.location.Locations +- name: google.longrunning.Operations types: - name: google.cloud.lifesciences.v2beta.ContainerKilledEvent diff --git a/google/cloud/lifesciences/v2beta/workflows.proto b/google/cloud/lifesciences/v2beta/workflows.proto index b69928ffa..2e9c576c6 100644 --- a/google/cloud/lifesciences/v2beta/workflows.proto +++ b/google/cloud/lifesciences/v2beta/workflows.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. @@ -17,12 +17,12 @@ syntax = "proto3"; package google.cloud.lifesciences.v2beta; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; import "google/rpc/code.proto"; -import "google/api/client.proto"; option csharp_namespace = "Google.Cloud.LifeSciences.V2Beta"; option go_package = "google.golang.org/genproto/googleapis/cloud/lifesciences/v2beta;lifesciences"; @@ -112,6 +112,15 @@ message Pipeline { // (though they can overwrite it with a different value). map environment = 3; + // The encrypted environment to pass into every action. Each action can also + // specify its own encrypted environment. + // + // The secret must decrypt to a JSON-encoded dictionary where key-value pairs + // serve as environment variable names and their values. The decoded + // environment variables can overwrite the values specified by the + // `environment` field. + Secret encrypted_environment = 5; + // The maximum amount of time to give the pipeline to complete. This includes // the time spent waiting for a worker to be allocated. If the pipeline fails // to complete before the timeout, it will be cancelled and the error code @@ -172,6 +181,17 @@ message Action { // authors to determine whether an individual action has succeeded or failed. map environment = 5; + // The encrypted environment to pass into the container. This environment is + // merged with values specified in the + // [google.cloud.lifesciences.v2beta.Pipeline][google.cloud.lifesciences.v2beta.Pipeline] message, overwriting any + // duplicate values. + // + // The secret must decrypt to a JSON-encoded dictionary where key-value pairs + // serve as environment variable names and their values. The decoded + // environment variables can overwrite the values specified by the + // `environment` field. + Secret encrypted_environment = 21; + // An optional identifier for a PID namespace to run the action inside. // Multiple actions should use the same string to share a namespace. If // unspecified, a separate isolated namespace is used. @@ -408,6 +428,10 @@ message VirtualMachine { // // Specify either the `volumes[]` field or the `disks[]` field, but not both. repeated Volume volumes = 14; + + // If specified, the VM will only be allocated inside the matching + // reservation. It will fail if the VM parameters don't match the reservation. + string reservation = 15; } // Carries information about a Google Cloud service account. diff --git a/google/cloud/location/BUILD.bazel b/google/cloud/location/BUILD.bazel index 6182d71f9..f345f8523 100644 --- a/google/cloud/location/BUILD.bazel +++ b/google/cloud/location/BUILD.bazel @@ -168,6 +168,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-location", ], + rest_numeric_enums = True, ruby_cloud_description = "An add-on interface used by some Google API clients to provide location management calls.", ruby_cloud_title = "Locations", deps = [ @@ -212,6 +213,7 @@ csharp_gapic_library( name = "location_csharp_gapic", srcs = [":location_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + rest_numeric_enums = True, deps = [ ":location_csharp_grpc", ":location_csharp_proto", diff --git a/google/cloud/managedidentities/v1/BUILD.bazel b/google/cloud/managedidentities/v1/BUILD.bazel index 38f60d112..04287a3d0 100644 --- a/google/cloud/managedidentities/v1/BUILD.bazel +++ b/google/cloud/managedidentities/v1/BUILD.bazel @@ -70,9 +70,11 @@ java_gapic_library( name = "managedidentities_java_gapic", srcs = [":managedidentities_proto_with_info"], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":managedidentities_java_grpc", ], + transport = "grpc", deps = [ ":managedidentities_java_proto", ], @@ -90,6 +92,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-managedidentities-v1-java", include_samples = True, + transport = "grpc", deps = [ ":managedidentities_java_gapic", ":managedidentities_java_grpc", @@ -125,13 +128,14 @@ go_gapic_library( srcs = [":managedidentities_proto_with_info"], grpc_service_config = "managedidentities_grpc_service_config.json", importpath = "cloud.google.com/go/managedidentities/apiv1;managedidentities", + rest_numeric_enums = True, service_yaml = "managedidentities_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":managedidentities_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -167,6 +171,7 @@ py_gapic_library( srcs = [":managedidentities_proto"], grpc_service_config = "managedidentities_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-managed-identities"], + rest_numeric_enums = True, transport = "grpc", ) @@ -214,7 +219,9 @@ php_gapic_library( name = "managedidentities_php_gapic", srcs = [":managedidentities_proto_with_info"], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "managedidentities_v1.yaml", + transport = "grpc+rest", deps = [ ":managedidentities_php_grpc", ":managedidentities_php_proto", @@ -247,7 +254,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "managedidentities_grpc_service_config.json", package = "google.cloud.managedidentities.v1", + rest_numeric_enums = True, service_yaml = "managedidentities_v1.yaml", + transport = "grpc", deps = [], ) @@ -292,6 +301,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=managedidentities", ], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory.", ruby_cloud_title = "Managed Service for Microsoft Active Directory API V1", deps = [ @@ -337,6 +347,7 @@ csharp_gapic_library( srcs = [":managedidentities_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "managedidentities_v1.yaml", deps = [ ":managedidentities_csharp_grpc", diff --git a/google/cloud/managedidentities/v1beta1/BUILD.bazel b/google/cloud/managedidentities/v1beta1/BUILD.bazel index a8c178326..263df98ee 100644 --- a/google/cloud/managedidentities/v1beta1/BUILD.bazel +++ b/google/cloud/managedidentities/v1beta1/BUILD.bazel @@ -71,10 +71,12 @@ java_gapic_library( srcs = [":managedidentities_proto_with_info"], gapic_yaml = "managedidentities_gapic.yaml", grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "managedidentities_v1beta1.yaml", test_deps = [ ":managedidentities_java_grpc", ], + transport = "grpc", deps = [ ":managedidentities_java_proto", "//google/api:api_java_proto", @@ -93,6 +95,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-managedidentities-v1beta1-java", include_samples = True, + transport = "grpc", deps = [ ":managedidentities_java_gapic", ":managedidentities_java_grpc", @@ -129,13 +132,14 @@ go_gapic_library( grpc_service_config = "managedidentities_grpc_service_config.json", importpath = "cloud.google.com/go/managedidentities/apiv1beta1;managedidentities", metadata = True, + rest_numeric_enums = True, service_yaml = "managedidentities_v1beta1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":managedidentities_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -171,6 +175,7 @@ py_gapic_library( name = "managedidentities_py_gapic", srcs = [":managedidentities_proto"], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -218,7 +223,9 @@ php_gapic_library( name = "managedidentities_php_gapic", srcs = [":managedidentities_proto_with_info"], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "managedidentities_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":managedidentities_php_grpc", ":managedidentities_php_proto", @@ -251,7 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "managedidentities_grpc_service_config.json", package = "google.cloud.managedidentities.v1beta1", + rest_numeric_enums = True, service_yaml = "managedidentities_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -290,6 +299,7 @@ ruby_cloud_gapic_library( srcs = [":managedidentities_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-managedidentities-v1beta1"], grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":managedidentities_ruby_grpc", ":managedidentities_ruby_proto", @@ -333,6 +343,7 @@ csharp_gapic_library( srcs = [":managedidentities_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "managedidentities_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "managedidentities_v1beta1.yaml", deps = [ ":managedidentities_csharp_grpc", diff --git a/google/cloud/mediatranslation/v1beta1/BUILD.bazel b/google/cloud/mediatranslation/v1beta1/BUILD.bazel index c208f3a5b..99b797d54 100644 --- a/google/cloud/mediatranslation/v1beta1/BUILD.bazel +++ b/google/cloud/mediatranslation/v1beta1/BUILD.bazel @@ -65,6 +65,7 @@ java_gapic_library( name = "mediatranslation_java_gapic", srcs = [":mediatranslation_proto_with_info"], grpc_service_config = "mediatranslation_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":mediatranslation_java_grpc", ], @@ -124,6 +125,8 @@ go_gapic_library( grpc_service_config = "mediatranslation_grpc_service_config.json", importpath = "cloud.google.com/go/mediatranslation/apiv1beta1;mediatranslation", metadata = True, + rest_numeric_enums = True, + transport = "grpc+rest", service_yaml = "mediatranslation_v1beta1.yaml", deps = [ ":mediatranslation_go_proto", @@ -165,6 +168,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-media-translation", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -212,7 +216,9 @@ php_gapic_library( name = "mediatranslation_php_gapic", srcs = [":mediatranslation_proto_with_info"], grpc_service_config = "mediatranslation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mediatranslation_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":mediatranslation_php_grpc", ":mediatranslation_php_proto", @@ -245,7 +251,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "mediatranslation_grpc_service_config.json", package = "google.cloud.mediatranslation.v1beta1", + rest_numeric_enums = True, service_yaml = "mediatranslation_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -290,6 +298,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/media-translation/", ], grpc_service_config = "mediatranslation_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Media Translation API delivers real-time speech translation to your content and applications directly from your audio data. Leveraging Google’s machine learning technologies, the API offers enhanced accuracy and simplified integration while equipping you with a comprehensive set of features to further refine your translation results. Improve user experience with low-latency streaming translation and scale quickly with straightforward internationalization.", ruby_cloud_title = "Media Translation V1beta1", deps = [ @@ -335,6 +344,7 @@ csharp_gapic_library( srcs = [":mediatranslation_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "mediatranslation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mediatranslation_v1beta1.yaml", deps = [ ":mediatranslation_csharp_grpc", diff --git a/google/cloud/memcache/v1/BUILD.bazel b/google/cloud/memcache/v1/BUILD.bazel index cdbb74486..d99a3c2de 100644 --- a/google/cloud/memcache/v1/BUILD.bazel +++ b/google/cloud/memcache/v1/BUILD.bazel @@ -1,5 +1,5 @@ # This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel +# 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: @@ -29,6 +29,9 @@ proto_library( "//google/api:field_behavior_proto", "//google/api:resource_proto", "//google/longrunning:operations_proto", + "//google/type:dayofweek_proto", + "//google/type:timeofday_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], @@ -39,6 +42,7 @@ proto_library_with_info( deps = [ ":memcache_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -68,19 +72,27 @@ java_grpc_library( java_gapic_library( name = "memcache_java_gapic", srcs = [":memcache_proto_with_info"], + gapic_yaml = None, grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "memcache_v1.yaml", test_deps = [ ":memcache_java_grpc", + "//google/cloud/location:location_java_grpc", ], transport = "grpc+rest", deps = [ ":memcache_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) java_gapic_test( name = "memcache_java_gapic_test_suite", test_classes = [ + "com.google.cloud.memcache.v1.CloudMemcacheClientHttpJsonTest", + "com.google.cloud.memcache.v1.CloudMemcacheClientTest", ], runtime_deps = [":memcache_java_gapic_test"], ) @@ -117,6 +129,8 @@ go_proto_library( deps = [ "//google/api:annotations_go_proto", "//google/longrunning:longrunning_go_proto", + "//google/type:dayofweek_go_proto", + "//google/type:timeofday_go_proto", ], ) @@ -125,13 +139,17 @@ go_gapic_library( srcs = [":memcache_proto_with_info"], grpc_service_config = "memcache_grpc_service_config.json", importpath = "cloud.google.com/go/memcache/apiv1;memcache", + metadata = True, + rest_numeric_enums = True, service_yaml = "memcache_v1.yaml", transport = "grpc+rest", deps = [ ":memcache_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -147,6 +165,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-memcache-v1-go", deps = [ ":memcache_go_gapic", + ":memcache_go_gapic_srcjar-metadata.srcjar", ":memcache_go_gapic_srcjar-test.srcjar", ":memcache_go_proto", ], @@ -166,7 +185,11 @@ py_gapic_library( name = "memcache_py_gapic", srcs = [":memcache_proto"], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "memcache_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -213,6 +236,9 @@ php_gapic_library( name = "memcache_php_gapic", srcs = [":memcache_proto_with_info"], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "memcache_v1.yaml", + transport = "grpc+rest", deps = [ ":memcache_php_grpc", ":memcache_php_proto", @@ -245,7 +271,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "memcache_grpc_service_config.json", package = "google.cloud.memcache.v1", + rest_numeric_enums = True, service_yaml = "memcache_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -283,15 +311,17 @@ ruby_cloud_gapic_library( name = "memcache_ruby_gapic", srcs = [":memcache_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-memcache-v1", - "ruby-cloud-env-prefix=MEMCACHE", - "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/memcached/", "ruby-cloud-api-id=memcache.googleapis.com", "ruby-cloud-api-shortname=memcache", + "ruby-cloud-env-prefix=MEMCACHE", + "ruby-cloud-gem-name=google-cloud-memcache-v1", + "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/memcached/", ], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", ruby_cloud_title = "Google Cloud Memorystore for Memcached V1", + service_yaml = "memcache_v1.yaml", deps = [ ":memcache_ruby_grpc", ":memcache_ruby_proto", @@ -335,6 +365,7 @@ csharp_gapic_library( srcs = [":memcache_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "memcache_v1.yaml", deps = [ ":memcache_csharp_grpc", diff --git a/google/cloud/memcache/v1/cloud_memcache.proto b/google/cloud/memcache/v1/cloud_memcache.proto index 308f05820..f1cca1231 100644 --- a/google/cloud/memcache/v1/cloud_memcache.proto +++ b/google/cloud/memcache/v1/cloud_memcache.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. @@ -21,8 +21,11 @@ import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/longrunning/operations.proto"; +import "google/protobuf/duration.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; +import "google/type/dayofweek.proto"; +import "google/type/timeofday.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/memcache/v1;memcache"; option java_multiple_files = true; @@ -90,9 +93,10 @@ service CloudMemcache { }; } - // Updates the defined Memcached Parameters for an existing Instance. + // Updates the defined Memcached parameters for an existing instance. // This method only stages the parameters, it must be followed by - // ApplyParameters to apply the parameters to nodes of the Memcached Instance. + // `ApplyParameters` to apply the parameters to nodes of the Memcached + // instance. rpc UpdateParameters(UpdateParametersRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{name=projects/*/locations/*/instances/*}:updateParameters" @@ -117,7 +121,7 @@ service CloudMemcache { }; } - // ApplyParameters will restart the set of specified nodes in order to update + // `ApplyParameters` restarts the set of specified nodes in order to update // them to the current set of parameters for the Memcached Instance. rpc ApplyParameters(ApplyParametersRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -130,14 +134,50 @@ service CloudMemcache { metadata_type: "google.cloud.memcache.v1.OperationMetadata" }; } + + // Reschedules upcoming maintenance event. + rpc RescheduleMaintenance(RescheduleMaintenanceRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{instance=projects/*/locations/*/instances/*}:rescheduleMaintenance" + body: "*" + }; + option (google.api.method_signature) = "instance, reschedule_type, schedule_time"; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.memcache.v1.Instance" + metadata_type: "google.cloud.memcache.v1.OperationMetadata" + }; + } } +// A Memorystore for Memcached instance message Instance { option (google.api.resource) = { type: "memcache.googleapis.com/Instance" pattern: "projects/{project}/locations/{location}/instances/{instance}" }; + // Different states of a Memcached instance. + enum State { + // State not set. + STATE_UNSPECIFIED = 0; + + // Memcached instance is being created. + CREATING = 1; + + // Memcached instance has been created and ready to be used. + READY = 2; + + // Memcached instance is updating configuration such as maintenance policy + // and schedule. + UPDATING = 3; + + // Memcached instance is being deleted. + DELETING = 4; + + // Memcached instance is going through maintenance, e.g. data plane rollout. + PERFORMING_MAINTENANCE = 5; + } + // Configuration for a Memcached Node. message NodeConfig { // Required. Number of cpus per Memcached node. @@ -203,35 +243,17 @@ message Instance { string message = 2; } - // Different states of a Memcached instance. - enum State { - // State not set. - STATE_UNSPECIFIED = 0; - - // Memcached instance is being created. - CREATING = 1; - - // Memcached instance has been created and ready to be used. - READY = 2; - - // Memcached instance is being deleted. - DELETING = 4; - - // Memcached instance is going through maintenance, e.g. data plane rollout. - PERFORMING_MAINTENANCE = 5; - } - // Required. Unique name of the resource in this scope including project and // location using the form: // `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // - // Note: Memcached instances are managed and addressed at regional level so - // location_id here refers to a GCP region; however, users may choose which - // zones Memcached nodes within an instances should be provisioned in. - // Refer to [zones] field for more details. + // Note: Memcached instances are managed and addressed at the regional level + // so `location_id` here refers to a Google Cloud region; however, users may + // choose which zones Memcached nodes should be provisioned in within an + // instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // User provided name for the instance only used for display + // User provided name for the instance, which is only used for display // purposes. Cannot be more than 80 characters. string display_name = 2; @@ -246,7 +268,7 @@ message Instance { // will be used. string authorized_network = 4; - // Zones where Memcached nodes should be provisioned in. + // Zones in which Memcached nodes should be provisioned. // Memcached nodes will be equally distributed across these zones. If not // provided, the service will by default create nodes in all zones in the // region for the instance. @@ -260,17 +282,17 @@ message Instance { // The major version of Memcached software. // If not provided, latest supported version will be used. Currently the - // latest supported major version is MEMCACHE_1_5. + // latest supported major version is `MEMCACHE_1_5`. // The minor version will be automatically determined by our system based on // the latest supported minor version. MemcacheVersion memcache_version = 9; - // Optional: User defined parameters to apply to the memcached process + // User defined parameters to apply to the memcached process // on each node. MemcacheParameters parameters = 11; // Output only. List of Memcached nodes. - // Refer to [Node] message for more details. + // Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details. repeated Node memcache_nodes = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time the instance was created. @@ -288,11 +310,99 @@ message Instance { // The full version format will be "memcached-1.5.16". string memcache_full_version = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; - // List of messages that describe current statuses of memcached instance. + // List of messages that describe the current state of the Memcached instance. repeated InstanceMessage instance_messages = 19; - // Output only. Endpoint for Discovery API + // Output only. Endpoint for the Discovery API. string discovery_endpoint = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The maintenance policy for the instance. If not provided, + // the maintenance event will be performed based on Memorystore + // internal rollout schedule. + MaintenancePolicy maintenance_policy = 21; + + // Output only. Published maintenance schedule. + MaintenanceSchedule maintenance_schedule = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Maintenance policy per instance. +message MaintenancePolicy { + // Output only. The time when the policy was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the policy was updated. + google.protobuf.Timestamp update_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Description of what this policy is for. Create/Update methods + // return INVALID_ARGUMENT if the length is greater than 512. + string description = 3; + + // Required. Maintenance window that is applied to resources covered by this + // policy. Minimum 1. For the current version, the maximum number of + // weekly_maintenance_windows is expected to be one. + repeated WeeklyMaintenanceWindow weekly_maintenance_window = 4 [(google.api.field_behavior) = REQUIRED]; +} + +// Time window specified for weekly operations. +message WeeklyMaintenanceWindow { + // Required. Allows to define schedule that runs specified day of the week. + google.type.DayOfWeek day = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Start time of the window in UTC. + google.type.TimeOfDay start_time = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Duration of the time window. + google.protobuf.Duration duration = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// Upcoming maintenance schedule. +message MaintenanceSchedule { + // Output only. The start time of any upcoming scheduled maintenance for this instance. + google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The end time of any upcoming scheduled maintenance for this instance. + google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The deadline that the maintenance schedule start time can not go beyond, + // including reschedule. + google.protobuf.Timestamp schedule_deadline_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request for [RescheduleMaintenance][google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenance]. +message RescheduleMaintenanceRequest { + // Reschedule options. + enum RescheduleType { + // Not set. + RESCHEDULE_TYPE_UNSPECIFIED = 0; + + // If the user wants to schedule the maintenance to happen now. + IMMEDIATE = 1; + + // If the user wants to use the existing maintenance policy to find the + // next available window. + NEXT_AVAILABLE_WINDOW = 2; + + // If the user wants to reschedule the maintenance to a specific time. + SPECIFIC_TIME = 3; + } + + // Required. Memcache instance resource name using the form: + // `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + // where `location_id` refers to a GCP region. + string instance = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "memcache.googleapis.com/Instance" + } + ]; + + // Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. + RescheduleType reschedule_type = 2 [(google.api.field_behavior) = REQUIRED]; + + // Timestamp when the maintenance shall be rescheduled to if + // reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for + // example `2012-11-15T16:19:00.094Z`. + google.protobuf.Timestamp schedule_time = 3; } // Request for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances]. @@ -310,18 +420,17 @@ message ListInstancesRequest { // The maximum number of items to return. // // If not specified, a default value of 1000 will be used by the service. - // Regardless of the page_size value, the response may include a partial list - // and a caller should only rely on response's - // [next_page_token][CloudMemcache.ListInstancesResponse.next_page_token] + // Regardless of the `page_size` value, the response may include a partial + // list and a caller should only rely on response's + // [`next_page_token`][google.cloud.memcache.v1.ListInstancesResponse.next_page_token] // to determine if there are more instances left to be queried. int32 page_size = 2; - // The next_page_token value returned from a previous List request, - // if any. + // The `next_page_token` value returned from a previous List request, if any. string page_token = 3; // List filter. For example, exclude all Memcached instances with name as - // my-instance by specifying "name != my-instance". + // my-instance by specifying `"name != my-instance"`. string filter = 4; // Sort results. Supported values are "name", "name desc" or "" (unsorted). @@ -377,9 +486,9 @@ message CreateInstanceRequest { // * Must start with a letter. // * Must be between 1-40 characters. // * Must end with a number or a letter. - // * Must be unique within the user project / location + // * Must be unique within the user project / location. // - // If any of the above are not met, will raise an invalid argument error. + // If any of the above are not met, the API raises an invalid argument error. string instance_id = 2 [(google.api.field_behavior) = REQUIRED]; // Required. A Memcached Instance @@ -389,6 +498,7 @@ message CreateInstanceRequest { // Request for [UpdateInstance][google.cloud.memcache.v1.CloudMemcache.UpdateInstance]. message UpdateInstanceRequest { // Required. Mask of fields to update. + // // * `displayName` google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; @@ -421,12 +531,12 @@ message ApplyParametersRequest { } ]; - // Nodes to which we should apply the instance-level parameter group. + // Nodes to which the instance-level parameter group is applied. repeated string node_ids = 2; // Whether to apply instance-level parameter group to all nodes. If set to - // true, will explicitly restrict users from specifying any nodes, and apply - // parameter group updates to all nodes within the instance. + // true, users are restricted from specifying individual nodes, and + // `ApplyParameters` updates all nodes within the instance. bool apply_all = 3; } @@ -448,11 +558,20 @@ message UpdateParametersRequest { MemcacheParameters parameters = 3; } +// Memcached versions supported by our service. +enum MemcacheVersion { + MEMCACHE_VERSION_UNSPECIFIED = 0; + + // Memcached 1.5 version. + MEMCACHE_1_5 = 1; +} + message MemcacheParameters { // Output only. The unique ID associated with this set of parameters. Users // can use this id to determine if the parameters associated with the instance - // differ from the parameters associated with the nodes and any action needs - // to be taken to apply parameters on nodes. + // differ from the parameters associated with the nodes. A discrepancy between + // parameter ids can inform users that they may need to take action to apply + // parameters on nodes. string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // User defined set of parameters to use in the memcached process. @@ -486,10 +605,14 @@ message OperationMetadata { string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Memcached versions supported by our service. -enum MemcacheVersion { - MEMCACHE_VERSION_UNSPECIFIED = 0; +// Metadata for the given [google.cloud.location.Location][google.cloud.location.Location]. +message LocationMetadata { + // Output only. The set of available zones in the location. The map is keyed + // by the lowercase ID of each zone, as defined by GCE. These keys can be + // specified in the `zones` field when creating a Memcached instance. + map available_zones = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +message ZoneMetadata { - // Memcached 1.5 version. - MEMCACHE_1_5 = 1; } diff --git a/google/cloud/memcache/v1/memcache_grpc_service_config.json b/google/cloud/memcache/v1/memcache_grpc_service_config.json index 9031986b7..15c609be2 100644 --- a/google/cloud/memcache/v1/memcache_grpc_service_config.json +++ b/google/cloud/memcache/v1/memcache_grpc_service_config.json @@ -29,6 +29,14 @@ { "service": "google.cloud.memcache.v1.CloudMemcache", "method": "DeleteInstance" + }, + { + "service": "google.cloud.memcache.v1.CloudMemcache", + "method": "ApplySoftwareUpdate" + }, + { + "service": "google.cloud.memcache.v1.CloudMemcache", + "method": "RescheduleMaintenance" } ], "timeout": "1200s" diff --git a/google/cloud/memcache/v1/memcache_v1.yaml b/google/cloud/memcache/v1/memcache_v1.yaml index f3a97bb3d..7a87d7264 100644 --- a/google/cloud/memcache/v1/memcache_v1.yaml +++ b/google/cloud/memcache/v1/memcache_v1.yaml @@ -4,9 +4,12 @@ name: memcache.googleapis.com title: Cloud Memorystore for Memcached API apis: +- name: google.cloud.location.Locations - name: google.cloud.memcache.v1.CloudMemcache +- name: google.longrunning.Operations types: +- name: google.cloud.memcache.v1.LocationMetadata - name: google.cloud.memcache.v1.OperationMetadata documentation: @@ -14,49 +17,54 @@ documentation: Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP. rules: - - 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.cloud.location.Locations.GetLocation + description: Gets information about a location. - - 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. + - selector: google.cloud.location.Locations.ListLocations + description: Lists information about the supported locations for this service. backend: rules: - - selector: google.cloud.memcache.v1.CloudMemcache.GetInstance + - selector: google.cloud.location.Locations.GetLocation deadline: 60.0 - - selector: google.cloud.memcache.v1.CloudMemcache.ListInstances - deadline: 60.0 - - selector: 'google.iam.v1.IAMPolicy.*' + - selector: google.cloud.location.Locations.ListLocations deadline: 60.0 + - selector: google.cloud.memcache.v1.CloudMemcache.GetInstance + deadline: 10.0 + - selector: google.cloud.memcache.v1.CloudMemcache.ListInstances + deadline: 10.0 - selector: 'google.longrunning.Operations.*' deadline: 60.0 - selector: google.longrunning.Operations.GetOperation deadline: 5.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.memcache.v1.CloudMemcache.*' + - selector: google.cloud.location.Locations.GetLocation oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform - - selector: 'google.iam.v1.IAMPolicy.*' + - selector: google.cloud.location.Locations.ListLocations + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.memcache.v1.CloudMemcache.*' oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/memcache/v1beta2/BUILD.bazel b/google/cloud/memcache/v1beta2/BUILD.bazel index d6f547386..858ea890a 100644 --- a/google/cloud/memcache/v1beta2/BUILD.bazel +++ b/google/cloud/memcache/v1beta2/BUILD.bazel @@ -1,5 +1,5 @@ # This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel +# 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: @@ -29,6 +29,9 @@ proto_library( "//google/api:field_behavior_proto", "//google/api:resource_proto", "//google/longrunning:operations_proto", + "//google/type:dayofweek_proto", + "//google/type:timeofday_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], @@ -39,6 +42,7 @@ proto_library_with_info( deps = [ ":memcache_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -68,19 +72,27 @@ java_grpc_library( java_gapic_library( name = "memcache_java_gapic", srcs = [":memcache_proto_with_info"], + gapic_yaml = None, grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "memcache_v1beta2.yaml", test_deps = [ ":memcache_java_grpc", + "//google/cloud/location:location_java_grpc", ], transport = "grpc+rest", deps = [ ":memcache_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) java_gapic_test( name = "memcache_java_gapic_test_suite", test_classes = [ + "com.google.cloud.memcache.v1beta2.CloudMemcacheClientHttpJsonTest", + "com.google.cloud.memcache.v1beta2.CloudMemcacheClientTest", ], runtime_deps = [":memcache_java_gapic_test"], ) @@ -117,6 +129,8 @@ go_proto_library( deps = [ "//google/api:annotations_go_proto", "//google/longrunning:longrunning_go_proto", + "//google/type:dayofweek_go_proto", + "//google/type:timeofday_go_proto", ], ) @@ -125,13 +139,17 @@ go_gapic_library( srcs = [":memcache_proto_with_info"], grpc_service_config = "memcache_grpc_service_config.json", importpath = "cloud.google.com/go/memcache/apiv1beta2;memcache", + metadata = True, + rest_numeric_enums = True, service_yaml = "memcache_v1beta2.yaml", transport = "grpc+rest", deps = [ ":memcache_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -147,6 +165,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-memcache-v1beta2-go", deps = [ ":memcache_go_gapic", + ":memcache_go_gapic_srcjar-metadata.srcjar", ":memcache_go_gapic_srcjar-test.srcjar", ":memcache_go_proto", ], @@ -166,7 +185,11 @@ py_gapic_library( name = "memcache_py_gapic", srcs = [":memcache_proto"], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "memcache_v1beta2.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -213,7 +236,9 @@ php_gapic_library( name = "memcache_php_gapic", srcs = [":memcache_proto_with_info"], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "memcache_v1beta2.yaml", + transport = "grpc+rest", deps = [ ":memcache_php_grpc", ":memcache_php_proto", @@ -246,7 +271,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "memcache_grpc_service_config.json", package = "google.cloud.memcache.v1beta2", + rest_numeric_enums = True, service_yaml = "memcache_v1beta2.yaml", + transport = "grpc+rest", deps = [], ) @@ -284,15 +311,17 @@ ruby_cloud_gapic_library( name = "memcache_ruby_gapic", srcs = [":memcache_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-memcache-v1beta2", - "ruby-cloud-env-prefix=MEMCACHE", - "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/memcached/", "ruby-cloud-api-id=memcache.googleapis.com", "ruby-cloud-api-shortname=memcache", + "ruby-cloud-env-prefix=MEMCACHE", + "ruby-cloud-gem-name=google-cloud-memcache-v1beta2", + "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/memcached/", ], grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", ruby_cloud_title = "Google Cloud Memorystore for Memcached", + service_yaml = "memcache_v1beta2.yaml", deps = [ ":memcache_ruby_grpc", ":memcache_ruby_proto", @@ -336,6 +365,7 @@ csharp_gapic_library( srcs = [":memcache_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "memcache_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "memcache_v1beta2.yaml", deps = [ ":memcache_csharp_grpc", @@ -356,4 +386,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "memcache_cc_proto", + deps = [":memcache_proto"], +) + +cc_grpc_library( + name = "memcache_cc_grpc", + srcs = [":memcache_proto"], + grpc_only = True, + deps = [":memcache_cc_proto"], +) diff --git a/google/cloud/memcache/v1beta2/cloud_memcache.proto b/google/cloud/memcache/v1beta2/cloud_memcache.proto index 1a3ff64a7..4cb904031 100644 --- a/google/cloud/memcache/v1beta2/cloud_memcache.proto +++ b/google/cloud/memcache/v1beta2/cloud_memcache.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. @@ -21,8 +21,11 @@ import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/longrunning/operations.proto"; +import "google/protobuf/duration.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; +import "google/type/dayofweek.proto"; +import "google/type/timeofday.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/memcache/v1beta2;memcache"; option java_multiple_files = true; @@ -144,6 +147,19 @@ service CloudMemcache { metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata" }; } + + // Performs the apply phase of the RescheduleMaintenance verb. + rpc RescheduleMaintenance(RescheduleMaintenanceRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta2/{instance=projects/*/locations/*/instances/*}:rescheduleMaintenance" + body: "*" + }; + option (google.api.method_signature) = "instance, reschedule_type, schedule_time"; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.memcache.v1beta2.Instance" + metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata" + }; + } } // A Memorystore for Memcached instance @@ -153,6 +169,28 @@ message Instance { pattern: "projects/{project}/locations/{location}/instances/{instance}" }; + // Different states of a Memcached instance. + enum State { + // State not set. + STATE_UNSPECIFIED = 0; + + // Memcached instance is being created. + CREATING = 1; + + // Memcached instance has been created and ready to be used. + READY = 2; + + // Memcached instance is updating configuration such as maintenance policy + // and schedule. + UPDATING = 3; + + // Memcached instance is being deleted. + DELETING = 4; + + // Memcached instance is going through maintenance, e.g. data plane rollout. + PERFORMING_MAINTENANCE = 5; + } + // Configuration for a Memcached Node. message NodeConfig { // Required. Number of cpus per Memcached node. @@ -221,24 +259,6 @@ message Instance { string message = 2; } - // Different states of a Memcached instance. - enum State { - // State not set. - STATE_UNSPECIFIED = 0; - - // Memcached instance is being created. - CREATING = 1; - - // Memcached instance has been created and ready to be used. - READY = 2; - - // Memcached instance is being deleted. - DELETING = 4; - - // Memcached instance is going through maintenance, e.g. data plane rollout. - PERFORMING_MAINTENANCE = 5; - } - // Required. Unique name of the resource in this scope including project and // location using the form: // `projects/{project_id}/locations/{location_id}/instances/{instance_id}` @@ -283,7 +303,7 @@ message Instance { // the latest supported minor version. MemcacheVersion memcache_version = 9; - // Optional: User defined parameters to apply to the memcached process + // User defined parameters to apply to the memcached process // on each node. MemcacheParameters parameters = 11; @@ -314,6 +334,57 @@ message Instance { // Output only. Returns true if there is an update waiting to be applied bool update_available = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The maintenance policy for the instance. If not provided, + // the maintenance event will be performed based on Memorystore + // internal rollout schedule. + MaintenancePolicy maintenance_policy = 22; + + // Output only. Published maintenance schedule. + MaintenanceSchedule maintenance_schedule = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Maintenance policy per instance. +message MaintenancePolicy { + // Output only. The time when the policy was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the policy was updated. + google.protobuf.Timestamp update_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Description of what this policy is for. Create/Update methods + // return INVALID_ARGUMENT if the length is greater than 512. + string description = 3; + + // Required. Maintenance window that is applied to resources covered by this + // policy. Minimum 1. For the current version, the maximum number of + // weekly_maintenance_windows is expected to be one. + repeated WeeklyMaintenanceWindow weekly_maintenance_window = 4 [(google.api.field_behavior) = REQUIRED]; +} + +// Time window specified for weekly operations. +message WeeklyMaintenanceWindow { + // Required. Allows to define schedule that runs specified day of the week. + google.type.DayOfWeek day = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Start time of the window in UTC. + google.type.TimeOfDay start_time = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Duration of the time window. + google.protobuf.Duration duration = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// Upcoming maintenance schedule. +message MaintenanceSchedule { + // Output only. The start time of any upcoming scheduled maintenance for this instance. + google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The end time of any upcoming scheduled maintenance for this instance. + google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The deadline that the maintenance schedule start time can not go beyond, + // including reschedule. + google.protobuf.Timestamp schedule_deadline_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Request for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances]. @@ -409,6 +480,7 @@ message CreateInstanceRequest { // Request for [UpdateInstance][google.cloud.memcache.v1beta2.CloudMemcache.UpdateInstance]. message UpdateInstanceRequest { // Required. Mask of fields to update. + // // * `displayName` google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; @@ -430,6 +502,43 @@ message DeleteInstanceRequest { ]; } +// Request for [RescheduleMaintenance][google.cloud.memcache.v1beta2.CloudMemcache.RescheduleMaintenance]. +message RescheduleMaintenanceRequest { + // Reschedule options. + enum RescheduleType { + // Not set. + RESCHEDULE_TYPE_UNSPECIFIED = 0; + + // If the user wants to schedule the maintenance to happen now. + IMMEDIATE = 1; + + // If the user wants to use the existing maintenance policy to find the + // next available window. + NEXT_AVAILABLE_WINDOW = 2; + + // If the user wants to reschedule the maintenance to a specific time. + SPECIFIC_TIME = 3; + } + + // Required. Memcache instance resource name using the form: + // `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + // where `location_id` refers to a GCP region. + string instance = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "memcache.googleapis.com/Instance" + } + ]; + + // Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. + RescheduleType reschedule_type = 2 [(google.api.field_behavior) = REQUIRED]; + + // Timestamp when the maintenance shall be rescheduled to if + // reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for + // example `2012-11-15T16:19:00.094Z`. + google.protobuf.Timestamp schedule_time = 3; +} + // Request for [ApplyParameters][google.cloud.memcache.v1beta2.CloudMemcache.ApplyParameters]. message ApplyParametersRequest { // Required. Resource name of the Memcached instance for which parameter group updates @@ -489,13 +598,20 @@ message ApplySoftwareUpdateRequest { bool apply_all = 3; } -// The unique ID associated with this set of parameters. Users -// can use this id to determine if the parameters associated with the instance -// differ from the parameters associated with the nodes. A discrepancy between -// parameter ids can inform users that they may need to take action to apply -// parameters on nodes. +// Memcached versions supported by our service. +enum MemcacheVersion { + MEMCACHE_VERSION_UNSPECIFIED = 0; + + // Memcached 1.5 version. + MEMCACHE_1_5 = 1; +} + message MemcacheParameters { - // Output only. + // Output only. The unique ID associated with this set of parameters. Users + // can use this id to determine if the parameters associated with the instance + // differ from the parameters associated with the nodes. A discrepancy between + // parameter ids can inform users that they may need to take action to apply + // parameters on nodes. string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // User defined set of parameters to use in the memcached process. @@ -529,14 +645,6 @@ message OperationMetadata { string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Memcached versions supported by our service. -enum MemcacheVersion { - MEMCACHE_VERSION_UNSPECIFIED = 0; - - // Memcached 1.5 version. - MEMCACHE_1_5 = 1; -} - // Metadata for the given [google.cloud.location.Location][google.cloud.location.Location]. message LocationMetadata { // Output only. The set of available zones in the location. The map is keyed diff --git a/google/cloud/memcache/v1beta2/memcache_grpc_service_config.json b/google/cloud/memcache/v1beta2/memcache_grpc_service_config.json index 595e9efd1..802e630df 100644 --- a/google/cloud/memcache/v1beta2/memcache_grpc_service_config.json +++ b/google/cloud/memcache/v1beta2/memcache_grpc_service_config.json @@ -33,6 +33,10 @@ { "service": "google.cloud.memcache.v1beta2.CloudMemcache", "method": "ApplySoftwareUpdate" + }, + { + "service": "google.cloud.memcache.v1beta2.CloudMemcache", + "method": "RescheduleMaintenance" } ], "timeout": "1200s" diff --git a/google/cloud/memcache/v1beta2/memcache_v1beta2.yaml b/google/cloud/memcache/v1beta2/memcache_v1beta2.yaml index 557e223cf..d624d09af 100644 --- a/google/cloud/memcache/v1beta2/memcache_v1beta2.yaml +++ b/google/cloud/memcache/v1beta2/memcache_v1beta2.yaml @@ -4,7 +4,9 @@ name: memcache.googleapis.com title: Cloud Memorystore for Memcached API apis: +- name: google.cloud.location.Locations - name: google.cloud.memcache.v1beta2.CloudMemcache +- name: google.longrunning.Operations types: - name: google.cloud.memcache.v1beta2.LocationMetadata @@ -21,29 +23,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.location.Locations.GetLocation @@ -51,11 +30,9 @@ backend: - selector: google.cloud.location.Locations.ListLocations deadline: 60.0 - selector: google.cloud.memcache.v1beta2.CloudMemcache.GetInstance - deadline: 60.0 + deadline: 10.0 - selector: google.cloud.memcache.v1beta2.CloudMemcache.ListInstances - deadline: 60.0 - - selector: 'google.iam.v1.IAMPolicy.*' - deadline: 60.0 + deadline: 10.0 - selector: 'google.longrunning.Operations.*' deadline: 60.0 - selector: google.longrunning.Operations.GetOperation @@ -91,10 +68,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: |- diff --git a/google/cloud/metastore/BUILD.bazel b/google/cloud/metastore/BUILD.bazel index 2655ab346..792b68fe3 100644 --- a/google/cloud/metastore/BUILD.bazel +++ b/google/cloud/metastore/BUILD.bazel @@ -22,7 +22,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-metastore", "ruby-cloud-env-prefix=METASTORE", - "ruby-cloud-wrapper-of=v1:0.0;v1beta:0.0", + "ruby-cloud-wrapper-of=v1:0.4;v1beta:0.3", "ruby-cloud-product-url=https://cloud.google.com/dataproc-metastore/", "ruby-cloud-api-id=metastore.googleapis.com", "ruby-cloud-api-shortname=metastore", diff --git a/google/cloud/metastore/v1/BUILD.bazel b/google/cloud/metastore/v1/BUILD.bazel index a99f39822..e39893221 100644 --- a/google/cloud/metastore/v1/BUILD.bazel +++ b/google/cloud/metastore/v1/BUILD.bazel @@ -22,6 +22,7 @@ proto_library( name = "metastore_proto", srcs = [ "metastore.proto", + "metastore_federation.proto", ], deps = [ "//google/api:annotations_proto", @@ -72,6 +73,7 @@ java_gapic_library( srcs = [":metastore_proto_with_info"], gapic_yaml = "metastore_gapic.yaml", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":metastore_java_grpc", ], @@ -132,13 +134,16 @@ go_gapic_library( grpc_service_config = "metastore_grpc_service_config.json", importpath = "cloud.google.com/go/metastore/apiv1;metastore", metadata = True, + rest_numeric_enums = True, service_yaml = "metastore_v1.yaml", transport = "grpc+rest", deps = [ ":metastore_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -174,6 +179,10 @@ py_gapic_library( name = "metastore_py_gapic", srcs = [":metastore_proto"], grpc_service_config = "metastore_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-dataproc-metastore", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +230,9 @@ php_gapic_library( name = "metastore_php_gapic", srcs = [":metastore_proto_with_info"], grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1.yaml", + transport = "grpc+rest", deps = [ ":metastore_php_grpc", ":metastore_php_proto", @@ -254,7 +265,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "metastore_grpc_service_config.json", package = "google.cloud.metastore.v1", + rest_numeric_enums = True, service_yaml = "metastore_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -299,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=metastore", ], grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dataproc Metastore is a fully managed, highly available within a region, autohealing serverless Apache Hive metastore (HMS) on Google Cloud for data analytics products. It supports HMS and serves as a critical component for managing the metadata of relational entities and provides interoperability between data processing applications in the open source data ecosystem.", ruby_cloud_title = "Dataproc Metastore V1", deps = [ @@ -344,6 +358,7 @@ csharp_gapic_library( srcs = [":metastore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1.yaml", deps = [ ":metastore_csharp_grpc", diff --git a/google/cloud/metastore/v1/metastore.proto b/google/cloud/metastore/v1/metastore.proto index 6a49abe20..01431d9c1 100644 --- a/google/cloud/metastore/v1/metastore.proto +++ b/google/cloud/metastore/v1/metastore.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. @@ -30,10 +30,15 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/metastore/v1;me option java_multiple_files = true; option java_outer_classname = "MetastoreProto"; option java_package = "com.google.cloud.metastore.v1"; +option php_namespace = "Google\\Cloud\\Metastore\\V1"; option (google.api.resource_definition) = { type: "compute.googleapis.com/Network" pattern: "projects/{project}/global/networks/{network}" }; +option (google.api.resource_definition) = { + type: "compute.googleapis.com/Subnetwork" + pattern: "projects/{project}/regions/{region}/subnetworks/{subnetwork}" +}; // Configures and manages metastore services. // Metastore services are fully managed, highly available, autoscaled, @@ -81,7 +86,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,service,service_id"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -94,7 +99,7 @@ service DataprocMetastore { option (google.api.method_signature) = "service,update_mask"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -106,7 +111,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -135,7 +140,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,metadata_import,metadata_import_id"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -149,7 +154,7 @@ service DataprocMetastore { option (google.api.method_signature) = "metadata_import,update_mask"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -161,7 +166,7 @@ service DataprocMetastore { }; option (google.longrunning.operation_info) = { response_type: "MetadataExport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -174,7 +179,7 @@ service DataprocMetastore { option (google.api.method_signature) = "service,backup"; option (google.longrunning.operation_info) = { response_type: "Restore" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -203,7 +208,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,backup,backup_id"; option (google.longrunning.operation_info) = { response_type: "Backup" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } @@ -215,7 +220,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" }; } } @@ -288,6 +293,18 @@ message Service { STABLE = 2; } + // The backend database type for the metastore service. + enum DatabaseType { + // The DATABASE_TYPE is not set. + DATABASE_TYPE_UNSPECIFIED = 0; + + // MySQL is used to persist the metastore data. + MYSQL = 1; + + // Spanner is used to persist the metastore data. + SPANNER = 2; + } + // Configuration properties specific to the underlying metastore service // technology (the software that serves metastore queries). oneof metastore_config { @@ -296,7 +313,8 @@ message Service { HiveMetastoreConfig hive_metastore_config = 5; } - // Immutable. The relative resource name of the metastore service, of the form: + // Immutable. The relative resource name of the metastore service, in the following + // format: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -343,6 +361,8 @@ message Service { // The one hour maintenance window of the metastore service. This specifies // when the service can be restarted for maintenance purposes in UTC time. + // Maintenance window is not needed for services with the SPANNER + // database type. MaintenanceWindow maintenance_window = 15; // Output only. The globally unique resource identifier of the metastore service. @@ -354,6 +374,21 @@ message Service { // Immutable. The release channel of the service. // If unspecified, defaults to `STABLE`. ReleaseChannel release_channel = 19 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Information used to configure the Dataproc Metastore service to encrypt + // customer data at rest. Cannot be updated. + EncryptionConfig encryption_config = 20 [(google.api.field_behavior) = IMMUTABLE]; + + // The configuration specifying the network settings for the + // Dataproc Metastore service. + NetworkConfig network_config = 21; + + // Immutable. The database type that the Metastore service stores its data. + DatabaseType database_type = 22 [(google.api.field_behavior) = IMMUTABLE]; + + // The configuration specifying telemetry settings for the Dataproc Metastore + // service. If unspecified defaults to `JSON`. + TelemetryConfig telemetry_config = 23; } // Maintenance window. This specifies when Dataproc Metastore @@ -374,7 +409,9 @@ message HiveMetastoreConfig { // A mapping of Hive metastore configuration key-value pairs to apply to the // Hive metastore (configured in `hive-site.xml`). The mappings - // override system defaults (some keys cannot be overridden). + // override system defaults (some keys cannot be overridden). These + // overrides are also applied to auxiliary versions and can be further + // customized in the auxiliary version's `AuxiliaryVersionConfig`. map config_overrides = 2; // Information used to configure the Hive metastore service as a service @@ -413,6 +450,62 @@ message Secret { } } +// Encryption settings for the service. +message EncryptionConfig { + // The fully qualified customer provided Cloud KMS key name to use for + // customer data encryption, in the following form: + // + // `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`. + string kms_key = 1; +} + +// Network configuration for the Dataproc Metastore service. +message NetworkConfig { + // Contains information of the customer's network configurations. + message Consumer { + oneof vpc_resource { + // Immutable. The subnetwork of the customer project from which an IP address is + // reserved and used as the Dataproc Metastore service's + // endpoint. It is accessible to hosts in the subnet and to all + // hosts in a subnet in the same region and same network. There must + // be at least one IP address available in the subnet's primary range. The + // subnet is specified in the following form: + // + // `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}` + string subnetwork = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "compute.googleapis.com/Subnetwork" + } + ]; + } + + // Output only. The URI of the endpoint used to access the metastore service. + string endpoint_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Immutable. The consumer-side network configuration for the Dataproc Metastore + // instance. + repeated Consumer consumers = 1 [(google.api.field_behavior) = IMMUTABLE]; +} + +// Telemetry Configuration for the Dataproc Metastore service. +message TelemetryConfig { + enum LogFormat { + // The LOG_FORMAT is not set. + LOG_FORMAT_UNSPECIFIED = 0; + + // Logging output uses the legacy `textPayload` format. + LEGACY = 1; + + // Logging output uses the `jsonPayload` format. + JSON = 2; + } + + // The output format of the Dataproc Metastore service's logs. + LogFormat log_format = 1; +} + // The metadata management activities of the metastore service. message MetadataManagementActivity { // Output only. The latest metadata exports of the metastore service. @@ -432,6 +525,7 @@ message MetadataImport { // A specification of the location of and metadata about a database dump from // a relational database management system. message DatabaseDump { + // The type of the database. enum DatabaseType { // The type of the source database is unknown. @@ -659,7 +753,7 @@ message ListServicesRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; @@ -723,7 +817,7 @@ message CreateServiceRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; @@ -822,7 +916,7 @@ message ListMetadataImportsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; @@ -886,7 +980,7 @@ message CreateMetadataImportRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; @@ -957,7 +1051,7 @@ message ListBackupsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; @@ -1021,7 +1115,7 @@ message CreateBackupRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; @@ -1219,6 +1313,4 @@ message DatabaseDumpSpec { // Database dump contains Avro files. AVRO = 2; } - - } diff --git a/google/cloud/metastore/v1/metastore_federation.proto b/google/cloud/metastore/v1/metastore_federation.proto new file mode 100644 index 000000000..f3a95b175 --- /dev/null +++ b/google/cloud/metastore/v1/metastore_federation.proto @@ -0,0 +1,361 @@ +// 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.metastore.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/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/metastore/v1;metastore"; +option java_multiple_files = true; +option java_outer_classname = "MetastoreFederationProto"; +option java_package = "com.google.cloud.metastore.v1"; + +// Configures and manages metastore federation services. +// Dataproc Metastore Federation Service allows federating a collection of +// backend metastores like BigQuery, Dataplex Lakes, and other Dataproc +// Metastores. The Federation Service exposes a gRPC URL through which metadata +// from the backend metastores are served at query time. +// +// The Dataproc Metastore Federation API defines the following resource model: +// * The service works with a collection of Google Cloud projects. +// * Each project has a collection of available locations. +// * Each location has a collection of federations. +// * Dataproc Metastore Federations are resources with names of the +// form: +// `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. +service DataprocMetastoreFederation { + option (google.api.default_host) = "metastore.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists federations in a project and location. + rpc ListFederations(ListFederationsRequest) returns (ListFederationsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/federations" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a single federation. + rpc GetFederation(GetFederationRequest) returns (Federation) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a metastore federation in a project and location. + rpc CreateFederation(CreateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/federations" + body: "federation" + }; + option (google.api.method_signature) = "parent,federation,federation_id"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" + }; + } + + // Updates the fields of a federation. + rpc UpdateFederation(UpdateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{federation.name=projects/*/locations/*/federations/*}" + body: "federation" + }; + option (google.api.method_signature) = "federation,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" + }; + } + + // Deletes a single federation. + rpc DeleteFederation(DeleteFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "google.cloud.metastore.v1.OperationMetadata" + }; + } +} + +// Represents a federation of multiple backend metastores. +message Federation { + option (google.api.resource) = { + type: "metastore.googleapis.com/Federation" + pattern: "projects/{project}/locations/{location}/federations/{federation}" + }; + + // The current state of the federation. + enum State { + // The state of the metastore federation is unknown. + STATE_UNSPECIFIED = 0; + + // The metastore federation is in the process of being created. + CREATING = 1; + + // The metastore federation is running and ready to serve queries. + ACTIVE = 2; + + // The metastore federation is being updated. It remains usable but cannot + // accept additional update requests or be deleted at this time. + UPDATING = 3; + + // The metastore federation is undergoing deletion. It cannot be used. + DELETING = 4; + + // The metastore federation has encountered an error and cannot be used. The + // metastore federation should be deleted. + ERROR = 5; + } + + // Immutable. The relative resource name of the federation, of the + // form: + // projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. The time when the metastore federation was created. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the metastore federation was last updated. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // User-defined labels for the metastore federation. + map labels = 4; + + // Immutable. The Apache Hive metastore version of the federation. All backend metastore + // versions must be compatible with the federation version. + string version = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // A map from `BackendMetastore` rank to `BackendMetastore`s from which the + // federation service serves metadata at query time. The map key represents + // the order in which `BackendMetastore`s should be evaluated to resolve + // database names at query time and should be greater than or equal to zero. A + // `BackendMetastore` with a lower number will be evaluated before a + // `BackendMetastore` with a higher number. + map backend_metastores = 6; + + // Output only. The federation endpoint. + string endpoint_uri = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The current state of the federation. + State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Additional information about the current state of the metastore federation, + // if available. + string state_message = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The globally unique resource identifier of the metastore federation. + string uid = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Represents a backend metastore for the federation. +message BackendMetastore { + // The type of the backend metastore. + enum MetastoreType { + // The metastore type is not set. + METASTORE_TYPE_UNSPECIFIED = 0; + + // The backend metastore is Dataproc Metastore. + DATAPROC_METASTORE = 3; + } + + // The relative resource name of the metastore that is being federated. + // The formats of the relative resource names for the currently supported + // metastores are listed below: + // + // * Dataplex + // * `projects/{project_id}/locations/{location}/lakes/{lake_id}` + // * BigQuery + // * `projects/{project_id}` + // * Dataproc Metastore + // * `projects/{project_id}/locations/{location}/services/{service_id}` + string name = 1; + + // The type of the backend metastore. + MetastoreType metastore_type = 2; +} + +// Request message for ListFederations. +message ListFederationsRequest { + // Required. The relative resource name of the location of metastore federations + // to list, in the following form: + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. The maximum number of federations to return. The response may contain less + // than the maximum number. If unspecified, no more than 500 services are + // returned. The maximum value is 1000; values above 1000 are changed to 1000. + int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A page token, received from a previous ListFederationServices + // call. Provide this token to retrieve the subsequent page. + // + // To retrieve the first page, supply an empty page token. + // + // When paginating, other parameters provided to + // ListFederationServices must match the call that provided the + // page token. + string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The filter to apply to list results. + string filter = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Specify the ordering of results as described in [Sorting + // Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). + // If not specified, the results will be sorted in the default order. + string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for ListFederations +message ListFederationsResponse { + // The services in the specified location. + repeated Federation federations = 1; + + // A token that 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; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request message for GetFederation. +message GetFederationRequest { + // Required. The relative resource name of the metastore federation to retrieve, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; +} + +// Request message for CreateFederation. +message CreateFederationRequest { + // Required. The relative resource name of the location in which to create a federation + // service, in the following form: + // + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Required. The ID of the metastore federation, which is used as the final + // component of the metastore federation's name. + // + // This value must be between 2 and 63 characters long inclusive, begin with a + // letter, end with a letter or number, and consist of alpha-numeric + // ASCII characters or hyphens. + string federation_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Metastore Federation to create. The `name` field is + // ignored. The ID of the created metastore federation must be + // provided in the request's `federation_id` field. + Federation federation = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for UpdateFederation. +message UpdateFederationRequest { + // Required. A field mask used to specify the fields to be overwritten in the + // metastore federation resource by the update. + // Fields specified in the `update_mask` are relative to the resource (not + // to the full request). A field is overwritten if it is in the mask. + google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The metastore federation to update. The server only merges fields + // in the service if they are specified in `update_mask`. + // + // The metastore federation's `name` field is used to identify the + // metastore service to be updated. + Federation federation = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for DeleteFederation. +message DeleteFederationRequest { + // Required. The relative resource name of the metastore federation to delete, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; +} diff --git a/google/cloud/metastore/v1/metastore_v1.yaml b/google/cloud/metastore/v1/metastore_v1.yaml index 0b2eaad45..e64ac48fb 100644 --- a/google/cloud/metastore/v1/metastore_v1.yaml +++ b/google/cloud/metastore/v1/metastore_v1.yaml @@ -4,7 +4,11 @@ name: metastore.googleapis.com title: Dataproc Metastore API apis: +- name: google.cloud.location.Locations - name: google.cloud.metastore.v1.DataprocMetastore +- name: google.cloud.metastore.v1.DataprocMetastoreFederation +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.metastore.v1.LocationMetadata @@ -52,6 +56,8 @@ backend: deadline: 60.0 - selector: 'google.cloud.metastore.v1.DataprocMetastore.*' deadline: 60.0 + - selector: 'google.cloud.metastore.v1.DataprocMetastoreFederation.*' + deadline: 60.0 - selector: 'google.iam.v1.IAMPolicy.*' deadline: 60.0 - selector: 'google.longrunning.Operations.*' @@ -67,15 +73,21 @@ http: get: '/v1/{resource=projects/*/locations/*/services/*}:getIamPolicy' additional_bindings: - get: '/v1/{resource=projects/*/locations/*/services/*/backups/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/federations/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1/{resource=projects/*/locations/*/services/*}:setIamPolicy' body: '*' additional_bindings: - post: '/v1/{resource=projects/*/locations/*/services/*/backups/*}:setIamPolicy' body: '*' + - post: '/v1/{resource=projects/*/locations/*/federations/*}:setIamPolicy' + body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1/{resource=projects/*/locations/*/services/*}:testIamPermissions' body: '*' + additional_bindings: + - post: '/v1/{resource=projects/*/locations/*/federations/*}:testIamPermissions' + body: '*' - selector: google.longrunning.Operations.DeleteOperation delete: '/v1/{name=projects/*/locations/*/operations/*}' - selector: google.longrunning.Operations.GetOperation @@ -97,6 +109,10 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.metastore.v1.DataprocMetastoreFederation.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.iam.v1.IAMPolicy.*' oauth: canonical_scopes: |- diff --git a/google/cloud/metastore/v1alpha/BUILD.bazel b/google/cloud/metastore/v1alpha/BUILD.bazel index 35c19f60f..f511af5ce 100644 --- a/google/cloud/metastore/v1alpha/BUILD.bazel +++ b/google/cloud/metastore/v1alpha/BUILD.bazel @@ -22,6 +22,7 @@ proto_library( name = "metastore_proto", srcs = [ "metastore.proto", + "metastore_federation.proto", ], deps = [ "//google/api:annotations_proto", @@ -72,6 +73,7 @@ java_gapic_library( srcs = [":metastore_proto_with_info"], gapic_yaml = "metastore_gapic.yaml", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1alpha.yaml", test_deps = [ ":metastore_java_grpc", @@ -134,13 +136,16 @@ go_gapic_library( grpc_service_config = "metastore_grpc_service_config.json", importpath = "cloud.google.com/go/metastore/apiv1alpha;metastore", metadata = True, + rest_numeric_enums = True, service_yaml = "metastore_v1alpha.yaml", transport = "grpc+rest", deps = [ ":metastore_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -176,6 +181,10 @@ py_gapic_library( name = "metastore_py_gapic", srcs = [":metastore_proto"], grpc_service_config = "metastore_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-dataproc-metastore", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -223,7 +232,9 @@ php_gapic_library( name = "metastore_php_gapic", srcs = [":metastore_proto_with_info"], grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":metastore_php_grpc", ":metastore_php_proto", @@ -256,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "metastore_grpc_service_config.json", package = "google.cloud.metastore.v1alpha", + rest_numeric_enums = True, service_yaml = "metastore_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +308,7 @@ ruby_cloud_gapic_library( srcs = [":metastore_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-metastore-v1alpha"], grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":metastore_ruby_grpc", ":metastore_ruby_proto", @@ -338,6 +352,7 @@ csharp_gapic_library( srcs = [":metastore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1alpha.yaml", deps = [ ":metastore_csharp_grpc", diff --git a/google/cloud/metastore/v1alpha/metastore.proto b/google/cloud/metastore/v1alpha/metastore.proto index d5b96385e..3cac5b5ab 100644 --- a/google/cloud/metastore/v1alpha/metastore.proto +++ b/google/cloud/metastore/v1alpha/metastore.proto @@ -63,7 +63,8 @@ option (google.api.resource_definition) = { // `/projects/{project_number}/locations/{location_id}/services/{service_id}`. service DataprocMetastore { option (google.api.default_host) = "metastore.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"; // Lists services in a project and location. rpc ListServices(ListServicesRequest) returns (ListServicesResponse) { @@ -82,7 +83,8 @@ service DataprocMetastore { } // Creates a metastore service in a project and location. - rpc CreateService(CreateServiceRequest) returns (google.longrunning.Operation) { + rpc CreateService(CreateServiceRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1alpha/{parent=projects/*/locations/*}/services" body: "service" @@ -90,12 +92,13 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,service,service_id"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Updates the parameters of a single service. - rpc UpdateService(UpdateServiceRequest) returns (google.longrunning.Operation) { + rpc UpdateService(UpdateServiceRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1alpha/{service.name=projects/*/locations/*/services/*}" body: "service" @@ -103,24 +106,26 @@ service DataprocMetastore { option (google.api.method_signature) = "service,update_mask"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Deletes a single service. - rpc DeleteService(DeleteServiceRequest) returns (google.longrunning.Operation) { + rpc DeleteService(DeleteServiceRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1alpha/{name=projects/*/locations/*/services/*}" }; option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Lists imports in a service. - rpc ListMetadataImports(ListMetadataImportsRequest) returns (ListMetadataImportsResponse) { + rpc ListMetadataImports(ListMetadataImportsRequest) + returns (ListMetadataImportsResponse) { option (google.api.http) = { get: "/v1alpha/{parent=projects/*/locations/*/services/*}/metadataImports" }; @@ -136,21 +141,24 @@ service DataprocMetastore { } // Creates a new MetadataImport in a given project and location. - rpc CreateMetadataImport(CreateMetadataImportRequest) returns (google.longrunning.Operation) { + rpc CreateMetadataImport(CreateMetadataImportRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1alpha/{parent=projects/*/locations/*/services/*}/metadataImports" body: "metadata_import" }; - option (google.api.method_signature) = "parent,metadata_import,metadata_import_id"; + option (google.api.method_signature) = + "parent,metadata_import,metadata_import_id"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Updates a single import. // Only the description field of MetadataImport is supported to be updated. - rpc UpdateMetadataImport(UpdateMetadataImportRequest) returns (google.longrunning.Operation) { + rpc UpdateMetadataImport(UpdateMetadataImportRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1alpha/{metadata_import.name=projects/*/locations/*/services/*/metadataImports/*}" body: "metadata_import" @@ -158,24 +166,26 @@ service DataprocMetastore { option (google.api.method_signature) = "metadata_import,update_mask"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Exports metadata from a service. - rpc ExportMetadata(ExportMetadataRequest) returns (google.longrunning.Operation) { + rpc ExportMetadata(ExportMetadataRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1alpha/{service=projects/*/locations/*/services/*}:exportMetadata" body: "*" }; option (google.longrunning.operation_info) = { response_type: "MetadataExport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } // Restores a service from a backup. - rpc RestoreService(RestoreServiceRequest) returns (google.longrunning.Operation) { + rpc RestoreService(RestoreServiceRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1alpha/{service=projects/*/locations/*/services/*}:restore" body: "*" @@ -183,7 +193,7 @@ service DataprocMetastore { option (google.api.method_signature) = "service,backup"; option (google.longrunning.operation_info) = { response_type: "Restore" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } @@ -212,7 +222,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,backup,backup_id"; option (google.longrunning.operation_info) = { response_type: "Backup" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } @@ -224,7 +234,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" }; } } @@ -317,29 +327,30 @@ message Service { HiveMetastoreConfig hive_metastore_config = 5; } - // Immutable. The relative resource name of the metastore service, of the form: + // Immutable. The relative resource name of the metastore service, in the + // following format: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The time when the metastore service 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 when the metastore service was 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]; // User-defined labels for the metastore service. map labels = 4; - // Immutable. The relative resource name of the VPC network on which the instance can be - // accessed. It is specified in the following form: + // Immutable. The relative resource name of the VPC network on which the + // instance can be accessed. It is specified in the following form: // // `projects/{project_number}/global/networks/{network_id}`. string network = 7 [ (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - } + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } ]; // Output only. The URI of the endpoint used to access the metastore service. @@ -351,12 +362,12 @@ message Service { // Output only. The current state of the metastore service. State state = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Additional information about the current state of the metastore service, if - // available. + // Output only. Additional information about the current state of the + // metastore service, if available. string state_message = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A Cloud Storage URI (starting with `gs://`) that specifies where artifacts - // related to the metastore service are stored. + // Output only. A Cloud Storage URI (starting with `gs://`) that specifies + // where artifacts related to the metastore service are stored. string artifact_gcs_uri = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // The tier of the service. @@ -372,26 +383,33 @@ message Service { // database type. MaintenanceWindow maintenance_window = 15; - // Output only. The globally unique resource identifier of the metastore service. + // Output only. The globally unique resource identifier of the metastore + // service. string uid = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The metadata management activities of the metastore service. - MetadataManagementActivity metadata_management_activity = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + MetadataManagementActivity metadata_management_activity = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. The release channel of the service. // If unspecified, defaults to `STABLE`. ReleaseChannel release_channel = 19 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Information used to configure the Dataproc Metastore service to encrypt - // customer data at rest. Cannot be updated. - EncryptionConfig encryption_config = 20 [(google.api.field_behavior) = IMMUTABLE]; + // Immutable. Information used to configure the Dataproc Metastore service to + // encrypt customer data at rest. Cannot be updated. + EncryptionConfig encryption_config = 20 + [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The configuration specifying the network settings for the + // The configuration specifying the network settings for the // Dataproc Metastore service. - NetworkConfig network_config = 21 [(google.api.field_behavior) = IMMUTABLE]; + NetworkConfig network_config = 21; // Immutable. The database type that the Metastore service stores its data. DatabaseType database_type = 22 [(google.api.field_behavior) = IMMUTABLE]; + + // The configuration specifying telemetry settings for the Dataproc Metastore + // service. If unspecified defaults to `JSON`. + TelemetryConfig telemetry_config = 23; } // Specifies how metastore metadata should be integrated with external services. @@ -425,9 +443,9 @@ message Lake { // The Lake resource name. // Example: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}` - string name = 1 [(google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - }]; + string name = 1 [ + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } + ]; } // Maintenance window. This specifies when Dataproc Metastore @@ -537,8 +555,8 @@ message AuxiliaryVersionConfig { // the auxiliary version's overrides takes precedence. map config_overrides = 2; - // Output only. The network configuration contains the endpoint URI(s) of the auxiliary - // Hive metastore service. + // Output only. The network configuration contains the endpoint URI(s) of the + // auxiliary Hive metastore service. NetworkConfig network_config = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -547,32 +565,54 @@ message NetworkConfig { // Contains information of the customer's network configurations. message Consumer { oneof vpc_resource { - // The subnetwork of the customer project from which an IP address is - // reserved and used as the Dataproc Metastore service's + // Immutable. The subnetwork of the customer project from which an IP + // address is reserved and used as the Dataproc Metastore service's // endpoint. It is accessible to hosts in the subnet and to all // hosts in a subnet in the same region and same network. There must // be at least one IP address available in the subnet's primary range. The // subnet is specified in the following form: // // `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id} - string subnetwork = 1 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Subnetwork" - }]; + string subnetwork = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "compute.googleapis.com/Subnetwork" + } + ]; } - // Output only. The URI of the endpoint used to access the metastore service. + // Output only. The URI of the endpoint used to access the metastore + // service. string endpoint_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Immutable. The consumer-side network configuration for the Dataproc Metastore - // instance. + // Immutable. The consumer-side network configuration for the Dataproc + // Metastore instance. repeated Consumer consumers = 1 [(google.api.field_behavior) = IMMUTABLE]; } +// Telemetry Configuration for the Dataproc Metastore service. +message TelemetryConfig { + enum LogFormat { + // The LOG_FORMAT is not set. + LOG_FORMAT_UNSPECIFIED = 0; + + // Logging output uses the legacy `textPayload` format. + LEGACY = 1; + + // Logging output uses the `jsonPayload` format. + JSON = 2; + } + + // The output format of the Dataproc Metastore service's logs. + LogFormat log_format = 1; +} + // The metadata management activities of the metastore service. message MetadataManagementActivity { // Output only. The latest metadata exports of the metastore service. - repeated MetadataExport metadata_exports = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated MetadataExport metadata_exports = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The latest restores of the metastore service. repeated Restore restores = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -607,7 +647,8 @@ message MetadataImport { // The name of the source database. string source_database = 3 [deprecated = true]; - // Optional. The type of the database dump. If unspecified, defaults to `MYSQL`. + // Optional. The type of the database dump. If unspecified, defaults to + // `MYSQL`. DatabaseDumpSpec.Type type = 4 [(google.api.field_behavior) = OPTIONAL]; } @@ -645,13 +686,16 @@ message MetadataImport { string description = 2; // Output only. The time when the metadata import was started. - 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 time when the metadata import 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. The time when the metadata import finished. - google.protobuf.Timestamp end_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The current state of the metadata import. State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -678,23 +722,27 @@ message MetadataExport { } oneof destination { - // Output only. A Cloud Storage URI of a folder that metadata are exported to, in the - // form of `gs:////`, where + // Output only. A Cloud Storage URI of a folder that metadata are exported + // to, in the form of + // `gs:////`, where // `` is automatically generated. string destination_gcs_uri = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. The time when the export started. - google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the export ended. - 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 current state of the export. State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The type of the database dump. - DatabaseDumpSpec.Type database_dump_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + DatabaseDumpSpec.Type database_dump_type = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The details of a backup resource. @@ -731,10 +779,12 @@ message Backup { string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The time when the backup was started. - 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 when the backup finished creating. - google.protobuf.Timestamp end_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The current state of the backup. State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -746,7 +796,8 @@ message Backup { string description = 6; // Output only. Services that are restoring from the backup. - repeated string restoring_services = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string restoring_services = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The details of a metadata restore operation. @@ -782,16 +833,18 @@ message Restore { } // Output only. The time when the restore started. - google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the restore ended. - 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 current state of the restore. State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The relative resource name of the metastore service backup to restore - // from, in the following form: + // Output only. The relative resource name of the metastore service backup to + // restore from, in the following form: // // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. string backup = 4 [ @@ -804,37 +857,40 @@ message Restore { // Output only. The type of restore. RestoreType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The restore details containing the revision of the service to be restored - // to, in format of JSON. + // Output only. The restore details containing the revision of the service to + // be restored to, in format of JSON. string details = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices]. +// Request message for +// [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices]. message ListServicesRequest { - // Required. The relative resource name of the location of metastore services to - // list, in the following form: + // Required. The relative resource name of the location of metastore services + // to list, in the following form: // // `projects/{project_number}/locations/{location_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; - // Optional. The maximum number of services to return. The response may contain less - // than the maximum number. If unspecified, no more than 500 services are - // returned. The maximum value is 1000; values above 1000 are changed to 1000. + // Optional. The maximum number of services to return. The response may + // contain less than the maximum number. If unspecified, no more than 500 + // services are returned. The maximum value is 1000; values above 1000 are + // changed to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A page token, received from a previous [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] + // Optional. A page token, received from a previous + // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] // call. Provide this token to retrieve the subsequent page. // // To retrieve the first page, supply an empty page token. // // When paginating, other parameters provided to - // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] must match the call that provided the - // page token. + // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] + // must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The filter to apply to list results. @@ -846,7 +902,8 @@ message ListServicesRequest { string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices]. +// Response message for +// [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices]. message ListServicesResponse { // The services in the specified location. repeated Service services = 1; @@ -859,10 +916,11 @@ message ListServicesResponse { repeated string unreachable = 3; } -// Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1alpha.DataprocMetastore.GetService]. +// Request message for +// [DataprocMetastore.GetService][google.cloud.metastore.v1alpha.DataprocMetastore.GetService]. message GetServiceRequest { - // Required. The relative resource name of the metastore service to retrieve, in the - // following form: + // Required. The relative resource name of the metastore service to retrieve, + // in the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string name = 1 [ @@ -873,16 +931,17 @@ message GetServiceRequest { ]; } -// Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1alpha.DataprocMetastore.CreateService]. +// Request message for +// [DataprocMetastore.CreateService][google.cloud.metastore.v1alpha.DataprocMetastore.CreateService]. message CreateServiceRequest { - // Required. The relative resource name of the location in which to create a metastore - // service, in the following form: + // Required. The relative resource name of the location in which to create a + // metastore service, in the following form: // // `projects/{project_number}/locations/{location_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; @@ -899,10 +958,10 @@ message CreateServiceRequest { // the request's `service_id` field. Service service = 3 [(google.api.field_behavior) = REQUIRED]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -914,13 +973,15 @@ message CreateServiceRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService]. +// Request message for +// [DataprocMetastore.UpdateService][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService]. message UpdateServiceRequest { // Required. A field mask used to specify the fields to be overwritten in the // metastore service resource by the update. // Fields specified in the `update_mask` are relative to the resource (not // to the full request). A field is overwritten if it is in the mask. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The metastore service to update. The server only merges fields // in the service if they are specified in `update_mask`. @@ -929,10 +990,10 @@ message UpdateServiceRequest { // service to be updated. Service service = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -944,10 +1005,11 @@ message UpdateServiceRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService]. +// Request message for +// [DataprocMetastore.DeleteService][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService]. message DeleteServiceRequest { - // Required. The relative resource name of the metastore service to delete, in the - // following form: + // Required. The relative resource name of the metastore service to delete, in + // the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string name = 1 [ @@ -957,10 +1019,10 @@ message DeleteServiceRequest { } ]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -972,32 +1034,34 @@ message DeleteServiceRequest { string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports]. +// Request message for +// [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports]. message ListMetadataImportsRequest { - // Required. The relative resource name of the service whose metadata imports to - // list, in the following form: + // Required. The relative resource name of the service whose metadata imports + // to list, in the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; - // Optional. The maximum number of imports to return. The response may contain less - // than the maximum number. If unspecified, no more than 500 imports are + // Optional. The maximum number of imports to return. The response may contain + // less than the maximum number. If unspecified, no more than 500 imports are // returned. The maximum value is 1000; values above 1000 are changed to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A page token, received from a previous [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] + // Optional. A page token, received from a previous + // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] // call. Provide this token to retrieve the subsequent page. // // To retrieve the first page, supply an empty page token. // // When paginating, other parameters provided to - // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] must match the call that provided the - // page token. + // [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices] + // must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The filter to apply to list results. @@ -1009,7 +1073,8 @@ message ListMetadataImportsRequest { string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports]. +// Response message for +// [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports]. message ListMetadataImportsResponse { // The imports in the specified service. repeated MetadataImport metadata_imports = 1; @@ -1022,10 +1087,11 @@ message ListMetadataImportsResponse { repeated string unreachable = 3; } -// Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport]. +// Request message for +// [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport]. message GetMetadataImportRequest { - // Required. The relative resource name of the metadata import to retrieve, in the - // following form: + // Required. The relative resource name of the metadata import to retrieve, in + // the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}`. string name = 1 [ @@ -1036,36 +1102,37 @@ message GetMetadataImportRequest { ]; } -// Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport]. +// Request message for +// [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport]. message CreateMetadataImportRequest { - // Required. The relative resource name of the service in which to create a metastore - // import, in the following form: + // Required. The relative resource name of the service in which to create a + // metastore import, in the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; - // Required. The ID of the metadata import, which is used as the final component of the - // metadata import's name. + // Required. The ID of the metadata import, which is used as the final + // component of the metadata import's name. // // This value must be between 1 and 64 characters long, begin with a letter, // end with a letter or number, and consist of alpha-numeric ASCII characters // or hyphens. string metadata_import_id = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The metadata import to create. The `name` field is ignored. The ID of the - // created metadata import must be provided in the request's + // Required. The metadata import to create. The `name` field is ignored. The + // ID of the created metadata import must be provided in the request's // `metadata_import_id` field. MetadataImport metadata_import = 3 [(google.api.field_behavior) = REQUIRED]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1077,13 +1144,15 @@ message CreateMetadataImportRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport]. +// Request message for +// [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport]. message UpdateMetadataImportRequest { // Required. A field mask used to specify the fields to be overwritten in the // metadata import resource by the update. // Fields specified in the `update_mask` are relative to the resource (not // to the full request). A field is overwritten if it is in the mask. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The metadata import to update. The server only merges fields // in the import if they are specified in `update_mask`. @@ -1092,10 +1161,10 @@ message UpdateMetadataImportRequest { // import to be updated. MetadataImport metadata_import = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1107,7 +1176,8 @@ message UpdateMetadataImportRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups]. +// Request message for +// [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups]. message ListBackupsRequest { // Required. The relative resource name of the service whose backups to // list, in the following form: @@ -1116,23 +1186,24 @@ message ListBackupsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; - // Optional. The maximum number of backups to return. The response may contain less - // than the maximum number. If unspecified, no more than 500 backups are + // Optional. The maximum number of backups to return. The response may contain + // less than the maximum number. If unspecified, no more than 500 backups are // returned. The maximum value is 1000; values above 1000 are changed to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A page token, received from a previous [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] + // Optional. A page token, received from a previous + // [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] // call. Provide this token to retrieve the subsequent page. // // To retrieve the first page, supply an empty page token. // // When paginating, other parameters provided to - // [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] must match the call that provided the - // page token. + // [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups] + // must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The filter to apply to list results. @@ -1144,7 +1215,8 @@ message ListBackupsRequest { string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups]. +// Response message for +// [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups]. message ListBackupsResponse { // The backups of the specified service. repeated Backup backups = 1; @@ -1157,7 +1229,8 @@ message ListBackupsResponse { repeated string unreachable = 3; } -// Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup]. +// Request message for +// [DataprocMetastore.GetBackup][google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup]. message GetBackupRequest { // Required. The relative resource name of the backup to retrieve, in the // following form: @@ -1171,16 +1244,17 @@ message GetBackupRequest { ]; } -// Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup]. +// Request message for +// [DataprocMetastore.CreateBackup][google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup]. message CreateBackupRequest { - // Required. The relative resource name of the service in which to create a backup - // of the following form: + // Required. The relative resource name of the service in which to create a + // backup of the following form: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; @@ -1192,14 +1266,14 @@ message CreateBackupRequest { // or hyphens. string backup_id = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The backup to create. The `name` field is ignored. The ID of the created - // backup must be provided in the request's `backup_id` field. + // Required. The backup to create. The `name` field is ignored. The ID of the + // created backup must be provided in the request's `backup_id` field. Backup backup = 3 [(google.api.field_behavior) = REQUIRED]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1211,7 +1285,8 @@ message CreateBackupRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup]. +// Request message for +// [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup]. message DeleteBackupRequest { // Required. The relative resource name of the backup to delete, in the // following form: @@ -1224,10 +1299,10 @@ message DeleteBackupRequest { } ]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1239,7 +1314,8 @@ message DeleteBackupRequest { string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [DataprocMetastore.ExportMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata]. +// Request message for +// [DataprocMetastore.ExportMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata]. message ExportMetadataRequest { // Required. Destination that metadata is exported to. oneof destination { @@ -1249,8 +1325,8 @@ message ExportMetadataRequest { string destination_gcs_folder = 2; } - // Required. The relative resource name of the metastore service to run export, in the - // following form: + // Required. The relative resource name of the metastore service to run + // export, in the following form: // // `projects/{project_id}/locations/{location_id}/services/{service_id}`. string service = 1 [ @@ -1260,10 +1336,10 @@ message ExportMetadataRequest { } ]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1274,14 +1350,16 @@ message ExportMetadataRequest { // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The type of the database dump. If unspecified, defaults to `MYSQL`. - DatabaseDumpSpec.Type database_dump_type = 4 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The type of the database dump. If unspecified, defaults to + // `MYSQL`. + DatabaseDumpSpec.Type database_dump_type = 4 + [(google.api.field_behavior) = OPTIONAL]; } // Request message for [DataprocMetastore.Restore][]. message RestoreServiceRequest { - // Required. The relative resource name of the metastore service to run restore, in the - // following form: + // Required. The relative resource name of the metastore service to run + // restore, in the following form: // // `projects/{project_id}/locations/{location_id}/services/{service_id}`. string service = 1 [ @@ -1291,8 +1369,8 @@ message RestoreServiceRequest { } ]; - // Required. The relative resource name of the metastore service backup to restore - // from, in the following form: + // Required. The relative resource name of the metastore service backup to + // restore from, in the following form: // // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. string backup = 2 [ @@ -1305,10 +1383,10 @@ message RestoreServiceRequest { // Optional. The type of restore. If unspecified, defaults to `METADATA_ONLY`. Restore.RestoreType restore_type = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. A request ID. Specify a unique request ID to allow the server to ignore the - // request if it has completed. The server will ignore subsequent requests - // that provide a duplicate request ID for at least 60 minutes after the first - // request. + // Optional. A request ID. Specify a unique request ID to allow the server to + // ignore the request if it has completed. The server will ignore subsequent + // requests that provide a duplicate request ID for at least 60 minutes after + // the first request. // // For example, if an initial request times out, followed by another request // with the same request ID, the server ignores the second request to prevent @@ -1323,10 +1401,12 @@ message RestoreServiceRequest { // Represents the metadata of a 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]; @@ -1339,8 +1419,9 @@ message OperationMetadata { // Output only. Identifies whether the caller 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. @@ -1378,6 +1459,4 @@ message DatabaseDumpSpec { // Database dump contains Avro files. AVRO = 2; } - - } diff --git a/google/cloud/metastore/v1alpha/metastore_federation.proto b/google/cloud/metastore/v1alpha/metastore_federation.proto new file mode 100644 index 000000000..d4f073354 --- /dev/null +++ b/google/cloud/metastore/v1alpha/metastore_federation.proto @@ -0,0 +1,364 @@ +// 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.metastore.v1alpha; + +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/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/metastore/v1alpha;metastore"; +option java_multiple_files = true; +option java_outer_classname = "MetastoreFederationProto"; +option java_package = "com.google.cloud.metastore.v1alpha"; + +// Configures and manages metastore federation services. +// Dataproc Metastore Federation Service allows federating a collection of +// backend metastores like BigQuery, Dataplex Lakes, and other Dataproc +// Metastores. The Federation Service exposes a gRPC URL through which metadata +// from the backend metastores are served at query time. +// +// The Dataproc Metastore Federation API defines the following resource model: +// * The service works with a collection of Google Cloud projects. +// * Each project has a collection of available locations. +// * Each location has a collection of federations. +// * Dataproc Metastore Federations are resources with names of the +// form: +// `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. +service DataprocMetastoreFederation { + option (google.api.default_host) = "metastore.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists federations in a project and location. + rpc ListFederations(ListFederationsRequest) returns (ListFederationsResponse) { + option (google.api.http) = { + get: "/v1alpha/{parent=projects/*/locations/*}/federations" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a single federation. + rpc GetFederation(GetFederationRequest) returns (Federation) { + option (google.api.http) = { + get: "/v1alpha/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a metastore federation in a project and location. + rpc CreateFederation(CreateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha/{parent=projects/*/locations/*}/federations" + body: "federation" + }; + option (google.api.method_signature) = "parent,federation,federation_id"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" + }; + } + + // Updates the fields of a federation. + rpc UpdateFederation(UpdateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha/{federation.name=projects/*/locations/*/federations/*}" + body: "federation" + }; + option (google.api.method_signature) = "federation,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" + }; + } + + // Deletes a single federation. + rpc DeleteFederation(DeleteFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "google.cloud.metastore.v1alpha.OperationMetadata" + }; + } +} + +// Represents a federation of multiple backend metastores. +message Federation { + option (google.api.resource) = { + type: "metastore.googleapis.com/Federation" + pattern: "projects/{project}/locations/{location}/federations/{federation}" + }; + + // The current state of the federation. + enum State { + // The state of the metastore federation is unknown. + STATE_UNSPECIFIED = 0; + + // The metastore federation is in the process of being created. + CREATING = 1; + + // The metastore federation is running and ready to serve queries. + ACTIVE = 2; + + // The metastore federation is being updated. It remains usable but cannot + // accept additional update requests or be deleted at this time. + UPDATING = 3; + + // The metastore federation is undergoing deletion. It cannot be used. + DELETING = 4; + + // The metastore federation has encountered an error and cannot be used. The + // metastore federation should be deleted. + ERROR = 5; + } + + // Immutable. The relative resource name of the federation, of the + // form: + // projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. The time when the metastore federation was created. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the metastore federation was last updated. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // User-defined labels for the metastore federation. + map labels = 4; + + // Immutable. The Apache Hive metastore version of the federation. All backend metastore + // versions must be compatible with the federation version. + string version = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // A map from `BackendMetastore` rank to `BackendMetastore`s from which the + // federation service serves metadata at query time. The map key represents + // the order in which `BackendMetastore`s should be evaluated to resolve + // database names at query time and should be greater than or equal to zero. A + // `BackendMetastore` with a lower number will be evaluated before a + // `BackendMetastore` with a higher number. + map backend_metastores = 6; + + // Output only. The federation endpoint. + string endpoint_uri = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The current state of the federation. + State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Additional information about the current state of the metastore federation, + // if available. + string state_message = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The globally unique resource identifier of the metastore federation. + string uid = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Represents a backend metastore for the federation. +message BackendMetastore { + // The type of the backend metastore. + enum MetastoreType { + // The metastore type is not set. + METASTORE_TYPE_UNSPECIFIED = 0; + + // The backend metastore is BigQuery. + BIGQUERY = 2; + + // The backend metastore is Dataproc Metastore. + DATAPROC_METASTORE = 3; + } + + // The relative resource name of the metastore that is being federated. + // The formats of the relative resource names for the currently supported + // metastores are listed below: + // + // * Dataplex + // * `projects/{project_id}/locations/{location}/lakes/{lake_id}` + // * BigQuery + // * `projects/{project_id}` + // * Dataproc Metastore + // * `projects/{project_id}/locations/{location}/services/{service_id}` + string name = 1; + + // The type of the backend metastore. + MetastoreType metastore_type = 2; +} + +// Request message for ListFederations. +message ListFederationsRequest { + // Required. The relative resource name of the location of metastore federations + // to list, in the following form: + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. The maximum number of federations to return. The response may contain less + // than the maximum number. If unspecified, no more than 500 services are + // returned. The maximum value is 1000; values above 1000 are changed to 1000. + int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A page token, received from a previous ListFederationServices + // call. Provide this token to retrieve the subsequent page. + // + // To retrieve the first page, supply an empty page token. + // + // When paginating, other parameters provided to + // ListFederationServices must match the call that provided the + // page token. + string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The filter to apply to list results. + string filter = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Specify the ordering of results as described in [Sorting + // Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). + // If not specified, the results will be sorted in the default order. + string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for ListFederations +message ListFederationsResponse { + // The services in the specified location. + repeated Federation federations = 1; + + // A token that 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; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request message for GetFederation. +message GetFederationRequest { + // Required. The relative resource name of the metastore federation to retrieve, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; +} + +// Request message for CreateFederation. +message CreateFederationRequest { + // Required. The relative resource name of the location in which to create a federation + // service, in the following form: + // + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Required. The ID of the metastore federation, which is used as the final + // component of the metastore federation's name. + // + // This value must be between 2 and 63 characters long inclusive, begin with a + // letter, end with a letter or number, and consist of alpha-numeric + // ASCII characters or hyphens. + string federation_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Metastore Federation to create. The `name` field is + // ignored. The ID of the created metastore federation must be + // provided in the request's `federation_id` field. + Federation federation = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for UpdateFederation. +message UpdateFederationRequest { + // Required. A field mask used to specify the fields to be overwritten in the + // metastore federation resource by the update. + // Fields specified in the `update_mask` are relative to the resource (not + // to the full request). A field is overwritten if it is in the mask. + google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The metastore federation to update. The server only merges fields + // in the service if they are specified in `update_mask`. + // + // The metastore federation's `name` field is used to identify the + // metastore service to be updated. + Federation federation = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for DeleteFederation. +message DeleteFederationRequest { + // Required. The relative resource name of the metastore federation to delete, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; +} diff --git a/google/cloud/metastore/v1alpha/metastore_v1alpha.yaml b/google/cloud/metastore/v1alpha/metastore_v1alpha.yaml index e90aaee2c..9b946252e 100644 --- a/google/cloud/metastore/v1alpha/metastore_v1alpha.yaml +++ b/google/cloud/metastore/v1alpha/metastore_v1alpha.yaml @@ -4,7 +4,11 @@ name: metastore.googleapis.com title: Dataproc Metastore API apis: +- name: google.cloud.location.Locations - name: google.cloud.metastore.v1alpha.DataprocMetastore +- name: google.cloud.metastore.v1alpha.DataprocMetastoreFederation +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.metastore.v1alpha.LocationMetadata @@ -52,6 +56,8 @@ backend: deadline: 60.0 - selector: 'google.cloud.metastore.v1alpha.DataprocMetastore.*' deadline: 60.0 + - selector: 'google.cloud.metastore.v1alpha.DataprocMetastoreFederation.*' + deadline: 60.0 - selector: 'google.iam.v1.IAMPolicy.*' deadline: 60.0 - selector: 'google.longrunning.Operations.*' @@ -69,6 +75,7 @@ http: - get: '/v1alpha/{resource=projects/*/locations/*/services/*/backups/*}:getIamPolicy' - get: '/v1alpha/{resource=projects/*/locations/*/services/*/databases/*}:getIamPolicy' - get: '/v1alpha/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:getIamPolicy' + - get: '/v1alpha/{resource=projects/*/locations/*/federations/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1alpha/{resource=projects/*/locations/*/services/*}:setIamPolicy' body: '*' @@ -79,6 +86,8 @@ http: body: '*' - post: '/v1alpha/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:setIamPolicy' body: '*' + - post: '/v1alpha/{resource=projects/*/locations/*/federations/*}:setIamPolicy' + body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1alpha/{resource=projects/*/locations/*/services/*}:testIamPermissions' body: '*' @@ -89,6 +98,8 @@ http: body: '*' - post: '/v1alpha/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:testIamPermissions' body: '*' + - post: '/v1alpha/{resource=projects/*/locations/*/federations/*}:testIamPermissions' + body: '*' - selector: google.longrunning.Operations.DeleteOperation delete: '/v1alpha/{name=projects/*/locations/*/operations/*}' - selector: google.longrunning.Operations.GetOperation @@ -110,6 +121,10 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.metastore.v1alpha.DataprocMetastoreFederation.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.iam.v1.IAMPolicy.*' oauth: canonical_scopes: |- diff --git a/google/cloud/metastore/v1beta/BUILD.bazel b/google/cloud/metastore/v1beta/BUILD.bazel index dea817212..f7eb75b12 100644 --- a/google/cloud/metastore/v1beta/BUILD.bazel +++ b/google/cloud/metastore/v1beta/BUILD.bazel @@ -22,6 +22,7 @@ proto_library( name = "metastore_proto", srcs = [ "metastore.proto", + "metastore_federation.proto", ], deps = [ "//google/api:annotations_proto", @@ -72,6 +73,7 @@ java_gapic_library( srcs = [":metastore_proto_with_info"], gapic_yaml = "metastore_gapic.yaml", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":metastore_java_grpc", ], @@ -132,13 +134,16 @@ go_gapic_library( grpc_service_config = "metastore_grpc_service_config.json", importpath = "cloud.google.com/go/metastore/apiv1beta;metastore", metadata = True, + rest_numeric_enums = True, service_yaml = "metastore_v1beta.yaml", transport = "grpc+rest", deps = [ ":metastore_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -174,7 +179,10 @@ py_gapic_library( name = "metastore_py_gapic", srcs = [":metastore_proto"], grpc_service_config = "metastore_grpc_service_config.json", - opt_args = ["warehouse-package-name=google-cloud-dataproc-metastore"], + opt_args = [ + "warehouse-package-name=google-cloud-dataproc-metastore", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -223,7 +231,9 @@ php_gapic_library( srcs = [":metastore_proto_with_info"], gapic_yaml = "metastore_gapic.yaml", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1beta.yaml", + transport = "grpc+rest", deps = [ ":metastore_php_grpc", ":metastore_php_proto", @@ -256,7 +266,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "metastore_grpc_service_config.json", package = "google.cloud.metastore.v1beta", + rest_numeric_enums = True, service_yaml = "metastore_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +313,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=metastore", ], grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dataproc Metastore is a fully managed, highly available within a region, autohealing serverless Apache Hive metastore (HMS) on Google Cloud for data analytics products. It supports HMS and serves as a critical component for managing the metadata of relational entities and provides interoperability between data processing applications in the open source data ecosystem.", ruby_cloud_title = "Dataproc Metastore V1beta", deps = [ @@ -346,6 +359,7 @@ csharp_gapic_library( srcs = [":metastore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "metastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "metastore_v1beta.yaml", deps = [ ":metastore_csharp_grpc", diff --git a/google/cloud/metastore/v1beta/metastore.proto b/google/cloud/metastore/v1beta/metastore.proto index 350c6bbf3..6259c1241 100644 --- a/google/cloud/metastore/v1beta/metastore.proto +++ b/google/cloud/metastore/v1beta/metastore.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,18 +27,26 @@ import "google/protobuf/wrappers.proto"; import "google/type/dayofweek.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/metastore/v1beta;metastore"; -option php_namespace = "Google\\Cloud\\Metastore\\V1beta"; option java_multiple_files = true; option java_outer_classname = "MetastoreProto"; option java_package = "com.google.cloud.metastore.v1beta"; +option php_namespace = "Google\\Cloud\\Metastore\\V1beta"; option (google.api.resource_definition) = { type: "compute.googleapis.com/Network" pattern: "projects/{project}/global/networks/{network}" }; +option (google.api.resource_definition) = { + type: "compute.googleapis.com/Subnetwork" + pattern: "projects/{project}/regions/{region}/subnetworks/{subnetwork}" +}; +option (google.api.resource_definition) = { + type: "dataplex.googleapis.com/Lake" + pattern: "projects/{project}/locations/{location}/lakes/{lake}" +}; // Configures and manages metastore services. -// Metastore services are fully managed, highly available, auto-scaled, -// auto-healing, OSS-native deployments of technical metadata management +// Metastore services are fully managed, highly available, autoscaled, +// autohealing, OSS-native deployments of technical metadata management // software. Each metastore service exposes a network endpoint through which // metadata queries are served. Metadata queries can originate from a variety // of sources, including Apache Hive, Apache Presto, and Apache Spark. @@ -84,7 +92,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,service,service_id"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -98,7 +106,7 @@ service DataprocMetastore { option (google.api.method_signature) = "service,update_mask"; option (google.longrunning.operation_info) = { response_type: "Service" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -111,7 +119,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -143,7 +151,7 @@ service DataprocMetastore { "parent,metadata_import,metadata_import_id"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -158,7 +166,7 @@ service DataprocMetastore { option (google.api.method_signature) = "metadata_import,update_mask"; option (google.longrunning.operation_info) = { response_type: "MetadataImport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -171,7 +179,7 @@ service DataprocMetastore { }; option (google.longrunning.operation_info) = { response_type: "MetadataExport" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -185,7 +193,7 @@ service DataprocMetastore { option (google.api.method_signature) = "service,backup"; option (google.longrunning.operation_info) = { response_type: "Restore" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -205,7 +213,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; } - // Creates a new Backup in a given project and location. + // 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/*/services/*}/backups" @@ -214,7 +222,7 @@ service DataprocMetastore { option (google.api.method_signature) = "parent,backup,backup_id"; option (google.longrunning.operation_info) = { response_type: "Backup" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } @@ -226,7 +234,7 @@ service DataprocMetastore { option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { response_type: "google.protobuf.Empty" - metadata_type: "OperationMetadata" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" }; } } @@ -299,6 +307,18 @@ message Service { STABLE = 2; } + // The backend database type for the metastore service. + enum DatabaseType { + // The DATABASE_TYPE is not set. + DATABASE_TYPE_UNSPECIFIED = 0; + + // MySQL is used to persist the metastore data. + MYSQL = 1; + + // Spanner is used to persist the metastore data. + SPANNER = 2; + } + // Configuration properties specific to the underlying metastore service // technology (the software that serves metastore queries). oneof metastore_config { @@ -307,8 +327,8 @@ message Service { HiveMetastoreConfig hive_metastore_config = 5; } - // Immutable. The relative resource name of the metastore service, of the - // form: + // Immutable. The relative resource name of the metastore service, in the + // following format: // // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -359,6 +379,8 @@ message Service { // The one hour maintenance window of the metastore service. This specifies // when the service can be restarted for maintenance purposes in UTC time. + // Maintenance window is not needed for services with the SPANNER + // database type. MaintenanceWindow maintenance_window = 15; // Output only. The globally unique resource identifier of the metastore @@ -372,12 +394,31 @@ message Service { // Immutable. The release channel of the service. // If unspecified, defaults to `STABLE`. ReleaseChannel release_channel = 19 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Information used to configure the Dataproc Metastore service to + // encrypt customer data at rest. Cannot be updated. + EncryptionConfig encryption_config = 20 + [(google.api.field_behavior) = IMMUTABLE]; + + // The configuration specifying the network settings for the + // Dataproc Metastore service. + NetworkConfig network_config = 21; + + // Immutable. The database type that the Metastore service stores its data. + DatabaseType database_type = 22 [(google.api.field_behavior) = IMMUTABLE]; + + // The configuration specifying telemetry settings for the Dataproc Metastore + // service. If unspecified defaults to `JSON`. + TelemetryConfig telemetry_config = 23; } // Specifies how metastore metadata should be integrated with external services. message MetadataIntegration { // The integration config for the Data Catalog service. DataCatalogConfig data_catalog_config = 1; + + // The integration config for the Dataplex service. + DataplexConfig dataplex_config = 2; } // Specifies how metastore metadata should be integrated with the Data Catalog @@ -388,6 +429,25 @@ message DataCatalogConfig { bool enabled = 2; } +// Specifies how metastore metadata should be integrated with the Dataplex +// service. +message DataplexConfig { + // A reference to the Lake resources that this metastore service is attached + // to. The key is the lake resource name. Example: + // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. + map lake_resources = 1; +} + +// Represents a Lake resource +message Lake { + // The Lake resource name. + // Example: + // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}` + string name = 1 [ + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } + ]; +} + // Maintenance window. This specifies when Dataproc Metastore // may perform system maintenance operation to the service. message MaintenanceWindow { @@ -401,12 +461,26 @@ message MaintenanceWindow { // Specifies configuration information specific to running Hive metastore // software as the metastore service. message HiveMetastoreConfig { + // Protocols available for serving the metastore service endpoint. + enum EndpointProtocol { + // The protocol is not set. + ENDPOINT_PROTOCOL_UNSPECIFIED = 0; + + // Use the legacy Apache Thrift protocol for the metastore service endpoint. + THRIFT = 1; + + // Use the modernized gRPC protocol for the metastore service endpoint. + GRPC = 2; + } + // Immutable. The Hive metastore schema version. string version = 1 [(google.api.field_behavior) = IMMUTABLE]; // A mapping of Hive metastore configuration key-value pairs to apply to the // Hive metastore (configured in `hive-site.xml`). The mappings - // override system defaults (some keys cannot be overridden). + // override system defaults (some keys cannot be overridden). These + // overrides are also applied to auxiliary versions and can be further + // customized in the auxiliary version's `AuxiliaryVersionConfig`. map config_overrides = 2; // Information used to configure the Hive metastore service as a service @@ -415,6 +489,20 @@ message HiveMetastoreConfig { // (`hive_metastore_config.kerberos_config`) in the request's `update_mask` // while omitting this field from the request's `service`. KerberosConfig kerberos_config = 3; + + // The protocol to use for the metastore service endpoint. If unspecified, + // defaults to `THRIFT`. + EndpointProtocol endpoint_protocol = 4; + + // A mapping of Hive metastore version to the auxiliary version + // configuration. When specified, a secondary Hive metastore service is + // created along with the primary service. All auxiliary versions must be less + // than the service's primary version. The key is the auxiliary service name + // and it must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. This + // means that the first character must be a lowercase letter, and all the + // following characters must be hyphens, lowercase letters, or digits, except + // the last character, which cannot be a hyphen. + map auxiliary_versions = 5; } // Configuration information for a Kerberos principal. @@ -429,7 +517,7 @@ message KerberosConfig { string principal = 2; // A Cloud Storage URI that specifies the path to a - // krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, + // krb5.conf file. It is of the form `gs://{bucket_name}/path/to/krb5.conf`, // although the file does not need to be named krb5.conf explicitly. string krb5_config_gcs_uri = 3; } @@ -445,6 +533,81 @@ message Secret { } } +// Encryption settings for the service. +message EncryptionConfig { + // The fully qualified customer provided Cloud KMS key name to use for + // customer data encryption, in the following form: + // + // `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`. + string kms_key = 1; +} + +// Configuration information for the auxiliary service versions. +message AuxiliaryVersionConfig { + // The Hive metastore version of the auxiliary service. It must be less + // than the primary Hive metastore service's version. + string version = 1; + + // A mapping of Hive metastore configuration key-value pairs to apply to the + // auxiliary Hive metastore (configured in `hive-site.xml`) in addition to + // the primary version's overrides. If keys are present in both the auxiliary + // version's overrides and the primary version's overrides, the value from + // the auxiliary version's overrides takes precedence. + map config_overrides = 2; + + // Output only. The network configuration contains the endpoint URI(s) of the + // auxiliary Hive metastore service. + NetworkConfig network_config = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Network configuration for the Dataproc Metastore service. +message NetworkConfig { + // Contains information of the customer's network configurations. + message Consumer { + oneof vpc_resource { + // Immutable. The subnetwork of the customer project from which an IP + // address is reserved and used as the Dataproc Metastore service's + // endpoint. It is accessible to hosts in the subnet and to all + // hosts in a subnet in the same region and same network. There must + // be at least one IP address available in the subnet's primary range. The + // subnet is specified in the following form: + // + // `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}` + string subnetwork = 1 [ + (google.api.field_behavior) = IMMUTABLE, + (google.api.resource_reference) = { + type: "compute.googleapis.com/Subnetwork" + } + ]; + } + + // Output only. The URI of the endpoint used to access the metastore + // service. + string endpoint_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Immutable. The consumer-side network configuration for the Dataproc + // Metastore instance. + repeated Consumer consumers = 1 [(google.api.field_behavior) = IMMUTABLE]; +} + +// Telemetry Configuration for the Dataproc Metastore service. +message TelemetryConfig { + enum LogFormat { + // The LOG_FORMAT is not set. + LOG_FORMAT_UNSPECIFIED = 0; + + // Logging output uses the legacy `textPayload` format. + LEGACY = 1; + + // Logging output uses the `jsonPayload` format. + JSON = 2; + } + + // The output format of the Dataproc Metastore service's logs. + LogFormat log_format = 1; +} + // The metadata management activities of the metastore service. message MetadataManagementActivity { // Output only. The latest metadata exports of the metastore service. @@ -522,7 +685,7 @@ message MetadataImport { // The description of the metadata import. string description = 2; - // Output only. The time when the metadata import was created. + // Output only. The time when the metadata import was started. google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -530,6 +693,10 @@ message MetadataImport { google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The time when the metadata import finished. + google.protobuf.Timestamp end_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The current state of the metadata import. State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -601,6 +768,9 @@ message Backup { // The backup failed. FAILED = 4; + + // The backup is being restored. + RESTORING = 5; } // Immutable. The relative resource name of the backup, in the following form: @@ -624,6 +794,10 @@ message Backup { // The description of the backup. string description = 6; + + // Output only. Services that are restoring from the backup. + repeated string restoring_services = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The details of a metadata restore operation. @@ -646,7 +820,7 @@ message Restore { CANCELLED = 4; } - // The type of restore. + // The type of restore. If unspecified, defaults to `METADATA_ONLY`. enum RestoreType { // The restore type is unknown. RESTORE_TYPE_UNSPECIFIED = 0; @@ -672,7 +846,7 @@ message Restore { // Output only. The relative resource name of the metastore service backup to // restore from, in the following form: // - // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}` + // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. string backup = 4 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -698,7 +872,7 @@ message ListServicesRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; @@ -767,7 +941,7 @@ message CreateServiceRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "locations.googleapis.com/Location" + child_type: "metastore.googleapis.com/Service" } ]; @@ -870,7 +1044,7 @@ message ListMetadataImportsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; @@ -934,11 +1108,11 @@ message CreateMetadataImportRequest { // Required. The relative resource name of the service in which to create a // metastore import, in the following form: // - // `projects/{project_number}/locations/{location_id}/services/{service_id}` + // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/MetadataImport" } ]; @@ -1012,7 +1186,7 @@ message ListBackupsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; @@ -1076,11 +1250,11 @@ message CreateBackupRequest { // Required. The relative resource name of the service in which to create a // backup of the following form: // - // `projects/{project_number}/locations/{location_id}/services/{service_id}` + // `projects/{project_number}/locations/{location_id}/services/{service_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "metastore.googleapis.com/Service" + child_type: "metastore.googleapis.com/Backup" } ]; @@ -1154,7 +1328,7 @@ message ExportMetadataRequest { // Required. The relative resource name of the metastore service to run // export, in the following form: // - // `projects/{project_id}/locations/{location_id}/services/{service_id}` + // `projects/{project_id}/locations/{location_id}/services/{service_id}`. string service = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1187,7 +1361,7 @@ message RestoreServiceRequest { // Required. The relative resource name of the metastore service to run // restore, in the following form: // - // `projects/{project_id}/locations/{location_id}/services/{service_id}` + // `projects/{project_id}/locations/{location_id}/services/{service_id}`. string service = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1198,7 +1372,7 @@ message RestoreServiceRequest { // Required. The relative resource name of the metastore service backup to // restore from, in the following form: // - // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}` + // `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`. string backup = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1281,5 +1455,8 @@ message DatabaseDumpSpec { // Database dump is a MySQL dump file. MYSQL = 1; + + // Database dump contains Avro files. + AVRO = 2; } } diff --git a/google/cloud/metastore/v1beta/metastore_federation.proto b/google/cloud/metastore/v1beta/metastore_federation.proto new file mode 100644 index 000000000..c0798f7ba --- /dev/null +++ b/google/cloud/metastore/v1beta/metastore_federation.proto @@ -0,0 +1,364 @@ +// 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.metastore.v1beta; + +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/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/metastore/v1beta;metastore"; +option java_multiple_files = true; +option java_outer_classname = "MetastoreFederationProto"; +option java_package = "com.google.cloud.metastore.v1beta"; + +// Configures and manages metastore federation services. +// Dataproc Metastore Federation Service allows federating a collection of +// backend metastores like BigQuery, Dataplex Lakes, and other Dataproc +// Metastores. The Federation Service exposes a gRPC URL through which metadata +// from the backend metastores are served at query time. +// +// The Dataproc Metastore Federation API defines the following resource model: +// * The service works with a collection of Google Cloud projects. +// * Each project has a collection of available locations. +// * Each location has a collection of federations. +// * Dataproc Metastore Federations are resources with names of the +// form: +// `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. +service DataprocMetastoreFederation { + option (google.api.default_host) = "metastore.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists federations in a project and location. + rpc ListFederations(ListFederationsRequest) returns (ListFederationsResponse) { + option (google.api.http) = { + get: "/v1beta/{parent=projects/*/locations/*}/federations" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a single federation. + rpc GetFederation(GetFederationRequest) returns (Federation) { + option (google.api.http) = { + get: "/v1beta/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a metastore federation in a project and location. + rpc CreateFederation(CreateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta/{parent=projects/*/locations/*}/federations" + body: "federation" + }; + option (google.api.method_signature) = "parent,federation,federation_id"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" + }; + } + + // Updates the fields of a federation. + rpc UpdateFederation(UpdateFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1beta/{federation.name=projects/*/locations/*/federations/*}" + body: "federation" + }; + option (google.api.method_signature) = "federation,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Federation" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" + }; + } + + // Deletes a single federation. + rpc DeleteFederation(DeleteFederationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1beta/{name=projects/*/locations/*/federations/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "google.cloud.metastore.v1beta.OperationMetadata" + }; + } +} + +// Represents a federation of multiple backend metastores. +message Federation { + option (google.api.resource) = { + type: "metastore.googleapis.com/Federation" + pattern: "projects/{project}/locations/{location}/federations/{federation}" + }; + + // The current state of the federation. + enum State { + // The state of the metastore federation is unknown. + STATE_UNSPECIFIED = 0; + + // The metastore federation is in the process of being created. + CREATING = 1; + + // The metastore federation is running and ready to serve queries. + ACTIVE = 2; + + // The metastore federation is being updated. It remains usable but cannot + // accept additional update requests or be deleted at this time. + UPDATING = 3; + + // The metastore federation is undergoing deletion. It cannot be used. + DELETING = 4; + + // The metastore federation has encountered an error and cannot be used. The + // metastore federation should be deleted. + ERROR = 5; + } + + // Immutable. The relative resource name of the federation, of the + // form: + // projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. The time when the metastore federation was created. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The time when the metastore federation was last updated. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // User-defined labels for the metastore federation. + map labels = 4; + + // Immutable. The Apache Hive metastore version of the federation. All backend metastore + // versions must be compatible with the federation version. + string version = 5 [(google.api.field_behavior) = IMMUTABLE]; + + // A map from `BackendMetastore` rank to `BackendMetastore`s from which the + // federation service serves metadata at query time. The map key represents + // the order in which `BackendMetastore`s should be evaluated to resolve + // database names at query time and should be greater than or equal to zero. A + // `BackendMetastore` with a lower number will be evaluated before a + // `BackendMetastore` with a higher number. + map backend_metastores = 6; + + // Output only. The federation endpoint. + string endpoint_uri = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The current state of the federation. + State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Additional information about the current state of the metastore federation, + // if available. + string state_message = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The globally unique resource identifier of the metastore federation. + string uid = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Represents a backend metastore for the federation. +message BackendMetastore { + // The type of the backend metastore. + enum MetastoreType { + // The metastore type is not set. + METASTORE_TYPE_UNSPECIFIED = 0; + + // The backend metastore is BigQuery. + BIGQUERY = 2; + + // The backend metastore is Dataproc Metastore. + DATAPROC_METASTORE = 3; + } + + // The relative resource name of the metastore that is being federated. + // The formats of the relative resource names for the currently supported + // metastores are listed below: + // + // * Dataplex + // * `projects/{project_id}/locations/{location}/lakes/{lake_id}` + // * BigQuery + // * `projects/{project_id}` + // * Dataproc Metastore + // * `projects/{project_id}/locations/{location}/services/{service_id}` + string name = 1; + + // The type of the backend metastore. + MetastoreType metastore_type = 2; +} + +// Request message for ListFederations. +message ListFederationsRequest { + // Required. The relative resource name of the location of metastore federations + // to list, in the following form: + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. The maximum number of federations to return. The response may contain less + // than the maximum number. If unspecified, no more than 500 services are + // returned. The maximum value is 1000; values above 1000 are changed to 1000. + int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A page token, received from a previous ListFederationServices + // call. Provide this token to retrieve the subsequent page. + // + // To retrieve the first page, supply an empty page token. + // + // When paginating, other parameters provided to + // ListFederationServices must match the call that provided the + // page token. + string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The filter to apply to list results. + string filter = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Specify the ordering of results as described in [Sorting + // Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). + // If not specified, the results will be sorted in the default order. + string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Response message for ListFederations +message ListFederationsResponse { + // The services in the specified location. + repeated Federation federations = 1; + + // A token that 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; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request message for GetFederation. +message GetFederationRequest { + // Required. The relative resource name of the metastore federation to retrieve, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; +} + +// Request message for CreateFederation. +message CreateFederationRequest { + // Required. The relative resource name of the location in which to create a federation + // service, in the following form: + // + // `projects/{project_number}/locations/{location_id}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "metastore.googleapis.com/Federation" + } + ]; + + // Required. The ID of the metastore federation, which is used as the final + // component of the metastore federation's name. + // + // This value must be between 2 and 63 characters long inclusive, begin with a + // letter, end with a letter or number, and consist of alpha-numeric + // ASCII characters or hyphens. + string federation_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The Metastore Federation to create. The `name` field is + // ignored. The ID of the created metastore federation must be + // provided in the request's `federation_id` field. + Federation federation = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for UpdateFederation. +message UpdateFederationRequest { + // Required. A field mask used to specify the fields to be overwritten in the + // metastore federation resource by the update. + // Fields specified in the `update_mask` are relative to the resource (not + // to the full request). A field is overwritten if it is in the mask. + google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The metastore federation to update. The server only merges fields + // in the service if they are specified in `update_mask`. + // + // The metastore federation's `name` field is used to identify the + // metastore service to be updated. + Federation federation = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for DeleteFederation. +message DeleteFederationRequest { + // Required. The relative resource name of the metastore federation to delete, + // in the following form: + // + // `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "metastore.googleapis.com/Federation" + } + ]; + + // Optional. A request ID. Specify a unique request ID to allow the server to ignore the + // request if it has completed. The server will ignore subsequent requests + // that provide a duplicate request ID for at least 60 minutes after the first + // request. + // + // For example, if an initial request times out, followed by another request + // with the same request ID, the server ignores the second request to prevent + // the creation of duplicate commitments. + // + // The request ID must be a valid + // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + // A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; +} diff --git a/google/cloud/metastore/v1beta/metastore_v1beta.yaml b/google/cloud/metastore/v1beta/metastore_v1beta.yaml index d96088861..53c3b9f59 100644 --- a/google/cloud/metastore/v1beta/metastore_v1beta.yaml +++ b/google/cloud/metastore/v1beta/metastore_v1beta.yaml @@ -4,7 +4,11 @@ name: metastore.googleapis.com title: Dataproc Metastore API apis: +- name: google.cloud.location.Locations - name: google.cloud.metastore.v1beta.DataprocMetastore +- name: google.cloud.metastore.v1beta.DataprocMetastoreFederation +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.metastore.v1beta.LocationMetadata @@ -52,6 +56,8 @@ backend: deadline: 60.0 - selector: 'google.cloud.metastore.v1beta.DataprocMetastore.*' deadline: 60.0 + - selector: 'google.cloud.metastore.v1beta.DataprocMetastoreFederation.*' + deadline: 60.0 - selector: 'google.iam.v1.IAMPolicy.*' deadline: 60.0 - selector: 'google.longrunning.Operations.*' @@ -65,12 +71,35 @@ http: get: '/v1beta/{name=projects/*}/locations' - selector: google.iam.v1.IAMPolicy.GetIamPolicy get: '/v1beta/{resource=projects/*/locations/*/services/*}:getIamPolicy' + additional_bindings: + - get: '/v1beta/{resource=projects/*/locations/*/services/*/backups/*}:getIamPolicy' + - get: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*}:getIamPolicy' + - get: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:getIamPolicy' + - get: '/v1beta/{resource=projects/*/locations/*/federations/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1beta/{resource=projects/*/locations/*/services/*}:setIamPolicy' body: '*' + additional_bindings: + - post: '/v1beta/{resource=projects/*/locations/*/services/*/backups/*}:setIamPolicy' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*}:setIamPolicy' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:setIamPolicy' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/federations/*}:setIamPolicy' + body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1beta/{resource=projects/*/locations/*/services/*}:testIamPermissions' body: '*' + additional_bindings: + - post: '/v1beta/{resource=projects/*/locations/*/services/*/backups/*}:testIamPermissions' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*}:testIamPermissions' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/services/*/databases/*/tables/*}:testIamPermissions' + body: '*' + - post: '/v1beta/{resource=projects/*/locations/*/federations/*}:testIamPermissions' + body: '*' - selector: google.longrunning.Operations.DeleteOperation delete: '/v1beta/{name=projects/*/locations/*/operations/*}' - selector: google.longrunning.Operations.GetOperation @@ -92,6 +121,10 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.metastore.v1beta.DataprocMetastoreFederation.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.iam.v1.IAMPolicy.*' oauth: canonical_scopes: |- diff --git a/google/cloud/networkconnectivity/BUILD.bazel b/google/cloud/networkconnectivity/BUILD.bazel index dc3e874ac..2e33a131d 100644 --- a/google/cloud/networkconnectivity/BUILD.bazel +++ b/google/cloud/networkconnectivity/BUILD.bazel @@ -22,7 +22,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-network_connectivity", "ruby-cloud-env-prefix=NETWORK_CONNECTIVITY", - "ruby-cloud-wrapper-of=v1:0.0;v1alpha1:0.0", + "ruby-cloud-wrapper-of=v1:0.4;v1alpha1:0.5", "ruby-cloud-product-url=https://cloud.google.com/network-connectivity/docs", "ruby-cloud-api-id=networkconnectivity.googleapis.com", "ruby-cloud-api-shortname=networkconnectivity", diff --git a/google/cloud/networkconnectivity/v1/BUILD.bazel b/google/cloud/networkconnectivity/v1/BUILD.bazel index 873ca1a56..1cfe39d64 100644 --- a/google/cloud/networkconnectivity/v1/BUILD.bazel +++ b/google/cloud/networkconnectivity/v1/BUILD.bazel @@ -23,6 +23,7 @@ proto_library( srcs = [ "common.proto", "hub.proto", + "policy_based_routing.proto", ], deps = [ "//google/api:annotations_proto", @@ -71,10 +72,12 @@ java_gapic_library( srcs = [":networkconnectivity_proto_with_info"], gapic_yaml = None, grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1.yaml", test_deps = [ ":networkconnectivity_java_grpc", ], + transport = "grpc", deps = [ ":networkconnectivity_java_proto", "//google/api:api_java_proto", @@ -85,6 +88,7 @@ java_gapic_test( name = "networkconnectivity_java_gapic_test_suite", test_classes = [ "com.google.cloud.networkconnectivity.v1.HubServiceClientTest", + "com.google.cloud.networkconnectivity.v1.PolicyBasedRoutingServiceClientTest", ], runtime_deps = [":networkconnectivity_java_gapic_test"], ) @@ -93,6 +97,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-networkconnectivity-v1-java", include_samples = True, + transport = "grpc", deps = [ ":networkconnectivity_java_gapic", ":networkconnectivity_java_grpc", @@ -129,12 +134,16 @@ go_gapic_library( grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", importpath = "cloud.google.com/go/networkconnectivity/apiv1;networkconnectivity", metadata = True, + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1.yaml", + transport = "grpc", deps = [ ":networkconnectivity_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -170,6 +179,8 @@ py_gapic_library( name = "networkconnectivity_py_gapic", srcs = [":networkconnectivity_proto"], grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", + opt_args = ["warehouse-package-name=google-cloud-network-connectivity"], + rest_numeric_enums = True, transport = "grpc", ) @@ -217,7 +228,9 @@ php_gapic_library( name = "networkconnectivity_php_gapic", srcs = [":networkconnectivity_proto_with_info"], grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1.yaml", + transport = "grpc+rest", deps = [ ":networkconnectivity_php_grpc", ":networkconnectivity_php_proto", @@ -250,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", package = "google.cloud.networkconnectivity.v1", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1.yaml", + transport = "grpc", deps = [], ) @@ -295,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/network-connectivity/docs", ], grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Network Connectivity is Google's suite of products that provide enterprise connectivity from your on-premises network or from another cloud provider to your Virtual Private Cloud (VPC) network.", ruby_cloud_title = "Network Connectivity V1", deps = [ @@ -340,6 +356,7 @@ csharp_gapic_library( srcs = [":networkconnectivity_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkconnectivity_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1.yaml", deps = [ ":networkconnectivity_csharp_grpc", diff --git a/google/cloud/networkconnectivity/v1/common.proto b/google/cloud/networkconnectivity/v1/common.proto index 21999d592..282cf3475 100644 --- a/google/cloud/networkconnectivity/v1/common.proto +++ b/google/cloud/networkconnectivity/v1/common.proto @@ -17,6 +17,7 @@ syntax = "proto3"; package google.cloud.networkconnectivity.v1; import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; import "google/protobuf/timestamp.proto"; option csharp_namespace = "Google.Cloud.NetworkConnectivity.V1"; @@ -26,6 +27,14 @@ option java_outer_classname = "CommonProto"; option java_package = "com.google.cloud.networkconnectivity.v1"; option php_namespace = "Google\\Cloud\\NetworkConnectivity\\V1"; option ruby_package = "Google::Cloud::NetworkConnectivity::V1"; +option (google.api.resource_definition) = { + type: "compute.googleapis.com/InterconnectAttachment" + pattern: "projects/{project}/regions/{region}/interconnectAttachments/{resource_id}" +}; +option (google.api.resource_definition) = { + type: "compute.googleapis.com/Network" + pattern: "projects/{project}/global/networks/{resource_id}" +}; // Represents the metadata of the long-running operation. message OperationMetadata { diff --git a/google/cloud/networkconnectivity/v1/hub.proto b/google/cloud/networkconnectivity/v1/hub.proto index c28ca9a07..44cf09ae0 100644 --- a/google/cloud/networkconnectivity/v1/hub.proto +++ b/google/cloud/networkconnectivity/v1/hub.proto @@ -35,27 +35,20 @@ option (google.api.resource_definition) = { type: "compute.googleapis.com/VpnTunnel" pattern: "projects/{project}/regions/{region}/vpnTunnels/{resource_id}" }; -option (google.api.resource_definition) = { - type: "compute.googleapis.com/InterconnectAttachment" - pattern: "projects/{project}/regions/{region}/interconnectAttachments/{resource_id}" -}; option (google.api.resource_definition) = { type: "compute.googleapis.com/Instance" pattern: "projects/{project}/zones/{zone}/instances/{instance}" }; -option (google.api.resource_definition) = { - type: "compute.googleapis.com/Network" - pattern: "projects/{project}/global/networks/{resource_id}" -}; // Network Connectivity Center is a hub-and-spoke abstraction for network // connectivity management in Google Cloud. It reduces operational complexity // through a simple, centralized connectivity management model. service HubService { option (google.api.default_host) = "networkconnectivity.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"; - // Lists hubs in a given project. + // Lists the Network Connectivity Center hubs associated with a given project. rpc ListHubs(ListHubsRequest) returns (ListHubsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/global}/hubs" @@ -63,7 +56,7 @@ service HubService { option (google.api.method_signature) = "parent"; } - // Gets details about the specified hub. + // Gets details about a Network Connectivity Center hub. rpc GetHub(GetHubRequest) returns (Hub) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/global/hubs/*}" @@ -71,7 +64,7 @@ service HubService { option (google.api.method_signature) = "name"; } - // Creates a new hub in the specified project. + // Creates a new Network Connectivity Center hub in the specified project. rpc CreateHub(CreateHubRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/global}/hubs" @@ -84,7 +77,8 @@ service HubService { }; } - // Updates the description and/or labels of the specified hub. + // Updates the description and/or labels of a Network Connectivity Center + // hub. rpc UpdateHub(UpdateHubRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{hub.name=projects/*/locations/global/hubs/*}" @@ -97,7 +91,7 @@ service HubService { }; } - // Deletes the specified hub. + // Deletes a Network Connectivity Center hub. rpc DeleteHub(DeleteHubRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/global/hubs/*}" @@ -109,7 +103,8 @@ service HubService { }; } - // Lists the spokes in the specified project and location. + // Lists the Network Connectivity Center spokes in a specified project and + // location. rpc ListSpokes(ListSpokesRequest) returns (ListSpokesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/spokes" @@ -117,7 +112,7 @@ service HubService { option (google.api.method_signature) = "parent"; } - // Gets details about the specified spoke. + // Gets details about a Network Connectivity Center spoke. rpc GetSpoke(GetSpokeRequest) returns (Spoke) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/spokes/*}" @@ -125,7 +120,7 @@ service HubService { option (google.api.method_signature) = "name"; } - // Creates a spoke in the specified project and location. + // Creates a Network Connectivity Center spoke. rpc CreateSpoke(CreateSpokeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/spokes" @@ -138,7 +133,7 @@ service HubService { }; } - // Updates the parameters of the specified spoke. + // Updates the parameters of a Network Connectivity Center spoke. rpc UpdateSpoke(UpdateSpokeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{spoke.name=projects/*/locations/*/spokes/*}" @@ -151,7 +146,7 @@ service HubService { }; } - // Deletes the specified spoke. + // Deletes a Network Connectivity Center spoke. rpc DeleteSpoke(DeleteSpokeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/spokes/*}" @@ -164,6 +159,18 @@ service HubService { } } +// Supported features for a location +enum LocationFeature { + // No publicly supported feature in this location + LOCATION_FEATURE_UNSPECIFIED = 0; + + // Site-to-cloud spokes are supported in this location + SITE_TO_CLOUD_SPOKES = 1; + + // Site-to-site spokes are supported in this location + SITE_TO_SITE_SPOKES = 2; +} + // The State enum represents the lifecycle stage of a Network Connectivity // Center resource. enum State { @@ -178,25 +185,16 @@ enum State { // The resource's Delete operation is in progress DELETING = 3; -} -// Supported features for a location -enum LocationFeature { - // No publicly supported feature in this location - LOCATION_FEATURE_UNSPECIFIED = 0; - - // Site-to-cloud spokes are supported in this location - SITE_TO_CLOUD_SPOKES = 1; - - // Site-to-site spokes are supported in this location - SITE_TO_SITE_SPOKES = 2; + // The resource's Update operation is in progress + UPDATING = 6; } -// A hub is a collection of spokes. A single hub can contain spokes from -// multiple regions. However, if any of a hub's spokes use the data transfer -// feature, the resources associated with those spokes must all reside in the -// same VPC network. Spokes that do not use data transfer can be associated -// with any VPC network in your project. +// A Network Connectivity Center hub is a collection of spokes. A single hub +// can contain spokes from multiple regions. However, if any of a hub's spokes +// use the data transfer feature, the resources associated with those spokes +// must all reside in the same VPC network. Spokes that do not use data +// transfer can be associated with any VPC network in your project. message Hub { option (google.api.resource) = { type: "networkconnectivity.googleapis.com/Hub" @@ -209,10 +207,12 @@ message Hub { string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The time the hub 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 the hub was 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]; // Optional labels in key:value format. For more information about labels, see // [Requirements for @@ -222,9 +222,9 @@ message Hub { // An optional description of the hub. string description = 5; - // Output only. The Google-generated UUID for the hub. This value is unique across all hub - // resources. If a hub is deleted and another with the same name is created, - // the new hub is assigned a different unique_id. + // Output only. The Google-generated UUID for the hub. This value is unique + // across all hub resources. If a hub is deleted and another with the same + // name is created, the new hub is assigned a different unique_id. string unique_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The current lifecycle state of this hub. @@ -237,24 +237,25 @@ message Hub { repeated RoutingVPC routing_vpcs = 10; } -// RoutingVPC contains information about the VPC networks that are associated -// with a hub's spokes. +// RoutingVPC contains information about the VPC networks associated +// with the spokes of a Network Connectivity Center hub. message RoutingVPC { // The URI of the VPC network. - string uri = 1 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - }]; + string uri = 1 [ + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; - // Output only. If true, indicates that this VPC network is currently associated with - // spokes that use the data transfer feature (spokes where the + // Output only. If true, indicates that this VPC network is currently + // associated with spokes that use the data transfer feature (spokes where the // site_to_site_data_transfer field is set to true). If you create new spokes // that use data transfer, they must be associated with this VPC network. At // most, one VPC network will have this field set to true. - bool required_for_new_site_to_site_data_transfer_spokes = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + bool required_for_new_site_to_site_data_transfer_spokes = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// A spoke represents a connection between your Google Cloud network resources -// and a non-Google-Cloud network. +// A Network Connectivity Center spoke represents a connection between your +// Google Cloud network resources and a non-Google-Cloud network. // // When you create a spoke, you associate it with a hub. You must also identify // a value for exactly one of the following fields: @@ -274,10 +275,12 @@ message Spoke { string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The time the spoke 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 the spoke was 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]; // Optional labels in key:value format. For more information about labels, see // [Requirements for @@ -304,16 +307,18 @@ message Spoke { // Router appliance instances that are associated with the spoke. LinkedRouterApplianceInstances linked_router_appliance_instances = 19; - // Output only. The Google-generated UUID for the spoke. This value is unique across all - // spoke resources. If a spoke is deleted and another with the same name is - // created, the new spoke is assigned a different unique_id. + // Output only. The Google-generated UUID for the spoke. This value is unique + // across all spoke resources. If a spoke is deleted and another with the same + // name is created, the new spoke is assigned a different unique_id. string unique_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The current lifecycle state of this spoke. State state = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request for [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] method. +// Request for +// [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] +// method. message ListHubsRequest { // Required. The parent resource's name. string parent = 1 [ @@ -336,7 +341,9 @@ message ListHubsRequest { string order_by = 5; } -// Response for [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] method. +// Response for +// [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] +// method. message ListHubsResponse { // The requested hubs. repeated Hub hubs = 1; @@ -349,7 +356,9 @@ message ListHubsResponse { repeated string unreachable = 3; } -// Request for [HubService.GetHub][google.cloud.networkconnectivity.v1.HubService.GetHub] method. +// Request for +// [HubService.GetHub][google.cloud.networkconnectivity.v1.HubService.GetHub] +// method. message GetHubRequest { // Required. The name of the hub resource to get. string name = 1 [ @@ -360,7 +369,9 @@ message GetHubRequest { ]; } -// Request for [HubService.CreateHub][google.cloud.networkconnectivity.v1.HubService.CreateHub] method. +// Request for +// [HubService.CreateHub][google.cloud.networkconnectivity.v1.HubService.CreateHub] +// method. message CreateHubRequest { // Required. The parent resource. string parent = 1 [ @@ -376,11 +387,11 @@ message CreateHubRequest { // Required. The initial values for a new hub. Hub hub = 3 [(google.api.field_behavior) = REQUIRED]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -393,23 +404,26 @@ message CreateHubRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request for [HubService.UpdateHub][google.cloud.networkconnectivity.v1.HubService.UpdateHub] method. +// Request for +// [HubService.UpdateHub][google.cloud.networkconnectivity.v1.HubService.UpdateHub] +// method. message UpdateHubRequest { - // Optional. In the case of an update to an existing hub, field mask is used to specify - // the fields to be overwritten. The fields specified in the update_mask are - // relative to the resource, not the full request. A field is overwritten if - // it is in the mask. If the user does not provide a mask, then all fields are - // overwritten. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL]; + // Optional. In the case of an update to an existing hub, field mask is used + // to specify the fields to be overwritten. The fields specified in the + // update_mask are relative to the resource, not the full request. A field is + // overwritten if it is in the mask. If the user does not provide a mask, then + // all fields are overwritten. + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = OPTIONAL]; // Required. The state that the hub should be in after the update. Hub hub = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -422,7 +436,8 @@ message UpdateHubRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The request for [HubService.DeleteHub][google.cloud.networkconnectivity.v1.HubService.DeleteHub]. +// The request for +// [HubService.DeleteHub][google.cloud.networkconnectivity.v1.HubService.DeleteHub]. message DeleteHubRequest { // Required. The name of the hub to delete. string name = 1 [ @@ -432,11 +447,11 @@ message DeleteHubRequest { } ]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -449,7 +464,8 @@ message DeleteHubRequest { string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; } -// The request for [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. +// The request for +// [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. message ListSpokesRequest { // Required. The parent resource. string parent = 1 [ @@ -472,7 +488,8 @@ message ListSpokesRequest { string order_by = 5; } -// The response for [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. +// The response for +// [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. message ListSpokesResponse { // The requested spokes. repeated Spoke spokes = 1; @@ -485,7 +502,8 @@ message ListSpokesResponse { repeated string unreachable = 3; } -// The request for [HubService.GetSpoke][google.cloud.networkconnectivity.v1.HubService.GetSpoke]. +// The request for +// [HubService.GetSpoke][google.cloud.networkconnectivity.v1.HubService.GetSpoke]. message GetSpokeRequest { // Required. The name of the spoke resource. string name = 1 [ @@ -496,7 +514,8 @@ message GetSpokeRequest { ]; } -// The request for [HubService.CreateSpoke][google.cloud.networkconnectivity.v1.HubService.CreateSpoke]. +// The request for +// [HubService.CreateSpoke][google.cloud.networkconnectivity.v1.HubService.CreateSpoke]. message CreateSpokeRequest { // Required. The parent resource. string parent = 1 [ @@ -512,11 +531,11 @@ message CreateSpokeRequest { // Required. The initial values for a new spoke. Spoke spoke = 3 [(google.api.field_behavior) = REQUIRED]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -529,23 +548,26 @@ message CreateSpokeRequest { string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request for [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1.HubService.UpdateSpoke] method. +// Request for +// [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1.HubService.UpdateSpoke] +// method. message UpdateSpokeRequest { - // Optional. In the case of an update to an existing spoke, field mask is used to - // specify the fields to be overwritten. The fields specified in the + // Optional. In the case of an update to an existing spoke, field mask is used + // to specify the fields to be overwritten. The fields specified in the // update_mask are relative to the resource, not the full request. A field is // overwritten if it is in the mask. If the user does not provide a mask, then // all fields are overwritten. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = OPTIONAL]; // Required. The state that the spoke should be in after the update. Spoke spoke = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -558,7 +580,8 @@ message UpdateSpokeRequest { string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The request for [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1.HubService.DeleteSpoke]. +// The request for +// [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1.HubService.DeleteSpoke]. message DeleteSpokeRequest { // Required. The name of the spoke to delete. string name = 1 [ @@ -568,11 +591,11 @@ message DeleteSpokeRequest { } ]; - // Optional. A unique request ID (optional). If you specify this ID, you can use it - // in cases when you need to retry your request. When you need to retry, this - // ID lets the server know that it can ignore the request if it has already - // been completed. The server guarantees that for at least 60 minutes after - // the first request. + // Optional. A unique request ID (optional). If you specify this ID, you can + // use it in cases when you need to retry your request. When you need to + // retry, this ID lets the server know that it can ignore the request if it + // has already been completed. The server guarantees 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 @@ -592,13 +615,19 @@ message DeleteSpokeRequest { message LinkedVpnTunnels { // The URIs of linked VPN tunnel resources. repeated string uris = 1 [(google.api.resource_reference) = { - type: "compute.googleapis.com/VpnTunnel" - }]; + type: "compute.googleapis.com/VpnTunnel" + }]; // A value that controls whether site-to-site data transfer is enabled for // these resources. Data transfer is available only in [supported // locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). bool site_to_site_data_transfer = 2; + + // Output only. The VPC network where these VPN tunnels are located. + string vpc_network = 3 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; } // A collection of VLAN attachment resources. These resources should @@ -608,13 +637,19 @@ message LinkedVpnTunnels { message LinkedInterconnectAttachments { // The URIs of linked interconnect attachment resources repeated string uris = 1 [(google.api.resource_reference) = { - type: "compute.googleapis.com/InterconnectAttachment" - }]; + type: "compute.googleapis.com/InterconnectAttachment" + }]; // A value that controls whether site-to-site data transfer is enabled for // these resources. Data transfer is available only in [supported // locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). bool site_to_site_data_transfer = 2; + + // Output only. The VPC network where these VLAN attachments are located. + string vpc_network = 3 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; } // A collection of router appliance instances. If you configure multiple router @@ -629,6 +664,13 @@ message LinkedRouterApplianceInstances { // these resources. Data transfer is available only in [supported // locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). bool site_to_site_data_transfer = 2; + + // Output only. The VPC network where these router appliance instances are + // located. + string vpc_network = 3 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; } // A router appliance instance is a Compute Engine virtual machine (VM) instance @@ -638,8 +680,8 @@ message LinkedRouterApplianceInstances { message RouterApplianceInstance { // The URI of the VM. string virtual_machine = 1 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Instance" - }]; + type: "compute.googleapis.com/Instance" + }]; // The IP address on the VM to use for peering. string ip_address = 3; diff --git a/google/cloud/networkconnectivity/v1/networkconnectivity_v1.yaml b/google/cloud/networkconnectivity/v1/networkconnectivity_v1.yaml index 32f961b15..d46c99a7a 100644 --- a/google/cloud/networkconnectivity/v1/networkconnectivity_v1.yaml +++ b/google/cloud/networkconnectivity/v1/networkconnectivity_v1.yaml @@ -4,15 +4,19 @@ name: networkconnectivity.googleapis.com title: Network Connectivity API apis: +- name: google.cloud.location.Locations - name: google.cloud.networkconnectivity.v1.HubService +- name: google.cloud.networkconnectivity.v1.PolicyBasedRoutingService +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.networkconnectivity.v1.LocationMetadata - name: google.cloud.networkconnectivity.v1.OperationMetadata documentation: - summary: The Network Connectivity API provides access to Network Connectivity Center. - overview: The Network Connectivity API provides access to Network Connectivity Center. + summary: This API enables connectivity with and between Google Cloud resources. + overview: This API enables connectivity with and between Google Cloud resources. rules: - selector: google.cloud.location.Locations.GetLocation description: Gets information about a location. @@ -51,6 +55,8 @@ backend: deadline: 60.0 - selector: 'google.cloud.networkconnectivity.v1.HubService.*' deadline: 60.0 + - selector: 'google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.*' + deadline: 60.0 - selector: 'google.iam.v1.IAMPolicy.*' deadline: 60.0 - selector: 'google.longrunning.Operations.*' @@ -67,6 +73,9 @@ http: additional_bindings: - get: '/v1/{resource=projects/*/locations/*/spokes/*}:getIamPolicy' - get: '/v1/{resource=projects/*/locations/global/policyBasedRoutes/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/serviceConnectionMaps/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/serviceConnectionPolicies/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/serviceClasses/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy post: '/v1/{resource=projects/*/locations/global/hubs/*}:setIamPolicy' body: '*' @@ -75,6 +84,12 @@ http: body: '*' - post: '/v1/{resource=projects/*/locations/global/policyBasedRoutes/*}:setIamPolicy' body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceConnectionMaps/*}:setIamPolicy' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceConnectionPolicies/*}:setIamPolicy' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceClasses/*}:setIamPolicy' + body: '*' - selector: google.iam.v1.IAMPolicy.TestIamPermissions post: '/v1/{resource=projects/*/locations/global/hubs/*}:testIamPermissions' body: '*' @@ -83,6 +98,12 @@ http: body: '*' - post: '/v1/{resource=projects/*/locations/global/policyBasedRoutes/*}:testIamPermissions' body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceConnectionMaps/*}:testIamPermissions' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceConnectionPolicies/*}:testIamPermissions' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/serviceClasses/*}:testIamPermissions' + body: '*' - selector: google.longrunning.Operations.CancelOperation post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' body: '*' @@ -107,6 +128,10 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.iam.v1.IAMPolicy.*' oauth: canonical_scopes: |- diff --git a/google/cloud/networkconnectivity/v1/networkconnectivity_v1_grpc_service_config.json b/google/cloud/networkconnectivity/v1/networkconnectivity_v1_grpc_service_config.json index d36327bfb..3b2a43050 100644 --- a/google/cloud/networkconnectivity/v1/networkconnectivity_v1_grpc_service_config.json +++ b/google/cloud/networkconnectivity/v1/networkconnectivity_v1_grpc_service_config.json @@ -1,6 +1,7 @@ { "methodConfig": [{ - "name": [{ "service": "google.cloud.networkconnectivity.v1.HubService" }], + "name": [{ "service": "google.cloud.networkconnectivity.v1.HubService" }, + { "service": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService" }], "timeout": "60s", "retryPolicy": { "maxAttempts": 5, @@ -19,7 +20,9 @@ { "service": "google.cloud.networkconnectivity.v1.HubService", "method": "UpdateSpoke" }, { "service": "google.cloud.networkconnectivity.v1.HubService", "method": "DeactivateSpoke" }, { "service": "google.cloud.networkconnectivity.v1.HubService", "method": "ActivateSpoke" }, - { "service": "google.cloud.networkconnectivity.v1.HubService", "method": "DeleteSpoke" } + { "service": "google.cloud.networkconnectivity.v1.HubService", "method": "DeleteSpoke" }, + { "service": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService", "method": "CreatePolicyBasedRoute" }, + { "service": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService", "method": "DeletePolicyBasedRoute" } ], "timeout": "60s" }] diff --git a/google/cloud/networkconnectivity/v1/policy_based_routing.proto b/google/cloud/networkconnectivity/v1/policy_based_routing.proto new file mode 100644 index 000000000..74c24bd39 --- /dev/null +++ b/google/cloud/networkconnectivity/v1/policy_based_routing.proto @@ -0,0 +1,338 @@ +// 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.networkconnectivity.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/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.NetworkConnectivity.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1;networkconnectivity"; +option java_multiple_files = true; +option java_outer_classname = "PolicyBasedRoutingProto"; +option java_package = "com.google.cloud.networkconnectivity.v1"; +option php_namespace = "Google\\Cloud\\NetworkConnectivity\\V1"; +option ruby_package = "Google::Cloud::NetworkConnectivity::V1"; + +// Policy-Based Routing allows GCP customers to specify flexibile routing +// policies for Layer 4 traffic traversing through the connected service. +service PolicyBasedRoutingService { + option (google.api.default_host) = "networkconnectivity.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists PolicyBasedRoutes in a given project and location. + rpc ListPolicyBasedRoutes(ListPolicyBasedRoutesRequest) returns (ListPolicyBasedRoutesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/global}/policyBasedRoutes" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single PolicyBasedRoute. + rpc GetPolicyBasedRoute(GetPolicyBasedRouteRequest) returns (PolicyBasedRoute) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new PolicyBasedRoute in a given project and location. + rpc CreatePolicyBasedRoute(CreatePolicyBasedRouteRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/global}/policyBasedRoutes" + body: "policy_based_route" + }; + option (google.api.method_signature) = "parent,policy_based_route,policy_based_route_id"; + option (google.longrunning.operation_info) = { + response_type: "PolicyBasedRoute" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single PolicyBasedRoute. + rpc DeletePolicyBasedRoute(DeletePolicyBasedRouteRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } +} + +// Policy Based Routes (PBR) are more powerful routes that allows GCP customers +// to route their L4 network traffic based on not just destination IP, but also +// source IP, protocol and more. A PBR always take precedence when it conflicts +// with other types of routes. +// Next id: 19 +message PolicyBasedRoute { + option (google.api.resource) = { + type: "networkconnectivity.googleapis.com/PolicyBasedRoute" + pattern: "projects/{project}/{location}/global/PolicyBasedRoutes/{policy_based_route}" + }; + + // VM instances to which this policy based route applies to. + message VirtualMachine { + // Optional. A list of VM instance tags to which this policy based route applies to. + // VM instances that have ANY of tags specified here will install this + // PBR. + repeated string tags = 1 [(google.api.field_behavior) = OPTIONAL]; + } + + // InterconnectAttachment to which this route applies to. + message InterconnectAttachment { + // Optional. Cloud region to install this policy based route on interconnect + // attachment. Use `all` to install it on all interconnect attachments. + string region = 1 [(google.api.field_behavior) = OPTIONAL]; + } + + // Filter matches L4 traffic. + message Filter { + // The internet protocol version. + enum ProtocolVersion { + // Default value. + PROTOCOL_VERSION_UNSPECIFIED = 0; + + // The PBR is for IPv4 internet protocol traffic. + IPV4 = 1; + } + + // Optional. The IP protocol that this policy based route applies to. Valid values are + // 'TCP', 'UDP', and 'ALL'. Default is 'ALL'. + string ip_protocol = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The source IP range of outgoing packets that this policy based route + // applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + string src_range = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The destination IP range of outgoing packets that this policy based route + // applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + string dest_range = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Required. Internet protocol versions this policy based route applies to. For this + // version, only IPV4 is supported. + ProtocolVersion protocol_version = 6 [(google.api.field_behavior) = REQUIRED]; + } + + // Informational warning message. + message Warnings { + // Warning code for Policy Based Routing. Expect to add values in the + // future. + enum Code { + // Default value. + WARNING_UNSPECIFIED = 0; + + // The policy based route is not active and functioning. Common causes are + // the dependent network was deleted or the resource project was turned + // off. + RESOURCE_NOT_ACTIVE = 1; + + // The policy based route is being modified (e.g. created/deleted) at this + // time. + RESOURCE_BEING_MODIFIED = 2; + } + + // Output only. A warning code, if applicable. + Code code = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Metadata about this warning in key: value format. The key should provides + // more detail on the warning being returned. For example, for warnings + // where there are no results in a list request for a particular zone, this + // key might be scope and the key value might be the zone name. Other + // examples might be a key indicating a deprecated resource and a suggested + // replacement. + map data = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A human-readable description of the warning code. + string warning_message = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Target specifies network endpoints to which this policy based route applies + // to. If none of the target is specified, the PBR will be installed on all + // network endpoints (e.g. VMs, VPNs, and Interconnects) in the VPC. + oneof target { + // Optional. VM instances to which this policy based route applies to. + VirtualMachine virtual_machine = 18 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The interconnect attachments to which this route applies to. + InterconnectAttachment interconnect_attachment = 9 [(google.api.field_behavior) = OPTIONAL]; + } + + oneof next_hop { + // Optional. The IP of a global access enabled L4 ILB that should be the next hop to + // handle matching packets. For this version, only next_hop_ilb_ip is + // supported. + string next_hop_ilb_ip = 12 [(google.api.field_behavior) = OPTIONAL]; + } + + // Immutable. A unique name of the resource in the form of + // `projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}` + string name = 1 [(google.api.field_behavior) = IMMUTABLE]; + + // Output only. Time when the PolicyBasedRoute was created. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the PolicyBasedRoute was updated. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // User-defined labels. + map labels = 4; + + // Optional. An optional description of this resource. Provide this field when you + // create the resource. + string description = 5 [(google.api.field_behavior) = OPTIONAL]; + + // Required. Fully-qualified URL of the network that this route applies to. e.g. + // projects/my-project/global/networks/my-network. + string network = 6 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "compute.googleapis.com/Network" + } + ]; + + // Required. The filter to match L4 traffic. + Filter filter = 10 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The priority of this policy based route. Priority is used to break ties in + // cases where there are more than one matching policy based routes found. In + // cases where multiple policy based routes are matched, the one with the + // lowest-numbered priority value wins. The default value is 1000. The + // priority value must be from 1 to 65535, inclusive. + int32 priority = 11 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. If potential misconfigurations are detected for this route, + // this field will be populated with warning messages. + repeated Warnings warnings = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Server-defined fully-qualified URL for this resource. + string self_link = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for + // Policy Based Route resources. + string kind = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request for [PolicyBasedRouting.ListPolicyBasedRoutes][] method. +message ListPolicyBasedRoutesRequest { + // Required. The parent resource's name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The maximum number of results per page that should be returned. + int32 page_size = 2; + + // The page token. + string page_token = 3; + + // A filter expression that filters the results listed in the response. + string filter = 4; + + // Sort the results by a certain order. + string order_by = 5; +} + +// Response for [PolicyBasedRouting.ListPolicyBasedRoutes][] method. +message ListPolicyBasedRoutesResponse { + // Policy based routes to be returned. + repeated PolicyBasedRoute policy_based_routes = 1; + + // The next pagination token in the List response. It should be used as + // page_token for the following request. An empty value means no more result. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request for [PolicyBasedRouting.GetPolicyBasedRoute][] method. +message GetPolicyBasedRouteRequest { + // Required. Name of the PolicyBasedRoute resource to get. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "networkconnectivity.googleapis.com/PolicyBasedRoute" + } + ]; +} + +// Request for [PolicyBasedRouting.CreatePolicyBasedRoute][] method. +message CreatePolicyBasedRouteRequest { + // Required. The parent resource's name of the PolicyBasedRoute. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Optional. Unique id for the Policy Based Route to create. + string policy_based_route_id = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Required. Initial values for a new Policy Based Route. + PolicyBasedRoute policy_based_route = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request for [PolicyBasedRouting.DeletePolicyBasedRoute][] method. +message DeletePolicyBasedRouteRequest { + // Required. Name of the PolicyBasedRoute resource to delete. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "networkconnectivity.googleapis.com/PolicyBasedRoute" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} diff --git a/google/cloud/networkconnectivity/v1alpha1/BUILD.bazel b/google/cloud/networkconnectivity/v1alpha1/BUILD.bazel index 313c9a738..f420ba47a 100644 --- a/google/cloud/networkconnectivity/v1alpha1/BUILD.bazel +++ b/google/cloud/networkconnectivity/v1alpha1/BUILD.bazel @@ -70,9 +70,11 @@ java_gapic_library( name = "networkconnectivity_java_gapic", srcs = [":networkconnectivity_proto_with_info"], grpc_service_config = "networkconnectivity_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":networkconnectivity_java_grpc", ], + transport = "grpc", deps = [ ":networkconnectivity_java_proto", ], @@ -90,6 +92,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-networkconnectivity-v1alpha1-java", include_samples = True, + transport = "grpc", deps = [ ":networkconnectivity_java_gapic", ":networkconnectivity_java_grpc", @@ -126,12 +129,14 @@ go_gapic_library( grpc_service_config = "networkconnectivity_grpc_service_config.json", importpath = "cloud.google.com/go/networkconnectivity/apiv1alpha1;networkconnectivity", metadata = True, + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1alpha1.yaml", + transport = "grpc+rest", deps = [ ":networkconnectivity_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -168,6 +173,7 @@ py_gapic_library( srcs = [":networkconnectivity_proto"], grpc_service_config = "networkconnectivity_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-network-connectivity"], + rest_numeric_enums = True, transport = "grpc", ) @@ -215,7 +221,9 @@ php_gapic_library( name = "networkconnectivity_php_gapic", srcs = [":networkconnectivity_proto_with_info"], grpc_service_config = "networkconnectivity_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1alpha1.yaml", + transport = "grpc+rest", deps = [ ":networkconnectivity_php_grpc", ":networkconnectivity_php_proto", @@ -248,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkconnectivity_grpc_service_config.json", package = "google.cloud.networkconnectivity.v1alpha1", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1alpha1.yaml", + transport = "grpc", deps = [], ) @@ -293,6 +303,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/network-connectivity/docs", ], grpc_service_config = "networkconnectivity_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Network Connectivity is Google's suite of products that provide enterprise connectivity from your on-premises network or from another cloud provider to your Virtual Private Cloud (VPC) network.", ruby_cloud_title = "Network Connectivity V1alpha1", deps = [ @@ -338,6 +349,7 @@ csharp_gapic_library( srcs = [":networkconnectivity_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkconnectivity_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkconnectivity_v1alpha1.yaml", deps = [ ":networkconnectivity_csharp_grpc", diff --git a/google/cloud/networkmanagement/v1/BUILD.bazel b/google/cloud/networkmanagement/v1/BUILD.bazel index 4a84ff7da..8da772eda 100644 --- a/google/cloud/networkmanagement/v1/BUILD.bazel +++ b/google/cloud/networkmanagement/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "networkmanagement_java_gapic", srcs = [":networkmanagement_proto_with_info"], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":networkmanagement_java_grpc", ], @@ -132,13 +133,14 @@ go_gapic_library( grpc_service_config = "networkmanagement_grpc_service_config.json", importpath = "cloud.google.com/go/networkmanagement/apiv1;networkmanagement", metadata = True, + rest_numeric_enums = True, service_yaml = "networkmanagement_v1.yaml", transport = "grpc+rest", deps = [ ":networkmanagement_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -178,6 +180,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=network_management", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "networkmanagement_php_gapic", srcs = [":networkmanagement_proto_with_info"], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1.yaml", + transport = "grpc+rest", deps = [ ":networkmanagement_php_grpc", ":networkmanagement_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkmanagement_grpc_service_config.json", package = "google.cloud.networkmanagement.v1", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/network-intelligence-center/docs/connectivity-tests/reference/networkmanagement/rest", ], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", ruby_cloud_title = "Network Management V1", deps = [ @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":networkmanagement_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1.yaml", deps = [ ":networkmanagement_csharp_grpc", diff --git a/google/cloud/networkmanagement/v1beta1/BUILD.bazel b/google/cloud/networkmanagement/v1beta1/BUILD.bazel index 49ed38ece..3774759f2 100644 --- a/google/cloud/networkmanagement/v1beta1/BUILD.bazel +++ b/google/cloud/networkmanagement/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "networkmanagement_java_gapic", srcs = [":networkmanagement_proto_with_info"], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":networkmanagement_java_grpc", ], @@ -132,13 +133,14 @@ go_gapic_library( grpc_service_config = "networkmanagement_grpc_service_config.json", importpath = "cloud.google.com/go/networkmanagement/apiv1beta1;networkmanagement", metadata = True, + rest_numeric_enums = True, service_yaml = "networkmanagement_v1beta1.yaml", transport = "grpc+rest", deps = [ ":networkmanagement_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -173,6 +175,7 @@ py_gapic_library( name = "networkmanagement_py_gapic", srcs = [":networkmanagement_proto"], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( name = "networkmanagement_php_gapic", srcs = [":networkmanagement_proto_with_info"], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":networkmanagement_php_grpc", ":networkmanagement_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkmanagement_grpc_service_config.json", package = "google.cloud.networkmanagement.v1beta1", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -298,6 +305,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/network-intelligence-center/docs/connectivity-tests/reference/networkmanagement/rest", ], grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", ruby_cloud_title = "Network Management V1beta1", deps = [ @@ -343,6 +351,7 @@ csharp_gapic_library( srcs = [":networkmanagement_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkmanagement_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkmanagement_v1beta1.yaml", deps = [ ":networkmanagement_csharp_grpc", diff --git a/google/cloud/networksecurity/v1/BUILD.bazel b/google/cloud/networksecurity/v1/BUILD.bazel index d20f4491f..b0a863c98 100644 --- a/google/cloud/networksecurity/v1/BUILD.bazel +++ b/google/cloud/networksecurity/v1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "networksecurity_proto", @@ -49,18 +78,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "networksecurity_java_proto", deps = [":networksecurity_proto"], @@ -76,11 +93,13 @@ java_gapic_library( name = "networksecurity_java_gapic", srcs = [":networksecurity_proto_with_info"], grpc_service_config = "networksecurity_v1_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":networksecurity_java_grpc", "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":networksecurity_java_proto", "//google/cloud/location:location_java_proto", @@ -99,6 +118,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-networksecurity-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":networksecurity_java_gapic", ":networksecurity_java_grpc", @@ -107,17 +128,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "networksecurity_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -135,14 +145,15 @@ go_gapic_library( grpc_service_config = "networksecurity_v1_grpc_service_config.json", importpath = "cloud.google.com/go/networksecurity/apiv1;networksecurity", metadata = True, + rest_numeric_enums = True, service_yaml = "networksecurity_v1.yaml", deps = [ ":networksecurity_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -164,16 +175,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "networksecurity_py_gapic", srcs = [":networksecurity_proto"], @@ -183,6 +184,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=network_security", ], + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -204,17 +206,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "networksecurity_php_proto", deps = [":networksecurity_proto"], @@ -230,7 +221,9 @@ php_gapic_library( name = "networksecurity_php_gapic", srcs = [":networksecurity_proto_with_info"], grpc_service_config = "networksecurity_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networksecurity_v1.yaml", + transport = "grpc+rest", deps = [ ":networksecurity_php_grpc", ":networksecurity_php_proto", @@ -247,15 +240,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "networksecurity_nodejs_gapic", package_name = "@google-cloud/networksecurity", @@ -263,7 +247,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networksecurity_v1_grpc_service_config.json", package = "google.cloud.networksecurity.v1", + rest_numeric_enums = True, service_yaml = "networksecurity_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -275,17 +261,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "networksecurity_ruby_proto", deps = [":networksecurity_proto"], @@ -304,6 +279,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-networksecurity-v1", ], grpc_service_config = "networksecurity_v1_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":networksecurity_ruby_grpc", ":networksecurity_ruby_proto", @@ -320,17 +296,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "networksecurity_csharp_proto", deps = [":networksecurity_proto"], @@ -347,6 +312,7 @@ csharp_gapic_library( srcs = [":networksecurity_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networksecurity_v1_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":networksecurity_csharp_grpc", ":networksecurity_csharp_proto", diff --git a/google/cloud/networksecurity/v1beta1/BUILD.bazel b/google/cloud/networksecurity/v1beta1/BUILD.bazel index 1de19937e..a9e62ecb5 100644 --- a/google/cloud/networksecurity/v1beta1/BUILD.bazel +++ b/google/cloud/networksecurity/v1beta1/BUILD.bazel @@ -77,6 +77,7 @@ java_gapic_library( srcs = [":networksecurity_proto_with_info"], gapic_yaml = None, grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", test_deps = [ ":networksecurity_java_grpc", @@ -142,6 +143,7 @@ go_gapic_library( grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", importpath = "cloud.google.com/go/networksecurity/apiv1beta1;networksecurity", metadata = True, + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -149,8 +151,8 @@ go_gapic_library( "//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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -191,8 +193,9 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=network_security", ], + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", ], @@ -242,7 +245,9 @@ php_gapic_library( name = "networksecurity_php_gapic", srcs = [":networksecurity_proto_with_info"], grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":networksecurity_php_grpc", ":networksecurity_php_proto", @@ -275,7 +280,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", package = "google.cloud.networksecurity.v1beta1", + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -319,6 +326,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/traffic-director/docs/reference/network-security/rest/", ], grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The client library for the Google Network Security V1beta1 API.", ruby_cloud_title = "Network Security V1beta1", service_yaml = "networksecurity_v1beta1.yaml", @@ -365,6 +373,7 @@ csharp_gapic_library( srcs = [":networksecurity_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networksecurity_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networksecurity_v1beta1.yaml", deps = [ ":networksecurity_csharp_grpc", diff --git a/google/cloud/networkservices/v1/BUILD.bazel b/google/cloud/networkservices/v1/BUILD.bazel index 61a049977..8b720dfa4 100644 --- a/google/cloud/networkservices/v1/BUILD.bazel +++ b/google/cloud/networkservices/v1/BUILD.bazel @@ -82,6 +82,7 @@ java_gapic_library( srcs = [":networkservices_proto_with_info"], gapic_yaml = None, grpc_service_config = "networkservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", test_deps = [ ":networkservices_java_grpc", @@ -147,6 +148,7 @@ go_gapic_library( grpc_service_config = "networkservices_grpc_service_config.json", importpath = "cloud.google.com/go/networkservices/apiv1;networkservices", metadata = True, + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", transport = "grpc+rest", deps = [ @@ -154,8 +156,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -196,11 +198,12 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-network-services", ], + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", - ] + ], ) py_test( @@ -247,7 +250,9 @@ php_gapic_library( name = "networkservices_php_gapic", srcs = [":networkservices_proto_with_info"], grpc_service_config = "networkservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", + transport = "grpc+rest", deps = [ ":networkservices_php_grpc", ":networkservices_php_proto", @@ -280,7 +285,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkservices_grpc_service_config.json", package = "google.cloud.networkservices.v1", + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -319,6 +326,7 @@ ruby_cloud_gapic_library( srcs = [":networkservices_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-networkservices-v1"], grpc_service_config = "networkservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", deps = [ ":networkservices_ruby_grpc", @@ -363,6 +371,7 @@ csharp_gapic_library( srcs = [":networkservices_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkservices_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1.yaml", deps = [ ":networkservices_csharp_grpc", diff --git a/google/cloud/networkservices/v1beta1/BUILD.bazel b/google/cloud/networkservices/v1beta1/BUILD.bazel index d890aa5b0..d50c0ea26 100644 --- a/google/cloud/networkservices/v1beta1/BUILD.bazel +++ b/google/cloud/networkservices/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":networkservices_proto_with_info"], gapic_yaml = None, grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1beta1.yaml", test_deps = [ ":networkservices_java_grpc", @@ -133,13 +134,14 @@ go_gapic_library( grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", importpath = "cloud.google.com/go/networkservices/apiv1beta1;networkservices", metadata = True, + rest_numeric_enums = True, service_yaml = "networkservices_v1beta1.yaml", transport = "grpc+rest", deps = [ ":networkservices_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -175,6 +177,7 @@ py_gapic_library( name = "networkservices_py_gapic", srcs = [":networkservices_proto"], grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -222,7 +225,9 @@ php_gapic_library( name = "networkservices_php_gapic", srcs = [":networkservices_proto_with_info"], grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":networkservices_php_grpc", ":networkservices_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", package = "google.cloud.networkservices.v1beta1", + rest_numeric_enums = True, service_yaml = "networkservices_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -294,6 +301,7 @@ ruby_cloud_gapic_library( srcs = [":networkservices_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-networkservices-v1beta1"], grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":networkservices_ruby_grpc", ":networkservices_ruby_proto", @@ -337,6 +345,7 @@ csharp_gapic_library( srcs = [":networkservices_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "networkservices_v1beta1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "networkservices_v1beta1.yaml", deps = [ ":networkservices_csharp_grpc", diff --git a/google/cloud/notebooks/v1/BUILD.bazel b/google/cloud/notebooks/v1/BUILD.bazel index a9c117d89..44703fc60 100644 --- a/google/cloud/notebooks/v1/BUILD.bazel +++ b/google/cloud/notebooks/v1/BUILD.bazel @@ -21,6 +21,7 @@ load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") proto_library( name = "notebooks_proto", srcs = [ + "diagnostic_config.proto", "environment.proto", "event.proto", "execution.proto", @@ -37,6 +38,7 @@ proto_library( "//google/api:field_behavior_proto", "//google/api:resource_proto", "//google/longrunning:operations_proto", + "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], ) @@ -47,6 +49,7 @@ proto_library_with_info( ":notebooks_proto", "//google/cloud:common_resources_proto", "//google/cloud/location:location_proto", + "//google/iam/v1:iam_policy_proto", ], ) @@ -78,16 +81,19 @@ java_gapic_library( srcs = [":notebooks_proto_with_info"], gapic_yaml = None, grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "notebooks_v1.yaml", test_deps = [ ":notebooks_java_grpc", "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":notebooks_java_proto", "//google/api:api_java_proto", - "//google/cloud/location:location_java_grpc", "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", ], ) @@ -104,14 +110,12 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-notebooks-v1-java", include_samples = True, + transport = "grpc+rest", deps = [ ":notebooks_java_gapic", ":notebooks_java_grpc", ":notebooks_java_proto", ":notebooks_proto", - "//google/cloud/location:location_java_grpc", - "//google/cloud/location:location_java_proto", - "//google/cloud/location:location_proto", ], ) @@ -133,7 +137,6 @@ go_proto_library( protos = [":notebooks_proto"], deps = [ "//google/api:annotations_go_proto", - "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", ], ) @@ -144,13 +147,16 @@ go_gapic_library( grpc_service_config = "notebooks_grpc_service_config.json", importpath = "cloud.google.com/go/notebooks/apiv1;notebooks", metadata = True, + rest_numeric_enums = True, service_yaml = "notebooks_v1.yaml", + transport = "grpc", deps = [ ":notebooks_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -186,7 +192,12 @@ py_gapic_library( name = "notebooks_py_gapic", srcs = [":notebooks_proto"], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "notebooks_v1.yaml", transport = "grpc", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], ) py_test( @@ -233,7 +244,9 @@ php_gapic_library( name = "notebooks_php_gapic", srcs = [":notebooks_proto_with_info"], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "notebooks_v1.yaml", + transport = "grpc+rest", deps = [ ":notebooks_php_grpc", ":notebooks_php_proto", @@ -266,7 +279,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "notebooks_grpc_service_config.json", package = "google.cloud.notebooks.v1", + rest_numeric_enums = True, service_yaml = "notebooks_v1.yaml", + transport = "grpc", deps = [], ) @@ -302,17 +317,19 @@ ruby_grpc_library( ruby_cloud_gapic_library( name = "notebooks_ruby_gapic", - srcs = [":notebooks_proto"], + srcs = [":notebooks_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-notebooks-v1", - "ruby-cloud-env-prefix=NOTEBOOKS", - "ruby-cloud-product-url=https://cloud.google.com/ai-platform-notebooks", "ruby-cloud-api-id=notebooks.googleapis.com", "ruby-cloud-api-shortname=notebooks", + "ruby-cloud-env-prefix=NOTEBOOKS", + "ruby-cloud-gem-name=google-cloud-notebooks-v1", + "ruby-cloud-product-url=https://cloud.google.com/ai-platform-notebooks", ], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "AI Platform Notebooks makes it easy to manage JupyterLab instances through a protected, publicly available notebook instance URL. A JupyterLab instance is a Deep Learning virtual machine instance with the latest machine learning and data science libraries pre-installed.", ruby_cloud_title = "AI Platform Notebooks V1", + service_yaml = "notebooks_v1.yaml", deps = [ ":notebooks_ruby_grpc", ":notebooks_ruby_proto", @@ -356,6 +373,7 @@ csharp_gapic_library( srcs = [":notebooks_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "notebooks_v1.yaml", deps = [ ":notebooks_csharp_grpc", diff --git a/google/cloud/notebooks/v1/diagnostic_config.proto b/google/cloud/notebooks/v1/diagnostic_config.proto new file mode 100644 index 000000000..dcde42557 --- /dev/null +++ b/google/cloud/notebooks/v1/diagnostic_config.proto @@ -0,0 +1,60 @@ +// 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.notebooks.v1; + +import "google/api/field_behavior.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks"; +option java_multiple_files = true; +option java_outer_classname = "DiagnosticConfigProto"; +option java_package = "com.google.cloud.notebooks.v1"; + +// Defines flags that are used to run the diagnostic tool +message DiagnosticConfig { + // Required. User Cloud Storage bucket location (REQUIRED). + // Must be formatted with path prefix (`gs://$GCS_BUCKET`). + // + // Permissions: + // User Managed Notebooks: + // - storage.buckets.writer: Must be given to the project's service account + // attached to VM. + // Google Managed Notebooks: + // - storage.buckets.writer: Must be given to the project's service account or + // user credentials attached to VM depending on authentication mode. + // + // Cloud Storage bucket Log file will be written to + // `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz` + string gcs_bucket = 1 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Defines the relative storage path in the Cloud Storage bucket + // where the diagnostic logs will be written: Default path will be the root + // directory of the Cloud Storage bucket + // (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) + // Example of full path where Log file will be written: + // `gs://$GCS_BUCKET/$RELATIVE_PATH/` + string relative_path = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Enables flag to repair service for instance + bool repair_flag_enabled = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Enables flag to capture packets from the instance for 30 seconds + bool packet_capture_flag_enabled = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Enables flag to copy all `/home/jupyter` folder contents + bool copy_home_files_flag_enabled = 5 + [(google.api.field_behavior) = OPTIONAL]; +} diff --git a/google/cloud/notebooks/v1/managed_service.proto b/google/cloud/notebooks/v1/managed_service.proto index 170ae98d2..e61cedb7a 100644 --- a/google/cloud/notebooks/v1/managed_service.proto +++ b/google/cloud/notebooks/v1/managed_service.proto @@ -20,9 +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/notebooks/v1/diagnostic_config.proto"; import "google/cloud/notebooks/v1/event.proto"; import "google/cloud/notebooks/v1/runtime.proto"; import "google/longrunning/operations.proto"; +import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; option csharp_namespace = "Google.Cloud.Notebooks.V1"; @@ -68,6 +70,19 @@ service ManagedNotebookService { }; } + // Update Notebook Runtime configuration. + rpc UpdateRuntime(UpdateRuntimeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{runtime.name=projects/*/locations/*/runtimes/*}" + body: "runtime" + }; + option (google.api.method_signature) = "runtime,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Runtime" + metadata_type: "OperationMetadata" + }; + } + // Deletes a single Runtime. rpc DeleteRuntime(DeleteRuntimeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -140,6 +155,19 @@ service ManagedNotebookService { }; } + // Upgrades a Managed Notebook Runtime to the latest version. + rpc UpgradeRuntime(UpgradeRuntimeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/runtimes/*}:upgrade" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Runtime" + metadata_type: "OperationMetadata" + }; + } + // Report and process a runtime event. rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -162,6 +190,19 @@ service ManagedNotebookService { }; option (google.api.method_signature) = "name,vm_id"; } + + // Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. + rpc DiagnoseRuntime(DiagnoseRuntimeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/runtimes/*}:diagnose" + body: "*" + }; + option (google.api.method_signature) = "name,diagnostic_config"; + option (google.longrunning.operation_info) = { + response_type: "Runtime" + metadata_type: "OperationMetadata" + }; + } } // Request for listing Managed Notebook Runtimes. @@ -292,6 +333,18 @@ message ResetRuntimeRequest { string request_id = 2; } +// Request for upgrading a Managed Notebook Runtime to the latest version. +// option (google.api.message_visibility).restriction = +// "TRUSTED_TESTER,SPECIAL_TESTER"; +message UpgradeRuntimeRequest { + // Required. Format: + // `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // Idempotent request UUID. + string request_id = 2; +} + // Request for reporting a Managed Notebook Event. message ReportRuntimeEventRequest { // Required. Format: @@ -311,6 +364,40 @@ message ReportRuntimeEventRequest { Event event = 3 [(google.api.field_behavior) = REQUIRED]; } +// Request for updating a Managed Notebook configuration. +message UpdateRuntimeRequest { + // Required. The Runtime to be updated. + Runtime runtime = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Specifies the path, relative to `Runtime`, of + // the field to update. For example, to change the software configuration + // kernels, the `update_mask` parameter would be + // specified as `software_config.kernels`, + // and the `PATCH` request body would specify the new value, as follows: + // + // { + // "software_config":{ + // "kernels": [{ + // 'repository': + // 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': + // 'latest' }], + // } + // } + // + // + // Currently, only the following fields can be updated: + // - software_config.kernels + // - software_config.post_startup_script + // - software_config.custom_gpu_driver_path + // - software_config.idle_shutdown + // - software_config.idle_shutdown_timeout + // - software_config.disable_terminal + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + + // Idempotent request UUID. + string request_id = 3; +} + // Request for getting a new access token. message RefreshRuntimeTokenInternalRequest { // Required. Format: @@ -335,3 +422,18 @@ message RefreshRuntimeTokenInternalResponse { // Output only. Token expiration time. google.protobuf.Timestamp expire_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } + +// Request for creating a notebook instance diagnostic file. +message DiagnoseRuntimeRequest { + // Required. Format: + // `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "notebooks.googleapis.com/Runtime" + } + ]; + + // Required. Defines flags that are used to run the diagnostic tool + DiagnosticConfig diagnostic_config = 2 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/notebooks/v1/notebooks_grpc_service_config.json b/google/cloud/notebooks/v1/notebooks_grpc_service_config.json index 054bae59d..534e89d30 100644 --- a/google/cloud/notebooks/v1/notebooks_grpc_service_config.json +++ b/google/cloud/notebooks/v1/notebooks_grpc_service_config.json @@ -47,6 +47,7 @@ { "service": "google.cloud.notebooks.v1.NotebookService", "method": "GetExecution" }, { "service": "google.cloud.notebooks.v1.NotebookService", "method": "CreateExecution" }, { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DeleteExecution" }, + { "service": "google.cloud.notebooks.v1.NotebookService", "method": "DiagnoseInstance" }, { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "ListRuntimes" }, { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "GetRuntime" }, { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "CreateRuntime" }, @@ -55,7 +56,9 @@ { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "StopRuntime" }, { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "SwitchRuntime" }, { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "RollbackRuntime" }, - { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "ReportRuntimeEvent" } + { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "ReportRuntimeEvent" }, + { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "UpdateRuntime" }, + { "service": "google.cloud.notebooks.v1.ManagedNotebookService", "method": "DiagnoseRuntime" } ], "timeout": "60s" }, diff --git a/google/cloud/notebooks/v1/notebooks_v1.yaml b/google/cloud/notebooks/v1/notebooks_v1.yaml index 735388734..f653e3fe9 100644 --- a/google/cloud/notebooks/v1/notebooks_v1.yaml +++ b/google/cloud/notebooks/v1/notebooks_v1.yaml @@ -4,8 +4,11 @@ name: notebooks.googleapis.com title: Notebooks API apis: +- name: google.cloud.location.Locations - name: google.cloud.notebooks.v1.ManagedNotebookService - name: google.cloud.notebooks.v1.NotebookService +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.notebooks.v1.OperationMetadata diff --git a/google/cloud/notebooks/v1/runtime.proto b/google/cloud/notebooks/v1/runtime.proto index fa4d3769a..9dd33fb91 100644 --- a/google/cloud/notebooks/v1/runtime.proto +++ b/google/cloud/notebooks/v1/runtime.proto @@ -144,7 +144,7 @@ message RuntimeAcceleratorConfig { ACCELERATOR_TYPE_UNSPECIFIED = 0; // Accelerator type is Nvidia Tesla K80. - NVIDIA_TESLA_K80 = 1; + NVIDIA_TESLA_K80 = 1 [deprecated = true]; // Accelerator type is Nvidia Tesla P100. NVIDIA_TESLA_P100 = 2; @@ -376,6 +376,18 @@ message RuntimeAccessConfig { // * `idle_shutdown_timeout: 180` // * `enable_health_monitoring: true` message RuntimeSoftwareConfig { + // Behavior for the post startup script. + enum PostStartupScriptBehavior { + // Unspecified post startup script behavior. Will run only once at creation. + POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0; + + // Runs the post startup script provided during creation at every start. + RUN_EVERY_START = 1; + + // Downloads and runs the provided post startup script at every start. + DOWNLOAD_AND_RUN_EVERY_START = 2; + } + // Cron expression in UTC timezone, used to schedule instance auto upgrade. // Please follow the [cron format](https://en.wikipedia.org/wiki/Cron). string notebook_upgrade_schedule = 1; @@ -409,6 +421,16 @@ message RuntimeSoftwareConfig { // Output only. Bool indicating whether an newer image is available in an image family. optional bool upgradeable = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Behavior for the post startup script. + PostStartupScriptBehavior post_startup_script_behavior = 10; + + // Bool indicating whether JupyterLab terminal will be available or not. + // Default: False + optional bool disable_terminal = 11; + + // Output only. version of boot image such as M100, from release label of the image. + optional string version = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Contains runtime daemon metrics, such as OS and kernels and sessions stats. @@ -509,8 +531,8 @@ message VirtualMachineConfig { // // A full URL or partial URI. 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` // // Runtimes are managed resources inside Google Infrastructure. // Runtimes support the following network configurations: diff --git a/google/cloud/notebooks/v1/service.proto b/google/cloud/notebooks/v1/service.proto index 61ac76ce0..b997d5b2c 100644 --- a/google/cloud/notebooks/v1/service.proto +++ b/google/cloud/notebooks/v1/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/notebooks/v1/diagnostic_config.proto"; import "google/cloud/notebooks/v1/environment.proto"; import "google/cloud/notebooks/v1/execution.proto"; import "google/cloud/notebooks/v1/instance.proto"; @@ -255,6 +256,19 @@ service NotebookService { }; } + // Creates a Diagnostic File and runs Diagnostic Tool given an Instance. + rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/instances/*}:diagnose" + body: "*" + }; + option (google.api.method_signature) = "name,diagnostic_config"; + option (google.longrunning.operation_info) = { + response_type: "Instance" + metadata_type: "OperationMetadata" + }; + } + // Allows notebook instances to // call this endpoint to upgrade themselves. Do not use this method directly. rpc UpgradeInstanceInternal(UpgradeInstanceInternalRequest) returns (google.longrunning.Operation) { @@ -746,6 +760,21 @@ message ListEnvironmentsRequest { string page_token = 3; } +// Request for creating a notebook instance diagnostic file. +message DiagnoseInstanceRequest { + // Required. Format: + // `projects/{project_id}/locations/{location}/instances/{instance_id}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "notebooks.googleapis.com/Instance" + } + ]; + + // Required. Defines flags that are used to run the diagnostic tool + DiagnosticConfig diagnostic_config = 2 [(google.api.field_behavior) = REQUIRED]; +} + // Response for listing environments. message ListEnvironmentsResponse { // A list of returned environments. diff --git a/google/cloud/notebooks/v1beta1/BUILD.bazel b/google/cloud/notebooks/v1beta1/BUILD.bazel index a44226f08..414db285c 100644 --- a/google/cloud/notebooks/v1beta1/BUILD.bazel +++ b/google/cloud/notebooks/v1beta1/BUILD.bazel @@ -1,5 +1,5 @@ # This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel +# 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: @@ -40,6 +40,8 @@ proto_library_with_info( deps = [ ":notebooks_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", + "//google/iam/v1:iam_policy_proto", ], ) @@ -69,12 +71,21 @@ java_grpc_library( java_gapic_library( name = "notebooks_java_gapic", srcs = [":notebooks_proto_with_info"], + gapic_yaml = None, grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "notebooks_v1beta1.yaml", test_deps = [ ":notebooks_java_grpc", + "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", ], + transport = "grpc", deps = [ ":notebooks_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", ], ) @@ -90,6 +101,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-notebooks-v1beta1-java", include_samples = True, + transport = "grpc+rest", deps = [ ":notebooks_java_gapic", ":notebooks_java_grpc", @@ -125,13 +137,17 @@ go_gapic_library( srcs = [":notebooks_proto_with_info"], grpc_service_config = "notebooks_grpc_service_config.json", importpath = "cloud.google.com/go/notebooks/apiv1beta1;notebooks", + metadata = True, + rest_numeric_enums = True, service_yaml = "notebooks_v1beta1.yaml", transport = "grpc+rest", deps = [ ":notebooks_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -147,6 +163,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-notebooks-v1beta1-go", deps = [ ":notebooks_go_gapic", + ":notebooks_go_gapic_srcjar-metadata.srcjar", ":notebooks_go_gapic_srcjar-test.srcjar", ":notebooks_go_proto", ], @@ -166,7 +183,12 @@ py_gapic_library( name = "notebooks_py_gapic", srcs = [":notebooks_proto"], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "notebooks_v1beta1.yaml", transport = "grpc", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], ) py_test( @@ -213,7 +235,9 @@ php_gapic_library( name = "notebooks_php_gapic", srcs = [":notebooks_proto_with_info"], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "notebooks_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":notebooks_php_grpc", ":notebooks_php_proto", @@ -246,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "notebooks_grpc_service_config.json", package = "google.cloud.notebooks.v1beta1", + rest_numeric_enums = True, service_yaml = "notebooks_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -284,15 +310,17 @@ ruby_cloud_gapic_library( name = "notebooks_ruby_gapic", srcs = [":notebooks_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-notebooks-v1beta1", - "ruby-cloud-env-prefix=NOTEBOOKS", - "ruby-cloud-product-url=https://cloud.google.com/ai-platform-notebooks", "ruby-cloud-api-id=notebooks.googleapis.com", "ruby-cloud-api-shortname=notebooks", + "ruby-cloud-env-prefix=NOTEBOOKS", + "ruby-cloud-gem-name=google-cloud-notebooks-v1beta1", + "ruby-cloud-product-url=https://cloud.google.com/ai-platform-notebooks", ], grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "AI Platform Notebooks makes it easy to manage JupyterLab instances through a protected, publicly available notebook instance URL. A JupyterLab instance is a Deep Learning virtual machine instance with the latest machine learning and data science libraries pre-installed.", ruby_cloud_title = "AI Platform Notebooks V1beta1", + service_yaml = "notebooks_v1beta1.yaml", deps = [ ":notebooks_ruby_grpc", ":notebooks_ruby_proto", @@ -336,6 +364,7 @@ csharp_gapic_library( srcs = [":notebooks_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "notebooks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "notebooks_v1beta1.yaml", deps = [ ":notebooks_csharp_grpc", @@ -356,4 +385,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "notebooks_cc_proto", + deps = [":notebooks_proto"], +) + +cc_grpc_library( + name = "notebooks_cc_grpc", + srcs = [":notebooks_proto"], + grpc_only = True, + deps = [":notebooks_cc_proto"], +) diff --git a/google/cloud/notebooks/v1beta1/environment.proto b/google/cloud/notebooks/v1beta1/environment.proto index c047877e0..3bf88450c 100644 --- a/google/cloud/notebooks/v1beta1/environment.proto +++ b/google/cloud/notebooks/v1beta1/environment.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,13 +20,13 @@ 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/notebooks/v1beta1;notebooks"; option csharp_namespace = "Google.Cloud.Notebooks.V1Beta1"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; -option ruby_package = "Google::Cloud::Notebooks::V1beta1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1;notebooks"; option java_multiple_files = true; option java_outer_classname = "EnvironmentProto"; option java_package = "com.google.cloud.notebooks.v1beta1"; +option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; +option ruby_package = "Google::Cloud::Notebooks::V1beta1"; // Definition of a software environment that is used to start a notebook // instance. diff --git a/google/cloud/notebooks/v1beta1/instance.proto b/google/cloud/notebooks/v1beta1/instance.proto index c7a4e999e..977695921 100644 --- a/google/cloud/notebooks/v1beta1/instance.proto +++ b/google/cloud/notebooks/v1beta1/instance.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. @@ -23,11 +23,39 @@ import "google/protobuf/timestamp.proto"; option csharp_namespace = "Google.Cloud.Notebooks.V1Beta1"; option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1;notebooks"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; -option ruby_package = "Google::Cloud::Notebooks::V1beta1"; option java_multiple_files = true; option java_outer_classname = "InstanceProto"; option java_package = "com.google.cloud.notebooks.v1beta1"; +option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; +option ruby_package = "Google::Cloud::Notebooks::V1beta1"; + +// Reservation Affinity for consuming Zonal reservation. +message ReservationAffinity { + // Indicates whether to consume capacity from an reservation or not. + enum Type { + // Default type. + TYPE_UNSPECIFIED = 0; + + // Do not consume from any allocated capacity. + NO_RESERVATION = 1; + + // Consume any reservation available. + ANY_RESERVATION = 2; + + // Must consume from a specific reservation. Must specify key value fields + // for specifying the reservations. + SPECIFIC_RESERVATION = 3; + } + + // Optional. Type of reservation to consume + Type consume_reservation_type = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Corresponds to the label key of reservation resource. + string key = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Corresponds to the label values of reservation resource. + repeated string values = 3 [(google.api.field_behavior) = OPTIONAL]; +} // The definition of a notebook instance. message Instance { @@ -36,18 +64,6 @@ message Instance { pattern: "projects/{project}/instances/{instance}" }; - // Definition of a hardware accelerator. Note that not all combinations - // of `type` and `core_count` are valid. Check [GPUs on - // Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid - // combination. TPUs are not supported. - message AcceleratorConfig { - // Type of this accelerator. - AcceleratorType type = 1; - - // Count of cores of this accelerator. - int64 core_count = 2; - } - // Definition of the types of hardware accelerators that can be used on this // instance. enum AcceleratorType { @@ -63,7 +79,7 @@ message Instance { // Accelerator type is Nvidia Tesla V100. NVIDIA_TESLA_V100 = 3; - // Accelerator type is Nvidia Tesla P_4. + // Accelerator type is Nvidia Tesla P4. NVIDIA_TESLA_P4 = 4; // Accelerator type is Nvidia Tesla T4. @@ -75,7 +91,7 @@ message Instance { // Accelerator type is NVIDIA Tesla P100 Virtual Workstations. NVIDIA_TESLA_P100_VWS = 9; - // Accelerator type is NVIDIA Tesla P_4 Virtual Workstations. + // Accelerator type is NVIDIA Tesla P4 Virtual Workstations. NVIDIA_TESLA_P4_VWS = 10; // (Coming soon) Accelerator type is TPU V2. @@ -85,6 +101,18 @@ message Instance { TPU_V3 = 7; } + // Definition of a hardware accelerator. Note that not all combinations + // of `type` and `core_count` are valid. Check [GPUs on + // Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid + // combination. TPUs are not supported. + message AcceleratorConfig { + // Type of this accelerator. + AcceleratorType type = 1; + + // Count of cores of this accelerator. + int64 core_count = 2; + } + // The definition of the states of this instance. enum State { // State is not specified. @@ -117,6 +145,12 @@ message Instance { // The instance is getting registered. REGISTERING = 9; + + // The instance is suspending. + SUSPENDING = 10; + + // The instance is suspended. + SUSPENDED = 11; } // Possible disk types for notebook instances. @@ -146,6 +180,19 @@ message Instance { CMEK = 2; } + // The type of vNIC driver. + enum NicType { + // No type specified. Default should be UNSPECIFIED_NIC_TYPE. + UNSPECIFIED_NIC_TYPE = 0; + + // VIRTIO. Default in Notebooks DLVM. + VIRTIO_NET = 1; + + // GVNIC. Alternative to VIRTIO. + // https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux + GVNIC = 2; + } + // Output only. The name of this notebook instance. Format: // `projects/{project_id}/locations/{location}/instances/{instance_id}` string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -161,21 +208,18 @@ message Instance { // Path to a Bash script that automatically runs after a notebook instance // fully boots up. The path must be a URL or - // Cloud Storage path (`gs://path-to-file/file-name`). + // Cloud Storage path (gs://path-to-file/file-name). string post_startup_script = 4; - // Output only. The proxy endpoint that is used to access the Jupyter - // notebook. + // Output only. The proxy endpoint that is used to access the Jupyter notebook. string proxy_uri = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Input only. The owner of this instance after creation. Format: - // `alias@example.com` + // Input only. The owner of this instance after creation. Format: `alias@example.com` // // Currently supports one owner only. If not specified, all of the service // account users of your VM instance's service account can use // the instance. - repeated string instance_owners = 6 - [(google.api.field_behavior) = INPUT_ONLY]; + repeated string instance_owners = 6 [(google.api.field_behavior) = INPUT_ONLY]; // The service account on this instance, giving access to other Google // Cloud services. @@ -187,15 +231,14 @@ message Instance { // is used. string service_account = 7; - // Required. The [Compute Engine machine - // type](https://cloud.google.com/compute/docs/machine-types) of this + // Required. The [Compute Engine machine type](/compute/docs/machine-types) of this // instance. string machine_type = 8 [(google.api.field_behavior) = REQUIRED]; // The hardware accelerator used on this instance. If you use // accelerators, make sure that your configuration has // [enough vCPUs and memory to support the `machine_type` you - // have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). + // have selected](/compute/docs/gpus/#gpus-list). AcceleratorConfig accelerator_config = 9; // Output only. The state of this instance. @@ -211,40 +254,37 @@ message Instance { // If not specified, we'll automatically choose from official GPU drivers. string custom_gpu_driver_path = 12; - // Input only. The type of the boot disk attached to this instance, defaults - // to standard persistent disk (`PD_STANDARD`). + // Input only. The type of the boot disk attached to this instance, defaults to + // standard persistent disk (`PD_STANDARD`). DiskType boot_disk_type = 13 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. The size of the boot disk in GB attached to this instance, up - // to a maximum of 64000 GB (64 TB). The minimum recommended value - // is 100 GB. If not specified, this defaults to 100. + // Input only. The size of the boot disk in GB attached to this instance, up to a maximum + // of 64000 GB (64 TB). The minimum recommended value is + // 100 GB. If not specified, this defaults to 100. int64 boot_disk_size_gb = 14 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. The type of the data disk attached to this instance, defaults - // to standard persistent disk (`PD_STANDARD`). + // Input only. The type of the data disk attached to this instance, defaults to + // standard persistent disk (`PD_STANDARD`). DiskType data_disk_type = 25 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. The size of the data disk in GB attached to this instance, up - // to a maximum of 64000 GB (64 TB). You can choose the size of the - // data disk based on how big your notebooks and data are. If not specified, - // this defaults to 100. + // Input only. The size of the data disk in GB attached to this instance, up to a maximum + // of 64000 GB (64 TB). You can choose the size of the data disk + // based on how big your notebooks and data are. If not specified, this + // defaults to 100. int64 data_disk_size_gb = 26 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. If true, the data disk will not be auto deleted when deleting - // the instance. + // Input only. If true, the data disk will not be auto deleted when deleting the instance. bool no_remove_data_disk = 27 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. Disk encryption method used on the boot and data disks, - // defaults to GMEK. - DiskEncryption disk_encryption = 15 - [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + DiskEncryption disk_encryption = 15 [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. The KMS key used to encrypt the disks, only applicable if - // disk_encryption is CMEK. Format: + // Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption + // is CMEK. + // Format: // `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` // - // Learn more about [using your own encryption keys]( - // https://cloud.google.com/kms/docs/quickstart). + // Learn more about [using your own encryption keys](/kms/docs/quickstart). string kms_key = 16 [(google.api.field_behavior) = INPUT_ONLY]; // If true, no public IP will be assigned to this instance. @@ -270,11 +310,23 @@ message Instance { // Custom metadata to apply to this instance. map metadata = 22; + // Optional. The type of vNIC to be used on this interface. This may be gVNIC or + // VirtioNet. + NicType nic_type = 28 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The optional reservation affinity. Setting this field will apply + // the specified [Zonal Compute + // Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) + // to this notebook instance. + ReservationAffinity reservation_affinity = 29 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Flag to enable ip forwarding or not, default false/off. + // https://cloud.google.com/vpc/docs/using-routes#canipforward + bool can_ip_forward = 31 [(google.api.field_behavior) = OPTIONAL]; + // Output only. Instance creation time. - google.protobuf.Timestamp create_time = 23 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Instance update time. - google.protobuf.Timestamp update_time = 24 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/notebooks/v1beta1/notebooks_v1beta1.yaml b/google/cloud/notebooks/v1beta1/notebooks_v1beta1.yaml index 922431501..a42beceb1 100644 --- a/google/cloud/notebooks/v1beta1/notebooks_v1beta1.yaml +++ b/google/cloud/notebooks/v1beta1/notebooks_v1beta1.yaml @@ -4,16 +4,23 @@ name: notebooks.googleapis.com title: Notebooks API apis: +- name: google.cloud.location.Locations - name: google.cloud.notebooks.v1beta1.NotebookService +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations types: - name: google.cloud.notebooks.v1beta1.OperationMetadata documentation: - summary: |- - AI Platform Notebooks API is used to manage notebook resources in Google - Cloud. + summary: Notebooks API is used to manage notebook resources in Google Cloud. 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 @@ -39,6 +46,10 @@ documentation: backend: rules: + - selector: google.cloud.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 - selector: 'google.cloud.notebooks.v1beta1.NotebookService.*' deadline: 60.0 - selector: 'google.iam.v1.IAMPolicy.*' @@ -50,6 +61,10 @@ backend: http: rules: + - selector: google.cloud.location.Locations.GetLocation + get: '/v1beta1/{name=projects/*/locations/*}' + - selector: google.cloud.location.Locations.ListLocations + get: '/v1beta1/{name=projects/*}/locations' - selector: google.iam.v1.IAMPolicy.GetIamPolicy get: '/v1beta1/{resource=projects/*/locations/*/instances/*}:getIamPolicy' - selector: google.iam.v1.IAMPolicy.SetIamPolicy @@ -70,6 +85,14 @@ http: authentication: rules: + - 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.cloud.notebooks.v1beta1.NotebookService.*' oauth: canonical_scopes: |- diff --git a/google/cloud/notebooks/v1beta1/service.proto b/google/cloud/notebooks/v1beta1/service.proto index 06064336c..4cfcca1c7 100644 --- a/google/cloud/notebooks/v1beta1/service.proto +++ b/google/cloud/notebooks/v1beta1/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. @@ -17,26 +17,25 @@ syntax = "proto3"; package google.cloud.notebooks.v1beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/cloud/notebooks/v1beta1/environment.proto"; import "google/cloud/notebooks/v1beta1/instance.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/timestamp.proto"; -import "google/api/client.proto"; option csharp_namespace = "Google.Cloud.Notebooks.V1Beta1"; option go_package = "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1;notebooks"; -option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; -option ruby_package = "Google::Cloud::Notebooks::V1beta1"; option java_multiple_files = true; option java_outer_classname = "NotebooksProto"; option java_package = "com.google.cloud.notebooks.v1beta1"; +option php_namespace = "Google\\Cloud\\Notebooks\\V1beta1"; +option ruby_package = "Google::Cloud::Notebooks::V1beta1"; // API v1beta1 service for Cloud AI Platform Notebooks. service NotebookService { option (google.api.default_host) = "notebooks.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"; // Lists instances in a given project and location. rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) { @@ -53,8 +52,7 @@ service NotebookService { } // Creates a new Instance in a given project and location. - rpc CreateInstance(CreateInstanceRequest) - returns (google.longrunning.Operation) { + rpc CreateInstance(CreateInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/instances" body: "instance" @@ -69,8 +67,7 @@ service NotebookService { // Legacy instances are instances created with the legacy Compute Engine // calls. They are not manageable by the Notebooks API out of the box. This // call makes these instances manageable by the Notebooks API. - rpc RegisterInstance(RegisterInstanceRequest) - returns (google.longrunning.Operation) { + rpc RegisterInstance(RegisterInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/instances:register" body: "*" @@ -82,8 +79,7 @@ service NotebookService { } // Updates the guest accelerators of a single Instance. - rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) - returns (google.longrunning.Operation) { + rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{name=projects/*/locations/*/instances/*}:setAccelerator" body: "*" @@ -95,8 +91,7 @@ service NotebookService { } // Updates the machine type of a single Instance. - rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) - returns (google.longrunning.Operation) { + rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{name=projects/*/locations/*/instances/*}:setMachineType" body: "*" @@ -108,8 +103,7 @@ service NotebookService { } // Updates the labels of an Instance. - rpc SetInstanceLabels(SetInstanceLabelsRequest) - returns (google.longrunning.Operation) { + rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{name=projects/*/locations/*/instances/*}:setLabels" body: "*" @@ -121,8 +115,7 @@ service NotebookService { } // Deletes a single Instance. - rpc DeleteInstance(DeleteInstanceRequest) - returns (google.longrunning.Operation) { + rpc DeleteInstance(DeleteInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/instances/*}" }; @@ -133,8 +126,7 @@ service NotebookService { } // Starts a notebook instance. - rpc StartInstance(StartInstanceRequest) - returns (google.longrunning.Operation) { + rpc StartInstance(StartInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/instances/*}:start" body: "*" @@ -158,8 +150,7 @@ service NotebookService { } // Resets a notebook instance. - rpc ResetInstance(ResetInstanceRequest) - returns (google.longrunning.Operation) { + rpc ResetInstance(ResetInstanceRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/instances/*}:reset" body: "*" @@ -174,8 +165,7 @@ service NotebookService { // report their latest instance information to the Notebooks // API server. The server will merge the reported information to // the instance metadata store. Do not use this method directly. - rpc ReportInstanceInfo(ReportInstanceInfoRequest) - returns (google.longrunning.Operation) { + rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/instances/*}:report" body: "*" @@ -187,16 +177,18 @@ service NotebookService { } // Check if a notebook instance is upgradable. - rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) - returns (IsInstanceUpgradeableResponse) { + // Deprecated. Please consider using v1. + rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse) { + option deprecated = true; option (google.api.http) = { get: "/v1beta1/{notebook_instance=projects/*/locations/*/instances/*}:isUpgradeable" }; } // Upgrades a notebook instance to the latest version. - rpc UpgradeInstance(UpgradeInstanceRequest) - returns (google.longrunning.Operation) { + // Deprecated. Please consider using v1. + rpc UpgradeInstance(UpgradeInstanceRequest) returns (google.longrunning.Operation) { + option deprecated = true; option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/instances/*}:upgrade" body: "*" @@ -209,8 +201,9 @@ service NotebookService { // Allows notebook instances to // call this endpoint to upgrade themselves. Do not use this method directly. - rpc UpgradeInstanceInternal(UpgradeInstanceInternalRequest) - returns (google.longrunning.Operation) { + // Deprecated. Please consider using v1. + rpc UpgradeInstanceInternal(UpgradeInstanceInternalRequest) returns (google.longrunning.Operation) { + option deprecated = true; option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/instances/*}:upgradeInternal" body: "*" @@ -222,8 +215,7 @@ service NotebookService { } // Lists environments in a project. - rpc ListEnvironments(ListEnvironmentsRequest) - returns (ListEnvironmentsResponse) { + rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/environments" }; @@ -237,8 +229,7 @@ service NotebookService { } // Creates a new Environment. - rpc CreateEnvironment(CreateEnvironmentRequest) - returns (google.longrunning.Operation) { + rpc CreateEnvironment(CreateEnvironmentRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/environments" body: "environment" @@ -250,8 +241,7 @@ service NotebookService { } // Deletes a single Environment. - rpc DeleteEnvironment(DeleteEnvironmentRequest) - returns (google.longrunning.Operation) { + rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/environments/*}" }; @@ -282,8 +272,7 @@ message OperationMetadata { // 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`. + // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`. bool requested_cancellation = 6; // API version used to start the operation. @@ -364,10 +353,10 @@ message SetInstanceAcceleratorRequest { // Required. Type of this accelerator. Instance.AcceleratorType type = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Count of cores of this accelerator. Note that not all - // combinations of `type` and `core_count` are valid. Check [GPUs on Compute - // Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a - // valid combination. TPUs are not supported. + // Required. Count of cores of this accelerator. Note that not all combinations + // of `type` and `core_count` are valid. Check [GPUs on + // Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to + // find a valid combination. TPUs are not supported. int64 core_count = 3 [(google.api.field_behavior) = REQUIRED]; } @@ -454,6 +443,11 @@ message IsInstanceUpgradeableResponse { // Additional information about upgrade. string upgrade_info = 3; + + // The new image self link this instance will be upgraded to if calling the + // upgrade endpoint. This field will only be populated if field upgradeable + // is true. + string upgrade_image = 4; } // Request for upgrading a notebook instance @@ -512,10 +506,10 @@ message CreateEnvironmentRequest { // Required. Format: `projects/{project_id}/locations/{location}` string parent = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. User-defined unique ID of this environment. The `environment_id` - // must be 1 to 63 characters long and contain only lowercase letters, numeric - // characters, and dashes. The first character must be a lowercase letter and - // the last character cannot be a dash. + // Required. User-defined unique ID of this environment. The `environment_id` must + // be 1 to 63 characters long and contain only lowercase letters, + // numeric characters, and dashes. The first character must be a lowercase + // letter and the last character cannot be a dash. string environment_id = 2 [(google.api.field_behavior) = REQUIRED]; // Required. The environment to be created. diff --git a/google/cloud/optimization/v1/BUILD.bazel b/google/cloud/optimization/v1/BUILD.bazel index 733518e4e..26cb39939 100644 --- a/google/cloud/optimization/v1/BUILD.bazel +++ b/google/cloud/optimization/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":optimization_proto_with_info"], gapic_yaml = "cloudoptimization_gapic.yaml", grpc_service_config = "cloudoptimization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudoptimization_v1.yaml", test_deps = [ ":optimization_java_grpc", @@ -133,13 +134,14 @@ go_gapic_library( grpc_service_config = "cloudoptimization_grpc_service_config.json", importpath = "cloud.google.com/go/optimization/apiv1;optimization", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudoptimization_v1.yaml", transport = "grpc+rest", deps = [ ":optimization_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -176,6 +178,7 @@ py_gapic_library( name = "optimization_py_gapic", srcs = [":optimization_proto"], grpc_service_config = "cloudoptimization_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -224,7 +227,9 @@ php_gapic_library( srcs = [":optimization_proto_with_info"], gapic_yaml = "cloudoptimization_gapic.yaml", grpc_service_config = "cloudoptimization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudoptimization_v1.yaml", + transport = "grpc+rest", deps = [ ":optimization_php_grpc", ":optimization_php_proto", @@ -257,7 +262,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudoptimization_grpc_service_config.json", package = "google.cloud.optimization.v1", + rest_numeric_enums = True, service_yaml = "cloudoptimization_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudoptimization", ], grpc_service_config = "cloudoptimization_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets.", ruby_cloud_title = "Cloud Optimization V1", deps = [ @@ -346,6 +354,7 @@ csharp_gapic_library( srcs = [":optimization_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudoptimization_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudoptimization_v1.yaml", deps = [ ":optimization_csharp_grpc", diff --git a/google/cloud/optimization/v1/fleet_routing.proto b/google/cloud/optimization/v1/fleet_routing.proto index 5e381e9f0..a00d1b781 100644 --- a/google/cloud/optimization/v1/fleet_routing.proto +++ b/google/cloud/optimization/v1/fleet_routing.proto @@ -49,7 +49,8 @@ option java_package = "com.google.cloud.optimization.v1"; // * at least one of latitude and longitude must be non-zero. service FleetRouting { option (google.api.default_host) = "cloudoptimization.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"; // Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an // `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of @@ -86,7 +87,8 @@ service FleetRouting { // contains a `ShipmentModel` and returns an `OptimizeToursResponse` // containing `ShipmentRoute`s, which are a set of routes to be performed by // vehicles minimizing the overall cost. - rpc BatchOptimizeTours(BatchOptimizeToursRequest) returns (google.longrunning.Operation) { + rpc BatchOptimizeTours(BatchOptimizeToursRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}:batchOptimizeTours" body: "*" @@ -107,8 +109,9 @@ service FleetRouting { message OptimizeToursRequest { // Defines how the solver should handle the request. In all modes but // `VALIDATE_ONLY`, if the request is invalid, you will receive an - // `INVALID_REQUEST` error. See [max_validation_errors][google.cloud.optimization.v1.OptimizeToursRequest.max_validation_errors] to cap the number of - // errors returned. + // `INVALID_REQUEST` error. See + // [max_validation_errors][google.cloud.optimization.v1.OptimizeToursRequest.max_validation_errors] + // to cap the number of errors returned. enum SolvingMode { // Solve the model. DEFAULT_SOLVE = 0; @@ -195,8 +198,9 @@ message OptimizeToursRequest { // <= visits[0].start_time <= visits[1].start_time ... // <= vehicle_end_time`). // * a shipment may only be performed on a vehicle that is allowed. A - // vehicle is allowed if [Shipment.allowed_vehicle_indices][google.cloud.optimization.v1.Shipment.allowed_vehicle_indices] is empty or - // its `vehicle_index` is included in + // vehicle is allowed if + // [Shipment.allowed_vehicle_indices][google.cloud.optimization.v1.Shipment.allowed_vehicle_indices] + // is empty or its `vehicle_index` is included in // [Shipment.allowed_vehicle_indices][google.cloud.optimization.v1.Shipment.allowed_vehicle_indices]. // // If the injected solution is not feasible, a validation error is not @@ -234,16 +238,27 @@ message OptimizeToursRequest { // If true: // - // * uses [ShipmentRoute.vehicle_label][google.cloud.optimization.v1.ShipmentRoute.vehicle_label] instead of `vehicle_index` to + // * uses + // [ShipmentRoute.vehicle_label][google.cloud.optimization.v1.ShipmentRoute.vehicle_label] + // instead of `vehicle_index` to // match routes in an injected solution with vehicles in the request; - // reuses the mapping of original [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index] to new - // [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index] to update + // reuses the mapping of original + // [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index] + // to new + // [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index] + // to update // [ConstraintRelaxation.vehicle_indices][google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.vehicle_indices] // if non-empty, but the mapping must be unambiguous (i.e., multiple // `ShipmentRoute`s must not share the same original `vehicle_index`). - // * uses [ShipmentRoute.Visit.shipment_label][google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label] instead of `shipment_index` + // * uses + // [ShipmentRoute.Visit.shipment_label][google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label] + // instead of `shipment_index` // to match visits in an injected solution with shipments in the request; - // * uses [SkippedShipment.label][google.cloud.optimization.v1.SkippedShipment.label] instead of [SkippedShipment.index][google.cloud.optimization.v1.SkippedShipment.index] to + // * uses + // [SkippedShipment.label][google.cloud.optimization.v1.SkippedShipment.label] + // instead of + // [SkippedShipment.index][google.cloud.optimization.v1.SkippedShipment.index] + // to // match skipped shipments in the injected solution with request // shipments. // @@ -256,8 +271,10 @@ message OptimizeToursRequest { // If true, labels in the following categories must appear at most once in // their category: // - // * [Vehicle.label][google.cloud.optimization.v1.Vehicle.label] in the request; - // * [Shipment.label][google.cloud.optimization.v1.Shipment.label] in the request; + // * [Vehicle.label][google.cloud.optimization.v1.Vehicle.label] in the + // request; + // * [Shipment.label][google.cloud.optimization.v1.Shipment.label] in the + // request; // * [ShipmentRoute.vehicle_label][google.cloud.optimization.v1.ShipmentRoute.vehicle_label] in the injected solution; // * [SkippedShipment.label][google.cloud.optimization.v1.SkippedShipment.label] and [ShipmentRoute.Visit.shipment_label][google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label] in // the injected solution (except pickup/delivery visit pairs, whose @@ -267,28 +284,33 @@ message OptimizeToursRequest { // request vehicle, the corresponding route is removed from the solution // along with its visits. If a `shipment_label` in the injected solution does // not correspond to a request shipment, the corresponding visit is removed - // from the solution. If a [SkippedShipment.label][google.cloud.optimization.v1.SkippedShipment.label] in the injected solution - // does not correspond to a request shipment, the `SkippedShipment` is removed - // from the solution. + // from the solution. If a + // [SkippedShipment.label][google.cloud.optimization.v1.SkippedShipment.label] + // in the injected solution does not correspond to a request shipment, the + // `SkippedShipment` is removed from the solution. // // Removing route visits or entire routes from an injected solution may // have an effect on the implied constraints, which may lead to change in // solution, validation errors, or infeasibility. // - // NOTE: The caller must ensure that each [Vehicle.label][google.cloud.optimization.v1.Vehicle.label] - // (resp. [Shipment.label][google.cloud.optimization.v1.Shipment.label]) uniquely identifies a vehicle (resp. shipment) - // entity used across the two relevant requests: the past request that - // produced the `OptimizeToursResponse` used in the injected solution and the - // current request that includes the injected solution. The uniqueness checks - // described above are not enough to guarantee this requirement. + // NOTE: The caller must ensure that each + // [Vehicle.label][google.cloud.optimization.v1.Vehicle.label] (resp. + // [Shipment.label][google.cloud.optimization.v1.Shipment.label]) uniquely + // identifies a vehicle (resp. shipment) entity used across the two relevant + // requests: the past request that produced the `OptimizeToursResponse` used + // in the injected solution and the current request that includes the injected + // solution. The uniqueness checks described above are not enough to guarantee + // this requirement. bool interpret_injected_solutions_using_labels = 10; // Consider traffic estimation in calculating `ShipmentRoute` fields // [Transition.travel_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration], // [Visit.start_time][google.cloud.optimization.v1.ShipmentRoute.Visit.start_time], // and `vehicle_end_time`; in setting the - // [ShipmentRoute.has_traffic_infeasibilities][google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities] field, and in calculating the - // [OptimizeToursResponse.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.total_cost] field. + // [ShipmentRoute.has_traffic_infeasibilities][google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities] + // field, and in calculating the + // [OptimizeToursResponse.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.total_cost] + // field. bool consider_road_traffic = 11; // If true, polylines will be populated in response `ShipmentRoute`s. @@ -321,10 +343,11 @@ message OptimizeToursRequest { // [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label]. string label = 17; - // Deprecated: Use [OptimizeToursRequest.populate_transition_polylines][] instead. - // If true, polylines will be populated in response - // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]. Note that in this case, the polylines will - // also be populated in the deprecated `travel_steps`. + // Deprecated: Use [OptimizeToursRequest.populate_transition_polylines][] + // instead. If true, polylines will be populated in response + // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]. + // Note that in this case, the polylines will also be populated in the + // deprecated `travel_steps`. bool populate_travel_step_polylines = 20 [deprecated = true]; } @@ -335,23 +358,27 @@ message OptimizeToursResponse { // Overall metrics, aggregated over all routes. message Metrics { // Aggregated over the routes. Each metric is the sum (or max, for loads) - // over all [ShipmentRoute.metrics][google.cloud.optimization.v1.ShipmentRoute.metrics] fields of the same name. + // over all + // [ShipmentRoute.metrics][google.cloud.optimization.v1.ShipmentRoute.metrics] + // fields of the same name. AggregatedMetrics aggregated_route_metrics = 1; // Number of mandatory shipments skipped. int32 skipped_mandatory_shipment_count = 2; // Number of vehicles used. Note: if a vehicle route is empty and - // [Vehicle.used_if_route_is_empty][google.cloud.optimization.v1.Vehicle.used_if_route_is_empty] is true, the vehicle is considered - // used. + // [Vehicle.used_if_route_is_empty][google.cloud.optimization.v1.Vehicle.used_if_route_is_empty] + // is true, the vehicle is considered used. int32 used_vehicle_count = 3; // The earliest start time for a used vehicle, computed as the minimum over - // all used vehicles of [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time]. + // all used vehicles of + // [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time]. google.protobuf.Timestamp earliest_vehicle_start_time = 4; // The latest end time for a used vehicle, computed as the maximum over all - // used vehicles of [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time]. + // used vehicles of + // [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time]. google.protobuf.Timestamp latest_vehicle_end_time = 5; // Cost of the solution, broken down by cost-related request fields. @@ -373,8 +400,9 @@ message OptimizeToursResponse { // vehicle in the model. repeated ShipmentRoute routes = 1; - // Copy of the [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label], if a label was specified in the - // request. + // Copy of the + // [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label], + // if a label was specified in the request. string request_label = 3; // The list of all shipments skipped. @@ -382,7 +410,8 @@ message OptimizeToursResponse { // List of all the validation errors that we were able to detect // independently. See the "MULTIPLE ERRORS" explanation for the - // [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError] message. + // [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError] + // message. repeated OptimizeToursValidationError validation_errors = 5; // Duration, distance and usage metrics for this solution. @@ -431,16 +460,15 @@ message BatchOptimizeToursRequest { // If no location is specified, a region will be chosen automatically. string parent = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Input/Output information each purchase model, such as file paths and data - // formats. - repeated AsyncModelConfig model_configs = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. Input/Output information each purchase model, such as file paths + // and data formats. + repeated AsyncModelConfig model_configs = 2 + [(google.api.field_behavior) = REQUIRED]; } // Response to a `BatchOptimizeToursRequest`. This is returned in // the LRO Operation after the operation is complete. -message BatchOptimizeToursResponse { - -} +message BatchOptimizeToursResponse {} // A shipment model contains a set of shipments which must be performed by a // set of vehicles, while minimizing the overall cost, which is the sum of: @@ -466,7 +494,8 @@ message ShipmentModel { } // Specifies the rows of the duration and distance matrix. It must have as - // many elements as [ShipmentModel.duration_distance_matrix_src_tags][google.cloud.optimization.v1.ShipmentModel.duration_distance_matrix_src_tags]. + // many elements as + // [ShipmentModel.duration_distance_matrix_src_tags][google.cloud.optimization.v1.ShipmentModel.duration_distance_matrix_src_tags]. repeated Row rows = 1; // Tag defining to which vehicles this duration and distance matrix applies. @@ -530,13 +559,16 @@ message ShipmentModel { // be compatible with the order (this is checked). message BreakRequest { // Required. Lower bound (inclusive) on the start of the break. - google.protobuf.Timestamp earliest_start_time = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Timestamp earliest_start_time = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Upper bound (inclusive) on the start of the break. - google.protobuf.Timestamp latest_start_time = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Timestamp latest_start_time = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. Minimum duration of the break. Must be positive. - google.protobuf.Duration min_duration = 3 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration min_duration = 3 + [(google.api.field_behavior) = REQUIRED]; } // One may further constrain the frequency and duration of the breaks @@ -575,12 +607,14 @@ message ShipmentModel { message FrequencyConstraint { // Required. Minimum break duration for this constraint. Nonnegative. // See description of `FrequencyConstraint`. - google.protobuf.Duration min_break_duration = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration min_break_duration = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. Maximum allowed span of any interval of time in the route that does not - // include at least partially a break of `duration >= + // Required. Maximum allowed span of any interval of time in the route + // that does not include at least partially a break of `duration >= // min_break_duration`. Must be positive. - google.protobuf.Duration max_inter_break_duration = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration max_inter_break_duration = 2 + [(google.api.field_behavior) = REQUIRED]; } // Sequence of breaks. See the `BreakRequest` message. @@ -626,7 +660,8 @@ message ShipmentModel { // earliest effective start time and the latest effective end time of // all vehicles. Users can assign a cost per hour to that quantity to try // and optimize for earliest job completion, for example. This cost must be in - // the same unit as [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost]. + // the same unit as + // [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost]. double global_duration_cost_per_hour = 7; // Specifies duration and distance matrices used in the model. If this field @@ -765,7 +800,8 @@ message ShipmentModel { // Deprecated: No longer used. // Set of break rules used in the model. // Each vehicle specifies the `BreakRule` that applies to it via the - // [Vehicle.break_rule_indices][google.cloud.optimization.v1.Vehicle.break_rule_indices] field (which must be a singleton). + // [Vehicle.break_rule_indices][google.cloud.optimization.v1.Vehicle.break_rule_indices] + // field (which must be a singleton). repeated BreakRule break_rules = 15 [deprecated = true]; } @@ -834,8 +870,10 @@ message Shipment { double cost = 8; // Load demands of this visit request. This is just like - // [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this - // [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. + // [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] + // field, except that it only applies to this + // [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] + // instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. // The demands listed here are added to the demands listed in // [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]. map load_demands = 12; @@ -848,7 +886,8 @@ message Shipment { repeated string visit_types = 10; // Specifies a label for this `VisitRequest`. This label is reported in the - // response as `visit_label` in the corresponding [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]. + // response as `visit_label` in the corresponding + // [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]. string label = 11; // Deprecated: Use [VisitRequest.load_demands][] instead. @@ -857,7 +896,8 @@ message Shipment { // When performing a visit, a predefined amount may be added to the vehicle // load if it's a pickup, or subtracted if it's a delivery. This message - // defines such amount. See [load_demands][google.cloud.optimization.v1.Shipment.load_demands]. + // defines such amount. See + // [load_demands][google.cloud.optimization.v1.Shipment.load_demands]. message Load { // The amount by which the load of the vehicle performing the corresponding // visit will vary. Since it is an integer, users are advised to choose an @@ -972,7 +1012,8 @@ message Shipment { string shipment_type = 11; // Specifies a label for this shipment. This label is reported in the response - // in the `shipment_label` of the corresponding [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]. + // in the `shipment_label` of the corresponding + // [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]. string label = 12; // If true, skip this shipment, but don't apply a `penalty_cost`. @@ -1103,30 +1144,42 @@ message Vehicle { } // Defines a load limit applying to a vehicle, e.g. "this truck may only - // carry up to 3500 kg". See [load_limits][google.cloud.optimization.v1.Vehicle.load_limits]. + // carry up to 3500 kg". See + // [load_limits][google.cloud.optimization.v1.Vehicle.load_limits]. message LoadLimit { // Interval of acceptable load amounts. message Interval { // A minimum acceptable load. Must be ≥ 0. - // If they're both specified, [min][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.min] must be ≤ [max][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.max]. + // If they're both specified, + // [min][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.min] must + // be ≤ + // [max][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.max]. int64 min = 1; // A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum // load is unrestricted by this message. - // If they're both specified, [min][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.min] must be ≤ [max][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.max]. + // If they're both specified, + // [min][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.min] must + // be ≤ + // [max][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.max]. optional int64 max = 2; } // The maximum acceptable amount of load. optional int64 max_load = 1; - // A soft limit of the load. See [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. + // A soft limit of the load. See + // [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. int64 soft_max_load = 2; - // If the load ever exceeds [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load] along this vehicle's route, - // the following cost penalty applies (only once per vehicle): - // (load - [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load]) * [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs - // add up and must be in the same unit as [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost]. + // If the load ever exceeds + // [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load] + // along this vehicle's route, the following cost penalty applies (only once + // per vehicle): (load - + // [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load]) + // * [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs + // add up and must be in the same unit as + // [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost]. double cost_per_unit_above_soft_max = 3; // The acceptable load interval of the vehicle at the start of the route. @@ -1296,13 +1349,15 @@ message Vehicle { // Cost per traveled hour of the vehicle route. This cost is applied only to // travel time taken by the route (i.e., that reported in - // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]), and excludes waiting time and visit time. + // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]), + // and excludes waiting time and visit time. double cost_per_traveled_hour = 17; // Cost per kilometer of the vehicle route. This cost is applied to the - // distance reported in the [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] and does not apply - // to any distance implicitly traveled from the `arrival_location` to the - // `departure_location` of a single `VisitRequest`. + // distance reported in the + // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] + // and does not apply to any distance implicitly traveled from the + // `arrival_location` to the `departure_location` of a single `VisitRequest`. double cost_per_kilometer = 18; // Fixed cost applied if this vehicle is used to handle a shipment. @@ -1346,14 +1401,16 @@ message Vehicle { // // If a visit request has multiple types, a duration will be added for each // type in the map. - map extra_visit_duration_for_visit_type = 24; + map extra_visit_duration_for_visit_type = + 24; // Describes the break schedule to be enforced on this vehicle. // If empty, no breaks will be scheduled for this vehicle. BreakRule break_rule = 25; // Specifies a label for this vehicle. This label is reported in the response - // as the `vehicle_label` of the corresponding [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute]. + // as the `vehicle_label` of the corresponding + // [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute]. string label = 27; // If true, `used_if_route_is_empty` must be false, and this vehicle will @@ -1383,7 +1440,8 @@ message Vehicle { repeated CapacityQuantity capacities = 13 [deprecated = true]; // Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead. - repeated CapacityQuantityInterval start_load_intervals = 14 [deprecated = true]; + repeated CapacityQuantityInterval start_load_intervals = 14 + [deprecated = true]; // Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead. repeated CapacityQuantityInterval end_load_intervals = 15 [deprecated = true]; @@ -1401,8 +1459,11 @@ message Vehicle { // event to happen at or before `soft_end_time` by incurring a cost proportional // to how long after `soft_end_time` the event occurs. `start_time`, `end_time`, // `soft_start_time` and `soft_end_time` should be within the global time limits -// (see [ShipmentModel.global_start_time][google.cloud.optimization.v1.ShipmentModel.global_start_time] and -// [ShipmentModel.global_end_time][google.cloud.optimization.v1.ShipmentModel.global_end_time]) and should respect: +// (see +// [ShipmentModel.global_start_time][google.cloud.optimization.v1.ShipmentModel.global_start_time] +// and +// [ShipmentModel.global_end_time][google.cloud.optimization.v1.ShipmentModel.global_end_time]) +// and should respect: // ``` // 0 <= `start_time` <= `soft_start_time` <= `end_time` and // 0 <= `start_time` <= `soft_end_time` <= `end_time`. @@ -1449,7 +1510,8 @@ message TimeWindow { optional double cost_per_hour_after_soft_end_time = 6; } -// Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and [ShipmentRoute.VehicleLoad][] instead. +// Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and +// [ShipmentRoute.VehicleLoad][] instead. message CapacityQuantity { option deprecated = true; @@ -1518,8 +1580,9 @@ message TransitionAttributes { // A destination visit or vehicle end matches iff its // [VisitRequest.tags][google.cloud.optimization.v1.Shipment.VisitRequest.tags] - // or [Vehicle.end_tags][google.cloud.optimization.v1.Vehicle.end_tags] either contains `dst_tag` or does not contain - // `excluded_dst_tag` (depending on which of these two fields is non-empty). + // or [Vehicle.end_tags][google.cloud.optimization.v1.Vehicle.end_tags] either + // contains `dst_tag` or does not contain `excluded_dst_tag` (depending on + // which of these two fields is non-empty). string dst_tag = 3; // See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be @@ -1533,7 +1596,8 @@ message TransitionAttributes { // Specifies a cost per kilometer applied to the distance traveled while // performing this transition. It adds up to any - // [Vehicle.cost_per_kilometer][google.cloud.optimization.v1.Vehicle.cost_per_kilometer] specified on vehicles. + // [Vehicle.cost_per_kilometer][google.cloud.optimization.v1.Vehicle.cost_per_kilometer] + // specified on vehicles. double cost_per_kilometer = 6; // Specifies a limit on the distance traveled while performing this @@ -1601,13 +1665,16 @@ message BreakRule { // be compatible with the order (this is checked). message BreakRequest { // Required. Lower bound (inclusive) on the start of the break. - google.protobuf.Timestamp earliest_start_time = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Timestamp earliest_start_time = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Upper bound (inclusive) on the start of the break. - google.protobuf.Timestamp latest_start_time = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Timestamp latest_start_time = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. Minimum duration of the break. Must be positive. - google.protobuf.Duration min_duration = 3 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration min_duration = 3 + [(google.api.field_behavior) = REQUIRED]; } // One may further constrain the frequency and duration of the breaks @@ -1646,12 +1713,14 @@ message BreakRule { message FrequencyConstraint { // Required. Minimum break duration for this constraint. Nonnegative. // See description of `FrequencyConstraint`. - google.protobuf.Duration min_break_duration = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration min_break_duration = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. Maximum allowed span of any interval of time in the route that does not - // include at least partially a break of `duration >= + // Required. Maximum allowed span of any interval of time in the route that + // does not include at least partially a break of `duration >= // min_break_duration`. Must be positive. - google.protobuf.Duration max_inter_break_duration = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration max_inter_break_duration = 2 + [(google.api.field_behavior) = REQUIRED]; } // Sequence of breaks. See the `BreakRequest` message. @@ -1763,7 +1832,8 @@ message ShipmentRoute { // A visit performed during a route. This visit corresponds to a pickup or a // delivery of a `Shipment`. message Visit { - // Index of the `shipments` field in the source [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. + // Index of the `shipments` field in the source + // [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. int32 shipment_index = 1; // If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it @@ -1814,8 +1884,9 @@ message ShipmentRoute { // Deprecated: Use [ShipmentRoute.Transition.loads][] instead. // Vehicle loads upon arrival at the visit location, for each - // type specified in [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities], `start_load_intervals`, - // `end_load_intervals` or `demands`. + // type specified in + // [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities], + // `start_load_intervals`, `end_load_intervals` or `demands`. // // Exception: we omit loads for quantity types unconstrained by intervals // and that don't have any non-zero demand on the route. @@ -1885,8 +1956,11 @@ message ShipmentRoute { EncodedPolyline route_polyline = 9; // Vehicle loads during this transition, for each type that either appears - // in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero - // [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route. + // in this vehicle's + // [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], + // or that have non-zero + // [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] + // on some shipment performed on this route. // // The loads during the first transition are the starting loads of the // vehicle route. Then, after each visit, the visit's `load_demands` are @@ -1899,10 +1973,12 @@ message ShipmentRoute { } // Reports the actual load of the vehicle at some point along the route, - // for a given type (see [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]). + // for a given type (see + // [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]). message VehicleLoad { // The amount of load on the vehicle, for the given type. The unit of load - // is usually indicated by the type. See [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]. + // is usually indicated by the type. See + // [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]. int64 amount = 1; } @@ -1992,8 +2068,10 @@ message ShipmentRoute { // between visits, before the first visit, or after the last visit, while // still satisfying the visit and vehicle time windows. For example, // - // ```start_time(previous_visit) + duration(previous_visit) + - // travel_duration(previous_visit, next_visit) > start_time(next_visit)``` + // ``` + // start_time(previous_visit) + duration(previous_visit) + + // travel_duration(previous_visit, next_visit) > start_time(next_visit) + // ``` // // Arrival at next_visit will likely happen later than its current // time window due the increased estimate of travel time @@ -2014,8 +2092,12 @@ message ShipmentRoute { repeated Break breaks = 11; // Duration, distance and load metrics for this route. The fields of - // [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are summed over all [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] or - // [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits], depending on the context. + // [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are + // summed over all + // [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] + // or + // [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits], + // depending on the context. AggregatedMetrics metrics = 12; // Cost of the route, broken down by cost-related request fields. @@ -2033,7 +2115,8 @@ message ShipmentRoute { // Deprecated: Use [ShipmentRoute.Transition.loads][] instead. // Vehicle loads upon arrival at its end location, for each - // type specified in [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities], + // type specified in + // [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities], // `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit // loads for quantity types unconstrained by intervals and that don't have any // non-zero demand on the route. @@ -2045,8 +2128,8 @@ message ShipmentRoute { // Deprecated: No longer used. // This field will only be populated at the - // [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit] level. - // Extra detour time due to the shipments visited on the route. + // [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit] + // level. Extra detour time due to the shipments visited on the route. // // It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration // from the vehicle's start_location to its `end_location`. @@ -2151,8 +2234,9 @@ message SkippedShipment { // `ShipmentModel`. int32 index = 1; - // Copy of the corresponding [Shipment.label][google.cloud.optimization.v1.Shipment.label], if specified in the - // `Shipment`. + // Copy of the corresponding + // [Shipment.label][google.cloud.optimization.v1.Shipment.label], if specified + // in the `Shipment`. string label = 2; // A list of reasons that explain why the shipment was skipped. See comment @@ -2160,7 +2244,9 @@ message SkippedShipment { repeated Reason reasons = 3; } -// Aggregated metrics for [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute] (resp. for [OptimizeToursResponse][google.cloud.optimization.v1.OptimizeToursResponse] +// Aggregated metrics for +// [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute] (resp. for +// [OptimizeToursResponse][google.cloud.optimization.v1.OptimizeToursResponse] // over all [Transition][google.cloud.optimization.v1.ShipmentRoute.Transition] // and/or [Visit][google.cloud.optimization.v1.ShipmentRoute.Visit] (resp. over // all [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute]) elements. @@ -2185,7 +2271,9 @@ message AggregatedMetrics { google.protobuf.Duration visit_duration = 6; // The total duration should be equal to the sum of all durations above. - // For routes, it also corresponds to [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time] - + // For routes, it also corresponds to + // [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time] + // - // [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time]. google.protobuf.Duration total_duration = 7; @@ -2200,10 +2288,12 @@ message AggregatedMetrics { // [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads]. map max_loads = 9; - // Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead. + // Deprecated: Use [ShipmentRoute.route_costs][] and + // [OptimizeToursResponse.Metrics.costs][] instead. map costs = 10 [deprecated = true]; - // Deprecated: Use [ShipmentRoute.route_total_cost][] and [OptimizeToursResponse.Metrics.total_cost][] instead. + // Deprecated: Use [ShipmentRoute.route_total_cost][] and + // [OptimizeToursResponse.Metrics.total_cost][] instead. double total_cost = 11 [deprecated = true]; } @@ -2309,8 +2399,9 @@ message InjectedSolutionConstraint { // `vehicle_indices`. A vehicle index can only be listed once, even within // several `constraint_relaxations`. // - // A vehicle index is mapped the same as [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index], if - // `interpret_injected_solutions_using_labels` is true (see `fields` + // A vehicle index is mapped the same as + // [ShipmentRoute.vehicle_index][google.cloud.optimization.v1.ShipmentRoute.vehicle_index], + // if `interpret_injected_solutions_using_labels` is true (see `fields` // comment). repeated int32 vehicle_indices = 2; } diff --git a/google/cloud/orchestration/airflow/service/v1/BUILD.bazel b/google/cloud/orchestration/airflow/service/v1/BUILD.bazel index 2c883ea53..abef15e2f 100644 --- a/google/cloud/orchestration/airflow/service/v1/BUILD.bazel +++ b/google/cloud/orchestration/airflow/service/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "service_java_gapic", srcs = [":service_proto_with_info"], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":service_java_grpc", ], @@ -134,13 +135,14 @@ go_gapic_library( grpc_service_config = "composer_grpc_service_config.json", importpath = "cloud.google.com/go/orchestration/airflow/service/apiv1;service", metadata = True, + rest_numeric_enums = True, service_yaml = "composer_v1.yaml", transport = "grpc+rest", deps = [ ":service_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +181,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-orchestration-airflow", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "service_php_gapic", srcs = [":service_proto_with_info"], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "composer_v1.yaml", + transport = "grpc+rest", deps = [ ":service_php_grpc", ":service_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "composer_grpc_service_config.json", package = "google.cloud.orchestration.airflow.service.v1", + rest_numeric_enums = True, service_yaml = "composer_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=composer", ], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The client library for the Cloud Composer API, built on the popular Apache Airflow open source project. Cloud Composer is a fully managed workflow orchestration service, enabling you to create, schedule, monitor, and manage workflows that span across clouds and on-premises data centers.", ruby_cloud_title = "Cloud Composer V1", deps = [ @@ -348,6 +356,7 @@ csharp_gapic_library( srcs = [":service_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "composer_v1.yaml", deps = [ ":service_csharp_grpc", diff --git a/google/cloud/orchestration/airflow/service/v1/composer_v1.yaml b/google/cloud/orchestration/airflow/service/v1/composer_v1.yaml index 2ad9fb5c2..f4a254cb2 100644 --- a/google/cloud/orchestration/airflow/service/v1/composer_v1.yaml +++ b/google/cloud/orchestration/airflow/service/v1/composer_v1.yaml @@ -6,10 +6,13 @@ title: Cloud Composer API apis: - name: google.cloud.orchestration.airflow.service.v1.Environments - name: google.cloud.orchestration.airflow.service.v1.ImageVersions +- name: google.longrunning.Operations types: - name: google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse +- name: google.cloud.orchestration.airflow.service.v1.LoadSnapshotResponse - name: google.cloud.orchestration.airflow.service.v1.OperationMetadata +- name: google.cloud.orchestration.airflow.service.v1.SaveSnapshotResponse documentation: summary: Manages Apache Airflow environments on Google Cloud Platform. diff --git a/google/cloud/orchestration/airflow/service/v1/environments.proto b/google/cloud/orchestration/airflow/service/v1/environments.proto index 0579d51ac..0916ec959 100644 --- a/google/cloud/orchestration/airflow/service/v1/environments.proto +++ b/google/cloud/orchestration/airflow/service/v1/environments.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. @@ -86,6 +86,36 @@ service Environments { metadata_type: "google.cloud.orchestration.airflow.service.v1.OperationMetadata" }; } + + // Creates a snapshots of a Cloud Composer environment. + // + // As a result of this operation, snapshot of environment's state is stored + // in a location specified in the SaveSnapshotRequest. + rpc SaveSnapshot(SaveSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{environment=projects/*/locations/*/environments/*}:saveSnapshot" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.orchestration.airflow.service.v1.SaveSnapshotResponse" + metadata_type: "google.cloud.orchestration.airflow.service.v1.OperationMetadata" + }; + } + + // Loads a snapshot of a Cloud Composer environment. + // + // As a result of this operation, a snapshot of environment's specified in + // LoadSnapshotRequest is loaded into the environment. + rpc LoadSnapshot(LoadSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{environment=projects/*/locations/*/environments/*}:loadSnapshot" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.orchestration.airflow.service.v1.LoadSnapshotResponse" + metadata_type: "google.cloud.orchestration.airflow.service.v1.OperationMetadata" + }; + } } // Create a new environment. @@ -230,13 +260,10 @@ message UpdateEnvironmentRequest { // * `config.nodeCount` // * Horizontally scale the number of nodes in the environment. An integer // greater than or equal to 3 must be provided in the `config.nodeCount` - // field. + // field. Supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. // * `config.webServerNetworkAccessControl` // * Replace the environment's current `WebServerNetworkAccessControl`. - // * `config.databaseConfig` - // * Replace the environment's current `DatabaseConfig`. - // * `config.webServerConfig` - // * Replace the environment's current `WebServerConfig`. // * `config.softwareConfig.airflowConfigOverrides` // * Replace all Apache Airflow config overrides. If a replacement config // overrides map is not included in `environment`, all config overrides @@ -254,14 +281,94 @@ message UpdateEnvironmentRequest { // * `config.softwareConfig.envVariables` // * Replace all environment variables. If a replacement environment // variable map is not included in `environment`, all custom environment - // variables are cleared. - // It is an error to provide both this mask and a mask specifying one or - // more individual environment variables. + // variables are cleared. + // * `config.softwareConfig.schedulerCount` + // * Horizontally scale the number of schedulers in Airflow. A positive + // integer not greater than the number of nodes must be provided in the + // `config.softwareConfig.schedulerCount` field. Supported for Cloud + // Composer environments in versions composer-1.*.*-airflow-2.*.*. + // * `config.databaseConfig.machineType` + // * Cloud SQL machine type used by Airflow database. + // It has to be one of: db-n1-standard-2, db-n1-standard-4, + // db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer + // environments in versions composer-1.*.*-airflow-*.*.*. + // * `config.webServerConfig.machineType` + // * Machine type on which Airflow web server is running. + // It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 + // or composer-n1-webserver-8. Supported for Cloud Composer environments + // in versions composer-1.*.*-airflow-*.*.*. google.protobuf.FieldMask update_mask = 3; } +// Request to create a snapshot of a Cloud Composer environment. +message SaveSnapshotRequest { + // The resource name of the source environment in the form: + // "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + string environment = 1; + + // Location in a Cloud Storage where the snapshot is going to be stored, e.g.: + // "gs://my-bucket/snapshots". + string snapshot_location = 2; +} + +// Response to SaveSnapshotRequest. +message SaveSnapshotResponse { + // The fully-resolved Cloud Storage path of the created snapshot, + // e.g.: + // "gs://my-bucket/snapshots/project_location_environment_timestamp". + // This field is populated only if the snapshot creation was successful. + string snapshot_path = 1; +} + +// Request to load a snapshot into a Cloud Composer environment. +message LoadSnapshotRequest { + // The resource name of the target environment in the form: + // "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + string environment = 1; + + // A Cloud Storage path to a snapshot to load, e.g.: + // "gs://my-bucket/snapshots/project_location_environment_timestamp". + string snapshot_path = 2; + + // Whether or not to skip installing Pypi packages when loading the + // environment's state. + bool skip_pypi_packages_installation = 3; + + // Whether or not to skip setting environment variables when loading the + // environment's state. + bool skip_environment_variables_setting = 4; + + // Whether or not to skip setting Airflow overrides when loading the + // environment's state. + bool skip_airflow_overrides_setting = 5; + + // Whether or not to skip copying Cloud Storage data when loading the + // environment's state. + bool skip_gcs_data_copying = 6; +} + +// Response to LoadSnapshotRequest. +message LoadSnapshotResponse { + +} + // Configuration information for an environment. message EnvironmentConfig { + // The size of the Cloud Composer environment. + enum EnvironmentSize { + // The size of the environment is unspecified. + ENVIRONMENT_SIZE_UNSPECIFIED = 0; + + // The environment size is small. + ENVIRONMENT_SIZE_SMALL = 1; + + // The environment size is medium. + ENVIRONMENT_SIZE_MEDIUM = 2; + + // The environment size is large. + ENVIRONMENT_SIZE_LARGE = 3; + } + // Output only. The Kubernetes Engine cluster used to run this environment. string gke_cluster = 1; @@ -273,6 +380,9 @@ message EnvironmentConfig { // The number of nodes in the Kubernetes Engine cluster that will be // used to run this environment. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. int32 node_count = 3; // The configuration settings for software inside the environment. @@ -299,10 +409,53 @@ message EnvironmentConfig { // and its dependencies. Cannot be updated. EncryptionConfig encryption_config = 11 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The maintenance window is the period when Cloud Composer components may + // undergo maintenance. It is defined so that maintenance is not executed + // during peak hours or critical time periods. + // + // The system will not be under maintenance for every occurrence of this + // window, but when maintenance is planned, it will be scheduled + // during the window. + // + // The maintenance window period must encompass at least 12 hours per week. + // This may be split into multiple chunks, each with a size of + // at least 4 hours. + // + // If this value is omitted, the default value for maintenance window will be + // applied. The default value is Saturday and Sunday 00-06 GMT. + MaintenanceWindow maintenance_window = 12 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The workloads configuration settings for the GKE cluster associated with + // the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web + // server and workers workloads. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + WorkloadsConfig workloads_config = 15 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The size of the Cloud Composer environment. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + EnvironmentSize environment_size = 16 [(google.api.field_behavior) = OPTIONAL]; + // Output only. The URI of the Apache Airflow Web UI hosted within this environment (see // [Airflow web // interface](/composer/docs/how-to/accessing/airflow-web-interface)). string airflow_uri = 6; + + // Optional. The configuration options for GKE cluster master authorized networks. + // By default master authorized networks feature is: + // - in case of private environment: enabled with no external networks + // allowlisted. + // - in case of public environment: disabled. + MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The Recovery settings configuration of an environment. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + RecoveryConfig recovery_config = 18 [(google.api.field_behavior) = OPTIONAL]; } // Network-level access control policy for the Airflow web server. @@ -333,10 +486,14 @@ message DatabaseConfig { // Optional. Cloud SQL machine type used by Airflow database. // It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 // or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. + // Supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string machine_type = 1 [(google.api.field_behavior) = OPTIONAL]; } // The configuration settings for the Airflow web server App Engine instance. +// Supported for Cloud Composer environments in versions +// composer-1.*.*-airflow-*.*.* message WebServerConfig { // Optional. Machine type on which Airflow web server is running. // It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or @@ -348,7 +505,8 @@ message WebServerConfig { } // The encryption options for the Cloud Composer environment -// and its dependencies. +// and its dependencies.Supported for Cloud Composer environments in versions +// composer-1.*.*-airflow-*.*.*. message EncryptionConfig { // Optional. Customer-managed Encryption Key available through Google's Key Management // Service. Cannot be updated. @@ -356,28 +514,62 @@ message EncryptionConfig { string kms_key_name = 1 [(google.api.field_behavior) = OPTIONAL]; } +// The configuration settings for Cloud Composer maintenance window. +// The following example: +// +// ``` +// { +// "startTime":"2019-08-01T01:00:00Z" +// "endTime":"2019-08-01T07:00:00Z" +// "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE" +// } +// ``` +// +// would define a maintenance window between 01 and 07 hours UTC during +// each Tuesday and Wednesday. +message MaintenanceWindow { + // Required. Start time of the first recurrence of the maintenance window. + google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Maintenance window end time. It is used only to calculate the duration of + // the maintenance window. + // The value for end-time must be in the future, relative to + // `start_time`. + google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. Maintenance window recurrence. Format is a subset of + // [RFC-5545](https://tools.ietf.org/html/rfc5545) `RRULE`. The only allowed + // values for `FREQ` field are `FREQ=DAILY` and `FREQ=WEEKLY;BYDAY=...` + // Example values: `FREQ=WEEKLY;BYDAY=TU,WE`, `FREQ=DAILY`. + string recurrence = 3 [(google.api.field_behavior) = REQUIRED]; +} + // Specifies the selection and configuration of software inside the environment. message SoftwareConfig { // The version of the software running in the environment. // This encapsulates both the version of Cloud Composer functionality and the // version of Apache Airflow. It must match the regular expression - // `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. + // `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. // When used as input, the server also checks if the provided version is // supported and denies the request for an unsupported version. // - // The Cloud Composer portion of the version is a - // [semantic version](https://semver.org) or `latest`. When the patch version - // is omitted, the current Cloud Composer patch version is selected. - // When `latest` is provided instead of an explicit version number, - // the server replaces `latest` with the current Cloud Composer version - // and stores that version number in the same field. + // The Cloud Composer portion of the image version is a full + // [semantic version](https://semver.org), or an alias in the form of major + // version number or `latest`. When an alias is provided, the server replaces + // it with the current Cloud Composer version that satisfies the alias. // - // The portion of the image version that follows *airflow-* is an - // official Apache Airflow repository - // [release name](https://github.com/apache/incubator-airflow/releases). + // The Apache Airflow portion of the image version is a full semantic version + // that points to one of the supported Apache Airflow versions, or an alias in + // the form of only major or major.minor versions specified. When an alias is + // provided, the server replaces it with the latest Apache Airflow version + // that satisfies the alias and is supported in the given Cloud Composer + // version. // - // See also [Version - // List](/composer/docs/concepts/versioning/composer-versions). + // In all cases, the resolved image version is stored in the same field. + // + // See also [version + // list](/composer/docs/concepts/versioning/composer-versions) and [versioning + // overview](/composer/docs/concepts/versioning/composer-versioning-overview). string image_version = 1; // Optional. Apache Airflow configuration properties to override. @@ -436,7 +628,17 @@ message SoftwareConfig { // // Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be // updated. + // + // This field is only supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. Environments in newer versions always use + // Python major version 3. string python_version = 6; + + // Optional. The number of schedulers for Airflow. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-2.*.*. + int32 scheduler_count = 7 [(google.api.field_behavior) = OPTIONAL]; } // Configuration for controlling how IPs are allocated in the @@ -444,6 +646,10 @@ message SoftwareConfig { message IPAllocationPolicy { // Optional. Whether or not to enable Alias IPs in the GKE cluster. // If `true`, a VPC-native cluster is created. + // + // This field is only supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. Environments in newer versions always use + // VPC-native GKE clusters. bool use_ip_aliases = 1 [(google.api.field_behavior) = OPTIONAL]; // Configuration of allocating IP addresses for pods in the GKE cluster. @@ -451,13 +657,15 @@ message IPAllocationPolicy { // Optional. The name of the GKE cluster's secondary range used to allocate // IP addresses to pods. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. string cluster_secondary_range_name = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The IP address range used to allocate IP addresses to pods in // the GKE cluster. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. // // Set to blank to have GKE choose a range with the default size. // @@ -465,7 +673,7 @@ message IPAllocationPolicy { // netmask. // // Set to a - // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range // to use. @@ -477,13 +685,15 @@ message IPAllocationPolicy { // Optional. The name of the services' secondary range used to allocate // IP addresses to the GKE cluster. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. string services_secondary_range_name = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The IP address range of the services IP addresses in this // GKE cluster. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. // // Set to blank to have GKE choose a range with the default size. // @@ -491,7 +701,7 @@ message IPAllocationPolicy { // netmask. // // Set to a - // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range // to use. @@ -516,6 +726,9 @@ message NodeConfig { // both fields. If only one field (`location` or `nodeConfig.machineType`) is // specified, the location information from the specified field will be // propagated to the unspecified field. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string location = 1; // Optional. The Compute Engine @@ -539,6 +752,9 @@ message NodeConfig { // // If this field is unspecified, the `machineTypeId` defaults // to "n1-standard-1". + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string machine_type = 2; // Optional. The Compute Engine network to be used for machine @@ -565,13 +781,19 @@ message NodeConfig { // location. string subnetwork = 4; - // Optional. The disk size in GB used for node VMs. Minimum size is 20GB. + // Optional. The disk size in GB used for node VMs. Minimum size is 30GB. // If unspecified, defaults to 100GB. Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. int32 disk_size_gb = 5; // Optional. The set of Google API scopes to be made available on all // node VMs. If `oauth_scopes` is empty, defaults to // ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. repeated string oauth_scopes = 6; // Optional. The Google Cloud Platform Service Account to be used by the node @@ -583,10 +805,21 @@ message NodeConfig { // to identify valid sources or targets for network firewalls. Each tag within // the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). // Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. repeated string tags = 8; // Optional. The configuration for controlling how IPs are allocated in the GKE cluster. IPAllocationPolicy ip_allocation_policy = 9 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines + // nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for + // all destination addresses, except between pods traffic. + // + // See: + // https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent + bool enable_ip_masq_agent = 11 [(google.api.field_behavior) = OPTIONAL]; } // Configuration options for the private GKE cluster in a Cloud Composer @@ -608,12 +841,39 @@ message PrivateClusterConfig { string master_ipv4_reserved_range = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Configuration options for networking connections in the Composer 2 +// environment. +message NetworkingConfig { + // Represents connection type between Composer environment in Customer + // Project and the corresponding Tenant project, from a predefined list + // of available connection modes. + enum ConnectionType { + // No specific connection type was requested, so the environment uses + // the default value corresponding to the rest of its configuration. + CONNECTION_TYPE_UNSPECIFIED = 0; + + // Requests the use of VPC peerings for connecting the Customer and Tenant + // projects. + VPC_PEERING = 1; + + // Requests the use of Private Service Connect for connecting the Customer + // and Tenant projects. + PRIVATE_SERVICE_CONNECT = 2; + } + + // Optional. Indicates the user requested specifc connection type between Tenant and + // Customer projects. + // You cannot set networking connection type in public IP environment. + ConnectionType connection_type = 1 [(google.api.field_behavior) = OPTIONAL]; +} + // The configuration information for configuring a Private IP Cloud Composer // environment. message PrivateEnvironmentConfig { // Optional. If `true`, a Private IP Cloud Composer environment is created. // If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be - // set to true. + // set to true for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. bool enable_private_environment = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for the private GKE cluster for a Private IP @@ -623,6 +883,9 @@ message PrivateEnvironmentConfig { // Optional. The CIDR block from which IP range for web server will be reserved. Needs // to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and // `cloud_sql_ipv4_cidr_block`. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string web_server_ipv4_cidr_block = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The CIDR block from which IP range in tenant project will be reserved for @@ -630,7 +893,143 @@ message PrivateEnvironmentConfig { string cloud_sql_ipv4_cidr_block = 4 [(google.api.field_behavior) = OPTIONAL]; // Output only. The IP range reserved for the tenant project's App Engine VMs. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string web_server_ipv4_reserved_range = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. The CIDR block from which IP range for Cloud Composer Network in tenant + // project will be reserved. Needs to be disjoint from + // private_cluster_config.master_ipv4_cidr_block and + // cloud_sql_ipv4_cidr_block. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + string cloud_composer_network_ipv4_cidr_block = 7 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. The IP range reserved for the tenant project's Cloud Composer network. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + string cloud_composer_network_ipv4_reserved_range = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for + // `IPAllocationPolicy.cluster_ipv4_cidr_block` and + // `IPAllocationPolicy.service_ipv4_cidr_block`. + bool enable_privately_used_public_ips = 6 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. When specified, the environment will use Private Service Connect + // instead of VPC peerings to connect to Cloud SQL in the Tenant Project, + // and the PSC endpoint in the Customer Project will use an IP address from + // this subnetwork. + string cloud_composer_connection_subnetwork = 9 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Configuration for the network connections configuration in the environment. + NetworkingConfig networking_config = 10 [(google.api.field_behavior) = OPTIONAL]; +} + +// The Kubernetes workloads configuration for GKE cluster associated with the +// Cloud Composer environment. Supported for Cloud Composer environments in +// versions composer-2.*.*-airflow-*.*.* and newer. +message WorkloadsConfig { + // Configuration for resources used by Airflow schedulers. + message SchedulerResource { + // Optional. CPU request and limit for a single Airflow scheduler replica. + float cpu = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Memory (GB) request and limit for a single Airflow scheduler replica. + float memory_gb = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Storage (GB) request and limit for a single Airflow scheduler replica. + float storage_gb = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The number of schedulers. + int32 count = 4 [(google.api.field_behavior) = OPTIONAL]; + } + + // Configuration for resources used by Airflow web server. + message WebServerResource { + // Optional. CPU request and limit for Airflow web server. + float cpu = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Memory (GB) request and limit for Airflow web server. + float memory_gb = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Storage (GB) request and limit for Airflow web server. + float storage_gb = 3 [(google.api.field_behavior) = OPTIONAL]; + } + + // Configuration for resources used by Airflow workers. + message WorkerResource { + // Optional. CPU request and limit for a single Airflow worker replica. + float cpu = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Memory (GB) request and limit for a single Airflow worker replica. + float memory_gb = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Storage (GB) request and limit for a single Airflow worker replica. + float storage_gb = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Minimum number of workers for autoscaling. + int32 min_count = 4 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Maximum number of workers for autoscaling. + int32 max_count = 5 [(google.api.field_behavior) = OPTIONAL]; + } + + // Optional. Resources used by Airflow schedulers. + SchedulerResource scheduler = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Resources used by Airflow web server. + WebServerResource web_server = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Resources used by Airflow workers. + WorkerResource worker = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// The Recovery settings of an environment. +message RecoveryConfig { + // Optional. The configuration for scheduled snapshot creation mechanism. + ScheduledSnapshotsConfig scheduled_snapshots_config = 1 [(google.api.field_behavior) = OPTIONAL]; +} + +// The configuration for scheduled snapshot creation mechanism. +message ScheduledSnapshotsConfig { + // Optional. Whether scheduled snapshots creation is enabled. + bool enabled = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The Cloud Storage location for storing automatically created snapshots. + string snapshot_location = 6 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The cron expression representing the time when snapshots creation mechanism + // runs. This field is subject to additional validation around frequency of + // execution. + string snapshot_creation_schedule = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Time zone that sets the context to interpret snapshot_creation_schedule. + string time_zone = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Configuration options for the master authorized networks feature. Enabled +// master authorized networks will disallow all external traffic to access +// Kubernetes master through HTTPS except traffic from the given CIDR blocks, +// Google Compute Engine Public IPs and Google Prod IPs. +message MasterAuthorizedNetworksConfig { + // CIDR block with an optional name. + message CidrBlock { + // User-defined name that identifies the CIDR block. + string display_name = 1; + + // CIDR block that must be specified in CIDR notation. + string cidr_block = 2; + } + + // Whether or not master authorized networks feature is enabled. + bool enabled = 1; + + // Up to 50 external networks that could access Kubernetes master through + // HTTPS. + repeated CidrBlock cidr_blocks = 2; } // An environment for running orchestration tasks. diff --git a/google/cloud/orchestration/airflow/service/v1/image_versions.proto b/google/cloud/orchestration/airflow/service/v1/image_versions.proto index ea65c8d85..8226c463b 100644 --- a/google/cloud/orchestration/airflow/service/v1/image_versions.proto +++ b/google/cloud/orchestration/airflow/service/v1/image_versions.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. @@ -66,7 +66,7 @@ message ListImageVersionsResponse { // ImageVersion information message ImageVersion { // The string identifier of the ImageVersion, in the form: - // "composer-x.y.z-airflow-a.b(.c)" + // "composer-x.y.z-airflow-a.b.c" string image_version_id = 1; // Whether this is the default ImageVersion used by Composer during diff --git a/google/cloud/orchestration/airflow/service/v1/operations.proto b/google/cloud/orchestration/airflow/service/v1/operations.proto index 9bb3a05dd..332e09623 100644 --- a/google/cloud/orchestration/airflow/service/v1/operations.proto +++ b/google/cloud/orchestration/airflow/service/v1/operations.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. @@ -63,6 +63,12 @@ message OperationMetadata { // A resource check operation. CHECK = 4; + + // Saves snapshot of the resource operation. + SAVE_SNAPSHOT = 5; + + // Loads snapshot of the resource operation. + LOAD_SNAPSHOT = 6; } // Output only. The current operation state. diff --git a/google/cloud/orchestration/airflow/service/v1beta1/BUILD.bazel b/google/cloud/orchestration/airflow/service/v1beta1/BUILD.bazel index f62191b85..0caec5f48 100644 --- a/google/cloud/orchestration/airflow/service/v1beta1/BUILD.bazel +++ b/google/cloud/orchestration/airflow/service/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "service_java_gapic", srcs = [":service_proto_with_info"], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":service_java_grpc", ], @@ -134,13 +135,14 @@ go_gapic_library( grpc_service_config = "composer_grpc_service_config.json", importpath = "cloud.google.com/go/orchestration/airflow/service/apiv1beta1;service", metadata = True, + rest_numeric_enums = True, service_yaml = "composer_v1beta1.yaml", transport = "grpc+rest", deps = [ ":service_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -176,6 +178,7 @@ py_gapic_library( name = "service_py_gapic", srcs = [":service_proto"], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -223,7 +226,9 @@ php_gapic_library( name = "service_php_gapic", srcs = [":service_proto_with_info"], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "composer_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":service_php_grpc", ":service_php_proto", @@ -256,7 +261,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "composer_grpc_service_config.json", package = "google.cloud.orchestration.airflow.service.v1beta1", + rest_numeric_enums = True, service_yaml = "composer_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,6 +307,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=composer", ], grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The client library for the Cloud Composer API, built on the popular Apache Airflow open source project. Cloud Composer is a fully managed workflow orchestration service, enabling you to create, schedule, monitor, and manage workflows that span across clouds and on-premises data centers.", ruby_cloud_title = "Cloud Composer V1beta1", deps = [ @@ -345,6 +353,7 @@ csharp_gapic_library( srcs = [":service_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "composer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "composer_v1beta1.yaml", deps = [ ":service_csharp_grpc", diff --git a/google/cloud/orchestration/airflow/service/v1beta1/composer_v1beta1.yaml b/google/cloud/orchestration/airflow/service/v1beta1/composer_v1beta1.yaml index dca24acc0..b77a99f6d 100644 --- a/google/cloud/orchestration/airflow/service/v1beta1/composer_v1beta1.yaml +++ b/google/cloud/orchestration/airflow/service/v1beta1/composer_v1beta1.yaml @@ -6,10 +6,15 @@ title: Cloud Composer API apis: - name: google.cloud.orchestration.airflow.service.v1beta1.Environments - name: google.cloud.orchestration.airflow.service.v1beta1.ImageVersions +- name: google.longrunning.Operations types: - name: google.cloud.orchestration.airflow.service.v1beta1.CheckUpgradeResponse +- name: google.cloud.orchestration.airflow.service.v1beta1.ExecuteAirflowCommandResponse +- name: google.cloud.orchestration.airflow.service.v1beta1.LoadSnapshotResponse - name: google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata +- name: google.cloud.orchestration.airflow.service.v1beta1.PollAirflowCommandResponse +- name: google.cloud.orchestration.airflow.service.v1beta1.SaveSnapshotResponse documentation: summary: Manages Apache Airflow environments on Google Cloud Platform. diff --git a/google/cloud/orchestration/airflow/service/v1beta1/environments.proto b/google/cloud/orchestration/airflow/service/v1beta1/environments.proto index a96a417fc..b2797ea7a 100644 --- a/google/cloud/orchestration/airflow/service/v1beta1/environments.proto +++ b/google/cloud/orchestration/airflow/service/v1beta1/environments.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. @@ -112,6 +112,36 @@ service Environments { metadata_type: "google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata" }; } + + // Creates a snapshots of a Cloud Composer environment. + // + // As a result of this operation, snapshot of environment's state is stored + // in a location specified in the SaveSnapshotRequest. + rpc SaveSnapshot(SaveSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{environment=projects/*/locations/*/environments/*}:saveSnapshot" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.orchestration.airflow.service.v1beta1.SaveSnapshotResponse" + metadata_type: "google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata" + }; + } + + // Loads a snapshot of a Cloud Composer environment. + // + // As a result of this operation, a snapshot of environment's specified in + // LoadSnapshotRequest is loaded into the environment. + rpc LoadSnapshot(LoadSnapshotRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{environment=projects/*/locations/*/environments/*}:loadSnapshot" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "google.cloud.orchestration.airflow.service.v1beta1.LoadSnapshotResponse" + metadata_type: "google.cloud.orchestration.airflow.service.v1beta1.OperationMetadata" + }; + } } // Create a new environment. @@ -256,7 +286,9 @@ message UpdateEnvironmentRequest { // * `config.nodeCount` // * Horizontally scale the number of nodes in the environment. An integer // greater than or equal to 3 must be provided in the `config.nodeCount` - // field. * `config.webServerNetworkAccessControl` + // field. Supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. + // * `config.webServerNetworkAccessControl` // * Replace the environment's current WebServerNetworkAccessControl. // * `config.softwareConfig.airflowConfigOverrides` // * Replace all Apache Airflow config overrides. If a replacement config @@ -275,30 +307,43 @@ message UpdateEnvironmentRequest { // * `config.softwareConfig.envVariables` // * Replace all environment variables. If a replacement environment // variable map is not included in `environment`, all custom environment - // variables are cleared. - // It is an error to provide both this mask and a mask specifying one or - // more individual environment variables. + // variables are cleared. // * `config.softwareConfig.imageVersion` // * Upgrade the version of the environment in-place. Refer to // `SoftwareConfig.image_version` for information on how to format the // new image version. Additionally, the new image version cannot effect - // a version downgrade and must match the current image version's - // Composer major version and Airflow major and minor versions. Consult - // the [Cloud Composer Version - // List](https://cloud.google.com/composer/docs/concepts/versioning/composer-versions) + // a version downgrade, and must match the current image version's + // Composer and Airflow major versions. Consult the [Cloud Composer + // version list](/composer/docs/concepts/versioning/composer-versions) // for valid values. // * `config.softwareConfig.schedulerCount` // * Horizontally scale the number of schedulers in Airflow. A positive // integer not greater than the number of nodes must be provided in the - // `config.softwareConfig.schedulerCount` field. * `config.databaseConfig.machineType` + // `config.softwareConfig.schedulerCount` field. Supported for Cloud + // Composer environments in versions composer-1.*.*-airflow-2.*.*. + // * `config.softwareConfig.cloudDataLineageIntegration` + // * Configuration for Cloud Data Lineage integration. + // * `config.databaseConfig.machineType` // * Cloud SQL machine type used by Airflow database. // It has to be one of: db-n1-standard-2, db-n1-standard-4, - // db-n1-standard-8 or db-n1-standard-16. * `config.webServerConfig.machineType` + // db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer + // environments in versions composer-1.*.*-airflow-*.*.*. + // * `config.webServerConfig.machineType` // * Machine type on which Airflow web server is running. // It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 - // or composer-n1-webserver-8. * `config.maintenanceWindow` + // or composer-n1-webserver-8. Supported for Cloud Composer environments + // in versions composer-1.*.*-airflow-*.*.*. + // * `config.maintenanceWindow` // * Maintenance window during which Cloud Composer components may be // under maintenance. + // * `config.workloadsConfig` + // * The workloads configuration settings for the GKE cluster associated + // with the Cloud Composer environment. Supported for Cloud Composer + // environments in versions composer-2.*.*-airflow-*.*.* and newer. + // * `config.environmentSize` + // * The size of the Cloud Composer environment. Supported for Cloud + // Composer environments in versions composer-2.*.*-airflow-*.*.* and + // newer. google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED]; } @@ -310,6 +355,104 @@ message RestartWebServerRequest { string name = 1; } +// Response to ExecuteAirflowCommandRequest. +message ExecuteAirflowCommandResponse { + // The unique ID of the command execution for polling. + string execution_id = 1; + + // The name of the pod where the command is executed. + string pod = 2; + + // The namespace of the pod where the command is executed. + string pod_namespace = 3; + + // Error message. Empty if there was no error. + string error = 4; +} + +// Response to PollAirflowCommandRequest. +message PollAirflowCommandResponse { + // Contains information about a single line from logs. + message Line { + // Number of the line. + int32 line_number = 1; + + // Text content of the log line. + string content = 2; + } + + // Information about how a command ended. + message ExitInfo { + // The exit code from the command execution. + int32 exit_code = 1; + + // Error message. Empty if there was no error. + string error = 2; + } + + // Output from the command execution. It may not contain the full output + // and the caller may need to poll for more lines. + repeated Line output = 1; + + // Whether the command execution has finished and there is no more output. + bool output_end = 2; + + // The result exit status of the command. + ExitInfo exit_info = 3; +} + +// Request to create a snapshot of a Cloud Composer environment. +message SaveSnapshotRequest { + // The resource name of the source environment in the form: + // "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + string environment = 1; + + // Location in a Cloud Storage where the snapshot is going to be stored, e.g.: + // "gs://my-bucket/snapshots". + string snapshot_location = 2; +} + +// Response to SaveSnapshotRequest. +message SaveSnapshotResponse { + // The fully-resolved Cloud Storage path of the created snapshot, + // e.g.: + // "gs://my-bucket/snapshots/project_location_environment_timestamp". + // This field is populated only if the snapshot creation was successful. + string snapshot_path = 1; +} + +// Request to load a snapshot into a Cloud Composer environment. +message LoadSnapshotRequest { + // The resource name of the target environment in the form: + // "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + string environment = 1; + + // A Cloud Storage path to a snapshot to load, e.g.: + // "gs://my-bucket/snapshots/project_location_environment_timestamp". + string snapshot_path = 2; + + // Whether or not to skip installing Pypi packages when loading the + // environment's state. + bool skip_pypi_packages_installation = 3; + + // Whether or not to skip setting environment variables when loading the + // environment's state. + bool skip_environment_variables_setting = 4; + + // Whether or not to skip setting Airflow overrides when loading the + // environment's state. + bool skip_airflow_overrides_setting = 5; + + // Whether or not to skip copying Cloud Storage data when loading the + // environment's state. + bool skip_gcs_data_copying = 6; +} + +// Response to LoadSnapshotRequest. +message LoadSnapshotResponse { + +} + // Configuration information for an environment. message EnvironmentConfig { // The size of the Cloud Composer environment. @@ -338,6 +481,9 @@ message EnvironmentConfig { // The number of nodes in the Kubernetes Engine cluster that will be // used to run this environment. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. int32 node_count = 3; // The configuration settings for software inside the environment. @@ -358,6 +504,9 @@ message EnvironmentConfig { DatabaseConfig database_config = 10 [(google.api.field_behavior) = OPTIONAL]; // Optional. The configuration settings for the Airflow web server App Engine instance. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. WebServerConfig web_server_config = 11 [(google.api.field_behavior) = OPTIONAL]; // Output only. The URI of the Apache Airflow Web UI hosted within this environment (see @@ -398,6 +547,19 @@ message EnvironmentConfig { // This field is supported for Cloud Composer environments in versions // composer-2.*.*-airflow-*.*.* and newer. EnvironmentSize environment_size = 16 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The configuration options for GKE cluster master authorized networks. + // By default master authorized networks feature is: + // - in case of private environment: enabled with no external networks + // allowlisted. + // - in case of public environment: disabled. + MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The Recovery settings configuration of an environment. + // + // This field is supported for Cloud Composer environments in versions + // composer-2.*.*-airflow-*.*.* and newer. + RecoveryConfig recovery_config = 18 [(google.api.field_behavior) = OPTIONAL]; } // Network-level access control policy for the Airflow web server. @@ -427,23 +589,27 @@ message SoftwareConfig { // The version of the software running in the environment. // This encapsulates both the version of Cloud Composer functionality and the // version of Apache Airflow. It must match the regular expression - // `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. + // `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. // When used as input, the server also checks if the provided version is // supported and denies the request for an unsupported version. // - // The Cloud Composer portion of the version is a - // [semantic version](https://semver.org) or `latest`. When the patch version - // is omitted, the current Cloud Composer patch version is selected. - // When `latest` is provided instead of an explicit version number, - // the server replaces `latest` with the current Cloud Composer version - // and stores that version number in the same field. + // The Cloud Composer portion of the image version is a full + // [semantic version](https://semver.org), or an alias in the form of major + // version number or `latest`. When an alias is provided, the server replaces + // it with the current Cloud Composer version that satisfies the alias. + // + // The Apache Airflow portion of the image version is a full semantic version + // that points to one of the supported Apache Airflow versions, or an alias in + // the form of only major or major.minor versions specified. When an alias is + // provided, the server replaces it with the latest Apache Airflow version + // that satisfies the alias and is supported in the given Cloud Composer + // version. // - // The portion of the image version that follows *airflow-* is an - // official Apache Airflow repository - // [release name](https://github.com/apache/incubator-airflow/releases). + // In all cases, the resolved image version is stored in the same field. // - // See also [Version - // List](/composer/docs/concepts/versioning/composer-versions). + // See also [version + // list](/composer/docs/concepts/versioning/composer-versions) and [versioning + // overview](/composer/docs/concepts/versioning/composer-versioning-overview). string image_version = 1; // Optional. Apache Airflow configuration properties to override. @@ -502,7 +668,20 @@ message SoftwareConfig { // // Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be // updated. + // + // This field is only supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. Environments in newer versions always use + // Python major version 3. string python_version = 6 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The number of schedulers for Airflow. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-2.*.*. + int32 scheduler_count = 7 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The configuration for Cloud Data Lineage integration. + CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(google.api.field_behavior) = OPTIONAL]; } // Configuration for controlling how IPs are allocated in the @@ -510,27 +689,33 @@ message SoftwareConfig { message IPAllocationPolicy { // Optional. Whether or not to enable Alias IPs in the GKE cluster. // If `true`, a VPC-native cluster is created. + // + // This field is only supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. Environments in newer versions always use + // VPC-native GKE clusters. bool use_ip_aliases = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The name of the cluster's secondary range used to allocate // IP addresses to pods. Specify either `cluster_secondary_range_name` // or `cluster_ipv4_cidr_block` but not both. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. string cluster_secondary_range_name = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The name of the services' secondary range used to allocate // IP addresses to the cluster. Specify either `services_secondary_range_name` // or `services_ipv4_cidr_block` but not both. // - // This field is applicable only when `use_ip_aliases` is true. + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. string services_secondary_range_name = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The IP address range used to allocate IP addresses to pods in // the cluster. // - // This field is applicable only when `use_ip_aliases` is true. - // + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. // // Set to blank to have GKE choose a range with the default size. // @@ -538,7 +723,7 @@ message IPAllocationPolicy { // netmask. // // Set to a - // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range // to use. @@ -549,8 +734,8 @@ message IPAllocationPolicy { // Optional. The IP address range of the services IP addresses in this // cluster. // - // This field is applicable only when `use_ip_aliases` is true. - // + // For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, + // this field is applicable only when `use_ip_aliases` is true. // // Set to blank to have GKE choose a range with the default size. // @@ -558,7 +743,7 @@ message IPAllocationPolicy { // netmask. // // Set to a - // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range // to use. @@ -584,6 +769,9 @@ message NodeConfig { // both fields. If only one field (`location` or `nodeConfig.machineType`) is // specified, the location information from the specified field will be // propagated to the unspecified field. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string location = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Compute Engine @@ -607,6 +795,9 @@ message NodeConfig { // // If this field is unspecified, the `machineTypeId` defaults // to "n1-standard-1". + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string machine_type = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Compute Engine network to be used for machine @@ -633,13 +824,19 @@ message NodeConfig { // location. string subnetwork = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The disk size in GB used for node VMs. Minimum size is 20GB. + // Optional. The disk size in GB used for node VMs. Minimum size is 30GB. // If unspecified, defaults to 100GB. Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. int32 disk_size_gb = 5 [(google.api.field_behavior) = OPTIONAL]; // Optional. The set of Google API scopes to be made available on all // node VMs. If `oauth_scopes` is empty, defaults to // ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. repeated string oauth_scopes = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Google Cloud Platform Service Account to be used by the workloads. If a @@ -651,6 +848,9 @@ message NodeConfig { // to identify valid sources or targets for network firewalls. Each tag within // the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). // Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. repeated string tags = 8 [(google.api.field_behavior) = OPTIONAL]; // Optional. The IPAllocationPolicy fields for the GKE cluster. @@ -666,7 +866,18 @@ message NodeConfig { // For more information, see [Optimizing IP address allocation] // (https://cloud.google.com/kubernetes-engine/docs/how-to/flexible-pod-cidr). // Cannot be updated. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. int32 max_pods_per_node = 10 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines + // nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for + // all destination addresses, except between pods traffic. + // + // See: + // https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent + bool enable_ip_masq_agent = 11 [(google.api.field_behavior) = OPTIONAL]; } // Configuration options for the private GKE cluster in a Cloud Composer @@ -688,12 +899,39 @@ message PrivateClusterConfig { string master_ipv4_reserved_range = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Configuration options for networking connections in the Composer 2 +// environment. +message NetworkingConfig { + // Represents connection type between Composer environment in Customer + // Project and the corresponding Tenant project, from a predefined list + // of available connection modes. + enum ConnectionType { + // No specific connection type was requested, so the environment uses + // the default value corresponding to the rest of its configuration. + CONNECTION_TYPE_UNSPECIFIED = 0; + + // Requests the use of VPC peerings for connecting the Customer and Tenant + // projects. + VPC_PEERING = 1; + + // Requests the use of Private Service Connect for connecting the Customer + // and Tenant projects. + PRIVATE_SERVICE_CONNECT = 2; + } + + // Optional. Indicates the user requested specifc connection type between Tenant and + // Customer projects. + // You cannot set networking connection type in public IP environment. + ConnectionType connection_type = 1 [(google.api.field_behavior) = OPTIONAL]; +} + // The configuration information for configuring a Private IP Cloud Composer // environment. message PrivateEnvironmentConfig { // Optional. If `true`, a Private IP Cloud Composer environment is created. // If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be - // set to true . + // set to true for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. bool enable_private_environment = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for the private GKE cluster for a Private IP @@ -703,6 +941,9 @@ message PrivateEnvironmentConfig { // Optional. The CIDR block from which IP range for web server will be reserved. Needs // to be disjoint from private_cluster_config.master_ipv4_cidr_block and // cloud_sql_ipv4_cidr_block. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string web_server_ipv4_cidr_block = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. The CIDR block from which IP range in tenant project will be reserved for @@ -710,6 +951,9 @@ message PrivateEnvironmentConfig { string cloud_sql_ipv4_cidr_block = 4 [(google.api.field_behavior) = OPTIONAL]; // Output only. The IP range reserved for the tenant project's App Engine VMs. + // + // This field is supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string web_server_ipv4_reserved_range = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The CIDR block from which IP range for Cloud Composer Network in tenant @@ -726,6 +970,20 @@ message PrivateEnvironmentConfig { // This field is supported for Cloud Composer environments in versions // composer-2.*.*-airflow-*.*.* and newer. string cloud_composer_network_ipv4_reserved_range = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for + // `IPAllocationPolicy.cluster_ipv4_cidr_block` and + // `IPAllocationPolicy.service_ipv4_cidr_block`. + bool enable_privately_used_public_ips = 6 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. When specified, the environment will use Private Service Connect + // instead of VPC peerings to connect to Cloud SQL in the Tenant Project, + // and the PSC endpoint in the Customer Project will use an IP address from + // this subnetwork. + string cloud_composer_connection_subnetwork = 9 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Configuration for the network connections configuration in the environment. + NetworkingConfig networking_config = 10 [(google.api.field_behavior) = OPTIONAL]; } // The configuration of Cloud SQL instance that is used by the Apache Airflow @@ -734,10 +992,14 @@ message DatabaseConfig { // Optional. Cloud SQL machine type used by Airflow database. // It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 // or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. + // Supported for Cloud Composer environments in versions + // composer-1.*.*-airflow-*.*.*. string machine_type = 1 [(google.api.field_behavior) = OPTIONAL]; } // The configuration settings for the Airflow web server App Engine instance. +// Supported for Cloud Composer environments in versions +// composer-1.*.*-airflow-*.*.*. message WebServerConfig { // Optional. Machine type on which Airflow web server is running. // It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or @@ -749,7 +1011,8 @@ message WebServerConfig { } // The encryption options for the Cloud Composer environment and its -// dependencies. +// dependencies. Supported for Cloud Composer environments in versions +// composer-1.*.*-airflow-*.*.*. message EncryptionConfig { // Optional. Customer-managed Encryption Key available through Google's Key Management // Service. Cannot be updated. @@ -835,6 +1098,18 @@ message WorkloadsConfig { int32 max_count = 5 [(google.api.field_behavior) = OPTIONAL]; } + // Configuration for resources used by Airflow triggerers. + message TriggererResource { + // Optional. The number of triggerers. + int32 count = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. CPU request and limit for a single Airflow triggerer replica. + float cpu = 2 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Memory (GB) request and limit for a single Airflow triggerer replica. + float memory_gb = 3 [(google.api.field_behavior) = OPTIONAL]; + } + // Optional. Resources used by Airflow schedulers. SchedulerResource scheduler = 1 [(google.api.field_behavior) = OPTIONAL]; @@ -843,6 +1118,60 @@ message WorkloadsConfig { // Optional. Resources used by Airflow workers. WorkerResource worker = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Resources used by Airflow triggerers. + TriggererResource triggerer = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// The Recovery settings of an environment. +message RecoveryConfig { + // Optional. The configuration for scheduled snapshot creation mechanism. + ScheduledSnapshotsConfig scheduled_snapshots_config = 1 [(google.api.field_behavior) = OPTIONAL]; +} + +// The configuration for scheduled snapshot creation mechanism. +message ScheduledSnapshotsConfig { + // Optional. Whether scheduled snapshots creation is enabled. + bool enabled = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The Cloud Storage location for storing automatically created snapshots. + string snapshot_location = 6 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The cron expression representing the time when snapshots creation mechanism + // runs. This field is subject to additional validation around frequency of + // execution. + string snapshot_creation_schedule = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Time zone that sets the context to interpret snapshot_creation_schedule. + string time_zone = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Configuration options for the master authorized networks feature. Enabled +// master authorized networks will disallow all external traffic to access +// Kubernetes master through HTTPS except traffic from the given CIDR blocks, +// Google Compute Engine Public IPs and Google Prod IPs. +message MasterAuthorizedNetworksConfig { + // CIDR block with an optional name. + message CidrBlock { + // User-defined name that identifies the CIDR block. + string display_name = 1; + + // CIDR block that must be specified in CIDR notation. + string cidr_block = 2; + } + + // Whether or not master authorized networks feature is enabled. + bool enabled = 1; + + // Up to 50 external networks that could access Kubernetes master through + // HTTPS. + repeated CidrBlock cidr_blocks = 2; +} + +// Configuration for Cloud Data Lineage integration. +message CloudDataLineageIntegration { + // Optional. Whether or not Cloud Data Lineage integration is enabled. + bool enabled = 1 [(google.api.field_behavior) = OPTIONAL]; } // An environment for running orchestration tasks. @@ -918,23 +1247,27 @@ message CheckUpgradeRequest { // The version of the software running in the environment. // This encapsulates both the version of Cloud Composer functionality and the // version of Apache Airflow. It must match the regular expression - // `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. + // `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. // When used as input, the server also checks if the provided version is // supported and denies the request for an unsupported version. // - // The Cloud Composer portion of the version is a - // [semantic version](https://semver.org) or `latest`. When the patch version - // is omitted, the current Cloud Composer patch version is selected. - // When `latest` is provided instead of an explicit version number, - // the server replaces `latest` with the current Cloud Composer version - // and stores that version number in the same field. + // The Cloud Composer portion of the image version is a full + // [semantic version](https://semver.org), or an alias in the form of major + // version number or `latest`. When an alias is provided, the server replaces + // it with the current Cloud Composer version that satisfies the alias. + // + // The Apache Airflow portion of the image version is a full semantic version + // that points to one of the supported Apache Airflow versions, or an alias in + // the form of only major or major.minor versions specified. When an alias is + // provided, the server replaces it with the latest Apache Airflow version + // that satisfies the alias and is supported in the given Cloud Composer + // version. // - // The portion of the image version that follows `airflow-` is an - // official Apache Airflow repository - // [release name](https://github.com/apache/incubator-airflow/releases). + // In all cases, the resolved image version is stored in the same field. // - // See also [Version List] - // (/composer/docs/concepts/versioning/composer-versions). + // See also [version + // list](/composer/docs/concepts/versioning/composer-versions) and [versioning + // overview](/composer/docs/concepts/versioning/composer-versioning-overview). string image_version = 2; } diff --git a/google/cloud/orchestration/airflow/service/v1beta1/image_versions.proto b/google/cloud/orchestration/airflow/service/v1beta1/image_versions.proto index 6a7d5f4c6..08bc9f0f5 100644 --- a/google/cloud/orchestration/airflow/service/v1beta1/image_versions.proto +++ b/google/cloud/orchestration/airflow/service/v1beta1/image_versions.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. @@ -66,7 +66,7 @@ message ListImageVersionsResponse { // Image Version information message ImageVersion { // The string identifier of the ImageVersion, in the form: - // "composer-x.y.z-airflow-a.b(.c)" + // "composer-x.y.z-airflow-a.b.c" string image_version_id = 1; // Whether this is the default ImageVersion used by Composer during diff --git a/google/cloud/orchestration/airflow/service/v1beta1/operations.proto b/google/cloud/orchestration/airflow/service/v1beta1/operations.proto index 5e5991f0c..5ba18a522 100644 --- a/google/cloud/orchestration/airflow/service/v1beta1/operations.proto +++ b/google/cloud/orchestration/airflow/service/v1beta1/operations.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. @@ -59,6 +59,12 @@ message OperationMetadata { // A resource check operation. CHECK = 4; + + // Saves snapshot of the resource operation. + SAVE_SNAPSHOT = 5; + + // Loads snapshot of the resource operation. + LOAD_SNAPSHOT = 6; } // Output only. The current operation state. diff --git a/google/cloud/orgpolicy/v2/BUILD.bazel b/google/cloud/orgpolicy/v2/BUILD.bazel index d1ddcc09f..78629b818 100644 --- a/google/cloud/orgpolicy/v2/BUILD.bazel +++ b/google/cloud/orgpolicy/v2/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( name = "orgpolicy_java_gapic", srcs = [":orgpolicy_proto_with_info"], grpc_service_config = "orgpolicy_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":orgpolicy_java_grpc", ], @@ -128,6 +129,7 @@ go_gapic_library( srcs = [":orgpolicy_proto_with_info"], grpc_service_config = "orgpolicy_grpc_service_config.json", importpath = "cloud.google.com/go/orgpolicy/apiv2;orgpolicy", + rest_numeric_enums = True, service_yaml = "orgpolicy_v2.yaml", transport = "grpc+rest", deps = [ @@ -166,6 +168,10 @@ py_gapic_library( name = "orgpolicy_py_gapic", srcs = [":orgpolicy_proto"], grpc_service_config = "orgpolicy_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-org-policy", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -213,6 +219,8 @@ php_gapic_library( name = "orgpolicy_php_gapic", srcs = [":orgpolicy_proto_with_info"], grpc_service_config = "orgpolicy_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":orgpolicy_php_grpc", ":orgpolicy_php_proto", @@ -245,7 +253,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "orgpolicy_grpc_service_config.json", package = "google.cloud.orgpolicy.v2", + rest_numeric_enums = True, service_yaml = "orgpolicy_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -290,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=orgpolicy", ], grpc_service_config = "orgpolicy_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud Resource hierarchy.", ruby_cloud_title = "Organization Policy V2", deps = [ @@ -335,6 +346,7 @@ csharp_gapic_library( srcs = [":orgpolicy_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "orgpolicy_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "orgpolicy_v2.yaml", deps = [ ":orgpolicy_csharp_grpc", diff --git a/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel b/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel index 787f368c3..44ff89439 100644 --- a/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel +++ b/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel @@ -74,6 +74,7 @@ java_gapic_library( srcs = [":agentendpoint_proto_with_info"], gapic_yaml = "osconfig_gapic.yaml", grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", test_deps = [ ":agentendpoint_java_grpc", @@ -135,6 +136,7 @@ go_gapic_library( grpc_service_config = "agentendpoint_grpc_service_config.json", importpath = "cloud.google.com/go/osconfig/agentendpoint/apiv1;agentendpoint", metadata = True, + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", transport = "grpc+rest", deps = [ @@ -174,6 +176,7 @@ py_gapic_library( name = "agentendpoint_py_gapic", srcs = [":agentendpoint_proto"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( name = "agentendpoint_php_gapic", srcs = [":agentendpoint_proto_with_info"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", + transport = "grpc+rest", deps = [ ":agentendpoint_php_grpc", ":agentendpoint_php_proto", @@ -254,7 +259,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "agentendpoint_grpc_service_config.json", package = "google.cloud.osconfig.agentendpoint.v1", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( srcs = [":agentendpoint_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-agentendpoint-v1"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":agentendpoint_ruby_grpc", ":agentendpoint_ruby_proto", @@ -336,6 +344,7 @@ csharp_gapic_library( srcs = [":agentendpoint_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", deps = [ ":agentendpoint_csharp_grpc", diff --git a/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel b/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel index 1952950d7..a86e5d705 100644 --- a/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel +++ b/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( srcs = [":agentendpoint_proto_with_info"], gapic_yaml = "osconfig_gapic.yaml", grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", test_deps = [ ":agentendpoint_java_grpc", @@ -129,6 +130,7 @@ go_gapic_library( grpc_service_config = "agentendpoint_grpc_service_config.json", importpath = "cloud.google.com/go/osconfig/agentendpoint/apiv1beta;agentendpoint", metadata = True, + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( name = "agentendpoint_py_gapic", srcs = [":agentendpoint_proto"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -215,7 +218,9 @@ php_gapic_library( name = "agentendpoint_php_gapic", srcs = [":agentendpoint_proto_with_info"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", + transport = "grpc+rest", deps = [ ":agentendpoint_php_grpc", ":agentendpoint_php_proto", @@ -248,7 +253,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "agentendpoint_grpc_service_config.json", package = "google.cloud.osconfig.agentendpoint.v1beta", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -287,6 +294,7 @@ ruby_cloud_gapic_library( srcs = [":agentendpoint_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-agentendpoint-v1beta"], grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":agentendpoint_ruby_grpc", ":agentendpoint_ruby_proto", @@ -330,6 +338,7 @@ csharp_gapic_library( srcs = [":agentendpoint_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "agentendpoint_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", deps = [ ":agentendpoint_csharp_grpc", diff --git a/google/cloud/osconfig/logging/BUILD.bazel b/google/cloud/osconfig/logging/BUILD.bazel new file mode 100644 index 000000000..e9b8a2e0d --- /dev/null +++ b/google/cloud/osconfig/logging/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 = [ + "patch_job_log.proto", + ], + deps = [ + "@com_google_protobuf//:timestamp_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 = "google.golang.org/genproto/googleapis/cloud/osconfig/logging", + protos = [":logging_proto"], + deps = [ + + ], +) + +############################################################################## +# 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 = [ + "@com_google_protobuf//:timestamp_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/google/cloud/osconfig/logging/patch_job_log.proto b/google/cloud/osconfig/logging/patch_job_log.proto new file mode 100644 index 000000000..c4b23c475 --- /dev/null +++ b/google/cloud/osconfig/logging/patch_job_log.proto @@ -0,0 +1,126 @@ +// 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.osconfig.logging; + +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/osconfig/logging;logging"; +option java_multiple_files = true; +option java_outer_classname = "PatchJobLogProto"; +option java_package = "com.google.cloud.osconfig.logging"; + +message PatchJobCompletedLog { + // Enumeration of the various states a patch job passes through as it + // executes. + enum State { + // State must be specified. + STATE_UNSPECIFIED = 0; + + // The patch job was successfully initiated. + STARTED = 1; + + // The patch job is looking up instances to run the patch on. + INSTANCE_LOOKUP = 2; + + // Instances are being patched. + PATCHING = 3; + + // Patch job completed successfully. + SUCCEEDED = 4; + + // Patch job completed but there were errors. + COMPLETED_WITH_ERRORS = 5; + + // The patch job was canceled. + CANCELED = 6; + + // The patch job has timed out. + TIMED_OUT = 7; + } + + // A summary of the current patch state across all instances this patch job + // affects. Contains counts of instances in different states. These states map + // to InstancePatchState. List patch job instance details to see the specific + // states of each instance. + message InstanceDetailsSummary { + // Number of instances pending patch job. + int64 instances_pending = 1; + + // Number of instances that are inactive. + int64 instances_inactive = 2; + + // Number of instances notified about patch job. + int64 instances_notified = 3; + + // Number of instances that have started. + int64 instances_started = 4; + + // Number of instances that are downloading patches. + int64 instances_downloading_patches = 5; + + // Number of instances that are applying patches. + int64 instances_applying_patches = 6; + + // Number of instances rebooting. + int64 instances_rebooting = 7; + + // Number of instances that have completed successfully. + int64 instances_succeeded = 8; + + // Number of instances that require reboot. + int64 instances_succeeded_reboot_required = 9; + + // Number of instances that failed. + int64 instances_failed = 10; + + // Number of instances that have acked and will start shortly. + int64 instances_acked = 11; + + // Number of instances that exceeded the time out while applying the patch. + int64 instances_timed_out = 12; + + // Number of instances that are running the pre-patch step. + int64 instances_running_pre_patch_step = 13; + + // Number of instances that are running the post-patch step. + int64 instances_running_post_patch_step = 14; + } + + // The patch job name. For example: + // projects/PROJECT_ID/patchJobs/PATCH_JOB_ID + string patch_job = 1; + + // The current state of the PatchJob. + State state = 2; + + // Summary of instance details. + InstanceDetailsSummary instance_details_summary = 3; + + // If this patch job is a dry run, the agent will report that it has + // finished without running any updates on the VM. + bool dry_run = 4; + + // If this patch job failed, this message will provide information about the + // failure. + string error_message = 5; + + // Time this PatchJob was created. + google.protobuf.Timestamp create_time = 6; + + // Last time this PatchJob was updated. + google.protobuf.Timestamp update_time = 7; +} diff --git a/google/cloud/osconfig/v1/BUILD.bazel b/google/cloud/osconfig/v1/BUILD.bazel index 0db392598..5e3f2a129 100644 --- a/google/cloud/osconfig/v1/BUILD.bazel +++ b/google/cloud/osconfig/v1/BUILD.bazel @@ -85,6 +85,7 @@ java_gapic_library( srcs = [":osconfig_proto_with_info"], gapic_yaml = None, grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", test_deps = [ ":osconfig_java_grpc", @@ -152,13 +153,14 @@ go_gapic_library( grpc_service_config = "osconfig_grpc_service_config.json", importpath = "cloud.google.com/go/osconfig/apiv1;osconfig", metadata = True, + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", transport = "grpc+rest", deps = [ ":osconfig_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -197,6 +199,7 @@ py_gapic_library( srcs = [":osconfig_proto"], grpc_service_config = "osconfig_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-os-config"], + rest_numeric_enums = True, transport = "grpc", ) @@ -249,7 +252,9 @@ php_gapic_library( name = "osconfig_php_gapic", srcs = [":osconfig_proto_with_info"], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", + transport = "grpc+rest", deps = [ ":osconfig_php_grpc", ":osconfig_php_proto", @@ -283,7 +288,9 @@ nodejs_gapic_library( grpc_service_config = "osconfig_grpc_service_config.json", main_service = "OsConfigServiceClient", package = "google.cloud.osconfig.v1", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -328,6 +335,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/compute/docs/manage-os", ], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud OS Config provides OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", ruby_cloud_title = "Cloud OS Config V1", deps = [ @@ -373,6 +381,7 @@ csharp_gapic_library( srcs = [":osconfig_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1.yaml", deps = [ ":osconfig_csharp_grpc", diff --git a/google/cloud/osconfig/v1alpha/BUILD.bazel b/google/cloud/osconfig/v1alpha/BUILD.bazel index 0a74ba0b7..e4896427e 100644 --- a/google/cloud/osconfig/v1alpha/BUILD.bazel +++ b/google/cloud/osconfig/v1alpha/BUILD.bazel @@ -80,6 +80,7 @@ java_gapic_library( srcs = [":osconfig_proto_with_info"], gapic_yaml = None, grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1alpha.yaml", test_deps = [ ":osconfig_java_grpc", @@ -142,13 +143,14 @@ go_gapic_library( grpc_service_config = "osconfig_grpc_service_config.json", importpath = "cloud.google.com/go/osconfig/apiv1alpha;osconfig", metadata = True, + rest_numeric_enums = True, service_yaml = "osconfig_v1alpha.yaml", transport = "grpc+rest", deps = [ ":osconfig_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -186,6 +188,7 @@ py_gapic_library( srcs = [":osconfig_proto"], grpc_service_config = "osconfig_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-os-config"], + rest_numeric_enums = True, transport = "grpc", ) @@ -233,7 +236,9 @@ php_gapic_library( name = "osconfig_php_gapic", srcs = [":osconfig_proto_with_info"], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":osconfig_php_grpc", ":osconfig_php_proto", @@ -266,7 +271,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "osconfig_grpc_service_config.json", package = "google.cloud.osconfig.v1alpha", + rest_numeric_enums = True, service_yaml = "osconfig_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -311,6 +318,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/compute/docs/manage-os", ], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud OS Config provides OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", ruby_cloud_title = "Cloud OS Config V1alpha", deps = [ @@ -356,6 +364,7 @@ csharp_gapic_library( srcs = [":osconfig_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1alpha.yaml", deps = [ ":osconfig_csharp_grpc", diff --git a/google/cloud/osconfig/v1beta/BUILD.bazel b/google/cloud/osconfig/v1beta/BUILD.bazel index 50d254fa0..b11b49e09 100644 --- a/google/cloud/osconfig/v1beta/BUILD.bazel +++ b/google/cloud/osconfig/v1beta/BUILD.bazel @@ -78,6 +78,7 @@ java_gapic_library( srcs = [":osconfig_proto_with_info"], gapic_yaml = "osconfig_gapic.yaml", grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", test_deps = [ ":osconfig_java_grpc", @@ -141,6 +142,7 @@ go_gapic_library( grpc_service_config = "osconfig_grpc_service_config.json", importpath = "cloud.google.com/go/osconfig/apiv1beta;osconfig", metadata = True, + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -182,6 +184,7 @@ py_gapic_library( srcs = [":osconfig_proto"], grpc_service_config = "osconfig_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-os-config"], + rest_numeric_enums = True, transport = "grpc", ) @@ -229,7 +232,9 @@ php_gapic_library( name = "osconfig_php_gapic", srcs = [":osconfig_proto_with_info"], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", + transport = "grpc+rest", deps = [ ":osconfig_php_grpc", ":osconfig_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "osconfig_grpc_service_config.json", package = "google.cloud.osconfig.v1beta", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( srcs = [":osconfig_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-osconfig-v1beta"], grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":osconfig_ruby_grpc", ":osconfig_ruby_proto", @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":osconfig_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "osconfig_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "osconfig_v1beta.yaml", deps = [ ":osconfig_csharp_grpc", diff --git a/google/cloud/oslogin/common/BUILD.bazel b/google/cloud/oslogin/common/BUILD.bazel index 07a7dd4a0..b04530507 100644 --- a/google/cloud/oslogin/common/BUILD.bazel +++ b/google/cloud/oslogin/common/BUILD.bazel @@ -77,6 +77,7 @@ load( py_gapic_library( name = "common_py_gapic", srcs = [":common_proto"], + rest_numeric_enums = False, transport = "grpc", ) @@ -160,6 +161,7 @@ csharp_gapic_library( name = "common_csharp_gapic", srcs = [":common_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + rest_numeric_enums = False, deps = [ ":common_csharp_grpc", ":common_csharp_proto", diff --git a/google/cloud/oslogin/common/common.proto b/google/cloud/oslogin/common/common.proto index 4d9755f0d..6eeaf8908 100644 --- a/google/cloud/oslogin/common/common.proto +++ b/google/cloud/oslogin/common/common.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -26,8 +25,6 @@ option java_outer_classname = "OsLoginProto"; option java_package = "com.google.cloud.oslogin.common"; option php_namespace = "Google\\Cloud\\OsLogin\\Common"; option ruby_package = "Google::Cloud::OsLogin::Common"; - -// Define a "User" resource owned by OS Login. option (google.api.resource_definition) = { type: "oslogin.googleapis.com/User" pattern: "users/{user}" diff --git a/google/cloud/oslogin/v1/BUILD.bazel b/google/cloud/oslogin/v1/BUILD.bazel index abe5df3fc..0d55aaeef 100644 --- a/google/cloud/oslogin/v1/BUILD.bazel +++ b/google/cloud/oslogin/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "oslogin_java_gapic", srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":oslogin_java_grpc", ] + _JAVA_GRPC_SUBPACKAGE_DEPS, @@ -128,6 +129,7 @@ go_gapic_library( srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", importpath = "cloud.google.com/go/oslogin/apiv1;oslogin", + rest_numeric_enums = True, service_yaml = "oslogin_v1.yaml", transport = "grpc+rest", deps = [ @@ -169,6 +171,10 @@ py_gapic_library( ":oslogin_proto", ], grpc_service_config = "oslogin_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-os-login", + ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/cloud/oslogin/common:common_py_proto", @@ -228,6 +234,8 @@ php_gapic_library( name = "oslogin_php_gapic", srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":oslogin_php_grpc", ":oslogin_php_proto", @@ -260,7 +268,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "oslogin_grpc_service_config.json", package = "google.cloud.oslogin.v1", + rest_numeric_enums = True, service_yaml = "oslogin_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -310,6 +320,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=oslogin", ], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Use OS Login to manage SSH access to your instances using IAM without having to create and manage individual SSH keys. OS Login maintains a consistent Linux user identity across VM instances and is the recommended way to manage many users across multiple instances or projects.", ruby_cloud_title = "Cloud OS Login V1", deps = [ @@ -360,6 +371,7 @@ csharp_gapic_library( srcs = [":oslogin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "oslogin_v1.yaml", deps = [ ":oslogin_csharp_grpc", diff --git a/google/cloud/oslogin/v1/oslogin.proto b/google/cloud/oslogin/v1/oslogin.proto index 25e9be0a0..fb3575600 100644 --- a/google/cloud/oslogin/v1/oslogin.proto +++ b/google/cloud/oslogin/v1/oslogin.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -41,7 +40,18 @@ service OsLoginService { option (google.api.default_host) = "oslogin.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform," - "https://www.googleapis.com/auth/compute"; + "https://www.googleapis.com/auth/cloud-platform.read-only," + "https://www.googleapis.com/auth/compute," + "https://www.googleapis.com/auth/compute.readonly"; + + // Create an SSH public key + rpc CreateSshPublicKey(CreateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) { + option (google.api.http) = { + post: "/v1/{parent=users/*}/sshPublicKeys" + body: "ssh_public_key" + }; + option (google.api.method_signature) = "parent,ssh_public_key"; + } // Deletes a POSIX account. rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) { @@ -113,6 +123,20 @@ message LoginProfile { map ssh_public_keys = 3; } +// A request message for creating an SSH public key. +message CreateSshPublicKeyRequest { + // Required. The unique ID for the user in format `users/{user}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "oslogin.googleapis.com/SshPublicKey" + } + ]; + + // Required. The SSH public key and expiration time. + google.cloud.oslogin.common.SshPublicKey ssh_public_key = 2 [(google.api.field_behavior) = REQUIRED]; +} + // A request message for deleting a POSIX account entry. message DeletePosixAccountRequest { // Required. A reference to the POSIX account to update. POSIX accounts are identified @@ -190,6 +214,9 @@ message ImportSshPublicKeyRequest { message ImportSshPublicKeyResponse { // The login profile information for the user. LoginProfile login_profile = 1; + + // Detailed information about import results. + string details = 2; } // A request message for updating an SSH public key. diff --git a/google/cloud/oslogin/v1/oslogin_v1.yaml b/google/cloud/oslogin/v1/oslogin_v1.yaml index 8d345ed2b..3c150c0fe 100644 --- a/google/cloud/oslogin/v1/oslogin_v1.yaml +++ b/google/cloud/oslogin/v1/oslogin_v1.yaml @@ -21,3 +21,10 @@ authentication: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/compute + - selector: google.cloud.oslogin.v1.OsLoginService.GetLoginProfile + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform, + https://www.googleapis.com/auth/cloud-platform.read-only, + https://www.googleapis.com/auth/compute, + https://www.googleapis.com/auth/compute.readonly diff --git a/google/cloud/oslogin/v1beta/BUILD.bazel b/google/cloud/oslogin/v1beta/BUILD.bazel index 35114f451..a534f97a4 100644 --- a/google/cloud/oslogin/v1beta/BUILD.bazel +++ b/google/cloud/oslogin/v1beta/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( name = "oslogin_java_gapic", srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [":oslogin_java_grpc"], transport = "grpc+rest", deps = [ @@ -125,6 +126,7 @@ go_gapic_library( srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", importpath = "cloud.google.com/go/oslogin/apiv1beta;oslogin", + rest_numeric_enums = True, service_yaml = "oslogin_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -166,6 +168,7 @@ py_gapic_library( ":oslogin_proto", ], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -219,6 +222,8 @@ php_gapic_library( name = "oslogin_php_gapic", srcs = [":oslogin_proto_with_info"], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":oslogin_php_grpc", ":oslogin_php_proto", @@ -251,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "oslogin_grpc_service_config.json", package = "google.cloud.oslogin.v1beta", + rest_numeric_enums = True, service_yaml = "oslogin_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=oslogin", ], grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Use OS Login to manage SSH access to your instances using IAM without having to create and manage individual SSH keys. OS Login maintains a consistent Linux user identity across VM instances and is the recommended way to manage many users across multiple instances or projects.", ruby_cloud_title = "Cloud OS Login V1beta", deps = [ @@ -351,6 +359,7 @@ csharp_gapic_library( srcs = [":oslogin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "oslogin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "oslogin_v1beta.yaml", deps = [ ":oslogin_csharp_grpc", diff --git a/google/cloud/oslogin/v1beta/oslogin.proto b/google/cloud/oslogin/v1beta/oslogin.proto index a5d784746..9a7a06b4a 100644 --- a/google/cloud/oslogin/v1beta/oslogin.proto +++ b/google/cloud/oslogin/v1beta/oslogin.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -45,6 +44,15 @@ service OsLoginService { "https://www.googleapis.com/auth/compute," "https://www.googleapis.com/auth/compute.readonly"; + // Create an SSH public key + rpc CreateSshPublicKey(CreateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) { + option (google.api.http) = { + post: "/v1beta/{parent=users/*}/sshPublicKeys" + body: "ssh_public_key" + }; + option (google.api.method_signature) = "parent,ssh_public_key"; + } + // Deletes a POSIX account. rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) { option (google.api.http) = { @@ -113,6 +121,23 @@ message LoginProfile { // A map from SSH public key fingerprint to the associated key object. map ssh_public_keys = 3; + + // The registered security key credentials for a user. + repeated SecurityKey security_keys = 5; +} + +// A request message for creating an SSH public key. +message CreateSshPublicKeyRequest { + // Required. The unique ID for the user in format `users/{user}`. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "oslogin.googleapis.com/SshPublicKey" + } + ]; + + // Required. The SSH public key and expiration time. + google.cloud.oslogin.common.SshPublicKey ssh_public_key = 2 [(google.api.field_behavior) = REQUIRED]; } // A request message for deleting a POSIX account entry. @@ -146,13 +171,19 @@ message GetLoginProfileRequest { // Required. The unique ID for the user in format `users/{user}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference).type = "oslogin.googleapis.com/User"]; + (google.api.resource_reference) = { + type: "oslogin.googleapis.com/User" + } + ]; // The project ID of the Google Cloud Platform project. string project_id = 2; // A system ID for filtering the results of the request. string system_id = 3; + + // The view configures whether to retrieve security keys information. + LoginProfileView view = 4; } // A request message for retrieving an SSH public key. @@ -180,12 +211,18 @@ message ImportSshPublicKeyRequest { // The project ID of the Google Cloud Platform project. string project_id = 3; + + // The view configures whether to retrieve security keys information. + LoginProfileView view = 4; } // A response message for importing an SSH public key. message ImportSshPublicKeyResponse { // The login profile information for the user. LoginProfile login_profile = 1; + + // Detailed information about import results. + string details = 2; } // A request message for updating an SSH public key. @@ -206,3 +243,46 @@ message UpdateSshPublicKeyRequest { // Mask to control which fields get updated. Updates all if not present. google.protobuf.FieldMask update_mask = 3; } + +// The credential information for a Google registered security key. +message SecurityKey { + // Public key text in SSH format, defined by + // [RFC4253]("https://www.ietf.org/rfc/rfc4253.txt") section 6.6. + string public_key = 1; + + // Hardware-backed private key text in SSH format. + string private_key = 2; + + // The FIDO protocol type used to register this credential. + oneof protocol_type { + // The U2F protocol type. + UniversalTwoFactor universal_two_factor = 3; + + // The Web Authentication protocol type. + WebAuthn web_authn = 4; + } +} + +// Security key information specific to the U2F protocol. +message UniversalTwoFactor { + // Application ID for the U2F protocol. + string app_id = 1; +} + +// Security key information specific to the Web Authentication protocol. +message WebAuthn { + // Relying party ID for Web Authentication. + string rp_id = 1; +} + +// The login profile view limits the user content retrieved. +enum LoginProfileView { + // The default login profile view. The API defaults to the BASIC view. + LOGIN_PROFILE_VIEW_UNSPECIFIED = 0; + + // Includes POSIX and SSH key information. + BASIC = 1; + + // Include security key information for the user. + SECURITY_KEY = 2; +} diff --git a/google/cloud/oslogin/v1beta/oslogin_v1beta.yaml b/google/cloud/oslogin/v1beta/oslogin_v1beta.yaml index eea7d547a..5ec5c3606 100644 --- a/google/cloud/oslogin/v1beta/oslogin_v1beta.yaml +++ b/google/cloud/oslogin/v1beta/oslogin_v1beta.yaml @@ -21,3 +21,10 @@ authentication: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/compute + - selector: google.cloud.oslogin.v1beta.OsLoginService.GetLoginProfile + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform, + https://www.googleapis.com/auth/cloud-platform.read-only, + https://www.googleapis.com/auth/compute, + https://www.googleapis.com/auth/compute.readonly diff --git a/google/cloud/paymentgateway/issuerswitch/v1/BUILD.bazel b/google/cloud/paymentgateway/issuerswitch/v1/BUILD.bazel index a2f6cd29d..a89a18860 100644 --- a/google/cloud/paymentgateway/issuerswitch/v1/BUILD.bazel +++ b/google/cloud/paymentgateway/issuerswitch/v1/BUILD.bazel @@ -22,6 +22,7 @@ proto_library( name = "issuerswitch_proto", srcs = [ "common_fields.proto", + "logs.proto", "resolutions.proto", "rules.proto", "transactions.proto", @@ -31,6 +32,7 @@ proto_library( "//google/api:client_proto", "//google/api:field_behavior_proto", "//google/api:resource_proto", + "//google/logging/type:type_proto", "//google/longrunning:operations_proto", "//google/type:date_proto", "//google/type:money_proto", @@ -75,6 +77,7 @@ java_gapic_library( srcs = [":issuerswitch_proto_with_info"], gapic_yaml = None, grpc_service_config = "issuerswitch_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", test_deps = [ ":issuerswitch_java_grpc", @@ -130,6 +133,7 @@ go_proto_library( protos = [":issuerswitch_proto"], deps = [ "//google/api:annotations_go_proto", + "//google/logging/type:type_go_proto", "//google/longrunning:longrunning_go_proto", "//google/type:date_go_proto", "//google/type:money_go_proto", @@ -142,13 +146,14 @@ go_gapic_library( grpc_service_config = "issuerswitch_grpc_service_config.json", importpath = "cloud.google.com/go/paymentgateway/issuerswitch/apiv1;issuerswitch", metadata = True, + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":issuerswitch_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -185,12 +190,15 @@ py_gapic_library( srcs = [":issuerswitch_proto"], grpc_service_config = "issuerswitch_grpc_service_config.json", opt_args = [ - "warehouse-package-name=google-cloud-payment-gateway-issuer-switch", - "python-gapic-namespace=google.cloud", "python-gapic-name=payment_gateway_issuer_switch", + "python-gapic-namespace=google.cloud", + "warehouse-package-name=google-cloud-payment-gateway-issuer-switch", ], + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -237,7 +245,9 @@ php_gapic_library( name = "issuerswitch_php_gapic", srcs = [":issuerswitch_proto_with_info"], grpc_service_config = "issuerswitch_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", + transport = "grpc+rest", deps = [ ":issuerswitch_php_grpc", ":issuerswitch_php_proto", @@ -270,7 +280,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "issuerswitch_grpc_service_config.json", package = "google.cloud.paymentgateway.issuerswitch.v1", + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", + transport = "grpc", deps = [], ) @@ -309,6 +321,7 @@ ruby_cloud_gapic_library( srcs = [":issuerswitch_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-paymentgateway-issuerswitch-v1"], grpc_service_config = "issuerswitch_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", deps = [ ":issuerswitch_ruby_grpc", @@ -353,6 +366,7 @@ csharp_gapic_library( srcs = [":issuerswitch_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "issuerswitch_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "issuerswitch_v1.yaml", deps = [ ":issuerswitch_csharp_grpc", diff --git a/google/cloud/paymentgateway/issuerswitch/v1/common_fields.proto b/google/cloud/paymentgateway/issuerswitch/v1/common_fields.proto index d07981c33..ac5841a1d 100644 --- a/google/cloud/paymentgateway/issuerswitch/v1/common_fields.proto +++ b/google/cloud/paymentgateway/issuerswitch/v1/common_fields.proto @@ -26,148 +26,6 @@ option java_package = "com.google.cloud.paymentgateway.issuerswitch.v1"; option php_namespace = "Google\\Cloud\\PaymentGateway\\IssuerSwitch\\V1"; option ruby_package = "Google::Cloud::PaymentGateway::IssuerSwitch::V1"; -// The API type for a transaction. Every transaction processed by the issuer -// switch will be one of these API types. -enum ApiType { - // Unspecified API type. - API_TYPE_UNSPECIFIED = 0; - - // Balance API. Maps to UPI's `BalEnq` API. This is a metadata - // transaction API. - BALANCE = 1; - - // Check transaction status API. Maps to UPI's `ChkTxn` API. This is a - // metadata transaction API. - CHECK_STATUS = 2; - - // Complain API. Maps to UPI's `Complaint` API. This is a metadata transaction - // API. - COMPLAINT = 3; - - // Heart beat API. Maps to UPI's `Hbt` API. This is a metadata transaction - // API. - HEART_BEAT = 4; - - // Initiate registration API. Maps to UPI's `Otp` API. This is a metadata - // transaction API. - INITIATE_REGISTRATION = 5; - - // List accounts API. Maps to UPI's `ListAccount` API. This is a metadata - // transaction API. - LIST_ACCOUNTS = 6; - - // Mandate API. Maps to UPI's `Mandate` API. This is a metadata transaction - // API. - MANDATE = 7; - - // Payment settlement API. Maps to UPI's `Pay` API. This is a financial - // transaction API. - SETTLE_PAYMENT = 8; - - // Update credentials API. Maps to UPI's `SetCre` API. This is a metadata - // transaction API. - UPDATE_CREDENTIALS = 9; - - // Validate registration API. Maps to UPI's `RegMob` API. This is a metadata - // transaction API. - VALIDATE_REGISTRATION = 10; - - // Voucher confirmation API. Maps to UPI's `VoucherConfirmation` API. - VOUCHER_CONFIRMATION = 11; -} - -// The type of a transaction. Every transaction processed by the issuer switch -// will be one of these transaction types. Transaction types are associated with -// a particular API type. This associated is documented with each value. -enum TransactionType { - // Unspecified transaction type. - TRANSACTION_TYPE_UNSPECIFIED = 0; - - // Autoupdate transaction type. This is associated with the `CHECK_STATUS` - // API type. Maps to UPI's `AUTOUPDATE` type. - TRANSACTION_TYPE_AUTOUPDATE = 1; - - // Balance check transaction type. This is associated with the - // `BALANCE_ENQUIRY` API type. Maps to UPI's `BalChk` type. - TRANSACTION_TYPE_BALANCE_CHECK = 3; - - // Balance enquiry transaction type. This is associated with the - // `BALANCE_ENQUIRY` API type. Maps to UPI's `BalEnq` type. - TRANSACTION_TYPE_BALANCE_ENQUIRY = 4; - - // Check status transaction type. This is associated with the `COMPLAINT` API - // type. Maps to UPI's `CHECKSTATUS` type. - TRANSACTION_TYPE_CHECK_STATUS = 5; - - // Check transaction type. This is associated with the `CHECK_STATUS` API - // type. Maps to UPI's `ChkTxn` type. - TRANSACTION_TYPE_CHECK_TRANSACTION = 6; - - // Complaint transaction type. This is associated with the `COMPLAINT` API - // type. Maps to UPI's `COMPLAINT` type. - TRANSACTION_TYPE_COMPLAINT = 7; - - // Create transaction type. This is associated with the `MANDATE` API type. - // Maps to UPI's `CREATE` type. - TRANSACTION_TYPE_CREATE = 8; - - // Credit transaction type. This is associated with the `SETTLE_PAYMENT` API - // type. Maps to UPI's `CREDIT` type. - TRANSACTION_TYPE_CREDIT = 9; - - // Debit transaction type. This is associated with the `SETTLE_PAYMENT` API - // type. Maps to UPI's `DEBIT` type. - TRANSACTION_TYPE_DEBIT = 10; - - // Dispute transaction type. This is associated with the `COMPLAINT` API - // type. Maps to UPI's `DISPUTE` type. - TRANSACTION_TYPE_DISPUTE = 11; - - // Heart beat transaction type. This is associated with `HEART_BEAT` API type. - // Maps to UPI's `Hbt` type. - TRANSACTION_TYPE_HEART_BEAT = 12; - - // List accounts transaction type. This is associated with `LIST_ACCOUNTS` API - // type. Maps to UPI's `ListAccount` type. - TRANSACTION_TYPE_LIST_ACCOUNTS = 13; - - // OTP transaction type. This is associated with the `INITIATE_REGISTRATION` - // API type. Maps to UPI's `Otp` type. - TRANSACTION_TYPE_OTP = 14; - - // Register mobile transaction type. This is associated with the - // `VALIDATE_REGISTRATION` API type. Maps to UPI's `RegMob` type. - TRANSACTION_TYPE_REGISTER_MOBILE = 15; - - // Refund transaction type. This is associated with the `COMPLAINT` API - // type. Maps to UPI's `REFUND` type. - TRANSACTION_TYPE_REFUND = 16; - - // Reversal transaction type. This is associated with the `SETTLE_PAYMENT` and - // `COMPLAINT` API types. Maps to UPI's `REVERSAL` type. - TRANSACTION_TYPE_REVERSAL = 17; - - // Revoke transaction type. This is associated with the `MANDATE` API type. - // Maps to UPI's `REVOKE` type. - TRANSACTION_TYPE_REVOKE = 18; - - // Status update transaction type. This is associated with the `COMPLAINT` API - // type. Maps to UPI's `STATUSUPDATE` type. - TRANSACTION_TYPE_STATUS_UPDATE = 19; - - // Update transaction type. This is associated with the `MANDATE` API type. - // Maps to UPI's `UPDATE` type. - TRANSACTION_TYPE_UPDATE = 20; - - // Update credentials transaction type. This is associated with - // `UPDATE_CREDENTIALS` API type. Maps to UPI's `SetCre` type. - TRANSACTION_TYPE_UPDATE_CREDENTIALS = 21; - - // Redeem transaction type. This is associated with the `VOUCHER_CONFIRMATION` - // API type. Maps to UPI's `REDEEM` type. - TRANSACTION_TYPE_REDEEM = 22; -} - // A reference to uniquely identify an account according to India's UPI // standards. message AccountReference { @@ -342,3 +200,275 @@ message MerchantAdditionalInfo { // Indicates the merchant's owner type. OwnershipType ownership_type = 7; } + +// The API type for a transaction. Every transaction processed by the issuer +// switch will be one of these API types. +enum ApiType { + // Unspecified API type. + API_TYPE_UNSPECIFIED = 0; + + // Balance API. Maps to UPI's `BalEnq` API. This is a metadata + // transaction API. + BALANCE = 1; + + // Check transaction status API. Maps to UPI's `ChkTxn` API. This is a + // metadata transaction API. + CHECK_STATUS = 2; + + // Complaint API. Maps to UPI's `Complaint` API. This is a dispute and issue + // resolution API. + COMPLAINT = 3; + + // Heart beat API. Maps to UPI's `Hbt` API. This is a metadata transaction + // API. + HEART_BEAT = 4; + + // Initiate registration API. Maps to UPI's `Otp` API. This is a metadata + // transaction API. + INITIATE_REGISTRATION = 5; + + // List accounts API. Maps to UPI's `ListAccount` API. This is a metadata + // transaction API. + LIST_ACCOUNTS = 6; + + // Mandate API. Maps to UPI's `Mandate` API. This is a metadata transaction + // API. + MANDATE = 7; + + // Mandate confirmation API. Maps to UPI's `MandateConfirmation` API. This is + // a metadata transaction API. + MANDATE_CONFIRMATION = 8; + + // Payment settlement API. Maps to UPI's `Pay` API. This is a financial + // transaction API. + SETTLE_PAYMENT = 9; + + // Update credentials API. Maps to UPI's `SetCre` API. This is a metadata + // transaction API. + UPDATE_CREDENTIALS = 10; + + // Validate registration API. Maps to UPI's `RegMob` API. This is a metadata + // transaction API. + VALIDATE_REGISTRATION = 11; + + // Validate customer API. Maps to UPI's `ValCust` API. This is a validation + // API. + VALIDATE_CUSTOMER = 12; + + // Voucher API. Maps to UPI's `Voucher` API. + VOUCHER = 13; + + // Voucher confirmation API. Maps to UPI's `VoucherConfirmation` API. + VOUCHER_CONFIRMATION = 14; +} + +// The type of a transaction. Every transaction processed by the issuer switch +// will be one of these transaction types. Transaction types are associated with +// a particular API type. This associated is documented with each value. +enum TransactionType { + // Unspecified transaction type. + TRANSACTION_TYPE_UNSPECIFIED = 0; + + // Autoupdate transaction type. This is associated with the `CHECK_STATUS` + // API type. Maps to UPI's `AUTOUPDATE` type. + TRANSACTION_TYPE_AUTOUPDATE = 1; + + // Balance check transaction type. This is associated with the + // `BALANCE_ENQUIRY` API type. Maps to UPI's `BalChk` type. + TRANSACTION_TYPE_BALANCE_CHECK = 2; + + // Balance enquiry transaction type. This is associated with the + // `BALANCE_ENQUIRY` API type. Maps to UPI's `BalEnq` type. + TRANSACTION_TYPE_BALANCE_ENQUIRY = 3; + + // Check status transaction type. This is associated with the `COMPLAINT` API + // type. Maps to UPI's `CHECKSTATUS` type. + TRANSACTION_TYPE_CHECK_STATUS = 4; + + // Check transaction type. This is associated with the `CHECK_STATUS` API + // type. Maps to UPI's `ChkTxn` type. + TRANSACTION_TYPE_CHECK_TRANSACTION = 5; + + // Complaint transaction type. This is associated with the `COMPLAINT` API + // type. Maps to UPI's `COMPLAINT` type. + TRANSACTION_TYPE_COMPLAINT = 6; + + // Create transaction type. This is associated with the `MANDATE` API type. + // Maps to UPI's `CREATE` type. + TRANSACTION_TYPE_CREATE = 7; + + // Credit transaction type. This is associated with the `SETTLE_PAYMENT` API + // type. Maps to UPI's `CREDIT` type. + TRANSACTION_TYPE_CREDIT = 8; + + // Debit transaction type. This is associated with the `SETTLE_PAYMENT` API + // type. Maps to UPI's `DEBIT` type. + TRANSACTION_TYPE_DEBIT = 9; + + // Dispute transaction type. This is associated with the `COMPLAINT` API + // type. Maps to UPI's `DISPUTE` type. + TRANSACTION_TYPE_DISPUTE = 10; + + // Heart beat transaction type. This is associated with `HEART_BEAT` API type. + // Maps to UPI's `Hbt` type. + TRANSACTION_TYPE_HEART_BEAT = 11; + + // List accounts transaction type. This is associated with `LIST_ACCOUNTS` API + // type. Maps to UPI's `ListAccount` type. + TRANSACTION_TYPE_LIST_ACCOUNTS = 12; + + // Mandate notification transaction type. This is associated with the + // `VALIDATE_CUSTOMER` API type. Maps to UPI's `MandateNotification` type. + TRANSACTION_TYPE_MANDATE_NOTIFICATION = 13; + + // OTP transaction type. This is associated with the `INITIATE_REGISTRATION` + // API type. Maps to UPI's `Otp` type. + TRANSACTION_TYPE_OTP = 14; + + // Pause transaction type. This is associated with the `MANDATE` API type. + // Maps to UPI's `PAUSE` type. + TRANSACTION_TYPE_PAUSE = 15; + + // Redeem transaction type. This is associated with the `VOUCHER_CONFIRMATION` + // API type. Maps to UPI's `REDEEM` type. + TRANSACTION_TYPE_REDEEM = 16; + + // Refund transaction type. This is associated with the `COMPLAINT` API + // type. Maps to UPI's `REFUND` type. + TRANSACTION_TYPE_REFUND = 17; + + // Register mobile transaction type. This is associated with the + // `VALIDATE_REGISTRATION` API type. Maps to UPI's `RegMob` type. + TRANSACTION_TYPE_REGISTER_MOBILE = 18; + + // Reversal transaction type. This is associated with the `SETTLE_PAYMENT` and + // `COMPLAINT` API types. Maps to UPI's `REVERSAL` type. + TRANSACTION_TYPE_REVERSAL = 19; + + // Revoke transaction type. This is associated with the `MANDATE` API type. + // Maps to UPI's `REVOKE` type. + TRANSACTION_TYPE_REVOKE = 20; + + // Status update transaction type. This is associated with the `COMPLAINT` API + // type. Maps to UPI's `STATUSUPDATE` type. + TRANSACTION_TYPE_STATUS_UPDATE = 21; + + // Update transaction type. This is associated with the `MANDATE` API type. + // Maps to UPI's `UNPAUSE` type. + TRANSACTION_TYPE_UNPAUSE = 22; + + // Update transaction type. This is associated with the `MANDATE` API type. + // Maps to UPI's `UPDATE` type. + TRANSACTION_TYPE_UPDATE = 23; + + // Update credentials transaction type. This is associated with + // `UPDATE_CREDENTIALS` API type. Maps to UPI's `SetCre` type. + TRANSACTION_TYPE_UPDATE_CREDENTIALS = 24; + + // Validate customer transaction type. This is associated with + // `VALIDATE_CUSTOMER` API type. Maps to UPI's `ValCust` type. + TRANSACTION_TYPE_VALIDATE_CUSTOMER = 25; +} + +// XmlApiType specifies the API type of the request or response as specified in +// the XML payload. +enum XmlApiType { + // Unspecified API type. + XML_API_TYPE_UNSPECIFIED = 0; + + // Balance enquiry request API type. Maps to UPI's `ReqBalEnq` API. + REQ_BAL_ENQ = 1; + + // Check transaction request API type. Maps to UPI's `ReqChkTxn` API. + REQ_CHK_TXN = 2; + + // Complaint request API type. Maps to UPI's `ReqComplaint` API. + REQ_COMPLAINT = 3; + + // Heart beat request API type. Maps to UPI's `ReqHbt` API. + REQ_HBT = 4; + + // List accounts request API type. Maps to UPI's `ReqListAccount` API. + REQ_LIST_ACCOUNT = 5; + + // Mandate request API. Maps to UPI's `ReqMandate` API. + REQ_MANDATE = 6; + + // Mandate confirmation request API type. Maps to UPI's + // `ReqMandateConfirmation` API. + REQ_MANDATE_CONFIRMATION = 7; + + // OTP request API. Maps to UPI's `ReqOtp` API. + REQ_OTP = 8; + + // Payment settlement request API type. Maps to UPI's `ReqPay` API. + REQ_PAY = 9; + + // Register mobile request API type. Maps to UPI's `ReqRegMob` API. + REQ_REG_MOB = 10; + + // Update credentials request API type. Maps to UPI's `ReqSetCre` API. + REQ_SET_CRE = 11; + + // Validate customer request API type. Maps to UPI's `ReqValCust`. + REQ_VAL_CUST = 12; + + // Create voucher request API type. Maps to UPI's `ReqVoucher`. + REQ_VOUCHER = 13; + + // Voucher confirmation request API type. Maps to UPI's + // `ReqVoucherConfirmation` API. + REQ_VOUCHER_CONFIRMATION = 14; + + // Transaction confirmation request API type. Maps to UPI's + // `ReqTxnConfirmation` API. + REQ_TXN_CONFIRMATION = 15; + + // Balance enquiry response API type. Maps to UPI's `RespBalEnq` API. + RESP_BAL_ENQ = 16; + + // Check transaction response API type. Maps to UPI's `RespChkTxn` API. + RESP_CHK_TXN = 17; + + // Complaint response API type. Maps to UPI's `RespComplaint` API. + RESP_COMPLAINT = 18; + + // Heart beat response API type. Maps to UPI's `RespHbt` API. + RESP_HBT = 19; + + // List accounts response API type. Maps to UPI's `RespListAccount` API. + RESP_LIST_ACCOUNT = 20; + + // Mandate response API type. Maps to UPI's `RespMandate` API. + RESP_MANDATE = 21; + + // Mandate confirmation response API type. Maps to UPI's + // `RespMandateConfirmation` API. + RESP_MANDATE_CONFIRMATION = 22; + + // OTP response API. Maps to UPI's `RespOtp` API. + RESP_OTP = 23; + + // Payment settlement response API type. Maps to UPI's `RespPay` API. + RESP_PAY = 24; + + // Register mobile response API type. Maps to UPI's `RespRegMob` API. + RESP_REG_MOB = 25; + + // Update credentials response API type. Maps to UPI's `RespSetCre` API. + RESP_SET_CRE = 26; + + // Validate customer response API type. Maps to UPI's `RespValCust`. + RESP_VAL_CUST = 27; + + // Create voucher response API type. Maps to UPI's `RespVoucher`. + RESP_VOUCHER = 28; + + // Voucher confirmation responseAPI type. Maps to UPI's + // `RespVoucherConfirmation` API. + RESP_VOUCHER_CONFIRMATION = 29; + + // Transaction confirmation response API type. Maps to UPI's + // `RespTxnConfirmation` API. + RESP_TXN_CONFIRMATION = 30; +} diff --git a/google/cloud/paymentgateway/issuerswitch/v1/issuerswitch_v1.yaml b/google/cloud/paymentgateway/issuerswitch/v1/issuerswitch_v1.yaml index 769499794..c60169f81 100644 --- a/google/cloud/paymentgateway/issuerswitch/v1/issuerswitch_v1.yaml +++ b/google/cloud/paymentgateway/issuerswitch/v1/issuerswitch_v1.yaml @@ -1,7 +1,7 @@ type: google.api.Service config_version: 3 name: issuerswitch.googleapis.com -title: Cloud Issuer Switch Service API +title: Issuer switch API apis: - name: google.cloud.paymentgateway.issuerswitch.v1.IssuerSwitchResolutions @@ -24,6 +24,7 @@ types: - name: google.cloud.paymentgateway.issuerswitch.v1.ExportMetadataTransactionsResponse - name: google.cloud.paymentgateway.issuerswitch.v1.ResolveComplaintMetadata - name: google.cloud.paymentgateway.issuerswitch.v1.ResolveDisputeMetadata +- name: google.cloud.paymentgateway.issuerswitch.v1.UpiTransaction http: rules: diff --git a/google/cloud/paymentgateway/issuerswitch/v1/logs.proto b/google/cloud/paymentgateway/issuerswitch/v1/logs.proto new file mode 100644 index 000000000..e269790cc --- /dev/null +++ b/google/cloud/paymentgateway/issuerswitch/v1/logs.proto @@ -0,0 +1,89 @@ +// 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.paymentgateway.issuerswitch.v1; + +import "google/cloud/paymentgateway/issuerswitch/v1/common_fields.proto"; +import "google/cloud/paymentgateway/issuerswitch/v1/transactions.proto"; +import "google/logging/type/log_severity.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.PaymentGateway.IssuerSwitch.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/paymentgateway/issuerswitch/v1;issuerswitch"; +option java_multiple_files = true; +option java_outer_classname = "LogsProto"; +option java_package = "com.google.cloud.paymentgateway.issuerswitch.v1"; +option php_namespace = "Google\\Cloud\\PaymentGateway\\IssuerSwitch\\V1"; +option ruby_package = "Google::Cloud::PaymentGateway::IssuerSwitch::V1"; + +// The payload for the log entry. +message UpiTransaction { + // A human readable message about the log entry. + string description = 1; + + // The severity of the log entry. + google.logging.type.LogSeverity severity = 2; + + // The API type of the transaction. + ApiType api_type = 3; + + // The XML API type of the transaction. + XmlApiType xml_api_type = 4; + + // The type of the transaction. + TransactionType transaction_type = 5; + + // UPI's transaction ID. + string transaction_id = 6; + + // UPI's message ID. + string message_id = 7; + + // The payment's RRN. This will be present only for payment related + // transactions. + string rrn = 8; + + // The timestamp at which the payload was received by the issuer switch. + google.protobuf.Timestamp payload_receipt_time = 9; + + // The timestamp at which the payload was sent by the issuer switch. + google.protobuf.Timestamp payload_sent_time = 10; + + // Status of the transaction which could be SUCCESS or FAILURE. This will be + // populated only after transaction is complete. + TransactionInfo.State status = 11; + + // Issuer switch error code. This will be present only for failed + // transactions. + string error_code = 12; + + // UPI error code that was sent back to NPCI. This will be present only for + // failed transactions. + string upi_error_code = 13; + + // Issuer switch error message. This will be present only for failed + // transactions. + string error_message = 14; + + // The ack, request or response payload. + oneof payload { + // The payload in XML format sent to the issuer switch. + string sent = 15; + + // The payload in XML format received by the issuer switch. + string received = 16; + } +} diff --git a/google/cloud/paymentgateway/issuerswitch/v1/transactions.proto b/google/cloud/paymentgateway/issuerswitch/v1/transactions.proto index f1bf6bca4..c08ef799a 100644 --- a/google/cloud/paymentgateway/issuerswitch/v1/transactions.proto +++ b/google/cloud/paymentgateway/issuerswitch/v1/transactions.proto @@ -82,44 +82,128 @@ service IssuerSwitchTransactions { // The exported file will be in the standard CSV format where each row in the // file represents a transaction. The file has the following fields in order: // - // - `TransactionID` - UPI transaction ID. - // - `TransactionType` - Type of the transaction. This will be one of - // `TRANSACTION_TYPE_CREDIT`, `TRANSACTION_TYPE_DEBIT` or - // `TRANSACTION_TYPE_REVERSAL`. - // - `TransactionSubType` - Subtype of the transaction. This will be one - // of `COLLECT`, `DEBIT` or `PAY`. - // - `RequestReceivedTimestamp` - Timestamp (in UTC) indicating when the - // transaction API request was received by the issuer switch. - // - `CreationTime` - Timestamp (in UTC) indicating when the - // issuer switch created the transaction resource for processing the - // transaction. - // - `State` - State of the transaction. This will be one of `FAILED` or - // `SUCCEEDED`. - // - `RRN` - Retrieval reference number associated with the transaction. - // - `PayerVPA` - Virtual Payment Address (VPA) of the payer. - // - `PayerMobileNumber` - Mobile number of the payer. - // - `PayerIFSCCode` - IFSC code of the payer's bank account. - // - `PayerAccountNumber` - Payer's bank account number. - // - `PayerAccountType` - Payer's bank account type. - // - `PayeeVPA` - Virtual Payment Address (VPA) of the payee. - // - `PayeeMobileNumber` - Payee's mobile number. - // - `PayeeIFSCCode` - IFSC code of the payee's bank account. - // - `PayeeAccountNumber` - Payee's bank account number. - // - `PayeeAccountType` - Payee's bank account type. - // - `PayeeMerchantID` - Payee's merchant ID, only if the payee is a merchant. - // - `PayeeMerchantName` - Payee's merchant name, only if the payee is a - // merchant. - // - `PayeeMCC` - Payee's Merchant Category Code (MCC), only if the payee is a - // merchant. - // - `Currency` - Currency of the amount involved in the transaction. - // - `Amount` - Amount involved in the transaction. - // - `BankAdapterRequestIDs` - List of Request IDs (colon separated) used when - // invoking the Bank Adapter APIs for fulfilling a transaction request. - // - `ErrorCode` - Error code of the failed transaction. - // - `ErrorMessage` - Error description for the failed transaction. - // - `UPIErrorCode` - Error code as per the UPI specification. The issuer - // switch maps the ErrorCode to an appropriate error code that complies with - // the UPI specification. + // 1. `TransactionID` + // * **Min Length** - 35 characters + // * **Max Length** - 35 characters + // * **Description** - UPI transaction ID. + // 1. `TransactionType` + // * **Min Length** - 22 characters + // * **Max Length** - 25 characters + // * **Description** - Type of the transaction. This will be one of + // `TRANSACTION_TYPE_CREDIT`, `TRANSACTION_TYPE_DEBIT` or + // `TRANSACTION_TYPE_REVERSAL`. + // 1. `TransactionSubType` + // * **Min Length** - 3 characters + // * **Max Length** - 7 characters + // * **Description** - Subtype of the transaction. This will be one of + // `COLLECT`, or `PAY`. + // 1. `RequestReceivedTimestamp` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the transaction + // API request was received by the issuer switch. The format will be as + // per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `CreationTime` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the issuer + // switch created the transaction resource for processing the transaction. + // The format will be as per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `State` + // * **Min Length** - 6 characters + // * **Max Length** - 9 characters + // * **Description** - State of the transaction. This will be one of + // `FAILED`, `SUCCEEDED`, or `TIMED_OUT`. + // 1. `RRN` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Retrieval reference number associated with the + // transaction. + // 1. `PayerVPA` + // * **Min Length** - 3 characters + // * **Max Length** - 255 characters + // * **Description** - Virtual Payment Address (VPA) of the payer. + // 1. `PayerMobileNumber` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Mobile number of the payer. + // 1. `PayerIFSC` + // * **Min Length** - 11 characters + // * **Max Length** - 11 characters + // * **Description** - IFSC of the payer's bank account. + // 1. `PayerAccountNumber` + // * **Min Length** - 1 characters + // * **Max Length** - 30 characters + // * **Description** - Payer's bank account number. + // 1. `PayerAccountType` + // * **Min Length** - 3 characters + // * **Max Length** - 7 characters + // * **Description** - Payer's bank account type. This will be one of + // `SAVINGS`, `DEFAULT`, `CURRENT`, `NRE`, `NRO`, `PPIWALLET`, + // `BANKWALLET`, `CREDIT`, `SOD`, or `UOD`. + // 1. `PayeeVPA` + // * **Min Length** - 3 characters + // * **Max Length** - 255 characters + // * **Description** - Virtual Payment Address (VPA) of the payee. + // 1. `PayeeMobileNumber` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Payee's mobile number. + // 1. `PayeeIFSC` + // * **Min Length** - 11 characters + // * **Max Length** - 11 characters + // * **Description** - IFSC of the payee's bank account. + // 1. `PayeeAccountNumber` + // * **Min Length** - 1 characters + // * **Max Length** - 30 characters + // * **Description** - Payee's bank account number. + // 1 `PayeeAccountType` + // * **Min Length** - 3 characters + // * **Max Length** - 10 characters + // * **Description** - Payee's bank account type. This will be one of + // `SAVINGS`, `DEFAULT`, `CURRENT`, `NRE`, `NRO`, `PPIWALLET`, + // `BANKWALLET`, `CREDIT`, `SOD`, or `UOD`. + // 1. `PayeeMerchantID` + // * **Min Length** - 1 characters + // * **Max Length** - 255 characters + // * **Description** - Payee's merchant ID, only if the payee is a + // merchant. + // 1. `PayeeMerchantName` + // * **Min Length** - 1 characters + // * **Max Length** - 99 characters + // * **Description** - Payee's merchant name, only if the payee is a + // merchant. + // 1. `PayeeMCC` + // * **Min Length** - 4 characters + // * **Max Length** - 4 characters + // * **Description** - Payee's Merchant Category Code (MCC), only if the + // payee is a merchant. + // 1. `Currency` + // * **Min Length** - 3 characters + // * **Max Length** - 3 characters + // * **Description** - Currency of the amount involved in the transaction. + // The currency codes are defined in ISO 4217. + // 1. `Amount` + // * **Description** - Amount involved in the transaction. + // 1. `BankAdapterRequestIDs` + // * **Min Length** - 0 characters + // * **Max Length** - 2,000 characters + // * **Description** - List of Request IDs (colon separated) used when + // invoking the Bank Adapter APIs for fulfilling a transaction request. + // 1. `ErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Error code of a failed transaction. + // 1. `ErrorMessage` + // * **Min Length** - 0 characters + // * **Max Length** - 10,000 characters + // * **Description** - Error description for a failed transaction. + // 1. `UPIErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 3 characters + // * **Description** - Error code as per the UPI specification. The issuer + // switch maps the ErrorCode to an appropriate error code that complies + // with the UPI specification. rpc ExportFinancialTransactions(ExportFinancialTransactionsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*}/financialTransactions:export" @@ -141,27 +225,57 @@ service IssuerSwitchTransactions { // The exported file will be in the standard CSV format where each row in the // file represents a transaction. The file has the following fields in order: // - // - `TransactionID` - UPI transaction ID. - // - `APIType` - The transaction's API type. The value will be of the - // [ApiType][google.cloud.paymentgateway.issuerswitch.v1.ApiType] enum. - // - `TransactionType` - Type of the transaction. The value will be of the - // [TransactionType][google.cloud.paymentgateway.issuerswitch.v1.TransactionType] enum. - // - `RequestReceivedTimestamp` - Timestamp (in UTC) indicating when the - // transaction's API request was received by the issuer switch. - // - `CreationTime` - Timestamp (in UTC) indicating when the - // issuer switch created the transaction resource for processing the - // transaction. - // - `State` - State of transaction. This will be one of `FAILED` or - // `SUCCEEDED`. - // - `OriginVPA` - Virtual Payment Address (VPA) of the originator of the - // transaction. - // - `BankAdapterRequestIDs` - List of Request IDs (colon separated) used when - // invoking the Bank Adapter APIs for fulfilling a transaction request. - // - `ErrorCode` - Error code of the failed transaction. - // - `ErrorMessage` - Error description for the failed transaction. - // - `UPIErrorCode` - Error code as per the UPI specification. The issuer - // switch maps the ErrorCode to an appropriate error code that complies with - // the UPI specification. + // 1. `TransactionID` + // * **Min Length** - 35 characters + // * **Max Length** - 35 characters + // * **Description** - UPI transaction ID. + // 1. `APIType` + // * **Description** - The transaction's API type. The value will be of + // the [ApiType][google.cloud.paymentgateway.issuerswitch.v1.ApiType] enum. + // 1. `TransactionType` + // * **Description** - Type of the transaction. The value will be of the + // [TransactionType][google.cloud.paymentgateway.issuerswitch.v1.TransactionType] enum. + // 1. `RequestReceivedTimestamp` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the transaction + // API request was received by the issuer switch. The format will be as + // per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `CreationTime` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the issuer + // switch created the transaction resource for processing the transaction. + // The format will be as per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `State` + // * **Min Length** - 6 characters + // * **Max Length** - 9 characters + // * **Description** - State of the transaction. This will be one of + // `FAILED`, `SUCCEEDED`, or `TIMED_OUT`. + // 1. `OriginVPA` + // * **Min Length** - 3 characters + // * **Max Length** - 255 characters + // * **Description** - Virtual Payment Address (VPA) of the originator of + // the transaction. + // 1. `BankAdapterRequestIDs` + // * **Min Length** - 0 characters + // * **Max Length** - 2,000 characters + // * **Description** - List of Request IDs (colon separated) used when + // invoking the Bank Adapter APIs for fulfilling a transaction request. + // 1. `ErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Error code of the failed transaction. + // 1. `ErrorMessage` + // * **Min Length** - 0 characters + // * **Max Length** - 10,000 characters + // * **Description** - Error description for the failed transaction. + // 1. `UPIErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 3 characters + // * **Description** - Error code as per the UPI specification. The issuer + // switch maps the ErrorCode to an appropriate error code that complies + // with the UPI specification. rpc ExportMetadataTransactions(ExportMetadataTransactionsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*}/metadataTransactions:export" @@ -183,48 +297,124 @@ service IssuerSwitchTransactions { // The exported file will be in the standard CSV format where each row in the // file represents a transaction. The file has the following fields in order: // - // - `TransactionID` - UPI transaction ID. - // - `UniqueMandateNumber` - UPI Unique Mandate Number. - // - `TransactionType` - Type of the transaction. This will be one of - // `TRANSACTION_TYPE_CREATE`, `TRANSACTION_TYPE_REVOKE` or - // `TRANSACTION_TYPE_UPDATE`. - // - `RequestReceivedTimestamp` - Timestamp (in UTC) indicating when the - // mandate API request was received by the issuer switch. - // - `CreationTime` - Timestamp (in UTC) indicating when the - // issuer switch created the transaction resource for processing the - // transaction. - // - `State` - State of the transaction. This will be one of - // `FAILED` or `SUCCEEDED`. - // - `PayerVPA` - Virtual Payment Address (VPA) of the payer. - // - `PayerMobileNumber` - Mobile number of the payer. - // - `PayeeVPA` - Virtual Payment Address (VPA) of the payee. - // - `PayeeMobileNumber` - Mobile number of the payee. - // - `PayeeMerchantID` - Payee's merchant ID. - // - `Amount` - Amount specified in the mandate. - // - `RecurrencePattern` - Reccurence pattern of the mandate. The value will - // be of the [MandateTransaction.RecurrencePattern][] enum. - // - `RecurrenceRuleType` - Reccurrence rule type of the mandate. The value - // will be of the [MandateTransaction.RecurrenceRuleType][google.cloud.paymentgateway.issuerswitch.v1.MandateTransaction.RecurrenceRuleType] enum. - // - `RecurrenceRuleValue` - Recurrence rule value of the mandate. - // - `Revokeable` - Boolean value specifying if the mandate is revokable. - // - `StartDate` - The start date of the mandate in `YYYY-MM-DD` format. - // - `EndDate` - The end date of the mandate in `YYYY-MM-DD` format. - // - `AmountRuleType` - The amount rule of the mandate. The value will - // be of the [MandateTransaction.AmountRuleType][google.cloud.paymentgateway.issuerswitch.v1.MandateTransaction.AmountRuleType] enum. - // - `ApprovalReference` - The block funds reference generated by the bank, - // if funds have been blocked for the mandate. This column have a value only - // when the RecurrencePattern is ONETIME. - // - `BlockFunds` - Boolean value specifying if the mandate transaction - // requested to block funds. - // - `LastUpdateTime` - Timestamp (in UTC) indicating when was the last - // modification made to the mandate. - // - `BankAdapterRequestIDs` - List of Request IDs (colon separated) used when - // invoking the Bank Adapter APIs for fulfilling a transaction request. - // - `ErrorCode` - Error code of the failed transaction. - // - `ErrorMessage` - Error description for the failed transaction. - // - `UPIErrorCode` - Error code as per the UPI specification. The issuer - // switch maps the ErrorCode to an appropriate error code that complies with - // the UPI specification. + // 1. `TransactionID` + // * **Min Length** - 35 characters + // * **Max Length** - 35 characters + // * **Description** - UPI transaction ID. + // 1. `UniqueMandateNumber` + // * **Min Length** - 3 characters + // * **Max Length** - 70 characters + // * **Description** - UPI Unique Mandate Number. + // 1. `TransactionType` + // * **Min Length** - 23 characters + // * **Max Length** - 23 characters + // * **Description** - Type of the transaction. This will be one of + // `TRANSACTION_TYPE_CREATE`, `TRANSACTION_TYPE_REVOKE` or + // `TRANSACTION_TYPE_UPDATE`. + // 1. `RequestReceivedTimestamp` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the mandate + // API request was received by the issuer switch. The format will be as + // per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `CreationTime` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the issuer + // switch created the transaction resource for processing the transaction. + // The format will be as per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1. `State` + // * **Min Length** - 6 characters + // * **Max Length** - 9 characters + // * **Description** - State of the transaction. This will be one of + // `FAILED`, `SUCCEEDED`, or `TIMED_OUT`. + // 1. `PayerVPA` + // * **Min Length** - 3 characters + // * **Max Length** - 255 characters + // * **Description** - Virtual Payment Address (VPA) of the payer. + // 1. `PayerMobileNumber` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Mobile number of the payer. + // 1. `PayeeVPA` + // * **Min Length** - 3 characters + // * **Max Length** - 255 characters + // * **Description** - Virtual Payment Address (VPA) of the payee. + // 1. `PayeeMobileNumber` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Mobile number of the payee. + // 1. `PayeeMerchantID` + // * **Min Length** - 1 characters + // * **Max Length** - 30 characters + // * **Description** - Payee's merchant ID, only if the payee is a + // merchant + // 1. `Amount` + // * **Description** - Amount specified in the mandate. + // 1. `RecurrencePattern` + // * **Description** - Reccurence pattern of the mandate. The value will + // be of the [MandateTransaction.RecurrencePatternType][google.cloud.paymentgateway.issuerswitch.v1.MandateTransaction.RecurrencePatternType] enum. + // 1. `RecurrenceRuleType` + // * **Description** - Reccurrence rule type of the mandate. The value + // will be of the [MandateTransaction.RecurrenceRuleType][google.cloud.paymentgateway.issuerswitch.v1.MandateTransaction.RecurrenceRuleType] enum. + // 1. `RecurrenceRuleValue` + // * **Min Length** - 0 characters + // * **Max Length** - 2 characters + // * **Description** - Recurrence rule value of the mandate. This will be + // an integer between 1 and 31. + // 1. `Revokeable` + // * **Min Length** - 4 characters + // * **Max Length** - 5 characters + // * **Description** - Boolean value specifying if the mandate is + // revokable. + // 1. `StartDate` + // * **Min Length** - 10 characters + // * **Max Length** - 10 characters + // * **Description** - The start date of the mandate in `YYYY-MM-DD` + // format. + // 1. `EndDate` + // * **Min Length** - 10 characters + // * **Max Length** - 10 characters + // * **Description** - The end date of the mandate in `YYYY-MM-DD` format. + // 1. `AmountRuleType` + // * **Description** - The amount rule of the mandate. The value will be + // of the [MandateTransaction.AmountRuleType][google.cloud.paymentgateway.issuerswitch.v1.MandateTransaction.AmountRuleType] enum. + // 1. `ApprovalReference` + // * **Min Length** - 6 characters + // * **Max Length** - 9 characters + // * **Description** - The block funds reference generated by the bank, if + // funds have been blocked for the mandate. This column will have a value + // only when the RecurrencePattern is ONETIME. + // 1. `BlockFunds` + // * **Min Length** - 4 characters + // * **Max Length** - 5 characters + // * **Description** - Boolean value specifying if the mandate transaction + // requested to block funds. + // 1. `LastUpdateTime` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when was the last + // modification made to the mandate. The format will be as per RFC-3339. + // Example : 2022-11-22T23:00:05Z + // 1. `BankAdapterRequestIDs` + // * **Min Length** - 0 characters + // * **Max Length** - 2,000 characters + // * **Description** - List of Request IDs (colon separated) used when + // invoking the Bank Adapter APIs for fulfilling a transaction request. + // 1. `ErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Error code of the failed transaction. + // 1. `ErrorMessage` + // * **Min Length** - 0 characters + // * **Max Length** - 10,000 characters + // * **Description** - Error description for the failed transaction. + // 1. `UPIErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 3 characters + // * **Description** - Error code as per the UPI specification. The issuer + // switch maps the ErrorCode to an appropriate error code that complies + // with the UPI specification. rpc ExportMandateTransactions(ExportMandateTransactionsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*}/mandateTransactions:export" @@ -246,51 +436,129 @@ service IssuerSwitchTransactions { // The exported file will be in the standard CSV format where each row in the // file represents a transaction. The file has the following fields in order: // - // - `TransactionID` - UPI transaction ID. - // - `TransactionType` - Type of the transaction. This will be one of - // `TRANSACTION_TYPE_CHECK_STATUS`, `TRANSACTION_TYPE_COMPLAINT`, - // `TRANSACTION_TYPE_REVERSAL`, `TRANSACTION_TYPE_DISPUTE`, - // `TRANSACTION_TYPE_REFUND` or `TRANSACTION_TYPE_STATUS_UPDATE`. - // - `CreationTime` - Timestamp (in UTC) indicating when the issuer switch - // created the transaction resource for processing the transaction. - // - `State` - State of the transaction. This will be one of - // `FAILED` or `SUCCEEDED`. - // - `OriginalRRN` - RRN of the original payment transaction. - // - `BankType` - The subtype of the transaction based on the bank involved. - // - `OriginalTransactionID` - Transaction ID of the original unresolved - // transaction. - // - `RaiseComplaintAdjFlag` - Indicates the type of action to raise the - // complaint. - // - `RaiseComplaintAdjCode` - Indicates the reason of action to raise the - // complaint. - // - `ResolveComplaintAdjFlag` - Indicates the type of action to resolve the - // complaint. - // - `ResolveComplaintAdjCode` - Indicates the reason of action to resolve the - // complaint. - // - `RaiseDisputeAdjFlag` - Indicates the type of action to raise the - // dispute. - // - `RaiseDisputeAdjCode` - Indicates the reason of action to raise the - // dispute. - // - `ResolveDisputeAdjFlag` - Indicates the type of action to resolve the - // dispute. - // - `ResolveDisputeAdjCode` - Indicates the reason of action to resolve the - // dispute. - // - `Amount` - Amount to be resolved. - // - `CurrentCycle` - Boolean value specifying if the complaint / dispute - // belongs to current settlement cycle or not. - // - `CRN` - Defines the Complaint Reference number. - // - `AdjTime` - Indicates the time when the resolution was done. - // - `RespAdjFlag` - Indicates the response category type. - // - `RespAdjCode` - Indicates the response reason used. - // - `AdjRemarks` - Indicates the additional remarks for the complaint / - // dispute. - // - `BankAdapterRequestIDs` - List of Request IDs (colon separated) used when - // invoking the Bank Adapter APIs for fulfilling a transaction request. - // - `ErrorCode` - Error code of the failed transaction. - // - `ErrorMessage` - Error description for the failed transaction. - // - `UPIErrorCode` - Error code as per the UPI specification. The issuer - // switch service maps the ErrorCode to an appropriate error code that - // complies with the UPI specification. + // 1. `TransactionID` + // * **Min Length** - 35 characters + // * **Max Length** - 35 characters + // * **Description** - UPI transaction ID. + // 1. `TransactionType` + // * **Min Length** - 23 characters + // * **Max Length** - 30 characters + // * **Description** - Type of the transaction. This will be one of + // `TRANSACTION_TYPE_CHECK_STATUS`, `TRANSACTION_TYPE_COMPLAINT`, + // `TRANSACTION_TYPE_REVERSAL`, `TRANSACTION_TYPE_DISPUTE`, + // `TRANSACTION_TYPE_REFUND`, or `TRANSACTION_TYPE_STATUS_UPDATE`. + // 1. `CreationTime` + // * **Min Length** - 20 characters + // * **Max Length** - 20 characters + // * **Description** - Timestamp (in UTC) indicating when the issuer + // switch created the transaction resource for processing the transaction. + // The format will be as per RFC-3339. Example : 2022-11-22T23:00:05Z + // 1: `State` + // * **Min Length** - 6 characters + // * **Max Length** - 9 characters + // * **Description** - State of the transaction. This will be one of + // `FAILED`, `SUCCEEDED`, or `TIMED_OUT`. + // 1. `OriginalRRN` + // * **Min Length** - 12 characters + // * **Max Length** - 12 characters + // * **Description** - Retrieval reference number of the original payment + // transaction. + // 1. `BankType` + // * **Min Length** - 8 characters + // * **Max Length** - 11 characters + // * **Description** - The subtype of the transaction based on the bank + // involved. This will be one of `BENEFICIARY`, or `REMITTER`. + // 1. `OriginalTransactionID` + // * **Min Length** - 35 characters + // * **Max Length** - 35 characters + // * **Description** - Transaction ID of the original unresolved + // transaction. + // 1. `RaiseComplaintAdjFlag` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the type of action to raise the + // complaint. + // 1. `RaiseComplaintAdjCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the reason of action to raise the + // complaint. + // 1. `ResolveComplaintAdjFlag` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the type of action to resolve the + // complaint. + // 1. `ResolveComplaintAdjCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the reason of action to resolve the + // complaint. + // 1. `RaiseDisputeAdjFlag` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the type of action to raise the dispute. + // 1. `RaiseDisputeAdjCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the reason of action to raise the + // dispute. + // 1. `ResolveDisputeAdjFlag` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the type of action to resolve the + // dispute. + // 1. `ResolveDisputeAdjCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the reason of action to resolve the + // dispute. + // 1. `Amount` + // * **Description** - Amount to be resolved. + // 1. `CurrentCycle` + // * **Min Length** - 4 characters + // * **Max Length** - 5 characters + // * **Description** - Boolean value specifying if the complaint / dispute + // belongs to current settlement cycle or not. + // 1. `CRN` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Defines the Complaint Reference number. + // 1. `AdjTime` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the time when the resolution was done. + // 1. `RespAdjFlag` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the response category type. + // 1. `RespAdjCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the response reason used. + // 1. `AdjRemarks` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Indicates the additional remarks for the complaint + // / dispute. + // 1. `BankAdapterRequestIDs` + // * **Min Length** - 0 characters + // * **Max Length** - 2,000 characters + // * **Description** - List of Request IDs (colon separated) used when + // invoking the Bank Adapter APIs for fulfilling a transaction request. + // 1. `ErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 255 characters + // * **Description** - Error code of the failed transaction. + // 1. `ErrorMessage` + // * **Min Length** - 0 characters + // * **Max Length** - 10,000 characters + // * **Description** - Error description for the failed transaction. + // 1. `UPIErrorCode` + // * **Min Length** - 0 characters + // * **Max Length** - 3 characters + // * **Description** - Error code as per the UPI specification. The issuer + // switch service maps the ErrorCode to an appropriate error code that + // complies with the UPI specification. rpc ExportComplaintTransactions(ExportComplaintTransactionsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*}/complaintTransactions:export" @@ -309,7 +577,7 @@ service IssuerSwitchTransactions { message TransactionInfo { // Specifies the current state of the transaction. enum State { - // Unspecicifed state. + // Unspecified state. STATE_UNSPECIFIED = 0; // The transaction has successfully completed. @@ -377,14 +645,18 @@ message TransactionInfo { // issuer switch. google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The time at which the transaction resource was last updated by the + // issuer switch. + google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. List of Request IDs (colon separated) used when // invoking the Bank Adapter APIs for fulfilling a transaction request. - string bank_adapter_request_ids = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + string bank_adapter_request_ids = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Error code as per the UPI specification. The issuer switch maps the // ErrorCode to an appropriate error code that complies with the UPI // specification. - string upi_error_code = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + string upi_error_code = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; } // A metadata API transaction processed by the issuer switch. This @@ -574,8 +846,7 @@ message MandateTransaction { // blocked. bool block_funds = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The last time at which the mandate resource was modified by the issuer - // switch. + // Output only. google.protobuf.Timestamp last_update_time = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -1114,20 +1385,24 @@ message ExportComplaintTransactionsResponse { // Metadata for ExportFinancialTransactions. message ExportFinancialTransactionsMetadata { - + // Output only. The time at which the operation was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Metadata for ExportMandateTransactions. message ExportMandateTransactionsMetadata { - + // Output only. The time at which the operation was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Metadata for ExportMetadataTransactions. message ExportMetadataTransactionsMetadata { - + // Output only. The time at which the operation was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Metadata for ExportComplaintTransactions. message ExportComplaintTransactionsMetadata { - + // Output only. The time at which the operation was created. + google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/phishingprotection/v1beta1/BUILD.bazel b/google/cloud/phishingprotection/v1beta1/BUILD.bazel index c3b5f9e6e..fb4ca00bd 100644 --- a/google/cloud/phishingprotection/v1beta1/BUILD.bazel +++ b/google/cloud/phishingprotection/v1beta1/BUILD.bazel @@ -58,6 +58,7 @@ java_gapic_library( srcs = [":phishingprotection_proto_with_info"], gapic_yaml = "phishingprotection_gapic.yaml", grpc_service_config = "phishingprotection_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":phishingprotection_java_grpc", ], @@ -115,6 +116,7 @@ go_gapic_library( srcs = [":phishingprotection_proto_with_info"], grpc_service_config = "phishingprotection_grpc_service_config.json", importpath = "cloud.google.com/go/phishingprotection/apiv1beta1;phishingprotection", + rest_numeric_enums = True, service_yaml = "phishingprotection_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -153,6 +155,10 @@ py_gapic_library( name = "phishingprotection_py_gapic", srcs = [":phishingprotection_proto"], grpc_service_config = "phishingprotection_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-phishing-protection", + ], + rest_numeric_enums = True, transport = "grpc", ) @@ -199,6 +205,8 @@ php_gapic_library( name = "phishingprotection_php_gapic", srcs = [":phishingprotection_proto_with_info"], grpc_service_config = "phishingprotection_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":phishingprotection_php_grpc", ":phishingprotection_php_proto", @@ -231,7 +239,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "phishingprotection_grpc_service_config.json", package = "google.cloud.phishingprotection.v1beta1", + rest_numeric_enums = True, service_yaml = "phishingprotection_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,6 +287,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=PhishingProtectionServiceV1Beta1=PhishingProtectionService", ], grpc_service_config = "phishingprotection_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Phishing Protection helps prevent users from accessing phishing sites by identifying various signals associated with malicious content, including the use of your brand assets, classifying malicious content that uses your brand and reporting the unsafe URLs to Google Safe Browsing.", ruby_cloud_title = "Phishing Protection V1beta1", deps = [ @@ -322,6 +333,7 @@ csharp_gapic_library( srcs = [":phishingprotection_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "phishingprotection_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "phishingprotection_v1beta1.yaml", deps = [ ":phishingprotection_csharp_grpc", diff --git a/google/cloud/policytroubleshooter/v1/BUILD.bazel b/google/cloud/policytroubleshooter/v1/BUILD.bazel index a096be8a3..647ff9e37 100644 --- a/google/cloud/policytroubleshooter/v1/BUILD.bazel +++ b/google/cloud/policytroubleshooter/v1/BUILD.bazel @@ -68,6 +68,7 @@ java_gapic_library( name = "policytroubleshooter_java_gapic", srcs = [":policytroubleshooter_proto_with_info"], grpc_service_config = "checker_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":policytroubleshooter_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -129,6 +130,7 @@ go_gapic_library( srcs = [":policytroubleshooter_proto_with_info"], grpc_service_config = "checker_grpc_service_config.json", importpath = "cloud.google.com/go/policytroubleshooter/apiv1;policytroubleshooter", + rest_numeric_enums = True, service_yaml = "policytroubleshooter_v1.yaml", transport = "grpc+rest", deps = [ @@ -169,6 +171,7 @@ py_gapic_library( srcs = [":policytroubleshooter_proto"], grpc_service_config = "checker_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-policy-troubleshooter"], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -219,6 +222,8 @@ php_gapic_library( name = "policytroubleshooter_php_gapic", srcs = [":policytroubleshooter_proto_with_info"], grpc_service_config = "checker_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":policytroubleshooter_php_grpc", ":policytroubleshooter_php_proto", @@ -251,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "checker_grpc_service_config.json", package = "google.cloud.policytroubleshooter.v1", + rest_numeric_enums = True, service_yaml = "policytroubleshooter_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -296,6 +303,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/iam/docs/troubleshooting-access", ], grpc_service_config = "checker_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Policy Troubleshooter makes it easier to understand why a user has access to a resource or doesn't have permission to call an API. Given an email, resource, and permission, Policy Troubleshooter will examine all IAM policies that apply to the resource. It then reveals whether the member's roles include the permission on that resource and, if so, which policies bind the member to those roles.", ruby_cloud_title = "IAM Policy Troubleshooter V1", deps = [ @@ -341,6 +349,7 @@ csharp_gapic_library( srcs = [":policytroubleshooter_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "checker_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "policytroubleshooter_v1.yaml", deps = [ ":policytroubleshooter_csharp_grpc", diff --git a/google/cloud/privatecatalog/v1beta1/BUILD.bazel b/google/cloud/privatecatalog/v1beta1/BUILD.bazel index e224d2589..872db16b8 100644 --- a/google/cloud/privatecatalog/v1beta1/BUILD.bazel +++ b/google/cloud/privatecatalog/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "privatecatalog_java_gapic", srcs = [":privatecatalog_proto_with_info"], grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":privatecatalog_java_grpc", ], @@ -131,13 +132,14 @@ go_gapic_library( grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", importpath = "cloud.google.com/go/privatecatalog/apiv1beta1;privatecatalog", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudprivatecatalog_v1beta1.yaml", transport = "grpc+rest", deps = [ ":privatecatalog_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -179,6 +181,7 @@ py_gapic_library( "warehouse-package-name=google-cloud-private-catalog", "autogen-snippets", ], + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "privatecatalog_php_gapic", srcs = [":privatecatalog_proto_with_info"], grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudprivatecatalog_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":privatecatalog_php_grpc", ":privatecatalog_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", package = "google.cloud.privatecatalog.v1beta1", + rest_numeric_enums = True, service_yaml = "cloudprivatecatalog_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-yard-strict=false", ], grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "With Private Catalog, developers and cloud admins can make their solutions discoverable to their internal enterprise users. Cloud admins can manage their solutions and ensure their users are always launching the latest versions.", ruby_cloud_title = "Private Catalog V1beta1", deps = [ @@ -350,6 +358,7 @@ csharp_gapic_library( srcs = [":privatecatalog_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudprivatecatalog_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudprivatecatalog_v1beta1.yaml", deps = [ ":privatecatalog_csharp_grpc", diff --git a/google/cloud/pubsublite/v1/BUILD.bazel b/google/cloud/pubsublite/v1/BUILD.bazel index f7821df37..c12f17ef1 100644 --- a/google/cloud/pubsublite/v1/BUILD.bazel +++ b/google/cloud/pubsublite/v1/BUILD.bazel @@ -78,6 +78,7 @@ java_gapic_library( srcs = [":pubsublite_proto_with_info"], gapic_yaml = "gapic.yaml", grpc_service_config = "pubsublite_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":pubsublite_java_grpc", ], @@ -141,12 +142,14 @@ go_gapic_library( srcs = [":pubsublite_proto_with_info"], grpc_service_config = "pubsublite_grpc_service_config.json", importpath = "cloud.google.com/go/pubsublite/apiv1;pubsublite", + rest_numeric_enums = False, service_yaml = "pubsublite_v1.yaml", + transport = "grpc", deps = [ ":pubsublite_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -182,6 +185,7 @@ py_gapic_library( name = "pubsublite_py_gapic", srcs = [":pubsublite_proto"], grpc_service_config = "pubsublite_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -219,7 +223,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "pubsublite_grpc_service_config.json", package = "google.cloud.pubsublite.v1", + rest_numeric_enums = False, service_yaml = "pubsublite_v1.yaml", + transport = "grpc", deps = [], ) @@ -258,6 +264,7 @@ ruby_cloud_gapic_library( srcs = [":pubsublite_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-pubsublite-v1"], grpc_service_config = "pubsublite_grpc_service_config.json", + rest_numeric_enums = False, deps = [ ":pubsublite_ruby_grpc", ":pubsublite_ruby_proto", @@ -301,6 +308,7 @@ csharp_gapic_library( srcs = [":pubsublite_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "pubsublite_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "pubsublite_v1.yaml", deps = [ ":pubsublite_csharp_grpc", diff --git a/google/cloud/pubsublite/v1/admin.proto b/google/cloud/pubsublite/v1/admin.proto index 693df9371..34ce92aa7 100644 --- a/google/cloud/pubsublite/v1/admin.proto +++ b/google/cloud/pubsublite/v1/admin.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. diff --git a/google/cloud/pubsublite/v1/common.proto b/google/cloud/pubsublite/v1/common.proto index 2a2c62ccb..56d8e2fa3 100644 --- a/google/cloud/pubsublite/v1/common.proto +++ b/google/cloud/pubsublite/v1/common.proto @@ -20,7 +20,6 @@ import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; -import "google/rpc/status.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.PubSubLite.V1"; @@ -236,7 +235,7 @@ message Subscription { // Configuration for a Pub/Sub Lite subscription that writes messages to a // destination. User subscriber clients must not connect to this subscription. message ExportConfig { - // An export state. + // The desired export state. enum State { // Default value. This value is unused. STATE_UNSPECIFIED = 0; @@ -246,22 +245,12 @@ message ExportConfig { // Exporting messages is suspended. PAUSED = 2; - } - // The export status of a partition. - message PartitionStatus { - // The partition number. - int64 partition = 1; + // Messages cannot be exported due to permission denied errors. Output only. + PERMISSION_DENIED = 3; - // If the export for a partition is healthy and the desired state is - // `ACTIVE`, the status code will be `OK` (zero). If the desired state of - // the export is `PAUSED`, the status code will be `CANCELLED`. - // - // If the export has been suspended due to an error, the status will be - // populated with an error code and details. The service will automatically - // retry after a period of time, and will update the status code to `OK` if - // export subsequently succeeds. - google.rpc.Status status = 2; + // Messages cannot be exported due to missing resources. Output only. + NOT_FOUND = 4; } // Configuration for exporting to a Pub/Sub topic. @@ -272,11 +261,13 @@ message ExportConfig { string topic = 1; } - // The desired state of this export. + // The desired state of this export. Setting this to values other than + // `ACTIVE` and `PAUSED` will result in an error. State desired_state = 1; - // Output only. The export statuses of each partition. This field is output only. - repeated PartitionStatus statuses = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The current state of the export, which may be different to the desired + // state due to errors. + State current_state = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not // be exported to the destination. For example, the message can not be diff --git a/google/cloud/pubsublite/v1/cursor.proto b/google/cloud/pubsublite/v1/cursor.proto index f3cfc1693..d325a1661 100644 --- a/google/cloud/pubsublite/v1/cursor.proto +++ b/google/cloud/pubsublite/v1/cursor.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. diff --git a/google/cloud/pubsublite/v1/publisher.proto b/google/cloud/pubsublite/v1/publisher.proto index 27737ecc7..8adf9948b 100644 --- a/google/cloud/pubsublite/v1/publisher.proto +++ b/google/cloud/pubsublite/v1/publisher.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,8 +16,9 @@ syntax = "proto3"; package google.cloud.pubsublite.v1; -import "google/cloud/pubsublite/v1/common.proto"; +import "google/api/annotations.proto"; import "google/api/client.proto"; +import "google/cloud/pubsublite/v1/common.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.PubSubLite.V1"; diff --git a/google/cloud/pubsublite/v1/subscriber.proto b/google/cloud/pubsublite/v1/subscriber.proto index c8bb1655c..587ee5225 100644 --- a/google/cloud/pubsublite/v1/subscriber.proto +++ b/google/cloud/pubsublite/v1/subscriber.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,9 +16,10 @@ syntax = "proto3"; package google.cloud.pubsublite.v1; +import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/cloud/pubsublite/v1/common.proto"; -import "google/api/client.proto"; option cc_enable_arenas = true; option csharp_namespace = "Google.Cloud.PubSubLite.V1"; diff --git a/google/cloud/pubsublite/v1/topic_stats.proto b/google/cloud/pubsublite/v1/topic_stats.proto index d4ccc413a..80527f218 100644 --- a/google/cloud/pubsublite/v1/topic_stats.proto +++ b/google/cloud/pubsublite/v1/topic_stats.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. @@ -17,11 +17,11 @@ syntax = "proto3"; package google.cloud.pubsublite.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/pubsublite/v1/common.proto"; import "google/protobuf/timestamp.proto"; -import "google/api/client.proto"; option csharp_namespace = "Google.Cloud.PubSubLite.V1"; option go_package = "google.golang.org/genproto/googleapis/cloud/pubsublite/v1;pubsublite"; diff --git a/google/cloud/recaptchaenterprise/v1/BUILD.bazel b/google/cloud/recaptchaenterprise/v1/BUILD.bazel index c9e46b8ac..38131d28a 100644 --- a/google/cloud/recaptchaenterprise/v1/BUILD.bazel +++ b/google/cloud/recaptchaenterprise/v1/BUILD.bazel @@ -70,9 +70,11 @@ java_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], gapic_yaml = "recaptchaenterprise_gapic.yaml", grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":recaptchaenterprise_java_grpc", ], + transport = "grpc", deps = [ ":recaptchaenterprise_java_proto", ], @@ -90,6 +92,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-recaptchaenterprise-v1-java", include_samples = True, + transport = "grpc", deps = [ ":recaptchaenterprise_java_gapic", ":recaptchaenterprise_java_grpc", @@ -124,7 +127,9 @@ go_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", importpath = "cloud.google.com/go/recaptchaenterprise/apiv1;recaptchaenterprise", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1.yaml", + transport = "grpc", deps = [ ":recaptchaenterprise_go_proto", ], @@ -164,6 +169,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-recaptcha-enterprise", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -211,6 +217,8 @@ php_gapic_library( name = "recaptchaenterprise_php_gapic", srcs = [":recaptchaenterprise_proto_with_info"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":recaptchaenterprise_php_grpc", ":recaptchaenterprise_php_proto", @@ -243,7 +251,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", package = "google.cloud.recaptchaenterprise.v1", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1.yaml", + transport = "grpc", deps = [], ) @@ -288,6 +298,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=recaptchaenterprise", ], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "reCAPTCHA Enterprise is a service that protects your site from spam and abuse.", ruby_cloud_title = "reCAPTCHA Enterprise V1", deps = [ @@ -333,6 +344,7 @@ csharp_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1.yaml", deps = [ ":recaptchaenterprise_csharp_grpc", diff --git a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto index 7165d1bcc..12e5852d5 100644 --- a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto +++ b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto @@ -74,6 +74,17 @@ service RecaptchaEnterpriseService { }; } + // Returns the secret key related to the specified public key. + // You must use the legacy secret key only in a 3rd party integration with + // legacy reCAPTCHA. + rpc RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest) + returns (RetrieveLegacySecretKeyResponse) { + option (google.api.http) = { + get: "/v1/{key=projects/*/keys/*}:retrieveLegacySecretKey" + }; + option (google.api.method_signature) = "key"; + } + // Returns the specified key. rpc GetKey(GetKeyRequest) returns (Key) { option (google.api.http) = { @@ -127,7 +138,7 @@ service RecaptchaEnterpriseService { option (google.api.method_signature) = "parent"; } - // Get the memberships in a group of related accounts. + // Get memberships in a group of related accounts. rpc ListRelatedAccountGroupMemberships( ListRelatedAccountGroupMembershipsRequest) returns (ListRelatedAccountGroupMembershipsResponse) { @@ -193,21 +204,38 @@ message AnnotateAssessmentRequest { // Default unspecified reason. REASON_UNSPECIFIED = 0; - // Indicates a chargeback issued for the transaction with no other details. - // When possible, specify the type by using CHARGEBACK_FRAUD or + // Indicates that the transaction had a chargeback issued with no other + // details. When possible, specify the type by using CHARGEBACK_FRAUD or // CHARGEBACK_DISPUTE instead. CHARGEBACK = 1; - // Indicates a chargeback related to an alleged unauthorized transaction - // from the cardholder's perspective (for example, the card number was - // stolen). + // Indicates that the transaction had a chargeback issued related to an + // alleged unauthorized transaction from the cardholder's perspective (for + // example, the card number was stolen). CHARGEBACK_FRAUD = 8; - // Indicates a chargeback related to the cardholder having provided their - // card details but allegedly not being satisfied with the purchase - // (for example, misrepresentation, attempted cancellation). + // Indicates that the transaction had a chargeback issued related to the + // cardholder having provided their card details but allegedly not being + // satisfied with the purchase (for example, misrepresentation, attempted + // cancellation). CHARGEBACK_DISPUTE = 9; + // Indicates that the completed payment transaction was refunded by the + // seller. + REFUND = 10; + + // Indicates that the completed payment transaction was determined to be + // fraudulent by the seller, and was cancelled and refunded as a result. + REFUND_FRAUD = 11; + + // Indicates that the payment transaction was accepted, and the user was + // charged. + TRANSACTION_ACCEPTED = 12; + + // Indicates that the payment transaction was declined, for example due to + // invalid card details. + TRANSACTION_DECLINED = 13; + // Indicates the transaction associated with the assessment is suspected of // being fraudulent based on the payment method, billing details, shipping // address or other transaction information. @@ -230,6 +258,10 @@ message AnnotateAssessmentRequest { // Indicates the user provided an incorrect password. INCORRECT_PASSWORD = 6; + + // Indicates that the user sent unwanted and abusive messages to other users + // of the platform, such as spam, scams, phishing, or social engineering. + SOCIAL_SPAM = 14; } // Required. The resource name of the Assessment, in the format @@ -250,8 +282,8 @@ message AnnotateAssessmentRequest { // Event. repeated Reason reasons = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Optional unique stable hashed user identifier to apply to the - // assessment. This is an alternative to setting the hashed_account_id in + // Optional. Unique stable hashed user identifier to apply to the assessment. + // This is an alternative to setting the hashed_account_id in // CreateAssessment, for example when the account identifier is not yet known // in the initial request. It is recommended that the identifier is hashed // using hmac-sha256 with stable secret. @@ -261,6 +293,114 @@ message AnnotateAssessmentRequest { // Empty response for AnnotateAssessment. message AnnotateAssessmentResponse {} +// Information about a verification endpoint that can be used for 2FA. +message EndpointVerificationInfo { + oneof endpoint { + // Email address for which to trigger a verification request. + string email_address = 1; + + // Phone number for which to trigger a verification request. Should be given + // in E.164 format. + string phone_number = 2; + } + + // Output only. Token to provide to the client to trigger endpoint + // verification. It must be used within 15 minutes. + string request_token = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp of the last successful verification for the + // endpoint, if any. + google.protobuf.Timestamp last_verification_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Information about account verification, used for identity verification. +message AccountVerificationInfo { + // Result of the account verification as contained in the verdict token issued + // at the end of the verification flow. + enum Result { + // No information about the latest account verification. + RESULT_UNSPECIFIED = 0; + + // The user was successfully verified. This means the account verification + // challenge was successfully completed. + SUCCESS_USER_VERIFIED = 1; + + // The user failed the verification challenge. + ERROR_USER_NOT_VERIFIED = 2; + + // The site is not properly onboarded to use the account verification + // feature. + ERROR_SITE_ONBOARDING_INCOMPLETE = 3; + + // The recipient is not allowed for account verification. This can occur + // during integration but should not occur in production. + ERROR_RECIPIENT_NOT_ALLOWED = 4; + + // The recipient has already been sent too many verification codes in a + // short amount of time. + ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5; + + // The verification flow could not be completed due to a critical internal + // error. + ERROR_CRITICAL_INTERNAL = 6; + + // The client has exceeded their two factor request quota for this period of + // time. + ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7; + + // The request cannot be processed at the time because of an incident. This + // bypass can be restricted to a problematic destination email domain, a + // customer, or could affect the entire service. + ERROR_VERIFICATION_BYPASSED = 8; + + // The request parameters do not match with the token provided and cannot be + // processed. + ERROR_VERDICT_MISMATCH = 9; + } + + // Endpoints that can be used for identity verification. + repeated EndpointVerificationInfo endpoints = 1; + + // Language code preference for the verification message, set as a IETF BCP 47 + // language code. + string language_code = 3; + + // Output only. Result of the latest account verification challenge. + Result latest_verification_result = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Username of the account that is being verified. Deprecated. Customers + // should now provide the hashed account ID field in Event. + string username = 2 [deprecated = true]; +} + +// Private password leak verification info. +message PrivatePasswordLeakVerification { + // Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized + // username. It is used to look up password leaks associated with that hash + // prefix. + bytes lookup_hash_prefix = 1 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Encrypted Scrypt hash of the canonicalized username+password. It + // is re-encrypted by the server and returned through + // `reencrypted_user_credentials_hash`. + bytes encrypted_user_credentials_hash = 2 + [(google.api.field_behavior) = OPTIONAL]; + + // Output only. List of prefixes of the encrypted potential password leaks + // that matched the given parameters. They must be compared with the + // client-side decryption prefix of `reencrypted_user_credentials_hash` + repeated bytes encrypted_leak_match_prefixes = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Corresponds to the re-encryption of the + // `encrypted_user_credentials_hash` field. It is used to match potential + // password leaks within `encrypted_leak_match_prefixes`. + bytes reencrypted_user_credentials_hash = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} + // A recaptcha assessment resource. message Assessment { option (google.api.resource) = { @@ -282,11 +422,16 @@ message Assessment { TokenProperties token_properties = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Assessment returned by Account Defender when a hashed_account_id is + // Account verification information for identity verification. The assessment + // event must include a token and site key to use this feature. + AccountVerificationInfo account_verification = 5; + + // Assessment returned by account defender when a hashed_account_id is // provided. AccountDefenderAssessment account_defender_assessment = 6; - // Password leak verification info. + // The private password leak verification field contains the parameters that + // are used to to check for leaks privately without sharing user credentials. PrivatePasswordLeakVerification private_password_leak_verification = 8; } @@ -312,8 +457,8 @@ message Event { // already integrated with recaptcha enterprise. string expected_action = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Optional unique stable hashed user identifier for the request. - // The identifier should ideally be hashed using sha256 with stable secret. + // Optional. Unique stable hashed user identifier for the request. The + // identifier must be hashed using hmac-sha256 with stable secret. bytes hashed_account_id = 6 [(google.api.field_behavior) = OPTIONAL]; } @@ -390,16 +535,24 @@ message TokenProperties { // The timestamp corresponding to the generation of the token. google.protobuf.Timestamp create_time = 3; - // The hostname of the page on which the token was generated. + // The hostname of the page on which the token was generated (Web keys only). string hostname = 4; + // The name of the Android package with which the token was generated (Android + // keys only). + string android_package_name = 8; + + // The ID of the iOS bundle with which the token was generated (iOS keys + // only). + string ios_bundle_id = 9; + // Action name provided at token generation. string action = 5; } -// Account Defender risk assessment. +// Account defender risk assessment. message AccountDefenderAssessment { - // Labels returned by Account Defender for this request. + // Labels returned by account defender for this request. enum AccountDefenderLabel { // Default unspecified type. ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0; @@ -407,17 +560,17 @@ message AccountDefenderAssessment { // The request matches a known good profile for the user. PROFILE_MATCH = 1; - // The request is potentially a suspicious login event and should be further - // verified either via multi-factor authentication or another system. + // The request is potentially a suspicious login event and must be further + // verified either through multi-factor authentication or another system. SUSPICIOUS_LOGIN_ACTIVITY = 2; // The request matched a profile that previously had suspicious account - // creation behavior. This could mean this is a fake account. + // creation behavior. This can mean that this is a fake account. SUSPICIOUS_ACCOUNT_CREATION = 3; // The account in the request has a high number of related accounts. It does - // not necessarily imply that the account is bad but could require - // investigating. + // not necessarily imply that the account is bad but can require further + // investigation. RELATED_ACCOUNTS_NUMBER_HIGH = 4; } @@ -425,31 +578,6 @@ message AccountDefenderAssessment { repeated AccountDefenderLabel labels = 1; } -// Private password leak verification info. -message PrivatePasswordLeakVerification { - // Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It - // is used to look up password leaks associated with that hash prefix. - bytes lookup_hash_prefix = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Encrypted Scrypt hash of the canonicalized username+password. It is - // re-encrypted by the server and returned through - // `reencrypted_user_credentials_hash`. - bytes encrypted_user_credentials_hash = 2 - [(google.api.field_behavior) = OPTIONAL]; - - // List of prefixes of the encrypted potential password leaks that matched the - // given parameters. They should be compared with the client-side decryption - // prefix of `reencrypted_user_credentials_hash` - repeated bytes encrypted_leak_match_prefixes = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Corresponds to the re-encryption of the `encrypted_user_credentials_hash` - // field. Used to match potential password leaks within - // `encrypted_leak_match_prefixes`. - bytes reencrypted_user_credentials_hash = 4 - [(google.api.field_behavior) = OUTPUT_ONLY]; -} - // The create key request message. message CreateKeyRequest { // Required. The name of the project in which the key will be created, in the @@ -495,6 +623,18 @@ message ListKeysResponse { string next_page_token = 2; } +// The retrieve legacy secret key request message. +message RetrieveLegacySecretKeyRequest { + // Required. The public key name linked to the requested secret key in the + // format "projects/{project}/keys/{key}". + string key = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "recaptchaenterprise.googleapis.com/Key" + } + ]; +} + // The get key request message. message GetKeyRequest { // Required. The name of the requested key, in the format @@ -540,6 +680,16 @@ message MigrateKeyRequest { type: "recaptchaenterprise.googleapis.com/Key" } ]; + + // Optional. If true, skips the billing check. + // A reCAPTCHA Enterprise key or migrated key behaves differently than a + // reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see + // https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid + // any disruption of your usage, we check that a billing account is present. + // If your usage of reCAPTCHA is under the free quota, you can safely skip the + // billing check and proceed with the migration. See + // https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + bool skip_billing_check = 2 [(google.api.field_behavior) = OPTIONAL]; } // The get metrics request message. @@ -578,6 +728,16 @@ message Metrics { repeated ChallengeMetrics challenge_metrics = 3; } +// Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party +// integration with legacy reCAPTCHA. +message RetrieveLegacySecretKeyResponse { + // The secret key (also known as shared secret) authorizes communication + // between your application backend and the reCAPTCHA Enterprise server to + // create an assessment. + // The secret key needs to be kept safe for security purposes. + string legacy_secret_key = 1; +} + // A key used to identify and configure applications (web and/or mobile) that // use reCAPTCHA Enterprise. message Key { @@ -593,8 +753,8 @@ message Key { // Human-readable display name of this key. Modifiable by user. string display_name = 2; - // Platform specific settings for this key. The key can only be used on one - // platform, the one it has settings for. + // Platform specific settings for this key. The key can only be used on a + // platform for which the settings are enabled. oneof platform_settings { // Settings for keys that can be used by websites. WebKeySettings web_settings = 3; @@ -743,7 +903,6 @@ message ScoreMetrics { // Action-based metrics. The map key is the action name which specified by the // site owners at time of the "execute" client-side call. - // Populated only for SCORE keys. map action_metrics = 2; } @@ -777,10 +936,9 @@ message ListRelatedAccountGroupMembershipsRequest { } ]; - // Optional. The maximum number of accounts to return. The service may return - // fewer than this value. If unspecified, at most 50 accounts will be - // returned. The maximum value is 1000; values above 1000 will be coerced to - // 1000. + // Optional. The maximum number of accounts to return. The service might + // return fewer than this value. If unspecified, at most 50 accounts are + // returned. The maximum value is 1000; values above 1000 are coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A page token, received from a previous @@ -813,9 +971,9 @@ message ListRelatedAccountGroupsRequest { } ]; - // Optional. The maximum number of groups to return. The service may return - // fewer than this value. If unspecified, at most 50 groups will be returned. - // The maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. The maximum number of groups to return. The service might return + // fewer than this value. If unspecified, at most 50 groups are returned. The + // maximum value is 1000; values above 1000 are coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. A page token, received from a previous `ListRelatedAccountGroups` @@ -840,7 +998,8 @@ message ListRelatedAccountGroupsResponse { // The request message to search related account group memberships. message SearchRelatedAccountGroupMembershipsRequest { // Required. The name of the project to search related account group - // memberships from, in the format "projects/{project}". + // memberships from. Specify the project name in the following format: + // "projects/{project}". string project = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -850,12 +1009,12 @@ message SearchRelatedAccountGroupMembershipsRequest { // Optional. The unique stable hashed user identifier we should search // connections to. The identifier should correspond to a `hashed_account_id` - // provided in a previous CreateAssessment or AnnotateAssessment call. + // provided in a previous `CreateAssessment` or `AnnotateAssessment` call. bytes hashed_account_id = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The maximum number of groups to return. The service may return - // fewer than this value. If unspecified, at most 50 groups will be returned. - // The maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. The maximum number of groups to return. The service might return + // fewer than this value. If unspecified, at most 50 groups are returned. The + // maximum value is 1000; values above 1000 are coerced to 1000. int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. A page token, received from a previous @@ -896,7 +1055,7 @@ message RelatedAccountGroupMembership { // The unique stable hashed user identifier of the member. The identifier // corresponds to a `hashed_account_id` provided in a previous - // CreateAssessment or AnnotateAssessment call. + // `CreateAssessment` or `AnnotateAssessment` call. bytes hashed_account_id = 2; } @@ -951,4 +1110,4 @@ message WafSettings { // Required. The WAF feature for which this key is enabled. WafFeature waf_feature = 2 [(google.api.field_behavior) = REQUIRED]; -} +} \ No newline at end of file diff --git a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml index aa45595c8..ed7fab727 100644 --- a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml +++ b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml @@ -6,9 +6,18 @@ title: reCAPTCHA Enterprise API apis: - name: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService +documentation: + summary: |- + Help protect your website from fraudulent activity, spam, and abuse without + creating friction. + overview: reCAPTCHA Enterprise Overview + authentication: rules: - selector: 'google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.*' oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/cloud/recaptchaenterprise/v1beta1/BUILD.bazel b/google/cloud/recaptchaenterprise/v1beta1/BUILD.bazel index 302d7bfde..a3a8eda93 100644 --- a/google/cloud/recaptchaenterprise/v1beta1/BUILD.bazel +++ b/google/cloud/recaptchaenterprise/v1beta1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], gapic_yaml = "recaptchaenterprise_gapic.yaml", grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":recaptchaenterprise_java_grpc", ], @@ -127,6 +128,7 @@ go_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", importpath = "cloud.google.com/go/recaptchaenterprise/apiv1beta1;recaptchaenterprise", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-recaptcha-enterprise", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -215,6 +218,8 @@ php_gapic_library( name = "recaptchaenterprise_php_gapic", srcs = [":recaptchaenterprise_proto_with_info"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":recaptchaenterprise_php_grpc", ":recaptchaenterprise_php_proto", @@ -247,7 +252,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", package = "google.cloud.recaptchaenterprise.v1beta1", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=RecaptchaEnterpriseServiceV1Beta1=RecaptchaEnterpriseService", ], grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "reCAPTCHA Enterprise is a service that protects your site from spam and abuse.", ruby_cloud_title = "reCAPTCHA Enterprise V1beta1", deps = [ @@ -338,6 +346,7 @@ csharp_gapic_library( srcs = [":recaptchaenterprise_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "recaptchaenterprise_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recaptchaenterprise_v1beta1.yaml", deps = [ ":recaptchaenterprise_csharp_grpc", diff --git a/google/cloud/recommendationengine/v1beta1/BUILD.bazel b/google/cloud/recommendationengine/v1beta1/BUILD.bazel index 3e8aaaee2..c77efa5ee 100644 --- a/google/cloud/recommendationengine/v1beta1/BUILD.bazel +++ b/google/cloud/recommendationengine/v1beta1/BUILD.bazel @@ -92,6 +92,7 @@ java_gapic_library( srcs = [":recommendationengine_proto_with_info"], gapic_yaml = "recommendationengine_gapic.yaml", grpc_service_config = "recommendationengine_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":recommendationengine_java_grpc", ], @@ -149,13 +150,15 @@ go_gapic_library( srcs = [":recommendationengine_proto_with_info"], grpc_service_config = "recommendationengine_grpc_service_config.json", importpath = "cloud.google.com/go/recommendationengine/apiv1beta1;recommendationengine", + rest_numeric_enums = True, + transport = "grpc+rest", service_yaml = "recommendationengine_v1beta1.yaml", deps = [ ":recommendationengine_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -182,6 +185,7 @@ py_gapic_library( srcs = [":recommendationengine_proto"], grpc_service_config = "recommendationengine_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-recommendations-ai"], + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -219,7 +223,9 @@ php_gapic_library( srcs = [":recommendationengine_proto_with_info"], gapic_yaml = "recommendationengine_gapic.yaml", grpc_service_config = "recommendationengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommendationengine_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":recommendationengine_php_grpc", ":recommendationengine_php_proto", @@ -242,7 +248,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "recommendationengine_grpc_service_config.json", package = "google.cloud.recommendationengine.v1beta1", + rest_numeric_enums = True, service_yaml = "recommendationengine_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -276,6 +284,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=recommendationengine", ], grpc_service_config = "recommendationengine_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Recommendations AI enables you to build an end-to-end personalized recommendation system based on state-of-the-art deep learning ML models, without a need for expertise in ML or recommendation systems.", ruby_cloud_title = "Recommendations AI V1beta1", deps = [ @@ -310,6 +319,7 @@ csharp_gapic_library( srcs = [":recommendationengine_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "recommendationengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommendationengine_v1beta1.yaml", deps = [ ":recommendationengine_csharp_grpc", diff --git a/google/cloud/recommendationengine/v1beta1/catalog_service.proto b/google/cloud/recommendationengine/v1beta1/catalog_service.proto index 73104424e..30a63e622 100644 --- a/google/cloud/recommendationengine/v1beta1/catalog_service.proto +++ b/google/cloud/recommendationengine/v1beta1/catalog_service.proto @@ -169,7 +169,7 @@ message ListCatalogItemsResponse { // Request message for UpdateCatalogItem method. message UpdateCatalogItemRequest { // Required. Full resource name of catalog item, such as - // "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". + // `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/recommender/v1/BUILD.bazel b/google/cloud/recommender/v1/BUILD.bazel index 803c6f717..96c42d7e9 100644 --- a/google/cloud/recommender/v1/BUILD.bazel +++ b/google/cloud/recommender/v1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":recommender_proto_with_info"], gapic_yaml = None, grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", test_deps = [ ":recommender_java_grpc", @@ -137,6 +138,7 @@ go_gapic_library( grpc_service_config = "recommender_grpc_service_config.json", importpath = "cloud.google.com/go/recommender/apiv1;recommender", metadata = True, + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", transport = "grpc+rest", deps = [ @@ -177,6 +179,7 @@ py_gapic_library( name = "recommender_py_gapic", srcs = [":recommender_proto"], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", transport = "grpc", ) @@ -225,7 +228,9 @@ php_gapic_library( name = "recommender_php_gapic", srcs = [":recommender_proto_with_info"], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", + transport = "grpc+rest", deps = [ ":recommender_php_grpc", ":recommender_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "recommender_grpc_service_config.json", package = "google.cloud.recommender.v1", + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -303,6 +310,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/recommender", ], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Recommender is a service on Google Cloud that provides usage recommendations for Cloud products and services.", ruby_cloud_title = "Recommender V1", service_yaml = "recommender_v1.yaml", @@ -349,6 +357,7 @@ csharp_gapic_library( srcs = [":recommender_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1.yaml", deps = [ ":recommender_csharp_grpc", diff --git a/google/cloud/recommender/v1beta1/BUILD.bazel b/google/cloud/recommender/v1beta1/BUILD.bazel index 0281a6ed5..78a81638b 100644 --- a/google/cloud/recommender/v1beta1/BUILD.bazel +++ b/google/cloud/recommender/v1beta1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":recommender_proto_with_info"], gapic_yaml = "recommender_gapic.yaml", grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", test_deps = [ ":recommender_java_grpc", @@ -137,6 +138,7 @@ go_gapic_library( grpc_service_config = "recommender_grpc_service_config.json", importpath = "cloud.google.com/go/recommender/apiv1beta1;recommender", metadata = True, + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -177,6 +179,7 @@ py_gapic_library( name = "recommender_py_gapic", srcs = [":recommender_proto"], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", transport = "grpc", ) @@ -225,7 +228,9 @@ php_gapic_library( name = "recommender_php_gapic", srcs = [":recommender_proto_with_info"], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":recommender_php_grpc", ":recommender_php_proto", @@ -258,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "recommender_grpc_service_config.json", package = "google.cloud.recommender.v1beta1", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -297,6 +304,7 @@ ruby_cloud_gapic_library( srcs = [":recommender_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-recommender-v1beta1"], grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", deps = [ ":recommender_ruby_grpc", @@ -341,6 +349,7 @@ csharp_gapic_library( srcs = [":recommender_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "recommender_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "recommender_v1beta1.yaml", deps = [ ":recommender_csharp_grpc", diff --git a/google/cloud/redis/v1/BUILD.bazel b/google/cloud/redis/v1/BUILD.bazel index f5d751113..e3be79c01 100644 --- a/google/cloud/redis/v1/BUILD.bazel +++ b/google/cloud/redis/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":redis_proto_with_info"], gapic_yaml = "redis_gapic.yaml", grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1.yaml", test_deps = [ ":redis_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "redis_grpc_service_config.json", importpath = "cloud.google.com/go/redis/apiv1;redis", metadata = True, + rest_numeric_enums = True, service_yaml = "redis_v1.yaml", transport = "grpc+rest", deps = [ ":redis_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -179,6 +181,7 @@ py_gapic_library( name = "redis_py_gapic", srcs = [":redis_proto"], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "redis_php_gapic", srcs = [":redis_proto_with_info"], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1.yaml", + transport = "grpc+rest", deps = [ ":redis_php_grpc", ":redis_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "redis_grpc_service_config.json", package = "google.cloud.redis.v1", + rest_numeric_enums = True, service_yaml = "redis_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -304,6 +311,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/redis", ], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Creates and manages Redis instances on the Google Cloud Platform.", ruby_cloud_title = "Google Cloud Memorystore for Redis V1", deps = [ @@ -349,6 +357,7 @@ csharp_gapic_library( srcs = [":redis_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1.yaml", deps = [ ":redis_csharp_grpc", diff --git a/google/cloud/redis/v1beta1/BUILD.bazel b/google/cloud/redis/v1beta1/BUILD.bazel index cb8d388c7..45cf16be0 100644 --- a/google/cloud/redis/v1beta1/BUILD.bazel +++ b/google/cloud/redis/v1beta1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":redis_proto_with_info"], gapic_yaml = "redis_gapic.yaml", grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1beta1.yaml", test_deps = [ ":redis_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "redis_grpc_service_config.json", importpath = "cloud.google.com/go/redis/apiv1beta1;redis", metadata = True, + rest_numeric_enums = True, service_yaml = "redis_v1beta1.yaml", transport = "grpc+rest", deps = [ ":redis_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -179,6 +181,7 @@ py_gapic_library( name = "redis_py_gapic", srcs = [":redis_proto"], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -226,7 +229,9 @@ php_gapic_library( name = "redis_php_gapic", srcs = [":redis_proto_with_info"], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":redis_php_grpc", ":redis_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "redis_grpc_service_config.json", package = "google.cloud.redis.v1beta1", + rest_numeric_enums = True, service_yaml = "redis_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -304,6 +311,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/memorystore/docs/redis", ], grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Creates and manages Redis instances on the Google Cloud Platform.", ruby_cloud_title = "Google Cloud Memorystore for Redis V1beta1", deps = [ @@ -349,6 +357,7 @@ csharp_gapic_library( srcs = [":redis_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "redis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "redis_v1beta1.yaml", deps = [ ":redis_csharp_grpc", diff --git a/google/cloud/resourcemanager/v3/BUILD.bazel b/google/cloud/resourcemanager/v3/BUILD.bazel index c3432b447..c768e980d 100644 --- a/google/cloud/resourcemanager/v3/BUILD.bazel +++ b/google/cloud/resourcemanager/v3/BUILD.bazel @@ -78,6 +78,7 @@ java_gapic_library( name = "resourcemanager_java_gapic", srcs = [":resourcemanager_proto_with_info"], grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":resourcemanager_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -150,14 +151,15 @@ go_gapic_library( grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", importpath = "cloud.google.com/go/resourcemanager/apiv3;resourcemanager", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudresourcemanager_v3.yaml", transport = "grpc+rest", deps = [ ":resourcemanager_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -193,10 +195,14 @@ py_gapic_library( name = "resourcemanager_py_gapic", srcs = [":resourcemanager_proto"], grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", ], + opt_args = [ + "warehouse-package-name=google-cloud-resource-manager", + ], ) py_test( @@ -243,7 +249,9 @@ php_gapic_library( name = "resourcemanager_php_gapic", srcs = [":resourcemanager_proto_with_info"], grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudresourcemanager_v3.yaml", + transport = "grpc+rest", deps = [ ":resourcemanager_php_grpc", ":resourcemanager_php_proto", @@ -276,7 +284,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", package = "google.cloud.resourcemanager.v3", + rest_numeric_enums = True, service_yaml = "cloudresourcemanager_v3.yaml", + transport = "grpc+rest", deps = [], ) @@ -321,6 +331,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudresourcemanager", ], grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Cloud provides container resources such as organizations and projects that allow you to group and hierarchically organize other Google Cloud resources. This hierarchical organization helps you manage common aspects of your resources, such as access control and configuration settings. The Resource Manager API enables you to programmatically manage these container resources.", ruby_cloud_title = "Resource Manager V3", deps = [ @@ -366,6 +377,7 @@ csharp_gapic_library( srcs = [":resourcemanager_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudresourcemanager_v3_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudresourcemanager_v3.yaml", deps = [ ":resourcemanager_csharp_grpc", diff --git a/google/cloud/resourcesettings/v1/BUILD.bazel b/google/cloud/resourcesettings/v1/BUILD.bazel index 1deca3bb8..d58a2e81d 100644 --- a/google/cloud/resourcesettings/v1/BUILD.bazel +++ b/google/cloud/resourcesettings/v1/BUILD.bazel @@ -65,6 +65,7 @@ java_gapic_library( name = "resourcesettings_java_gapic", srcs = [":resourcesettings_proto_with_info"], grpc_service_config = "resourcesettings_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":resourcesettings_java_grpc", ], @@ -123,6 +124,7 @@ go_gapic_library( grpc_service_config = "resourcesettings_grpc_service_config.json", importpath = "cloud.google.com/go/resourcesettings/apiv1;resourcesettings", metadata = True, + rest_numeric_enums = True, service_yaml = "resourcesettings_v1.yaml", transport = "grpc+rest", deps = [ @@ -163,6 +165,7 @@ py_gapic_library( srcs = [":resourcesettings_proto"], grpc_service_config = "resourcesettings_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-resource-settings"], + rest_numeric_enums = True, transport = "grpc", ) @@ -210,7 +213,9 @@ php_gapic_library( name = "resourcesettings_php_gapic", srcs = [":resourcesettings_proto_with_info"], grpc_service_config = "resourcesettings_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "resourcesettings_v1.yaml", + transport = "grpc+rest", deps = [ ":resourcesettings_php_grpc", ":resourcesettings_php_proto", @@ -243,7 +248,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "resourcesettings_grpc_service_config.json", package = "google.cloud.resourcesettings.v1", + rest_numeric_enums = True, service_yaml = "resourcesettings_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -288,6 +295,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=resourcesettings", ], grpc_service_config = "resourcesettings_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "You can use Resource Settings to centrally configure settings for your Google Cloud projects, folders, and organization. These settings are inherited by their descendants in the resource hierarchy. Each setting is created and managed by Google.", ruby_cloud_title = "Resource Settings V1", deps = [ @@ -333,6 +341,7 @@ csharp_gapic_library( srcs = [":resourcesettings_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "resourcesettings_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "resourcesettings_v1.yaml", deps = [ ":resourcesettings_csharp_grpc", diff --git a/google/cloud/retail/logging/error_log.proto b/google/cloud/retail/logging/error_log.proto index 1286ea845..b0944768d 100644 --- a/google/cloud/retail/logging/error_log.proto +++ b/google/cloud/retail/logging/error_log.proto @@ -59,9 +59,9 @@ message ErrorContext { SourceLocation report_location = 2; } -// The error payload that is populated on LRO import APIs. Including: -// "google.cloud.retail.v2.ProductService.ImportProducts" -// "google.cloud.retail.v2.EventService.ImportUserEvents" +// The error payload that is populated on LRO import APIs, including +// "google.cloud.retail.v2.ProductService.ImportProducts" and +// "google.cloud.retail.v2.EventService.ImportUserEvents". message ImportErrorContext { // The operation resource name of the LRO. string operation_name = 1; diff --git a/google/cloud/retail/v2/BUILD.bazel b/google/cloud/retail/v2/BUILD.bazel index 73aaf11dc..30069db32 100644 --- a/google/cloud/retail/v2/BUILD.bazel +++ b/google/cloud/retail/v2/BUILD.bazel @@ -93,6 +93,7 @@ java_gapic_library( srcs = [":retail_proto_with_info"], gapic_yaml = None, grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2.yaml", test_deps = [ ":retail_java_grpc", @@ -171,13 +172,14 @@ go_gapic_library( grpc_service_config = "retail_grpc_service_config.json", importpath = "cloud.google.com/go/retail/apiv2;retail", metadata = True, + rest_numeric_enums = True, service_yaml = "retail_v2.yaml", deps = [ ":retail_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -215,6 +217,7 @@ py_gapic_library( name = "retail_py_gapic", srcs = [":retail_proto"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -262,7 +265,9 @@ php_gapic_library( name = "retail_php_gapic", srcs = [":retail_proto_with_info"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2.yaml", + transport = "grpc+rest", deps = [ ":retail_php_grpc", ":retail_php_proto", @@ -294,10 +299,12 @@ nodejs_gapic_library( src = ":retail_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "retail_grpc_service_config.json", + mixins = "google.longrunning.Operations;google.cloud.location.Locations", package = "google.cloud.retail.v2", + rest_numeric_enums = True, service_yaml = "retail_v2.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -341,6 +348,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/retail/docs/apis", ], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Retail enables you to build an end-to-end personalized recommendation system based on state-of-the-art deep learning ML models, without a need for expertise in ML or recommendation systems.", ruby_cloud_title = "Retail V2", deps = [ @@ -386,6 +394,7 @@ csharp_gapic_library( srcs = [":retail_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2.yaml", deps = [ ":retail_csharp_grpc", diff --git a/google/cloud/retail/v2/catalog.proto b/google/cloud/retail/v2/catalog.proto index 0e1b85f6a..156e061ec 100644 --- a/google/cloud/retail/v2/catalog.proto +++ b/google/cloud/retail/v2/catalog.proto @@ -104,8 +104,7 @@ message CatalogAttribute { // The status of the indexable option of a catalog attribute. enum IndexableOption { - // Value used when unset. Defaults to - // [INDEXABLE_ENABLED][google.cloud.retail.v2.CatalogAttribute.IndexableOption.INDEXABLE_ENABLED]. + // Value used when unset. INDEXABLE_OPTION_UNSPECIFIED = 0; // Indexable option enabled for an attribute. @@ -117,8 +116,7 @@ message CatalogAttribute { // The status of the dynamic facetable option of a catalog attribute. enum DynamicFacetableOption { - // Value used when unset. Defaults to - // [DYNAMIC_FACETABLE_ENABLED][google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED]. + // Value used when unset. DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0; // Dynamic facetable option enabled for an attribute. @@ -130,8 +128,7 @@ message CatalogAttribute { // The status of the searchable option of a catalog attribute. enum SearchableOption { - // Value used when unset. Defaults to - // [SEARCHABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.SearchableOption.SEARCHABLE_DISABLED]. + // Value used when unset. SEARCHABLE_OPTION_UNSPECIFIED = 0; // Searchable option enabled for an attribute. @@ -141,6 +138,32 @@ message CatalogAttribute { SEARCHABLE_DISABLED = 2; } + // The status of the exact-searchable option of a catalog attribute. + enum ExactSearchableOption { + // Value used when unset. Defaults to + // [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED]. + EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0; + + // Exact searchable option enabled for an attribute. + EXACT_SEARCHABLE_ENABLED = 1; + + // Exact searchable option disabled for an attribute. + EXACT_SEARCHABLE_DISABLED = 2; + } + + // The status of the retrievable option of a catalog attribute. + enum RetrievableOption { + // Value used when unset. Defaults to + // [RETRIEVABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED]. + RETRIEVABLE_OPTION_UNSPECIFIED = 0; + + // Retrievable option enabled for an attribute. + RETRIEVABLE_ENABLED = 1; + + // Retrievable option disabled for an attribute. + RETRIEVABLE_DISABLED = 2; + } + // Required. Attribute name. // For example: `color`, `brands`, `attributes.custom_attribute`, such as // `attributes.xyz`. @@ -164,13 +187,13 @@ message CatalogAttribute { // APIs. This field is `False` for pre-loaded // [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s. // - // Only pre-loaded - // [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s that are - // neither in use by products nor predefined can be deleted. - // [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]s that are - // either in use by products or are predefined cannot be deleted; however, - // their configuration properties will reset to default values upon removal - // request. + // Only pre-loaded [catalog + // attributes][google.cloud.retail.v2.CatalogAttribute] that are neither in + // use by products nor predefined can be deleted. [Catalog + // attributes][google.cloud.retail.v2.CatalogAttribute] that are + // either in use by products or are predefined attributes cannot be deleted; + // however, their configuration properties will reset to default values upon + // removal request. // // After catalog changes, it takes about 10 minutes for this field to update. bool in_use = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -184,12 +207,16 @@ message CatalogAttribute { // is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in // [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. + // + // Must be specified, otherwise throws INVALID_FORMAT error. IndexableOption indexable_option = 5; // If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic // facet. Could only be DYNAMIC_FACETABLE_DISABLED if // [CatalogAttribute.indexable_option][google.cloud.retail.v2.CatalogAttribute.indexable_option] // is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. + // + // Must be specified, otherwise throws INVALID_FORMAT error. DynamicFacetableOption dynamic_facetable_option = 6; // When @@ -202,7 +229,18 @@ message CatalogAttribute { // will not be searchable by text queries in // [SearchService.Search][google.cloud.retail.v2.SearchService.Search], as // there are no text values associated to numerical attributes. + // + // Must be specified, otherwise throws INVALID_FORMAT error. SearchableOption searchable_option = 7; + + // If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. + // This property only applies to textual custom attributes and requires + // indexable set to enabled to enable exact-searchable. + ExactSearchableOption exact_searchable_option = 11; + + // If RETRIEVABLE_ENABLED, attribute values are retrievable in the search + // results. + RetrievableOption retrievable_option = 12; } // Catalog level attribute config. diff --git a/google/cloud/retail/v2/catalog_service.proto b/google/cloud/retail/v2/catalog_service.proto index 4d667d1f9..da6f5a2b8 100644 --- a/google/cloud/retail/v2/catalog_service.proto +++ b/google/cloud/retail/v2/catalog_service.proto @@ -339,7 +339,7 @@ message GetDefaultBranchResponse { // method. message GetCompletionConfigRequest { // Required. Full CompletionConfig resource name. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/retail/v2/common.proto b/google/cloud/retail/v2/common.proto index 9864ee7d6..5db569dd8 100644 --- a/google/cloud/retail/v2/common.proto +++ b/google/cloud/retail/v2/common.proto @@ -83,8 +83,8 @@ message Condition { // Value cannot be empty. // Value can have at most 3 terms if specified as a partial match. Each // space separated string is considered as one term. - // Example) "a b c" is 3 terms and allowed, " a b c d" is 4 terms and not - // allowed for partial match. + // For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms + // and not allowed for a partial match. string value = 1; // Whether this is supposed to be a full or partial match. @@ -113,6 +113,7 @@ message Condition { } // A rule is a condition-action pair +// // * A condition defines when a rule is to be triggered. // * An action specifies what occurs on that trigger. // Currently rules only work for [controls][google.cloud.retail.v2.Control] with @@ -201,7 +202,8 @@ message Rule { } // Creates a set of terms that will be treated as synonyms of each other. - // Example: synonyms of "sneakers" and "shoes". + // Example: synonyms of "sneakers" and "shoes": + // // * "sneakers" will use a synonym of "shoes". // * "shoes" will use a synonym of "sneakers". message TwowaySynonymsAction { diff --git a/google/cloud/retail/v2/completion_service.proto b/google/cloud/retail/v2/completion_service.proto index af0fac87e..86493f8a2 100644 --- a/google/cloud/retail/v2/completion_service.proto +++ b/google/cloud/retail/v2/completion_service.proto @@ -36,7 +36,7 @@ option ruby_package = "Google::Cloud::Retail::V2"; // Auto-completion service for retail. // // This feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this feature. +// Enable Retail Search on Cloud Console before using this feature. service CompletionService { option (google.api.default_host) = "retail.googleapis.com"; option (google.api.oauth_scopes) = @@ -45,7 +45,7 @@ service CompletionService { // Completes the specified prefix with keyword suggestions. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) { option (google.api.http) = { get: "/v2/{catalog=projects/*/locations/*/catalogs/*}:completeQuery" @@ -60,7 +60,7 @@ service CompletionService { // are indexed successfully and ready for serving. The process takes hours. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc ImportCompletionData(ImportCompletionDataRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -110,8 +110,10 @@ message CompleteQueryRequest { // number of language codes is 3. repeated string language_codes = 3; - // The device type context for completion suggestions. - // It is useful to apply different suggestions on different device types, e.g. + // The device type context for completion suggestions. We recommend that you + // leave this field empty. + // + // It can apply different suggestions on different device types, e.g. // `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device // types. // diff --git a/google/cloud/retail/v2/control.proto b/google/cloud/retail/v2/control.proto index 5558e44dd..4dc94aa38 100644 --- a/google/cloud/retail/v2/control.proto +++ b/google/cloud/retail/v2/control.proto @@ -60,9 +60,8 @@ message Control { // characters. Otherwise, an INVALID_ARGUMENT error is thrown. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Output only. List of [serving - // configuration][google.cloud.retail.v2.ServingConfig] ids that are - // associated with this control in the same + // Output only. List of [serving config][google.cloud.retail.v2.ServingConfig] + // ids that are associated with this control in the same // [Catalog][google.cloud.retail.v2.Catalog]. // // Note the association is managed via the diff --git a/google/cloud/retail/v2/prediction_service.proto b/google/cloud/retail/v2/prediction_service.proto index 717405b2b..48b46bc81 100644 --- a/google/cloud/retail/v2/prediction_service.proto +++ b/google/cloud/retail/v2/prediction_service.proto @@ -19,6 +19,7 @@ package google.cloud.retail.v2; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; import "google/cloud/retail/v2/user_event.proto"; import "google/protobuf/struct.proto"; @@ -61,7 +62,7 @@ message PredictRequest { // The ID of the Recommendations AI serving config or placement. // Before you can request predictions from your model, you must create at // least one serving config or placement for it. For more information, see - // [Managing serving configurations] + // [Manage serving configs] // (https://cloud.google.com/retail/docs/manage-configs). // // The full list of available serving configs can be seen at @@ -116,12 +117,11 @@ message PredictRequest { // * filterOutOfStockItems tag=(-"promotional") // * filterOutOfStockItems // - // If your filter blocks all prediction results, the API will return generic - // (unfiltered) popular products. If you only want results strictly matching - // the filters, set `strictFiltering` to True in `PredictRequest.params` to - // receive empty results instead. - // Note that the API will never return items with storageStatus of "EXPIRED" - // or "DELETED" regardless of filter choices. + // If your filter blocks all prediction results, the API will return *no* + // results. If instead you want empty result sets to return generic + // (unfiltered) popular products, set `strictFiltering` to False in + // `PredictRequest.params`. Note that the API will never return items with + // storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. // // If `filterSyntaxV2` is set to true under the `params` field, then // attribute-based expressions are expected instead of the above described @@ -148,7 +148,7 @@ message PredictRequest { // * `returnScore`: Boolean. If set to true, the prediction 'score' // corresponding to each returned product will be set in the // `results.metadata` field in the prediction response. The given - // 'score' indicates the probability of an product being clicked/purchased + // 'score' indicates the probability of a product being clicked/purchased // given the user's context and history. // * `strictFiltering`: Boolean. True by default. If set to false, the service // will return generic (unfiltered) popular products instead of empty if diff --git a/google/cloud/retail/v2/product.proto b/google/cloud/retail/v2/product.proto index fe5d212cf..5d61470d3 100644 --- a/google/cloud/retail/v2/product.proto +++ b/google/cloud/retail/v2/product.proto @@ -104,7 +104,13 @@ message Product { oneof expiration { // The timestamp when this product becomes unavailable for - // [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. + // [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. Note + // that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and + // ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. + // In general, we suggest the users to delete the stale products explicitly, + // instead of using this field to determine staleness. // // If it is set, the [Product][google.cloud.retail.v2.Product] is not // available for @@ -124,7 +130,13 @@ message Product { // [expiration_date](https://support.google.com/merchants/answer/6324499). google.protobuf.Timestamp expire_time = 16; - // Input only. The TTL (time to live) of the product. + // Input only. The TTL (time to live) of the product. Note that this is only + // applicable to [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] + // and [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], + // and ignored for + // [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. In general, + // we suggest the users to delete the stale products explicitly, instead of + // using this field to determine staleness. // // If it is set, it must be a non-negative value, and // [expire_time][google.cloud.retail.v2.Product.expire_time] is set as @@ -226,7 +238,7 @@ message Product { // // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // For example, if a shoes product belongs to both @@ -356,7 +368,11 @@ message Product { // The timestamp when this [Product][google.cloud.retail.v2.Product] becomes // available for - // [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. + // [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. Note + // that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and + // ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. google.protobuf.Timestamp available_time = 18; // The online availability of the [Product][google.cloud.retail.v2.Product]. @@ -542,7 +558,9 @@ message Product { // Note: Returning more fields in // [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase // response payload size and serving latency. - google.protobuf.FieldMask retrievable_fields = 30; + // + // This field is deprecated. Use the retrievable site-wide control instead. + google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; // Output only. Product variants grouped together on primary product which // share similar product attributes. It's automatically grouped by @@ -559,7 +577,11 @@ message Product { // Output only. A list of local inventories specific to different places. // // This is only available for users who have Retail Search enabled, and it can - // be managed by [AddLocalInventories][] and [RemoveLocalInventories][] APIs. + // be managed by + // [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] + // and + // [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] + // APIs. repeated LocalInventory local_inventories = 35 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/retail/v2/product_service.proto b/google/cloud/retail/v2/product_service.proto index 5ca2cb326..be83ad9fd 100644 --- a/google/cloud/retail/v2/product_service.proto +++ b/google/cloud/retail/v2/product_service.proto @@ -111,9 +111,9 @@ service ProductService { // // This process is asynchronous and does not require the // [Product][google.cloud.retail.v2.Product] to exist before updating - // fulfillment information. If the request is valid, the update will be - // enqueued and processed downstream. As a consequence, when a response is - // returned, updates are not immediately manifested in the + // fulfillment information. If the request is valid, the update is enqueued + // and processed downstream. As a consequence, when a response is returned, + // updates are not immediately manifested in the // [Product][google.cloud.retail.v2.Product] queried by // [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] // or @@ -123,10 +123,10 @@ service ProductService { // [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] // and // [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct], - // the specified inventory field value(s) will overwrite any existing value(s) + // the specified inventory field value(s) overwrite any existing value(s) // while ignoring the last update time for this field. Furthermore, the last - // update time for the specified inventory fields will be overwritten to the - // time of the + // update times for the specified inventory fields are overwritten by the + // times of the // [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] // or // [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] @@ -134,11 +134,11 @@ service ProductService { // // If no inventory fields are set in // [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product], - // then any pre-existing inventory information for this product will be used. + // then any pre-existing inventory information for this product is used. // // If no inventory fields are set in // [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask], - // then any existing inventory information will be preserved. + // then any existing inventory information is preserved. // // Pre-existing inventory information can only be updated with // [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory], @@ -146,15 +146,17 @@ service ProductService { // and // [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. // - // The returned [Operation][]s will be obsolete after 1 day, and - // [GetOperation][] API will return NOT_FOUND afterwards. + // The returned [Operation][google.longrunning.Operation]s is obsolete after + // one day, and the [GetOperation][google.longrunning.Operations.GetOperation] + // API returns `NOT_FOUND` afterwards. // - // If conflicting updates are issued, the [Operation][]s associated with the - // stale updates will not be marked as [done][Operation.done] until being - // obsolete. + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates are not marked as [done][google.longrunning.Operation.done] until + // they are obsolete. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc SetInventory(SetInventoryRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2/{inventory.name=projects/*/locations/*/catalogs/*/branches/*/products/**}:setInventory" @@ -180,15 +182,17 @@ service ProductService { // or // [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. // - // The returned [Operation][]s will be obsolete after 1 day, and - // [GetOperation][] API will return NOT_FOUND afterwards. + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. // - // If conflicting updates are issued, the [Operation][]s associated with the - // stale updates will not be marked as [done][Operation.done] until being - // obsolete. + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc AddFulfillmentPlaces(AddFulfillmentPlacesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -215,15 +219,17 @@ service ProductService { // or // [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. // - // The returned [Operation][]s will be obsolete after 1 day, and - // [GetOperation][] API will return NOT_FOUND afterwards. + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. // - // If conflicting updates are issued, the [Operation][]s associated with the - // stale updates will not be marked as [done][Operation.done] until being - // obsolete. + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -257,15 +263,17 @@ service ProductService { // [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] // has no effect on local inventories. // - // The returned [Operation][]s will be obsolete after 1 day, and - // [GetOperation][] API will return NOT_FOUND afterwards. + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. // - // If conflicting updates are issued, the [Operation][]s associated with the - // stale updates will not be marked as [done][Operation.done] until being - // obsolete. + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc AddLocalInventories(AddLocalInventoriesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -297,15 +305,17 @@ service ProductService { // [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] // has no effect on local inventories. // - // The returned [Operation][]s will be obsolete after 1 day, and - // [GetOperation][] API will return NOT_FOUND afterwards. + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. // - // If conflicting updates are issued, the [Operation][]s associated with the - // stale updates will not be marked as [done][Operation.done] until being - // obsolete. + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc RemoveLocalInventories(RemoveLocalInventoriesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { diff --git a/google/cloud/retail/v2/retail_v2.yaml b/google/cloud/retail/v2/retail_v2.yaml index caa125739..3b0e4454e 100644 --- a/google/cloud/retail/v2/retail_v2.yaml +++ b/google/cloud/retail/v2/retail_v2.yaml @@ -53,10 +53,14 @@ backend: rules: - selector: google.cloud.retail.v2.CatalogService.UpdateCatalog deadline: 10.0 + - selector: google.cloud.retail.v2.CompletionService.ImportCompletionData + deadline: 300.0 - selector: 'google.cloud.retail.v2.ProductService.*' deadline: 30.0 - selector: google.cloud.retail.v2.ProductService.ImportProducts deadline: 300.0 + - selector: google.cloud.retail.v2.UserEventService.CollectUserEvent + deadline: 10.0 - selector: google.cloud.retail.v2.UserEventService.ImportUserEvents deadline: 600.0 - selector: google.cloud.retail.v2.UserEventService.PurgeUserEvents diff --git a/google/cloud/retail/v2/search_service.proto b/google/cloud/retail/v2/search_service.proto index 32de76da6..30c3c45a6 100644 --- a/google/cloud/retail/v2/search_service.proto +++ b/google/cloud/retail/v2/search_service.proto @@ -37,7 +37,7 @@ option ruby_package = "Google::Cloud::Retail::V2"; // Service for search. // // This feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this feature. +// Enable Retail Search on Cloud Console before using this feature. service SearchService { option (google.api.default_host) = "retail.googleapis.com"; option (google.api.oauth_scopes) = @@ -46,7 +46,7 @@ service SearchService { // Performs a search. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc Search(SearchRequest) returns (SearchResponse) { option (google.api.http) = { post: "/v2/{placement=projects/*/locations/*/catalogs/*/placements/*}:search" @@ -216,7 +216,7 @@ message SearchRequest { FacetKey facet_key = 1 [(google.api.field_behavior) = REQUIRED]; // Maximum of facet values that should be returned for this facet. If - // unspecified, defaults to 20. The maximum allowed value is 300. Values + // unspecified, defaults to 50. The maximum allowed value is 300. Values // above 300 will be coerced to 300. // // If this field is negative, an INVALID_ARGUMENT is returned. @@ -436,15 +436,20 @@ message SearchRequest { // The search mode of each search request. enum SearchMode { // Default value. In this case both product search and faceted search will - // be performed. Both [SearchResponse.SearchResult] and - // [SearchResponse.Facet] will be returned. + // be performed. Both + // [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] + // and [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] + // will be returned. SEARCH_MODE_UNSPECIFIED = 0; // Only product search will be performed. The faceted search will be // disabled. // - // Only [SearchResponse.SearchResult] will be returned. - // [SearchResponse.Facet] will not be returned, even if + // Only + // [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] + // will be returned. + // [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will + // not be returned, even if // [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs] // or // [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec] @@ -459,7 +464,9 @@ message SearchRequest { // and // [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec] // should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only - // [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult] + // [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will + // be returned. + // [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] // will not be returned. FACETED_SEARCH_ONLY = 2; } @@ -468,7 +475,7 @@ message SearchRequest { // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` // or the name of the legacy placement resource, such as // `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. - // This field is used to identify the serving configuration name and the set + // This field is used to identify the serving config name and the set // of models that will be used to make the search. string placement = 1 [(google.api.field_behavior) = REQUIRED]; @@ -671,7 +678,7 @@ message SearchRequest { // [UserEvent.page_categories][google.cloud.retail.v2.UserEvent.page_categories]; // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // Category pages include special pages such as sales or promotions. For diff --git a/google/cloud/retail/v2/serving_config.proto b/google/cloud/retail/v2/serving_config.proto index 45f317d63..41e73beff 100644 --- a/google/cloud/retail/v2/serving_config.proto +++ b/google/cloud/retail/v2/serving_config.proto @@ -38,6 +38,18 @@ message ServingConfig { pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}" }; + // What type of diversity - data or rule based. + enum DiversityType { + // Default value. + DIVERSITY_TYPE_UNSPECIFIED = 0; + + // Rule based diversity. + RULE_BASED_DIVERSITY = 2; + + // Data driven diversity. + DATA_DRIVEN_DIVERSITY = 3; + } + // Immutable. Fully qualified name // `projects/*/locations/global/catalogs/*/servingConfig/*` string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -67,13 +79,13 @@ message ServingConfig { // click-through and conversion rates. // Allowed values are: // - // * 'no-price-reranking' - // * 'low-price-raranking' - // * 'medium-price-reranking' - // * 'high-price-reranking' + // * `no-price-reranking` + // * `low-price-raranking` + // * `medium-price-reranking` + // * `high-price-reranking` // // If not specified, we choose default based on model type. Default value: - // 'no-price-reranking'. + // `no-price-reranking`. // // Can only be set if // [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is @@ -191,29 +203,34 @@ message ServingConfig { repeated string ignore_control_ids = 15; // How much diversity to use in recommendation model results e.g. - // 'medium-diversity' or 'high-diversity'. Currently supported values: + // `medium-diversity` or `high-diversity`. Currently supported values: // - // * 'no-diversity' - // * 'low-diversity' - // * 'medium-diversity' - // * 'high-diversity' - // * 'auto-diversity' + // * `no-diversity` + // * `low-diversity` + // * `medium-diversity` + // * `high-diversity` + // * `auto-diversity` // // If not specified, we choose default based on recommendation model - // type. Default value: 'no-diversity'. + // type. Default value: `no-diversity`. // // Can only be set if // [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. string diversity_level = 8; - // Whether to add additional category filters on the 'similar-items' model. + // What kind of diversity to use - data driven or rule based. If unset, + // the server behavior defaults to + // [RULE_BASED_DIVERSITY][google.cloud.retail.v2.ServingConfig.DiversityType.RULE_BASED_DIVERSITY]. + DiversityType diversity_type = 20; + + // Whether to add additional category filters on the `similar-items` model. // If not specified, we enable it by default. // Allowed values are: // - // * 'no-category-match': No additional filtering of original results from + // * `no-category-match`: No additional filtering of original results from // the model and the customer's filters. - // * 'relaxed-category-match': Only keep results with categories that match + // * `relaxed-category-match`: Only keep results with categories that match // at least one item categories in the PredictRequests's context item. // * If customer also sends filters in the PredictRequest, then the results // will satisfy both conditions (user given and category match). diff --git a/google/cloud/retail/v2/serving_config_service.proto b/google/cloud/retail/v2/serving_config_service.proto index a4cabe26b..b8dbc621d 100644 --- a/google/cloud/retail/v2/serving_config_service.proto +++ b/google/cloud/retail/v2/serving_config_service.proto @@ -158,7 +158,7 @@ message UpdateServingConfigRequest { // Request for DeleteServingConfig method. message DeleteServingConfigRequest { // Required. The resource name of the ServingConfig to delete. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -170,7 +170,7 @@ message DeleteServingConfigRequest { // Request for GetServingConfig method. message GetServingConfigRequest { // Required. The resource name of the ServingConfig to get. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -182,7 +182,7 @@ message GetServingConfigRequest { // Request for ListServingConfigs method. message ListServingConfigsRequest { // Required. The catalog resource name. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" } @@ -210,7 +210,7 @@ message ListServingConfigsResponse { // Request for AddControl method. message AddControlRequest { // Required. The source ServingConfig resource name . Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string serving_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -226,7 +226,7 @@ message AddControlRequest { // Request for RemoveControl method. message RemoveControlRequest { // Required. The source ServingConfig resource name . Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string serving_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/retail/v2/user_event.proto b/google/cloud/retail/v2/user_event.proto index fc315f88f..6093c9a5f 100644 --- a/google/cloud/retail/v2/user_event.proto +++ b/google/cloud/retail/v2/user_event.proto @@ -226,7 +226,7 @@ message UserEvent { // The categories associated with a category page. // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // Category pages include special pages such as sales or promotions. For diff --git a/google/cloud/retail/v2/user_event_service.proto b/google/cloud/retail/v2/user_event_service.proto index 9a917bc6c..23049dafe 100644 --- a/google/cloud/retail/v2/user_event_service.proto +++ b/google/cloud/retail/v2/user_event_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/httpbody.proto"; +import "google/api/resource.proto"; import "google/cloud/retail/v2/import_config.proto"; import "google/cloud/retail/v2/purge_config.proto"; import "google/cloud/retail/v2/user_event.proto"; @@ -94,14 +95,14 @@ service UserEventService { }; } - // Starts a user event rejoin operation with latest product catalog. Events - // will not be annotated with detailed product information if product is - // missing from the catalog at the time the user event is ingested, and these - // events are stored as unjoined events with a limited usage on training and - // serving. This method can be used to start a join operation on specified - // events with latest version of product catalog. It can also be used to - // correct events joined with the wrong product catalog. A rejoin operation - // can take hours or days to complete. + // Starts a user-event rejoin operation with latest product catalog. Events + // are not annotated with detailed product information for products that are + // missing from the catalog when the user event is ingested. These + // events are stored as unjoined events with limited usage on training and + // serving. You can use this method to start a join operation on specified + // events with the latest version of product catalog. You can also use this + // method to correct events joined with the wrong product catalog. A rejoin + // operation can take hours or days to complete. rpc RejoinUserEvents(RejoinUserEventsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -123,10 +124,24 @@ message WriteUserEventRequest { // Required. User event to write. UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED]; + + // If set to true, the user event will be written asynchronously after + // validation, and the API will respond without waiting for the write. + // Therefore, silent failures can occur even if the API returns success. In + // case of silent failures, error messages can be found in Stackdriver logs. + bool write_async = 3; } // Request message for CollectUserEvent method. message CollectUserEventRequest { + // The rule that can convert the raw_json to a user event. It is needed + // only when the raw_json is set. + oneof conversion_rule { + // The prebuilt rule name that can convert a specific type of raw_json. + // For example: "default_schema/v1.0" + string prebuilt_rule = 6; + } + // Required. The parent catalog name, such as // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; @@ -145,17 +160,23 @@ message CollectUserEventRequest { // otherwise identical get requests. The name is abbreviated to reduce the // payload bytes. int64 ets = 4; + + // An arbitrary serialized JSON string that contains necessary information + // that can comprise a user event. When this field is specified, the + // user_event field will be ignored. Note: line-delimited JSON is not + // supported, a single JSON only. + string raw_json = 5; } // Request message for RejoinUserEvents method. message RejoinUserEventsRequest { // The scope of user events to be rejoined with the latest product catalog. // If the rejoining aims at reducing number of unjoined events, set - // UserEventRejoinScope to UNJOINED_EVENTS. + // `UserEventRejoinScope` to `UNJOINED_EVENTS`. // If the rejoining aims at correcting product catalog information in joined - // events, set UserEventRejoinScope to JOINED_EVENTS. - // If all events needs to be rejoined, set UserEventRejoinScope to - // USER_EVENT_REJOIN_SCOPE_UNSPECIFIED. + // events, set `UserEventRejoinScope` to `JOINED_EVENTS`. + // If all events needs to be rejoined, set `UserEventRejoinScope` to + // `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`. enum UserEventRejoinScope { // Rejoin all events with the latest product catalog, including both joined // events and unjoined events. @@ -174,16 +195,16 @@ message RejoinUserEventsRequest { // The type of the user event rejoin to define the scope and range of the user // events to be rejoined with the latest product catalog. Defaults to - // USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an - // invalid integer value. + // `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to + // an invalid integer value. UserEventRejoinScope user_event_rejoin_scope = 2; } -// Response message for RejoinUserEvents method. +// Response message for `RejoinUserEvents` method. message RejoinUserEventsResponse { // Number of user events that were joined with latest product catalog. int64 rejoined_user_events_count = 1; } -// Metadata for RejoinUserEvents method. +// Metadata for `RejoinUserEvents` method. message RejoinUserEventsMetadata {} diff --git a/google/cloud/retail/v2alpha/BUILD.bazel b/google/cloud/retail/v2alpha/BUILD.bazel index e2cd9275a..037227909 100644 --- a/google/cloud/retail/v2alpha/BUILD.bazel +++ b/google/cloud/retail/v2alpha/BUILD.bazel @@ -96,6 +96,7 @@ java_gapic_library( srcs = [":retail_proto_with_info"], gapic_yaml = "retail_gapic.yaml", grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2alpha.yaml", test_deps = [ ":retail_java_grpc", @@ -176,13 +177,15 @@ go_gapic_library( grpc_service_config = "retail_grpc_service_config.json", importpath = "cloud.google.com/go/retail/apiv2alpha;retail", metadata = True, + rest_numeric_enums = True, + transport = "grpc+rest", service_yaml = "retail_v2alpha.yaml", deps = [ ":retail_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -220,6 +223,7 @@ py_gapic_library( name = "retail_py_gapic", srcs = [":retail_proto"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -267,7 +271,9 @@ php_gapic_library( name = "retail_php_gapic", srcs = [":retail_proto_with_info"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2alpha.yaml", + transport = "grpc+rest", deps = [ ":retail_php_grpc", ":retail_php_proto", @@ -299,10 +305,12 @@ nodejs_gapic_library( src = ":retail_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "retail_grpc_service_config.json", + mixins = "google.longrunning.Operations;google.cloud.location.Locations", package = "google.cloud.retail.v2alpha", + rest_numeric_enums = True, service_yaml = "retail_v2alpha.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -346,6 +354,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/retail/docs/apis", ], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Retail enables you to build an end-to-end personalized recommendation system based on state-of-the-art deep learning ML models, without a need for expertise in ML or recommendation systems.", ruby_cloud_title = "Retail V2alpha", deps = [ @@ -391,6 +400,7 @@ csharp_gapic_library( srcs = [":retail_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2alpha.yaml", deps = [ ":retail_csharp_grpc", diff --git a/google/cloud/retail/v2alpha/catalog.proto b/google/cloud/retail/v2alpha/catalog.proto index f6c114d7c..95b7dd944 100644 --- a/google/cloud/retail/v2alpha/catalog.proto +++ b/google/cloud/retail/v2alpha/catalog.proto @@ -104,8 +104,7 @@ message CatalogAttribute { // The status of the indexable option of a catalog attribute. enum IndexableOption { - // Value used when unset. Defaults to - // [INDEXABLE_ENABLED][google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption.INDEXABLE_ENABLED]. + // Value used when unset. INDEXABLE_OPTION_UNSPECIFIED = 0; // Indexable option enabled for an attribute. @@ -117,8 +116,7 @@ message CatalogAttribute { // The status of the dynamic facetable option of a catalog attribute. enum DynamicFacetableOption { - // Value used when unset. Defaults to - // [DYNAMIC_FACETABLE_ENABLED][google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED]. + // Value used when unset. DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0; // Dynamic facetable option enabled for an attribute. @@ -130,8 +128,7 @@ message CatalogAttribute { // The status of the searchable option of a catalog attribute. enum SearchableOption { - // Value used when unset. Defaults to - // [SEARCHABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption.SEARCHABLE_DISABLED]. + // Value used when unset. SEARCHABLE_OPTION_UNSPECIFIED = 0; // Searchable option enabled for an attribute. @@ -141,6 +138,32 @@ message CatalogAttribute { SEARCHABLE_DISABLED = 2; } + // The status of the exact-searchable option of a catalog attribute. + enum ExactSearchableOption { + // Value used when unset. Defaults to + // [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED]. + EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0; + + // Exact searchable option enabled for an attribute. + EXACT_SEARCHABLE_ENABLED = 1; + + // Exact searchable option disabled for an attribute. + EXACT_SEARCHABLE_DISABLED = 2; + } + + // The status of the retrievable option of a catalog attribute. + enum RetrievableOption { + // Value used when unset. Defaults to + // [RETRIEVABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED]. + RETRIEVABLE_OPTION_UNSPECIFIED = 0; + + // Retrievable option enabled for an attribute. + RETRIEVABLE_ENABLED = 1; + + // Retrievable option disabled for an attribute. + RETRIEVABLE_DISABLED = 2; + } + // Required. Attribute name. // For example: `color`, `brands`, `attributes.custom_attribute`, such as // `attributes.xyz`. @@ -165,13 +188,13 @@ message CatalogAttribute { // APIs. This field is `False` for pre-loaded // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s. // - // Only pre-loaded - // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s that are - // neither in use by products nor predefined can be deleted. - // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s that are - // either in use by products or are predefined cannot be deleted; however, - // their configuration properties will reset to default values upon removal - // request. + // Only pre-loaded [catalog + // attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are neither + // in use by products nor predefined can be deleted. [Catalog + // attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are + // either in use by products or are predefined attributes cannot be deleted; + // however, their configuration properties will reset to default values upon + // removal request. // // After catalog changes, it takes about 10 minutes for this field to update. bool in_use = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -185,12 +208,16 @@ message CatalogAttribute { // is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. + // + // Must be specified, otherwise throws INVALID_FORMAT error. IndexableOption indexable_option = 5; // If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic // facet. Could only be DYNAMIC_FACETABLE_DISABLED if // [CatalogAttribute.indexable_option][google.cloud.retail.v2alpha.CatalogAttribute.indexable_option] // is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. + // + // Must be specified, otherwise throws INVALID_FORMAT error. DynamicFacetableOption dynamic_facetable_option = 6; // When @@ -203,6 +230,8 @@ message CatalogAttribute { // will not be searchable by text queries in // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search], // as there are no text values associated to numerical attributes. + // + // Must be specified, otherwise throws INVALID_FORMAT error. SearchableOption searchable_option = 7; // When @@ -212,6 +241,15 @@ message CatalogAttribute { // This option works for categorical features only, // does not work for numerical features, inventory filtering. RecommendationsFilteringOption recommendations_filtering_option = 8; + + // If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. + // This property only applies to textual custom attributes and requires + // indexable set to enabled to enable exact-searchable. + ExactSearchableOption exact_searchable_option = 11; + + // If RETRIEVABLE_ENABLED, attribute values are retrievable in the search + // results. + RetrievableOption retrievable_option = 12; } // Catalog level attribute config. @@ -336,21 +374,21 @@ message CompletionConfig { // will be streamed to the linked branch. message MerchantCenterLink { // Required. The linked [Merchant center account - // id](https://developers.google.com/shopping-content/guides/accountstatuses). + // ID](https://developers.google.com/shopping-content/guides/accountstatuses). // The account must be a standalone account or a sub-account of a MCA. int64 merchant_center_account_id = 1 [(google.api.field_behavior) = REQUIRED]; - // The branch id (e.g. 0/1/2) within this catalog that products from + // The branch ID (e.g. 0/1/2) within this catalog that products from // merchant_center_account_id are streamed to. When updating this field, an // empty value will use the currently configured default branch. However, // changing the default branch later on won't change the linked branch here. // - // A single branch id can only have one linked merchant center account id. + // A single branch ID can only have one linked merchant center account ID. string branch_id = 2; // String representing the destination to import for, all if left empty. - // List of possible values can be found here. - // [https://support.google.com/merchants/answer/7501026] + // List of possible values is given in [Included + // destination](https://support.google.com/merchants/answer/7501026). // List of allowed string values: // "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory // _ads", "Free_listings", "Free_local_listings" @@ -375,6 +413,21 @@ message MerchantCenterLink { // // Example value: `en`. string language_code = 5; + + // Criteria for the Merchant Center feeds to be ingested via the link. + // All offers will be ingested if the list is empty. + // Otherwise the offers will be ingested from selected feeds. + repeated MerchantCenterFeedFilter feeds = 6; +} + +// Merchant Center Feed filter criterion. +message MerchantCenterFeedFilter { + // Merchant Center primary feed ID. + int64 primary_feed_id = 1; + + // Merchant Center primary feed name. The name is used for the display + // purposes only. + string primary_feed_name = 2; } // Configures Merchant Center linking. diff --git a/google/cloud/retail/v2alpha/catalog_service.proto b/google/cloud/retail/v2alpha/catalog_service.proto index 088c01922..d14a79a83 100644 --- a/google/cloud/retail/v2alpha/catalog_service.proto +++ b/google/cloud/retail/v2alpha/catalog_service.proto @@ -186,6 +186,17 @@ service CatalogService { }; } + // Removes all specified + // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s from the + // [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig]. + rpc BatchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest) + returns (BatchRemoveCatalogAttributesResponse) { + option (google.api.http) = { + post: "/v2alpha/{attributes_config=projects/*/locations/*/catalogs/*/attributesConfig}:batchRemoveCatalogAttributes" + body: "*" + }; + } + // Replaces the specified // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] in the // [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] by @@ -341,7 +352,7 @@ message GetDefaultBranchResponse { // method. message GetCompletionConfigRequest { // Required. Full CompletionConfig resource name. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -449,6 +460,44 @@ message RemoveCatalogAttributeRequest { string key = 2 [(google.api.field_behavior) = REQUIRED]; } +// Request for +// [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes] +// method. +message BatchRemoveCatalogAttributesRequest { + // Required. The attributes config resource shared by all catalog attributes + // being deleted. Format: + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` + string attributes_config = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "retail.googleapis.com/AttributesConfig" + } + ]; + + // Required. The attribute name keys of the + // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s to + // delete. A maximum of 1000 catalog attributes can be deleted in a batch. + repeated string attribute_keys = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response of the +// [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes]. +message BatchRemoveCatalogAttributesResponse { + // Catalog attributes that were deleted. Only pre-loaded [catalog + // attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are + // neither [in + // use][google.cloud.retail.v2alpha.CatalogAttribute.in_use] by + // products nor predefined can be deleted. + repeated string deleted_catalog_attributes = 1; + + // Catalog attributes that were reset. [Catalog + // attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are either + // [in use][google.cloud.retail.v2alpha.CatalogAttribute.in_use] by products + // or are predefined attributes cannot be deleted; however, their + // configuration properties will reset to default values upon removal request. + repeated string reset_catalog_attributes = 2; +} + // Request for // [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.ReplaceCatalogAttribute] // method. diff --git a/google/cloud/retail/v2alpha/common.proto b/google/cloud/retail/v2alpha/common.proto index 02cf05ba8..4a06b4273 100644 --- a/google/cloud/retail/v2alpha/common.proto +++ b/google/cloud/retail/v2alpha/common.proto @@ -72,7 +72,7 @@ enum RecommendationsFilteringOption { // The use case of Cloud Retail Search. enum SearchSolutionUseCase { // The value when it's unspecified. In this case, server behavior defaults to - // [SEARCH_SOLUTION_USE_CASE_SEARCH][]. + // [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]. SEARCH_SOLUTION_USE_CASE_UNSPECIFIED = 0; // Search use case. Expects the traffic has a non-empty @@ -97,8 +97,8 @@ message Condition { // Value cannot be empty. // Value can have at most 3 terms if specified as a partial match. Each // space separated string is considered as one term. - // Example) "a b c" is 3 terms and allowed, " a b c d" is 4 terms and not - // allowed for partial match. + // For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms + // and not allowed for a partial match. string value = 1; // Whether this is supposed to be a full or partial match. @@ -127,10 +127,12 @@ message Condition { } // A rule is a condition-action pair +// // * A condition defines when a rule is to be triggered. // * An action specifies what occurs on that trigger. -// Currently only boost rules are supported. -// Currently only supported by the search endpoint. +// Currently rules only work for [controls][google.cloud.retail.v2alpha.Control] +// with +// [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH]. message Rule { // A boost action to apply to results matching condition specified above. message BoostAction { @@ -216,7 +218,8 @@ message Rule { } // Creates a set of terms that will be treated as synonyms of each other. - // Example: synonyms of "sneakers" and "shoes". + // Example: synonyms of "sneakers" and "shoes": + // // * "sneakers" will use a synonym of "shoes". // * "shoes" will use a synonym of "sneakers". message TwowaySynonymsAction { diff --git a/google/cloud/retail/v2alpha/completion_service.proto b/google/cloud/retail/v2alpha/completion_service.proto index 9f399d223..323bc05d6 100644 --- a/google/cloud/retail/v2alpha/completion_service.proto +++ b/google/cloud/retail/v2alpha/completion_service.proto @@ -36,7 +36,7 @@ option ruby_package = "Google::Cloud::Retail::V2alpha"; // Auto-completion service for retail. // // This feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this feature. +// Enable Retail Search on Cloud Console before using this feature. service CompletionService { option (google.api.default_host) = "retail.googleapis.com"; option (google.api.oauth_scopes) = @@ -45,7 +45,7 @@ service CompletionService { // Completes the specified prefix with keyword suggestions. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) { option (google.api.http) = { get: "/v2alpha/{catalog=projects/*/locations/*/catalogs/*}:completeQuery" @@ -60,7 +60,7 @@ service CompletionService { // are indexed successfully and ready for serving. The process takes hours. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc ImportCompletionData(ImportCompletionDataRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -110,8 +110,10 @@ message CompleteQueryRequest { // number of language codes is 3. repeated string language_codes = 3; - // The device type context for completion suggestions. - // It is useful to apply different suggestions on different device types, e.g. + // The device type context for completion suggestions. We recommend that you + // leave this field empty. + // + // It can apply different suggestions on different device types, e.g. // `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device // types. // @@ -148,6 +150,11 @@ message CompleteQueryRequest { // The maximum allowed max suggestions is 20. If it is set higher, it will be // capped by 20. int32 max_suggestions = 5; + + // If true, attribute suggestions are enabled and provided in response. + // + // This field is only available for "cloud-retail" dataset. + bool enable_attribute_suggestions = 9; } // Response of the auto-complete query. @@ -175,6 +182,12 @@ message CompleteQueryResponse { string recent_search = 1; } + // Resource that represents attribute results. + message AttributeResult { + // The list of suggestions for the attribute. + repeated string suggestions = 1; + } + // Results of the matching suggestions. The result list is ordered and the // first result is top suggestion. repeated CompletionResult completion_results = 1; @@ -207,4 +220,14 @@ message CompleteQueryResponse { // Recent searches are deduplicated. More recent searches will be reserved // when duplication happens. repeated RecentSearchResult recent_search_results = 3; + + // A map of matched attribute suggestions. This field is only available for + // "cloud-retail" dataset. + // + // Current supported keys: + // + // * `brands` + // + // * `categories` + map attribute_results = 4; } diff --git a/google/cloud/retail/v2alpha/control.proto b/google/cloud/retail/v2alpha/control.proto index cdd683d57..6ad604ea4 100644 --- a/google/cloud/retail/v2alpha/control.proto +++ b/google/cloud/retail/v2alpha/control.proto @@ -30,8 +30,9 @@ option objc_class_prefix = "RETAIL"; option php_namespace = "Google\\Cloud\\Retail\\V2alpha"; option ruby_package = "Google::Cloud::Retail::V2alpha"; -// Configures dynamic serving time metadata that is used to pre and post -// process search/recommendation model results. +// Configures dynamic metadata that can be linked to a +// [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search +// or recommendation results at serving time. message Control { option (google.api.resource) = { type: "retail.googleapis.com/Control" @@ -45,7 +46,10 @@ message Control { // INVALID_ARGUMENT will be returned if either condition is violated. oneof control { // A facet specification to perform faceted search. - SearchRequest.FacetSpec facet_spec = 3; + // + // Note that this field is deprecated and will throw NOT_IMPLEMENTED if + // used for creating a control. + SearchRequest.FacetSpec facet_spec = 3 [deprecated = true]; // A rule control - a condition-action pair. // Enacts a set action when the condition is triggered. @@ -63,30 +67,34 @@ message Control { // characters. Otherwise, an INVALID_ARGUMENT error is thrown. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Output only. List of serving configuration ids that that are associated - // with this control. Note the association is managed via the ServingConfig, - // this is an output only denormalizeed view. Assumed to be in the same - // catalog. + // Output only. List of [serving + // config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated + // with this control in the same + // [Catalog][google.cloud.retail.v2alpha.Catalog]. + // + // Note the association is managed via the + // [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an + // output only denormalized view. repeated string associated_serving_config_ids = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. Immutable. The solution types that the serving config is used - // for. Currently we support setting only one type of solution at creation - // time. + // Required. Immutable. The solution types that the control is used for. + // Currently we support setting only one type of solution at creation time. // // Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. // If no solution type is provided at creation time, will default to - // SOLUTION_TYPE_SEARCH. + // [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH]. repeated SolutionType solution_types = 6 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Specifies the use case for the control. + // Specifies the use case for the control. // Affects what condition fields can be set. // Only settable by search controls. - // Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. - // Currently only allow one search_solution_use_case per control. - repeated SearchSolutionUseCase search_solution_use_case = 7 - [(google.api.field_behavior) = REQUIRED]; + // Will default to + // [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] + // if not specified. Currently only allow one search_solution_use_case per + // control. + repeated SearchSolutionUseCase search_solution_use_case = 7; } diff --git a/google/cloud/retail/v2alpha/control_service.proto b/google/cloud/retail/v2alpha/control_service.proto index d69201a3d..53744cded 100644 --- a/google/cloud/retail/v2alpha/control_service.proto +++ b/google/cloud/retail/v2alpha/control_service.proto @@ -66,7 +66,7 @@ service ControlService { // // [Control][google.cloud.retail.v2alpha.Control] cannot be set to a different // oneof field, if so an INVALID_ARGUMENT is returned. If the - // [Control][google.cloud.retail.v2alpha.Control] to delete does not exist, a + // [Control][google.cloud.retail.v2alpha.Control] to update does not exist, a // NOT_FOUND error is returned. rpc UpdateControl(UpdateControlRequest) returns (Control) { option (google.api.http) = { @@ -84,7 +84,8 @@ service ControlService { option (google.api.method_signature) = "name"; } - // Lists all Controls linked to this catalog. + // Lists all Controls by their parent + // [Catalog][google.cloud.retail.v2alpha.Catalog]. rpc ListControls(ListControlsRequest) returns (ListControlsResponse) { option (google.api.http) = { get: "/v2alpha/{parent=projects/*/locations/*/catalogs/*}/controls" @@ -140,7 +141,7 @@ message DeleteControlRequest { // Request for GetControl method. message GetControlRequest { - // Required. The resource name of the Control to delete. Format: + // Required. The resource name of the Control to get. Format: // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/google/cloud/retail/v2alpha/export_config.proto b/google/cloud/retail/v2alpha/export_config.proto index dd907d1ea..831bb2ec5 100644 --- a/google/cloud/retail/v2alpha/export_config.proto +++ b/google/cloud/retail/v2alpha/export_config.proto @@ -16,6 +16,8 @@ syntax = "proto3"; package google.cloud.retail.v2alpha; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; import "google/protobuf/timestamp.proto"; import "google/rpc/status.proto"; @@ -40,7 +42,7 @@ message ExportErrorsConfig { } } -// Metadata related to the progress of the Export operation. This will be +// Metadata related to the progress of the Export operation. This is // returned by the google.longrunning.Operation.metadata field. message ExportMetadata { // Operation create time. @@ -79,10 +81,14 @@ message ExportUserEventsResponse { OutputResult output_result = 3; } -// Output result. +// Output result that stores the information about where the exported data is +// stored. message OutputResult { - // Export result in BigQuery. + // The BigQuery location where the result is stored. repeated BigQueryOutputResult bigquery_result = 1; + + // The Google Cloud Storage location where the result is stored. + repeated GcsOutputResult gcs_result = 2; } // A BigQuery output result. @@ -93,3 +99,9 @@ message BigQueryOutputResult { // The ID of a BigQuery Table. string table_id = 2; } + +// A Gcs output result. +message GcsOutputResult { + // The uri of Gcs output + string output_uri = 1; +} diff --git a/google/cloud/retail/v2alpha/import_config.proto b/google/cloud/retail/v2alpha/import_config.proto index 319edb1ea..8b7d87b95 100644 --- a/google/cloud/retail/v2alpha/import_config.proto +++ b/google/cloud/retail/v2alpha/import_config.proto @@ -35,7 +35,6 @@ option php_namespace = "Google\\Cloud\\Retail\\V2alpha"; option ruby_package = "Google::Cloud::Retail::V2alpha"; // Google Cloud Storage location for input content. -// format. message GcsSource { // Required. Google Cloud Storage URIs to input files. URI can be up to // 2000 characters long. URIs can match the full object path (for example, @@ -66,12 +65,12 @@ message GcsSource { // // Supported values for control imports: // - // * 'control' (default): One JSON + // * `control` (default): One JSON // [Control][google.cloud.retail.v2alpha.Control] per line. // // Supported values for catalog attribute imports: // - // * 'catalog_attribute' (default): One CSV + // * `catalog_attribute` (default): One CSV // [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] per line. string data_schema = 2; } @@ -83,9 +82,8 @@ message BigQuerySource { oneof partition { // BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. // - // Only supported when - // [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode] - // is set to `FULL`. + // Only supported in + // [ImportProductsRequest][google.cloud.retail.v2alpha.ImportProductsRequest]. google.type.Date partition_date = 6; } @@ -124,8 +122,7 @@ message BigQuerySource { // * `user_event_ga360`: // The schema is available here: // https://support.google.com/analytics/answer/3437719. - // * `user_event_ga4`: This feature is in private preview. Please contact the - // support team for importing Google Analytics 4 events. + // * `user_event_ga4`: // The schema is available here: // https://support.google.com/analytics/answer/7029846. // @@ -156,7 +153,7 @@ message ImportErrorsConfig { // Required. Errors destination. oneof destination { // Google Cloud Storage prefix for import errors. This must be an empty, - // existing Cloud Storage directory. Import errors will be written to + // existing Cloud Storage directory. Import errors are written to // sharded files in this directory, one per line, as a JSON-encoded // `google.rpc.Status` message. string gcs_prefix = 1; @@ -176,16 +173,6 @@ message ImportProductsRequest { // Calculates diff and replaces the entire product dataset. Existing // products may be deleted if they are not present in the source location. - // - // Can only be set while using - // [BigQuerySource][google.cloud.retail.v2alpha.BigQuerySource]. And the - // BigQuery dataset must be created in the data location "us (multiple - // regions in United States)", otherwise a PERMISSION_DENIED error is - // thrown. - // - // Add the IAM permission "BigQuery Data Viewer" for - // cloud-retail-customer-data-access@system.gserviceaccount.com before - // using this feature otherwise an error is thrown. FULL = 2; } @@ -208,8 +195,8 @@ message ImportProductsRequest { // The desired location of errors incurred during the Import. ImportErrorsConfig errors_config = 3; - // Indicates which fields in the provided imported 'products' to update. If - // not set, will by default update all fields. + // Indicates which fields in the provided imported `products` to update. If + // not set, all fields are updated. google.protobuf.FieldMask update_mask = 4; // The mode of reconciliation between existing products and the products to be @@ -218,24 +205,19 @@ message ImportProductsRequest { ReconciliationMode reconciliation_mode = 5; // Full Pub/Sub topic name for receiving notification. If this field is set, - // when the import is finished, a notification will be sent to - // specified Pub/Sub topic. The message data will be JSON string of a + // when the import is finished, a notification is sent to + // specified Pub/Sub topic. The message data is JSON string of a // [Operation][google.longrunning.Operation]. // // Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has // to be within the same project as // [ImportProductsRequest.parent][google.cloud.retail.v2alpha.ImportProductsRequest.parent]. - // Make sure that both - // `cloud-retail-customer-data-access@system.gserviceaccount.com` and - // `service-@gcp-sa-retail.iam.gserviceaccount.com` - // have the `pubsub.topics.publish` IAM permission on the topic. - // - // Only supported when - // [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode] - // is set to `FULL`. + // Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the + // `pubsub.topics.publish` IAM permission on the topic. string notification_pubsub_topic = 7; - // If true, will perform the FULL import even if it would delete a large + // If true, this performs the FULL import even if it would delete a large // proportion of the products in the default branch, which could potentially // cause outages if you have live predict/search traffic. // @@ -277,8 +259,8 @@ message ImportCompletionDataRequest { [(google.api.field_behavior) = REQUIRED]; // Pub/Sub topic for receiving notification. If this field is set, - // when the import is finished, a notification will be sent to - // specified Pub/Sub topic. The message data will be JSON string of a + // when the import is finished, a notification is sent to + // specified Pub/Sub topic. The message data is JSON string of a // [Operation][google.longrunning.Operation]. // Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. string notification_pubsub_topic = 3; @@ -338,7 +320,7 @@ message CompletionDataInputConfig { } } -// Metadata related to the progress of the Import operation. This will be +// Metadata related to the progress of the Import operation. This is // returned by the google.longrunning.Operation.metadata field. message ImportMetadata { // Operation create time. @@ -358,11 +340,24 @@ message ImportMetadata { string request_id = 5 [deprecated = true]; // Pub/Sub topic for receiving notification. If this field is set, - // when the import is finished, a notification will be sent to - // specified Pub/Sub topic. The message data will be JSON string of a + // when the import is finished, a notification is sent to + // specified Pub/Sub topic. The message data is JSON string of a // [Operation][google.longrunning.Operation]. // Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. string notification_pubsub_topic = 6; + + // Metadata related to transform user events. + TransformedUserEventsMetadata transformed_user_events_metadata = 7; +} + +// Metadata related to transform user events operation. +message TransformedUserEventsMetadata { + // Count of entries in the source user events BigQuery table. + int64 source_events_count = 1; + + // Count of entries in the transformed user events BigQuery table, which could + // be different from the actually imported number of user events. + int64 transformed_events_count = 2; } // Response of the diff --git a/google/cloud/retail/v2alpha/model.proto b/google/cloud/retail/v2alpha/model.proto index 5f4ead9f7..1b60792db 100644 --- a/google/cloud/retail/v2alpha/model.proto +++ b/google/cloud/retail/v2alpha/model.proto @@ -34,7 +34,7 @@ option ruby_package = "Google::Cloud::Retail::V2alpha"; // [Model][google.cloud.retail.v2alpha.Model]. A // [Model][google.cloud.retail.v2alpha.Model] can be associated with a // [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and then queried -// through the Predict api. +// through the Predict API. message Model { option (google.api.resource) = { type: "retail.googleapis.com/Model" @@ -44,7 +44,7 @@ message Model { // The PageOptimizationConfig for model training. // // This determines how many panels to optimize for, and which serving - // configurations to consider for each panel. + // configs to consider for each panel. // The purpose of this model is to optimize which // [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] to show on which // panels in way that optimizes the visitors shopping journey. @@ -56,9 +56,9 @@ message Model { oneof candidate { // This has to be a valid // [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] - // identifier. e.g. for a ServingConfig with full name: - // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config` - // this would be 'my_candidate_config' + // identifier. For example, for a ServingConfig with full name: + // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config`, + // this would be `my_candidate_config`. string serving_config_id = 1; } } @@ -71,13 +71,11 @@ message Model { string display_name = 1 [(google.api.field_behavior) = OPTIONAL]; // Required. The candidates to consider on the panel. - // - // Limit = 10. repeated Candidate candidates = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The default candidate (in case the model fails at serving - // time, we can fall back to the default). + // Required. The default candidate. If the model fails at serving time, + // we fall back to the default. Candidate default_candidate = 3 [(google.api.field_behavior) = REQUIRED]; } @@ -127,7 +125,7 @@ message Model { // home_page_ctr_diversity_low, // pdp_cvr_no_diversity // - // `Restriction` = UNIQUE_SERVING_CONFIG_RESTRICTION + // `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION` // // `Valid combinations`: // @@ -160,7 +158,7 @@ message Model { // home_page_ctr_diversity_low, // pdp_cvr_no_diversity // - // `Restriction` = UNIQUE_MODEL_RESTRICTION + // `Restriction` = `UNIQUE_MODEL_RESTRICTION` // // `Valid combinations`: // @@ -192,7 +190,7 @@ message Model { // home_page_ctr_diversity_low, // pdp_cvr_no_diversity // - // `Restriction` = UNIQUE_MODEL_RESTRICTION + // `Restriction` = `UNIQUE_MODEL_RESTRICTION` // // `Valid combinations`: // @@ -247,10 +245,10 @@ message Model { } // Represents an ordered combination of valid serving configs, which - // / may be used for PAGE_OPTIMIZATION recommendations. + // can be used for `PAGE_OPTIMIZATION` recommendations. message ServingConfigList { // Optional. A set of valid serving configs that may be used for - // PAGE_OPTIMIZATION. + // `PAGE_OPTIMIZATION`. repeated string serving_config_ids = 1 [(google.api.field_behavior) = OPTIONAL]; } @@ -266,7 +264,7 @@ message Model { // The model is serving and can be queried. ACTIVE = 2; - // The model is trained on tuned hyperparameters, and can be + // The model is trained on tuned hyperparameters and can be // queried. TUNED = 3; } @@ -285,26 +283,26 @@ message Model { // Describes whether periodic tuning is enabled for this model // or not. Periodic tuning is scheduled at most every three months. You can - // start a tuning process manually by using the ModelTune + // start a tuning process manually by using the `TuneModel` // method, which starts a tuning process immediately and resets the quarterly // schedule. Enabling or disabling periodic tuning does not affect any // current tuning processes. enum PeriodicTuningState { - // Unspecified default value - should never be explicitly set. + // Unspecified default value, should never be explicitly set. PERIODIC_TUNING_STATE_UNSPECIFIED = 0; // The model has periodic tuning disabled. Tuning - // can be reenabled by calling the EnableModelPeriodicTuning - // method or by calling the TuneModel method. + // can be reenabled by calling the `EnableModelPeriodicTuning` + // method or by calling the `TuneModel` method. PERIODIC_TUNING_DISABLED = 1; // The model cannot be tuned with periodic tuning OR the - // TuneModel method. Hide the options in customer UI and + // `TuneModel` method. Hide the options in customer UI and // reject any requests through the backend self serve API. ALL_TUNING_DISABLED = 3; // The model has periodic tuning enabled. Tuning - // can be disabled by calling the DisableModelPeriodicTuning + // can be disabled by calling the `DisableModelPeriodicTuning` // method. PERIODIC_TUNING_ENABLED = 2; } @@ -312,7 +310,7 @@ message Model { // Describes whether this model have sufficient training data // to be continuously trained. enum DataState { - // Unspecified default value - should never be explicitly set. + // Unspecified default value, should never be explicitly set. DATA_STATE_UNSPECIFIED = 0; // The model has sufficient training data. @@ -335,7 +333,7 @@ message Model { // Required. The fully qualified resource name of the model. // // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` // catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. string name = 1 [(google.api.field_behavior) = REQUIRED]; @@ -343,21 +341,21 @@ message Model { // Required. The display name of the model. // // Should be human readable, used to display Recommendation Models in the - // Retail Cloud Cosole Dashboard. UTF-8 encoded string with limit of 1024 + // Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Optional. The training state that the model is in (e.g. - // TRAINING or PAUSED). + // `TRAINING` or `PAUSED`). // // Since part of the cost of running the service // is frequency of training - this can be used to determine when to train // model in order to control cost. If not specified: the default value for - // CreateModel method is TRAINING. the default value for - // UpdateModel method is to keep the state the same as before. + // `CreateModel` method is `TRAINING`. The default value for + // `UpdateModel` method is to keep the state the same as before. TrainingState training_state = 3 [(google.api.field_behavior) = OPTIONAL]; - // Output only. The serving state of the model: ACTIVE, NOT_ACTIVE. + // Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`. ServingState serving_state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp the Recommendation Model was created at. @@ -373,8 +371,19 @@ message Model { // Required. The type of model e.g. `home-page`. // // Currently supported values: `recommended-for-you`, `others-you-may-like`, - // `frequently-bought-together`, `page-optimization`, 'similar-items', - // 'buy-it-again', `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, `similar-items`, + // `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). + // + // + // This field together with + // [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] + // describe model metadata to use to control model training and serving. + // See https://cloud.google.com/retail/docs/models + // for more details on what the model metadata control and which combination + // of parameters are valid. For invalid combinations of parameters (e.g. type + // = `frequently-bought-together` and optimization_objective = `ctr`), you + // receive an error 400 if you try to create/update a recommendation with + // this set of knobs. string type = 7 [(google.api.field_behavior) = REQUIRED]; // Optional. The optimization objective e.g. `cvr`. @@ -390,13 +399,23 @@ message Model { // `others-you-may-like` => `ctr` // // `frequently-bought-together` => `revenue_per_order` + // + // This field together with + // [optimization_objective][google.cloud.retail.v2alpha.Model.type] + // describe model metadata to use to control model training and serving. + // See https://cloud.google.com/retail/docs/models + // for more details on what the model metadata control and which combination + // of parameters are valid. For invalid combinations of parameters (e.g. type + // = `frequently-bought-together` and optimization_objective = `ctr`), you + // receive an error 400 if you try to create/update a recommendation with + // this set of knobs. string optimization_objective = 8 [(google.api.field_behavior) = OPTIONAL]; // Optional. The state of periodic tuning. // // The period we use is 3 months - to do a - // one-off tune earlier use the TuneModel method. Default value - // is PERIODIC_TUNING_ENABLED. + // one-off tune earlier use the `TuneModel` method. Default value + // is `PERIODIC_TUNING_ENABLED`. PeriodicTuningState periodic_tuning_state = 11 [(google.api.field_behavior) = OPTIONAL]; @@ -410,18 +429,18 @@ message Model { // recommendation. Empty field implies no tune is goig on. string tuning_operation = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The state of data requirements for this model: DATA_OK and - // DATA_ERROR. + // Output only. The state of data requirements for this model: `DATA_OK` and + // `DATA_ERROR`. // // Recommendation model cannot be trained if the data is in - // DATA_ERROR state. Recommendation model can have DATA_ERROR state even if - // serving state is ACTIVE: models were trained successfully before, but + // `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even + // if serving state is `ACTIVE`: models were trained successfully before, but // cannot be refreshed because model no longer has sufficient // data for training. DataState data_state = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by - // attributes is enabled for the model. + // Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering + // by attributes is enabled for the model. RecommendationsFilteringOption filtering_option = 18 [(google.api.field_behavior) = OPTIONAL]; diff --git a/google/cloud/retail/v2alpha/model_service.proto b/google/cloud/retail/v2alpha/model_service.proto index 30690f538..af057c514 100644 --- a/google/cloud/retail/v2alpha/model_service.proto +++ b/google/cloud/retail/v2alpha/model_service.proto @@ -36,11 +36,11 @@ option ruby_package = "Google::Cloud::Retail::V2alpha"; // Service for performing CRUD operations on models. // Recommendation models contain all the metadata necessary to generate a set of -// models for the Predict() api. A model is queried +// models for the `Predict()` API. A model is queried // indirectly via a ServingConfig, which associates a model with a // given Placement (e.g. Frequently Bought Together on Home Page). // -// This service allows customers to e.g.: +// This service allows you to do the following: // // * Initiate training of a model. // * Pause training of an existing model. @@ -59,8 +59,8 @@ service ModelService { }; option (google.api.method_signature) = "parent,model"; option (google.longrunning.operation_info) = { - response_type: "Model" - metadata_type: "CreateModelMetadata" + response_type: "google.cloud.retail.v2alpha.Model" + metadata_type: "google.cloud.retail.v2alpha.CreateModelMetadata" }; } @@ -99,8 +99,9 @@ service ModelService { } // Update of model metadata. Only fields that - // currently can be updated are: filtering_option, periodic_tuning_state. - // If other values are provided, this API method will ignore them. + // currently can be updated are: `filtering_option` and + // `periodic_tuning_state`. + // If other values are provided, this API method ignores them. rpc UpdateModel(UpdateModelRequest) returns (Model) { option (google.api.http) = { patch: "/v2alpha/{model.name=projects/*/locations/*/catalogs/*/models/*}" @@ -117,8 +118,8 @@ service ModelService { }; option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { - response_type: "TuneModelResponse" - metadata_type: "TuneModelMetadata" + response_type: "google.cloud.retail.v2alpha.TuneModelResponse" + metadata_type: "google.cloud.retail.v2alpha.TuneModelMetadata" }; } } @@ -126,27 +127,29 @@ service ModelService { // Request for creating a model. message CreateModelRequest { // Required. The parent resource under which to create the model. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" } ]; - // Required. The payload of the [Model] to create. + // Required. The payload of the [Model][google.cloud.retail.v2alpha.Model] to + // create. Model model = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Whether to run a dry_run to validate the request (without + // Optional. Whether to run a dry run to validate the request (without // actually creating the model). bool dry_run = 3 [(google.api.field_behavior) = OPTIONAL]; } // Request for updating an existing model. message UpdateModelRequest { - // Required. The body of the updated [Model]. + // Required. The body of the updated + // [Model][google.cloud.retail.v2alpha.Model]. Model model = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. Indicates which fields in the provided 'model' to - // update. If not set, will by default update all fields. + // update. If not set, by default updates all fields. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; } @@ -155,7 +158,7 @@ message UpdateModelRequest { message PauseModelRequest { // Required. The name of the model to pause. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Model" } @@ -166,7 +169,7 @@ message PauseModelRequest { message ResumeModelRequest { // Required. The name of the model to resume. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string name = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -174,7 +177,7 @@ message ResumeModelRequest { message ListModelsRequest { // Required. The parent for which to list models. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" } @@ -191,9 +194,9 @@ message ListModelsRequest { // Request for deleting a model. message DeleteModelRequest { - // Required. The resource name of the [Model] to delete. - // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // Required. The resource name of the + // [Model][google.cloud.retail.v2alpha.Model] to delete. Format: + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Model" } @@ -214,7 +217,7 @@ message ListModelsResponse { message TuneModelRequest { // Required. The resource name of the model to tune. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Model" } @@ -225,7 +228,7 @@ message TuneModelRequest { message CreateModelMetadata { // The resource name of the model that this create applies to. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string model = 1; } @@ -233,7 +236,7 @@ message CreateModelMetadata { message TuneModelMetadata { // The resource name of the model that this tune applies to. // Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` string model = 1; } diff --git a/google/cloud/retail/v2alpha/prediction_service.proto b/google/cloud/retail/v2alpha/prediction_service.proto index b76aed50b..b88e97e7a 100644 --- a/google/cloud/retail/v2alpha/prediction_service.proto +++ b/google/cloud/retail/v2alpha/prediction_service.proto @@ -19,6 +19,7 @@ package google.cloud.retail.v2alpha; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; import "google/cloud/retail/v2alpha/user_event.proto"; import "google/protobuf/struct.proto"; @@ -61,7 +62,7 @@ message PredictRequest { // The ID of the Recommendations AI serving config or placement. // Before you can request predictions from your model, you must create at // least one serving config or placement for it. For more information, see - // [Managing serving configurations] + // [Manage serving configs] // (https://cloud.google.com/retail/docs/manage-configs). // // The full list of available serving configs can be seen at @@ -84,13 +85,13 @@ message PredictRequest { // [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset. UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED]; - // Maximum number of results to return per page. Set this property - // to the number of prediction results needed. If zero, the service will - // choose a reasonable default. The maximum allowed value is 100. Values - // above 100 will be coerced to 100. + // Maximum number of results to return. Set this property to the number of + // prediction results needed. If zero, the service will choose a reasonable + // default. The maximum allowed value is 100. Values above 100 will be coerced + // to 100. int32 page_size = 3; - // This field is not used for now; leave it unset. + // This field is not used; leave it unset. string page_token = 4 [deprecated = true]; // Filter for restricting prediction results with a length limit of 5,000 @@ -116,12 +117,11 @@ message PredictRequest { // * filterOutOfStockItems tag=(-"promotional") // * filterOutOfStockItems // - // If your filter blocks all prediction results, the API will return generic - // (unfiltered) popular products. If you only want results strictly matching - // the filters, set `strictFiltering` to True in `PredictRequest.params` to - // receive empty results instead. - // Note that the API will never return items with storageStatus of "EXPIRED" - // or "DELETED" regardless of filter choices. + // If your filter blocks all prediction results, the API will return *no* + // results. If instead you want empty result sets to return generic + // (unfiltered) popular products, set `strictFiltering` to False in + // `PredictRequest.params`. Note that the API will never return items with + // storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. // // If `filterSyntaxV2` is set to true under the `params` field, then // attribute-based expressions are expected instead of the above described @@ -148,7 +148,7 @@ message PredictRequest { // * `returnScore`: Boolean. If set to true, the prediction 'score' // corresponding to each returned product will be set in the // `results.metadata` field in the prediction response. The given - // 'score' indicates the probability of an product being clicked/purchased + // 'score' indicates the probability of a product being clicked/purchased // given the user's context and history. // * `strictFiltering`: Boolean. True by default. If set to false, the service // will return generic (unfiltered) popular products instead of empty if diff --git a/google/cloud/retail/v2alpha/product.proto b/google/cloud/retail/v2alpha/product.proto index f4826f1bd..7dd20a744 100644 --- a/google/cloud/retail/v2alpha/product.proto +++ b/google/cloud/retail/v2alpha/product.proto @@ -105,6 +105,13 @@ message Product { oneof expiration { // The timestamp when this product becomes unavailable for // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. + // Note that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], + // and ignored for + // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In + // general, we suggest the users to delete the stale products explicitly, + // instead of using this field to determine staleness. // // If it is set, the [Product][google.cloud.retail.v2alpha.Product] is not // available for @@ -125,7 +132,14 @@ message Product { // [expiration_date](https://support.google.com/merchants/answer/6324499). google.protobuf.Timestamp expire_time = 16; - // Input only. The TTL (time to live) of the product. + // Input only. The TTL (time to live) of the product. Note that this is only + // applicable to + // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], + // and ignored for + // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In + // general, we suggest the users to delete the stale products explicitly, + // instead of using this field to determine staleness. // // If it is set, it must be a non-negative value, and // [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as @@ -200,7 +214,7 @@ message Product { // The [type][google.cloud.retail.v2alpha.Product.type] of the members must be // either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise - // and INVALID_ARGUMENT error is thrown. Should not set it for other types. A + // an INVALID_ARGUMENT error is thrown. Should not set it for other types. A // maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is // return. repeated string collection_member_ids = 5; @@ -231,7 +245,7 @@ message Product { // // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // For example, if a shoes product belongs to both @@ -364,6 +378,11 @@ message Product { // The timestamp when this [Product][google.cloud.retail.v2alpha.Product] // becomes available for // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. + // Note that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and + // ignored for + // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. google.protobuf.Timestamp available_time = 18; // The online availability of the @@ -551,7 +570,9 @@ message Product { // Note: Returning more fields in // [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] can increase // response payload size and serving latency. - google.protobuf.FieldMask retrievable_fields = 30; + // + // This field is deprecated. Use the retrievable site-wide control instead. + google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; // Output only. Product variants grouped together on primary product which // share similar product attributes. It's automatically grouped by @@ -564,4 +585,15 @@ message Product { // [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. // Do not set this field in API requests. repeated Product variants = 31 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A list of local inventories specific to different places. + // + // This is only available for users who have Retail Search enabled, and it can + // be managed by + // [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] + // and + // [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] + // APIs. + repeated LocalInventory local_inventories = 35 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/cloud/retail/v2alpha/product_service.proto b/google/cloud/retail/v2alpha/product_service.proto index 1a5f702bb..ec82c437f 100644 --- a/google/cloud/retail/v2alpha/product_service.proto +++ b/google/cloud/retail/v2alpha/product_service.proto @@ -141,9 +141,9 @@ service ProductService { // // This process is asynchronous and does not require the // [Product][google.cloud.retail.v2alpha.Product] to exist before updating - // fulfillment information. If the request is valid, the update will be - // enqueued and processed downstream. As a consequence, when a response is - // returned, updates are not immediately manifested in the + // fulfillment information. If the request is valid, the update is enqueued + // and processed downstream. As a consequence, when a response is returned, + // updates are not immediately manifested in the // [Product][google.cloud.retail.v2alpha.Product] queried by // [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] // or @@ -153,10 +153,10 @@ service ProductService { // [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] // and // [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct], - // the specified inventory field value(s) will overwrite any existing value(s) + // the specified inventory field value(s) overwrite any existing value(s) // while ignoring the last update time for this field. Furthermore, the last - // update time for the specified inventory fields will be overwritten to the - // time of the + // update times for the specified inventory fields are overwritten by the + // times of the // [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] // or // [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] @@ -164,11 +164,11 @@ service ProductService { // // If no inventory fields are set in // [CreateProductRequest.product][google.cloud.retail.v2alpha.CreateProductRequest.product], - // then any pre-existing inventory information for this product will be used. + // then any pre-existing inventory information for this product is used. // // If no inventory fields are set in // [SetInventoryRequest.set_mask][google.cloud.retail.v2alpha.SetInventoryRequest.set_mask], - // then any existing inventory information will be preserved. + // then any existing inventory information is preserved. // // Pre-existing inventory information can only be updated with // [ProductService.SetInventory][google.cloud.retail.v2alpha.ProductService.SetInventory], @@ -176,8 +176,17 @@ service ProductService { // and // [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces]. // + // The returned [Operation][google.longrunning.Operation]s is obsolete after + // one day, and the [GetOperation][google.longrunning.Operations.GetOperation] + // API returns `NOT_FOUND` afterwards. + // + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates are not marked as [done][google.longrunning.Operation.done] until + // they are obsolete. + // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc SetInventory(SetInventoryRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2alpha/{inventory.name=projects/*/locations/*/catalogs/*/branches/*/products/**}:setInventory" @@ -203,8 +212,17 @@ service ProductService { // or // [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]. // + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. + // + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. + // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc AddFulfillmentPlaces(AddFulfillmentPlacesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -231,8 +249,17 @@ service ProductService { // or // [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]. // + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. + // + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. + // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -266,8 +293,17 @@ service ProductService { // [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] // has no effect on local inventories. // + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. + // + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. + // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc AddLocalInventories(AddLocalInventoriesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -299,8 +335,17 @@ service ProductService { // [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] // has no effect on local inventories. // + // The returned [Operation][google.longrunning.Operation]s will be obsolete + // after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation] + // API will return NOT_FOUND afterwards. + // + // If conflicting updates are issued, the + // [Operation][google.longrunning.Operation]s associated with the stale + // updates will not be marked as [done][google.longrunning.Operation.done] + // until being obsolete. + // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc RemoveLocalInventories(RemoveLocalInventoriesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { diff --git a/google/cloud/retail/v2alpha/retail_v2alpha.yaml b/google/cloud/retail/v2alpha/retail_v2alpha.yaml index 65d5b6a58..8955dd1bc 100644 --- a/google/cloud/retail/v2alpha/retail_v2alpha.yaml +++ b/google/cloud/retail/v2alpha/retail_v2alpha.yaml @@ -64,12 +64,16 @@ backend: rules: - selector: google.cloud.retail.v2alpha.CatalogService.UpdateCatalog deadline: 10.0 + - selector: google.cloud.retail.v2alpha.CompletionService.ImportCompletionData + deadline: 300.0 - selector: 'google.cloud.retail.v2alpha.ModelService.*' deadline: 60.0 - selector: 'google.cloud.retail.v2alpha.ProductService.*' deadline: 30.0 - selector: google.cloud.retail.v2alpha.ProductService.ImportProducts deadline: 300.0 + - selector: google.cloud.retail.v2alpha.UserEventService.CollectUserEvent + deadline: 10.0 - selector: google.cloud.retail.v2alpha.UserEventService.ImportUserEvents deadline: 600.0 - selector: google.cloud.retail.v2alpha.UserEventService.PurgeUserEvents @@ -82,6 +86,7 @@ http: - selector: google.longrunning.Operations.GetOperation get: '/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*/operations/*}' additional_bindings: + - get: '/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*/places/*/operations/*}' - get: '/v2alpha/{name=projects/*/locations/*/catalogs/*/operations/*}' - get: '/v2alpha/{name=projects/*/locations/*/operations/*}' - get: '/v2alpha/{name=projects/*/operations/*}' diff --git a/google/cloud/retail/v2alpha/search_service.proto b/google/cloud/retail/v2alpha/search_service.proto index 24bfa34aa..37526c1f7 100644 --- a/google/cloud/retail/v2alpha/search_service.proto +++ b/google/cloud/retail/v2alpha/search_service.proto @@ -37,7 +37,7 @@ option ruby_package = "Google::Cloud::Retail::V2alpha"; // Service for search. // // This feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this feature. +// Enable Retail Search on Cloud Console before using this feature. service SearchService { option (google.api.default_host) = "retail.googleapis.com"; option (google.api.oauth_scopes) = @@ -46,7 +46,7 @@ service SearchService { // Performs a search. // // This feature is only available for users who have Retail Search enabled. - // Please enable Retail Search on Cloud Console before using this feature. + // Enable Retail Search on Cloud Console before using this feature. rpc Search(SearchRequest) returns (SearchResponse) { option (google.api.http) = { post: "/v2alpha/{placement=projects/*/locations/*/catalogs/*/placements/*}:search" @@ -218,7 +218,7 @@ message SearchRequest { FacetKey facet_key = 1 [(google.api.field_behavior) = REQUIRED]; // Maximum of facet values that should be returned for this facet. If - // unspecified, defaults to 20. The maximum allowed value is 300. Values + // unspecified, defaults to 50. The maximum allowed value is 300. Values // above 300 will be coerced to 300. // // If this field is negative, an INVALID_ARGUMENT is returned. @@ -396,7 +396,8 @@ message SearchRequest { // [Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. MODE_UNSPECIFIED = 0; - // Let CRS decide whether to use personalization. + // Let CRS decide whether to use personalization based on quality of user + // event data. AUTO = 1; // Disable personalization. @@ -458,15 +459,21 @@ message SearchRequest { // The search mode of each search request. enum SearchMode { // Default value. In this case both product search and faceted search will - // be performed. Both [SearchResponse.SearchResult] and - // [SearchResponse.Facet] will be returned. + // be performed. Both + // [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] + // and + // [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] + // will be returned. SEARCH_MODE_UNSPECIFIED = 0; // Only product search will be performed. The faceted search will be // disabled. // - // Only [SearchResponse.SearchResult] will be returned. - // [SearchResponse.Facet] will not be returned, even if + // Only + // [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] + // will be returned. + // [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] + // will not be returned, even if // [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs] // or // [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec] @@ -481,7 +488,9 @@ message SearchRequest { // and // [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec] // should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only - // [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult] + // [SearchResponse.Facet][google.cloud.retail.v2alpha.SearchResponse.Facet] + // will be returned. + // [SearchResponse.SearchResult][google.cloud.retail.v2alpha.SearchResponse.SearchResult] // will not be returned. FACETED_SEARCH_ONLY = 2; } @@ -490,7 +499,7 @@ message SearchRequest { // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` // or the name of the legacy placement resource, such as // `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. - // This field is used to identify the serving configuration name and the set + // This field is used to identify the serving config name and the set // of models that will be used to make the search. string placement = 1 [(google.api.field_behavior) = REQUIRED]; @@ -713,7 +722,7 @@ message SearchRequest { // [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories]; // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // Category pages include special pages such as sales or promotions. For @@ -726,6 +735,15 @@ message SearchRequest { SearchMode search_mode = 31; // The specification for personalization. + // + // Notice that if both + // [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec] + // and + // [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec] + // are set. + // [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec] + // will override + // [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]. PersonalizationSpec personalization_spec = 32; // The labels applied to a resource must meet the following requirements: @@ -829,6 +847,21 @@ message SearchResponse { // `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there // are 10 variants in this product are available in the store "store1". map variant_rollup_values = 5; + + // Specifies previous events related to this product for this user based on + // [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same + // [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] + // or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id]. + // + // This is set only when + // [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.mode] + // is + // [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. + // + // Possible values: + // + // * `purchased`: Indicates that this product has been purchased before. + repeated string personal_labels = 7; } // A facet result. diff --git a/google/cloud/retail/v2alpha/serving_config.proto b/google/cloud/retail/v2alpha/serving_config.proto index d05240124..d4d02c70c 100644 --- a/google/cloud/retail/v2alpha/serving_config.proto +++ b/google/cloud/retail/v2alpha/serving_config.proto @@ -32,14 +32,25 @@ option ruby_package = "Google::Cloud::Retail::V2alpha"; // Configures metadata that is used to generate serving time results (e.g. // search results or recommendation predictions). -// The ServingConfig is passed in the search and predict request and together -// with the Catalog.default_branch, generates results. message ServingConfig { option (google.api.resource) = { type: "retail.googleapis.com/ServingConfig" pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}" }; + // What type of diversity - data or rule based. + // If none is specified, default to rule based. + enum DiversityType { + // Default value. + DIVERSITY_TYPE_UNSPECIFIED = 0; + + // Rule based diversity. + RULE_BASED_DIVERSITY = 2; + + // Data driven diversity. + DATA_DRIVEN_DIVERSITY = 3; + } + // Immutable. Fully qualified name // `projects/*/locations/global/catalogs/*/servingConfig/*` string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -51,7 +62,8 @@ message ServingConfig { // characters. Otherwise, an INVALID_ARGUMENT error is returned. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // The id of the model to use at serving time. + // The id of the model in the same + // [Catalog][google.cloud.retail.v2alpha.Catalog] to use at serving time. // Currently only RecommendationModels are supported: // https://cloud.google.com/retail/recommendations-ai/docs/create-models // Can be changed but only to a compatible model (e.g. @@ -70,13 +82,13 @@ message ServingConfig { // click-through and conversion rates. // Allowed values are: // - // * 'no-price-reranking' - // * 'low-price-raranking' - // * 'medium-price-reranking' - // * 'high-price-reranking' + // * `no-price-reranking` + // * `low-price-raranking` + // * `medium-price-reranking` + // * `high-price-reranking` // // If not specified, we choose default based on model type. Default value: - // 'no-price-reranking'. + // `no-price-reranking`. // // Can only be set if // [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types] @@ -205,16 +217,16 @@ message ServingConfig { repeated string ignore_control_ids = 15; // How much diversity to use in recommendation model results e.g. - // 'medium-diversity' or 'high-diversity'. Currently supported values: + // `medium-diversity` or `high-diversity`. Currently supported values: // - // * 'no-diversity' - // * 'low-diversity' - // * 'medium-diversity' - // * 'high-diversity' - // * 'auto-diversity' + // * `no-diversity` + // * `low-diversity` + // * `medium-diversity` + // * `high-diversity` + // * `auto-diversity` // // If not specified, we choose default based on recommendation model - // type. Default value: 'no-diversity'. + // type. Default value: `no-diversity`. // // Can only be set if // [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types] @@ -222,13 +234,16 @@ message ServingConfig { // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. string diversity_level = 8; - // Whether to add additional category filters on the 'similar-items' model. + // What kind of diversity to use - data driven or rule based. + DiversityType diversity_type = 20; + + // Whether to add additional category filters on the `similar-items` model. // If not specified, we enable it by default. // Allowed values are: // - // * 'no-category-match': No additional filtering of original results from + // * `no-category-match`: No additional filtering of original results from // the model and the customer's filters. - // * 'relaxed-category-match': Only keep results with categories that match + // * `relaxed-category-match`: Only keep results with categories that match // at least one item categories in the PredictRequests's context item. // * If customer also sends filters in the PredictRequest, then the results // will satisfy both conditions (user given and category match). @@ -239,6 +254,23 @@ message ServingConfig { // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. string enable_category_filter_level = 16; + // The specification for personalization spec. + // + // Can only be set if + // [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types] + // is + // [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH]. + // + // Notice that if both + // [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec] + // and + // [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec] + // are set. + // [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec] + // will override + // [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]. + SearchRequest.PersonalizationSpec personalization_spec = 21; + // Required. Immutable. Specifies the solution types that a serving config can // be associated with. Currently we support setting only one type of solution. repeated SolutionType solution_types = 19 [ diff --git a/google/cloud/retail/v2alpha/serving_config_service.proto b/google/cloud/retail/v2alpha/serving_config_service.proto index 311126510..387091079 100644 --- a/google/cloud/retail/v2alpha/serving_config_service.proto +++ b/google/cloud/retail/v2alpha/serving_config_service.proto @@ -159,7 +159,7 @@ message UpdateServingConfigRequest { // Request for DeleteServingConfig method. message DeleteServingConfigRequest { // Required. The resource name of the ServingConfig to delete. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -171,7 +171,7 @@ message DeleteServingConfigRequest { // Request for GetServingConfig method. message GetServingConfigRequest { // Required. The resource name of the ServingConfig to get. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -183,7 +183,7 @@ message GetServingConfigRequest { // Request for ListServingConfigs method. message ListServingConfigsRequest { // Required. The catalog resource name. Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" } @@ -211,7 +211,7 @@ message ListServingConfigsResponse { // Request for AddControl method. message AddControlRequest { // Required. The source ServingConfig resource name . Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string serving_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -227,7 +227,7 @@ message AddControlRequest { // Request for RemoveControl method. message RemoveControlRequest { // Required. The source ServingConfig resource name . Format: - // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}` string serving_config = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/retail/v2alpha/user_event.proto b/google/cloud/retail/v2alpha/user_event.proto index ca25f3003..6d24ca244 100644 --- a/google/cloud/retail/v2alpha/user_event.proto +++ b/google/cloud/retail/v2alpha/user_event.proto @@ -229,7 +229,7 @@ message UserEvent { // The categories associated with a category page. // // To represent full path of category, use '>' sign to separate different - // hierarchies. If '>' is part of the category name, please replace it with + // hierarchies. If '>' is part of the category name, replace it with // other character(s). // // Category pages include special pages such as sales or promotions. For diff --git a/google/cloud/retail/v2alpha/user_event_service.proto b/google/cloud/retail/v2alpha/user_event_service.proto index 35fe33f4b..5e0702bca 100644 --- a/google/cloud/retail/v2alpha/user_event_service.proto +++ b/google/cloud/retail/v2alpha/user_event_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/httpbody.proto"; +import "google/api/resource.proto"; import "google/cloud/retail/v2alpha/import_config.proto"; import "google/cloud/retail/v2alpha/purge_config.proto"; import "google/cloud/retail/v2alpha/user_event.proto"; @@ -79,9 +80,9 @@ service UserEventService { // synchronous. Events that already exist are skipped. // Use this method for backfilling historical user events. // - // Operation.response is of type ImportResponse. Note that it is + // `Operation.response` is of type `ImportResponse`. Note that it is // possible for a subset of the items to be successfully inserted. - // Operation.metadata is of type ImportMetadata. + // `Operation.metadata` is of type `ImportMetadata`. rpc ImportUserEvents(ImportUserEventsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -94,14 +95,14 @@ service UserEventService { }; } - // Starts a user event rejoin operation with latest product catalog. Events - // will not be annotated with detailed product information if product is - // missing from the catalog at the time the user event is ingested, and these - // events are stored as unjoined events with a limited usage on training and - // serving. This method can be used to start a join operation on specified - // events with latest version of product catalog. It can also be used to - // correct events joined with the wrong product catalog. A rejoin operation - // can take hours or days to complete. + // Starts a user-event rejoin operation with latest product catalog. Events + // are not annotated with detailed product information for products that are + // missing from the catalog when the user event is ingested. These + // events are stored as unjoined events with limited usage on training and + // serving. You can use this method to start a join operation on specified + // events with the latest version of product catalog. You can also use this + // method to correct events joined with the wrong product catalog. A rejoin + // operation can take hours or days to complete. rpc RejoinUserEvents(RejoinUserEventsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -123,10 +124,24 @@ message WriteUserEventRequest { // Required. User event to write. UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED]; + + // If set to true, the user event will be written asynchronously after + // validation, and the API will respond without waiting for the write. + // Therefore, silent failures can occur even if the API returns success. In + // case of silent failures, error messages can be found in Stackdriver logs. + bool write_async = 3; } // Request message for CollectUserEvent method. message CollectUserEventRequest { + // The rule that can convert the raw_json to a user event. It is needed + // only when the raw_json is set. + oneof conversion_rule { + // The prebuilt rule name that can convert a specific type of raw_json. + // For example: "default_schema/v1.0" + string prebuilt_rule = 6; + } + // Required. The parent catalog name, such as // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; @@ -145,17 +160,23 @@ message CollectUserEventRequest { // otherwise identical get requests. The name is abbreviated to reduce the // payload bytes. int64 ets = 4; + + // An arbitrary serialized JSON string that contains necessary information + // that can comprise a user event. When this field is specified, the + // user_event field will be ignored. Note: line-delimited JSON is not + // supported, a single JSON only. + string raw_json = 5; } // Request message for RejoinUserEvents method. message RejoinUserEventsRequest { // The scope of user events to be rejoined with the latest product catalog. // If the rejoining aims at reducing number of unjoined events, set - // UserEventRejoinScope to UNJOINED_EVENTS. + // `UserEventRejoinScope` to `UNJOINED_EVENTS`. // If the rejoining aims at correcting product catalog information in joined - // events, set UserEventRejoinScope to JOINED_EVENTS. - // If all events needs to be rejoined, set UserEventRejoinScope to - // USER_EVENT_REJOIN_SCOPE_UNSPECIFIED. + // events, set `UserEventRejoinScope` to `JOINED_EVENTS`. + // If all events needs to be rejoined, set `UserEventRejoinScope` to + // `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`. enum UserEventRejoinScope { // Rejoin all events with the latest product catalog, including both joined // events and unjoined events. @@ -174,16 +195,16 @@ message RejoinUserEventsRequest { // The type of the user event rejoin to define the scope and range of the user // events to be rejoined with the latest product catalog. Defaults to - // USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an - // invalid integer value. + // `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to + // an invalid integer value. UserEventRejoinScope user_event_rejoin_scope = 2; } -// Response message for RejoinUserEvents method. +// Response message for `RejoinUserEvents` method. message RejoinUserEventsResponse { // Number of user events that were joined with latest product catalog. int64 rejoined_user_events_count = 1; } -// Metadata for RejoinUserEvents method. +// Metadata for `RejoinUserEvents` method. message RejoinUserEventsMetadata {} diff --git a/google/cloud/retail/v2beta/BUILD.bazel b/google/cloud/retail/v2beta/BUILD.bazel index e91ace7ee..3a8972847 100644 --- a/google/cloud/retail/v2beta/BUILD.bazel +++ b/google/cloud/retail/v2beta/BUILD.bazel @@ -96,6 +96,7 @@ java_gapic_library( srcs = [":retail_proto_with_info"], gapic_yaml = "retail_gapic.yaml", grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2beta.yaml", test_deps = [ ":retail_java_grpc", @@ -176,13 +177,15 @@ go_gapic_library( grpc_service_config = "retail_grpc_service_config.json", importpath = "cloud.google.com/go/retail/apiv2beta;retail", metadata = True, + rest_numeric_enums = True, + transport = "grpc+rest", service_yaml = "retail_v2beta.yaml", deps = [ ":retail_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -220,6 +223,7 @@ py_gapic_library( name = "retail_py_gapic", srcs = [":retail_proto"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -267,7 +271,9 @@ php_gapic_library( name = "retail_php_gapic", srcs = [":retail_proto_with_info"], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2beta.yaml", + transport = "grpc+rest", deps = [ ":retail_php_grpc", ":retail_php_proto", @@ -299,10 +305,12 @@ nodejs_gapic_library( src = ":retail_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "retail_grpc_service_config.json", + mixins = "google.longrunning.Operations;google.cloud.location.Locations", package = "google.cloud.retail.v2beta", + rest_numeric_enums = True, service_yaml = "retail_v2beta.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations;google.cloud.location.Locations", ) nodejs_gapic_assembly_pkg( @@ -346,6 +354,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/retail/docs/apis", ], grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Retail enables you to build an end-to-end personalized recommendation system based on state-of-the-art deep learning ML models, without a need for expertise in ML or recommendation systems.", ruby_cloud_title = "Retail V2beta", deps = [ @@ -391,6 +400,7 @@ csharp_gapic_library( srcs = [":retail_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "retail_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "retail_v2beta.yaml", deps = [ ":retail_csharp_grpc", diff --git a/google/cloud/retail/v2beta/catalog.proto b/google/cloud/retail/v2beta/catalog.proto index c95e3ac93..ca691cc86 100644 --- a/google/cloud/retail/v2beta/catalog.proto +++ b/google/cloud/retail/v2beta/catalog.proto @@ -104,8 +104,7 @@ message CatalogAttribute { // The status of the indexable option of a catalog attribute. enum IndexableOption { - // Value used when unset. Defaults to - // [INDEXABLE_ENABLED][google.cloud.retail.v2beta.CatalogAttribute.IndexableOption.INDEXABLE_ENABLED]. + // Value used when unset. INDEXABLE_OPTION_UNSPECIFIED = 0; // Indexable option enabled for an attribute. @@ -117,8 +116,7 @@ message CatalogAttribute { // The status of the dynamic facetable option of a catalog attribute. enum DynamicFacetableOption { - // Value used when unset. Defaults to - // [DYNAMIC_FACETABLE_ENABLED][google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED]. + // Value used when unset. DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0; // Dynamic facetable option enabled for an attribute. @@ -130,8 +128,7 @@ message CatalogAttribute { // The status of the searchable option of a catalog attribute. enum SearchableOption { - // Value used when unset. Defaults to - // [SEARCHABLE_DISABLED][google.cloud.retail.v2beta.CatalogAttribute.SearchableOption.SEARCHABLE_DISABLED]. + // Value used when unset. SEARCHABLE_OPTION_UNSPECIFIED = 0; // Searchable option enabled for an attribute. @@ -154,6 +151,19 @@ message CatalogAttribute { EXACT_SEARCHABLE_DISABLED = 2; } + // The status of the retrievable option of a catalog attribute. + enum RetrievableOption { + // Value used when unset. Defaults to + // [RETRIEVABLE_DISABLED][google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED]. + RETRIEVABLE_OPTION_UNSPECIFIED = 0; + + // Retrievable option enabled for an attribute. + RETRIEVABLE_ENABLED = 1; + + // Retrievable option disabled for an attribute. + RETRIEVABLE_DISABLED = 2; + } + // Required. Attribute name. // For example: `color`, `brands`, `attributes.custom_attribute`, such as // `attributes.xyz`. @@ -177,13 +187,13 @@ message CatalogAttribute { // APIs. This field is `False` for pre-loaded // [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s. // - // Only pre-loaded - // [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s that are - // neither in use by products nor predefined can be deleted. - // [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s that are - // either in use by products or are predefined cannot be deleted; however, - // their configuration properties will reset to default values upon removal - // request. + // Only pre-loaded [catalog + // attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither + // in use by products nor predefined can be deleted. [Catalog + // attributes][google.cloud.retail.v2beta.CatalogAttribute] that are + // either in use by products or are predefined attributes cannot be deleted; + // however, their configuration properties will reset to default values upon + // removal request. // // After catalog changes, it takes about 10 minutes for this field to update. bool in_use = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -197,12 +207,16 @@ message CatalogAttribute { // is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in // [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. + // + // Must be specified, otherwise throws INVALID_FORMAT error. IndexableOption indexable_option = 5; // If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic // facet. Could only be DYNAMIC_FACETABLE_DISABLED if // [CatalogAttribute.indexable_option][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] // is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. + // + // Must be specified, otherwise throws INVALID_FORMAT error. DynamicFacetableOption dynamic_facetable_option = 6; // When @@ -215,6 +229,8 @@ message CatalogAttribute { // will not be searchable by text queries in // [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as // there are no text values associated to numerical attributes. + // + // Must be specified, otherwise throws INVALID_FORMAT error. SearchableOption searchable_option = 7; // When @@ -229,6 +245,10 @@ message CatalogAttribute { // This property only applies to textual custom attributes and requires // indexable set to enabled to enable exact-searchable. ExactSearchableOption exact_searchable_option = 11; + + // If RETRIEVABLE_ENABLED, attribute values are retrievable in the search + // results. + RetrievableOption retrievable_option = 12; } // Catalog level attribute config. @@ -353,16 +373,16 @@ message CompletionConfig { // will be streamed to the linked branch. message MerchantCenterLink { // Required. The linked [Merchant center account - // id](https://developers.google.com/shopping-content/guides/accountstatuses). + // ID](https://developers.google.com/shopping-content/guides/accountstatuses). // The account must be a standalone account or a sub-account of a MCA. int64 merchant_center_account_id = 1 [(google.api.field_behavior) = REQUIRED]; - // The branch id (e.g. 0/1/2) within this catalog that products from + // The branch ID (e.g. 0/1/2) within this catalog that products from // merchant_center_account_id are streamed to. When updating this field, an // empty value will use the currently configured default branch. However, // changing the default branch later on won't change the linked branch here. // - // A single branch id can only have one linked merchant center account id. + // A single branch ID can only have one linked merchant center account ID. string branch_id = 2; // String representing the destination to import for, all if left empty. @@ -392,6 +412,21 @@ message MerchantCenterLink { // // Example value: `en`. string language_code = 5; + + // Criteria for the Merchant Center feeds to be ingested via the link. + // All offers will be ingested if the list is empty. + // Otherwise the offers will be ingested from selected feeds. + repeated MerchantCenterFeedFilter feeds = 6; +} + +// Merchant Center Feed filter criterion. +message MerchantCenterFeedFilter { + // Merchant Center primary feed ID. + int64 primary_feed_id = 1; + + // Merchant Center primary feed name. The name is used for the display + // purposes only. + string primary_feed_name = 2; } // Configures Merchant Center linking. diff --git a/google/cloud/retail/v2beta/catalog_service.proto b/google/cloud/retail/v2beta/catalog_service.proto index 7001c2113..bab1fc34a 100644 --- a/google/cloud/retail/v2beta/catalog_service.proto +++ b/google/cloud/retail/v2beta/catalog_service.proto @@ -483,13 +483,18 @@ message BatchRemoveCatalogAttributesRequest { // Response of the // [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes]. message BatchRemoveCatalogAttributesResponse { - // Catalog attributes that were deleted. Only attributes that are not [in - // use][CatalogAttribute.in_use] by products can be deleted. + // Catalog attributes that were deleted. Only pre-loaded [catalog + // attributes][google.cloud.retail.v2beta.CatalogAttribute] that are + // neither [in + // use][google.cloud.retail.v2beta.CatalogAttribute.in_use] by + // products nor predefined can be deleted. repeated string deleted_catalog_attributes = 1; - // Catalog attributes that were reset. Attributes that are [in - // use][CatalogAttribute.in_use] by products cannot be deleted, however their - // configuration properties will reset to default values upon removal request. + // Catalog attributes that were reset. [Catalog + // attributes][google.cloud.retail.v2beta.CatalogAttribute] that are either + // [in use][google.cloud.retail.v2beta.CatalogAttribute.in_use] by products or + // are predefined attributes cannot be deleted; however, their configuration + // properties will reset to default values upon removal request. repeated string reset_catalog_attributes = 2; } diff --git a/google/cloud/retail/v2beta/common.proto b/google/cloud/retail/v2beta/common.proto index fd1247636..5aab1d0dd 100644 --- a/google/cloud/retail/v2beta/common.proto +++ b/google/cloud/retail/v2beta/common.proto @@ -218,7 +218,8 @@ message Rule { } // Creates a set of terms that will be treated as synonyms of each other. - // Example: synonyms of "sneakers" and "shoes". + // Example: synonyms of "sneakers" and "shoes": + // // * "sneakers" will use a synonym of "shoes". // * "shoes" will use a synonym of "sneakers". message TwowaySynonymsAction { diff --git a/google/cloud/retail/v2beta/completion_service.proto b/google/cloud/retail/v2beta/completion_service.proto index 4db036647..635189b60 100644 --- a/google/cloud/retail/v2beta/completion_service.proto +++ b/google/cloud/retail/v2beta/completion_service.proto @@ -110,8 +110,10 @@ message CompleteQueryRequest { // number of language codes is 3. repeated string language_codes = 3; - // The device type context for completion suggestions. - // It is useful to apply different suggestions on different device types, e.g. + // The device type context for completion suggestions. We recommend that you + // leave this field empty. + // + // It can apply different suggestions on different device types, e.g. // `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device // types. // diff --git a/google/cloud/retail/v2beta/control.proto b/google/cloud/retail/v2beta/control.proto index 238f0f5fe..2d6367199 100644 --- a/google/cloud/retail/v2beta/control.proto +++ b/google/cloud/retail/v2beta/control.proto @@ -68,8 +68,8 @@ message Control { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. List of [serving - // configuration][google.cloud.retail.v2beta.ServingConfig] ids that are - // associated with this control in the same + // config][google.cloud.retail.v2beta.ServingConfig] ids that are associated + // with this control in the same // [Catalog][google.cloud.retail.v2beta.Catalog]. // // Note the association is managed via the diff --git a/google/cloud/retail/v2beta/export_config.proto b/google/cloud/retail/v2beta/export_config.proto index de24f4190..d330c6faa 100644 --- a/google/cloud/retail/v2beta/export_config.proto +++ b/google/cloud/retail/v2beta/export_config.proto @@ -81,10 +81,14 @@ message ExportUserEventsResponse { OutputResult output_result = 3; } -// Output result. +// Output result that stores the information about where the exported data is +// stored. message OutputResult { - // Export result in BigQuery. + // The BigQuery location where the result is stored. repeated BigQueryOutputResult bigquery_result = 1; + + // The Google Cloud Storage location where the result is stored. + repeated GcsOutputResult gcs_result = 2; } // A BigQuery output result. @@ -95,3 +99,9 @@ message BigQueryOutputResult { // The ID of a BigQuery Table. string table_id = 2; } + +// A Gcs output result. +message GcsOutputResult { + // The uri of Gcs output + string output_uri = 1; +} diff --git a/google/cloud/retail/v2beta/model.proto b/google/cloud/retail/v2beta/model.proto index ea4bd30c6..3141b0df5 100644 --- a/google/cloud/retail/v2beta/model.proto +++ b/google/cloud/retail/v2beta/model.proto @@ -160,7 +160,8 @@ message Model { // // Currently supported values: `recommended-for-you`, `others-you-may-like`, // `frequently-bought-together`, `page-optimization`, `similar-items`, - // `buy-it-again`, and `recently-viewed`(readonly value). + // `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). + // // // This field together with // [optimization_objective][google.cloud.retail.v2beta.Model.optimization_objective] diff --git a/google/cloud/retail/v2beta/prediction_service.proto b/google/cloud/retail/v2beta/prediction_service.proto index 1ac3026d6..7b3f322f1 100644 --- a/google/cloud/retail/v2beta/prediction_service.proto +++ b/google/cloud/retail/v2beta/prediction_service.proto @@ -62,7 +62,7 @@ message PredictRequest { // The ID of the Recommendations AI serving config or placement. // Before you can request predictions from your model, you must create at // least one serving config or placement for it. For more information, see - // [Managing serving configurations] + // [Manage serving configs] // (https://cloud.google.com/retail/docs/manage-configs). // // The full list of available serving configs can be seen at @@ -117,12 +117,11 @@ message PredictRequest { // * filterOutOfStockItems tag=(-"promotional") // * filterOutOfStockItems // - // If your filter blocks all prediction results, the API will return generic - // (unfiltered) popular products. If you only want results strictly matching - // the filters, set `strictFiltering` to True in `PredictRequest.params` to - // receive empty results instead. - // Note that the API will never return items with storageStatus of "EXPIRED" - // or "DELETED" regardless of filter choices. + // If your filter blocks all prediction results, the API will return *no* + // results. If instead you want empty result sets to return generic + // (unfiltered) popular products, set `strictFiltering` to False in + // `PredictRequest.params`. Note that the API will never return items with + // storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. // // If `filterSyntaxV2` is set to true under the `params` field, then // attribute-based expressions are expected instead of the above described @@ -149,7 +148,7 @@ message PredictRequest { // * `returnScore`: Boolean. If set to true, the prediction 'score' // corresponding to each returned product will be set in the // `results.metadata` field in the prediction response. The given - // 'score' indicates the probability of an product being clicked/purchased + // 'score' indicates the probability of a product being clicked/purchased // given the user's context and history. // * `strictFiltering`: Boolean. True by default. If set to false, the service // will return generic (unfiltered) popular products instead of empty if diff --git a/google/cloud/retail/v2beta/product.proto b/google/cloud/retail/v2beta/product.proto index 8b1009013..383c06a2b 100644 --- a/google/cloud/retail/v2beta/product.proto +++ b/google/cloud/retail/v2beta/product.proto @@ -105,6 +105,13 @@ message Product { oneof expiration { // The timestamp when this product becomes unavailable for // [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. + // Note that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], + // and ignored for + // [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]. In + // general, we suggest the users to delete the stale products explicitly, + // instead of using this field to determine staleness. // // If it is set, the [Product][google.cloud.retail.v2beta.Product] is not // available for @@ -125,7 +132,14 @@ message Product { // [expiration_date](https://support.google.com/merchants/answer/6324499). google.protobuf.Timestamp expire_time = 16; - // Input only. The TTL (time to live) of the product. + // Input only. The TTL (time to live) of the product. Note that this is only + // applicable to + // [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], + // and ignored for + // [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]. In + // general, we suggest the users to delete the stale products explicitly, + // instead of using this field to determine staleness. // // If it is set, it must be a non-negative value, and // [expire_time][google.cloud.retail.v2beta.Product.expire_time] is set as @@ -363,6 +377,11 @@ message Product { // The timestamp when this [Product][google.cloud.retail.v2beta.Product] // becomes available for // [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. + // Note that this is only applicable to + // [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and + // [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and + // ignored for + // [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]. google.protobuf.Timestamp available_time = 18; // The online availability of the @@ -550,7 +569,9 @@ message Product { // Note: Returning more fields in // [SearchResponse][google.cloud.retail.v2beta.SearchResponse] can increase // response payload size and serving latency. - google.protobuf.FieldMask retrievable_fields = 30; + // + // This field is deprecated. Use the retrievable site-wide control instead. + google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; // Output only. Product variants grouped together on primary product which // share similar product attributes. It's automatically grouped by diff --git a/google/cloud/retail/v2beta/retail_grpc_service_config.json b/google/cloud/retail/v2beta/retail_grpc_service_config.json index b3f709bd6..8e587919d 100644 --- a/google/cloud/retail/v2beta/retail_grpc_service_config.json +++ b/google/cloud/retail/v2beta/retail_grpc_service_config.json @@ -35,6 +35,17 @@ "DEADLINE_EXCEEDED" ] } + }, { + "name": [ + { "service": "google.cloud.retail.v2alpha.ModelService" } + ], + "timeout": "60s", + "retryPolicy": { + "initialBackoff": "0.100s", + "maxBackoff": "60s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE", "DEADLINE_EXCEEDED"] + } }, { "name": [ { diff --git a/google/cloud/retail/v2beta/retail_v2beta.yaml b/google/cloud/retail/v2beta/retail_v2beta.yaml index 3a114a3bb..f0ed2b85e 100644 --- a/google/cloud/retail/v2beta/retail_v2beta.yaml +++ b/google/cloud/retail/v2beta/retail_v2beta.yaml @@ -22,6 +22,7 @@ types: - name: google.cloud.retail.v2beta.AddFulfillmentPlacesResponse - name: google.cloud.retail.v2beta.AddLocalInventoriesMetadata - name: google.cloud.retail.v2beta.AddLocalInventoriesResponse +- name: google.cloud.retail.v2beta.CreateModelMetadata - name: google.cloud.retail.v2beta.ExportErrorsConfig - name: google.cloud.retail.v2beta.ExportMetadata - name: google.cloud.retail.v2beta.ExportProductsResponse @@ -31,6 +32,7 @@ types: - name: google.cloud.retail.v2beta.ImportMetadata - name: google.cloud.retail.v2beta.ImportProductsResponse - name: google.cloud.retail.v2beta.ImportUserEventsResponse +- name: google.cloud.retail.v2beta.Model - name: google.cloud.retail.v2beta.PurgeMetadata - name: google.cloud.retail.v2beta.PurgeUserEventsResponse - name: google.cloud.retail.v2beta.RejoinUserEventsMetadata @@ -41,6 +43,8 @@ types: - name: google.cloud.retail.v2beta.RemoveLocalInventoriesResponse - name: google.cloud.retail.v2beta.SetInventoryMetadata - name: google.cloud.retail.v2beta.SetInventoryResponse +- name: google.cloud.retail.v2beta.TuneModelMetadata +- name: google.cloud.retail.v2beta.TuneModelResponse documentation: summary: |- @@ -58,10 +62,16 @@ backend: rules: - selector: google.cloud.retail.v2beta.CatalogService.UpdateCatalog deadline: 10.0 + - selector: google.cloud.retail.v2beta.CompletionService.ImportCompletionData + deadline: 300.0 + - selector: 'google.cloud.retail.v2beta.ModelService.*' + deadline: 60.0 - selector: 'google.cloud.retail.v2beta.ProductService.*' deadline: 30.0 - selector: google.cloud.retail.v2beta.ProductService.ImportProducts deadline: 300.0 + - selector: google.cloud.retail.v2beta.UserEventService.CollectUserEvent + deadline: 10.0 - selector: google.cloud.retail.v2beta.UserEventService.ImportUserEvents deadline: 600.0 - selector: google.cloud.retail.v2beta.UserEventService.PurgeUserEvents diff --git a/google/cloud/retail/v2beta/search_service.proto b/google/cloud/retail/v2beta/search_service.proto index 5a1004410..9bbf255b2 100644 --- a/google/cloud/retail/v2beta/search_service.proto +++ b/google/cloud/retail/v2beta/search_service.proto @@ -218,7 +218,7 @@ message SearchRequest { FacetKey facet_key = 1 [(google.api.field_behavior) = REQUIRED]; // Maximum of facet values that should be returned for this facet. If - // unspecified, defaults to 20. The maximum allowed value is 300. Values + // unspecified, defaults to 50. The maximum allowed value is 300. Values // above 300 will be coerced to 300. // // If this field is negative, an INVALID_ARGUMENT is returned. @@ -478,7 +478,7 @@ message SearchRequest { // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` // or the name of the legacy placement resource, such as // `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. - // This field is used to identify the serving configuration name and the set + // This field is used to identify the serving config name and the set // of models that will be used to make the search. string placement = 1 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/cloud/retail/v2beta/user_event_service.proto b/google/cloud/retail/v2beta/user_event_service.proto index 74dccdff8..4dc822bdc 100644 --- a/google/cloud/retail/v2beta/user_event_service.proto +++ b/google/cloud/retail/v2beta/user_event_service.proto @@ -124,10 +124,24 @@ message WriteUserEventRequest { // Required. User event to write. UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED]; + + // If set to true, the user event will be written asynchronously after + // validation, and the API will respond without waiting for the write. + // Therefore, silent failures can occur even if the API returns success. In + // case of silent failures, error messages can be found in Stackdriver logs. + bool write_async = 3; } // Request message for CollectUserEvent method. message CollectUserEventRequest { + // The rule that can convert the raw_json to a user event. It is needed + // only when the raw_json is set. + oneof conversion_rule { + // The prebuilt rule name that can convert a specific type of raw_json. + // For example: "default_schema/v1.0" + string prebuilt_rule = 6; + } + // Required. The parent catalog name, such as // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; @@ -146,6 +160,12 @@ message CollectUserEventRequest { // otherwise identical get requests. The name is abbreviated to reduce the // payload bytes. int64 ets = 4; + + // An arbitrary serialized JSON string that contains necessary information + // that can comprise a user event. When this field is specified, the + // user_event field will be ignored. Note: line-delimited JSON is not + // supported, a single JSON only. + string raw_json = 5; } // Request message for RejoinUserEvents method. diff --git a/google/cloud/run/BUILD.bazel b/google/cloud/run/BUILD.bazel index 41b0e9d15..87908ac70 100644 --- a/google/cloud/run/BUILD.bazel +++ b/google/cloud/run/BUILD.bazel @@ -21,7 +21,7 @@ ruby_cloud_gapic_library( srcs = ["//google/cloud/run/v2:run_proto_with_info"], extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-run", - "ruby-cloud-wrapper-of=v2:0.0", + "ruby-cloud-wrapper-of=v2:0.5", "ruby-cloud-product-url=https://cloud.google.com/run", "ruby-cloud-api-id=run.googleapis.com", "ruby-cloud-api-shortname=run", diff --git a/google/cloud/run/v2/BUILD.bazel b/google/cloud/run/v2/BUILD.bazel index 6162da2c0..b35b5bfa2 100644 --- a/google/cloud/run/v2/BUILD.bazel +++ b/google/cloud/run/v2/BUILD.bazel @@ -22,10 +22,15 @@ proto_library( name = "run_proto", srcs = [ "condition.proto", + "execution.proto", + "execution_template.proto", + "job.proto", "k8s.min.proto", "revision.proto", "revision_template.proto", "service.proto", + "task.proto", + "task_template.proto", "traffic_target.proto", "vendor_settings.proto", ], @@ -39,6 +44,7 @@ proto_library( "//google/iam/v1:iam_policy_proto", "//google/iam/v1:policy_proto", "//google/longrunning:operations_proto", + "//google/rpc:status_proto", "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:timestamp_proto", ], @@ -49,6 +55,7 @@ proto_library_with_info( deps = [ ":run_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -80,15 +87,18 @@ java_gapic_library( srcs = [":run_proto_with_info"], gapic_yaml = None, grpc_service_config = "run_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "run_v2.yaml", test_deps = [ ":run_java_grpc", + "//google/cloud/location:location_java_grpc", "//google/iam/v1:iam_java_grpc", ], transport = "grpc+rest", deps = [ ":run_java_proto", "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", "//google/iam/v1:iam_java_proto", ], ) @@ -96,10 +106,16 @@ java_gapic_library( java_gapic_test( name = "run_java_gapic_test_suite", test_classes = [ + "com.google.cloud.run.v2.ExecutionsClientHttpJsonTest", + "com.google.cloud.run.v2.ExecutionsClientTest", + "com.google.cloud.run.v2.JobsClientHttpJsonTest", + "com.google.cloud.run.v2.JobsClientTest", "com.google.cloud.run.v2.RevisionsClientHttpJsonTest", "com.google.cloud.run.v2.RevisionsClientTest", "com.google.cloud.run.v2.ServicesClientHttpJsonTest", "com.google.cloud.run.v2.ServicesClientTest", + "com.google.cloud.run.v2.TasksClientHttpJsonTest", + "com.google.cloud.run.v2.TasksClientTest", ], runtime_deps = [":run_java_gapic_test"], ) @@ -139,6 +155,7 @@ go_proto_library( "//google/api:routing_go_proto", "//google/iam/v1:iam_go_proto", "//google/longrunning:longrunning_go_proto", + "//google/rpc:status_go_proto", ], ) @@ -148,14 +165,16 @@ go_gapic_library( grpc_service_config = "run_grpc_service_config.json", importpath = "cloud.google.com/go/run/apiv2;run", metadata = True, + rest_numeric_enums = True, service_yaml = "run_v2.yaml", transport = "grpc+rest", deps = [ ":run_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", + "@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", ], ) @@ -185,12 +204,14 @@ load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", "py_gapic_library", + "py_test", ) py_gapic_library( name = "run_py_gapic", srcs = [":run_proto"], grpc_service_config = "run_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "run_v2.yaml", transport = "grpc+rest", deps = [ @@ -242,7 +263,9 @@ php_gapic_library( name = "run_php_gapic", srcs = [":run_proto_with_info"], grpc_service_config = "run_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "run_v2.yaml", + transport = "grpc+rest", deps = [ ":run_php_grpc", ":run_php_proto", @@ -275,7 +298,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "run_grpc_service_config.json", package = "google.cloud.run.v2", + rest_numeric_enums = True, service_yaml = "run_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -320,8 +345,10 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-run-client", ], grpc_service_config = "run_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Run deploys and manages user provided container images that scale automatically based on incoming requests.", ruby_cloud_title = "Cloud Run V2", + service_yaml = "run_v2.yaml", deps = [ ":run_ruby_grpc", ":run_ruby_proto", @@ -365,6 +392,7 @@ csharp_gapic_library( srcs = [":run_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "run_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "run_v2.yaml", deps = [ ":run_csharp_grpc", diff --git a/google/cloud/run/v2/condition.proto b/google/cloud/run/v2/condition.proto index 3e98749c9..bfc653647 100644 --- a/google/cloud/run/v2/condition.proto +++ b/google/cloud/run/v2/condition.proto @@ -162,6 +162,9 @@ message Condition { // A task reached its retry limit and the last attempt failed due to the // user container exiting with a non-zero exit code. NON_ZERO_EXIT_CODE = 2; + + // The execution was cancelled by users. + CANCELLED = 3; } // type is used to communicate the status of the reconciliation process. @@ -185,7 +188,7 @@ message Condition { // The reason for this condition. Depending on the condition type, // it will populate one of these fields. - // Successful conditions may not have a reason. + // Successful conditions cannot have a reason. oneof reasons { // A common (service-level) reason for this condition. CommonReason reason = 6; diff --git a/google/cloud/run/v2/execution.proto b/google/cloud/run/v2/execution.proto new file mode 100644 index 000000000..04644caea --- /dev/null +++ b/google/cloud/run/v2/execution.proto @@ -0,0 +1,256 @@ +// 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.run.v2; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/launch_stage.proto"; +import "google/api/resource.proto"; +import "google/cloud/run/v2/condition.proto"; +import "google/cloud/run/v2/task_template.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/run/v2;run"; +option java_multiple_files = true; +option java_outer_classname = "ExecutionProto"; +option java_package = "com.google.cloud.run.v2"; + +// Cloud Run Execution Control Plane API. +service Executions { + option (google.api.default_host) = "run.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Gets information about an Execution. + rpc GetExecution(GetExecutionRequest) returns (Execution) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/jobs/*/executions/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists Executions from a Job. + rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*/jobs/*}/executions" + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes an Execution. + rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v2/{name=projects/*/locations/*/jobs/*/executions/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Execution" + metadata_type: "Execution" + }; + } +} + +// Request message for obtaining a Execution by its full name. +message GetExecutionRequest { + // Required. The full name of the Execution. + // Format: + // projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, + // where {project} can be project id or number. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Execution" + } + ]; +} + +// Request message for retrieving a list of Executions. +message ListExecutionsRequest { + // Required. The Execution from which the Executions should be listed. + // To list all Executions across Jobs, use "-" instead of Job name. + // Format: projects/{project}/locations/{location}/jobs/{job}, where {project} + // can be project id or number. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "run.googleapis.com/Execution" + } + ]; + + // Maximum number of Executions to return in this call. + int32 page_size = 2; + + // A page token received from a previous call to ListExecutions. + // All other parameters must match. + string page_token = 3; + + // If true, returns deleted (but unexpired) resources along with active ones. + bool show_deleted = 4; +} + +// Response message containing a list of Executions. +message ListExecutionsResponse { + // The resulting list of Executions. + repeated Execution executions = 1; + + // A token indicating there are more items than page_size. Use it in the next + // ListExecutions request to continue. + string next_page_token = 2; +} + +// Request message for deleting an Execution. +message DeleteExecutionRequest { + // Required. The name of the Execution to delete. + // Format: + // projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, + // where {project} can be project id or number. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Execution" + } + ]; + + // Indicates that the request should be validated without actually + // deleting any resources. + bool validate_only = 2; + + // A system-generated fingerprint for this version of the resource. + // This may be used to detect modification conflict during updates. + string etag = 3; +} + +// Execution represents the configuration of a single execution. A execution an +// immutable resource that references a container image which is run to +// completion. +message Execution { + option (google.api.resource) = { + type: "run.googleapis.com/Execution" + pattern: "projects/{project}/locations/{location}/jobs/{job}/executions/{execution}" + style: DECLARATIVE_FRIENDLY + }; + + // Output only. The unique name of this Execution. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Server assigned unique identifier for the Execution. The value is a UUID4 + // string and guaranteed to remain unchanged until the resource is deleted. + string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A number that monotonically increases every time the user + // modifies the desired state. + int64 generation = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // KRM-style labels for the resource. + // User-provided labels are shared with Google's billing system, so they can + // be used to filter, or break down billing charges by team, component, + // environment, state, etc. For more information, visit + // https://cloud.google.com/resource-manager/docs/creating-managing-labels or + // https://cloud.google.com/run/docs/configuring/labels + // Cloud Run will populate some labels with 'run.googleapis.com' or + // 'serving.knative.dev' namespaces. Those labels are read-only, and user + // changes will not be preserved. + map labels = 4; + + // KRM-style annotations for the resource. + map annotations = 5; + + // Output only. Represents time when the execution was acknowledged by the execution + // controller. It is not guaranteed to be set in happens-before order across + // separate operations. + google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Represents time when the execution started to run. + // It is not guaranteed to be set in happens-before order across separate + // operations. + google.protobuf.Timestamp start_time = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Represents time when the execution was completed. It is not guaranteed to + // be set in happens-before order across separate operations. + google.protobuf.Timestamp completion_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The last-modified time. + google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. For a deleted resource, the deletion time. It is only + // populated as a response to a Delete request. + google.protobuf.Timestamp delete_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. For a deleted resource, the time after which it will be + // permamently deleted. It is only populated as a response to a Delete + // request. + google.protobuf.Timestamp expire_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Set the launch stage to a preview stage on write to allow use of preview + // features in that stage. On read, describes whether the resource uses + // preview features. Launch Stages are defined at [Google Cloud Platform + // Launch Stages](https://cloud.google.com/terms/launch-stages). + google.api.LaunchStage launch_stage = 11; + + // Output only. The name of the parent Job. + string job = 12 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "run.googleapis.com/Job" + } + ]; + + // Output only. Specifies the maximum desired number of tasks the execution should + // run at any given time. Must be <= task_count. The actual number of + // tasks running in steady state will be less than this number when + // ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when + // the work left to do is less than max parallelism. More info: + // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + int32 parallelism = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Specifies the desired number of tasks the execution should run. + // Setting to 1 means that parallelism is limited to 1 and the success of + // that task signals the success of the execution. + // More info: + // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + int32 task_count = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The template used to create tasks for this execution. + TaskTemplate template = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Indicates whether the resource's reconciliation is still in progress. + // See comments in `Job.reconciling` for additional information on + // reconciliation process in Cloud Run. + bool reconciling = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The Condition of this Execution, containing its readiness status, and + // detailed error information in case it did not reach the desired state. + repeated Condition conditions = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The generation of this Execution. See comments in `reconciling` for + // additional information on reconciliation process in Cloud Run. + int64 observed_generation = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The number of actively running tasks. + int32 running_count = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The number of tasks which reached phase Succeeded. + int32 succeeded_count = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The number of tasks which reached phase Failed. + int32 failed_count = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A system-generated fingerprint for this version of the + // resource. May be used to detect modification conflict during updates. + string etag = 99 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/cloud/run/v2/execution_template.proto b/google/cloud/run/v2/execution_template.proto new file mode 100644 index 000000000..e0657f6cb --- /dev/null +++ b/google/cloud/run/v2/execution_template.proto @@ -0,0 +1,54 @@ +// 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.run.v2; + +import "google/api/field_behavior.proto"; +import "google/cloud/run/v2/task_template.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/run/v2;run"; +option java_multiple_files = true; +option java_outer_classname = "ExecutionTemplateProto"; +option java_package = "com.google.cloud.run.v2"; + +// ExecutionTemplate describes the data an execution should have when created +// from a template. +message ExecutionTemplate { + // KRM-style labels for the resource. + map labels = 1; + + // KRM-style annotations for the resource. + map annotations = 2; + + // Specifies the maximum desired number of tasks the execution should run at + // given time. Must be <= task_count. + // When the job is run, if this field is 0 or unset, the maximum possible + // value will be used for that execution. + // The actual number of tasks running in steady state will be less than this + // number when there are fewer tasks waiting to be completed remaining, + // i.e. when the work left to do is less than max parallelism. + int32 parallelism = 3; + + // Specifies the desired number of tasks the execution should run. + // Setting to 1 means that parallelism is limited to 1 and the success of + // that task signals the success of the execution. + // More info: + // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + int32 task_count = 4; + + // Required. Describes the task(s) that will be created when executing an execution. + TaskTemplate template = 5 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/run/v2/job.proto b/google/cloud/run/v2/job.proto new file mode 100644 index 000000000..b5331f08b --- /dev/null +++ b/google/cloud/run/v2/job.proto @@ -0,0 +1,405 @@ +// 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.run.v2; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/launch_stage.proto"; +import "google/api/resource.proto"; +import "google/cloud/run/v2/condition.proto"; +import "google/cloud/run/v2/execution_template.proto"; +import "google/cloud/run/v2/vendor_settings.proto"; +import "google/iam/v1/iam_policy.proto"; +import "google/iam/v1/policy.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/run/v2;run"; +option java_multiple_files = true; +option java_outer_classname = "JobProto"; +option java_package = "com.google.cloud.run.v2"; + +// Cloud Run Job Control Plane API. +service Jobs { + option (google.api.default_host) = "run.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Creates a Job. + rpc CreateJob(CreateJobRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2/{parent=projects/*/locations/*}/jobs" + body: "job" + }; + option (google.api.method_signature) = "parent,job,job_id"; + option (google.longrunning.operation_info) = { + response_type: "Job" + metadata_type: "Job" + }; + } + + // Gets information about a Job. + rpc GetJob(GetJobRequest) returns (Job) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/jobs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists Jobs. + rpc ListJobs(ListJobsRequest) returns (ListJobsResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*}/jobs" + }; + option (google.api.method_signature) = "parent"; + } + + // Updates a Job. + rpc UpdateJob(UpdateJobRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v2/{job.name=projects/*/locations/*/jobs/*}" + body: "job" + }; + option (google.api.method_signature) = "job"; + option (google.longrunning.operation_info) = { + response_type: "Job" + metadata_type: "Job" + }; + } + + // Deletes a Job. + rpc DeleteJob(DeleteJobRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v2/{name=projects/*/locations/*/jobs/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Job" + metadata_type: "Job" + }; + } + + // Triggers creation of a new Execution of this Job. + rpc RunJob(RunJobRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2/{name=projects/*/locations/*/jobs/*}:run" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Execution" + metadata_type: "Execution" + }; + } + + // Gets the IAM Access Control policy currently in effect for the given Job. + // This result does not include any inherited policies. + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + option (google.api.http) = { + get: "/v2/{resource=projects/*/locations/*/jobs/*}:getIamPolicy" + }; + } + + // Sets the IAM Access control policy for the specified Job. Overwrites + // any existing policy. + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + option (google.api.http) = { + post: "/v2/{resource=projects/*/locations/*/jobs/*}:setIamPolicy" + body: "*" + }; + } + + // Returns permissions that a caller has on the specified Project. + // + // There are no permissions required for making this API call. + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + option (google.api.http) = { + post: "/v2/{resource=projects/*/locations/*/jobs/*}:testIamPermissions" + body: "*" + }; + } +} + +// Request message for creating a Job. +message CreateJobRequest { + // Required. The location and project in which this Job should be created. + // Format: projects/{project}/locations/{location}, where {project} can be + // project id or number. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "run.googleapis.com/Job" + } + ]; + + // Required. The Job instance to create. + Job job = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The unique identifier for the Job. The name of the job becomes + // {parent}/jobs/{job_id}. + string job_id = 3 [(google.api.field_behavior) = REQUIRED]; + + // Indicates that the request should be validated and default values + // populated, without persisting the request or creating any resources. + bool validate_only = 4; +} + +// Request message for obtaining a Job by its full name. +message GetJobRequest { + // Required. The full name of the Job. + // Format: projects/{project}/locations/{location}/jobs/{job}, where {project} + // can be project id or number. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Job" + } + ]; +} + +// Request message for updating a Job. +message UpdateJobRequest { + // Required. The Job to be updated. + Job job = 1 [(google.api.field_behavior) = REQUIRED]; + + // Indicates that the request should be validated and default values + // populated, without persisting the request or updating any resources. + bool validate_only = 3; + + // If set to true, and if the Job does not exist, it will create a new + // one. Caller must have both create and update permissions for this call if + // this is set to true. + bool allow_missing = 4; +} + +// Request message for retrieving a list of Jobs. +message ListJobsRequest { + // Required. The location and project to list resources on. + // Format: projects/{project}/locations/{location}, where {project} can be + // project id or number. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "run.googleapis.com/Job" + } + ]; + + // Maximum number of Jobs to return in this call. + int32 page_size = 2; + + // A page token received from a previous call to ListJobs. + // All other parameters must match. + string page_token = 3; + + // If true, returns deleted (but unexpired) resources along with active ones. + bool show_deleted = 4; +} + +// Response message containing a list of Jobs. +message ListJobsResponse { + // The resulting list of Jobs. + repeated Job jobs = 1; + + // A token indicating there are more items than page_size. Use it in the next + // ListJobs request to continue. + string next_page_token = 2; +} + +// Request message to delete a Job by its full name. +message DeleteJobRequest { + // Required. The full name of the Job. + // Format: projects/{project}/locations/{location}/jobs/{job}, where {project} + // can be project id or number. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Job" + } + ]; + + // Indicates that the request should be validated without actually + // deleting any resources. + bool validate_only = 3; + + // A system-generated fingerprint for this version of the + // resource. May be used to detect modification conflict during updates. + string etag = 4; +} + +// Request message to create a new Execution of a Job. +message RunJobRequest { + // Required. The full name of the Job. + // Format: projects/{project}/locations/{location}/jobs/{job}, where {project} + // can be project id or number. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Job" + } + ]; + + // Indicates that the request should be validated without actually + // deleting any resources. + bool validate_only = 2; + + // A system-generated fingerprint for this version of the + // resource. May be used to detect modification conflict during updates. + string etag = 3; +} + +// Job represents the configuration of a single job. A job an immutable resource +// that references a container image which is run to completion. +message Job { + option (google.api.resource) = { + type: "run.googleapis.com/Job" + pattern: "projects/{project}/locations/{location}/jobs/{job}" + style: DECLARATIVE_FRIENDLY + }; + + // The fully qualified name of this Job. + // + // Format: + // projects/{project}/locations/{location}/jobs/{job} + string name = 1; + + // Output only. Server assigned unique identifier for the Execution. The value is a UUID4 + // string and guaranteed to remain unchanged until the resource is deleted. + string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A number that monotonically increases every time the user + // modifies the desired state. + int64 generation = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // KRM-style labels for the resource. + // User-provided labels are shared with Google's billing system, so they can + // be used to filter, or break down billing charges by team, component, + // environment, state, etc. For more information, visit + // https://cloud.google.com/resource-manager/docs/creating-managing-labels or + // https://cloud.google.com/run/docs/configuring/labels + // Cloud Run will populate some labels with 'run.googleapis.com' or + // 'serving.knative.dev' namespaces. Those labels are read-only, and user + // changes will not be preserved. + map labels = 4; + + // KRM-style annotations for the resource. Unstructured key value map that may + // be set by external tools to store and arbitrary metadata. + // They are not queryable and should be preserved + // when modifying objects. Cloud Run will populate some annotations using + // 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field + // follows Kubernetes annotations' namespacing, limits, and rules. More info: + // https://kubernetes.io/docs/user-guide/annotations + map annotations = 5; + + // Output only. The creation time. + google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The last-modified time. + google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The deletion time. + google.protobuf.Timestamp delete_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. For a deleted resource, the time after which it will be + // permamently deleted. + google.protobuf.Timestamp expire_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Email address of the authenticated creator. + string creator = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Email address of the last authenticated modifier. + string last_modifier = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Arbitrary identifier for the API client. + string client = 12; + + // Arbitrary version identifier for the API client. + string client_version = 13; + + // The launch stage as defined by [Google Cloud Platform + // Launch Stages](https://cloud.google.com/terms/launch-stages). + // Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA + // is assumed. + google.api.LaunchStage launch_stage = 14; + + // Settings for the Binary Authorization feature. + BinaryAuthorization binary_authorization = 15; + + // Required. The template used to create executions for this Job. + ExecutionTemplate template = 16 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The generation of this Job. See comments in `reconciling` for additional + // information on reconciliation process in Cloud Run. + int64 observed_generation = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The Condition of this Job, containing its readiness status, and + // detailed error information in case it did not reach the desired state. + Condition terminal_condition = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The Conditions of all other associated sub-resources. They contain + // additional diagnostics information in case the Job does not reach its + // desired state. See comments in `reconciling` for additional information on + // reconciliation process in Cloud Run. + repeated Condition conditions = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Number of executions created for this job. + int32 execution_count = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Name of the last created execution. + ExecutionReference latest_created_execution = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Returns true if the Job is currently being acted upon by the system to + // bring it into the desired state. + // + // When a new Job is created, or an existing one is updated, Cloud Run + // will asynchronously perform all necessary steps to bring the Job to the + // desired state. This process is called reconciliation. + // While reconciliation is in process, `observed_generation` and + // `latest_succeeded_execution`, will have transient values that might + // mismatch the intended state: Once reconciliation is over (and this field is + // false), there are two possible outcomes: reconciliation succeeded and the + // state matches the Job, or there was an error, and reconciliation failed. + // This state can be found in `terminal_condition.state`. + // + // If reconciliation succeeded, the following fields will match: + // `observed_generation` and `generation`, `latest_succeeded_execution` and + // `latest_created_execution`. + // + // If reconciliation failed, `observed_generation` and + // `latest_succeeded_execution` will have the state of the last succeeded + // execution or empty for newly created Job. Additional information on the + // failure can be found in `terminal_condition` and `conditions`. + bool reconciling = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A system-generated fingerprint for this version of the + // resource. May be used to detect modification conflict during updates. + string etag = 99 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Reference to an Execution. Use /Executions.GetExecution with the given name +// to get full execution including the latest status. +message ExecutionReference { + // Name of the execution. + string name = 1 [(google.api.resource_reference) = { + type: "run.googleapis.com/Execution" + }]; + + // Creation timestamp of the execution. + google.protobuf.Timestamp create_time = 2; + + // Creation timestamp of the execution. + google.protobuf.Timestamp completion_time = 3; +} diff --git a/google/cloud/run/v2/k8s.min.proto b/google/cloud/run/v2/k8s.min.proto index 328c816f9..31c81bea1 100644 --- a/google/cloud/run/v2/k8s.min.proto +++ b/google/cloud/run/v2/k8s.min.proto @@ -93,14 +93,33 @@ message Container { // Volume to mount into the container's filesystem. repeated VolumeMount volume_mounts = 8; + + // Container's working directory. + // If not specified, the container runtime's default will be used, which + // might be configured in the container image. + string working_dir = 9; + + // Periodic probe of container liveness. + // Container will be restarted if the probe fails. + // More info: + // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + Probe liveness_probe = 10; + + // Startup probe of application within the container. + // All other probes are disabled if a startup probe is provided, until it + // succeeds. Container will not be added to service endpoints if the probe + // fails. + // More info: + // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + Probe startup_probe = 11; } // ResourceRequirements describes the compute resource requirements. message ResourceRequirements { // Only memory and CPU are supported. Note: The only - // supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at - // least 2Gi of memory. - // The values of the map is string form of the 'quantity' k8s type: + // supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU + // requires at least 2Gi of memory. The values of the map is string form of + // the 'quantity' k8s type: // https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go map limits = 1; @@ -150,7 +169,8 @@ message SecretKeySelector { ]; // The Cloud Secret Manager secret version. - // Can be 'latest' for the latest value or an integer for a specific version. + // Can be 'latest' for the latest version, an integer for a specific version, + // or a version alias. string version = 2 [(google.api.resource_reference) = { type: "secretmanager.googleapis.com/SecretVersion" }]; @@ -215,7 +235,7 @@ message SecretVolumeSource { repeated VersionToPath items = 2; // Integer representation of mode bits to use on created files by default. - // Must be a value between 0000 and 0777 (octal), defaulting to 0644. + // Must be a value between 0000 and 0777 (octal), defaulting to 0444. // Directories within the path are not affected by this setting. // // Notes @@ -242,7 +262,8 @@ message VersionToPath { string path = 1 [(google.api.field_behavior) = REQUIRED]; // The Cloud Secret Manager secret version. - // Can be 'latest' for the latest value or an integer for a specific version. + // Can be 'latest' for the latest value, or an integer or a secret alias for a + // specific version. string version = 2; // Integer octal mode bits to use on this file, must be a value between @@ -272,3 +293,83 @@ message CloudSqlInstance { // {project}:{location}:{instance} repeated string instances = 1; } + +// Probe describes a health check to be performed against a container to +// determine whether it is alive or ready to receive traffic. +message Probe { + // Number of seconds after the container has started before the probe is + // initiated. + // Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe + // is 3600. Maximum value for startup probe is 240. + // More info: + // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + int32 initial_delay_seconds = 1; + + // Number of seconds after which the probe times out. + // Defaults to 1 second. Minimum value is 1. Maximum value is 3600. + // Must be smaller than period_seconds. + // More info: + // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + int32 timeout_seconds = 2; + + // How often (in seconds) to perform the probe. + // Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe + // is 3600. Maximum value for startup probe is 240. + // Must be greater or equal than timeout_seconds. + int32 period_seconds = 3; + + // Minimum consecutive failures for the probe to be considered failed after + // having succeeded. Defaults to 3. Minimum value is 1. + int32 failure_threshold = 4; + + oneof probe_type { + // HTTPGet specifies the http request to perform. + // Exactly one of httpGet, tcpSocket, or grpc must be specified. + HTTPGetAction http_get = 5; + + // TCPSocket specifies an action involving a TCP port. + // Exactly one of httpGet, tcpSocket, or grpc must be specified. + TCPSocketAction tcp_socket = 6; + + // GRPC specifies an action involving a gRPC port. + // Exactly one of httpGet, tcpSocket, or grpc must be specified. + GRPCAction grpc = 7; + } +} + +// HTTPGetAction describes an action based on HTTP Get requests. +message HTTPGetAction { + // Path to access on the HTTP server. Defaults to '/'. + string path = 1; + + // Custom headers to set in the request. HTTP allows repeated headers. + repeated HTTPHeader http_headers = 4; +} + +// HTTPHeader describes a custom header to be used in HTTP probes +message HTTPHeader { + // Required. The header field name + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The header field value + string value = 2; +} + +// TCPSocketAction describes an action based on opening a socket +message TCPSocketAction { + // Port number to access on the container. Must be in the range 1 to 65535. + // If not specified, defaults to 8080. + int32 port = 1; +} + +// GRPCAction describes an action involving a GRPC port. +message GRPCAction { + // Port number of the gRPC service. Number must be in the range 1 to 65535. + // If not specified, defaults to 8080. + int32 port = 1; + + // Service is the name of the service to place in the gRPC HealthCheckRequest + // (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If + // this is not specified, the default behavior is defined by gRPC. + string service = 2; +} diff --git a/google/cloud/run/v2/revision.proto b/google/cloud/run/v2/revision.proto index 0cb674e81..bf5b4e904 100644 --- a/google/cloud/run/v2/revision.proto +++ b/google/cloud/run/v2/revision.proto @@ -53,7 +53,7 @@ service Revisions { option (google.api.method_signature) = "name"; } - // List Revisions from a given Service, or from a given location. + // Lists Revisions from a given Service, or from a given location. rpc ListRevisions(ListRevisionsRequest) returns (ListRevisionsResponse) { option (google.api.http) = { get: "/v2/{parent=projects/*/locations/*/services/*}/revisions" @@ -67,7 +67,7 @@ service Revisions { option (google.api.method_signature) = "parent"; } - // Delete a Revision. + // Deletes a Revision. rpc DeleteRevision(DeleteRevisionRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v2/{name=projects/*/locations/*/services/*/revisions/*}" diff --git a/google/cloud/run/v2/run_v2.yaml b/google/cloud/run/v2/run_v2.yaml index 7abc23c00..edd55fd35 100644 --- a/google/cloud/run/v2/run_v2.yaml +++ b/google/cloud/run/v2/run_v2.yaml @@ -4,14 +4,48 @@ name: run.googleapis.com title: Cloud Run Admin API apis: +- name: google.cloud.location.Locations +- name: google.cloud.run.v2.Executions +- name: google.cloud.run.v2.Jobs - name: google.cloud.run.v2.Revisions - name: google.cloud.run.v2.Services +- name: google.cloud.run.v2.Tasks +- name: google.longrunning.Operations documentation: + summary: |- + Deploy and manage user provided container images that scale automatically + based on incoming requests. The Cloud Run Admin API v1 follows the Knative + Serving API specification, while v2 is aligned with Google Cloud AIP-based + API standards, as described in https://google.aip.dev/. + overview: API for managing Cloud Run services rules: - selector: google.cloud.location.Locations.ListLocations description: Lists information about the supported locations for this service. +backend: + rules: + - selector: google.cloud.location.Locations.ListLocations + deadline: 5.0 + - selector: 'google.cloud.run.v2.Executions.*' + deadline: 5.0 + - selector: 'google.cloud.run.v2.Jobs.*' + deadline: 5.0 + - selector: 'google.cloud.run.v2.Revisions.*' + deadline: 5.0 + - selector: 'google.cloud.run.v2.Services.*' + deadline: 5.0 + - selector: google.cloud.run.v2.Services.CreateService + deadline: 10.0 + - selector: google.cloud.run.v2.Services.UpdateService + deadline: 10.0 + - selector: google.cloud.run.v2.Tasks.GetTask + deadline: 5.0 + - selector: google.cloud.run.v2.Tasks.ListTasks + deadline: 5.0 + - selector: 'google.longrunning.Operations.*' + deadline: 5.0 + http: rules: - selector: google.longrunning.Operations.DeleteOperation @@ -27,6 +61,14 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.run.v2.Executions.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.run.v2.Jobs.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform - selector: 'google.cloud.run.v2.Revisions.*' oauth: canonical_scopes: |- @@ -35,3 +77,15 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.run.v2.Tasks.GetTask + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.run.v2.Tasks.ListTasks + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.longrunning.Operations.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/run/v2/service.proto b/google/cloud/run/v2/service.proto index 51a29edc0..2357a35b9 100644 --- a/google/cloud/run/v2/service.proto +++ b/google/cloud/run/v2/service.proto @@ -74,7 +74,7 @@ service Services { option (google.api.method_signature) = "name"; } - // List Services. + // Lists Services. rpc ListServices(ListServicesRequest) returns (ListServicesResponse) { option (google.api.http) = { get: "/v2/{parent=projects/*/locations/*}/services" @@ -127,7 +127,7 @@ service Services { }; } - // Get the IAM Access Control policy currently in effect for the given + // Gets the IAM Access Control policy currently in effect for the given // Cloud Run Service. This result does not include any inherited policies. rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { option (google.api.http) = { @@ -158,7 +158,8 @@ service Services { // Request message for creating a Service. message CreateServiceRequest { // Required. The location and project in which this service should be created. - // Format: projects/{projectnumber}/locations/{location} + // Format: projects/{project}/locations/{location}, where {project} can be + // project id or number. Only lowercase characters, digits, and hyphens. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -169,8 +170,9 @@ message CreateServiceRequest { // Required. The Service instance to create. Service service = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The unique identifier for the Service. The name of the service becomes - // {parent}/services/{service_id}. + // Required. The unique identifier for the Service. It must begin with letter, + // and cannot end with hyphen; must contain fewer than 50 characters. + // The name of the service becomes {parent}/services/{service_id}. string service_id = 3 [(google.api.field_behavior) = REQUIRED]; // Indicates that the request should be validated and default values @@ -196,8 +198,9 @@ message UpdateServiceRequest { // Request message for retrieving a list of Services. message ListServicesRequest { // Required. The location and project to list resources on. - // Location must be a valid GCP region, and may not be the "-" wildcard. - // Format: projects/{projectnumber}/locations/{location} + // Location must be a valid GCP region, and cannot be the "-" wildcard. + // Format: projects/{project}/locations/{location}, where {project} can be + // project id or number. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -229,7 +232,8 @@ message ListServicesResponse { // Request message for obtaining a Service by its full name. message GetServiceRequest { // Required. The full name of the Service. - // Format: projects/{projectnumber}/locations/{location}/services/{service} + // Format: projects/{project}/locations/{location}/services/{service}, where + // {project} can be project id or number. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -241,7 +245,8 @@ message GetServiceRequest { // Request message to delete a Service by its full name. message DeleteServiceRequest { // Required. The full name of the Service. - // Format: projects/{projectnumber}/locations/{location}/services/{service} + // Format: projects/{project}/locations/{location}/services/{service}, where + // {project} can be project id or number. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/google/cloud/run/v2/task.proto b/google/cloud/run/v2/task.proto new file mode 100644 index 000000000..0fa6b03b9 --- /dev/null +++ b/google/cloud/run/v2/task.proto @@ -0,0 +1,256 @@ +// 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.run.v2; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/run/v2/condition.proto"; +import "google/cloud/run/v2/k8s.min.proto"; +import "google/cloud/run/v2/vendor_settings.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/timestamp.proto"; +import "google/rpc/status.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/run/v2;run"; +option java_multiple_files = true; +option java_outer_classname = "TaskProto"; +option java_package = "com.google.cloud.run.v2"; + +// Cloud Run Task Control Plane API. +service Tasks { + option (google.api.default_host) = "run.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Gets information about a Task. + rpc GetTask(GetTaskRequest) returns (Task) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/jobs/*/executions/*/tasks/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists Tasks from an Execution of a Job. + rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*/jobs/*/executions/*}/tasks" + }; + option (google.api.method_signature) = "parent"; + } +} + +// Request message for obtaining a Task by its full name. +message GetTaskRequest { + // Required. The full name of the Task. + // Format: + // projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "run.googleapis.com/Task" + } + ]; +} + +// Request message for retrieving a list of Tasks. +message ListTasksRequest { + // Required. The Execution from which the Tasks should be listed. + // To list all Tasks across Executions of a Job, use "-" instead of Execution + // name. To list all Tasks across Jobs, use "-" instead of Job name. Format: + // projects/{project}/locations/{location}/jobs/{job}/executions/{execution} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "run.googleapis.com/Task" + } + ]; + + // Maximum number of Tasks to return in this call. + int32 page_size = 2; + + // A page token received from a previous call to ListTasks. + // All other parameters must match. + string page_token = 3; + + // If true, returns deleted (but unexpired) resources along with active ones. + bool show_deleted = 4; +} + +// Response message containing a list of Tasks. +message ListTasksResponse { + // The resulting list of Tasks. + repeated Task tasks = 1; + + // A token indicating there are more items than page_size. Use it in the next + // ListTasks request to continue. + string next_page_token = 2; +} + +// Task represents a single run of a container to completion. +message Task { + option (google.api.resource) = { + type: "run.googleapis.com/Task" + pattern: "projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}" + style: DECLARATIVE_FRIENDLY + }; + + // Output only. The unique name of this Task. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Server assigned unique identifier for the Task. The value is a UUID4 + // string and guaranteed to remain unchanged until the resource is deleted. + string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A number that monotonically increases every time the user + // modifies the desired state. + int64 generation = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // KRM-style labels for the resource. + // User-provided labels are shared with Google's billing system, so they can + // be used to filter, or break down billing charges by team, component, + // environment, state, etc. For more information, visit + // https://cloud.google.com/resource-manager/docs/creating-managing-labels or + // https://cloud.google.com/run/docs/configuring/labels + // Cloud Run will populate some labels with 'run.googleapis.com' or + // 'serving.knative.dev' namespaces. Those labels are read-only, and user + // changes will not be preserved. + map labels = 4; + + // KRM-style annotations for the resource. + map annotations = 5; + + // Output only. Represents time when the task was created by the job controller. + // It is not guaranteed to be set in happens-before order across separate + // operations. + google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Represents time when the task started to run. + // It is not guaranteed to be set in happens-before order across separate + // operations. + google.protobuf.Timestamp start_time = 27 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Represents time when the Task was completed. It is not guaranteed to + // be set in happens-before order across separate operations. + google.protobuf.Timestamp completion_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The last-modified time. + google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. For a deleted resource, the deletion time. It is only + // populated as a response to a Delete request. + google.protobuf.Timestamp delete_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. For a deleted resource, the time after which it will be + // permamently deleted. It is only populated as a response to a Delete + // request. + google.protobuf.Timestamp expire_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The name of the parent Job. + string job = 12 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "run.googleapis.com/Job" + } + ]; + + // Output only. The name of the parent Execution. + string execution = 13 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "run.googleapis.com/Execution" + } + ]; + + // Holds the single container that defines the unit of execution for this + // task. + repeated Container containers = 14; + + // A list of Volumes to make available to containers. + repeated Volume volumes = 15; + + // Number of retries allowed per Task, before marking this Task failed. + int32 max_retries = 16; + + // Max allowed time duration the Task may be active before the system will + // actively try to mark it failed and kill associated containers. This applies + // per attempt of a task, meaning each retry can run for the full timeout. + google.protobuf.Duration timeout = 17; + + // Email address of the IAM service account associated with the Task of a + // Job. The service account represents the identity of the + // running task, and determines what permissions the task has. If + // not provided, the task will use the project's default service account. + string service_account = 18; + + // The execution environment being used to host this Task. + ExecutionEnvironment execution_environment = 20; + + // Output only. Indicates whether the resource's reconciliation is still in progress. + // See comments in `Job.reconciling` for additional information on + // reconciliation process in Cloud Run. + bool reconciling = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The Condition of this Task, containing its readiness status, and + // detailed error information in case it did not reach the desired state. + repeated Condition conditions = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The generation of this Task. See comments in `Job.reconciling` + // for additional information on reconciliation process in Cloud Run. + int64 observed_generation = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Index of the Task, unique per execution, and beginning at 0. + int32 index = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The number of times this Task was retried. + // Tasks are retried when they fail up to the maxRetries limit. + int32 retried = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Result of the last attempt of this Task. + TaskAttemptResult last_attempt_result = 26 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt + // this container image. For more information, go to + // https://cloud.google.com/run/docs/securing/using-cmek + string encryption_key = 28 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "cloudkms.googleapis.com/CryptoKey" + } + ]; + + // Output only. VPC Access configuration to use for this Task. For more information, + // visit https://cloud.google.com/run/docs/configuring/connecting-vpc. + VpcAccess vpc_access = 29 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. A system-generated fingerprint for this version of the + // resource. May be used to detect modification conflict during updates. + string etag = 99 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Result of a task attempt. +message TaskAttemptResult { + // Output only. The status of this attempt. + // If the status code is OK, then the attempt succeeded. + google.rpc.Status status = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The exit code of this attempt. + // This may be unset if the container was unable to exit cleanly with a code + // due to some other failure. + // See status field for possible failure details. + int32 exit_code = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/cloud/run/v2/task_template.proto b/google/cloud/run/v2/task_template.proto new file mode 100644 index 000000000..b5b43fba2 --- /dev/null +++ b/google/cloud/run/v2/task_template.proto @@ -0,0 +1,68 @@ +// 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.run.v2; + +import "google/api/resource.proto"; +import "google/cloud/run/v2/k8s.min.proto"; +import "google/cloud/run/v2/vendor_settings.proto"; +import "google/protobuf/duration.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/run/v2;run"; +option java_multiple_files = true; +option java_outer_classname = "TaskTemplateProto"; +option java_package = "com.google.cloud.run.v2"; + +// TaskTemplate describes the data a task should have when created +// from a template. +message TaskTemplate { + // Holds the single container that defines the unit of execution for this + // task. + repeated Container containers = 1; + + // A list of Volumes to make available to containers. + repeated Volume volumes = 2; + + oneof retries { + // Number of retries allowed per Task, before marking this Task failed. + int32 max_retries = 3; + } + + // Max allowed time duration the Task may be active before the system will + // actively try to mark it failed and kill associated containers. This applies + // per attempt of a task, meaning each retry can run for the full timeout. + google.protobuf.Duration timeout = 4; + + // Email address of the IAM service account associated with the Task of a + // Job. The service account represents the identity of the + // running task, and determines what permissions the task has. If + // not provided, the task will use the project's default service account. + string service_account = 5; + + // The execution environment being used to host this Task. + ExecutionEnvironment execution_environment = 6; + + // A reference to a customer managed encryption key (CMEK) to use to encrypt + // this container image. For more information, go to + // https://cloud.google.com/run/docs/securing/using-cmek + string encryption_key = 7 [(google.api.resource_reference) = { + type: "cloudkms.googleapis.com/CryptoKey" + }]; + + // VPC Access configuration to use for this Task. For more information, + // visit https://cloud.google.com/run/docs/configuring/connecting-vpc. + VpcAccess vpc_access = 8; +} diff --git a/google/cloud/run/v2/vendor_settings.proto b/google/cloud/run/v2/vendor_settings.proto index 89748d5c7..0ee74eafa 100644 --- a/google/cloud/run/v2/vendor_settings.proto +++ b/google/cloud/run/v2/vendor_settings.proto @@ -41,7 +41,8 @@ message VpcAccess { } // VPC Access connector name. - // Format: projects/{project}/locations/{location}/connectors/{connector} + // Format: projects/{project}/locations/{location}/connectors/{connector}, + // where {project} can be project id or number. string connector = 1 [(google.api.resource_reference) = { type: "vpcaccess.googleapis.com/Connector" }]; diff --git a/google/cloud/scheduler/v1/BUILD.bazel b/google/cloud/scheduler/v1/BUILD.bazel index f5afd87a8..94135264b 100644 --- a/google/cloud/scheduler/v1/BUILD.bazel +++ b/google/cloud/scheduler/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"]) @@ -63,13 +72,17 @@ java_grpc_library( java_gapic_library( name = "scheduler_java_gapic", srcs = [":scheduler_proto_with_info"], + gapic_yaml = None, grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1.yaml", test_deps = [ ":scheduler_java_grpc", ], transport = "grpc+rest", deps = [ ":scheduler_java_proto", + "//google/api:api_java_proto", ], ) @@ -122,10 +135,13 @@ go_gapic_library( srcs = [":scheduler_proto_with_info"], grpc_service_config = "cloudscheduler_grpc_service_config.json", importpath = "cloud.google.com/go/scheduler/apiv1;scheduler", + metadata = True, + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1.yaml", transport = "grpc+rest", deps = [ ":scheduler_go_proto", + "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], ) @@ -141,6 +157,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-scheduler-v1-go", deps = [ ":scheduler_go_gapic", + ":scheduler_go_gapic_srcjar-metadata.srcjar", ":scheduler_go_gapic_srcjar-test.srcjar", ":scheduler_go_proto", ], @@ -160,7 +177,11 @@ py_gapic_library( name = "scheduler_py_gapic", srcs = [":scheduler_proto"], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -207,6 +228,9 @@ php_gapic_library( name = "scheduler_php_gapic", srcs = [":scheduler_proto_with_info"], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1.yaml", + transport = "grpc+rest", deps = [ ":scheduler_php_grpc", ":scheduler_php_proto", @@ -240,7 +264,9 @@ nodejs_gapic_library( grpc_service_config = "cloudscheduler_grpc_service_config.json", main_service = "scheduler", package = "google.cloud.scheduler.v1", + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,15 +304,17 @@ ruby_cloud_gapic_library( name = "scheduler_ruby_gapic", srcs = [":scheduler_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-scheduler-v1", - "ruby-cloud-env-prefix=SCHEDULER", - "ruby-cloud-product-url=https://cloud.google.com/scheduler", "ruby-cloud-api-id=cloudscheduler.googleapis.com", "ruby-cloud-api-shortname=cloudscheduler", + "ruby-cloud-env-prefix=SCHEDULER", + "ruby-cloud-gem-name=google-cloud-scheduler-v1", + "ruby-cloud-product-url=https://cloud.google.com/scheduler", ], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Scheduler is a fully managed enterprise-grade cron job scheduler. It allows you to schedule virtually any job, including batch, big data jobs, cloud infrastructure operations, and more. You can automate everything, including retries in case of failure to reduce manual toil and intervention. Cloud Scheduler even acts as a single pane of glass, allowing you to manage all your automation tasks from one place.", ruby_cloud_title = "Cloud Scheduler V1", + service_yaml = "cloudscheduler_v1.yaml", deps = [ ":scheduler_ruby_grpc", ":scheduler_ruby_proto", @@ -330,6 +358,7 @@ csharp_gapic_library( srcs = [":scheduler_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1.yaml", deps = [ ":scheduler_csharp_grpc", diff --git a/google/cloud/scheduler/v1beta1/BUILD.bazel b/google/cloud/scheduler/v1beta1/BUILD.bazel index 3a6e1b92b..9cec308d4 100644 --- a/google/cloud/scheduler/v1beta1/BUILD.bazel +++ b/google/cloud/scheduler/v1beta1/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"]) @@ -34,6 +43,7 @@ proto_library_with_info( deps = [ ":scheduler_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -63,13 +73,19 @@ java_grpc_library( java_gapic_library( name = "scheduler_java_gapic", srcs = [":scheduler_proto_with_info"], + gapic_yaml = None, grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1beta1.yaml", test_deps = [ ":scheduler_java_grpc", + "//google/cloud/location:location_java_grpc", ], transport = "grpc+rest", deps = [ ":scheduler_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) @@ -122,10 +138,14 @@ go_gapic_library( srcs = [":scheduler_proto_with_info"], grpc_service_config = "cloudscheduler_grpc_service_config.json", importpath = "cloud.google.com/go/scheduler/apiv1beta1;scheduler", + metadata = True, + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1beta1.yaml", transport = "grpc+rest", deps = [ ":scheduler_go_proto", + "//google/cloud/location:location_go_proto", + "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], ) @@ -141,6 +161,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-scheduler-v1beta1-go", deps = [ ":scheduler_go_gapic", + ":scheduler_go_gapic_srcjar-metadata.srcjar", ":scheduler_go_gapic_srcjar-test.srcjar", ":scheduler_go_proto", ], @@ -160,7 +181,11 @@ py_gapic_library( name = "scheduler_py_gapic", srcs = [":scheduler_proto"], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1beta1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -207,6 +232,9 @@ php_gapic_library( name = "scheduler_php_gapic", srcs = [":scheduler_proto_with_info"], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "cloudscheduler_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":scheduler_php_grpc", ":scheduler_php_proto", @@ -240,7 +268,9 @@ nodejs_gapic_library( grpc_service_config = "cloudscheduler_grpc_service_config.json", main_service = "scheduler", package = "google.cloud.scheduler.v1beta1", + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,15 +308,17 @@ ruby_cloud_gapic_library( name = "scheduler_ruby_gapic", srcs = [":scheduler_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-scheduler-v1beta1", - "ruby-cloud-env-prefix=SCHEDULER", - "ruby-cloud-product-url=https://cloud.google.com/scheduler", "ruby-cloud-api-id=cloudscheduler.googleapis.com", "ruby-cloud-api-shortname=cloudscheduler", + "ruby-cloud-env-prefix=SCHEDULER", + "ruby-cloud-gem-name=google-cloud-scheduler-v1beta1", + "ruby-cloud-product-url=https://cloud.google.com/scheduler", ], grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Scheduler is a fully managed enterprise-grade cron job scheduler. It allows you to schedule virtually any job, including batch, big data jobs, cloud infrastructure operations, and more. You can automate everything, including retries in case of failure to reduce manual toil and intervention. Cloud Scheduler even acts as a single pane of glass, allowing you to manage all your automation tasks from one place.", ruby_cloud_title = "Cloud Scheduler V1beta1", + service_yaml = "cloudscheduler_v1beta1.yaml", deps = [ ":scheduler_ruby_grpc", ":scheduler_ruby_proto", @@ -330,6 +362,7 @@ csharp_gapic_library( srcs = [":scheduler_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudscheduler_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudscheduler_v1beta1.yaml", deps = [ ":scheduler_csharp_grpc", @@ -350,4 +383,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "scheduler_cc_proto", + deps = [":scheduler_proto"], +) + +cc_grpc_library( + name = "scheduler_cc_grpc", + srcs = [":scheduler_proto"], + grpc_only = True, + deps = [":scheduler_cc_proto"], +) diff --git a/google/cloud/scheduler/v1beta1/cloudscheduler.proto b/google/cloud/scheduler/v1beta1/cloudscheduler.proto index 4f86b7a56..f9a2da03f 100644 --- a/google/cloud/scheduler/v1beta1/cloudscheduler.proto +++ b/google/cloud/scheduler/v1beta1/cloudscheduler.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -35,7 +34,8 @@ option objc_class_prefix = "SCHEDULER"; // schedule asynchronous jobs. service CloudScheduler { option (google.api.default_host) = "cloudscheduler.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"; // Lists jobs. rpc ListJobs(ListJobsRequest) returns (ListJobsResponse) { @@ -64,13 +64,14 @@ service CloudScheduler { // Updates a job. // - // If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does - // not exist, `NOT_FOUND` is returned. + // If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is + // returned. If the job does not exist, `NOT_FOUND` is returned. // // If UpdateJob does not successfully return, it is possible for the - // job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may - // not be executed. If this happens, retry the UpdateJob request - // until a successful response is received. + // job to be in an + // [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] + // state. A job in this state may not be executed. If this happens, retry the + // UpdateJob request until a successful response is received. rpc UpdateJob(UpdateJobRequest) returns (Job) { option (google.api.http) = { patch: "/v1beta1/{job.name=projects/*/locations/*/jobs/*}" @@ -90,10 +91,14 @@ service CloudScheduler { // Pauses a job. // // If a job is paused then the system will stop executing the job - // until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The - // state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it - // will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] - // to be paused. + // until it is re-enabled via + // [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The + // state of the job is stored in + // [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set + // to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A + // job must be in + // [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be + // paused. rpc PauseJob(PauseJobRequest) returns (Job) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/jobs/*}:pause" @@ -104,10 +109,15 @@ service CloudScheduler { // Resume a job. // - // This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The - // state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it - // will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in - // [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed. + // This method reenables a job after it has been + // [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The + // state of a job is stored in + // [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this + // method it will be set to + // [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A + // job must be in + // [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be + // resumed. rpc ResumeJob(ResumeJobRequest) returns (Job) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/jobs/*}:resume" @@ -129,7 +139,8 @@ service CloudScheduler { } } -// Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. +// Request message for listing jobs using +// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. message ListJobsRequest { // Required. The location name. For example: // `projects/PROJECT_ID/locations/LOCATION_ID`. @@ -140,6 +151,16 @@ message ListJobsRequest { } ]; + // `filter` can be used to specify a subset of jobs. + // + // If `filter` equals `target_config="HttpConfig"`, then the http + // target jobs are retrieved. If `filter` equals + // `target_config="PubSubConfig"`, then the Pub/Sub target jobs are + // retrieved. If `filter` equals `labels.foo=value1 + // labels.foo=value2` then only jobs which are labeled with + // foo=value1 AND foo=value2 will be returned. + string filter = 4; + // Requested page size. // // The maximum page size is 500. If unspecified, the page size will @@ -151,29 +172,40 @@ message ListJobsRequest { // A token identifying a page of results the server will return. To // request the first page results, page_token must be empty. To // request the next page of results, page_token must be the value of - // [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token] returned from - // the previous call to [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is an error to - // switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or - // [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages. + // [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token] + // returned from the previous call to + // [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is + // an error to switch the value of + // [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or + // [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while + // iterating through pages. string page_token = 6; + + // This field is used to manage the legacy App Engine Cron jobs using the + // Cloud Scheduler API. If the field is set to true, the jobs in the __cron + // queue will be listed instead. + bool legacy_app_engine_cron = 7; } -// Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. +// Response message for listing jobs using +// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. message ListJobsResponse { // The list of jobs. repeated Job jobs = 1; // A token to retrieve next page of results. Pass this value in the - // [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token] field in the subsequent call to - // [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to retrieve the next page of results. - // If this is empty it indicates that there are no more results - // through which to paginate. + // [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token] + // field in the subsequent call to + // [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to + // retrieve the next page of results. If this is empty it indicates that there + // are no more results through which to paginate. // // The page token is valid for only 2 hours. string next_page_token = 2; } -// Request message for [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob]. +// Request message for +// [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob]. message GetJobRequest { // Required. The job name. For example: // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. @@ -185,7 +217,8 @@ message GetJobRequest { ]; } -// Request message for [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob]. +// Request message for +// [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob]. message CreateJobRequest { // Required. The location name. For example: // `projects/PROJECT_ID/locations/LOCATION_ID`. @@ -197,16 +230,19 @@ message CreateJobRequest { ]; // Required. The job to add. The user can optionally specify a name for the - // job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an + // job in [name][google.cloud.scheduler.v1beta1.Job.name]. + // [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an // existing job. If a name is not specified then the system will // generate a random unique name that will be returned // ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response. Job job = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]. +// Request message for +// [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]. message UpdateJobRequest { - // Required. The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name] must be specified. + // Required. The new job properties. + // [name][google.cloud.scheduler.v1beta1.Job.name] must be specified. // // Output only fields cannot be modified using UpdateJob. // Any value specified for an output only field will be ignored. @@ -227,9 +263,15 @@ message DeleteJobRequest { type: "cloudscheduler.googleapis.com/Job" } ]; + + // This field is used to manage the legacy App Engine Cron jobs using the + // Cloud Scheduler API. If the field is set to true, the job in the __cron + // queue with the corresponding name will be deleted instead. + bool legacy_app_engine_cron = 2; } -// Request message for [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob]. +// Request message for +// [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob]. message PauseJobRequest { // Required. The job name. For example: // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. @@ -241,7 +283,8 @@ message PauseJobRequest { ]; } -// Request message for [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. +// Request message for +// [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. message ResumeJobRequest { // Required. The job name. For example: // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. @@ -264,4 +307,9 @@ message RunJobRequest { type: "cloudscheduler.googleapis.com/Job" } ]; + + // This field is used to manage the legacy App Engine Cron jobs using the + // Cloud Scheduler API. If the field is set to true, the job in the __cron + // queue with the corresponding name will be forced to run instead. + bool legacy_app_engine_cron = 2; } diff --git a/google/cloud/scheduler/v1beta1/cloudscheduler_v1beta1.yaml b/google/cloud/scheduler/v1beta1/cloudscheduler_v1beta1.yaml index 8b9fdadca..32864821a 100644 --- a/google/cloud/scheduler/v1beta1/cloudscheduler_v1beta1.yaml +++ b/google/cloud/scheduler/v1beta1/cloudscheduler_v1beta1.yaml @@ -4,18 +4,44 @@ name: cloudscheduler.googleapis.com title: Cloud Scheduler API apis: +- name: google.cloud.location.Locations - name: google.cloud.scheduler.v1beta1.CloudScheduler documentation: summary: Creates and manages jobs run on a regular recurring schedule. + 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. backend: rules: + - selector: google.cloud.location.Locations.GetLocation + deadline: 30.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 30.0 - selector: 'google.cloud.scheduler.v1beta1.CloudScheduler.*' deadline: 30.0 +http: + rules: + - selector: google.cloud.location.Locations.GetLocation + get: '/v1beta1/{name=projects/*/locations/*}' + - selector: google.cloud.location.Locations.ListLocations + get: '/v1beta1/{name=projects/*}/locations' + authentication: rules: + - 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.cloud.scheduler.v1beta1.CloudScheduler.*' oauth: canonical_scopes: |- diff --git a/google/cloud/scheduler/v1beta1/job.proto b/google/cloud/scheduler/v1beta1/job.proto index 4e8e3777f..2353beeca 100644 --- a/google/cloud/scheduler/v1beta1/job.proto +++ b/google/cloud/scheduler/v1beta1/job.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,12 +11,12 @@ // 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.scheduler.v1beta1; +import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/scheduler/v1beta1/target.proto"; import "google/protobuf/duration.proto"; @@ -29,7 +29,7 @@ option java_outer_classname = "JobProto"; option java_package = "com.google.cloud.scheduler.v1beta1"; // Configuration for a job. -// The maximum allowed size for a job is 100KB. +// The maximum allowed size for a job is 1MB. message Job { option (google.api.resource) = { type: "cloudscheduler.googleapis.com/Job" @@ -53,13 +53,16 @@ message Job { // cannot directly set a job to be disabled. DISABLED = 3; - // The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] + // The job state resulting from a failed + // [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] // operation. To recover a job from this state, retry - // [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] until a successful response is received. + // [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] + // until a successful response is received. UPDATE_FAILED = 4; } - // Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob], after + // Optionally caller-specified in + // [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob], after // which it becomes output only. // // The job name. For example: @@ -78,7 +81,8 @@ message Job { // hyphens (-), or underscores (_). The maximum length is 500 characters. string name = 1; - // Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob] or + // Optionally caller-specified in + // [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob] or // [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]. // // A human-readable description for the job. This string must not contain @@ -99,13 +103,14 @@ message Job { HttpTarget http_target = 6; } - // Required, except when used with [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]. + // Required, except when used with + // [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]. // // Describes the schedule on which the job will be executed. // // The schedule can be either of the following types: // - // * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) + // * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) // * English-like // [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) // @@ -118,15 +123,17 @@ message Job { // A scheduled start time will be delayed if the previous // execution has not ended when its scheduled time occurs. // - // If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] > 0 and a job attempt fails, - // the job will be tried a total of [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] + // If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] > + // 0 and a job attempt fails, the job will be tried a total of + // [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] // times, with exponential backoff, until the next scheduled start // time. string schedule = 20; // Specifies the time zone to be used in interpreting - // [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this field must be a time - // zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). + // [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this + // field must be a time zone name from the [tz + // database](http://en.wikipedia.org/wiki/Tz_database). // // Note that some time zones include a provision for // daylight savings time. The rules for daylight saving time are @@ -161,20 +168,38 @@ message Job { // execution logs. Cloud Scheduler will retry the job according // to the [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig]. // - // The allowed duration for this deadline is: + // The default and the allowed values depend on the type of target: + // + // * For [HTTP targets][google.cloud.scheduler.v1beta1.Job.http_target], the + // default is 3 minutes. The deadline must be in the interval [15 seconds, 30 + // minutes]. // - // * For [HTTP targets][google.cloud.scheduler.v1beta1.Job.http_target], between 15 seconds and 30 minutes. - // * For [App Engine HTTP targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target], between 15 - // seconds and 24 hours. - // * For [PubSub targets][google.cloud.scheduler.v1beta1.Job.pubsub_target], this field is ignored. + // * For [App Engine HTTP + // targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target], 0 + // indicates that the request has the default deadline. The default deadline + // depends on the scaling type of the service: 10 minutes for standard apps + // with automatic scaling, 24 hours for standard apps with manual and basic + // scaling, and 60 minutes for flex apps. If the request deadline is set, it + // must be in the interval [15 seconds, 24 hours 15 seconds]. + // + // * For [Pub/Sub targets][google.cloud.scheduler.v1beta1.Job.pubsub_target], + // this field is ignored. google.protobuf.Duration attempt_deadline = 22; + + // Immutable. This field is used to manage the legacy App Engine Cron jobs + // using the Cloud Scheduler API. If the field is set to true, the job will be + // considered a legacy job. Note that App Engine Cron jobs have fewer + // features than Cloud Scheduler jobs, e.g., are only limited to App Engine + // targets. + bool legacy_app_engine_cron = 23 [(google.api.field_behavior) = IMMUTABLE]; } // Settings that determine the retry behavior. // // By default, if a job does not complete successfully (meaning that // an acknowledgement is not received from the handler, then it will be retried -// with exponential backoff according to the settings in [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig]. +// with exponential backoff according to the settings in +// [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig]. message RetryConfig { // The number of attempts that the system will make to run a job using the // exponential backoff procedure described by @@ -196,8 +221,8 @@ message RetryConfig { // The time limit for retrying a failed job, measured from time when an // execution was first attempted. If specified with - // [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count], the job will be retried until both - // limits are reached. + // [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count], the + // job will be retried until both limits are reached. // // The default value for max_retry_duration is zero, which means retry // duration is unlimited. @@ -218,20 +243,25 @@ message RetryConfig { // The time between retries will double `max_doublings` times. // // A job's retry interval starts at - // [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration], then doubles - // `max_doublings` times, then increases linearly, and finally - // retries retries at intervals of - // [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] up to - // [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times. - // - // For example, if [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration] is - // 10s, [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] is 300s, and - // `max_doublings` is 3, then the a job will first be retried in 10s. The - // retry interval will double three times, and then increase linearly by - // 2^3 * 10s. Finally, the job will retry at intervals of - // [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] until the job has - // been attempted [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times. Thus, the - // requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... + // [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration], + // then doubles `max_doublings` times, then increases linearly, and finally + // retries at intervals of + // [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] + // up to [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] + // times. + // + // For example, if + // [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration] + // is 10s, + // [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] + // is 300s, and `max_doublings` is 3, then the a job will first be retried in + // 10s. The retry interval will double three times, and then increase linearly + // by 2^3 * 10s. Finally, the job will retry at intervals of + // [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] + // until the job has been attempted + // [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] + // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, + // 300s, 300s, .... // // The default value of this field is 5. int32 max_doublings = 5; diff --git a/google/cloud/scheduler/v1beta1/target.proto b/google/cloud/scheduler/v1beta1/target.proto index 7f5214f59..f98f210dc 100644 --- a/google/cloud/scheduler/v1beta1/target.proto +++ b/google/cloud/scheduler/v1beta1/target.proto @@ -1,4 +1,4 @@ -// Copyright 2019 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. @@ -11,7 +11,6 @@ // 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"; @@ -23,10 +22,15 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/scheduler/v1bet option java_multiple_files = true; option java_outer_classname = "TargetProto"; option java_package = "com.google.cloud.scheduler.v1beta1"; +option (google.api.resource_definition) = { + type: "pubsub.googleapis.com/Topic" + pattern: "projects/{project}/topics/{topic}" +}; // Http target. The job will be pushed to the job handler by means of -// an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.HttpTarget.http_method] such as HTTP -// POST, HTTP GET, etc. The job is acknowledged by means of an HTTP +// an HTTP request via an +// [http_method][google.cloud.scheduler.v1beta1.HttpTarget.http_method] such as +// HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP // response code in the range [200 - 299]. A failure to receive a response // constitutes a failed execution. For a redirected request, the response // returned by the redirected request is considered. @@ -55,6 +59,11 @@ message HttpTarget { // * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. // * `X-Google-*`: Google internal use only. // * `X-AppEngine-*`: Google internal use only. + // * `X-CloudScheduler`: This header will be set to true. + // * `X-CloudScheduler-JobName`: This header will contain the job name. + // * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in + // the unix-cron format, this header will contain the job schedule time in + // RFC3339 UTC "Zulu" format. // // The total size of headers must be less than 80KB. map headers = 3; @@ -66,7 +75,8 @@ message HttpTarget { // The mode for generating an `Authorization` header for HTTP requests. // - // If specified, all `Authorization` headers in the [HttpTarget.headers][google.cloud.scheduler.v1beta1.HttpTarget.headers] + // If specified, all `Authorization` headers in the + // [HttpTarget.headers][google.cloud.scheduler.v1beta1.HttpTarget.headers] // field will be overridden. oneof authorization_header { // If specified, an @@ -91,14 +101,14 @@ message HttpTarget { } // App Engine target. The job will be pushed to a job handler by means -// of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.http_method] such -// as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an -// HTTP response code in the range [200 - 299]. Error 503 is -// considered an App Engine system error instead of an application -// error. Requests returning error 503 will be retried regardless of -// retry configuration and not counted against retry counts. Any other -// response code, or a failure to receive a response before the -// deadline, constitutes a failed attempt. +// of an HTTP request via an +// [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.http_method] +// such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP +// response code in the range [200 - 299]. Error 503 is considered an App Engine +// system error instead of an application error. Requests returning error 503 +// will be retried regardless of retry configuration and not counted against +// retry counts. Any other response code, or a failure to receive a response +// before the deadline, constitutes a failed attempt. message AppEngineHttpTarget { // The HTTP method to use for the request. PATCH and OPTIONS are not // permitted. @@ -128,9 +138,14 @@ message AppEngineHttpTarget { // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the // modified `User-Agent`. // * `X-CloudScheduler`: This header will be set to true. + // * `X-CloudScheduler-JobName`: This header will contain the job name. + // * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in + // the unix-cron format, this header will contain the job schedule time in + // RFC3339 UTC "Zulu" format. // - // If the job has an [body][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.body], Cloud Scheduler sets - // the following headers: + // If the job has an + // [body][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.body], Cloud + // Scheduler sets the following headers: // // * `Content-Type`: By default, the `Content-Type` header is set to // `"application/octet-stream"`. The default can be overridden by explictly @@ -153,7 +168,8 @@ message AppEngineHttpTarget { // // HTTP request body. A request body is allowed only if the HTTP method is // POST or PUT. It will result in invalid argument error to set a body on a - // job with an incompatible [HttpMethod][google.cloud.scheduler.v1beta1.HttpMethod]. + // job with an incompatible + // [HttpMethod][google.cloud.scheduler.v1beta1.HttpMethod]. bytes body = 5; } @@ -162,14 +178,14 @@ message AppEngineHttpTarget { message PubsubTarget { // Required. The name of the Cloud Pub/Sub topic to which messages will // be published when a job is delivered. The topic name must be in the - // same format as required by PubSub's + // same format as required by Pub/Sub's // [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), // for example `projects/PROJECT_ID/topics/TOPIC_ID`. // // The topic must be in the same project as the Cloud Scheduler job. - string topic_name = 1 [(google.api.resource_reference) = { - type: "pubsub.googleapis.com/Topic" - }]; + string topic_name = 1 [ + (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" } + ]; // The message payload for PubsubMessage. // @@ -215,7 +231,7 @@ message AppEngineRouting { // // Requests can only be sent to a specific instance if // [manual scaling is used in App Engine - // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). // App Engine Flex does not support instances. For more information, see // [App Engine Standard request // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) @@ -244,43 +260,51 @@ message AppEngineRouting { // example .appspot.com, which is associated with the // job's project ID. // - // * `service =` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] + // * `service =` + // [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] // - // * `version =` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] + // * `version =` + // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] // // * `version_dot_service =` - // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' +` - // [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] + // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' + // +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] // - // * `instance =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] + // * `instance =` + // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] // // * `instance_dot_service =` - // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` - // [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] + // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ + // '.' +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] // // * `instance_dot_version =` - // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` - // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] + // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ + // '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] // // * `instance_dot_version_dot_service =` - // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +` - // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' +` + // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ + // '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] + // `+ '.' +` // [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] // // - // If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] is empty, then the job will be sent - // to the service which is the default service when the job is attempted. + // If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] is + // empty, then the job will be sent to the service which is the default + // service when the job is attempted. // - // If [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] is empty, then the job will be sent - // to the version which is the default version when the job is attempted. + // If [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] is + // empty, then the job will be sent to the version which is the default + // version when the job is attempted. // - // If [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is empty, then the job will be - // sent to an instance which is available when the job is attempted. + // If [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is + // empty, then the job will be sent to an instance which is available when the + // job is attempted. // // If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service], // [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version], or - // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is invalid, then the job will be sent - // to the default version of the default service when the job is attempted. + // [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is + // invalid, then the job will be sent to the default version of the default + // service when the job is attempted. string host = 4; } @@ -345,11 +369,3 @@ message OidcToken { // specified in target will be used. string audience = 2; } - -// The Pub/Sub Topic resource definition is in google/cloud/pubsub/v1/, -// but we do not import that proto directly; therefore, we redefine the -// pattern here. -option (google.api.resource_definition) = { - type: "pubsub.googleapis.com/Topic" - pattern: "projects/{project}/topics/{topic}" -}; diff --git a/google/cloud/secretmanager/v1/BUILD.bazel b/google/cloud/secretmanager/v1/BUILD.bazel index e2ab76d44..1a5ce402d 100644 --- a/google/cloud/secretmanager/v1/BUILD.bazel +++ b/google/cloud/secretmanager/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( name = "secretmanager_java_gapic", srcs = [":secretmanager_proto_with_info"], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":secretmanager_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -134,6 +135,7 @@ go_gapic_library( grpc_service_config = "secretmanager_grpc_service_config.json", importpath = "cloud.google.com/go/secretmanager/apiv1;secretmanager", metadata = True, + rest_numeric_enums = True, service_yaml = "secretmanager_v1.yaml", transport = "grpc+rest", deps = [ @@ -178,6 +180,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-secret-manager", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -228,6 +231,8 @@ php_gapic_library( name = "secretmanager_php_gapic", srcs = [":secretmanager_proto_with_info"], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":secretmanager_php_grpc", ":secretmanager_php_proto", @@ -260,7 +265,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "secretmanager_grpc_service_config.json", package = "google.cloud.secretmanager.v1", + rest_numeric_enums = True, service_yaml = "secretmanager_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/secret-manager", ], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Secret Manager is a secure and convenient storage system for API keys, passwords, certificates, and other sensitive data. Secret Manager provides a central place and single source of truth to manage, access, and audit secrets across Google Cloud.", ruby_cloud_title = "Secret Manager V1", deps = [ @@ -350,6 +358,7 @@ csharp_gapic_library( srcs = [":secretmanager_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "secretmanager_v1.yaml", deps = [ ":secretmanager_csharp_grpc", diff --git a/google/cloud/secretmanager/v1/resources.proto b/google/cloud/secretmanager/v1/resources.proto index 4b50a6715..3c6591e3b 100644 --- a/google/cloud/secretmanager/v1/resources.proto +++ b/google/cloud/secretmanager/v1/resources.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. @@ -31,21 +31,25 @@ option objc_class_prefix = "GSM"; option php_namespace = "Google\\Cloud\\SecretManager\\V1"; option ruby_package = "Google::Cloud::SecretManager::V1"; -// A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can -// be accessed. +// A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose +// value and versions can be accessed. // -// A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that -// represent the secret data. +// A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero or more +// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that represent +// the secret data. message Secret { option (google.api.resource) = { type: "secretmanager.googleapis.com/Secret" pattern: "projects/{project}/secrets/{secret}" }; - // Output only. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] in the format `projects/*/secrets/*`. + // Output only. The resource name of the + // [Secret][google.cloud.secretmanager.v1.Secret] in the format + // `projects/*/secrets/*`. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. Immutable. The replication policy of the secret data attached to the [Secret][google.cloud.secretmanager.v1.Secret]. + // Required. Immutable. The replication policy of the secret data attached to + // the [Secret][google.cloud.secretmanager.v1.Secret]. // // The replication policy cannot be changed after the Secret has been created. Replication replication = 2 [ @@ -53,8 +57,10 @@ message Secret { (google.api.field_behavior) = REQUIRED ]; - // Output only. The time at which the [Secret][google.cloud.secretmanager.v1.Secret] was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The time at which the + // [Secret][google.cloud.secretmanager.v1.Secret] was created. + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels assigned to this Secret. // @@ -69,32 +75,40 @@ message Secret { // No more than 64 labels can be assigned to a given resource. map labels = 4; - // Optional. A list of up to 10 Pub/Sub topics to which messages are published when - // control plane operations are called on the secret or its versions. + // Optional. A list of up to 10 Pub/Sub topics to which messages are published + // when control plane operations are called on the secret or its versions. repeated Topic topics = 5 [(google.api.field_behavior) = OPTIONAL]; - // Expiration policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. If specified the [Secret][google.cloud.secretmanager.v1.Secret] - // and all [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] will be automatically deleted at - // expiration. Expired secrets are irreversibly deleted. + // Expiration policy attached to the + // [Secret][google.cloud.secretmanager.v1.Secret]. If specified the + // [Secret][google.cloud.secretmanager.v1.Secret] and all + // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] will be + // automatically deleted at expiration. Expired secrets are irreversibly + // deleted. // // Expiration is *not* the recommended way to set time-based permissions. [IAM // Conditions](https://cloud.google.com/secret-manager/docs/access-control#conditions) // is recommended for granting time-based permissions because the operation // can be reversed. oneof expiration { - // Optional. Timestamp in UTC when the [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to expire. This is - // always provided on output, regardless of what was sent on input. - google.protobuf.Timestamp expire_time = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Input only. The TTL for the [Secret][google.cloud.secretmanager.v1.Secret]. + // Optional. Timestamp in UTC when the + // [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to expire. + // This is always provided on output, regardless of what was sent on input. + google.protobuf.Timestamp expire_time = 6 + [(google.api.field_behavior) = OPTIONAL]; + + // Input only. The TTL for the + // [Secret][google.cloud.secretmanager.v1.Secret]. google.protobuf.Duration ttl = 7 [(google.api.field_behavior) = INPUT_ONLY]; } - // Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1.Secret]. + // Optional. Etag of the currently stored + // [Secret][google.cloud.secretmanager.v1.Secret]. string etag = 8 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is no - // rotation policy. + // Optional. Rotation policy attached to the + // [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is + // no rotation policy. Rotation rotation = 9 [(google.api.field_behavior) = OPTIONAL]; // Optional. Mapping from version alias to version name. @@ -108,7 +122,22 @@ message Secret { // Version-Alias pairs will be viewable via GetSecret and modifiable via // UpdateSecret. At launch access by alias will only be supported on // GetSecretVersion and AccessSecretVersion. - map version_aliases = 11 [(google.api.field_behavior) = OPTIONAL]; + map version_aliases = 11 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Custom metadata about the secret. + // + // Annotations are distinct from various forms of labels. + // Annotations exist to allow client tools to store their own state + // information without requiring a database. + // + // Annotation keys must be between 1 and 63 characters long, have a UTF-8 + // encoding of maximum 128 bytes, begin and end with an alphanumeric character + // ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and + // alphanumerics in between these symbols. + // + // The total size of annotation keys and values must be less than 16KiB. + map annotations = 13 [(google.api.field_behavior) = OPTIONAL]; } // A secret version resource in the Secret Manager API. @@ -118,88 +147,119 @@ message SecretVersion { pattern: "projects/{project}/secrets/{secret}/versions/{secret_version}" }; - // The state of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], indicating if it can be accessed. + // The state of a + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], indicating if + // it can be accessed. enum State { // Not specified. This value is unused and invalid. STATE_UNSPECIFIED = 0; - // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may be accessed. + // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may be + // accessed. ENABLED = 1; - // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may not be accessed, but the secret data - // is still available and can be placed back into the [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED] + // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may not + // be accessed, but the secret data is still available and can be placed + // back into the + // [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED] // state. DISABLED = 2; - // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] is destroyed and the secret data is no longer - // stored. A version may not leave this state once entered. + // The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] is + // destroyed and the secret data is no longer stored. A version may not + // leave this state once entered. DESTROYED = 3; } - // Output only. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the - // format `projects/*/secrets/*/versions/*`. + // Output only. The resource name of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format + // `projects/*/secrets/*/versions/*`. // - // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] IDs in a [Secret][google.cloud.secretmanager.v1.Secret] start at 1 and - // are incremented for each subsequent version of the secret. + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] IDs in a + // [Secret][google.cloud.secretmanager.v1.Secret] start at 1 and are + // incremented for each subsequent version of the secret. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The time at which the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was created. - google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The time at which the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was created. + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The time this [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was destroyed. - // Only present if [state][google.cloud.secretmanager.v1.SecretVersion.state] is + // Output only. The time this + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was destroyed. + // Only present if [state][google.cloud.secretmanager.v1.SecretVersion.state] + // is // [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]. - google.protobuf.Timestamp destroy_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp destroy_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The current state of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + // Output only. The current state of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // The replication status of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + // The replication status of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. ReplicationStatus replication_status = 5; - // Output only. Etag of the currently stored [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + // Output only. Etag of the currently stored + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. string etag = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. True if payload checksum specified in [SecretPayload][google.cloud.secretmanager.v1.SecretPayload] object has been - // received by [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] on + // Output only. True if payload checksum specified in + // [SecretPayload][google.cloud.secretmanager.v1.SecretPayload] object has + // been received by + // [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] + // on // [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]. - bool client_specified_payload_checksum = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + bool client_specified_payload_checksum = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // A policy that defines the replication and encryption configuration of data. message Replication { - // A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload without any + // A replication policy that replicates the + // [Secret][google.cloud.secretmanager.v1.Secret] payload without any // restrictions. message Automatic { - // Optional. The customer-managed encryption configuration of the [Secret][google.cloud.secretmanager.v1.Secret]. If no - // configuration is provided, Google-managed default encryption is used. + // Optional. The customer-managed encryption configuration of the + // [Secret][google.cloud.secretmanager.v1.Secret]. If no configuration is + // provided, Google-managed default encryption is used. // - // Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption configuration only apply to - // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added afterwards. They do not apply - // retroactively to existing [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - CustomerManagedEncryption customer_managed_encryption = 1 [(google.api.field_behavior) = OPTIONAL]; + // Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption + // configuration only apply to + // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added + // afterwards. They do not apply retroactively to existing + // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + CustomerManagedEncryption customer_managed_encryption = 1 + [(google.api.field_behavior) = OPTIONAL]; } - // A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload into the - // locations specified in [Secret.replication.user_managed.replicas][] + // A replication policy that replicates the + // [Secret][google.cloud.secretmanager.v1.Secret] payload into the locations + // specified in [Secret.replication.user_managed.replicas][] message UserManaged { - // Represents a Replica for this [Secret][google.cloud.secretmanager.v1.Secret]. + // Represents a Replica for this + // [Secret][google.cloud.secretmanager.v1.Secret]. message Replica { // The canonical IDs of the location to replicate data. // For example: `"us-east1"`. string location = 1; - // Optional. The customer-managed encryption configuration of the [User-Managed - // Replica][Replication.UserManaged.Replica]. If no configuration is - // provided, Google-managed default encryption is used. + // Optional. The customer-managed encryption configuration of the + // [User-Managed Replica][Replication.UserManaged.Replica]. If no + // configuration is provided, Google-managed default encryption is used. // - // Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption configuration only apply to - // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added afterwards. They do not apply - // retroactively to existing [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. - CustomerManagedEncryption customer_managed_encryption = 2 [(google.api.field_behavior) = OPTIONAL]; + // Updates to the [Secret][google.cloud.secretmanager.v1.Secret] + // encryption configuration only apply to + // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added + // afterwards. They do not apply retroactively to existing + // [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. + CustomerManagedEncryption customer_managed_encryption = 2 + [(google.api.field_behavior) = OPTIONAL]; } - // Required. The list of Replicas for this [Secret][google.cloud.secretmanager.v1.Secret]. + // Required. The list of Replicas for this + // [Secret][google.cloud.secretmanager.v1.Secret]. // // Cannot be empty. repeated Replica replicas = 1 [(google.api.field_behavior) = REQUIRED]; @@ -207,10 +267,12 @@ message Replication { // The replication policy for this secret. oneof replication { - // The [Secret][google.cloud.secretmanager.v1.Secret] will automatically be replicated without any restrictions. + // The [Secret][google.cloud.secretmanager.v1.Secret] will automatically be + // replicated without any restrictions. Automatic automatic = 1; - // The [Secret][google.cloud.secretmanager.v1.Secret] will only be replicated into the locations specified. + // The [Secret][google.cloud.secretmanager.v1.Secret] will only be + // replicated into the locations specified. UserManaged user_managed = 2; } } @@ -218,75 +280,93 @@ message Replication { // Configuration for encrypting secret payloads using customer-managed // encryption keys (CMEK). message CustomerManagedEncryption { - // Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret - // payloads. + // Required. The resource name of the Cloud KMS CryptoKey used to encrypt + // secret payloads. // - // For secrets using the [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged] replication - // policy type, Cloud KMS CryptoKeys must reside in the same location as the - // [replica location][Secret.UserManaged.Replica.location]. + // For secrets using the + // [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged] + // replication policy type, Cloud KMS CryptoKeys must reside in the same + // location as the [replica location][Secret.UserManaged.Replica.location]. // - // For secrets using the [Automatic][google.cloud.secretmanager.v1.Replication.Automatic] replication policy - // type, Cloud KMS CryptoKeys must reside in `global`. + // For secrets using the + // [Automatic][google.cloud.secretmanager.v1.Replication.Automatic] + // replication policy type, Cloud KMS CryptoKeys must reside in `global`. // // The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. string kms_key_name = 1 [(google.api.field_behavior) = REQUIRED]; } -// The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. +// The replication status of a +// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. message ReplicationStatus { - // The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using automatic replication. + // The replication status of a + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using + // automatic replication. // - // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has an automatic replication - // policy. + // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] + // has an automatic replication policy. message AutomaticStatus { - // Output only. The customer-managed encryption status of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only + // Output only. The customer-managed encryption status of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only // populated if customer-managed encryption is used. - CustomerManagedEncryptionStatus customer_managed_encryption = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + CustomerManagedEncryptionStatus customer_managed_encryption = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } - // The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using user-managed - // replication. + // The replication status of a + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using + // user-managed replication. // - // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed replication - // policy. + // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] + // has a user-managed replication policy. message UserManagedStatus { - // Describes the status of a user-managed replica for the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + // Describes the status of a user-managed replica for the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. message ReplicaStatus { // Output only. The canonical ID of the replica location. // For example: `"us-east1"`. string location = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The customer-managed encryption status of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only + // Output only. The customer-managed encryption status of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only // populated if customer-managed encryption is used. - CustomerManagedEncryptionStatus customer_managed_encryption = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + CustomerManagedEncryptionStatus customer_managed_encryption = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. The list of replica statuses for the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. - repeated ReplicaStatus replicas = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The list of replica statuses for the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + repeated ReplicaStatus replicas = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } - // The replication status of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. + // The replication status of the + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. oneof replication_status { - // Describes the replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with + // Describes the replication status of a + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with // automatic replication. // - // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has an automatic replication - // policy. + // Only populated if the parent + // [Secret][google.cloud.secretmanager.v1.Secret] has an automatic + // replication policy. AutomaticStatus automatic = 1; - // Describes the replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with + // Describes the replication status of a + // [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with // user-managed replication. // - // Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed replication - // policy. + // Only populated if the parent + // [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed + // replication policy. UserManagedStatus user_managed = 2; } } // Describes the status of customer-managed encryption. message CustomerManagedEncryptionStatus { - // Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the - // secret payload, in the following format: + // Required. The resource name of the Cloud KMS CryptoKeyVersion used to + // encrypt the secret payload, in the following format: // `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. string kms_key_version_name = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -299,44 +379,65 @@ message Topic { pattern: "projects/{project}/topics/{topic}" }; - // Required. The resource name of the Pub/Sub topic that will be published to, in the - // following format: `projects/*/topics/*`. For publication to succeed, the - // Secret Manager P4SA must have `pubsub.publisher` permissions on the topic. + // Required. The resource name of the Pub/Sub topic that will be published to, + // in the following format: `projects/*/topics/*`. For publication to succeed, + // the Secret Manager P4SA must have `pubsub.publisher` permissions on the + // topic. string name = 1 [(google.api.field_behavior) = REQUIRED]; } -// The rotation time and period for a [Secret][google.cloud.secretmanager.v1.Secret]. At next_rotation_time, Secret +// The rotation time and period for a +// [Secret][google.cloud.secretmanager.v1.Secret]. At next_rotation_time, Secret // Manager will send a Pub/Sub notification to the topics configured on the -// Secret. [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be set to configure rotation. +// Secret. [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be +// set to configure rotation. message Rotation { - // Optional. Timestamp in UTC at which the [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate. Cannot be - // set to less than 300s (5 min) in the future and at most 3153600000s (100 - // years). + // Optional. Timestamp in UTC at which the + // [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate. + // Cannot be set to less than 300s (5 min) in the future and at most + // 3153600000s (100 years). // - // [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] MUST be set if [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] is set. - google.protobuf.Timestamp next_rotation_time = 1 [(google.api.field_behavior) = OPTIONAL]; + // [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + // MUST be set if + // [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] + // is set. + google.protobuf.Timestamp next_rotation_time = 1 + [(google.api.field_behavior) = OPTIONAL]; // Input only. The Duration between rotation notifications. Must be in seconds // and at least 3600s (1h) and at most 3153600000s (100 years). // - // If [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] is set, [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] must be set. - // [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] will be advanced by this period when the service - // automatically sends rotation notifications. - google.protobuf.Duration rotation_period = 2 [(google.api.field_behavior) = INPUT_ONLY]; + // If + // [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period] + // is set, + // [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + // must be set. + // [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time] + // will be advanced by this period when the service automatically sends + // rotation notifications. + google.protobuf.Duration rotation_period = 2 + [(google.api.field_behavior) = INPUT_ONLY]; } // A secret payload resource in the Secret Manager API. This contains the -// sensitive secret payload that is associated with a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. +// sensitive secret payload that is associated with a +// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. message SecretPayload { // The secret data. Must be no larger than 64KiB. bytes data = 1; - // Optional. If specified, [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] will verify the integrity of the - // received [data][google.cloud.secretmanager.v1.SecretPayload.data] on [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion] calls using - // the crc32c checksum and store it to include in future - // [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion] responses. If a checksum is - // not provided in the [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion] request, the - // [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] will generate and store one for you. + // Optional. If specified, + // [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] + // will verify the integrity of the received + // [data][google.cloud.secretmanager.v1.SecretPayload.data] on + // [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion] + // calls using the crc32c checksum and store it to include in future + // [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion] + // responses. If a checksum is not provided in the + // [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion] + // request, the + // [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService] + // will generate and store one for you. // // The CRC32C value is encoded as a Int64 for compatibility, and can be // safely downconverted to uint32 in languages that support this type. diff --git a/google/cloud/secrets/v1beta1/BUILD.bazel b/google/cloud/secrets/v1beta1/BUILD.bazel index aa69c8db2..db5cadee1 100644 --- a/google/cloud/secrets/v1beta1/BUILD.bazel +++ b/google/cloud/secrets/v1beta1/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( name = "secretmanager_java_gapic", srcs = [":secretmanager_proto_with_info"], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":secretmanager_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -121,6 +122,7 @@ go_gapic_library( srcs = [":secretmanager_proto_with_info"], grpc_service_config = "secretmanager_grpc_service_config.json", importpath = "cloud.google.com/go/secretmanager/apiv1beta1;secretmanager", + rest_numeric_enums = True, service_yaml = "//google/cloud/secrets/v1beta1:secretmanager_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -164,6 +166,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=secretmanager", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -213,6 +216,8 @@ php_gapic_library( name = "secretmanager_php_gapic", srcs = [":secretmanager_proto_with_info"], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":secretmanager_php_grpc", ":secretmanager_php_proto", @@ -245,7 +250,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "secretmanager_grpc_service_config.json", package = "google.cloud.secrets.v1beta1", + rest_numeric_enums = True, service_yaml = "//google/cloud/secrets/v1beta1:secretmanager_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -290,6 +297,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=secretmanager", ], grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Secret Manager is a secure and convenient storage system for API keys, passwords, certificates, and other sensitive data. Secret Manager provides a central place and single source of truth to manage, access, and audit secrets across Google Cloud.", ruby_cloud_title = "Secret Manager V1beta1", deps = [ @@ -335,6 +343,7 @@ csharp_gapic_library( srcs = [":secretmanager_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "secretmanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/secrets/v1beta1:secretmanager_v1beta1.yaml", deps = [ ":secretmanager_csharp_grpc", diff --git a/google/cloud/security/privateca/v1/BUILD.bazel b/google/cloud/security/privateca/v1/BUILD.bazel index b404eeade..0f1da935e 100644 --- a/google/cloud/security/privateca/v1/BUILD.bazel +++ b/google/cloud/security/privateca/v1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":privateca_proto_with_info"], gapic_yaml = None, grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "privateca_v1.yaml", test_deps = [ ":privateca_java_grpc", @@ -142,6 +143,7 @@ go_gapic_library( grpc_service_config = "privateca_grpc_service_config.json", importpath = "cloud.google.com/go/security/privateca/apiv1;privateca", metadata = True, + rest_numeric_enums = True, service_yaml = "privateca_v1.yaml", transport = "grpc+rest", deps = [ @@ -149,8 +151,8 @@ go_gapic_library( "//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", + "@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", ], ) @@ -190,6 +192,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-private-ca", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -237,7 +240,9 @@ php_gapic_library( name = "privateca_php_gapic", srcs = [":privateca_proto_with_info"], grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "privateca_v1.yaml", + transport = "grpc+rest", deps = [ ":privateca_php_grpc", ":privateca_php_proto", @@ -270,7 +275,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "privateca_grpc_service_config.json", package = "google.cloud.security.privateca.v1", + rest_numeric_enums = True, service_yaml = "privateca_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -316,6 +323,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=privateca", ], grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Certificate Authority Service is a highly available, scalable Google Cloud service that enables you to simplify, automate, and customize the deployment, management, and security of private certificate authorities (CA).", ruby_cloud_title = "Ceritificate Authority Service V1", service_yaml = "privateca_v1.yaml", @@ -362,6 +370,7 @@ csharp_gapic_library( srcs = [":privateca_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "privateca_v1.yaml", deps = [ ":privateca_csharp_grpc", diff --git a/google/cloud/security/privateca/v1beta1/BUILD.bazel b/google/cloud/security/privateca/v1beta1/BUILD.bazel index 01deab24f..a1e620e71 100644 --- a/google/cloud/security/privateca/v1beta1/BUILD.bazel +++ b/google/cloud/security/privateca/v1beta1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( name = "privateca_java_gapic", srcs = [":privateca_proto_with_info"], grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":privateca_java_grpc", ], @@ -130,13 +131,14 @@ go_gapic_library( srcs = [":privateca_proto_with_info"], grpc_service_config = "privateca_grpc_service_config.json", importpath = "cloud.google.com/go/security/privateca/apiv1beta1;privateca", + rest_numeric_enums = True, service_yaml = "privateca_v1beta1.yaml", transport = "grpc+rest", deps = [ ":privateca_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -175,6 +177,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-private-ca", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -221,6 +224,8 @@ php_gapic_library( name = "privateca_php_gapic", srcs = [":privateca_proto_with_info"], grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":privateca_php_grpc", ":privateca_php_proto", @@ -253,7 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "privateca_grpc_service_config.json", package = "google.cloud.security.privateca.v1beta1", + rest_numeric_enums = True, service_yaml = "privateca_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -299,6 +306,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=privateca", ], grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Certificate Authority Service is a highly available, scalable Google Cloud service that enables you to simplify, automate, and customize the deployment, management, and security of private certificate authorities (CA).", ruby_cloud_title = "Certificate Authority Service V1beta1", deps = [ @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":privateca_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "privateca_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "privateca_v1beta1.yaml", deps = [ ":privateca_csharp_grpc", diff --git a/google/cloud/security/publicca/v1beta1/BUILD.bazel b/google/cloud/security/publicca/v1beta1/BUILD.bazel index 3cc179f5c..7ec1baaa2 100644 --- a/google/cloud/security/publicca/v1beta1/BUILD.bazel +++ b/google/cloud/security/publicca/v1beta1/BUILD.bazel @@ -68,7 +68,7 @@ java_gapic_library( srcs = [":publicca_proto_with_info"], gapic_yaml = None, grpc_service_config = "publicca_v1beta1_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", test_deps = [ ":publicca_java_grpc", @@ -129,7 +129,7 @@ go_gapic_library( grpc_service_config = "publicca_v1beta1_grpc_service_config.json", importpath = "cloud.google.com/go/security/publicca/apiv1beta1;publicca", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -169,9 +169,12 @@ py_gapic_library( name = "publicca_py_gapic", srcs = [":publicca_proto"], grpc_service_config = "publicca_v1beta1_grpc_service_config.json", - rest_numeric_enums = False, + opt_args = [ + "warehouse-package-name=google-cloud-public-ca", + ], + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", - transport = "grpc", + transport = "grpc+rest", deps = [ ], ) @@ -220,8 +223,9 @@ php_gapic_library( name = "publicca_php_gapic", srcs = [":publicca_proto_with_info"], grpc_service_config = "publicca_v1beta1_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":publicca_php_grpc", ":publicca_php_proto", @@ -254,8 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "publicca_v1beta1_grpc_service_config.json", package = "google.cloud.security.publicca.v1beta1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,7 +305,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/certificate-manager/docs/public-ca/", ], grpc_service_config = "publicca_v1beta1_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Certificate Manager's Public Certificate Authority (CA) functionality allows you to provision and deploy widely trusted X.509 certificates after validating that the certificate requester controls the domains. Certificate Manager lets you directly and programmatically request publicly trusted TLS certificates that are already in the root of trust stores used by major browsers, operating systems, and applications. You can use these TLS certificates to authenticate and encrypt internet traffic.", ruby_cloud_title = "Public Certificate Authority V1beta1", service_yaml = "publicca_v1beta1.yaml", @@ -347,7 +352,7 @@ csharp_gapic_library( srcs = [":publicca_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "publicca_v1beta1_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "publicca_v1beta1.yaml", deps = [ ":publicca_csharp_grpc", diff --git a/google/cloud/securitycenter/settings/v1beta1/BUILD.bazel b/google/cloud/securitycenter/settings/v1beta1/BUILD.bazel index a82544efa..bd5edbd87 100644 --- a/google/cloud/securitycenter/settings/v1beta1/BUILD.bazel +++ b/google/cloud/securitycenter/settings/v1beta1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "settings_proto", @@ -47,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "settings_java_proto", deps = [":settings_proto"], @@ -74,9 +91,11 @@ java_gapic_library( name = "settings_java_gapic", srcs = [":settings_proto_with_info"], grpc_service_config = "securitycenter_settings_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":settings_java_grpc", ], + transport = "grpc", deps = [ ":settings_java_proto", ], @@ -93,6 +112,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-securitycenter-settings-v1beta1-java", + include_samples = True, + transport = "grpc", deps = [ ":settings_java_gapic", ":settings_java_grpc", @@ -101,17 +122,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "settings_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -127,7 +137,9 @@ go_gapic_library( srcs = [":settings_proto_with_info"], grpc_service_config = "securitycenter_settings_grpc_service_config.json", importpath = "cloud.google.com/go/securitycenter/settings/apiv1beta1;settings", + rest_numeric_enums = False, service_yaml = "securitycenter_settings.yaml", + transport = "grpc+rest", deps = [ ":settings_go_proto", ], @@ -150,20 +162,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "settings_py_gapic", srcs = [":settings_proto"], grpc_service_config = "securitycenter_settings_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -185,17 +188,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "settings_php_proto", deps = [":settings_proto"], @@ -211,6 +203,8 @@ php_gapic_library( name = "settings_php_gapic", srcs = [":settings_proto_with_info"], grpc_service_config = "securitycenter_settings_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":settings_php_grpc", ":settings_php_proto", @@ -227,22 +221,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "settings_nodejs_gapic", src = ":settings_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "securitycenter_settings_grpc_service_config.json", package = "google.cloud.securitycenter.settings.v1beta1", + rest_numeric_enums = False, service_yaml = "securitycenter_settings.yaml", + transport = "grpc", deps = [], ) @@ -254,17 +241,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "settings_ruby_proto", deps = [":settings_proto"], @@ -280,6 +256,7 @@ ruby_cloud_gapic_library( name = "settings_ruby_gapic", srcs = [":settings_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-settings-v1beta1"], + rest_numeric_enums = False, deps = [ ":settings_ruby_grpc", ":settings_ruby_proto", @@ -296,17 +273,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "settings_csharp_proto", deps = [":settings_proto"], @@ -323,6 +289,7 @@ csharp_gapic_library( srcs = [":settings_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "securitycenter_settings_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "securitycenter_settings.yaml", deps = [ ":settings_csharp_grpc", diff --git a/google/cloud/securitycenter/v1/BUILD.bazel b/google/cloud/securitycenter/v1/BUILD.bazel index d9d8a385f..17966818b 100644 --- a/google/cloud/securitycenter/v1/BUILD.bazel +++ b/google/cloud/securitycenter/v1/BUILD.bazel @@ -67,6 +67,7 @@ proto_library( "folder.proto", "iam_binding.proto", "indicator.proto", + "kernel_rootkit.proto", "kubernetes.proto", "label.proto", "mitre_attack.proto", @@ -122,6 +123,7 @@ java_gapic_library( srcs = [":securitycenter_proto_with_info"], gapic_yaml = None, grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1.yaml", test_deps = [ ":securitycenter_java_grpc", @@ -175,14 +177,15 @@ go_gapic_library( grpc_service_config = "securitycenter_grpc_service_config.json", importpath = "cloud.google.com/go/securitycenter/apiv1;securitycenter", metadata = True, + rest_numeric_enums = True, service_yaml = "securitycenter_v1.yaml", transport = "grpc+rest", deps = [ ":securitycenter_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", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -210,6 +213,7 @@ py_gapic_library( name = "securitycenter_py_gapic", srcs = [":securitycenter_proto"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -249,7 +253,9 @@ php_gapic_library( name = "securitycenter_php_gapic", srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1.yaml", + transport = "grpc+rest", deps = [ ":securitycenter_php_grpc", ":securitycenter_php_proto", @@ -273,7 +279,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "securitycenter_grpc_service_config.json", package = "google.cloud.securitycenter.v1", + rest_numeric_enums = True, service_yaml = "securitycenter_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +315,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/security-command-center", ], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Security Command Center API provides access to temporal views of assets and findings within an organization.", ruby_cloud_title = "Cloud Security Command Center V1", deps = [ @@ -341,6 +350,7 @@ csharp_gapic_library( srcs = [":securitycenter_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1.yaml", deps = [ ":securitycenter_csharp_grpc", diff --git a/google/cloud/securitycenter/v1/access.proto b/google/cloud/securitycenter/v1/access.proto index 799b84fcc..159a6ef6f 100644 --- a/google/cloud/securitycenter/v1/access.proto +++ b/google/cloud/securitycenter/v1/access.proto @@ -42,7 +42,7 @@ message Access { // The caller IP's geolocation, which identifies where the call came from. Geolocation caller_ip_geo = 3; - // What kind of user agent is associated, e.g. operating system shells, + // What kind of user agent is associated, for example operating system shells, // embedded or stand-alone applications, etc. string user_agent_family = 4; @@ -76,6 +76,15 @@ message Access { // authorities are present, they are guaranteed to be sorted based on the // original ordering of the identity delegation events. repeated ServiceAccountDelegationInfo service_account_delegation_info = 9; + + // A string that represents the username of a user, user account, or other + // entity involved in the access event. What the entity is and what its role + // in the access event is depends on the finding that this field appears in. + // The entity is likely not an IAM principal, but could be a user that is + // logged into an operating system, if the finding is VM-related, or a user + // that is logged into some type of application that is involved in the + // access event. + string user_name = 11; } // Identity delegation history of an authenticated service account. @@ -97,4 +106,4 @@ message ServiceAccountDelegationInfo { message Geolocation { // A CLDR. string region_code = 1; -} +} \ No newline at end of file diff --git a/google/cloud/securitycenter/v1/external_system.proto b/google/cloud/securitycenter/v1/external_system.proto index 8ba698138..66034dfc4 100644 --- a/google/cloud/securitycenter/v1/external_system.proto +++ b/google/cloud/securitycenter/v1/external_system.proto @@ -36,11 +36,10 @@ message ExternalSystem { pattern: "projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}" }; - // External System Name e.g. jira, demisto, etc. - // e.g.: - // `organizations/1234/sources/5678/findings/123456/externalSystems/jira` - // `folders/1234/sources/5678/findings/123456/externalSystems/jira` - // `projects/1234/sources/5678/findings/123456/externalSystems/jira` + // Full resource name of the external system, for example: + // "organizations/1234/sources/5678/findings/123456/externalSystems/jira", + // "folders/1234/sources/5678/findings/123456/externalSystems/jira", + // "projects/1234/sources/5678/findings/123456/externalSystems/jira" string name = 1; // References primary/secondary etc assignees in the external system. diff --git a/google/cloud/securitycenter/v1/finding.proto b/google/cloud/securitycenter/v1/finding.proto index 126d5e59f..a16f1d511 100644 --- a/google/cloud/securitycenter/v1/finding.proto +++ b/google/cloud/securitycenter/v1/finding.proto @@ -26,8 +26,10 @@ import "google/cloud/securitycenter/v1/container.proto"; import "google/cloud/securitycenter/v1/database.proto"; import "google/cloud/securitycenter/v1/exfiltration.proto"; import "google/cloud/securitycenter/v1/external_system.proto"; +import "google/cloud/securitycenter/v1/file.proto"; import "google/cloud/securitycenter/v1/iam_binding.proto"; import "google/cloud/securitycenter/v1/indicator.proto"; +import "google/cloud/securitycenter/v1/kernel_rootkit.proto"; import "google/cloud/securitycenter/v1/kubernetes.proto"; import "google/cloud/securitycenter/v1/mitre_attack.proto"; import "google/cloud/securitycenter/v1/process.proto"; @@ -252,7 +254,7 @@ message Finding { // Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise Indicator indicator = 18; - // Represents vulnerability specific fields like cve, cvss scores etc. + // Represents vulnerability-specific fields like CVE and CVS scores. // CVE stands for Common Vulnerabilities and Exposures // (https://cve.mitre.org/about/) Vulnerability vulnerability = 20; @@ -332,4 +334,10 @@ message Finding { // Database associated with the finding. Database database = 44; + + // File associated with the finding. + repeated File files = 46; + + // Kernel Rootkit signature. + KernelRootkit kernel_rootkit = 50; } diff --git a/google/cloud/securitycenter/v1/kernel_rootkit.proto b/google/cloud/securitycenter/v1/kernel_rootkit.proto new file mode 100644 index 000000000..1010e3eff --- /dev/null +++ b/google/cloud/securitycenter/v1/kernel_rootkit.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.cloud.securitycenter.v1; + +option csharp_namespace = "Google.Cloud.SecurityCenter.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter"; +option java_multiple_files = true; +option java_outer_classname = "KernelRootkitProto"; +option java_package = "com.google.cloud.securitycenter.v1"; +option php_namespace = "Google\\Cloud\\SecurityCenter\\V1"; +option ruby_package = "Google::Cloud::SecurityCenter::V1"; + +// Kernel mode rootkit signatures. +message KernelRootkit { + // Rootkit name when available. + string name = 1; + + // True if unexpected modifications of kernel code memory are present. + bool unexpected_code_modification = 2; + + // True if unexpected modifications of kernel read-only data memory are + // present. + bool unexpected_read_only_data_modification = 3; + + // True if `ftrace` points are present with callbacks pointing to regions + // that are not in the expected kernel or module code range. + bool unexpected_ftrace_handler = 4; + + // True if `kprobe` points are present with callbacks pointing to regions + // that are not in the expected kernel or module code range. + bool unexpected_kprobe_handler = 5; + + // True if kernel code pages that are not in the expected kernel or module + // code regions are present. + bool unexpected_kernel_code_pages = 6; + + // True if system call handlers that are are not in the expected kernel or + // module code regions are present. + bool unexpected_system_call_handler = 7; + + // True if interrupt handlers that are are not in the expected kernel or + // module code regions are present. + bool unexpected_interrupt_handler = 8; + + // True if unexpected processes in the scheduler run queue are present. Such + // processes are in the run queue, but not in the process task list. + bool unexpected_processes_in_runqueue = 9; +} diff --git a/google/cloud/securitycenter/v1/mitre_attack.proto b/google/cloud/securitycenter/v1/mitre_attack.proto index ba654822b..ab8262ccf 100644 --- a/google/cloud/securitycenter/v1/mitre_attack.proto +++ b/google/cloud/securitycenter/v1/mitre_attack.proto @@ -183,6 +183,9 @@ message MitreAttack { // T1548 ABUSE_ELEVATION_CONTROL_MECHANISM = 34; + + // T1078.001 + DEFAULT_ACCOUNTS = 35; } // The MITRE ATT&CK tactic most closely represented by this finding, if any. diff --git a/google/cloud/securitycenter/v1/notification_config.proto b/google/cloud/securitycenter/v1/notification_config.proto index 7ab946628..00e8c1e8a 100644 --- a/google/cloud/securitycenter/v1/notification_config.proto +++ b/google/cloud/securitycenter/v1/notification_config.proto @@ -39,6 +39,8 @@ message NotificationConfig { option (google.api.resource) = { type: "securitycenter.googleapis.com/NotificationConfig" pattern: "organizations/{organization}/notificationConfigs/{notification_config}" + pattern: "folders/{folder}/notificationConfigs/{notification_config}" + pattern: "projects/{project}/notificationConfigs/{notification_config}" }; // The config for streaming-based notifications, which send each event as soon @@ -71,7 +73,9 @@ message NotificationConfig { // The relative resource name of this notification config. See: // https://cloud.google.com/apis/design/resource_names#relative_resource_name // Example: - // "organizations/{organization_id}/notificationConfigs/notify_public_bucket". + // "organizations/{organization_id}/notificationConfigs/notify_public_bucket", + // "folders/{folder_id}/notificationConfigs/notify_public_bucket", + // or "projects/{project_id}/notificationConfigs/notify_public_bucket". string name = 1; // The description of the notification config (max of 1024 characters). diff --git a/google/cloud/securitycenter/v1/securitycenter_service.proto b/google/cloud/securitycenter/v1/securitycenter_service.proto index cc4d3fbfe..ad77642d5 100644 --- a/google/cloud/securitycenter/v1/securitycenter_service.proto +++ b/google/cloud/securitycenter/v1/securitycenter_service.proto @@ -51,12 +51,14 @@ option ruby_package = "Google::Cloud::SecurityCenter::V1"; // V1 APIs for Security Center service. service SecurityCenter { option (google.api.default_host) = "securitycenter.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"; // Kicks off an LRO to bulk mute findings for a parent based on a filter. The // parent can be either an organization, folder or project. The findings // matched by the filter will be muted after the LRO is done. - rpc BulkMuteFindings(BulkMuteFindingsRequest) returns (google.longrunning.Operation) { + rpc BulkMuteFindings(BulkMuteFindingsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=organizations/*}/findings:bulkMute" body: "*" @@ -114,53 +116,64 @@ service SecurityCenter { } // Creates a notification config. - rpc CreateNotificationConfig(CreateNotificationConfigRequest) returns (NotificationConfig) { + rpc CreateNotificationConfig(CreateNotificationConfigRequest) + returns (NotificationConfig) { option (google.api.http) = { post: "/v1/{parent=organizations/*}/notificationConfigs" body: "notification_config" + additional_bindings { + post: "/v1/{parent=folders/*}/notificationConfigs" + body: "notification_config" + } + additional_bindings { + post: "/v1/{parent=projects/*}/notificationConfigs" + body: "notification_config" + } }; - option (google.api.method_signature) = "parent,config_id,notification_config"; + option (google.api.method_signature) = + "parent,config_id,notification_config"; option (google.api.method_signature) = "parent,notification_config"; } // Deletes an existing mute config. - rpc DeleteMuteConfig(DeleteMuteConfigRequest) returns (google.protobuf.Empty) { + rpc DeleteMuteConfig(DeleteMuteConfigRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=organizations/*/muteConfigs/*}" - additional_bindings { - delete: "/v1/{name=folders/*/muteConfigs/*}" - } - additional_bindings { - delete: "/v1/{name=projects/*/muteConfigs/*}" - } + additional_bindings { delete: "/v1/{name=folders/*/muteConfigs/*}" } + additional_bindings { delete: "/v1/{name=projects/*/muteConfigs/*}" } }; option (google.api.method_signature) = "name"; } // Deletes a notification config. - rpc DeleteNotificationConfig(DeleteNotificationConfigRequest) returns (google.protobuf.Empty) { + rpc DeleteNotificationConfig(DeleteNotificationConfigRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=organizations/*/notificationConfigs/*}" + additional_bindings { + delete: "/v1/{name=folders/*/notificationConfigs/*}" + } + additional_bindings { + delete: "/v1/{name=projects/*/notificationConfigs/*}" + } }; option (google.api.method_signature) = "name"; } - // Gets a big query export. + // Gets a BigQuery export. rpc GetBigQueryExport(GetBigQueryExportRequest) returns (BigQueryExport) { option (google.api.http) = { get: "/v1/{name=organizations/*/bigQueryExports/*}" - additional_bindings { - get: "/v1/{name=folders/*/bigQueryExports/*}" - } - additional_bindings { - get: "/v1/{name=projects/*/bigQueryExports/*}" - } + additional_bindings { get: "/v1/{name=folders/*/bigQueryExports/*}" } + additional_bindings { get: "/v1/{name=projects/*/bigQueryExports/*}" } }; option (google.api.method_signature) = "name"; } // Gets the access control policy on the specified Source. - 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=organizations/*/sources/*}:getIamPolicy" body: "*" @@ -172,26 +185,26 @@ service SecurityCenter { rpc GetMuteConfig(GetMuteConfigRequest) returns (MuteConfig) { option (google.api.http) = { get: "/v1/{name=organizations/*/muteConfigs/*}" - additional_bindings { - get: "/v1/{name=folders/*/muteConfigs/*}" - } - additional_bindings { - get: "/v1/{name=projects/*/muteConfigs/*}" - } + additional_bindings { get: "/v1/{name=folders/*/muteConfigs/*}" } + additional_bindings { get: "/v1/{name=projects/*/muteConfigs/*}" } }; option (google.api.method_signature) = "name"; } // Gets a notification config. - rpc GetNotificationConfig(GetNotificationConfigRequest) returns (NotificationConfig) { + rpc GetNotificationConfig(GetNotificationConfigRequest) + returns (NotificationConfig) { option (google.api.http) = { get: "/v1/{name=organizations/*/notificationConfigs/*}" + additional_bindings { get: "/v1/{name=folders/*/notificationConfigs/*}" } + additional_bindings { get: "/v1/{name=projects/*/notificationConfigs/*}" } }; option (google.api.method_signature) = "name"; } // Gets the settings for an organization. - rpc GetOrganizationSettings(GetOrganizationSettingsRequest) returns (OrganizationSettings) { + rpc GetOrganizationSettings(GetOrganizationSettingsRequest) + returns (OrganizationSettings) { option (google.api.http) = { get: "/v1/{name=organizations/*/organizationSettings}" }; @@ -250,12 +263,8 @@ service SecurityCenter { rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*}/assets" - additional_bindings { - get: "/v1/{parent=folders/*}/assets" - } - additional_bindings { - get: "/v1/{parent=projects/*}/assets" - } + additional_bindings { get: "/v1/{parent=folders/*}/assets" } + additional_bindings { get: "/v1/{parent=projects/*}/assets" } }; } @@ -266,33 +275,29 @@ service SecurityCenter { rpc ListFindings(ListFindingsRequest) returns (ListFindingsResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*/sources/*}/findings" - additional_bindings { - get: "/v1/{parent=folders/*/sources/*}/findings" - } - additional_bindings { - get: "/v1/{parent=projects/*/sources/*}/findings" - } + additional_bindings { get: "/v1/{parent=folders/*/sources/*}/findings" } + additional_bindings { get: "/v1/{parent=projects/*/sources/*}/findings" } }; } // Lists mute configs. - rpc ListMuteConfigs(ListMuteConfigsRequest) returns (ListMuteConfigsResponse) { + rpc ListMuteConfigs(ListMuteConfigsRequest) + returns (ListMuteConfigsResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*}/muteConfigs" - additional_bindings { - get: "/v1/{parent=folders/*}/muteConfigs" - } - additional_bindings { - get: "/v1/{parent=projects/*}/muteConfigs" - } + additional_bindings { get: "/v1/{parent=folders/*}/muteConfigs" } + additional_bindings { get: "/v1/{parent=projects/*}/muteConfigs" } }; option (google.api.method_signature) = "parent"; } // Lists notification configs. - rpc ListNotificationConfigs(ListNotificationConfigsRequest) returns (ListNotificationConfigsResponse) { + rpc ListNotificationConfigs(ListNotificationConfigsRequest) + returns (ListNotificationConfigsResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*}/notificationConfigs" + additional_bindings { get: "/v1/{parent=folders/*}/notificationConfigs" } + additional_bindings { get: "/v1/{parent=projects/*}/notificationConfigs" } }; option (google.api.method_signature) = "parent"; } @@ -301,12 +306,8 @@ service SecurityCenter { rpc ListSources(ListSourcesRequest) returns (ListSourcesResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*}/sources" - additional_bindings { - get: "/v1/{parent=folders/*}/sources" - } - additional_bindings { - get: "/v1/{parent=projects/*}/sources" - } + additional_bindings { get: "/v1/{parent=folders/*}/sources" } + additional_bindings { get: "/v1/{parent=projects/*}/sources" } }; option (google.api.method_signature) = "parent"; } @@ -317,7 +318,8 @@ service SecurityCenter { // This API can only be called with limited frequency for an organization. If // it is called too frequently the caller will receive a TOO_MANY_REQUESTS // error. - rpc RunAssetDiscovery(RunAssetDiscoveryRequest) returns (google.longrunning.Operation) { + rpc RunAssetDiscovery(RunAssetDiscoveryRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=organizations/*}/assets:runDiscovery" body: "*" @@ -364,7 +366,8 @@ service SecurityCenter { } // Sets the access control policy on the specified Source. - 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=organizations/*/sources/*}:setIamPolicy" body: "*" @@ -373,7 +376,8 @@ service SecurityCenter { } // Returns the permissions that a caller has on the specified source. - 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=organizations/*/sources/*}:testIamPermissions" body: "*" @@ -382,7 +386,8 @@ service SecurityCenter { } // Updates external system. This is for a given finding. - rpc UpdateExternalSystem(UpdateExternalSystemRequest) returns (ExternalSystem) { + rpc UpdateExternalSystem(UpdateExternalSystemRequest) + returns (ExternalSystem) { option (google.api.http) = { patch: "/v1/{external_system.name=organizations/*/sources/*/findings/*/externalSystems/*}" body: "external_system" @@ -436,17 +441,27 @@ service SecurityCenter { // // Updates a notification config. The following update // fields are allowed: description, pubsub_topic, streaming_config.filter - rpc UpdateNotificationConfig(UpdateNotificationConfigRequest) returns (NotificationConfig) { + rpc UpdateNotificationConfig(UpdateNotificationConfigRequest) + returns (NotificationConfig) { option (google.api.http) = { patch: "/v1/{notification_config.name=organizations/*/notificationConfigs/*}" body: "notification_config" + additional_bindings { + patch: "/v1/{notification_config.name=folders/*/notificationConfigs/*}" + body: "notification_config" + } + additional_bindings { + patch: "/v1/{notification_config.name=projects/*/notificationConfigs/*}" + body: "notification_config" + } }; option (google.api.method_signature) = "notification_config"; option (google.api.method_signature) = "notification_config,update_mask"; } // Updates an organization's settings. - rpc UpdateOrganizationSettings(UpdateOrganizationSettingsRequest) returns (OrganizationSettings) { + rpc UpdateOrganizationSettings(UpdateOrganizationSettingsRequest) + returns (OrganizationSettings) { option (google.api.http) = { patch: "/v1/{organization_settings.name=organizations/*/organizationSettings}" body: "organization_settings" @@ -492,8 +507,9 @@ service SecurityCenter { option (google.api.method_signature) = "security_marks"; } - // Creates a big query export. - rpc CreateBigQueryExport(CreateBigQueryExportRequest) returns (BigQueryExport) { + // Creates a BigQuery export. + rpc CreateBigQueryExport(CreateBigQueryExportRequest) + returns (BigQueryExport) { option (google.api.http) = { post: "/v1/{parent=organizations/*}/bigQueryExports" body: "big_query_export" @@ -506,25 +522,24 @@ service SecurityCenter { body: "big_query_export" } }; - option (google.api.method_signature) = "parent,big_query_export,big_query_export_id"; + option (google.api.method_signature) = + "parent,big_query_export,big_query_export_id"; } - // Deletes an existing big query export. - rpc DeleteBigQueryExport(DeleteBigQueryExportRequest) returns (google.protobuf.Empty) { + // Deletes an existing BigQuery export. + rpc DeleteBigQueryExport(DeleteBigQueryExportRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=organizations/*/bigQueryExports/*}" - additional_bindings { - delete: "/v1/{name=folders/*/bigQueryExports/*}" - } - additional_bindings { - delete: "/v1/{name=projects/*/bigQueryExports/*}" - } + additional_bindings { delete: "/v1/{name=folders/*/bigQueryExports/*}" } + additional_bindings { delete: "/v1/{name=projects/*/bigQueryExports/*}" } }; option (google.api.method_signature) = "name"; } // Updates a BigQuery export. - rpc UpdateBigQueryExport(UpdateBigQueryExportRequest) returns (BigQueryExport) { + rpc UpdateBigQueryExport(UpdateBigQueryExportRequest) + returns (BigQueryExport) { option (google.api.http) = { patch: "/v1/{big_query_export.name=organizations/*/bigQueryExports/*}" body: "big_query_export" @@ -545,15 +560,12 @@ service SecurityCenter { // requesting BigQuery exports under a folder, then all BigQuery exports // immediately under the folder plus the ones created under the projects // within the folder are returned. - rpc ListBigQueryExports(ListBigQueryExportsRequest) returns (ListBigQueryExportsResponse) { + rpc ListBigQueryExports(ListBigQueryExportsRequest) + returns (ListBigQueryExportsResponse) { option (google.api.http) = { get: "/v1/{parent=organizations/*}/bigQueryExports" - additional_bindings { - get: "/v1/{parent=folders/*}/bigQueryExports" - } - additional_bindings { - get: "/v1/{parent=projects/*}/bigQueryExports" - } + additional_bindings { get: "/v1/{parent=folders/*}/bigQueryExports" } + additional_bindings { get: "/v1/{parent=projects/*}/bigQueryExports" } }; option (google.api.method_signature) = "parent"; } @@ -566,14 +578,12 @@ service SecurityCenter { // which they get executed is not defined. // 2. Once a bulk operation is started, there is no way to stop it. message BulkMuteFindingsRequest { - // Required. The parent, at which bulk action needs to be applied. Its format is - // "organizations/[organization_id]", "folders/[folder_id]", + // Required. The parent, at which bulk action needs to be applied. Its format + // is "organizations/[organization_id]", "folders/[folder_id]", // "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "*" - } + (google.api.resource_reference) = { type: "*" } ]; // Expression that identifies findings that should be updated. @@ -604,9 +614,7 @@ message BulkMuteFindingsRequest { } // The response to a BulkMute request. Contains the LRO information. -message BulkMuteFindingsResponse { - -} +message BulkMuteFindingsResponse {} // Request message for creating a finding. message CreateFindingRequest { @@ -624,8 +632,8 @@ message CreateFindingRequest { // greater than 0 characters in length. string finding_id = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The Finding being created. The name and security_marks will be ignored as - // they are both output only fields on this resource. + // Required. The Finding being created. The name and security_marks will be + // ignored as they are both output only fields on this resource. Finding finding = 3 [(google.api.field_behavior) = REQUIRED]; } @@ -653,24 +661,27 @@ message CreateMuteConfigRequest { // Request message for creating a notification config. message CreateNotificationConfigRequest { - // Required. Resource name of the new notification config's parent. Its format is - // "organizations/[organization_id]". + // Required. Resource name of the new notification config's parent. Its format + // is "organizations/[organization_id]", "folders/[folder_id]", or + // "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "cloudresourcemanager.googleapis.com/Organization" + child_type: "securitycenter.googleapis.com/NotificationConfig" } ]; // Required. // Unique identifier provided by the client within the parent scope. - // It must be between 1 and 128 characters, and contains alphanumeric - // characters, underscores or hyphens only. + // It must be between 1 and 128 characters and contain alphanumeric + // characters, underscores, or hyphens only. string config_id = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The notification config being created. The name and the service account - // will be ignored as they are both output only fields on this resource. - NotificationConfig notification_config = 3 [(google.api.field_behavior) = REQUIRED]; + // Required. The notification config being created. The name and the service + // account will be ignored as they are both output only fields on this + // resource. + NotificationConfig notification_config = 3 + [(google.api.field_behavior) = REQUIRED]; } // Request message for creating a source. @@ -684,8 +695,8 @@ message CreateSourceRequest { } ]; - // Required. The Source being created, only the display_name and description will be - // used. All other fields will be ignored. + // Required. The Source being created, only the display_name and description + // will be used. All other fields will be ignored. Source source = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -706,7 +717,9 @@ message DeleteMuteConfigRequest { // Request message for deleting a notification config. message DeleteNotificationConfigRequest { // Required. Name of the notification config to delete. Its format is - // "organizations/[organization_id]/notificationConfigs/[config_id]". + // "organizations/[organization_id]/notificationConfigs/[config_id]", + // "folders/[folder_id]/notificationConfigs/[config_id]", + // or "projects/[project_id]/notificationConfigs/[config_id]". string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -715,9 +728,9 @@ message DeleteNotificationConfigRequest { ]; } -// Request message for retrieving a big query export. +// Request message for retrieving a BigQuery export. message GetBigQueryExportRequest { - // Required. Name of the big query export to retrieve. Its format is + // Required. Name of the BigQuery export to retrieve. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id} @@ -746,7 +759,9 @@ message GetMuteConfigRequest { // Request message for getting a notification config. message GetNotificationConfigRequest { // Required. Name of the notification config to get. Its format is - // "organizations/[organization_id]/notificationConfigs/[config_id]". + // "organizations/[organization_id]/notificationConfigs/[config_id]", + // "folders/[folder_id]/notificationConfigs/[config_id]", + // or "projects/[project_id]/notificationConfigs/[config_id]". string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -757,8 +772,8 @@ message GetNotificationConfigRequest { // Request message for getting organization settings. message GetOrganizationSettingsRequest { - // Required. Name of the organization to get organization settings for. Its format is - // "organizations/[organization_id]/organizationSettings". + // Required. Name of the organization to get organization settings for. Its + // format is "organizations/[organization_id]/organizationSettings". string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -781,7 +796,7 @@ message GetSourceRequest { // Request message for grouping by assets. message GroupAssetsRequest { - // Required. Name of the organization to groupBy. Its format is + // Required. The name of the parent to group the assets by. Its format is // "organizations/[organization_id], folders/[folder_id], or // projects/[project_id]". string parent = 1 [ @@ -855,9 +870,9 @@ message GroupAssetsRequest { // property not existing: `-resource_properties.my_property : ""` string filter = 2; - // Required. Expression that defines what assets fields to use for grouping. The string - // value should follow SQL syntax: comma separated list of fields. For - // example: + // Required. Expression that defines what assets fields to use for grouping. + // The string value should follow SQL syntax: comma separated list of fields. + // For example: // "security_center_properties.resource_project,security_center_properties.project". // // The following fields are supported when compare_duration is not set: @@ -1015,9 +1030,9 @@ message GroupFindingsRequest { // * resource.type: `=`, `:` string filter = 2; - // Required. Expression that defines what assets fields to use for grouping (including - // `state_change`). The string value should follow SQL syntax: comma separated - // list of fields. For example: "parent,resource_name". + // Required. Expression that defines what assets fields to use for grouping + // (including `state_change`). The string value should follow SQL syntax: + // comma separated list of fields. For example: "parent,resource_name". // // The following fields are supported: // @@ -1112,8 +1127,8 @@ message GroupResult { // Request message for listing mute configs at a given scope e.g. organization, // folder or project. message ListMuteConfigsRequest { - // Required. The parent, which owns the collection of mute configs. Its format is - // "organizations/[organization_id]", "folders/[folder_id]", + // Required. The parent, which owns the collection of mute configs. Its format + // is "organizations/[organization_id]", "folders/[folder_id]", // "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1148,12 +1163,13 @@ message ListMuteConfigsResponse { // Request message for listing notification configs. message ListNotificationConfigsRequest { - // Required. Name of the organization to list notification configs. - // Its format is "organizations/[organization_id]". + // Required. The name of the parent in which to list the notification + // configurations. Its format is "organizations/[organization_id]", + // "folders/[folder_id]", or "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "cloudresourcemanager.googleapis.com/Organization" + child_type: "securitycenter.googleapis.com/NotificationConfig" } ]; @@ -1179,8 +1195,8 @@ message ListNotificationConfigsResponse { // Request message for listing sources. message ListSourcesRequest { - // Required. Resource name of the parent of sources to list. Its format should be - // "organizations/[organization_id], folders/[folder_id], or + // Required. Resource name of the parent of sources to list. Its format should + // be "organizations/[organization_id], folders/[folder_id], or // projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1211,8 +1227,8 @@ message ListSourcesResponse { // Request message for listing assets. message ListAssetsRequest { - // Required. Name of the organization assets should belong to. Its format is - // "organizations/[organization_id], folders/[folder_id], or + // Required. The name of the parent that the listed assets belong to. Its + // format is "organizations/[organization_id], folders/[folder_id], or // projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1640,10 +1656,12 @@ message ListFindingsResponse { // Request message for updating a finding's state. message SetFindingStateRequest { - // Required. The relative resource name of the finding. See: - // https://cloud.google.com/apis/design/resource_names#relative_resource_name - // Example: - // "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}". + // Required. The [relative resource + // name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) + // of the finding. Example: + // "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", + // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", + // "projects/{project_id}/sources/{source_id}/findings/{finding_id}". string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1655,17 +1673,18 @@ message SetFindingStateRequest { Finding.State state = 2 [(google.api.field_behavior) = REQUIRED]; // Required. The time at which the updated state takes effect. - google.protobuf.Timestamp start_time = 3 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Timestamp start_time = 3 + [(google.api.field_behavior) = REQUIRED]; } // Request message for updating a finding's mute status. message SetMuteRequest { - // Required. The relative resource name of the finding. See: - // https://cloud.google.com/apis/design/resource_names#relative_resource_name - // Example: - // "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}", - // "folders/{folder_id}/sources/{source_id}/finding/{finding_id}", - // "projects/{project_id}/sources/{source_id}/finding/{finding_id}". + // Required. The [relative resource + // name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) + // of the finding. Example: + // "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", + // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", + // "projects/{project_id}/sources/{source_id}/findings/{finding_id}". string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1679,8 +1698,8 @@ message SetMuteRequest { // Request message for running asset discovery for an organization. message RunAssetDiscoveryRequest { - // Required. Name of the organization to run asset discovery for. Its format is - // "organizations/[organization_id]". + // Required. Name of the organization to run asset discovery for. Its format + // is "organizations/[organization_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1702,8 +1721,8 @@ message UpdateExternalSystemRequest { // Request message for updating or creating a finding. message UpdateFindingRequest { - // Required. The finding resource to update or create if it does not already exist. - // parent, security_marks, and update_time will be ignored. + // Required. The finding resource to update or create if it does not already + // exist. parent, security_marks, and update_time will be ignored. // // In the case of creation, the finding id portion of the name must be // alphanumeric and less than or equal to 32 characters and greater than 0 @@ -1733,7 +1752,8 @@ message UpdateMuteConfigRequest { // Request message for updating a notification config. message UpdateNotificationConfigRequest { // Required. The notification config to update. - NotificationConfig notification_config = 1 [(google.api.field_behavior) = REQUIRED]; + NotificationConfig notification_config = 1 + [(google.api.field_behavior) = REQUIRED]; // The FieldMask to use when updating the notification config. // @@ -1744,7 +1764,8 @@ message UpdateNotificationConfigRequest { // Request message for updating an organization's settings. message UpdateOrganizationSettingsRequest { // Required. The organization settings resource to update. - OrganizationSettings organization_settings = 1 [(google.api.field_behavior) = REQUIRED]; + OrganizationSettings organization_settings = 1 + [(google.api.field_behavior) = REQUIRED]; // The FieldMask to use when updating the settings resource. // @@ -1782,10 +1803,10 @@ message UpdateSecurityMarksRequest { google.protobuf.Timestamp start_time = 3; } -// Request message for creating a big query export. +// Request message for creating a BigQuery export. message CreateBigQueryExportRequest { - // Required. Resource name of the new big query export's parent. Its format is - // "organizations/[organization_id]", "folders/[folder_id]", or + // Required. The name of the parent resource of the new BigQuery export. Its + // format is "organizations/[organization_id]", "folders/[folder_id]", or // "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1794,7 +1815,7 @@ message CreateBigQueryExportRequest { } ]; - // Required. The big query export being created. + // Required. The BigQuery export being created. BigQueryExport big_query_export = 2 [(google.api.field_behavior) = REQUIRED]; // Required. Unique identifier provided by the client within the parent scope. @@ -1814,11 +1835,11 @@ message UpdateBigQueryExportRequest { google.protobuf.FieldMask update_mask = 2; } -// Request message for listing BigQuery exports at a given scope e.g. +// Request message for listing BigQuery exports at a given scope e.g. // organization, folder or project. message ListBigQueryExportsRequest { - // Required. The parent, which owns the collection of BigQuery exports. Its format is - // "organizations/[organization_id]", "folders/[folder_id]", + // Required. The parent, which owns the collection of BigQuery exports. Its + // format is "organizations/[organization_id]", "folders/[folder_id]", // "projects/[project_id]". string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1850,9 +1871,9 @@ message ListBigQueryExportsResponse { string next_page_token = 2; } -// Request message for deleting a big query export. +// Request message for deleting a BigQuery export. message DeleteBigQueryExportRequest { - // Required. Name of the big query export to delete. Its format is + // Required. The name of the BigQuery export to delete. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id} diff --git a/google/cloud/securitycenter/v1beta1/BUILD.bazel b/google/cloud/securitycenter/v1beta1/BUILD.bazel index b2c9d0cca..43202e026 100644 --- a/google/cloud/securitycenter/v1beta1/BUILD.bazel +++ b/google/cloud/securitycenter/v1beta1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "securitycenter_java_gapic", srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":securitycenter_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -132,14 +133,15 @@ go_gapic_library( srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", importpath = "cloud.google.com/go/securitycenter/apiv1beta1;securitycenter", + rest_numeric_enums = True, service_yaml = "securitycenter_v1beta1.yaml", transport = "grpc+rest", deps = [ ":securitycenter_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", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -176,6 +178,7 @@ py_gapic_library( name = "securitycenter_py_gapic", srcs = [":securitycenter_proto"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -226,7 +229,9 @@ php_gapic_library( name = "securitycenter_php_gapic", srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":securitycenter_php_grpc", ":securitycenter_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "securitycenter_grpc_service_config.json", package = "google.cloud.securitycenter.v1beta1", + rest_numeric_enums = True, service_yaml = "securitycenter_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -297,6 +304,7 @@ ruby_cloud_gapic_library( name = "securitycenter_ruby_gapic", srcs = [":securitycenter_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-securitycenter-v1beta1"], + rest_numeric_enums = True, deps = [ ":securitycenter_ruby_grpc", ":securitycenter_ruby_proto", @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":securitycenter_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1beta1.yaml", deps = [ ":securitycenter_csharp_grpc", diff --git a/google/cloud/securitycenter/v1p1beta1/BUILD.bazel b/google/cloud/securitycenter/v1p1beta1/BUILD.bazel index 85ce05502..c9eee4f75 100644 --- a/google/cloud/securitycenter/v1p1beta1/BUILD.bazel +++ b/google/cloud/securitycenter/v1p1beta1/BUILD.bazel @@ -84,6 +84,7 @@ java_gapic_library( name = "securitycenter_java_gapic", srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":securitycenter_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -145,14 +146,15 @@ go_gapic_library( srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", importpath = "cloud.google.com/go/securitycenter/apiv1p1beta1;securitycenter", + rest_numeric_enums = True, service_yaml = "securitycenter_v1p1beta1.yaml", transport = "grpc+rest", deps = [ ":securitycenter_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", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -189,6 +191,7 @@ py_gapic_library( name = "securitycenter_py_gapic", srcs = [":securitycenter_proto"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -239,7 +242,9 @@ php_gapic_library( name = "securitycenter_php_gapic", srcs = [":securitycenter_proto_with_info"], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1p1beta1.yaml", + transport = "grpc+rest", deps = [ ":securitycenter_php_grpc", ":securitycenter_php_proto", @@ -272,7 +277,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "securitycenter_grpc_service_config.json", package = "google.cloud.securitycenter.v1p1beta1", + rest_numeric_enums = True, service_yaml = "securitycenter_v1p1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -317,6 +324,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=securitycenter", ], grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Security Command Center API provides access to temporal views of assets and findings within an organization.", ruby_cloud_title = "Cloud Security Command Center V1p1beta1", deps = [ @@ -362,6 +370,7 @@ csharp_gapic_library( srcs = [":securitycenter_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "securitycenter_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "securitycenter_v1p1beta1.yaml", deps = [ ":securitycenter_csharp_grpc", diff --git a/google/cloud/servicedirectory/v1/BUILD.bazel b/google/cloud/servicedirectory/v1/BUILD.bazel index e65513482..33876c06c 100644 --- a/google/cloud/servicedirectory/v1/BUILD.bazel +++ b/google/cloud/servicedirectory/v1/BUILD.bazel @@ -94,6 +94,7 @@ java_gapic_library( name = "servicedirectory_java_gapic", srcs = [":servicedirectory_proto_with_info"], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":servicedirectory_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -145,6 +146,7 @@ go_gapic_library( srcs = [":servicedirectory_proto_with_info"], grpc_service_config = "servicedirectory_grpc_service_config.json", importpath = "cloud.google.com/go/servicedirectory/apiv1;servicedirectory", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1.yaml", transport = "grpc+rest", deps = [ @@ -177,6 +179,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-service-directory", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -216,6 +219,8 @@ php_gapic_library( name = "servicedirectory_php_gapic", srcs = [":servicedirectory_proto_with_info"], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":servicedirectory_php_grpc", ":servicedirectory_php_proto", @@ -240,7 +245,9 @@ nodejs_gapic_library( grpc_service_config = "servicedirectory_grpc_service_config.json", main_service = "ServiceDirectory", package = "google.cloud.servicedirectory.v1", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -274,6 +281,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=servicedirectory", ], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Service Directory is the single place to register, browse, and resolve application services.", ruby_cloud_title = "Service Directory V1", deps = [ @@ -308,6 +316,7 @@ csharp_gapic_library( srcs = [":servicedirectory_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1.yaml", deps = [ ":servicedirectory_csharp_grpc", diff --git a/google/cloud/servicedirectory/v1beta1/BUILD.bazel b/google/cloud/servicedirectory/v1beta1/BUILD.bazel index e00053a2a..ed9ccd51e 100644 --- a/google/cloud/servicedirectory/v1beta1/BUILD.bazel +++ b/google/cloud/servicedirectory/v1beta1/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( name = "servicedirectory_java_gapic", srcs = [":servicedirectory_proto_with_info"], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":servicedirectory_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -138,6 +139,7 @@ go_gapic_library( grpc_service_config = "servicedirectory_grpc_service_config.json", importpath = "cloud.google.com/go/servicedirectory/apiv1beta1;servicedirectory", metadata = True, + rest_numeric_enums = True, service_yaml = "servicedirectory_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -179,6 +181,7 @@ py_gapic_library( srcs = [":servicedirectory_proto"], grpc_service_config = "servicedirectory_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-service-directory"], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -229,7 +232,9 @@ php_gapic_library( name = "servicedirectory_php_gapic", srcs = [":servicedirectory_proto_with_info"], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":servicedirectory_php_grpc", ":servicedirectory_php_proto", @@ -263,7 +268,9 @@ nodejs_gapic_library( grpc_service_config = "servicedirectory_grpc_service_config.json", main_service = "ServiceDirectory", package = "google.cloud.servicedirectory.v1beta1", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -308,6 +315,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/service-directory", ], grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Service directory is the single place to register, browse, and resolve application services.", ruby_cloud_title = "Service Directory V1beta1", deps = [ @@ -353,6 +361,7 @@ csharp_gapic_library( srcs = [":servicedirectory_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "servicedirectory_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "servicedirectory_v1beta1.yaml", deps = [ ":servicedirectory_csharp_grpc", diff --git a/google/cloud/shell/v1/BUILD.bazel b/google/cloud/shell/v1/BUILD.bazel index 1b98b7c61..364a394ab 100644 --- a/google/cloud/shell/v1/BUILD.bazel +++ b/google/cloud/shell/v1/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( name = "shell_java_gapic", srcs = [":shell_proto_with_info"], grpc_service_config = "cloudshell_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":shell_java_grpc", ], @@ -128,13 +129,14 @@ go_gapic_library( grpc_service_config = "cloudshell_grpc_service_config.json", importpath = "cloud.google.com/go/shell/apiv1;shell", metadata = True, + rest_numeric_enums = True, service_yaml = "cloudshell_v1.yaml", transport = "grpc+rest", deps = [ ":shell_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -170,6 +172,7 @@ py_gapic_library( name = "shell_py_gapic", srcs = [":shell_proto"], grpc_service_config = "cloudshell_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -217,7 +220,9 @@ php_gapic_library( name = "shell_php_gapic", srcs = [":shell_proto_with_info"], grpc_service_config = "cloudshell_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudshell_v1.yaml", + transport = "grpc+rest", deps = [ ":shell_php_grpc", ":shell_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudshell_grpc_service_config.json", package = "google.cloud.shell.v1", + rest_numeric_enums = True, service_yaml = "cloudshell_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudshell", ], grpc_service_config = "cloudshell_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Shell is an interactive shell environment for Google Cloud that makes it easy for you to learn and experiment with Google Cloud and manage your projects and resources from your web browser.", ruby_cloud_title = "Cloud Shell V1", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":shell_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudshell_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudshell_v1.yaml", deps = [ ":shell_csharp_grpc", diff --git a/google/cloud/shell/v1/cloudshell.proto b/google/cloud/shell/v1/cloudshell.proto index 6d4f6c6b0..cee2cb188 100644 --- a/google/cloud/shell/v1/cloudshell.proto +++ b/google/cloud/shell/v1/cloudshell.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. @@ -380,6 +380,10 @@ message CloudShellErrorDetails { // The user has exhausted their weekly Cloud Shell quota, and Cloud Shell // will be disabled until the quota resets. QUOTA_EXCEEDED = 5; + + // The Cloud Shell environment is unavailable and cannot be connected to at + // the moment. + ENVIRONMENT_UNAVAILABLE = 6; } // Code indicating the specific error the occurred. diff --git a/google/cloud/shell/v1/cloudshell_v1.yaml b/google/cloud/shell/v1/cloudshell_v1.yaml index c042cece4..8587a0590 100644 --- a/google/cloud/shell/v1/cloudshell_v1.yaml +++ b/google/cloud/shell/v1/cloudshell_v1.yaml @@ -5,6 +5,7 @@ title: Cloud Shell API apis: - name: google.cloud.shell.v1.CloudShellService +- name: google.longrunning.Operations types: - name: google.cloud.shell.v1.AddPublicKeyMetadata @@ -30,17 +31,6 @@ backend: - selector: 'google.longrunning.Operations.*' deadline: 30.0 -http: - rules: - - selector: google.longrunning.Operations.ListOperations - get: '/v1/{name=operations}' - - selector: google.longrunning.Operations.GetOperation - get: '/v1/{name=operations/**}' - - selector: google.longrunning.Operations.DeleteOperation - delete: '/v1/{name=operations/**}' - - selector: google.longrunning.Operations.CancelOperation - post: '/v1/{name=operations/**}:cancel' - authentication: rules: - selector: 'google.cloud.shell.v1.CloudShellService.*' diff --git a/google/cloud/speech/v1/BUILD.bazel b/google/cloud/speech/v1/BUILD.bazel index e2a956c65..38dbb3124 100644 --- a/google/cloud/speech/v1/BUILD.bazel +++ b/google/cloud/speech/v1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( srcs = [":speech_proto_with_info"], gapic_yaml = None, grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", test_deps = [ ":speech_java_grpc", @@ -140,13 +141,14 @@ go_gapic_library( grpc_service_config = "speech_grpc_service_config.json", importpath = "cloud.google.com/go/speech/apiv1;speech", metadata = True, + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", transport = "grpc+rest", deps = [ ":speech_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -183,6 +185,7 @@ py_gapic_library( name = "speech_py_gapic", srcs = [":speech_proto"], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", transport = "grpc", ) @@ -231,7 +234,9 @@ php_gapic_library( name = "speech_php_gapic", srcs = [":speech_proto_with_info"], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", + transport = "grpc+rest", deps = [ ":speech_php_grpc", ":speech_php_proto", @@ -264,7 +269,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "speech_grpc_service_config.json", package = "google.cloud.speech.v1", + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -309,6 +316,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/speech-to-text", ], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Speech-to-Text enables developers to convert audio to text by applying powerful neural network models in an easy-to-use API. The API recognizes more than 120 languages and variants to support your global user base. You can enable voice command-and-control, transcribe audio from call centers, and more. It can process real-time streaming or prerecorded audio, using Google's machine learning technology.", ruby_cloud_title = "Cloud Speech-to-Text V1", deps = [ @@ -354,6 +362,7 @@ csharp_gapic_library( srcs = [":speech_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1.yaml", deps = [ ":speech_csharp_grpc", diff --git a/google/cloud/speech/v1/cloud_speech.proto b/google/cloud/speech/v1/cloud_speech.proto index 65aed9837..e8f196030 100644 --- a/google/cloud/speech/v1/cloud_speech.proto +++ b/google/cloud/speech/v1/cloud_speech.proto @@ -260,8 +260,7 @@ message RecognitionConfig { // The number of channels in the input audio data. // ONLY set this for MULTI-CHANNEL recognition. - // Valid values for LINEAR16 and FLAC are `1`-`8`. - // Valid values for OGG_OPUS are '1'-'254'. + // Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`. // Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. // If `0` or omitted, defaults to one channel (mono). // Note: We only recognize the first channel by default. @@ -652,6 +651,13 @@ message RecognizeResponse { // When available, billed audio seconds for the corresponding request. google.protobuf.Duration total_billed_time = 3; + + // Provides information on adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 7; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 8; } // The only message returned to the client by the `LongRunningRecognize` method. @@ -672,6 +678,13 @@ message LongRunningRecognizeResponse { // If the transcript output fails this field contains the relevant error. google.rpc.Status output_error = 7; + + // Provides information on speech adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 8; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 9; } // Describes the progress of a long-running `LongRunningRecognize` call. It is @@ -774,6 +787,13 @@ message StreamingRecognizeResponse { // When available, billed audio seconds for the stream. // Set only if this is the last response in the stream. google.protobuf.Duration total_billed_time = 5; + + // Provides information on adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 9; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 10; } // A streaming speech recognition result corresponding to a portion of the audio @@ -897,3 +917,14 @@ message WordInfo { // top alternative. int32 speaker_tag = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } + +// Information on speech adaptation use in results +message SpeechAdaptationInfo { + // Whether there was a timeout when applying speech adaptation. If true, + // adaptation had no effect in the response transcript. + bool adaptation_timeout = 1; + + // If set, returns a message specifying which part of the speech adaptation + // request timed out. + string timeout_message = 4; +} diff --git a/google/cloud/speech/v1/speech_v1.yaml b/google/cloud/speech/v1/speech_v1.yaml index d2a5ba9e0..628014f44 100644 --- a/google/cloud/speech/v1/speech_v1.yaml +++ b/google/cloud/speech/v1/speech_v1.yaml @@ -6,6 +6,7 @@ title: Cloud Speech-to-Text API apis: - name: google.cloud.speech.v1.Adaptation - name: google.cloud.speech.v1.Speech +- name: google.longrunning.Operations types: - name: google.cloud.speech.v1.LongRunningRecognizeMetadata diff --git a/google/cloud/speech/v1p1beta1/BUILD.bazel b/google/cloud/speech/v1p1beta1/BUILD.bazel index 0f9c33419..30220d1b0 100644 --- a/google/cloud/speech/v1p1beta1/BUILD.bazel +++ b/google/cloud/speech/v1p1beta1/BUILD.bazel @@ -76,6 +76,7 @@ java_gapic_library( name = "speech_java_gapic", srcs = [":speech_proto_with_info"], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":speech_java_grpc", ], @@ -138,13 +139,14 @@ go_gapic_library( grpc_service_config = "speech_grpc_service_config.json", importpath = "cloud.google.com/go/speech/apiv1p1beta1;speech", metadata = True, + rest_numeric_enums = True, service_yaml = "speech_v1p1beta1.yaml", transport = "grpc+rest", deps = [ ":speech_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], @@ -182,6 +184,7 @@ py_gapic_library( name = "speech_py_gapic", srcs = [":speech_proto"], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -229,7 +232,9 @@ php_gapic_library( name = "speech_php_gapic", srcs = [":speech_proto_with_info"], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1p1beta1.yaml", + transport = "grpc+rest", deps = [ ":speech_php_grpc", ":speech_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "speech_grpc_service_config.json", package = "google.cloud.speech.v1p1beta1", + rest_numeric_enums = True, service_yaml = "speech_v1p1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/speech-to-text", ], grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Google Speech-to-Text enables developers to convert audio to text by applying powerful neural network models in an easy-to-use API. The API recognizes more than 120 languages and variants to support your global user base. You can enable voice command-and-control, transcribe audio from call centers, and more. It can process real-time streaming or prerecorded audio, using Google's machine learning technology.", ruby_cloud_title = "Cloud Speech-to-Text V1p1beta1", deps = [ @@ -352,6 +360,7 @@ csharp_gapic_library( srcs = [":speech_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "speech_v1p1beta1.yaml", deps = [ ":speech_csharp_grpc", diff --git a/google/cloud/speech/v1p1beta1/cloud_speech.proto b/google/cloud/speech/v1p1beta1/cloud_speech.proto index 9bf36fccf..d1396692b 100644 --- a/google/cloud/speech/v1p1beta1/cloud_speech.proto +++ b/google/cloud/speech/v1p1beta1/cloud_speech.proto @@ -266,8 +266,7 @@ message RecognitionConfig { // The number of channels in the input audio data. // ONLY set this for MULTI-CHANNEL recognition. - // Valid values for LINEAR16 and FLAC are `1`-`8`. - // Valid values for OGG_OPUS are '1'-'254'. + // Valid values for LINEAR16, OGG_OPUS and FLAC are `1`-`8`. // Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. // If `0` or omitted, defaults to one channel (mono). // Note: We only recognize the first channel by default. @@ -679,6 +678,13 @@ message RecognizeResponse { // When available, billed audio seconds for the corresponding request. google.protobuf.Duration total_billed_time = 3; + + // Provides information on adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 7; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 8; } // The only message returned to the client by the `LongRunningRecognize` method. @@ -699,6 +705,13 @@ message LongRunningRecognizeResponse { // If the transcript output fails this field contains the relevant error. google.rpc.Status output_error = 7; + + // Provides information on speech adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 8; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 9; } // Describes the progress of a long-running `LongRunningRecognize` call. It is @@ -804,6 +817,13 @@ message StreamingRecognizeResponse { // When available, billed audio seconds for the stream. // Set only if this is the last response in the stream. google.protobuf.Duration total_billed_time = 5; + + // Provides information on adaptation behavior in response + SpeechAdaptationInfo speech_adaptation_info = 9; + + // The ID associated with the request. This is a unique ID specific only to + // the given request. + int64 request_id = 10; } // A streaming speech recognition result corresponding to a portion of the audio @@ -927,3 +947,14 @@ message WordInfo { // top alternative. int32 speaker_tag = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; } + +// Information on speech adaptation use in results +message SpeechAdaptationInfo { + // Whether there was a timeout when applying speech adaptation. If true, + // adaptation had no effect in the response transcript. + bool adaptation_timeout = 1; + + // If set, returns a message specifying which part of the speech adaptation + // request timed out. + string timeout_message = 4; +} diff --git a/google/cloud/speech/v1p1beta1/speech_v1p1beta1.yaml b/google/cloud/speech/v1p1beta1/speech_v1p1beta1.yaml index e45954eae..e8285e975 100644 --- a/google/cloud/speech/v1p1beta1/speech_v1p1beta1.yaml +++ b/google/cloud/speech/v1p1beta1/speech_v1p1beta1.yaml @@ -6,6 +6,7 @@ title: Cloud Speech-to-Text API apis: - name: google.cloud.speech.v1p1beta1.Adaptation - name: google.cloud.speech.v1p1beta1.Speech +- name: google.longrunning.Operations types: - name: google.cloud.speech.v1p1beta1.LongRunningRecognizeMetadata diff --git a/google/cloud/speech/v2/BUILD.bazel b/google/cloud/speech/v2/BUILD.bazel index 743a2fb34..e5356162e 100644 --- a/google/cloud/speech/v2/BUILD.bazel +++ b/google/cloud/speech/v2/BUILD.bazel @@ -43,3 +43,356 @@ proto_library_with_info( "//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 = "speech_java_proto", + deps = [":speech_proto"], +) + +java_grpc_library( + name = "speech_java_grpc", + srcs = [":speech_proto"], + deps = [":speech_java_proto"], +) + +java_gapic_library( + name = "speech_java_gapic", + srcs = [":speech_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + test_deps = [ + ":speech_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":speech_java_proto", + "//google/api:api_java_proto", + ], +) + +java_gapic_test( + name = "speech_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.speech.v2.SpeechClientHttpJsonTest", + "com.google.cloud.speech.v2.SpeechClientTest", + ], + runtime_deps = [":speech_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-speech-v2-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":speech_java_gapic", + ":speech_java_grpc", + ":speech_java_proto", + ":speech_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 = "speech_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/speech/v2", + protos = [":speech_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", + "//google/rpc:status_go_proto", + ], +) + +go_gapic_library( + name = "speech_go_gapic", + srcs = [":speech_proto_with_info"], + grpc_service_config = "speech_grpc_service_config.json", + importpath = "cloud.google.com/go/speech/apiv2;speech", + metadata = True, + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + transport = "grpc+rest", + deps = [ + ":speech_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 = "speech_go_gapic_test", + srcs = [":speech_go_gapic_srcjar_test"], + embed = [":speech_go_gapic"], + importpath = "cloud.google.com/go/speech/apiv2", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-speech-v2-go", + deps = [ + ":speech_go_gapic", + ":speech_go_gapic_srcjar-metadata.srcjar", + ":speech_go_gapic_srcjar-test.srcjar", + ":speech_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "speech_py_gapic", + srcs = [":speech_proto"], + grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + deps = [ + ], +) + +py_test( + name = "speech_py_gapic_test", + srcs = [ + "speech_py_gapic_pytest.py", + "speech_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":speech_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "speech-v2-py", + deps = [ + ":speech_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 = "speech_php_proto", + deps = [":speech_proto"], +) + +php_grpc_library( + name = "speech_php_grpc", + srcs = [":speech_proto"], + deps = [":speech_php_proto"], +) + +php_gapic_library( + name = "speech_php_gapic", + srcs = [":speech_proto_with_info"], + grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + transport = "grpc+rest", + deps = [ + ":speech_php_grpc", + ":speech_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-speech-v2-php", + deps = [ + ":speech_php_gapic", + ":speech_php_grpc", + ":speech_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "speech_nodejs_gapic", + package_name = "@google-cloud/speech", + src = ":speech_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "speech_grpc_service_config.json", + package = "google.cloud.speech.v2", + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "speech-v2-nodejs", + deps = [ + ":speech_nodejs_gapic", + ":speech_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 = "speech_ruby_proto", + deps = [":speech_proto"], +) + +ruby_grpc_library( + name = "speech_ruby_grpc", + srcs = [":speech_proto"], + deps = [":speech_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "speech_ruby_gapic", + srcs = [":speech_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-api-id=speech.googleapis.com", + "ruby-cloud-api-shortname=speech", + "ruby-cloud-env-prefix=SPEECH", + "ruby-cloud-gem-name=google-cloud-speech-v2", + "ruby-cloud-product-url=https://cloud.google.com/speech-to-text", + ], + grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, + ruby_cloud_description = "Google Speech-to-Text enables developers to convert audio to text by applying powerful neural network models in an easy-to-use API. The API recognizes more than 120 languages and variants to support your global user base. You can enable voice command-and-control, transcribe audio from call centers, and more. It can process real-time streaming or prerecorded audio, using Google's machine learning technology.", + ruby_cloud_title = "Cloud Speech-to-Text V2", + service_yaml = "speech_v2.yaml", + deps = [ + ":speech_ruby_grpc", + ":speech_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-speech-v2-ruby", + deps = [ + ":speech_ruby_gapic", + ":speech_ruby_grpc", + ":speech_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 = "speech_csharp_proto", + deps = [":speech_proto"], +) + +csharp_grpc_library( + name = "speech_csharp_grpc", + srcs = [":speech_proto"], + deps = [":speech_csharp_proto"], +) + +csharp_gapic_library( + name = "speech_csharp_gapic", + srcs = [":speech_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "speech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "speech_v2.yaml", + deps = [ + ":speech_csharp_grpc", + ":speech_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-speech-v2-csharp", + deps = [ + ":speech_csharp_gapic", + ":speech_csharp_grpc", + ":speech_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "speech_cc_proto", + deps = [":speech_proto"], +) + +cc_grpc_library( + name = "speech_cc_grpc", + srcs = [":speech_proto"], + grpc_only = True, + deps = [":speech_cc_proto"], +) diff --git a/google/cloud/sql/v1/BUILD.bazel b/google/cloud/sql/v1/BUILD.bazel index d4a1bb618..2708008f3 100644 --- a/google/cloud/sql/v1/BUILD.bazel +++ b/google/cloud/sql/v1/BUILD.bazel @@ -117,6 +117,7 @@ java_grpc_library( # ":sql_java_proto", # ":sql_proto", # ], +# include_samples = True, # ) ############################################################################## @@ -186,6 +187,7 @@ py_gapic_library( name = "sql_py_gapic", srcs = [":sql_proto"], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -233,7 +235,9 @@ php_gapic_library( name = "sql_php_gapic", srcs = [":sql_proto_with_info"], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "sqladmin_v1.yaml", + transport = "grpc+rest", deps = [ ":sql_php_grpc", ":sql_php_proto", @@ -266,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "sqladmin_grpc_service_config.json", package = "google.cloud.sql.v1", + rest_numeric_enums = True, service_yaml = "sqladmin_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +313,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-sql-v1", ], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":sql_ruby_grpc", ":sql_ruby_proto", diff --git a/google/cloud/sql/v1beta4/BUILD.bazel b/google/cloud/sql/v1beta4/BUILD.bazel index 4f0074074..abe10bb00 100644 --- a/google/cloud/sql/v1beta4/BUILD.bazel +++ b/google/cloud/sql/v1beta4/BUILD.bazel @@ -108,6 +108,7 @@ proto_library_with_info( # ":sql_java_proto", # ":sql_proto", # ], +# include_samples = True, #) ############################################################################## @@ -176,6 +177,7 @@ py_gapic_library( name = "sql_py_gapic", srcs = [":sql_proto"], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -223,7 +225,9 @@ php_gapic_library( name = "sql_php_gapic", srcs = [":sql_proto_with_info"], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "sqladmin_v1beta4.yaml", + transport = "grpc+rest", deps = [ ":sql_php_grpc", ":sql_php_proto", @@ -256,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "sqladmin_grpc_service_config.json", package = "google.cloud.sql.v1beta4", + rest_numeric_enums = True, service_yaml = "sqladmin_v1beta4.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +301,7 @@ ruby_cloud_gapic_library( srcs = [":sql_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-sql-v1beta4"], grpc_service_config = "sqladmin_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":sql_ruby_grpc", ":sql_ruby_proto", diff --git a/google/cloud/storageinsights/v1/BUILD.bazel b/google/cloud/storageinsights/v1/BUILD.bazel new file mode 100644 index 000000000..182911f2e --- /dev/null +++ b/google/cloud/storageinsights/v1/BUILD.bazel @@ -0,0 +1,397 @@ +# 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 = "storageinsights_proto", + srcs = [ + "storageinsights.proto", + ], + deps = [ + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/api:field_behavior_proto", + "//google/api:resource_proto", + "//google/rpc:status_proto", + "//google/type:date_proto", + "//google/type:datetime_proto", + "@com_google_protobuf//:empty_proto", + "@com_google_protobuf//:field_mask_proto", + "@com_google_protobuf//:timestamp_proto", + ], +) + +proto_library_with_info( + name = "storageinsights_proto_with_info", + deps = [ + ":storageinsights_proto", + "//google/cloud:common_resources_proto", + "//google/cloud/location:location_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 = "storageinsights_java_proto", + deps = [":storageinsights_proto"], +) + +java_grpc_library( + name = "storageinsights_java_grpc", + srcs = [":storageinsights_proto"], + deps = [":storageinsights_java_proto"], +) + +java_gapic_library( + name = "storageinsights_java_gapic", + srcs = [":storageinsights_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "storageinsights_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + test_deps = [ + ":storageinsights_java_grpc", + "//google/cloud/location:location_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":storageinsights_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + ], +) + +java_gapic_test( + name = "storageinsights_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.storageinsights.v1.StorageInsightsClientHttpJsonTest", + "com.google.cloud.storageinsights.v1.StorageInsightsClientTest", + ], + runtime_deps = [":storageinsights_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-storageinsights-v1-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":storageinsights_java_gapic", + ":storageinsights_java_grpc", + ":storageinsights_java_proto", + ":storageinsights_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 = "storageinsights_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/storageinsights/v1", + protos = [":storageinsights_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/rpc:status_go_proto", + "//google/type:date_go_proto", + "//google/type:datetime_go_proto", + ], +) + +go_gapic_library( + name = "storageinsights_go_gapic", + srcs = [":storageinsights_proto_with_info"], + grpc_service_config = "storageinsights_grpc_service_config.json", + importpath = "cloud.google.com/go/storageinsights/apiv1;storageinsights", + metadata = True, + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + transport = "grpc+rest", + deps = [ + ":storageinsights_go_proto", + "//google/cloud/location:location_go_proto", + "//google/iam/v1:iam_go_proto", ## manual change + "//google/longrunning:longrunning_go_proto", ## manual change + ], +) + +go_test( + name = "storageinsights_go_gapic_test", + srcs = [":storageinsights_go_gapic_srcjar_test"], + embed = [":storageinsights_go_gapic"], + importpath = "cloud.google.com/go/storageinsights/apiv1", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-storageinsights-v1-go", + deps = [ + ":storageinsights_go_gapic", + ":storageinsights_go_gapic_srcjar-metadata.srcjar", + ":storageinsights_go_gapic_srcjar-test.srcjar", + ":storageinsights_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "storageinsights_py_gapic", + srcs = [":storageinsights_proto"], + grpc_service_config = "storageinsights_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + transport = "grpc+rest", + deps = [ + ], +) + +py_test( + name = "storageinsights_py_gapic_test", + srcs = [ + "storageinsights_py_gapic_pytest.py", + "storageinsights_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":storageinsights_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "storageinsights-v1-py", + deps = [ + ":storageinsights_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 = "storageinsights_php_proto", + deps = [":storageinsights_proto"], +) + +php_grpc_library( + name = "storageinsights_php_grpc", + srcs = [":storageinsights_proto"], + deps = [":storageinsights_php_proto"], +) + +php_gapic_library( + name = "storageinsights_php_gapic", + srcs = [":storageinsights_proto_with_info"], + grpc_service_config = "storageinsights_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + transport = "grpc+rest", + deps = [ + ":storageinsights_php_grpc", + ":storageinsights_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-storageinsights-v1-php", + deps = [ + ":storageinsights_php_gapic", + ":storageinsights_php_grpc", + ":storageinsights_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "storageinsights_nodejs_gapic", + package_name = "@google-cloud/storageinsights", + src = ":storageinsights_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "storageinsights_grpc_service_config.json", + package = "google.cloud.storageinsights.v1", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "storageinsights-v1-nodejs", + deps = [ + ":storageinsights_nodejs_gapic", + ":storageinsights_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 = "storageinsights_ruby_proto", + deps = [":storageinsights_proto"], +) + +ruby_grpc_library( + name = "storageinsights_ruby_grpc", + srcs = [":storageinsights_proto"], + deps = [":storageinsights_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "storageinsights_ruby_gapic", + srcs = [":storageinsights_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-storageinsights-v1", + ], + grpc_service_config = "storageinsights_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + deps = [ + ":storageinsights_ruby_grpc", + ":storageinsights_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-storageinsights-v1-ruby", + deps = [ + ":storageinsights_ruby_gapic", + ":storageinsights_ruby_grpc", + ":storageinsights_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 = "storageinsights_csharp_proto", + deps = [":storageinsights_proto"], +) + +csharp_grpc_library( + name = "storageinsights_csharp_grpc", + srcs = [":storageinsights_proto"], + deps = [":storageinsights_csharp_proto"], +) + +csharp_gapic_library( + name = "storageinsights_csharp_gapic", + srcs = [":storageinsights_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "storageinsights_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "storageinsights_v1.yaml", + deps = [ + ":storageinsights_csharp_grpc", + ":storageinsights_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-storageinsights-v1-csharp", + deps = [ + ":storageinsights_csharp_gapic", + ":storageinsights_csharp_grpc", + ":storageinsights_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "storageinsights_cc_proto", + deps = [":storageinsights_proto"], +) + +cc_grpc_library( + name = "storageinsights_cc_grpc", + srcs = [":storageinsights_proto"], + grpc_only = True, + deps = [":storageinsights_cc_proto"], +) diff --git a/google/cloud/storageinsights/v1/storageinsights.proto b/google/cloud/storageinsights/v1/storageinsights.proto new file mode 100644 index 000000000..21e92f891 --- /dev/null +++ b/google/cloud/storageinsights/v1/storageinsights.proto @@ -0,0 +1,477 @@ +// 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.storageinsights.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/empty.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; +import "google/rpc/status.proto"; +import "google/type/date.proto"; +import "google/type/datetime.proto"; + +option csharp_namespace = "Google.Cloud.StorageInsights.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/storageinsights/v1;storageinsights"; +option java_multiple_files = true; +option java_outer_classname = "V1Proto"; +option java_package = "com.google.cloud.storageinsights.v1"; +option php_namespace = "Google\\Cloud\\StorageInsights\\V1"; +option ruby_package = "Google::Cloud::StorageInsights::V1"; + +// Service describing handlers for resources +service StorageInsights { + option (google.api.default_host) = "storageinsights.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; + + // Lists ReportConfigs in a given project and location. + rpc ListReportConfigs(ListReportConfigsRequest) + returns (ListReportConfigsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/reportConfigs" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single ReportConfig. + rpc GetReportConfig(GetReportConfigRequest) returns (ReportConfig) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/reportConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new ReportConfig in a given project and location. + rpc CreateReportConfig(CreateReportConfigRequest) returns (ReportConfig) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/reportConfigs" + body: "report_config" + }; + option (google.api.method_signature) = "parent,report_config"; + } + + // Updates the parameters of a single ReportConfig. + rpc UpdateReportConfig(UpdateReportConfigRequest) returns (ReportConfig) { + option (google.api.http) = { + patch: "/v1/{report_config.name=projects/*/locations/*/reportConfigs/*}" + body: "report_config" + }; + option (google.api.method_signature) = "report_config,update_mask"; + } + + // Deletes a single ReportConfig. + rpc DeleteReportConfig(DeleteReportConfigRequest) + returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/reportConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists ReportDetails in a given project and location. + rpc ListReportDetails(ListReportDetailsRequest) + returns (ListReportDetailsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/reportConfigs/*}/reportDetails" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single ReportDetail. + rpc GetReportDetail(GetReportDetailRequest) returns (ReportDetail) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/reportConfigs/*/reportDetails/*}" + }; + option (google.api.method_signature) = "name"; + } +} + +// Message for requesting list of ReportConfigs +message ListReportConfigsRequest { + // Required. Parent value for ListReportConfigsRequest + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "storageinsights.googleapis.com/ReportConfig" + } + ]; + + // 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 ReportConfigs +message ListReportConfigsResponse { + // The list of ReportConfig + repeated ReportConfig report_configs = 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 ReportConfig +message GetReportConfigRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "storageinsights.googleapis.com/ReportConfig" + } + ]; +} + +// Message for creating a ReportConfig +message CreateReportConfigRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "storageinsights.googleapis.com/ReportConfig" + } + ]; + + // Required. The resource being created + ReportConfig report_config = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating a ReportConfig +message UpdateReportConfigRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // ReportConfig 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) = REQUIRED]; + + // Required. The resource being updated + ReportConfig report_config = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 deleting a ReportConfig +message DeleteReportConfigRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "storageinsights.googleapis.com/ReportConfig" + } + ]; + + // Optional. If set, all ReportDetails for this ReportConfig will be deleted. + bool force = 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. + // + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 describing ReportDetail object. ReportDetail represents metadata of +// generated reports for a ReportConfig. +// Next ID: 8 +message ReportDetail { + option (google.api.resource) = { + type: "storageinsights.googleapis.com/ReportDetail" + pattern: "projects/{project}/locations/{location}/reportConfigs/{report_config}/reportDetails/{report_detail}" + }; + + // Different metrics associated with the generated report. + message Metrics { + // Count of Cloud Storage objects which are part of the report. + int64 processed_records_count = 1; + } + + // Name of resource. It will be of form + // projects//locations//reportConfigs//reportDetails/. + string name = 1; + + // The snapshot time. + // All the report data is referenced at this point of time. + google.protobuf.Timestamp snapshot_time = 2; + + // Generated report's full path with name. It will be of the form + // destination_bucket//. + repeated string report_names = 3; + + // Status of the ReportDetail. + google.rpc.Status status = 4; + + // Labels as key value pairs + map labels = 5; + + // The date for which report is generated. The time part of target_datetime + // will be zero till we support multiple reports per day. + google.type.DateTime target_datetime = 6; + + // Metrics of the report. + Metrics report_metrics = 7; +} + +// Message for requesting list of ReportDetails +message ListReportDetailsRequest { + // Required. Parent value for ListReportDetailsRequest + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "storageinsights.googleapis.com/ReportDetail" + } + ]; + + // 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 ReportDetails +message ListReportDetailsResponse { + // The list of ReportDetail + repeated ReportDetail report_details = 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 ReportDetail +message GetReportDetailRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "storageinsights.googleapis.com/ReportDetail" + } + ]; +} + +// 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]; + + // 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 been cancelled successfully + // 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]; +} + +// ReportConfig Resource: +// +// Options to setup frequency of report generation. +message FrequencyOptions { + // This ENUM specifies possible frequencies of report generation. + enum Frequency { + // Unspecified. + FREQUENCY_UNSPECIFIED = 0; + + // Report will be generated daily. + DAILY = 1; + + // Report will be generated weekly. + WEEKLY = 2; + } + + // Frequency of report generation. + Frequency frequency = 1; + + // The date from which report generation should start. + // UTC time zone. + google.type.Date start_date = 2; + + // The date on which report generation should stop (Inclusive). + // UTC time zone. + google.type.Date end_date = 3; +} + +// Options to configure CSV formatted reports. +message CSVOptions { + // Record separator characters in CSV. + string record_separator = 1; + + // Delimiter characters in CSV. + string delimiter = 2; + + // If set, will include a header row in the CSV report. + bool header_required = 3; +} + +// Options to filter data on storage systems. +// Next ID: 2 +message CloudStorageFilters { + // Bucket for which the report will be generated. + string bucket = 1; +} + +// Options to store reports in storage systems. +// Next ID: 3 +message CloudStorageDestinationOptions { + // Destination bucket. + string bucket = 1; + + // Destination path is the path in the bucket where the report should be + // generated. + string destination_path = 2; +} + +// Report specification for exporting object metadata. +// Next ID: 4 +message ObjectMetadataReportOptions { + // Metadata fields to be included in the report. + repeated string metadata_fields = 1; + + // Filter options for storage systems. + oneof filter { + // Cloud Storage as the storage system. + CloudStorageFilters storage_filters = 2; + } + + // Options on destination for storage systems. + oneof destination_options { + // Cloud Storage as the storage system. + CloudStorageDestinationOptions storage_destination_options = 3; + } +} + +// Message describing ReportConfig object. ReportConfig is the configuration to +// generate reports. +// Next ID: 12 +message ReportConfig { + option (google.api.resource) = { + type: "storageinsights.googleapis.com/ReportConfig" + pattern: "projects/{project}/locations/{location}/reportConfigs/{report_config}" + }; + + // name of resource. It will be of form + // projects//locations//reportConfigs/. + string name = 1; + + // Output only. [Output only] Create time stamp + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update time stamp + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The frequency of report generation. + FrequencyOptions frequency_options = 5; + + // Format in which report will be published. + oneof report_format { + // Options for CSV formatted reports. + CSVOptions csv_options = 6; + } + + // Configuration options for report contents. + oneof report_kind { + // Report for exporting object metadata. + ObjectMetadataReportOptions object_metadata_report_options = 8; + } + + // Labels as key value pairs + map labels = 10; + + // User provided display name which can be empty and limited to 256 characters + // that is editable. + string display_name = 11; +} diff --git a/google/cloud/storageinsights/v1/storageinsights_grpc_service_config.json b/google/cloud/storageinsights/v1/storageinsights_grpc_service_config.json new file mode 100644 index 000000000..a46e6a3e5 --- /dev/null +++ b/google/cloud/storageinsights/v1/storageinsights_grpc_service_config.json @@ -0,0 +1,26 @@ +{ + "methodConfig": [{ + "name": [ + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "ListReportConfigs" }, + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "GetReportConfig" }, + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "ListReportDetails" }, + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "GetReportDetail" } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }, + { + "name": [ + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "CreateReportConfig" }, + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "DeleteReportConfig" }, + { "service": "google.cloud.storageinsights.v1.StorageinsightsService", "method": "UpdateReportConfig" } + ], + "timeout": "60s" + }] +} \ No newline at end of file diff --git a/google/cloud/storageinsights/v1/storageinsights_v1.yaml b/google/cloud/storageinsights/v1/storageinsights_v1.yaml new file mode 100644 index 000000000..873d7d4e5 --- /dev/null +++ b/google/cloud/storageinsights/v1/storageinsights_v1.yaml @@ -0,0 +1,66 @@ +type: google.api.Service +config_version: 3 +name: storageinsights.googleapis.com +title: Storage Insights API + +apis: +- name: google.cloud.location.Locations +- name: google.cloud.storageinsights.v1.StorageInsights +- name: google.longrunning.Operations + +types: +- name: google.cloud.storageinsights.v1.OperationMetadata + +documentation: + 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. + +backend: + rules: + - selector: google.cloud.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 + - selector: 'google.cloud.storageinsights.v1.StorageInsights.*' + 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.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.cloud.storageinsights.v1.StorageInsights.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.longrunning.Operations.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/talent/v4/BUILD.bazel b/google/cloud/talent/v4/BUILD.bazel index 70e201291..322b67722 100644 --- a/google/cloud/talent/v4/BUILD.bazel +++ b/google/cloud/talent/v4/BUILD.bazel @@ -89,6 +89,7 @@ java_gapic_library( name = "talent_java_gapic", srcs = [":talent_proto_with_info"], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":talent_java_grpc", ], @@ -160,13 +161,14 @@ go_gapic_library( srcs = [":talent_proto_with_info"], grpc_service_config = "talent_grpc_service_config.json", importpath = "cloud.google.com/go/talent/apiv4;talent", + rest_numeric_enums = True, service_yaml = "//google/cloud/talent:talent_v4.yaml", transport = "grpc+rest", deps = [ ":talent_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], @@ -203,6 +205,7 @@ py_gapic_library( name = "talent_py_gapic", srcs = [":talent_proto"], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -249,7 +252,9 @@ php_gapic_library( name = "talent_php_gapic", srcs = [":talent_proto_with_info"], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "jobs_v4.yaml", + transport = "grpc+rest", deps = [ ":talent_php_grpc", ":talent_php_proto", @@ -283,7 +288,9 @@ nodejs_gapic_library( grpc_service_config = "talent_grpc_service_config.json", main_service = "talent", package = "google.cloud.talent.v4", + rest_numeric_enums = True, service_yaml = "//google/cloud/talent:talent_v4.yaml", + transport = "grpc+rest", deps = [], ) @@ -328,6 +335,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=jobs", ], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Transform your job search and candidate matching capabilities with Cloud Talent Solution, designed to support enterprise talent acquisition technology and evolve with your growing needs. This AI solution includes features such as Job Search and Profile Search to provide candidates and employers with an enhanced talent acquisition experience.", ruby_cloud_title = "Cloud Talent Solution V4", deps = [ @@ -371,6 +379,7 @@ csharp_grpc_library( csharp_gapic_library( name = "talent_csharp_gapic", srcs = [":talent_proto_with_info"], + rest_numeric_enums = True, service_yaml = "//google/cloud/talent:talent_v4.yaml", deps = [ ":talent_csharp_grpc", diff --git a/google/cloud/talent/v4/company.proto b/google/cloud/talent/v4/company.proto index 9845aa968..075e7bcfb 100644 --- a/google/cloud/talent/v4/company.proto +++ b/google/cloud/talent/v4/company.proto @@ -96,13 +96,16 @@ message Company { // A URI that hosts the employer's company logo. string image_uri = 10; + // This field is deprecated. Please set the searchability of the custom + // attribute in the [Job.custom_attributes][google.cloud.talent.v4.Job.custom_attributes] going forward. + // // A list of keys of filterable [Job.custom_attributes][google.cloud.talent.v4.Job.custom_attributes], whose // corresponding `string_values` are used in keyword searches. Jobs with // `string_values` under these specified field keys are returned if any // of the values match the search keyword. Custom field values with // parenthesis, brackets and special symbols are not searchable as-is, // and those keyword queries must be surrounded by quotes. - repeated string keyword_searchable_job_custom_attributes = 11; + repeated string keyword_searchable_job_custom_attributes = 11 [deprecated = true]; // Output only. Derived details about the company. DerivedInfo derived_info = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/google/cloud/talent/v4/job_service.proto b/google/cloud/talent/v4/job_service.proto index b17751dcb..3e93164c9 100644 --- a/google/cloud/talent/v4/job_service.proto +++ b/google/cloud/talent/v4/job_service.proto @@ -556,8 +556,8 @@ message SearchJobsRequest { // * company_display_name: histogram by [Job.company_display_name][google.cloud.talent.v4.Job.company_display_name]. // * employment_type: histogram by [Job.employment_types][google.cloud.talent.v4.Job.employment_types], for example, // "FULL_TIME", "PART_TIME". - // * company_size: histogram by [CompanySize][google.cloud.talent.v4.CompanySize], for example, "SMALL", - // "MEDIUM", "BIG". + // * company_size (DEPRECATED): histogram by [CompanySize][google.cloud.talent.v4.CompanySize], for example, + // "SMALL", "MEDIUM", "BIG". // * publish_time_in_day: histogram by the [Job.posting_publish_time][google.cloud.talent.v4.Job.posting_publish_time] // in days. // Must specify list of numeric buckets in spec. diff --git a/google/cloud/talent/v4beta1/BUILD.bazel b/google/cloud/talent/v4beta1/BUILD.bazel index 196728a02..174843175 100644 --- a/google/cloud/talent/v4beta1/BUILD.bazel +++ b/google/cloud/talent/v4beta1/BUILD.bazel @@ -93,6 +93,7 @@ java_gapic_library( srcs = [":talent_proto_with_info"], gapic_yaml = None, grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", test_deps = [ ":talent_java_grpc", @@ -169,13 +170,14 @@ go_gapic_library( grpc_service_config = "talent_grpc_service_config.json", importpath = "cloud.google.com/go/talent/apiv4beta1;talent", metadata = True, + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", transport = "grpc+rest", deps = [ ":talent_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -212,6 +214,7 @@ py_gapic_library( name = "talent_py_gapic", srcs = [":talent_proto"], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", transport = "grpc", ) @@ -260,7 +263,9 @@ php_gapic_library( name = "talent_php_gapic", srcs = [":talent_proto_with_info"], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", + transport = "grpc+rest", deps = [ ":talent_php_grpc", ":talent_php_proto", @@ -294,7 +299,9 @@ nodejs_gapic_library( grpc_service_config = "talent_grpc_service_config.json", main_service = "talent", package = "google.cloud.talent.v4beta1", + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -339,6 +346,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/solutions/talent-solution", ], grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Transform your job search and candidate matching capabilities with Cloud Talent Solution, designed to support enterprise talent acquisition technology and evolve with your growing needs. This AI solution includes features such as Job Search and Profile Search to provide candidates and employers with an enhanced talent acquisition experience.", ruby_cloud_title = "Cloud Talent Solution V4beta1", deps = [ @@ -384,6 +392,7 @@ csharp_gapic_library( srcs = [":talent_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "talent_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "jobs_v4beta1.yaml", deps = [ ":talent_csharp_grpc", diff --git a/google/cloud/talent/v4beta1/company.proto b/google/cloud/talent/v4beta1/company.proto index e04f01334..7c1e2ea56 100644 --- a/google/cloud/talent/v4beta1/company.proto +++ b/google/cloud/talent/v4beta1/company.proto @@ -100,13 +100,16 @@ message Company { // A URI that hosts the employer's company logo. string image_uri = 10; + // This field is deprecated. Please set the searchability of the custom + // attribute in the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] going forward. + // // A list of keys of filterable [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes], whose // corresponding `string_values` are used in keyword searches. Jobs with // `string_values` under these specified field keys are returned if any // of the values match the search keyword. Custom field values with // parenthesis, brackets and special symbols are not searchable as-is, // and those keyword queries must be surrounded by quotes. - repeated string keyword_searchable_job_custom_attributes = 11; + repeated string keyword_searchable_job_custom_attributes = 11 [deprecated = true]; // Output only. Derived details about the company. DerivedInfo derived_info = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/google/cloud/talent/v4beta1/job_service.proto b/google/cloud/talent/v4beta1/job_service.proto index c8e420d60..87dc47d91 100644 --- a/google/cloud/talent/v4beta1/job_service.proto +++ b/google/cloud/talent/v4beta1/job_service.proto @@ -611,8 +611,8 @@ message SearchJobsRequest { // * company_display_name: histogram by [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name]. // * employment_type: histogram by [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types], for example, // "FULL_TIME", "PART_TIME". - // * company_size: histogram by [CompanySize][google.cloud.talent.v4beta1.CompanySize], for example, "SMALL", - // "MEDIUM", "BIG". + // * company_size (DEPRECATED): histogram by [CompanySize][google.cloud.talent.v4beta1.CompanySize], for example, + // "SMALL", "MEDIUM", "BIG". // * publish_time_in_day: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] // in days. // Must specify list of numeric buckets in spec. diff --git a/google/cloud/tasks/v2/BUILD.bazel b/google/cloud/tasks/v2/BUILD.bazel index 03144e77d..d558117ae 100644 --- a/google/cloud/tasks/v2/BUILD.bazel +++ b/google/cloud/tasks/v2/BUILD.bazel @@ -67,6 +67,7 @@ java_gapic_library( name = "tasks_java_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":tasks_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -128,6 +129,7 @@ go_gapic_library( srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", importpath = "cloud.google.com/go/cloudtasks/apiv2;tasks", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2.yaml", transport = "grpc+rest", deps = [ @@ -167,6 +169,7 @@ py_gapic_library( name = "tasks_py_gapic", srcs = [":tasks_proto"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -216,6 +219,8 @@ php_gapic_library( name = "tasks_php_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":tasks_php_grpc", ":tasks_php_proto", @@ -249,7 +254,9 @@ nodejs_gapic_library( grpc_service_config = "cloudtasks_grpc_service_config.json", main_service = "tasks", package = "google.cloud.tasks.v2", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -294,6 +301,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudtasks", ], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Tasks is a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. You can asynchronously perform work outside of a user request. Your tasks can be executed on App Engine or any arbitrary HTTP endpoint.", ruby_cloud_title = "Cloud Tasks V2", deps = [ @@ -339,6 +347,7 @@ csharp_gapic_library( srcs = [":tasks_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2.yaml", deps = [ ":tasks_csharp_grpc", diff --git a/google/cloud/tasks/v2beta2/BUILD.bazel b/google/cloud/tasks/v2beta2/BUILD.bazel index af7558dfb..ceab869bd 100644 --- a/google/cloud/tasks/v2beta2/BUILD.bazel +++ b/google/cloud/tasks/v2beta2/BUILD.bazel @@ -67,6 +67,7 @@ java_gapic_library( name = "tasks_java_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":tasks_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -128,6 +129,7 @@ go_gapic_library( srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", importpath = "cloud.google.com/go/cloudtasks/apiv2beta2;tasks", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta2.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( name = "tasks_py_gapic", srcs = [":tasks_proto"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -217,6 +220,8 @@ php_gapic_library( name = "tasks_php_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":tasks_php_grpc", ":tasks_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( grpc_service_config = "cloudtasks_grpc_service_config.json", main_service = "tasks", package = "google.cloud.tasks.v2beta2", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta2.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudtasks", ], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Tasks is a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. You can asynchronously perform work outside of a user request. Your tasks can be executed on App Engine or any arbitrary HTTP endpoint.", ruby_cloud_title = "Cloud Tasks V2beta2", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":tasks_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta2.yaml", deps = [ ":tasks_csharp_grpc", diff --git a/google/cloud/tasks/v2beta3/BUILD.bazel b/google/cloud/tasks/v2beta3/BUILD.bazel index 2a849edd0..b08e6135a 100644 --- a/google/cloud/tasks/v2beta3/BUILD.bazel +++ b/google/cloud/tasks/v2beta3/BUILD.bazel @@ -67,6 +67,7 @@ java_gapic_library( name = "tasks_java_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":tasks_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -128,6 +129,7 @@ go_gapic_library( srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", importpath = "cloud.google.com/go/cloudtasks/apiv2beta3;tasks", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta3.yaml", transport = "grpc+rest", deps = [ @@ -168,6 +170,7 @@ py_gapic_library( name = "tasks_py_gapic", srcs = [":tasks_proto"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -217,6 +220,8 @@ php_gapic_library( name = "tasks_php_gapic", srcs = [":tasks_proto_with_info"], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":tasks_php_grpc", ":tasks_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( grpc_service_config = "cloudtasks_grpc_service_config.json", main_service = "tasks", package = "google.cloud.tasks.v2beta3", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta3.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudtasks", ], grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Tasks is a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. You can asynchronously perform work outside of a user request. Your tasks can be executed on App Engine or any arbitrary HTTP endpoint.", ruby_cloud_title = "Cloud Tasks V2beta3", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":tasks_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudtasks_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudtasks_v2beta3.yaml", deps = [ ":tasks_csharp_grpc", diff --git a/google/cloud/texttospeech/BUILD.bazel b/google/cloud/texttospeech/BUILD.bazel index 96eb699fa..10f8a078a 100644 --- a/google/cloud/texttospeech/BUILD.bazel +++ b/google/cloud/texttospeech/BUILD.bazel @@ -22,7 +22,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-text_to_speech", "ruby-cloud-env-prefix=TEXTTOSPEECH", - "ruby-cloud-wrapper-of=v1:0.0;v1beta1:0.0", + "ruby-cloud-wrapper-of=v1:0.8;v1beta1:0.9", "ruby-cloud-product-url=https://cloud.google.com/text-to-speech", "ruby-cloud-api-id=texttospeech.googleapis.com", "ruby-cloud-api-shortname=texttospeech", diff --git a/google/cloud/texttospeech/v1/BUILD.bazel b/google/cloud/texttospeech/v1/BUILD.bazel index 65a57b4dd..738f44edd 100644 --- a/google/cloud/texttospeech/v1/BUILD.bazel +++ b/google/cloud/texttospeech/v1/BUILD.bazel @@ -22,12 +22,15 @@ proto_library( name = "texttospeech_proto", srcs = [ "cloud_tts.proto", + "cloud_tts_lrs.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//:timestamp_proto", ], ) @@ -67,6 +70,7 @@ java_gapic_library( srcs = [":texttospeech_proto_with_info"], gapic_yaml = None, grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1.yaml", test_deps = [ ":texttospeech_java_grpc", @@ -83,6 +87,8 @@ java_gapic_test( test_classes = [ "com.google.cloud.texttospeech.v1.TextToSpeechClientHttpJsonTest", "com.google.cloud.texttospeech.v1.TextToSpeechClientTest", + "com.google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesizeClientHttpJsonTest", + "com.google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesizeClientTest", ], runtime_deps = [":texttospeech_java_gapic_test"], ) @@ -118,6 +124,7 @@ go_proto_library( protos = [":texttospeech_proto"], deps = [ "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", ], ) @@ -127,10 +134,14 @@ go_gapic_library( grpc_service_config = "texttospeech_grpc_service_config.json", importpath = "cloud.google.com/go/texttospeech/apiv1;texttospeech", metadata = True, + rest_numeric_enums = True, service_yaml = "texttospeech_v1.yaml", transport = "grpc+rest", deps = [ ":texttospeech_go_proto", + "//google/longrunning:longrunning_go_proto", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -166,7 +177,11 @@ py_gapic_library( name = "texttospeech_py_gapic", srcs = [":texttospeech_proto"], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "texttospeech_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -213,7 +228,9 @@ php_gapic_library( name = "texttospeech_php_gapic", srcs = [":texttospeech_proto_with_info"], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1.yaml", + transport = "grpc+rest", deps = [ ":texttospeech_php_grpc", ":texttospeech_php_proto", @@ -246,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "texttospeech_grpc_service_config.json", package = "google.cloud.texttospeech.v1", + rest_numeric_enums = True, service_yaml = "texttospeech_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -291,8 +310,10 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/text-to-speech", ], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Text-to-Speech converts text or Speech Synthesis Markup Language (SSML) input into audio data of natural human speech.", ruby_cloud_title = "Cloud Text-to-Speech V1", + service_yaml = "texttospeech_v1.yaml", deps = [ ":texttospeech_ruby_grpc", ":texttospeech_ruby_proto", @@ -336,6 +357,7 @@ csharp_gapic_library( srcs = [":texttospeech_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1.yaml", deps = [ ":texttospeech_csharp_grpc", diff --git a/google/cloud/texttospeech/v1/cloud_tts.proto b/google/cloud/texttospeech/v1/cloud_tts.proto index 4c4ae7bd7..b50d3698f 100644 --- a/google/cloud/texttospeech/v1/cloud_tts.proto +++ b/google/cloud/texttospeech/v1/cloud_tts.proto @@ -37,7 +37,8 @@ option (google.api.resource_definition) = { // Service that implements Google Cloud Text-to-Speech API. service TextToSpeech { option (google.api.default_host) = "texttospeech.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"; // Returns a list of Voice supported for synthesis. rpc ListVoices(ListVoicesRequest) returns (ListVoicesResponse) { @@ -49,7 +50,8 @@ service TextToSpeech { // Synthesizes speech synchronously: receive results after all text input // has been processed. - rpc SynthesizeSpeech(SynthesizeSpeechRequest) returns (SynthesizeSpeechResponse) { + rpc SynthesizeSpeech(SynthesizeSpeechRequest) + returns (SynthesizeSpeechResponse) { option (google.api.http) = { post: "/v1/text:synthesize" body: "*" @@ -81,7 +83,8 @@ enum SsmlVoiceGender { // Configuration to set up audio encoder. The encoding determines the output // audio format that we'd like. enum AudioEncoding { - // Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][]. + // Not specified. Will return result + // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. AUDIO_ENCODING_UNSPECIFIED = 0; // Uncompressed 16-bit signed little-endian samples (Linear PCM). @@ -156,8 +159,8 @@ message SynthesizeSpeechRequest { // Contains text input to be synthesized. Either `text` or `ssml` must be // supplied. Supplying both or neither returns -// [google.rpc.Code.INVALID_ARGUMENT][]. The input size is limited to 5000 -// characters. +// [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. The +// input size is limited to 5000 bytes. message SynthesisInput { // The input source, which is either plain text or SSML. oneof input_source { @@ -166,7 +169,8 @@ message SynthesisInput { // The SSML document to be synthesized. The SSML document must be valid // and well-formed. Otherwise the RPC will fail and return - // [google.rpc.Code.INVALID_ARGUMENT][]. For more information, see + // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For + // more information, see // [SSML](https://cloud.google.com/text-to-speech/docs/ssml). string ssml = 2; } @@ -174,9 +178,9 @@ message SynthesisInput { // Description of which voice to use for a synthesis request. message VoiceSelectionParams { - // Required. The language (and potentially also the region) of the voice expressed as a - // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. - // "en-US". This should not include a script tag (e.g. use + // Required. The language (and potentially also the region) of the voice + // expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + // language tag, e.g. "en-US". This should not include a script tag (e.g. use // "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred // from the input provided in the SynthesisInput. The TTS service // will use this parameter to help choose an appropriate voice. Note that @@ -245,7 +249,7 @@ message AudioConfig { // converting to the desired sample rate (which might result in worse audio // quality), unless the specified sample rate is not supported for the // encoding chosen, in which case it will fail the request and return - // [google.rpc.Code.INVALID_ARGUMENT][]. + // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. int32 sample_rate_hertz = 5 [(google.api.field_behavior) = OPTIONAL]; // Optional. Input only. An identifier which selects 'audio effects' profiles @@ -282,9 +286,7 @@ message CustomVoiceParams { // Required. The name of the AutoML model that synthesizes the custom voice. 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. The usage of the synthesized audio to be reported. diff --git a/google/cloud/texttospeech/v1/cloud_tts_lrs.proto b/google/cloud/texttospeech/v1/cloud_tts_lrs.proto new file mode 100644 index 000000000..d90f58716 --- /dev/null +++ b/google/cloud/texttospeech/v1/cloud_tts_lrs.proto @@ -0,0 +1,90 @@ +// 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.texttospeech.v1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/cloud/texttospeech/v1/cloud_tts.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/timestamp.proto"; + +option cc_enable_arenas = true; +option csharp_namespace = "Google.Cloud.TextToSpeech.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/texttospeech/v1;texttospeech"; +option java_multiple_files = true; +option java_outer_classname = "TextToSpeechLongAudioSynthesisProto"; +option java_package = "com.google.cloud.texttospeech.v1"; +option php_namespace = "Google\\Cloud\\TextToSpeech\\V1"; +option ruby_package = "Google::Cloud::TextToSpeech::V1"; + +// Service that implements Google Cloud Text-to-Speech API. +service TextToSpeechLongAudioSynthesize { + option (google.api.default_host) = "texttospeech.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; + + // Synthesizes long form text asynchronously. + rpc SynthesizeLongAudio(SynthesizeLongAudioRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/voices/*}:SynthesizeLongAudio" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "SynthesizeLongAudioResponse" + metadata_type: "SynthesizeLongAudioMetadata" + }; + } +} + +// The top-level message sent by the client for the +// `SynthesizeLongAudio` method. +message SynthesizeLongAudioRequest { + // The resource states of the request in the form of + // `projects/*/locations/*/voices/*`. + string parent = 1; + + // Required. The Synthesizer requires either plain text or SSML as input. + SynthesisInput input = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The configuration of the synthesized audio. + AudioConfig audio_config = 3 [(google.api.field_behavior) = REQUIRED]; + + // Specifies a Cloud Storage URI for the synthesis results. Must be + // specified in the format: `gs://bucket_name/object_name`, and the bucket + // must already exist. + string output_gcs_uri = 4; + + // The desired voice of the synthesized audio. + VoiceSelectionParams voice = 5; +} + +// The message returned to the client by the `SynthesizeLongAudio` method. +message SynthesizeLongAudioResponse {} + +// Metadata for response returned by the `SynthesizeLongAudio` method. +message SynthesizeLongAudioMetadata { + // Time when the request was received. + google.protobuf.Timestamp start_time = 1; + + // Time of the most recent processing update. + google.protobuf.Timestamp last_update_time = 2; + + // The progress of the most recent processing update in percentage, ie. 70.0%. + double progress_percentage = 3; +} diff --git a/google/cloud/texttospeech/v1/texttospeech_grpc_service_config.json b/google/cloud/texttospeech/v1/texttospeech_grpc_service_config.json index 948d18d86..b2ef04e2f 100755 --- a/google/cloud/texttospeech/v1/texttospeech_grpc_service_config.json +++ b/google/cloud/texttospeech/v1/texttospeech_grpc_service_config.json @@ -12,6 +12,15 @@ "DEADLINE_EXCEEDED" ] } + }, + { + "name": [ + { + "service": "google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize", + "method": "SynthesizeLongAudio" + } + ], + "timeout": "5000s" } ] } diff --git a/google/cloud/texttospeech/v1/texttospeech_v1.yaml b/google/cloud/texttospeech/v1/texttospeech_v1.yaml index 99f5f17d3..f0503fdab 100644 --- a/google/cloud/texttospeech/v1/texttospeech_v1.yaml +++ b/google/cloud/texttospeech/v1/texttospeech_v1.yaml @@ -5,6 +5,8 @@ title: Cloud Text-to-Speech API apis: - name: google.cloud.texttospeech.v1.TextToSpeech +- name: google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize +- name: google.longrunning.Operations documentation: summary: |- @@ -25,3 +27,11 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.texttospeech.v1.TextToSpeechLongAudioSynthesize.SynthesizeLongAudio + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.longrunning.Operations.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/texttospeech/v1beta1/BUILD.bazel b/google/cloud/texttospeech/v1beta1/BUILD.bazel index 852f99baa..5bb02bcb1 100644 --- a/google/cloud/texttospeech/v1beta1/BUILD.bazel +++ b/google/cloud/texttospeech/v1beta1/BUILD.bazel @@ -22,12 +22,15 @@ proto_library( name = "texttospeech_proto", srcs = [ "cloud_tts.proto", + "cloud_tts_lrs.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//:timestamp_proto", ], ) @@ -67,6 +70,7 @@ java_gapic_library( srcs = [":texttospeech_proto_with_info"], gapic_yaml = None, grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1beta1.yaml", test_deps = [ ":texttospeech_java_grpc", @@ -83,6 +87,8 @@ java_gapic_test( test_classes = [ "com.google.cloud.texttospeech.v1beta1.TextToSpeechClientHttpJsonTest", "com.google.cloud.texttospeech.v1beta1.TextToSpeechClientTest", + "com.google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesizeClientHttpJsonTest", + "com.google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesizeClientTest", ], runtime_deps = [":texttospeech_java_gapic_test"], ) @@ -118,6 +124,7 @@ go_proto_library( protos = [":texttospeech_proto"], deps = [ "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", ], ) @@ -127,10 +134,14 @@ go_gapic_library( grpc_service_config = "texttospeech_grpc_service_config.json", importpath = "cloud.google.com/go/texttospeech/apiv1beta1;texttospeech", metadata = True, + rest_numeric_enums = True, service_yaml = "texttospeech_v1beta1.yaml", transport = "grpc+rest", deps = [ ":texttospeech_go_proto", + "//google/longrunning:longrunning_go_proto", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -166,7 +177,11 @@ py_gapic_library( name = "texttospeech_py_gapic", srcs = [":texttospeech_proto"], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "texttospeech_v1beta1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -213,7 +228,9 @@ php_gapic_library( name = "texttospeech_php_gapic", srcs = [":texttospeech_proto_with_info"], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":texttospeech_php_grpc", ":texttospeech_php_proto", @@ -246,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "texttospeech_grpc_service_config.json", package = "google.cloud.texttospeech.v1beta1", + rest_numeric_enums = True, service_yaml = "texttospeech_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -291,8 +310,10 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/text-to-speech", ], grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Text-to-Speech converts text or Speech Synthesis Markup Language (SSML) input into audio data of natural human speech.", ruby_cloud_title = "Cloud Text-to-Speech V1beta1", + service_yaml = "texttospeech_v1beta1.yaml", deps = [ ":texttospeech_ruby_grpc", ":texttospeech_ruby_proto", @@ -336,6 +357,7 @@ csharp_gapic_library( srcs = [":texttospeech_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "texttospeech_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "texttospeech_v1beta1.yaml", deps = [ ":texttospeech_csharp_grpc", @@ -356,4 +378,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "texttospeech_cc_proto", + deps = [":texttospeech_proto"], +) + +cc_grpc_library( + name = "texttospeech_cc_grpc", + srcs = [":texttospeech_proto"], + grpc_only = True, + deps = [":texttospeech_cc_proto"], +) diff --git a/google/cloud/texttospeech/v1beta1/cloud_tts.proto b/google/cloud/texttospeech/v1beta1/cloud_tts.proto index 4fdd68b20..63e5361dc 100644 --- a/google/cloud/texttospeech/v1beta1/cloud_tts.proto +++ b/google/cloud/texttospeech/v1beta1/cloud_tts.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. @@ -58,19 +58,6 @@ service TextToSpeech { } } -// The top-level message sent by the client for the `ListVoices` method. -message ListVoicesRequest { - // Optional. Recommended. - // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - // If not specified, the API will return all supported voices. - // If specified, the ListVoices call will only return voices that can be used - // to synthesize this language_code. For example, if you specify `"en-NZ"`, - // all `"en-NZ"` voices will be returned. If you specify `"no"`, both - // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be - // returned. - string language_code = 1 [(google.api.field_behavior) = OPTIONAL]; -} - // Gender of the voice as described in // [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice). enum SsmlVoiceGender { @@ -94,7 +81,7 @@ enum SsmlVoiceGender { // Configuration to set up audio encoder. The encoding determines the output // audio format that we'd like. enum AudioEncoding { - // Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][]. + // Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. AUDIO_ENCODING_UNSPECIFIED = 0; // Uncompressed 16-bit signed little-endian samples (Linear PCM). @@ -122,6 +109,19 @@ enum AudioEncoding { ALAW = 6; } +// The top-level message sent by the client for the `ListVoices` method. +message ListVoicesRequest { + // Optional. Recommended. + // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + // If not specified, the API will return all supported voices. + // If specified, the ListVoices call will only return voices that can be used + // to synthesize this language_code. For example, if you specify `"en-NZ"`, + // all `"en-NZ"` voices will be returned. If you specify `"no"`, both + // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be + // returned. + string language_code = 1 [(google.api.field_behavior) = OPTIONAL]; +} + // The message returned to the client by the `ListVoices` method. message ListVoicesResponse { // The list of voices. @@ -171,8 +171,8 @@ message SynthesizeSpeechRequest { // Contains text input to be synthesized. Either `text` or `ssml` must be // supplied. Supplying both or neither returns -// [google.rpc.Code.INVALID_ARGUMENT][]. The input size is limited to 5000 -// characters. +// [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. The input size is limited to 5000 +// bytes. message SynthesisInput { // The input source, which is either plain text or SSML. oneof input_source { @@ -181,7 +181,7 @@ message SynthesisInput { // The SSML document to be synthesized. The SSML document must be valid // and well-formed. Otherwise the RPC will fail and return - // [google.rpc.Code.INVALID_ARGUMENT][]. For more information, see + // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For more information, see // [SSML](https://cloud.google.com/text-to-speech/docs/ssml). string ssml = 2; } @@ -260,7 +260,7 @@ message AudioConfig { // converting to the desired sample rate (which might result in worse audio // quality), unless the specified sample rate is not supported for the // encoding chosen, in which case it will fail the request and return - // [google.rpc.Code.INVALID_ARGUMENT][]. + // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. int32 sample_rate_hertz = 5 [(google.api.field_behavior) = OPTIONAL]; // Optional. Input only. An identifier which selects 'audio effects' profiles diff --git a/google/cloud/texttospeech/v1beta1/cloud_tts_lrs.proto b/google/cloud/texttospeech/v1beta1/cloud_tts_lrs.proto new file mode 100644 index 000000000..17bc9479f --- /dev/null +++ b/google/cloud/texttospeech/v1beta1/cloud_tts_lrs.proto @@ -0,0 +1,90 @@ +// 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.texttospeech.v1beta1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/cloud/texttospeech/v1beta1/cloud_tts.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/timestamp.proto"; + +option cc_enable_arenas = true; +option csharp_namespace = "Google.Cloud.TextToSpeech.V1Beta1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/texttospeech/v1beta1;texttospeech"; +option java_multiple_files = true; +option java_outer_classname = "TextToSpeechLongAudioSynthesisProto"; +option java_package = "com.google.cloud.texttospeech.v1beta1"; +option php_namespace = "Google\\Cloud\\TextToSpeech\\V1beta1"; +option ruby_package = "Google::Cloud::TextToSpeech::V1beta1"; + +// Service that implements Google Cloud Text-to-Speech API. +service TextToSpeechLongAudioSynthesize { + option (google.api.default_host) = "texttospeech.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; + + // Synthesizes long form text asynchronously. + rpc SynthesizeLongAudio(SynthesizeLongAudioRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1beta1/{parent=projects/*/locations/*/voices/*}:SynthesizeLongAudio" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "SynthesizeLongAudioResponse" + metadata_type: "SynthesizeLongAudioMetadata" + }; + } +} + +// The top-level message sent by the client for the +// `SynthesizeLongAudio` method. +message SynthesizeLongAudioRequest { + // The resource states of the request in the form of + // `projects/*/locations/*/voices/*`. + string parent = 1; + + // Required. The Synthesizer requires either plain text or SSML as input. + SynthesisInput input = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The configuration of the synthesized audio. + AudioConfig audio_config = 3 [(google.api.field_behavior) = REQUIRED]; + + // Specifies a Cloud Storage URI for the synthesis results. Must be + // specified in the format: `gs://bucket_name/object_name`, and the bucket + // must already exist. + string output_gcs_uri = 4; + + // The desired voice of the synthesized audio. + VoiceSelectionParams voice = 5; +} + +// The message returned to the client by the `SynthesizeLongAudio` method. +message SynthesizeLongAudioResponse {} + +// Metadata for response returned by the `SynthesizeLongAudio` method. +message SynthesizeLongAudioMetadata { + // Time when the request was received. + google.protobuf.Timestamp start_time = 1; + + // Time of the most recent processing update. + google.protobuf.Timestamp last_update_time = 2; + + // The progress of the most recent processing update in percentage, ie. 70.0%. + double progress_percentage = 3; +} diff --git a/google/cloud/texttospeech/v1beta1/texttospeech_grpc_service_config.json b/google/cloud/texttospeech/v1beta1/texttospeech_grpc_service_config.json index 5ac4d5dcf..c93f4c8a1 100755 --- a/google/cloud/texttospeech/v1beta1/texttospeech_grpc_service_config.json +++ b/google/cloud/texttospeech/v1beta1/texttospeech_grpc_service_config.json @@ -12,6 +12,15 @@ "DEADLINE_EXCEEDED" ] } + }, + { + "name": [ + { + "service": "google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize", + "method": "SynthesizeLongAudio" + } + ], + "timeout": "5000s" } ] } diff --git a/google/cloud/texttospeech/v1beta1/texttospeech_v1beta1.yaml b/google/cloud/texttospeech/v1beta1/texttospeech_v1beta1.yaml index 8e5391843..915d35bd3 100644 --- a/google/cloud/texttospeech/v1beta1/texttospeech_v1beta1.yaml +++ b/google/cloud/texttospeech/v1beta1/texttospeech_v1beta1.yaml @@ -5,6 +5,8 @@ title: Cloud Text-to-Speech API apis: - name: google.cloud.texttospeech.v1beta1.TextToSpeech +- name: google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize +- name: google.longrunning.Operations documentation: summary: |- @@ -25,3 +27,11 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + - selector: google.cloud.texttospeech.v1beta1.TextToSpeechLongAudioSynthesize.SynthesizeLongAudio + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.longrunning.Operations.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/timeseriesinsights/v1/BUILD.bazel b/google/cloud/timeseriesinsights/v1/BUILD.bazel index 1f33d1635..dc60a5bd9 100644 --- a/google/cloud/timeseriesinsights/v1/BUILD.bazel +++ b/google/cloud/timeseriesinsights/v1/BUILD.bazel @@ -72,6 +72,7 @@ java_gapic_library( srcs = [":timeseriesinsights_proto_with_info"], gapic_yaml = None, grpc_service_config = "timeseries_insights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", test_deps = [ ":timeseriesinsights_java_grpc", @@ -135,6 +136,7 @@ go_gapic_library( grpc_service_config = "timeseries_insights_grpc_service_config.json", importpath = "cloud.google.com/go/timeseriesinsights/apiv1;timeseriesinsights", metadata = True, + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", transport = "grpc+rest", deps = [ @@ -176,6 +178,7 @@ py_gapic_library( name = "timeseriesinsights_py_gapic", srcs = [":timeseriesinsights_proto"], grpc_service_config = "timeseries_insights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", transport = "grpc", deps = [ @@ -226,7 +229,9 @@ php_gapic_library( name = "timeseriesinsights_php_gapic", srcs = [":timeseriesinsights_proto_with_info"], grpc_service_config = "timeseries_insights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", + transport = "grpc+rest", deps = [ ":timeseriesinsights_php_grpc", ":timeseriesinsights_php_proto", @@ -259,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "timeseries_insights_grpc_service_config.json", package = "google.cloud.timeseriesinsights.v1", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -296,10 +303,9 @@ ruby_grpc_library( ruby_cloud_gapic_library( name = "timeseriesinsights_ruby_gapic", srcs = [":timeseriesinsights_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-timeseriesinsights-v1", - ], + extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-timeseriesinsights-v1"], grpc_service_config = "timeseries_insights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", deps = [ ":timeseriesinsights_ruby_grpc", @@ -344,6 +350,7 @@ csharp_gapic_library( srcs = [":timeseriesinsights_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "timeseries_insights_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "timeseriesinsights_v1.yaml", deps = [ ":timeseriesinsights_csharp_grpc", diff --git a/google/cloud/timeseriesinsights/v1/timeseries_insights.proto b/google/cloud/timeseriesinsights/v1/timeseries_insights.proto index 4c985d1c7..922bcfd72 100644 --- a/google/cloud/timeseriesinsights/v1/timeseries_insights.proto +++ b/google/cloud/timeseriesinsights/v1/timeseries_insights.proto @@ -33,30 +33,29 @@ option java_package = "com.google.cloud.timeseriesinsights.v1"; service TimeseriesInsightsController { option (google.api.default_host) = "timeseriesinsights.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"; - // Lists [DataSets][google.cloud.timeseriesinsights.v1.DataSet] under the - // project. + // Lists [DataSets][google.cloud.timeseriesinsights.v1.DataSet] under the project. // // The order of the results is unspecified but deterministic. Newly created - // [DataSets][google.cloud.timeseriesinsights.v1.DataSet] will not necessarily - // be added to the end of this list. + // [DataSets][google.cloud.timeseriesinsights.v1.DataSet] will not necessarily be added to the end + // of this list. rpc ListDataSets(ListDataSetsRequest) returns (ListDataSetsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/datasets" - additional_bindings { get: "/v1/{parent=projects/*}/datasets" } + additional_bindings { + get: "/v1/{parent=projects/*}/datasets" + } }; option (google.api.method_signature) = "parent"; } - // Create a [DataSet][google.cloud.timeseriesinsights.v1.DataSet] from data - // stored on Cloud Storage. + // Create a [DataSet][google.cloud.timeseriesinsights.v1.DataSet] from data stored on Cloud + // Storage. // // The data must stay immutable while we process the - // [DataSet][google.cloud.timeseriesinsights.v1.DataSet] creation; otherwise, - // undefined outcomes might result. For more information, see - // [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. + // [DataSet][google.cloud.timeseriesinsights.v1.DataSet] creation; otherwise, undefined outcomes + // might result. For more information, see [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. rpc CreateDataSet(CreateDataSetRequest) returns (DataSet) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/datasets" @@ -69,21 +68,21 @@ service TimeseriesInsightsController { option (google.api.method_signature) = "parent,dataset"; } - // Delete a [DataSet][google.cloud.timeseriesinsights.v1.DataSet] from the - // system. + // Delete a [DataSet][google.cloud.timeseriesinsights.v1.DataSet] from the system. // - // **NOTE**: If the [DataSet][google.cloud.timeseriesinsights.v1.DataSet] is - // still being processed, it will be aborted and deleted. + // **NOTE**: If the [DataSet][google.cloud.timeseriesinsights.v1.DataSet] is still being + // processed, it will be aborted and deleted. rpc DeleteDataSet(DeleteDataSetRequest) returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/datasets/*}" - additional_bindings { delete: "/v1/{name=projects/*/datasets/*}" } + additional_bindings { + delete: "/v1/{name=projects/*/datasets/*}" + } }; option (google.api.method_signature) = "name"; } - // Append events to a `LOADED` - // [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. + // Append events to a `LOADED` [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. rpc AppendEvents(AppendEventsRequest) returns (AppendEventsResponse) { option (google.api.http) = { post: "/v1/{dataset=projects/*/locations/*/datasets/*}:appendEvents" @@ -109,8 +108,7 @@ service TimeseriesInsightsController { }; } - // Evaluate an explicit slice from a loaded - // [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. + // Evaluate an explicit slice from a loaded [DataSet][google.cloud.timeseriesinsights.v1.DataSet]. rpc EvaluateSlice(EvaluateSliceRequest) returns (EvaluatedSlice) { option (google.api.http) = { post: "/v1/{dataset=projects/*/locations/*/datasets/*}:evaluateSlice" @@ -121,6 +119,18 @@ service TimeseriesInsightsController { } }; } + + // Evaluate an explicit timeseries. + rpc EvaluateTimeseries(EvaluateTimeseriesRequest) returns (EvaluatedSlice) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/datasets:evaluateTimeseries" + body: "*" + additional_bindings { + post: "/v1/{parent=projects/*}/datasets:evaluateTimeseries" + body: "*" + } + }; + } } // Mapping of BigQuery columns to timestamp, group_id and dimensions. @@ -143,7 +153,7 @@ message BigqueryMapping { repeated string dimension_column = 3; } -// A data source consists of multiple [Event] stored on +// A data source consists of multiple [Event][google.cloud.timeseriesinsights.v1.Event] objects stored on // Cloud Storage. Each Event should be in JSON format, with one Event // per line, also known as JSON Lines format. message DataSource { @@ -199,9 +209,7 @@ message DataSet { // requests. This must be unique within a project. string name = 1; - // [Data dimension - // names][google.cloud.timeseriesinsights.v1.EventDimension.name] allowed for - // this DataSet. + // [Data dimension names][google.cloud.timeseriesinsights.v1.EventDimension.name] allowed for this `DataSet`. // // If left empty, all dimension names are included. This field works as a // filter to avoid regenerating the data. @@ -216,8 +224,9 @@ message DataSet { // Dataset processing status. google.rpc.Status status = 5; - // Periodically we discard dataset [Event] that have timestamps older than - // 'ttl'. Omitting this field or a zero value means no events are discarded. + // Periodically we discard dataset [Event][google.cloud.timeseriesinsights.v1.Event] objects that have + // timestamps older than 'ttl'. Omitting this field or a zero value means no + // events are discarded. google.protobuf.Duration ttl = 6; } @@ -225,9 +234,9 @@ message DataSet { message EventDimension { // Dimension name. // - // **NOTE**: EventDimension names must be composed of alphanumeric characters - // only, and are case insensitive. Unicode characters are *not* supported. The - // underscore '_' is also allowed. + // **NOTE**: `EventDimension` names must be composed of alphanumeric + // characters only, and are case insensitive. Unicode characters are *not* + // supported. The underscore '_' is also allowed. string name = 1; // Dimension value. @@ -291,22 +300,20 @@ message Event { message AppendEventsRequest { // Events to be appended. // - // **NOTE**: + // Note: // - // 0. The [DataSet] must be shown in a `LOADED` state - // in the results of [list method][ListDataSet]; otherwise, all events from + // 0. The [DataSet][google.cloud.timeseriesinsights.v1.DataSet] must be shown in a `LOADED` state + // in the results of `list` method; otherwise, all events from // the append request will be dropped, and a `NOT_FOUND` status will be // returned. // 0. All events in a single request must have the same - // [groupId][google.cloud.timeseriesinsights.v1.Event.group_id] if set; - // otherwise, an `INVALID_ARGUMENT` status will be returned. - // 0. If [groupId][google.cloud.timeseriesinsights.v1.Event.group_id] is not - // set (or 0), there + // [groupId][google.cloud.timeseriesinsights.v1.Event.group_id] if set; otherwise, an + // `INVALID_ARGUMENT` status will be returned. + // 0. If [groupId][google.cloud.timeseriesinsights.v1.Event.group_id] is not set (or 0), there // should be only 1 event; otherwise, an `INVALID_ARGUMENT` status will be // returned. // 0. The events must be newer than the current time minus - // [DataSet TTL][google.cloud.timeseriesinsights.v1.DataSet.ttl] or they - // will be dropped. + // [DataSet TTL][google.cloud.timeseriesinsights.v1.DataSet.ttl] or they will be dropped. repeated Event events = 1; // Required. The DataSet to which we want to append to in the format of @@ -336,14 +343,13 @@ message CreateDataSetRequest { } ]; - // Required. Data set to be loaded. + // Required. Dataset to be loaded. DataSet dataset = 2 [(google.api.field_behavior) = REQUIRED]; } // Unload DataSet request from the serving system. message DeleteDataSetRequest { - // Required. Data set name in the format of - // "projects/{project}/datasets/{dataset}" + // Required. Dataset name in the format of "projects/{project}/datasets/{dataset}" string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -388,16 +394,12 @@ message PinnedDimension { // **NOTE**: The `value` type must match that in the data with the same // `dimension` as name. oneof value { - // A string value. This can be used for - // [dimensions][google.cloud.timeseriesinsights.v1.EventDimension] which - // have their value field set to - // [string_val][google.cloud.timeseriesinsights.v1.EventDimension.string_val]. + // A string value. This can be used for [dimensions][google.cloud.timeseriesinsights.v1.EventDimension], which + // have their value field set to [string_val][google.cloud.timeseriesinsights.v1.EventDimension.string_val]. string string_val = 2; - // A bool value. This can be used for - // [dimensions][google.cloud.timeseriesinsights.v1.EventDimension] which - // have their value field set to - // [bool_val][google.cloud.timeseriesinsights.v1.EventDimension.bool_val]. + // A bool value. This can be used for [dimensions][google.cloud.timeseriesinsights.v1.EventDimension], which + // have their value field set to [bool_val][google.cloud.timeseriesinsights.v1.EventDimension.bool_val]. bool bool_val = 3; } } @@ -426,9 +428,9 @@ message ForecastParams { YEARLY = 4; } - // Optional. Penalize variations between the actual and forecasted values - // smaller than this. See the [anomalyScore](EvaluatedSlice.anomaly_score) - // formula for details on how this parameter impacts the score. + // Optional. Penalize variations between the actual and forecasted values smaller than + // this. For more information about how this parameter affects the score, see + // the [anomalyScore](EvaluatedSlice.anomaly_score) formula. // // Intuitively, anomaly scores summarize how statistically significant the // change between the actual and forecasted value is compared with what we @@ -461,17 +463,16 @@ message ForecastParams { // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity]. // // Example: If the detection point is set to "2020-12-27T00:00:00Z", the - // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] - // to "3600s" and the horizon_duration to "10800s", then we will generate 3 - // time series points (from "2020-12-27T01:00:00Z" to "2020-12-27T04:00:00Z"), - // for which we will return their forecasted values. + // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] to "3600s" and the + // horizon_duration to "10800s", then we will generate 3 time + // series points (from "2020-12-27T01:00:00Z" to "2020-12-27T04:00:00Z"), for + // which we will return their forecasted values. // - // **NOTE**: The horizon time is only used for forecasting not for anormaly + // Note: The horizon time is only used for forecasting not for anormaly // detection. To detect anomalies for multiple points of time, // simply send multiple queries with those as // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time]. - google.protobuf.Duration horizon_duration = 13 - [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration horizon_duration = 13 [(google.api.field_behavior) = OPTIONAL]; } // A point in a time series. @@ -482,9 +483,8 @@ message TimeseriesPoint { // The value for this point. // // It is computed by aggregating all events in the associated slice that are - // in the [time, time + granularity] range (see - // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity]) - // using the specified + // in the `[time, time + granularity]` range (see + // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity]) using the specified // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric]. optional double value = 2; } @@ -526,100 +526,89 @@ message EvaluatedSlice { // Summarizes how significant the change between the actual and forecasted // detection points are compared with the historical patterns observed on the - // [history][google.cloud.timeseriesinsights.v1.EvaluatedSlice.history] time - // series. + // [history][google.cloud.timeseriesinsights.v1.EvaluatedSlice.history] time series. // - // Defined as `|a - f| / (e + nt)`, where: + // Defined as *|a - f| / (e + nt)*, where: // - // - `a` is the - // [detectionPointActual][google.cloud.timeseriesinsights.v1.EvaluatedSlice.detection_point_actual]. - // - `f` is the - // [detectionPointForecast][google.cloud.timeseriesinsights.v1.EvaluatedSlice.detection_point_forecast]. - // - `e` is the - // [expectedDeviation][google.cloud.timeseriesinsights.v1.EvaluatedSlice.expected_deviation]. - // - `nt` is the - // [noiseThreshold][google.cloud.timeseriesinsights.v1.ForecastParams.noise_threshold]. + // - *a* is the [detectionPointActual][google.cloud.timeseriesinsights.v1.EvaluatedSlice.detection_point_actual]. + // - *f* is the [detectionPointForecast][google.cloud.timeseriesinsights.v1.EvaluatedSlice.detection_point_forecast]. + // - *e* is the [expectedDeviation][google.cloud.timeseriesinsights.v1.EvaluatedSlice.expected_deviation]. + // - *nt` is the [noiseThreshold][google.cloud.timeseriesinsights.v1.ForecastParams.noise_threshold]. // - // Anomaly scores between different requests and data sets are comparable. As + // Anomaly scores between different requests and datasets are comparable. As // a guideline, the risk of a slice being an anomaly based on the anomaly // score is: // - // - **Very High** if anomaly_score > 5. - // - **High** if the anomaly_score is in the [2, 5] range. - // - **Medium** if the anomaly_score is in the [1, 2) range. - // - **Low** if the anomaly_score is < 1. + // - **Very High** if `anomalyScore` > 5. + // - **High** if the `anomalyScore` is in the [2, 5] range. + // - **Medium** if the `anomalyScore` is in the [1, 2) range. + // - **Low** if the `anomalyScore` is < 1. // // If there were issues evaluating this slice, then the anomaly score will be - // set to -1.0 and the - // [status][google.cloud.timeseriesinsights.v1.EvaluatedSlice.status] field - // will contain details on what went wrong. + // set to -1.0 and the [status][google.cloud.timeseriesinsights.v1.EvaluatedSlice.status] field will contain details on what + // went wrong. optional double anomaly_score = 17; // The actual values in the `[` - // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] - // `-` + // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] `-` // [forecastHistory][google.cloud.timeseriesinsights.v1.TimeseriesParams.forecast_history]`,` - // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] - // `]` time range. + // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] `]` time + // range. // - // **NOTE**: This field is only populated - // https://old.reddit.com/r/nba?utm_source=reddit&utm_medium=usertext&utm_name=nba&utm_content=t5_2qo4sif - // [returnTimeseries][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.return_timeseries] - // is true. + // **NOTE**: This field is only populated if + // [returnTimeseries][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.return_timeseries] is true. Timeseries history = 5; // The forecasted values in the `[` - // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] - // `+` + // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] `+` // [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity]`,` - // [forecastParams.horizonTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.forecast_params] - // `]` time range. + // [forecastParams.horizonTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.forecast_params] `]` time + // range. // // **NOTE**: This field is only populated if - // [returnTimeseries][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.return_timeseries] - // is true. + // [returnTimeseries][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.return_timeseries] is true. Timeseries forecast = 10; - // Evaluation status. Contains an error message if the anomaly_score is < 0. + // Evaluation status. Contains an error message if the `anomalyScore` is < 0. // // Possible error messages: - // - "Time series too sparse": The returned time series for this slice did not - // contain enough data points (we require a minimum of 10). - // - "Not enough recent time series points": The time series contains the + // + // - **"Time series too sparse"**: The returned time series for this slice did + // not contain enough data points (we require a minimum of 10). + // - **"Not enough recent time series points"**: The time series contains the // minimum of 10 points, but there are not enough close in time to the // detection point. - // - "Missing detection point data": There were not events to be aggregated - // within the [detectionTime + granularity] time interval, so we don't have an - // actual value with which we can compare our prediction. - // - "Data retrieval error": We failed to retrieve the time series data for - // this slice and could not evaluate it successfully. Should be a transient - // error. - // - "Internal server error": Internal unexpected error. + // - **"Missing detection point data"**: There were not events to be + // aggregated within the `[detectionTime, detectionTime + granularity]` time + // interval, so we don't have an actual value with which we can compare our + // prediction. + // - **"Data retrieval error"**: We failed to retrieve the time series data + // for this slice and could not evaluate it successfully. Should be a + // transient error. + // - **"Internal server error"**: Internal unexpected error. google.rpc.Status status = 18; } -// Parameters that control how we slice the data set and, optionally, filter +// Parameters that control how we slice the dataset and, optionally, filter // slices that have some specific values on some dimensions (pinned dimensions). message SlicingParams { - // Required. Dimensions over which we will group the events in slices. The - // names specified here come from the - // [EventDimension.name][google.cloud.timeseriesinsights.v1.EventDimension.name] - // field. At least one dimension name must be specified. All dimension names - // that do not exist in the queried DataSet will be ignored. + // Required. Dimensions over which we will group the events in slices. The names + // specified here come from the + // [EventDimension.name][google.cloud.timeseriesinsights.v1.EventDimension.name] field. At least + // one dimension name must be specified. All dimension names that do not exist + // in the queried `DataSet` will be ignored. // // Currently only dimensions that hold string values can be specified here. repeated string dimension_names = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. We will only analyze slices for which - // [ForecastSlice.dimensions][ForecastSlice.dimensions] contain all of the + // [EvaluatedSlice.dimensions][google.cloud.timeseriesinsights.v1.EvaluatedSlice.dimensions] contain all of the // following pinned dimensions. A query with a pinned dimension `{ name: "d3" // stringVal: "v3" }` will only analyze events which contain the dimension `{ // name: "d3" stringVal: "v3" }`. - // The - // [pinnedDimensions][google.cloud.timeseriesinsights.v1.SlicingParams.pinned_dimensions] - // and - // [dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] - // fields can **not** share the same dimension names. + // The [pinnedDimensions][google.cloud.timeseriesinsights.v1.SlicingParams.pinned_dimensions] and + // [dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] fields can **not** + // share the same dimension names. // // Example a valid specification: // @@ -633,7 +622,7 @@ message SlicingParams { // } // ``` // - // In the previous example we will slice the data set by dimensions "d1", + // In the previous example we will slice the dataset by dimensions "d1", // "d2", "d3" and "d4", but we will only analyze slices for which "d3=v3" and // "d4=v4". // @@ -649,8 +638,7 @@ message SlicingParams { // ] // } // ``` - repeated PinnedDimension pinned_dimensions = 2 - [(google.api.field_behavior) = OPTIONAL]; + repeated PinnedDimension pinned_dimensions = 2 [(google.api.field_behavior) = OPTIONAL]; } // Parameters that control how we construct the time series for each slice. @@ -662,44 +650,37 @@ message TimeseriesParams { AGGREGATION_METHOD_UNSPECIFIED = 0; // Aggregate multiple events by summing up the values found in the - // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] - // dimension. + // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] dimension. SUM = 1; // Aggregate multiple events by averaging out the values found in the - // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] - // dimension. + // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] dimension. AVERAGE = 2; } - // Required. How long should we go in the past when fetching the timeline used - // for forecasting each slice. + // Required. How long should we go in the past when fetching the timeline used for + // forecasting each slice. // // This is used in combination with the - // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] - // parameter. The time series we construct will have the following time range: - // [detectionTime - forecastHistory, detectionTime + granularity]. + // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] parameter. + // The time series we construct will have the following time range: + // `[detectionTime - forecastHistory, detectionTime + granularity]`. // // The forecast history might be rounded up, so that a multiple of // `granularity` is used to process the query. // - // **NOTE**: Make sure there are enough events in the data set to cover the - // time interval: if the `detectionTime` is set to T, the data set should - // have enough events from "T - forecastHistory" to allow forecasting and - // anomaly detection. If too few events are found in this range, no anomaly - // will be reported. Users can use [EvaluateSlice][EvaluateSlice] to - // check the (approximate) count of events for each point of time in the - // range, by not setting `metric`. - google.protobuf.Duration forecast_history = 1 - [(google.api.field_behavior) = REQUIRED]; + // Note: If there are not enough events in the + // `[detectionTime - forecastHistory, detectionTime + granularity]` time + // interval, the slice evaluation can fail. For more information, see + // [EvaluatedSlice.status][google.cloud.timeseriesinsights.v1.EvaluatedSlice.status]. + google.protobuf.Duration forecast_history = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The time granularity of the time series (on the x-axis). Each - // time series point starting at time T will aggregate all events for a - // particular slice in [T, T + granularity) time windows. + // Required. The time granularity of the time series (on the x-axis). Each time series + // point starting at time T will aggregate all events for a particular slice + // in *[T, T + granularity)* time windows. // - // **NOTE**: The aggregation is decided based on the - // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] - // parameter. + // Note: The aggregation is decided based on the + // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] parameter. // // This granularity defines the query-time aggregation windows and is not // necessarily related to any event time granularity in the raw data (though @@ -707,27 +688,26 @@ message TimeseriesParams { // ingestion-time one). // // Currently, the minimal supported granularity is 10 seconds. - google.protobuf.Duration granularity = 2 - [(google.api.field_behavior) = REQUIRED]; + google.protobuf.Duration granularity = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Denotes the - // [name][google.cloud.timeseriesinsights.v1.EventDimension.name] of a - // numerical dimension that will have its values aggregated to compute the - // y-axis of the time series. + // Optional. Denotes the [name][google.cloud.timeseriesinsights.v1.EventDimension.name] of a numerical + // dimension that will have its values aggregated to compute the y-axis of the + // time series. // // The aggregation method must also be specified by setting the - // [metricAggregationMethod][TimeseriesParams.metricAggregationMethod] field. + // [metricAggregationMethod][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric_aggregation_method] + // field. // - // **Note**: Currently, if the aggregation method is unspecified, we will - // default to SUM for backwards compatibility reasons, but new implementations + // Note: Currently, if the aggregation method is unspecified, we will + // default to SUM for backward compatibility reasons, but new implementations // should set the - // [metricAggregationMethod][TimeseriesParams.metricAggregationMethod] + // [metricAggregationMethod][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric_aggregation_method] // explicitly. // // If the metric is unspecified, we will use the number of events that each // time series point contains as the point value. // - // Example: Let's assume we have the following three events in our data set: + // Example: Let's assume we have the following three events in our dataset: // ```json // { // eventTime: "2020-12-27T00:00:00Z", @@ -759,20 +739,15 @@ message TimeseriesParams { // ``` // // These events are all within the same hour, spaced 10 minutes between each - // of them. Assuming our - // [QueryDataSetRequest][google.cloud.timeseriesinsights.v1.QueryDataSetRequest] - // had set - // [slicingParams.dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] - // to ["d1", "d2"] and - // [timeseries_params.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] - // to "3600s", then all the previous events will be aggregated into the same + // of them. Assuming our [QueryDataSetRequest][google.cloud.timeseriesinsights.v1.QueryDataSetRequest] had set + // [slicingParams.dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] to ["d1", + // "d2"] and [timeseries_params.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] to + // "3600s", then all the previous events will be aggregated into the same // [timeseries point][google.cloud.timeseriesinsights.v1.TimeseriesPoint]. // - // The time series point which they are all part of will have the - // [time][google.cloud.timeseriesinsights.v1.TimeseriesPoint.time] set to - // "2020-12-27T00:00:00Z" and the - // [value][google.cloud.timeseriesinsights.v1.TimeseriesPoint.value] populated - // based on this metric field: + // The time series point that they're all part of will have the + // [time][google.cloud.timeseriesinsights.v1.TimeseriesPoint.time] set to "2020-12-27T00:00:00Z" and the + // [value][google.cloud.timeseriesinsights.v1.TimeseriesPoint.value] populated based on this metric field: // // - If the metric is set to "m1" and metric_aggregation_method to SUM, then // the value of the point will be 600. @@ -786,16 +761,13 @@ message TimeseriesParams { // will be 3, as we will simply count the events. optional string metric = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Together with the - // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] field, - // specifies how we will aggregate multiple events to obtain the value of a - // time series point. See the - // [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] - // documentation for more details. + // Optional. Together with the [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] field, specifies how + // we will aggregate multiple events to obtain the value of a time series + // point. See the [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] documentation for more + // details. // // If the metric is not specified or "", then this field will be ignored. - AggregationMethod metric_aggregation_method = 5 - [(google.api.field_behavior) = OPTIONAL]; + AggregationMethod metric_aggregation_method = 5 [(google.api.field_behavior) = OPTIONAL]; } // Request for performing a query against a loaded DataSet. @@ -809,27 +781,24 @@ message QueryDataSetRequest { } ]; - // Required. This is the point in time which we want to probe for anomalies. + // Required. This is the point in time that we want to probe for anomalies. // - // The corresponding - // [TimeseriesPoint][google.cloud.timeseriesinsights.v1.TimeseriesPoint] is - // referred to as the detection point. + // The corresponding [TimeseriesPoint][google.cloud.timeseriesinsights.v1.TimeseriesPoint] is referred to as the + // detection point. // // **NOTE**: As with any other time series point, the value is given by // aggregating all events in the slice that are in the // [detectionTime, detectionTime + granularity) time interval, where // the granularity is specified in the - // [timeseriesParams.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] - // field. - google.protobuf.Timestamp detection_time = 11 - [(google.api.field_behavior) = REQUIRED]; + // [timeseriesParams.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] field. + google.protobuf.Timestamp detection_time = 11 [(google.api.field_behavior) = REQUIRED]; // How many slices are returned in // [QueryDataSetResponse.slices][google.cloud.timeseriesinsights.v1.QueryDataSetResponse.slices]. // - // The returned slices are tentatively the ones with the highest [anomaly - // scores][EvaluatedSlice.anomaly_score] in the data set that match the query, - // but it is not guaranteed. + // The returned slices are tentatively the ones with the highest + // [anomaly scores][google.cloud.timeseriesinsights.v1.EvaluatedSlice.anomaly_score] in the dataset that match + // the query, but it is not guaranteed. // // Reducing this number will improve query performance, both in terms of // latency and resource usage. @@ -837,14 +806,12 @@ message QueryDataSetRequest { // Defaults to 50. optional int32 num_returned_slices = 13; - // Parameters controlling how we will split the data set into the slices that + // Parameters controlling how we will split the dataset into the slices that // we will analyze. SlicingParams slicing_params = 9; // Parameters controlling how we will build the time series used to predict - // the - // [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] - // value for each slice. + // the [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] value for each slice. TimeseriesParams timeseries_params = 10; // Parameters that control the time series forecasting models, such as the @@ -855,10 +822,8 @@ message QueryDataSetRequest { // returned slices. // // The time series are returned in the - // [EvaluatedSlice.history][google.cloud.timeseriesinsights.v1.EvaluatedSlice.history] - // and - // [EvaluatedSlice.forecast][google.cloud.timeseriesinsights.v1.EvaluatedSlice.forecast] - // fields. + // [EvaluatedSlice.history][google.cloud.timeseriesinsights.v1.EvaluatedSlice.history] and + // [EvaluatedSlice.forecast][google.cloud.timeseriesinsights.v1.EvaluatedSlice.forecast] fields. bool return_timeseries = 8; } @@ -870,8 +835,7 @@ message QueryDataSetResponse { // Slices sorted in descending order by their // [anomalyScore][google.cloud.timeseriesinsights.v1.EvaluatedSlice.anomaly_score]. // - // At most - // [numReturnedSlices][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.num_returned_slices] + // At most [numReturnedSlices][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.num_returned_slices] // slices are present in this field. repeated EvaluatedSlice slices = 3; } @@ -887,25 +851,58 @@ message EvaluateSliceRequest { } ]; - // Required. Dimensions with pinned values that specify the slice for which we - // will fetch the time series. - repeated PinnedDimension pinned_dimensions = 2 - [(google.api.field_behavior) = REQUIRED]; + // Required. Dimensions with pinned values that specify the slice for which we will + // fetch the time series. + repeated PinnedDimension pinned_dimensions = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. This is the point in time which we want to probe for anomalies. + // Required. This is the point in time that we want to probe for anomalies. // // See documentation for - // [QueryDataSetRequest.detectionPoint][QueryDataSetRequest.detection_point]. - google.protobuf.Timestamp detection_time = 3 - [(google.api.field_behavior) = REQUIRED]; + // [QueryDataSetRequest.detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time]. + google.protobuf.Timestamp detection_time = 3 [(google.api.field_behavior) = REQUIRED]; // Parameters controlling how we will build the time series used to predict - // the - // [detectionTime][google.cloud.timeseriesinsights.v1.EvaluateSliceRequest.detection_time] - // value for this slice. + // the [detectionTime][google.cloud.timeseriesinsights.v1.EvaluateSliceRequest.detection_time] value for this slice. TimeseriesParams timeseries_params = 4; // Parameters that control the time series forecasting models, such as the // sensitivity of the anomaly detection. ForecastParams forecast_params = 5; } + +// Request for evaluateTimeseries. +message EvaluateTimeseriesRequest { + // Required. Client project name in the format of 'projects/{project}'. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "cloudresourcemanager.googleapis.com/Project" + } + ]; + + // Evaluate this time series without requiring it was previously loaded in + // a data set. + // + // The evaluated time series point is the last one, analogous to calling + // evaluateSlice or query with + // [detectionTime][google.cloud.timeseriesinsights.v1.EvaluateSliceRequest.detection_time] set to + // `timeseries.point(timeseries.point_size() - 1).time`. + // + // The length of the time series must be at least 10. + // + // All points must have the same time offset relative to the granularity. For + // example, if the [granularity][google.cloud.timeseriesinsights.v1.EvaluateTimeseriesRequest.granularity] is "5s", then the following + // point.time sequences are valid: + // - "100s", "105s", "120s", "125s" (no offset) + // - "102s", "107s", "122s", "127s" (offset is "2s") + // However, the following sequence is invalid as it has inconsistent offsets: + // - "100s", "105s", "122s", "127s" (offsets are either "0s" or "2s") + Timeseries timeseries = 2; + + // The granularity of the time series (time distance between two consecutive + // points). + google.protobuf.Duration granularity = 3; + + // The forecast parameters. + ForecastParams forecast_params = 4; +} diff --git a/google/cloud/tpu/v1/BUILD.bazel b/google/cloud/tpu/v1/BUILD.bazel index 60d084067..76d6791fc 100644 --- a/google/cloud/tpu/v1/BUILD.bazel +++ b/google/cloud/tpu/v1/BUILD.bazel @@ -38,6 +38,7 @@ proto_library_with_info( deps = [ ":tpu_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -67,12 +68,19 @@ java_grpc_library( java_gapic_library( name = "tpu_java_gapic", srcs = [":tpu_proto_with_info"], + gapic_yaml = None, grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v1.yaml", test_deps = [ ":tpu_java_grpc", + "//google/cloud/location:location_java_grpc", ], + transport = "grpc", deps = [ ":tpu_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) @@ -88,6 +96,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-tpu-v1-java", include_samples = True, + transport = "grpc+rest", deps = [ ":tpu_java_gapic", ":tpu_java_grpc", @@ -124,12 +133,15 @@ go_gapic_library( grpc_service_config = "tpu_grpc_service_config.json", importpath = "cloud.google.com/go/tpu/apiv1;tpu", metadata = True, + rest_numeric_enums = True, service_yaml = "tpu_v1.yaml", + transport = "grpc", deps = [ ":tpu_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -165,7 +177,11 @@ py_gapic_library( name = "tpu_py_gapic", srcs = [":tpu_proto"], grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -212,7 +228,9 @@ php_gapic_library( name = "tpu_php_gapic", srcs = [":tpu_proto_with_info"], grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "tpu_v1.yaml", + transport = "grpc+rest", deps = [ ":tpu_php_grpc", ":tpu_php_proto", @@ -245,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "tpu_grpc_service_config.json", package = "google.cloud.tpu.v1", + rest_numeric_enums = True, service_yaml = "tpu_v1.yaml", + transport = "grpc", deps = [], ) @@ -283,15 +303,17 @@ ruby_cloud_gapic_library( name = "tpu_ruby_gapic", srcs = [":tpu_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-tpu-v1", - "ruby-cloud-env-prefix=CLOUD_TPU", - "ruby-cloud-product-url=https://cloud.google.com/tpu/", "ruby-cloud-api-id=tpu.googleapis.com", "ruby-cloud-api-shortname=tpu", + "ruby-cloud-env-prefix=CLOUD_TPU", + "ruby-cloud-gem-name=google-cloud-tpu-v1", + "ruby-cloud-product-url=https://cloud.google.com/tpu/", ], grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Tensor Processing Units (TPUs) are Google's custom-developed application-specific integrated circuits (ASICs) used to accelerate machine learning workloads. Cloud TPUs allow you to access TPUs from Compute Engine, Google Kubernetes Engine and AI Platform.", ruby_cloud_title = "Cloud TPU V1", + service_yaml = "tpu_v1.yaml", deps = [ ":tpu_ruby_grpc", ":tpu_ruby_proto", @@ -335,6 +357,7 @@ csharp_gapic_library( srcs = [":tpu_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "tpu_v1.yaml", deps = [ ":tpu_csharp_grpc", diff --git a/google/cloud/tpu/v1/cloud_tpu.proto b/google/cloud/tpu/v1/cloud_tpu.proto index 08e83550b..c2acf92f4 100644 --- a/google/cloud/tpu/v1/cloud_tpu.proto +++ b/google/cloud/tpu/v1/cloud_tpu.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. @@ -88,7 +88,7 @@ service Tpu { }; } - // Stops a node. + // Stops a node, this operation is only available with single TPU nodes. rpc StopNode(StopNodeRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/nodes/*}:stop" @@ -178,7 +178,7 @@ message Node { // TPU node is being created. CREATING = 1; - // TPU node has been created and is fully usable. + // TPU node has been created. READY = 2; // TPU node is restarting. @@ -550,11 +550,6 @@ message ListAcceleratorTypesResponse { repeated string unreachable = 3; } -// Note: the following OperationMetadata message was added manually. -// This is caused by a conflict with some other message and will -// be resolved separately. Please make sure to add this message back -// if it's removed during public proto regeneration. - // Metadata describing an [Operation][google.longrunning.Operation] message OperationMetadata { // The time the operation was created. diff --git a/google/cloud/tpu/v1/tpu_v1.yaml b/google/cloud/tpu/v1/tpu_v1.yaml index db7abf448..aacfd2b9e 100644 --- a/google/cloud/tpu/v1/tpu_v1.yaml +++ b/google/cloud/tpu/v1/tpu_v1.yaml @@ -4,7 +4,9 @@ name: tpu.googleapis.com title: Cloud TPU API apis: +- name: google.cloud.location.Locations - name: google.cloud.tpu.v1.Tpu +- name: google.longrunning.Operations types: - name: google.cloud.tpu.v1.OperationMetadata diff --git a/google/cloud/bigquery/reservation/v1beta1/BUILD.bazel b/google/cloud/tpu/v2/BUILD.bazel similarity index 51% rename from google/cloud/bigquery/reservation/v1beta1/BUILD.bazel rename to google/cloud/tpu/v2/BUILD.bazel index 898e3b7a4..648fdca95 100644 --- a/google/cloud/bigquery/reservation/v1beta1/BUILD.bazel +++ b/google/cloud/tpu/v2/BUILD.bazel @@ -1,5 +1,5 @@ # This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel +# 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: @@ -19,27 +19,27 @@ load("@rules_proto//proto:defs.bzl", "proto_library") load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") proto_library( - name = "reservation_proto", + name = "tpu_proto", srcs = [ - "reservation.proto", + "cloud_tpu.proto", ], deps = [ "//google/api:annotations_proto", "//google/api:client_proto", "//google/api:field_behavior_proto", "//google/api:resource_proto", - "//google/rpc:status_proto", - "@com_google_protobuf//:empty_proto", + "//google/longrunning:operations_proto", "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], ) proto_library_with_info( - name = "reservation_proto_with_info", + name = "tpu_proto_with_info", deps = [ - ":reservation_proto", + ":tpu_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -56,44 +56,54 @@ load( ) java_proto_library( - name = "reservation_java_proto", - deps = [":reservation_proto"], + name = "tpu_java_proto", + deps = [":tpu_proto"], ) java_grpc_library( - name = "reservation_java_grpc", - srcs = [":reservation_proto"], - deps = [":reservation_java_proto"], + name = "tpu_java_grpc", + srcs = [":tpu_proto"], + deps = [":tpu_java_proto"], ) java_gapic_library( - name = "reservation_java_gapic", - srcs = [":reservation_proto_with_info"], - grpc_service_config = "bigqueryreservation_grpc_service_config.json", + name = "tpu_java_gapic", + srcs = [":tpu_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", test_deps = [ - ":reservation_java_grpc", + ":tpu_java_grpc", + "//google/cloud/location:location_java_grpc", ], + transport = "grpc+rest", deps = [ - ":reservation_java_proto", + ":tpu_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) java_gapic_test( - name = "reservation_java_gapic_test_suite", + name = "tpu_java_gapic_test_suite", test_classes = [ - "com.google.cloud.bigquery.reservation.v1beta1.ReservationServiceClientTest", + "com.google.cloud.tpu.v2.TpuClientHttpJsonTest", + "com.google.cloud.tpu.v2.TpuClientTest", ], - runtime_deps = [":reservation_java_gapic_test"], + runtime_deps = [":tpu_java_gapic_test"], ) # Open Source Packages java_gapic_assembly_gradle_pkg( - name = "google-cloud-bigquery-reservation-v1beta1-java", + name = "google-cloud-tpu-v2-java", + include_samples = True, + transport = "grpc+rest", deps = [ - ":reservation_java_gapic", - ":reservation_java_grpc", - ":reservation_java_proto", - ":reservation_proto", + ":tpu_java_gapic", + ":tpu_java_grpc", + ":tpu_java_proto", + ":tpu_proto", ], ) @@ -109,41 +119,49 @@ load( ) go_proto_library( - name = "reservation_go_proto", + name = "tpu_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1beta1", - protos = [":reservation_proto"], + importpath = "google.golang.org/genproto/googleapis/cloud/tpu/v2", + protos = [":tpu_proto"], deps = [ "//google/api:annotations_go_proto", - "//google/rpc:status_go_proto", + "//google/longrunning:longrunning_go_proto", ], ) go_gapic_library( - name = "reservation_go_gapic", - srcs = [":reservation_proto_with_info"], - grpc_service_config = "bigqueryreservation_grpc_service_config.json", - importpath = "cloud.google.com/go/bigquery/reservation/apiv1beta1;reservation", - service_yaml = "bigqueryreservation_v1beta1.yaml", + name = "tpu_go_gapic", + srcs = [":tpu_proto_with_info"], + grpc_service_config = "tpu_grpc_service_config.json", + importpath = "cloud.google.com/go/tpu/apiv2;tpu", + metadata = True, + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", + transport = "grpc+rest", deps = [ - ":reservation_go_proto", + ":tpu_go_proto", + "//google/cloud/location:location_go_proto", + "//google/longrunning:longrunning_go_proto", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) go_test( - name = "reservation_go_gapic_test", - srcs = [":reservation_go_gapic_srcjar_test"], - embed = [":reservation_go_gapic"], - importpath = "cloud.google.com/go/bigquery/reservation/apiv1beta1", + name = "tpu_go_gapic_test", + srcs = [":tpu_go_gapic_srcjar_test"], + embed = [":tpu_go_gapic"], + importpath = "cloud.google.com/go/tpu/apiv2", ) # Open Source Packages go_gapic_assembly_pkg( - name = "gapi-cloud-bigquery-reservation-v1beta1-go", + name = "gapi-cloud-tpu-v2-go", deps = [ - ":reservation_go_gapic", - ":reservation_go_gapic_srcjar-test.srcjar", - ":reservation_go_proto", + ":tpu_go_gapic", + ":tpu_go_gapic_srcjar-metadata.srcjar", + ":tpu_go_gapic_srcjar-test.srcjar", + ":tpu_go_proto", ], ) @@ -158,27 +176,31 @@ load( ) py_gapic_library( - name = "reservation_py_gapic", - srcs = [":reservation_proto"], - grpc_service_config = "bigqueryreservation_grpc_service_config.json", - transport = "grpc", + name = "tpu_py_gapic", + srcs = [":tpu_proto"], + grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", + transport = "grpc+rest", + deps = [ + ], ) py_test( - name = "reservation_py_gapic_test", + name = "tpu_py_gapic_test", srcs = [ - "reservation_py_gapic_pytest.py", - "reservation_py_gapic_test.py", + "tpu_py_gapic_pytest.py", + "tpu_py_gapic_test.py", ], legacy_create_init = False, - deps = [":reservation_py_gapic"], + deps = [":tpu_py_gapic"], ) # Open Source Packages py_gapic_assembly_pkg( - name = "bigquery-reservation-v1beta1-py", + name = "tpu-v2-py", deps = [ - ":reservation_py_gapic", + ":tpu_py_gapic", ], ) @@ -194,33 +216,36 @@ load( ) php_proto_library( - name = "reservation_php_proto", - deps = [":reservation_proto"], + name = "tpu_php_proto", + deps = [":tpu_proto"], ) php_grpc_library( - name = "reservation_php_grpc", - srcs = [":reservation_proto"], - deps = [":reservation_php_proto"], + name = "tpu_php_grpc", + srcs = [":tpu_proto"], + deps = [":tpu_php_proto"], ) php_gapic_library( - name = "reservation_php_gapic", - srcs = [":reservation_proto_with_info"], - grpc_service_config = "bigqueryreservation_grpc_service_config.json", + name = "tpu_php_gapic", + srcs = [":tpu_proto_with_info"], + grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", + transport = "grpc+rest", deps = [ - ":reservation_php_grpc", - ":reservation_php_proto", + ":tpu_php_grpc", + ":tpu_php_proto", ], ) # Open Source Packages php_gapic_assembly_pkg( - name = "google-cloud-bigquery-reservation-v1beta1-php", + name = "google-cloud-tpu-v2-php", deps = [ - ":reservation_php_gapic", - ":reservation_php_grpc", - ":reservation_php_proto", + ":tpu_php_gapic", + ":tpu_php_grpc", + ":tpu_php_proto", ], ) @@ -234,20 +259,23 @@ load( ) nodejs_gapic_library( - name = "reservation_nodejs_gapic", - src = ":reservation_proto_with_info", + name = "tpu_nodejs_gapic", + package_name = "@google-cloud/tpu", + src = ":tpu_proto_with_info", extra_protoc_parameters = ["metadata"], - grpc_service_config = "bigqueryreservation_grpc_service_config.json", - package = "google.cloud.bigquery.reservation.v1beta1", - service_yaml = "bigqueryreservation_v1beta1.yaml", + grpc_service_config = "tpu_grpc_service_config.json", + package = "google.cloud.tpu.v2", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", + transport = "grpc+rest", deps = [], ) nodejs_gapic_assembly_pkg( - name = "bigquery-reservation-v1beta1-nodejs", + name = "tpu-v2-nodejs", deps = [ - ":reservation_nodejs_gapic", - ":reservation_proto", + ":tpu_nodejs_gapic", + ":tpu_proto", ], ) @@ -263,33 +291,36 @@ load( ) ruby_proto_library( - name = "reservation_ruby_proto", - deps = [":reservation_proto"], + name = "tpu_ruby_proto", + deps = [":tpu_proto"], ) ruby_grpc_library( - name = "reservation_ruby_grpc", - srcs = [":reservation_proto"], - deps = [":reservation_ruby_proto"], + name = "tpu_ruby_grpc", + srcs = [":tpu_proto"], + deps = [":tpu_ruby_proto"], ) ruby_cloud_gapic_library( - name = "reservation_ruby_gapic", - srcs = [":reservation_proto_with_info"], - extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-reservation-v1beta1"], + name = "tpu_ruby_gapic", + srcs = [":tpu_proto_with_info"], + extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-tpu-v2"], + grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", deps = [ - ":reservation_ruby_grpc", - ":reservation_ruby_proto", + ":tpu_ruby_grpc", + ":tpu_ruby_proto", ], ) # Open Source Packages ruby_gapic_assembly_pkg( - name = "google-cloud-bigquery-reservation-v1beta1-ruby", + name = "google-cloud-tpu-v2-ruby", deps = [ - ":reservation_ruby_gapic", - ":reservation_ruby_grpc", - ":reservation_ruby_proto", + ":tpu_ruby_gapic", + ":tpu_ruby_grpc", + ":tpu_ruby_proto", ], ) @@ -305,39 +336,56 @@ load( ) csharp_proto_library( - name = "reservation_csharp_proto", - deps = [":reservation_proto"], + name = "tpu_csharp_proto", + deps = [":tpu_proto"], ) csharp_grpc_library( - name = "reservation_csharp_grpc", - srcs = [":reservation_proto"], - deps = [":reservation_csharp_proto"], + name = "tpu_csharp_grpc", + srcs = [":tpu_proto"], + deps = [":tpu_csharp_proto"], ) csharp_gapic_library( - name = "reservation_csharp_gapic", - srcs = [":reservation_proto_with_info"], + name = "tpu_csharp_gapic", + srcs = [":tpu_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "bigqueryreservation_grpc_service_config.json", - service_yaml = "bigqueryreservation_v1beta1.yaml", + grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "tpu_v2.yaml", deps = [ - ":reservation_csharp_grpc", - ":reservation_csharp_proto", + ":tpu_csharp_grpc", + ":tpu_csharp_proto", ], ) # Open Source Packages csharp_gapic_assembly_pkg( - name = "google-cloud-bigquery-reservation-v1beta1-csharp", + name = "google-cloud-tpu-v2-csharp", deps = [ - ":reservation_csharp_gapic", - ":reservation_csharp_grpc", - ":reservation_csharp_proto", + ":tpu_csharp_gapic", + ":tpu_csharp_grpc", + ":tpu_csharp_proto", ], ) ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "tpu_cc_proto", + deps = [":tpu_proto"], +) + +cc_grpc_library( + name = "tpu_cc_grpc", + srcs = [":tpu_proto"], + grpc_only = True, + deps = [":tpu_cc_proto"], +) diff --git a/google/cloud/tpu/v2/cloud_tpu.proto b/google/cloud/tpu/v2/cloud_tpu.proto new file mode 100644 index 000000000..b99a2013c --- /dev/null +++ b/google/cloud/tpu/v2/cloud_tpu.proto @@ -0,0 +1,795 @@ +// 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.tpu.v2; + +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/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "google.golang.org/genproto/googleapis/cloud/tpu/v2;tpu"; +option java_multiple_files = true; +option java_outer_classname = "CloudTpuProto"; +option java_package = "com.google.cloud.tpu.v2"; + +// Manages TPU nodes and other resources +// +// TPU API v2 +service Tpu { + option (google.api.default_host) = "tpu.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists nodes. + rpc ListNodes(ListNodesRequest) returns (ListNodesResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*}/nodes" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets the details of a node. + rpc GetNode(GetNodeRequest) returns (Node) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/nodes/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a node. + rpc CreateNode(CreateNodeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2/{parent=projects/*/locations/*}/nodes" + body: "node" + }; + option (google.api.method_signature) = "parent,node,node_id"; + option (google.longrunning.operation_info) = { + response_type: "Node" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a node. + rpc DeleteNode(DeleteNodeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v2/{name=projects/*/locations/*/nodes/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Stops a node. This operation is only available with single TPU nodes. + rpc StopNode(StopNodeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2/{name=projects/*/locations/*/nodes/*}:stop" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "Node" + metadata_type: "OperationMetadata" + }; + } + + // Starts a node. + rpc StartNode(StartNodeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2/{name=projects/*/locations/*/nodes/*}:start" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "Node" + metadata_type: "OperationMetadata" + }; + } + + // Updates the configurations of a node. + rpc UpdateNode(UpdateNodeRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v2/{node.name=projects/*/locations/*/nodes/*}" + body: "node" + }; + option (google.api.method_signature) = "node,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Node" + metadata_type: "OperationMetadata" + }; + } + + // Generates the Cloud TPU service identity for the project. + rpc GenerateServiceIdentity(GenerateServiceIdentityRequest) returns (GenerateServiceIdentityResponse) { + option (google.api.http) = { + post: "/v2/{parent=projects/*/locations/*}:generateServiceIdentity" + body: "*" + }; + } + + // Lists accelerator types supported by this API. + rpc ListAcceleratorTypes(ListAcceleratorTypesRequest) returns (ListAcceleratorTypesResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*}/acceleratorTypes" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets AcceleratorType. + rpc GetAcceleratorType(GetAcceleratorTypeRequest) returns (AcceleratorType) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/acceleratorTypes/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists runtime versions supported by this API. + rpc ListRuntimeVersions(ListRuntimeVersionsRequest) returns (ListRuntimeVersionsResponse) { + option (google.api.http) = { + get: "/v2/{parent=projects/*/locations/*}/runtimeVersions" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets a runtime version. + rpc GetRuntimeVersion(GetRuntimeVersionRequest) returns (RuntimeVersion) { + option (google.api.http) = { + get: "/v2/{name=projects/*/locations/*/runtimeVersions/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Retrieves the guest attributes for the node. + rpc GetGuestAttributes(GetGuestAttributesRequest) returns (GetGuestAttributesResponse) { + option (google.api.http) = { + post: "/v2/{name=projects/*/locations/*/nodes/*}:getGuestAttributes" + body: "*" + }; + } +} + +// A guest attributes. +message GuestAttributes { + // The path to be queried. This can be the default namespace ('/') or a + // nested namespace ('/\/') or a specified key + // ('/\/\') + string query_path = 1; + + // The value of the requested queried path. + GuestAttributesValue query_value = 2; +} + +// Array of guest attribute namespace/key/value tuples. +message GuestAttributesValue { + // The list of guest attributes entries. + repeated GuestAttributesEntry items = 1; +} + +// A guest attributes namespace/key/value entry. +message GuestAttributesEntry { + // Namespace for the guest attribute entry. + string namespace = 1; + + // Key for the guest attribute entry. + string key = 2; + + // Value for the guest attribute entry. + string value = 3; +} + +// A node-attached disk resource. +// Next ID: 8; +message AttachedDisk { + // The different mode of the attached disk. + enum DiskMode { + // The disk mode is not known/set. + DISK_MODE_UNSPECIFIED = 0; + + // Attaches the disk in read-write mode. Only one TPU node can attach a disk + // in read-write mode at a time. + READ_WRITE = 1; + + // Attaches the disk in read-only mode. Multiple TPU nodes can attach + // a disk in read-only mode at a time. + READ_ONLY = 2; + } + + // Specifies the full path to an existing disk. + // For example: "projects/my-project/zones/us-central1-c/disks/my-disk". + string source_disk = 3; + + // The mode in which to attach this disk. + // If not specified, the default is READ_WRITE mode. + // Only applicable to data_disks. + DiskMode mode = 4; +} + +// Sets the scheduling options for this node. +message SchedulingConfig { + // Defines whether the node is preemptible. + bool preemptible = 1; + + // Whether the node is created under a reservation. + bool reserved = 2; +} + +// A network endpoint over which a TPU worker can be reached. +message NetworkEndpoint { + // The internal IP address of this network endpoint. + string ip_address = 1; + + // The port of this network endpoint. + int32 port = 2; + + // The access config for the TPU worker. + AccessConfig access_config = 5; +} + +// An access config attached to the TPU worker. +message AccessConfig { + // Output only. An external IP address associated with the TPU worker. + string external_ip = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Network related configurations. +message NetworkConfig { + // The name of the network for the TPU node. It must be a preexisting Google + // Compute Engine network. If none is provided, "default" will be used. + string network = 1; + + // The name of the subnetwork for the TPU node. It must be a preexisting + // Google Compute Engine subnetwork. If none is provided, "default" will be + // used. + string subnetwork = 2; + + // Indicates that external IP addresses would be associated with the TPU + // workers. If set to false, the specified subnetwork or network should have + // Private Google Access enabled. + bool enable_external_ips = 3; + + // Allows the TPU node to send and receive packets with non-matching + // destination or source IPs. This is required if you plan to use the TPU + // workers to forward routes. + bool can_ip_forward = 4; +} + +// A service account. +message ServiceAccount { + // Email address of the service account. If empty, default Compute service + // account will be used. + string email = 1; + + // The list of scopes to be made available for this service account. If empty, + // access to all Cloud APIs will be allowed. + repeated string scope = 2; +} + +// A TPU instance. +message Node { + option (google.api.resource) = { + type: "tpu.googleapis.com/Node" + pattern: "projects/{project}/locations/{location}/nodes/{node}" + }; + + // Represents the different states of a TPU node during its lifecycle. + enum State { + // TPU node state is not known/set. + STATE_UNSPECIFIED = 0; + + // TPU node is being created. + CREATING = 1; + + // TPU node has been created. + READY = 2; + + // TPU node is restarting. + RESTARTING = 3; + + // TPU node is undergoing reimaging. + REIMAGING = 4; + + // TPU node is being deleted. + DELETING = 5; + + // TPU node is being repaired and may be unusable. Details can be + // found in the `help_description` field. + REPAIRING = 6; + + // TPU node is stopped. + STOPPED = 8; + + // TPU node is currently stopping. + STOPPING = 9; + + // TPU node is currently starting. + STARTING = 10; + + // TPU node has been preempted. Only applies to Preemptible TPU Nodes. + PREEMPTED = 11; + + // TPU node has been terminated due to maintenance or has reached the end of + // its life cycle (for preemptible nodes). + TERMINATED = 12; + + // TPU node is currently hiding. + HIDING = 13; + + // TPU node has been hidden. + HIDDEN = 14; + + // TPU node is currently unhiding. + UNHIDING = 15; + } + + // Health defines the status of a TPU node as reported by + // Health Monitor. + enum Health { + // Health status is unknown: not initialized or failed to retrieve. + HEALTH_UNSPECIFIED = 0; + + // The resource is healthy. + HEALTHY = 1; + + // The resource is unresponsive. + TIMEOUT = 3; + + // The in-guest ML stack is unhealthy. + UNHEALTHY_TENSORFLOW = 4; + + // The node is under maintenance/priority boost caused rescheduling and + // will resume running once rescheduled. + UNHEALTHY_MAINTENANCE = 5; + } + + // TPU API Version. + enum ApiVersion { + // API version is unknown. + API_VERSION_UNSPECIFIED = 0; + + // TPU API V1Alpha1 version. + V1_ALPHA1 = 1; + + // TPU API V1 version. + V1 = 2; + + // TPU API V2Alpha1 version. + V2_ALPHA1 = 3; + + // TPU API V2 version. + V2 = 4; + } + + // Output only. Immutable. The name of the TPU. + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // The user-supplied description of the TPU. Maximum of 512 characters. + string description = 3; + + // Required. The type of hardware accelerators associated with this node. + string accelerator_type = 5 [(google.api.field_behavior) = REQUIRED]; + + // Output only. The current state for the TPU Node. + State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. If this field is populated, it contains a description of why the TPU Node + // is unhealthy. + string health_description = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The runtime version running in the Node. + string runtime_version = 11 [(google.api.field_behavior) = REQUIRED]; + + // Network configurations for the TPU node. + NetworkConfig network_config = 36; + + // The CIDR block that the TPU node will use when selecting an IP address. + // This CIDR block must be a /29 block; the Compute Engine networks API + // forbids a smaller block, and using a larger block would be wasteful (a + // node can only consume one IP address). Errors will occur if the CIDR block + // has already been used for a currently existing TPU node, the CIDR block + // conflicts with any subnetworks in the user's provided network, or the + // provided network is peered with another network that is using that CIDR + // block. + string cidr_block = 13; + + // The Google Cloud Platform Service Account to be used by the TPU node VMs. + // If None is specified, the default compute service account will be used. + ServiceAccount service_account = 37; + + // Output only. The time when the node was created. + google.protobuf.Timestamp create_time = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The scheduling options for this node. + SchedulingConfig scheduling_config = 17; + + // Output only. The network endpoints where TPU workers can be accessed and + // sent work. It is recommended that runtime clients of the node reach out + // to the 0th entry in this map first. + repeated NetworkEndpoint network_endpoints = 21 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The health status of the TPU node. + Health health = 22; + + // Resource labels to represent user-provided metadata. + map labels = 24; + + // Custom metadata to apply to the TPU Node. + // Can set startup-script and shutdown-script + map metadata = 34; + + // Tags to apply to the TPU Node. Tags are used to identify valid sources or + // targets for network firewalls. + repeated string tags = 40; + + // Output only. The unique identifier for the TPU Node. + int64 id = 33 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The additional data disks for the Node. + repeated AttachedDisk data_disks = 41; + + // Output only. The API version that created this Node. + ApiVersion api_version = 38 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The Symptoms that have occurred to the TPU Node. + repeated Symptom symptoms = 39 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Shielded Instance options. + ShieldedInstanceConfig shielded_instance_config = 45; +} + +// Request for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. +message ListNodesRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "tpu.googleapis.com/Node" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value returned from a previous List request, if any. + string page_token = 3; +} + +// Response for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. +message ListNodesResponse { + // The listed nodes. + repeated Node nodes = 1; + + // The next page token or empty if none. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode]. +message GetNodeRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/Node" + } + ]; +} + +// Request for [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode]. +message CreateNodeRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The unqualified resource name. + string node_id = 2; + + // Required. The node. + Node node = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// Request for [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode]. +message DeleteNodeRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/Node" + } + ]; +} + +// Request for [StopNode][google.cloud.tpu.v2.Tpu.StopNode]. +message StopNodeRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/Node" + } + ]; +} + +// Request for [StartNode][google.cloud.tpu.v2.Tpu.StartNode]. +message StartNodeRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/Node" + } + ]; +} + +// Request for [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode]. +message UpdateNodeRequest { + // Required. Mask of fields from [Node][Tpu.Node] to update. + // Supported fields: [description, tags, labels, metadata, + // network_config.enable_external_ips]. + google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The node. Only fields specified in update_mask are updated. + Node node = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// The per-product per-project service identity for Cloud TPU service. +message ServiceIdentity { + // The email address of the service identity. + string email = 1; +} + +// Request for [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. +message GenerateServiceIdentityRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; +} + +// Response for [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. +message GenerateServiceIdentityResponse { + // ServiceIdentity that was created or retrieved. + ServiceIdentity identity = 1; +} + +// A accelerator type that a Node can be configured with. +message AcceleratorType { + option (google.api.resource) = { + type: "tpu.googleapis.com/AcceleratorType" + pattern: "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}" + }; + + // The resource name. + string name = 1; + + // the accelerator type. + string type = 2; +} + +// Request for [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType]. +message GetAcceleratorTypeRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/AcceleratorType" + } + ]; +} + +// Request for [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. +message ListAcceleratorTypesRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "tpu.googleapis.com/AcceleratorType" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value returned from a previous List request, if any. + string page_token = 3; + + // List filter. + string filter = 5; + + // Sort results. + string order_by = 6; +} + +// Response for [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. +message ListAcceleratorTypesResponse { + // The listed nodes. + repeated AcceleratorType accelerator_types = 1; + + // The next page token or empty if none. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// A runtime version that a Node can be configured with. +message RuntimeVersion { + option (google.api.resource) = { + type: "tpu.googleapis.com/RuntimeVersion" + pattern: "projects/{project}/locations/{location}/runtimeVersions/{runtime_version}" + }; + + // The resource name. + string name = 1; + + // The runtime version. + string version = 2; +} + +// Request for [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion]. +message GetRuntimeVersionRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/RuntimeVersion" + } + ]; +} + +// Request for [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. +message ListRuntimeVersionsRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "tpu.googleapis.com/RuntimeVersion" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value returned from a previous List request, if any. + string page_token = 3; + + // List filter. + string filter = 5; + + // Sort results. + string order_by = 6; +} + +// Response for [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. +message ListRuntimeVersionsResponse { + // The listed nodes. + repeated RuntimeVersion runtime_versions = 1; + + // The next page token or empty if none. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Metadata describing an [Operation][google.longrunning.Operation] +message OperationMetadata { + // The time the operation was created. + google.protobuf.Timestamp create_time = 1; + + // The time the operation finished running. + google.protobuf.Timestamp end_time = 2; + + // Target of the operation - for example + // projects/project-1/connectivityTests/test-1 + string target = 3; + + // Name of the verb executed by the operation. + string verb = 4; + + // Human-readable status of the operation, if any. + string status_detail = 5; + + // Specifies if cancellation was requested for the operation. + bool cancel_requested = 6; + + // API version. + string api_version = 7; +} + +// A Symptom instance. +message Symptom { + // SymptomType represents the different types of Symptoms that a TPU can be + // at. + enum SymptomType { + // Unspecified symptom. + SYMPTOM_TYPE_UNSPECIFIED = 0; + + // TPU VM memory is low. + LOW_MEMORY = 1; + + // TPU runtime is out of memory. + OUT_OF_MEMORY = 2; + + // TPU runtime execution has timed out. + EXECUTE_TIMED_OUT = 3; + + // TPU runtime fails to construct a mesh that recognizes each TPU device's + // neighbors. + MESH_BUILD_FAIL = 4; + + // TPU HBM is out of memory. + HBM_OUT_OF_MEMORY = 5; + + // Abusive behaviors have been identified on the current project. + PROJECT_ABUSE = 6; + } + + // Timestamp when the Symptom is created. + google.protobuf.Timestamp create_time = 1; + + // Type of the Symptom. + SymptomType symptom_type = 2; + + // Detailed information of the current Symptom. + string details = 3; + + // A string used to uniquely distinguish a worker within a TPU node. + string worker_id = 4; +} + +// Request for [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. +message GetGuestAttributesRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/Node" + } + ]; + + // The guest attributes path to be queried. + string query_path = 2; + + // The 0-based worker ID. If it is empty, all workers' GuestAttributes will be + // returned. + repeated string worker_ids = 3; +} + +// Response for [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. +message GetGuestAttributesResponse { + // The guest attributes for the TPU workers. + repeated GuestAttributes guest_attributes = 1; +} + +// A set of Shielded Instance options. +message ShieldedInstanceConfig { + // Defines whether the instance has Secure Boot enabled. + bool enable_secure_boot = 1; +} diff --git a/google/cloud/tpu/v2/tpu_grpc_service_config.json b/google/cloud/tpu/v2/tpu_grpc_service_config.json new file mode 100644 index 000000000..9cd840fb4 --- /dev/null +++ b/google/cloud/tpu/v2/tpu_grpc_service_config.json @@ -0,0 +1,8 @@ +{ + "methodConfig": [{ + "name": [ + { "service": "google.cloud.tpu.v2.Tpu" } + ], + "timeout": "60s" + }] +} diff --git a/google/cloud/tpu/v2/tpu_v2.yaml b/google/cloud/tpu/v2/tpu_v2.yaml new file mode 100644 index 000000000..d86fa4ada --- /dev/null +++ b/google/cloud/tpu/v2/tpu_v2.yaml @@ -0,0 +1,90 @@ +type: google.api.Service +config_version: 3 +name: tpu.googleapis.com +title: Cloud TPU API + +apis: +- name: google.cloud.location.Locations +- name: google.cloud.tpu.v2.Tpu +- name: google.longrunning.Operations + +types: +- name: google.cloud.tpu.v2.OperationMetadata + +documentation: + summary: TPU API provides customers with access to Google TPU technology. + 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. + +backend: + rules: + - selector: google.cloud.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 + - selector: 'google.cloud.tpu.v2.Tpu.*' + deadline: 60.0 + - selector: 'google.longrunning.Operations.*' + deadline: 60.0 + +http: + rules: + - selector: google.cloud.location.Locations.GetLocation + get: '/v1alpha1/{name=projects/*/locations/*}' + additional_bindings: + - get: '/v1/{name=projects/*/locations/*}' + - get: '/v2alpha1/{name=projects/*/locations/*}' + - get: '/v2/{name=projects/*/locations/*}' + - selector: google.cloud.location.Locations.ListLocations + get: '/v1alpha1/{name=projects/*}/locations' + additional_bindings: + - get: '/v1/{name=projects/*}/locations' + - get: '/v2alpha1/{name=projects/*}/locations' + - get: '/v2/{name=projects/*}/locations' + - selector: google.longrunning.Operations.CancelOperation + post: '/v1alpha1/{name=projects/*/locations/*/operations/*}:cancel' + additional_bindings: + - post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' + - post: '/v2alpha1/{name=projects/*/locations/*/operations/*}:cancel' + - post: '/v2/{name=projects/*/locations/*/operations/*}:cancel' + - selector: google.longrunning.Operations.DeleteOperation + delete: '/v1alpha1/{name=projects/*/locations/*/operations/*}' + additional_bindings: + - delete: '/v1/{name=projects/*/locations/*/operations/*}' + - delete: '/v2alpha1/{name=projects/*/locations/*/operations/*}' + - delete: '/v2/{name=projects/*/locations/*/operations/*}' + - selector: google.longrunning.Operations.GetOperation + get: '/v1alpha1/{name=projects/*/locations/*/operations/*}' + additional_bindings: + - get: '/v1/{name=projects/*/locations/*/operations/*}' + - get: '/v2alpha1/{name=projects/*/locations/*/operations/*}' + - get: '/v2/{name=projects/*/locations/*/operations/*}' + - selector: google.longrunning.Operations.ListOperations + get: '/v1alpha1/{name=projects/*/locations/*}/operations' + additional_bindings: + - get: '/v1/{name=projects/*/locations/*}/operations' + - get: '/v2alpha1/{name=projects/*/locations/*}/operations' + - get: '/v2/{name=projects/*/locations/*}/operations' + +authentication: + rules: + - 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.cloud.tpu.v2.Tpu.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.longrunning.Operations.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform diff --git a/google/cloud/tpu/v2alpha1/BUILD.bazel b/google/cloud/tpu/v2alpha1/BUILD.bazel index d23e8b696..e8ae5dee2 100644 --- a/google/cloud/tpu/v2alpha1/BUILD.bazel +++ b/google/cloud/tpu/v2alpha1/BUILD.bazel @@ -29,6 +29,9 @@ proto_library( "//google/api:field_behavior_proto", "//google/api:resource_proto", "//google/longrunning:operations_proto", + "//google/rpc:status_proto", + "//google/type:interval_proto", + "@com_google_protobuf//:duration_proto", "@com_google_protobuf//:field_mask_proto", "@com_google_protobuf//:timestamp_proto", ], @@ -39,6 +42,7 @@ proto_library_with_info( deps = [ ":tpu_proto", "//google/cloud:common_resources_proto", + "//google/cloud/location:location_proto", ], ) @@ -70,13 +74,17 @@ java_gapic_library( srcs = [":tpu_proto_with_info"], gapic_yaml = None, grpc_service_config = "tpu_grpc_service_config.json", - service_yaml = "tpu.yaml", + rest_numeric_enums = True, + service_yaml = "tpu_v2alpha1.yaml", test_deps = [ ":tpu_java_grpc", + "//google/cloud/location:location_java_grpc", ], + transport = "grpc", deps = [ ":tpu_java_proto", "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", ], ) @@ -92,6 +100,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-tpu-v2alpha1-java", include_samples = True, + transport = "grpc", deps = [ ":tpu_java_gapic", ":tpu_java_grpc", @@ -119,6 +128,8 @@ go_proto_library( deps = [ "//google/api:annotations_go_proto", "//google/longrunning:longrunning_go_proto", + "//google/rpc:status_go_proto", + "//google/type:interval_go_proto", ], ) @@ -128,12 +139,16 @@ go_gapic_library( grpc_service_config = "tpu_grpc_service_config.json", importpath = "cloud.google.com/go/tpu/apiv2alpha1;tpu", metadata = True, - service_yaml = "tpu.yaml", + rest_numeric_enums = True, + service_yaml = "tpu_v2alpha1.yaml", + transport = "grpc", deps = [ ":tpu_go_proto", + "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -169,7 +184,10 @@ py_gapic_library( name = "tpu_py_gapic", srcs = [":tpu_proto"], grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", + deps = [ + ], ) py_test( @@ -216,7 +234,9 @@ php_gapic_library( name = "tpu_php_gapic", srcs = [":tpu_proto_with_info"], grpc_service_config = "tpu_grpc_service_config.json", - service_yaml = "tpu.yaml", + rest_numeric_enums = True, + service_yaml = "tpu_v2alpha1.yaml", + transport = "grpc+rest", deps = [ ":tpu_php_grpc", ":tpu_php_proto", @@ -249,7 +269,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "tpu_grpc_service_config.json", package = "google.cloud.tpu.v2alpha1", - service_yaml = "tpu.yaml", + rest_numeric_enums = True, + service_yaml = "tpu_v2alpha1.yaml", + transport = "grpc", deps = [], ) @@ -286,10 +308,9 @@ ruby_grpc_library( ruby_cloud_gapic_library( name = "tpu_ruby_gapic", srcs = [":tpu_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-tpu-v2alpha1", - ], + extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-tpu-v2alpha1"], grpc_service_config = "tpu_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":tpu_ruby_grpc", ":tpu_ruby_proto", @@ -333,7 +354,8 @@ csharp_gapic_library( srcs = [":tpu_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "tpu_grpc_service_config.json", - service_yaml = "tpu.yaml", + rest_numeric_enums = True, + service_yaml = "tpu_v2alpha1.yaml", deps = [ ":tpu_csharp_grpc", ":tpu_csharp_proto", @@ -353,4 +375,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "tpu_cc_proto", + deps = [":tpu_proto"], +) + +cc_grpc_library( + name = "tpu_cc_grpc", + srcs = [":tpu_proto"], + grpc_only = True, + deps = [":tpu_cc_proto"], +) diff --git a/google/cloud/tpu/v2alpha1/cloud_tpu.proto b/google/cloud/tpu/v2alpha1/cloud_tpu.proto index 612e1c4f5..dc179c818 100644 --- a/google/cloud/tpu/v2alpha1/cloud_tpu.proto +++ b/google/cloud/tpu/v2alpha1/cloud_tpu.proto @@ -21,8 +21,11 @@ import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/longrunning/operations.proto"; +import "google/protobuf/duration.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; +import "google/rpc/status.proto"; +import "google/type/interval.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/tpu/v2alpha1;tpu"; option java_multiple_files = true; @@ -73,7 +76,7 @@ service Tpu { }; option (google.api.method_signature) = "name"; option (google.longrunning.operation_info) = { - response_type: "Node" + response_type: "google.protobuf.Empty" metadata_type: "OperationMetadata" }; } @@ -115,6 +118,51 @@ service Tpu { }; } + // Lists queued resources. + rpc ListQueuedResources(ListQueuedResourcesRequest) + returns (ListQueuedResourcesResponse) { + option (google.api.http) = { + get: "/v2alpha1/{parent=projects/*/locations/*}/queuedResources" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a queued resource. + rpc GetQueuedResource(GetQueuedResourceRequest) returns (QueuedResource) { + option (google.api.http) = { + get: "/v2alpha1/{name=projects/*/locations/*/queuedResources/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a QueuedResource TPU instance. + rpc CreateQueuedResource(CreateQueuedResourceRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2alpha1/{parent=projects/*/locations/*}/queuedResources" + body: "queued_resource" + }; + option (google.api.method_signature) = + "parent,queued_resource,queued_resource_id"; + option (google.longrunning.operation_info) = { + response_type: "QueuedResource" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a QueuedResource TPU instance. + rpc DeleteQueuedResource(DeleteQueuedResourceRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v2alpha1/{name=projects/*/locations/*/queuedResources/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "QueuedResource" + metadata_type: "OperationMetadata" + }; + } + // Generates the Cloud TPU service identity for the project. rpc GenerateServiceIdentity(GenerateServiceIdentityRequest) returns (GenerateServiceIdentityResponse) { @@ -166,6 +214,19 @@ service Tpu { body: "*" }; } + + // Simulates a maintenance event. + rpc SimulateMaintenanceEvent(SimulateMaintenanceEventRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v2alpha1/{name=projects/*/locations/*/nodes/*}:simulateMaintenanceEvent" + body: "*" + }; + option (google.longrunning.operation_info) = { + response_type: "Node" + metadata_type: "OperationMetadata" + }; + } } // A guest attributes. @@ -266,6 +327,11 @@ message NetworkConfig { // workers. If set to false, the specified subnetwork or network should have // Private Google Access enabled. bool enable_external_ips = 3; + + // Allows the TPU node to send and receive packets with non-matching + // destination or source IPs. This is required if you plan to use the TPU + // workers to forward routes. + bool can_ip_forward = 4; } // A service account. @@ -307,7 +373,7 @@ message Node { DELETING = 5; // TPU node is being repaired and may be unusable. Details can be - // found in the `help_description` field. + // found in the 'help_description' field. REPAIRING = 6; // TPU node is stopped. @@ -380,8 +446,8 @@ message Node { // The user-supplied description of the TPU. Maximum of 512 characters. string description = 3; - // Required. The type of hardware accelerators associated with this node. - string accelerator_type = 5 [(google.api.field_behavior) = REQUIRED]; + // The type of hardware accelerators associated with this node. + string accelerator_type = 5; // Output only. The current state for the TPU Node. State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -449,16 +515,225 @@ message Node { // Output only. The Symptoms that have occurred to the TPU Node. repeated Symptom symptoms = 39 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The qualified name of the QueuedResource that requested this + // Node. + string queued_resource = 43 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Shielded Instance options. ShieldedInstanceConfig shielded_instance_config = 45; } +// A QueuedResource represents a request for resources that will be placed +// in a queue and fulfilled when the necessary resources are available. +message QueuedResource { + option (google.api.resource) = { + type: "tpu.googleapis.com/QueuedResource" + pattern: "projects/{project}/locations/{location}/queuedResources/{queued_resource}" + }; + + // Details of the TPU resource(s) being requested. + message Tpu { + // Details of the TPU node(s) being requested. Users can request either a + // single node or multiple nodes. + // NodeSpec provides the specification for node(s) to be created. + message NodeSpec { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` + // regex format. This is only specified when requesting a single node. + // In case of multi-node requests, multi_node_params must be populated + // instead. It's an error to specify both node_id and multi_node_params. + string node_id = 2; + + // Required. The node. + Node node = 3 [(google.api.field_behavior) = REQUIRED]; + } + + // The TPU node(s) being requested. + repeated NodeSpec node_spec = 1; + } + + // BestEffort tier definition. + message BestEffort {} + + // Guaranteed tier definition. + message Guaranteed { + // Optional. Defines the minimum duration of the guarantee. If specified, + // the requested resources will only be provisioned if they can be + // allocated for at least the given duration. + google.protobuf.Duration min_duration = 1 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Specifies the request should be scheduled on reserved capacity. + bool reserved = 2 [(google.api.field_behavior) = OPTIONAL]; + } + + // Defines the policy of the QueuedRequest. + message QueueingPolicy { + // Time flexibility specification. + oneof start_timing_constraints { + // A relative time after which resources should not be created. + // If the request cannot be fulfilled by this time the request will be + // failed. + google.protobuf.Duration valid_until_duration = 1; + + // An absolute time after which resources should not be created. + // If the request cannot be fulfilled by this time the request will be + // failed. + google.protobuf.Timestamp valid_until_time = 2; + + // A relative time after which resources may be created. + google.protobuf.Duration valid_after_duration = 3; + + // An absolute time at which resources may be created. + google.protobuf.Timestamp valid_after_time = 4; + + // An absolute time interval within which resources may be created. + google.type.Interval valid_interval = 5; + } + } + + // Output only. Immutable. The name of the QueuedResource. + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Resource specification. + oneof resource { + // Defines a TPU resource. + Tpu tpu = 2; + } + + // Tier specifies the required tier. + oneof tier { + // The BestEffort tier. + BestEffort best_effort = 3; + + // The Guaranteed tier + Guaranteed guaranteed = 4; + } + + // The queueing policy of the QueuedRequest. + QueueingPolicy queueing_policy = 5; + + // Output only. State of the QueuedResource request + QueuedResourceState state = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// QueuedResourceState defines the details of the QueuedResource request. +message QueuedResourceState { + // Output only state of the request + enum State { + // State of the QueuedResource request is not known/set. + STATE_UNSPECIFIED = 0; + + // The QueuedResource request has been received. We're still working on + // determining if we will be able to honor this request. + CREATING = 1; + + // The QueuedResource request has passed initial validation/admission + // control and has been persisted in the queue. + ACCEPTED = 2; + + // The QueuedResource request has been selected. The + // associated resources are currently being provisioned (or very soon + // will begin provisioning). + PROVISIONING = 3; + + // The request could not be completed. This may be due to some + // late-discovered problem with the request itself, or due to + // unavailability of resources within the constraints of the request + // (e.g., the 'valid until' start timing constraint expired). + FAILED = 4; + + // The QueuedResource is being deleted. + DELETING = 5; + + // The resources specified in the QueuedResource request have been + // provisioned and are ready for use by the end-user/consumer. + ACTIVE = 6; + + // The resources specified in the QueuedResource request are being + // deleted. This may have been initiated by the user, or + // the Cloud TPU service. Inspect the state data for more details. + SUSPENDING = 7; + + // The resources specified in the QueuedResource request have been + // deleted. + SUSPENDED = 8; + } + + // Further data for the creating state. + message CreatingData {} + + // Further data for the accepted state. + message AcceptedData {} + + // Further data for the provisioning state. + message ProvisioningData {} + + // Further data for the failed state. + message FailedData { + // The error that caused the queued resource to enter the FAILED state. + google.rpc.Status error = 1; + } + + // Further data for the deleting state. + message DeletingData {} + + // Further data for the active state. + message ActiveData {} + + // Further data for the suspending state. + message SuspendingData {} + + // Further data for the suspended state. + message SuspendedData {} + + // State of the QueuedResource request. + State state = 1; + + // Further data for the state. + oneof state_data { + // Further data for the creating state. + CreatingData creating_data = 2; + + // Further data for the accepted state. + AcceptedData accepted_data = 3; + + // Further data for the provisioning state. + ProvisioningData provisioning_data = 4; + + // Further data for the failed state. + FailedData failed_data = 5; + + // Further data for the deleting state. + DeletingData deleting_data = 6; + + // Further data for the active state. + ActiveData active_data = 7; + + // Further data for the suspending state. + SuspendingData suspending_data = 8; + + // Further data for the suspended state. + SuspendedData suspended_data = 9; + } +} + // Request for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. message ListNodesRequest { // Required. The parent resource name. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { type: "tpu.googleapis.com/Node" } + (google.api.resource_reference) = { child_type: "tpu.googleapis.com/Node" } ]; // The maximum number of items to return. @@ -504,6 +779,9 @@ message CreateNodeRequest { // Required. The node. Node node = 3 [(google.api.field_behavior) = REQUIRED]; + + // Idempotent request UUID. + string request_id = 6; } // Request for [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode]. @@ -513,24 +791,34 @@ message DeleteNodeRequest { (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "tpu.googleapis.com/Node" } ]; + + // Idempotent request UUID. + string request_id = 3; } // Request for [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode]. message StopNodeRequest { - // The resource name. - string name = 1; + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { type: "tpu.googleapis.com/Node" } + ]; } // Request for [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode]. message StartNodeRequest { - // The resource name. - string name = 1; + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { type: "tpu.googleapis.com/Node" } + ]; } // Request for [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode]. message UpdateNodeRequest { // Required. Mask of fields from [Node][Tpu.Node] to update. - // Supported fields: None. + // Supported fields: [description, tags, labels, metadata, + // network_config.enable_external_ips]. google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; @@ -538,6 +826,86 @@ message UpdateNodeRequest { Node node = 2 [(google.api.field_behavior) = REQUIRED]; } +// Request for +// [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. +message ListQueuedResourcesRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "tpu.googleapis.com/QueuedResource" + } + ]; + + // The maximum number of items to return. + int32 page_size = 2; + + // The next_page_token value returned from a previous List request, if any. + string page_token = 3; +} + +// Response for +// [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. +message ListQueuedResourcesResponse { + // The listed queued resources. + repeated QueuedResource queued_resources = 1; + + // The next page token or empty if none. + string next_page_token = 2; + + // Locations that could not be reached. + repeated string unreachable = 3; +} + +// Request for +// [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource] +message GetQueuedResourceRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/QueuedResource" + } + ]; +} + +// Request for +// [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource]. +message CreateQueuedResourceRequest { + // Required. The parent resource name. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` + // regex format. + string queued_resource_id = 2; + + // Required. The queued resource. + QueuedResource queued_resource = 3 [(google.api.field_behavior) = REQUIRED]; + + // Idempotent request UUID. + string request_id = 4; +} + +// Request for +// [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource]. +message DeleteQueuedResourceRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "tpu.googleapis.com/QueuedResource" + } + ]; + + // Idempotent request UUID. + string request_id = 2; +} + // The per-product per-project service identity for Cloud TPU service. message ServiceIdentity { // The email address of the service identity. @@ -573,7 +941,7 @@ message AcceleratorType { // The resource name. string name = 1; - // the accelerator type. + // The accelerator type. string type = 2; } @@ -596,7 +964,7 @@ message ListAcceleratorTypesRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "tpu.googleapis.com/AcceleratorType" + child_type: "tpu.googleapis.com/AcceleratorType" } ]; @@ -626,36 +994,6 @@ message ListAcceleratorTypesResponse { repeated string unreachable = 3; } -// Note: the following OperationMetadata message was added manually. -// This is caused by a conflict with some other message and will -// be resolved separately. Please make sure to add this message back -// if it's removed during public proto regeneration. - -// Metadata describing an [Operation][google.longrunning.Operation] -message OperationMetadata { - // The time the operation was created. - google.protobuf.Timestamp create_time = 1; - - // The time the operation finished running. - google.protobuf.Timestamp end_time = 2; - - // Target of the operation - for example - // projects/project-1/connectivityTests/test-1 - string target = 3; - - // Name of the verb executed by the operation. - string verb = 4; - - // Human-readable status of the operation, if any. - string status_detail = 5; - - // Specifies if cancellation was requested for the operation. - bool cancel_requested = 6; - - // API version. - string api_version = 7; -} - // A runtime version that a Node can be configured with. message RuntimeVersion { option (google.api.resource) = { @@ -689,7 +1027,7 @@ message ListRuntimeVersionsRequest { string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { - type: "tpu.googleapis.com/RuntimeVersion" + child_type: "tpu.googleapis.com/RuntimeVersion" } ]; @@ -719,6 +1057,31 @@ message ListRuntimeVersionsResponse { repeated string unreachable = 3; } +// Metadata describing an [Operation][google.longrunning.Operation] +message OperationMetadata { + // The time the operation was created. + google.protobuf.Timestamp create_time = 1; + + // The time the operation finished running. + google.protobuf.Timestamp end_time = 2; + + // Target of the operation - for example + // projects/project-1/connectivityTests/test-1 + string target = 3; + + // Name of the verb executed by the operation. + string verb = 4; + + // Human-readable status of the operation, if any. + string status_detail = 5; + + // Specifies if cancellation was requested for the operation. + bool cancel_requested = 6; + + // API version. + string api_version = 7; +} + // A Symptom instance. message Symptom { // SymptomType represents the different types of Symptoms that a TPU can be @@ -784,8 +1147,24 @@ message GetGuestAttributesResponse { repeated GuestAttributes guest_attributes = 1; } +// Request for +// [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent]. +message SimulateMaintenanceEventRequest { + // Required. The resource name. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { type: "tpu.googleapis.com/Node" } + ]; + + // The 0-based worker ID. If it is empty, worker ID 0 will be selected for + // maintenance event simulation. A maintenance event will only be fired on the + // first specified worker ID. Future implementations may support firing on + // multiple workers. + repeated string worker_ids = 2; +} + // A set of Shielded Instance options. message ShieldedInstanceConfig { // Defines whether the instance has Secure Boot enabled. bool enable_secure_boot = 1; -} \ No newline at end of file +} diff --git a/google/cloud/tpu/v2alpha1/tpu.yaml b/google/cloud/tpu/v2alpha1/tpu_v2alpha1.yaml similarity index 86% rename from google/cloud/tpu/v2alpha1/tpu.yaml rename to google/cloud/tpu/v2alpha1/tpu_v2alpha1.yaml index 4ac26a8ec..c05df1746 100644 --- a/google/cloud/tpu/v2alpha1/tpu.yaml +++ b/google/cloud/tpu/v2alpha1/tpu_v2alpha1.yaml @@ -4,10 +4,12 @@ name: tpu.googleapis.com title: Cloud TPU API apis: +- name: google.cloud.location.Locations - name: google.cloud.tpu.v2alpha1.Tpu +- name: google.longrunning.Operations types: -- name: google.cloud.tpu.v1.OperationMetadata +- name: google.cloud.tpu.v2alpha1.OperationMetadata documentation: summary: TPU API provides customers with access to Google TPU technology. @@ -36,31 +38,37 @@ http: additional_bindings: - get: '/v1/{name=projects/*/locations/*}' - get: '/v2alpha1/{name=projects/*/locations/*}' + - get: '/v2/{name=projects/*/locations/*}' - selector: google.cloud.location.Locations.ListLocations get: '/v1alpha1/{name=projects/*}/locations' additional_bindings: - get: '/v1/{name=projects/*}/locations' - get: '/v2alpha1/{name=projects/*}/locations' + - get: '/v2/{name=projects/*}/locations' - selector: google.longrunning.Operations.CancelOperation post: '/v1alpha1/{name=projects/*/locations/*/operations/*}:cancel' additional_bindings: - post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' - post: '/v2alpha1/{name=projects/*/locations/*/operations/*}:cancel' + - post: '/v2/{name=projects/*/locations/*/operations/*}:cancel' - selector: google.longrunning.Operations.DeleteOperation delete: '/v1alpha1/{name=projects/*/locations/*/operations/*}' additional_bindings: - delete: '/v1/{name=projects/*/locations/*/operations/*}' - delete: '/v2alpha1/{name=projects/*/locations/*/operations/*}' + - delete: '/v2/{name=projects/*/locations/*/operations/*}' - selector: google.longrunning.Operations.GetOperation get: '/v1alpha1/{name=projects/*/locations/*/operations/*}' additional_bindings: - get: '/v1/{name=projects/*/locations/*/operations/*}' - get: '/v2alpha1/{name=projects/*/locations/*/operations/*}' + - get: '/v2/{name=projects/*/locations/*/operations/*}' - selector: google.longrunning.Operations.ListOperations get: '/v1alpha1/{name=projects/*/locations/*}/operations' additional_bindings: - get: '/v1/{name=projects/*/locations/*}/operations' - get: '/v2alpha1/{name=projects/*/locations/*}/operations' + - get: '/v2/{name=projects/*/locations/*}/operations' authentication: rules: diff --git a/google/cloud/translate/v3/BUILD.bazel b/google/cloud/translate/v3/BUILD.bazel index ef0b22293..16abace89 100644 --- a/google/cloud/translate/v3/BUILD.bazel +++ b/google/cloud/translate/v3/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":translation_proto_with_info"], gapic_yaml = None, grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3.yaml", test_deps = [ ":translation_java_grpc", @@ -139,14 +140,15 @@ go_gapic_library( grpc_service_config = "translate_grpc_service_config.json", importpath = "cloud.google.com/go/translate/apiv3;translate", metadata = True, + rest_numeric_enums = True, service_yaml = "translate_v3.yaml", transport = "grpc+rest", deps = [ ":translation_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -183,6 +185,7 @@ py_gapic_library( srcs = [":translation_proto"], grpc_service_config = "translate_grpc_service_config.json", opt_args = ["python-gapic-name=translate"], + rest_numeric_enums = True, transport = "grpc", ) @@ -230,7 +233,9 @@ php_gapic_library( name = "translation_php_gapic", srcs = [":translation_proto_with_info"], grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3.yaml", + transport = "grpc+rest", deps = [ ":translation_php_grpc", ":translation_php_proto", @@ -263,7 +268,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "translate_grpc_service_config.json", package = "google.cloud.translation.v3", + rest_numeric_enums = True, service_yaml = "translate_v3.yaml", + transport = "grpc+rest", deps = [], ) @@ -308,6 +315,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/translate", ], grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Translation can dynamically translate text between thousands of language pairs. Translation lets websites and programs programmatically integrate with the translation service.", ruby_cloud_title = "Cloud Translation V3", deps = [ @@ -353,6 +361,7 @@ csharp_gapic_library( srcs = [":translation_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3.yaml", deps = [ ":translation_csharp_grpc", diff --git a/google/cloud/translate/v3/translation_service.proto b/google/cloud/translate/v3/translation_service.proto index 4ea17dadd..c0203c93f 100644 --- a/google/cloud/translate/v3/translation_service.proto +++ b/google/cloud/translate/v3/translation_service.proto @@ -545,7 +545,7 @@ message OutputConfig { // (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) // // The format of translations_file (for target language code 'trg') is: - // gs://translation_test/a_b_c_'trg'_translations.[extension] + // `gs://translation_test/a_b_c_'trg'_translations.[extension]` // // If the input file extension is tsv, the output has the following // columns: diff --git a/google/cloud/translate/v3beta1/BUILD.bazel b/google/cloud/translate/v3beta1/BUILD.bazel index a141fcfe8..1b577dfb3 100644 --- a/google/cloud/translate/v3beta1/BUILD.bazel +++ b/google/cloud/translate/v3beta1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":translation_proto_with_info"], gapic_yaml = None, grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3beta1.yaml", test_deps = [ ":translation_java_grpc", @@ -138,14 +139,15 @@ go_gapic_library( grpc_service_config = "translate_grpc_service_config.json", importpath = "cloud.google.com/go/translate/apiv3beta1;translate", metadata = True, + rest_numeric_enums = True, service_yaml = "translate_v3beta1.yaml", transport = "grpc+rest", deps = [ ":translation_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -182,6 +184,7 @@ py_gapic_library( srcs = [":translation_proto"], grpc_service_config = "translate_grpc_service_config.json", opt_args = ["python-gapic-name=translate"], + rest_numeric_enums = True, transport = "grpc", ) @@ -229,7 +232,9 @@ php_gapic_library( name = "translation_php_gapic", srcs = [":translation_proto_with_info"], grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3beta1.yaml", + transport = "grpc+rest", deps = [ ":translation_php_grpc", ":translation_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "translate_grpc_service_config.json", package = "google.cloud.translation.v3beta1", + rest_numeric_enums = True, service_yaml = "translate_v3beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( srcs = [":translation_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-translation-v3beta1"], grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":translation_ruby_grpc", ":translation_ruby_proto", @@ -344,6 +352,7 @@ csharp_gapic_library( srcs = [":translation_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "translate_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "translate_v3beta1.yaml", deps = [ ":translation_csharp_grpc", diff --git a/google/cloud/translate/v3beta1/translation_service.proto b/google/cloud/translate/v3beta1/translation_service.proto index 05ad079fd..076261452 100644 --- a/google/cloud/translate/v3beta1/translation_service.proto +++ b/google/cloud/translate/v3beta1/translation_service.proto @@ -535,7 +535,7 @@ message OutputConfig { // (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) // // The format of translations_file (for target language code 'trg') is: - // gs://translation_test/a_b_c_'trg'_translations.[extension] + // `gs://translation_test/a_b_c_'trg'_translations.[extension]` // // If the input file extension is tsv, the output has the following // columns: diff --git a/google/cloud/v1beta1/cloudscheduler_grpc_service_config.json b/google/cloud/v1beta1/cloudscheduler_grpc_service_config.json new file mode 100644 index 000000000..547377650 --- /dev/null +++ b/google/cloud/v1beta1/cloudscheduler_grpc_service_config.json @@ -0,0 +1,55 @@ +{ + "methodConfig": [ + { + "name": [ + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "ListJobs" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "GetJob" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "DeleteJob" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "PauseJob" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "ResumeJob" + } + ], + "timeout": "600s", + "retryPolicy": { + "initialBackoff": "0.100s", + "maxBackoff": "60s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": [ + "DEADLINE_EXCEEDED", + "UNAVAILABLE" + ] + } + }, + { + "name": [ + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "CreateJob" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "UpdateJob" + }, + { + "service": "google.cloud.scheduler.v1beta1.CloudScheduler", + "method": "RunJob" + } + ], + "timeout": "600s" + } + ] +} diff --git a/google/cloud/video/livestream/v1/BUILD.bazel b/google/cloud/video/livestream/v1/BUILD.bazel index d54d33b1a..67d3d6053 100644 --- a/google/cloud/video/livestream/v1/BUILD.bazel +++ b/google/cloud/video/livestream/v1/BUILD.bazel @@ -75,6 +75,7 @@ java_gapic_library( srcs = [":livestream_proto_with_info"], gapic_yaml = None, grpc_service_config = "livestream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "livestream_v1.yaml", test_deps = [ ":livestream_java_grpc", @@ -137,13 +138,14 @@ go_gapic_library( grpc_service_config = "livestream_grpc_service_config.json", importpath = "cloud.google.com/go/video/livestream/apiv1;livestream", metadata = True, + rest_numeric_enums = True, service_yaml = "livestream_v1.yaml", transport = "grpc+rest", deps = [ ":livestream_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -185,6 +187,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud.video", "python-gapic-name=live_stream", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -232,7 +235,9 @@ php_gapic_library( name = "livestream_php_gapic", srcs = [":livestream_proto_with_info"], grpc_service_config = "livestream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "livestream_v1.yaml", + transport = "grpc+rest", deps = [ ":livestream_php_grpc", ":livestream_php_proto", @@ -265,7 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "livestream_grpc_service_config.json", package = "google.cloud.video.livestream.v1", + rest_numeric_enums = True, service_yaml = "livestream_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -309,6 +316,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/livestream/", ], grpc_service_config = "livestream_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Live Stream API transcodes mezzanine live signals into direct-to-consumer streaming formats, including Dynamic Adaptive Streaming over HTTP (DASH/MPEG-DASH), and HTTP Live Streaming (HLS), for multiple device platforms.", ruby_cloud_title = "Live Stream V1", deps = [ @@ -354,6 +362,7 @@ csharp_gapic_library( srcs = [":livestream_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "livestream_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "livestream_v1.yaml", deps = [ ":livestream_csharp_grpc", diff --git a/google/cloud/video/stitcher/v1/BUILD.bazel b/google/cloud/video/stitcher/v1/BUILD.bazel index 99669a17a..56a5d8e52 100644 --- a/google/cloud/video/stitcher/v1/BUILD.bazel +++ b/google/cloud/video/stitcher/v1/BUILD.bazel @@ -78,10 +78,12 @@ java_gapic_library( srcs = [":stitcher_proto_with_info"], gapic_yaml = None, grpc_service_config = "videostitcher_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", test_deps = [ ":stitcher_java_grpc", ], + transport = "grpc", deps = [ ":stitcher_java_proto", "//google/api:api_java_proto", @@ -100,6 +102,7 @@ java_gapic_test( java_gapic_assembly_gradle_pkg( name = "google-cloud-video-stitcher-v1-java", include_samples = True, + transport = "grpc", deps = [ ":stitcher_java_gapic", ":stitcher_java_grpc", @@ -135,7 +138,9 @@ go_gapic_library( grpc_service_config = "videostitcher_grpc_service_config.json", importpath = "cloud.google.com/go/video/stitcher/apiv1;stitcher", metadata = True, + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", + transport = "grpc", deps = [ ":stitcher_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", @@ -174,8 +179,9 @@ py_gapic_library( name = "stitcher_py_gapic", srcs = [":stitcher_proto"], grpc_service_config = "videostitcher_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", - transport = "grpc+rest", + transport = "grpc", ) py_test( @@ -222,7 +228,9 @@ php_gapic_library( name = "stitcher_php_gapic", srcs = [":stitcher_proto_with_info"], grpc_service_config = "videostitcher_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", + transport = "grpc+rest", deps = [ ":stitcher_php_grpc", ":stitcher_php_proto", @@ -255,7 +263,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "videostitcher_grpc_service_config.json", package = "google.cloud.video.stitcher.v1", + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", + transport = "grpc", deps = [], ) @@ -299,6 +309,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/video-stitcher/", ], grpc_service_config = "videostitcher_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Video Stitcher API allows you to manipulate video content to dynamically insert ads prior to delivery to client devices. Using the Video Stitcher API, you can monetize your video-on-demand (VOD) and livestreaming videos by inserting ads as described by metadata stored on ad servers.", ruby_cloud_title = "Video Stitcher V1", deps = [ @@ -344,6 +355,7 @@ csharp_gapic_library( srcs = [":stitcher_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videostitcher_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "videostitcher_v1.yaml", deps = [ ":stitcher_csharp_grpc", diff --git a/google/cloud/video/stitcher/v1/cdn_keys.proto b/google/cloud/video/stitcher/v1/cdn_keys.proto index 254f415f8..c4835c5a6 100644 --- a/google/cloud/video/stitcher/v1/cdn_keys.proto +++ b/google/cloud/video/stitcher/v1/cdn_keys.proto @@ -40,6 +40,9 @@ message CdnKey { // The configuration for an Akamai CDN key. AkamaiCdnKey akamai_cdn_key = 6; + + // The configuration for a Media CDN key. + MediaCdnKey media_cdn_key = 8; } // The resource name of the CDN key, in the form of @@ -65,3 +68,12 @@ message AkamaiCdnKey { // Input only. Token key for the Akamai CDN edge configuration. bytes token_key = 1 [(google.api.field_behavior) = INPUT_ONLY]; } + +// Configuration for a Media CDN key. +message MediaCdnKey { + // Input only. 64-byte ed25519 private key for this Media CDN key. + bytes private_key = 1 [(google.api.field_behavior) = INPUT_ONLY]; + + // The keyset name of the Media CDN key. + string key_name = 2; +} diff --git a/google/cloud/video/transcoder/v1/BUILD.bazel b/google/cloud/video/transcoder/v1/BUILD.bazel index 893703f84..3e8afdd6e 100644 --- a/google/cloud/video/transcoder/v1/BUILD.bazel +++ b/google/cloud/video/transcoder/v1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "transcoder_java_gapic", srcs = [":transcoder_proto_with_info"], grpc_service_config = "transcoder_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":transcoder_java_grpc", ], @@ -130,6 +131,7 @@ go_gapic_library( grpc_service_config = "transcoder_grpc_service_config.json", importpath = "cloud.google.com/go/video/transcoder/apiv1;transcoder", metadata = True, + rest_numeric_enums = True, service_yaml = "transcoder_v1.yaml", transport = "grpc+rest", deps = [ @@ -170,6 +172,7 @@ py_gapic_library( name = "transcoder_py_gapic", srcs = [":transcoder_proto"], grpc_service_config = "transcoder_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -217,7 +220,9 @@ php_gapic_library( name = "transcoder_php_gapic", srcs = [":transcoder_proto_with_info"], grpc_service_config = "transcoder_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "transcoder_v1.yaml", + transport = "grpc+rest", deps = [ ":transcoder_php_grpc", ":transcoder_php_proto", @@ -250,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "transcoder_grpc_service_config.json", package = "google.cloud.video.transcoder.v1", + rest_numeric_enums = True, service_yaml = "transcoder_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -295,6 +302,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/transcoder/", ], grpc_service_config = "transcoder_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Transcoder API allows you to convert video files and package them for optimized delivery to web, mobile and connected TVs.", ruby_cloud_title = "Transcoder V1", deps = [ @@ -340,6 +348,7 @@ csharp_gapic_library( srcs = [":transcoder_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "transcoder_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "transcoder_v1.yaml", deps = [ ":transcoder_csharp_grpc", diff --git a/google/cloud/video/transcoder/v1/resources.proto b/google/cloud/video/transcoder/v1/resources.proto index ce3824ba4..08508ec87 100644 --- a/google/cloud/video/transcoder/v1/resources.proto +++ b/google/cloud/video/transcoder/v1/resources.proto @@ -335,12 +335,22 @@ message SpriteSheet { // source aspect ratio, set the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field or // the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field, but not both (the API will // automatically calculate the missing field). + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the width, in pixels, per the horizontal ASR. The API calculates + // the height per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 sprite_width_pixels = 3 [(google.api.field_behavior) = REQUIRED]; // Required. The height of sprite in pixels. Must be an even integer. To preserve the // source aspect ratio, set the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field or // the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field, but not both (the API will // automatically calculate the missing field). + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the height, in pixels, per the horizontal ASR. The API calculates + // the width per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 sprite_height_pixels = 4 [(google.api.field_behavior) = REQUIRED]; // The maximum number of sprites per row in a sprite sheet. The default is 0, @@ -594,6 +604,70 @@ message PreprocessingConfig { int32 right_pixels = 4; } + // Deinterlace configuration for input video. + message Deinterlace { + // Yet Another Deinterlacing Filter Configuration. + message YadifConfig { + // Specifies the deinterlacing mode to adopt. + // The default is `send_frame`. + // Supported values: + // + // - `send_frame`: Output one frame for each frame + // - `send_field`: Output one frame for each field + string mode = 1; + + // Disable spacial interlacing. + // The default is `false`. + bool disable_spatial_interlacing = 2; + + // The picture field parity assumed for the input interlaced video. + // The default is `auto`. + // Supported values: + // + // - `tff`: Assume the top field is first + // - `bff`: Assume the bottom field is first + // - `auto`: Enable automatic detection of field parity + string parity = 3; + + // Deinterlace all frames rather than just the frames identified as + // interlaced. The default is `false`. + bool deinterlace_all_frames = 4; + } + + // Bob Weaver Deinterlacing Filter Configuration. + message BwdifConfig { + // Specifies the deinterlacing mode to adopt. + // The default is `send_frame`. + // Supported values: + // + // - `send_frame`: Output one frame for each frame + // - `send_field`: Output one frame for each field + string mode = 1; + + // The picture field parity assumed for the input interlaced video. + // The default is `auto`. + // Supported values: + // + // - `tff`: Assume the top field is first + // - `bff`: Assume the bottom field is first + // - `auto`: Enable automatic detection of field parity + string parity = 2; + + // Deinterlace all frames rather than just the frames identified as + // interlaced. The default is `false`. + bool deinterlace_all_frames = 3; + } + + // Specify the video deinterlacing filter. The default is `yadif`. + oneof deinterlacing_filter { + // Specifies the Yet Another Deinterlacing Filter Configuration. + YadifConfig yadif = 1; + + // Specifies the Bob Weaver Deinterlacing Filter Configuration. + BwdifConfig bwdif = 2; + } + } + // Color preprocessing configuration. Color color = 1; @@ -611,6 +685,9 @@ message PreprocessingConfig { // Specify the video pad filter configuration. Pad pad = 6; + + // Specify the video deinterlace configuration. + Deinterlace deinterlace = 7; } // Video stream resource. @@ -620,11 +697,21 @@ message VideoStream { // The width of the video in pixels. Must be an even integer. // When not specified, the width is adjusted to match the specified height // and input aspect ratio. If both are omitted, the input width is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the width, in pixels, per the horizontal ASR. The API calculates + // the height per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 width_pixels = 1; // The height of the video in pixels. Must be an even integer. // When not specified, the height is adjusted to match the specified width // and input aspect ratio. If both are omitted, the input height is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the height, in pixels, per the horizontal ASR. The API calculates + // the width per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 height_pixels = 2; // Required. The target video frame rate in frames per second (FPS). Must be less than @@ -755,11 +842,21 @@ message VideoStream { // The width of the video in pixels. Must be an even integer. // When not specified, the width is adjusted to match the specified height // and input aspect ratio. If both are omitted, the input width is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the width, in pixels, per the horizontal ASR. The API calculates + // the height per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 width_pixels = 1; // The height of the video in pixels. Must be an even integer. // When not specified, the height is adjusted to match the specified width // and input aspect ratio. If both are omitted, the input height is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the height, in pixels, per the horizontal ASR. The API calculates + // the width per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 height_pixels = 2; // Required. The target video frame rate in frames per second (FPS). Must be less than @@ -897,11 +994,21 @@ message VideoStream { // The width of the video in pixels. Must be an even integer. // When not specified, the width is adjusted to match the specified height // and input aspect ratio. If both are omitted, the input width is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the width, in pixels, per the horizontal ASR. The API calculates + // the height per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 width_pixels = 1; // The height of the video in pixels. Must be an even integer. // When not specified, the height is adjusted to match the specified width // and input aspect ratio. If both are omitted, the input height is used. + // + // For portrait videos that contain horizontal ASR and rotation metadata, + // provide the height, in pixels, per the horizontal ASR. The API calculates + // the width per the horizontal ASR. The API detects any rotation metadata + // and swaps the requested height and width for the output. int32 height_pixels = 2; // Required. The target video frame rate in frames per second (FPS). Must be less than diff --git a/google/cloud/video/transcoder/v1/transcoder_v1.yaml b/google/cloud/video/transcoder/v1/transcoder_v1.yaml index 6d813cda9..2c7cb00de 100644 --- a/google/cloud/video/transcoder/v1/transcoder_v1.yaml +++ b/google/cloud/video/transcoder/v1/transcoder_v1.yaml @@ -9,7 +9,9 @@ apis: documentation: summary: |- This API converts video files into formats suitable for consumer - distribution. + distribution. For more information, see the Transcoder + API overview. backend: rules: diff --git a/google/cloud/videointelligence/v1/BUILD.bazel b/google/cloud/videointelligence/v1/BUILD.bazel index b29e40e01..01145cf81 100644 --- a/google/cloud/videointelligence/v1/BUILD.bazel +++ b/google/cloud/videointelligence/v1/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":videointelligence_java_grpc", ], @@ -120,13 +121,14 @@ go_gapic_library( srcs = [":videointelligence_proto_with_info"], grpc_service_config = "videointelligence_grpc_service_config.json", importpath = "cloud.google.com/go/videointelligence/apiv1;videointelligence", + rest_numeric_enums = True, service_yaml = "videointelligence_v1.yaml", transport = "grpc+rest", deps = [ ":videointelligence_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -162,6 +164,7 @@ py_gapic_library( name = "videointelligence_py_gapic", srcs = [":videointelligence_proto"], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -209,7 +212,9 @@ php_gapic_library( srcs = [":videointelligence_proto_with_info"], # Do not change this to the videointelligence_gapic.yaml, see tracking bug. gapic_yaml = "videointelligence_gapic.legacy.yaml", + rest_numeric_enums = True, service_yaml = "videointelligence_v1.yaml", + transport = "grpc+rest", deps = [ ":videointelligence_php_grpc", ":videointelligence_php_proto", @@ -243,7 +248,9 @@ nodejs_gapic_library( grpc_service_config = "videointelligence_grpc_service_config.json", main_service = "videointelligence", package = "google.cloud.videointelligence.v1", + rest_numeric_enums = True, service_yaml = "videointelligence_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -288,6 +295,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=videointelligence", ], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", ruby_cloud_title = "Cloud Video Intelligence V1", deps = [ @@ -333,6 +341,7 @@ csharp_gapic_library( srcs = [":videointelligence_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "videointelligence_v1.yaml", deps = [ ":videointelligence_csharp_grpc", diff --git a/google/cloud/videointelligence/v1beta2/BUILD.bazel b/google/cloud/videointelligence/v1beta2/BUILD.bazel index 0acc55229..5fb5b3855 100644 --- a/google/cloud/videointelligence/v1beta2/BUILD.bazel +++ b/google/cloud/videointelligence/v1beta2/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":videointelligence_java_grpc", ], @@ -120,13 +121,14 @@ go_gapic_library( srcs = [":videointelligence_proto_with_info"], grpc_service_config = "videointelligence_grpc_service_config.json", importpath = "cloud.google.com/go/videointelligence/apiv1beta2;videointelligence", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1beta2.yaml", transport = "grpc+rest", deps = [ ":videointelligence_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -162,6 +164,7 @@ py_gapic_library( name = "videointelligence_py_gapic", srcs = [":videointelligence_proto"], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -208,7 +211,9 @@ php_gapic_library( name = "videointelligence_php_gapic", srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1beta2.yaml", + transport = "grpc+rest", deps = [ ":videointelligence_php_grpc", ":videointelligence_php_proto", @@ -242,7 +247,9 @@ nodejs_gapic_library( grpc_service_config = "videointelligence_grpc_service_config.json", main_service = "videointelligence", package = "google.cloud.videointelligence.v1beta2", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1beta2.yaml", + transport = "grpc+rest", deps = [], ) @@ -287,6 +294,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=videointelligence", ], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", ruby_cloud_title = "Cloud Video Intelligence V1beta2", deps = [ @@ -332,6 +340,7 @@ csharp_gapic_library( srcs = [":videointelligence_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":videointelligence_csharp_grpc", ":videointelligence_csharp_proto", diff --git a/google/cloud/videointelligence/v1p1beta1/BUILD.bazel b/google/cloud/videointelligence/v1p1beta1/BUILD.bazel index 7c677c989..606902717 100644 --- a/google/cloud/videointelligence/v1p1beta1/BUILD.bazel +++ b/google/cloud/videointelligence/v1p1beta1/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":videointelligence_java_grpc", ], @@ -120,13 +121,14 @@ go_gapic_library( srcs = [":videointelligence_proto_with_info"], grpc_service_config = "videointelligence_grpc_service_config.json", importpath = "cloud.google.com/go/videointelligence/apiv1p1beta1;videointelligence", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p1beta1.yaml", transport = "grpc+rest", deps = [ ":videointelligence_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -162,6 +164,7 @@ py_gapic_library( name = "videointelligence_py_gapic", srcs = [":videointelligence_proto"], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -209,7 +212,9 @@ php_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p1beta1.yaml", + transport = "grpc+rest", deps = [ ":videointelligence_php_grpc", ":videointelligence_php_proto", @@ -243,7 +248,9 @@ nodejs_gapic_library( grpc_service_config = "videointelligence_grpc_service_config.json", main_service = "videointelligence", package = "google.cloud.videointelligence.v1p1beta1", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -288,6 +295,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=videointelligence", ], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", ruby_cloud_title = "Cloud Video Intelligence V1p1beta1", deps = [ @@ -333,6 +341,7 @@ csharp_gapic_library( srcs = [":videointelligence_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p1beta1.yaml", deps = [ ":videointelligence_csharp_grpc", diff --git a/google/cloud/videointelligence/v1p2beta1/BUILD.bazel b/google/cloud/videointelligence/v1p2beta1/BUILD.bazel index 5c9724fcd..5f77a62bd 100644 --- a/google/cloud/videointelligence/v1p2beta1/BUILD.bazel +++ b/google/cloud/videointelligence/v1p2beta1/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":videointelligence_java_grpc", ], @@ -120,13 +121,14 @@ go_gapic_library( srcs = [":videointelligence_proto_with_info"], grpc_service_config = "videointelligence_grpc_service_config.json", importpath = "cloud.google.com/go/videointelligence/apiv1p2beta1;videointelligence", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p2beta1.yaml", transport = "grpc+rest", deps = [ ":videointelligence_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -162,6 +164,7 @@ py_gapic_library( name = "videointelligence_py_gapic", srcs = [":videointelligence_proto"], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -209,7 +212,9 @@ php_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p2beta1.yaml", + transport = "grpc+rest", deps = [ ":videointelligence_php_grpc", ":videointelligence_php_proto", @@ -243,7 +248,9 @@ nodejs_gapic_library( grpc_service_config = "videointelligence_grpc_service_config.json", main_service = "videointelligence", package = "google.cloud.videointelligence.v1p2beta1", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p2beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -288,6 +295,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=videointelligence", ], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", ruby_cloud_title = "Cloud Video Intelligence V1p2beta1", deps = [ @@ -333,6 +341,7 @@ csharp_gapic_library( srcs = [":videointelligence_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p2beta1.yaml", deps = [ ":videointelligence_csharp_grpc", diff --git a/google/cloud/videointelligence/v1p3beta1/BUILD.bazel b/google/cloud/videointelligence/v1p3beta1/BUILD.bazel index 4c801f98d..56151ef58 100644 --- a/google/cloud/videointelligence/v1p3beta1/BUILD.bazel +++ b/google/cloud/videointelligence/v1p3beta1/BUILD.bazel @@ -61,6 +61,7 @@ java_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":videointelligence_java_grpc", ], @@ -122,12 +123,14 @@ go_gapic_library( srcs = [":videointelligence_proto_with_info"], grpc_service_config = "videointelligence_grpc_service_config.json", importpath = "cloud.google.com/go/videointelligence/apiv1p3beta1;videointelligence", + rest_numeric_enums = True, + transport = "grpc+rest", service_yaml = "//google/cloud/videointelligence:videointelligence_v1p3beta1.yaml", deps = [ ":videointelligence_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -163,6 +166,7 @@ py_gapic_library( name = "videointelligence_py_gapic", srcs = [":videointelligence_proto"], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -210,7 +214,9 @@ php_gapic_library( srcs = [":videointelligence_proto_with_info"], gapic_yaml = "videointelligence_gapic.yaml", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p3beta1.yaml", + transport = "grpc+rest", deps = [ ":videointelligence_php_grpc", ":videointelligence_php_proto", @@ -244,7 +250,9 @@ nodejs_gapic_library( grpc_service_config = "videointelligence_grpc_service_config.json", main_service = "videointelligence", package = "google.cloud.videointelligence.v1p3beta1", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p3beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -289,6 +297,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=videointelligence", ], grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", ruby_cloud_title = "Cloud Video Intelligence V1p3beta1", deps = [ @@ -334,6 +343,7 @@ csharp_gapic_library( srcs = [":videointelligence_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "videointelligence_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/cloud/videointelligence:videointelligence_v1p3beta1.yaml", deps = [ ":videointelligence_csharp_grpc", diff --git a/google/cloud/vision/v1/BUILD.bazel b/google/cloud/vision/v1/BUILD.bazel index f8f247d82..3c69ca3a5 100644 --- a/google/cloud/vision/v1/BUILD.bazel +++ b/google/cloud/vision/v1/BUILD.bazel @@ -79,6 +79,7 @@ java_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", test_deps = [ ":vision_java_grpc", @@ -145,13 +146,14 @@ go_gapic_library( grpc_service_config = "vision_grpc_service_config.json", importpath = "cloud.google.com/go/vision/apiv1;vision", metadata = True, + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", transport = "grpc+rest", deps = [ ":vision_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -187,6 +189,7 @@ py_gapic_library( name = "vision_py_gapic", srcs = [":vision_proto"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", transport = "grpc", ) @@ -235,7 +238,9 @@ php_gapic_library( name = "vision_php_gapic", srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", + transport = "grpc+rest", deps = [ ":vision_php_grpc", ":vision_php_proto", @@ -269,7 +274,9 @@ nodejs_gapic_library( grpc_service_config = "vision_grpc_service_config.json", main_service = "vision", package = "google.cloud.vision.v1", + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -316,6 +323,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/vision", ], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Vision API allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.", ruby_cloud_title = "Cloud Vision V1", deps = [ @@ -361,6 +369,7 @@ csharp_gapic_library( srcs = [":vision_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1.yaml", deps = [ ":vision_csharp_grpc", diff --git a/google/cloud/vision/v1p1beta1/BUILD.bazel b/google/cloud/vision/v1p1beta1/BUILD.bazel index 3cb55d3e5..85ad35272 100644 --- a/google/cloud/vision/v1p1beta1/BUILD.bazel +++ b/google/cloud/vision/v1p1beta1/BUILD.bazel @@ -62,6 +62,7 @@ java_gapic_library( name = "vision_java_gapic", srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":vision_java_grpc", ], @@ -122,6 +123,7 @@ go_gapic_library( srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", importpath = "cloud.google.com/go/vision/apiv1p1beta1;vision", + rest_numeric_enums = True, service_yaml = "vision_v1p1beta1.yaml", transport = "grpc+rest", deps = [ @@ -160,6 +162,7 @@ py_gapic_library( name = "vision_py_gapic", srcs = [":vision_proto"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -207,6 +210,8 @@ php_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":vision_php_grpc", ":vision_php_proto", @@ -240,7 +245,9 @@ nodejs_gapic_library( grpc_service_config = "vision_grpc_service_config.json", main_service = "vision", package = "google.cloud.vision.v1p1beta1", + rest_numeric_enums = True, service_yaml = "vision_v1p1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -278,6 +285,7 @@ ruby_cloud_gapic_library( name = "vision_ruby_gapic", srcs = [":vision_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-vision-v1p1beta1"], + rest_numeric_enums = True, deps = [ ":vision_ruby_grpc", ":vision_ruby_proto", @@ -321,6 +329,7 @@ csharp_gapic_library( srcs = [":vision_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":vision_csharp_grpc", ":vision_csharp_proto", diff --git a/google/cloud/vision/v1p2beta1/BUILD.bazel b/google/cloud/vision/v1p2beta1/BUILD.bazel index c42770d4a..9e87cf63c 100644 --- a/google/cloud/vision/v1p2beta1/BUILD.bazel +++ b/google/cloud/vision/v1p2beta1/BUILD.bazel @@ -65,6 +65,7 @@ java_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":vision_java_grpc", ], @@ -126,13 +127,14 @@ go_gapic_library( srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", importpath = "cloud.google.com/go/vision/apiv1p2beta1;vision", + rest_numeric_enums = True, service_yaml = "vision_v1p2beta1.yaml", transport = "grpc+rest", deps = [ ":vision_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -167,6 +169,7 @@ py_gapic_library( name = "vision_py_gapic", srcs = [":vision_proto"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -214,6 +217,8 @@ php_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":vision_php_grpc", ":vision_php_proto", @@ -247,7 +252,9 @@ nodejs_gapic_library( grpc_service_config = "vision_grpc_service_config.json", main_service = "vision", package = "google.cloud.vision.v1p2beta1", + rest_numeric_enums = True, service_yaml = "vision_v1p2beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -285,6 +292,7 @@ ruby_cloud_gapic_library( name = "vision_ruby_gapic", srcs = [":vision_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-vision-v1p2beta1"], + rest_numeric_enums = True, deps = [ ":vision_ruby_grpc", ":vision_ruby_proto", @@ -328,6 +336,7 @@ csharp_gapic_library( srcs = [":vision_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":vision_csharp_grpc", ":vision_csharp_proto", diff --git a/google/cloud/vision/v1p3beta1/BUILD.bazel b/google/cloud/vision/v1p3beta1/BUILD.bazel index 2fdc7f797..b21c282d8 100644 --- a/google/cloud/vision/v1p3beta1/BUILD.bazel +++ b/google/cloud/vision/v1p3beta1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":vision_java_grpc", ], @@ -133,13 +134,14 @@ go_gapic_library( srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", importpath = "cloud.google.com/go/vision/apiv1p3beta1;vision", + rest_numeric_enums = True, service_yaml = "vision_v1p3beta1.yaml", transport = "grpc+rest", deps = [ ":vision_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -174,6 +176,7 @@ py_gapic_library( name = "vision_py_gapic", srcs = [":vision_proto"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -221,7 +224,9 @@ php_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1p3beta1.yaml", + transport = "grpc+rest", deps = [ ":vision_php_grpc", ":vision_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( grpc_service_config = "vision_grpc_service_config.json", main_service = "vision", package = "google.cloud.vision.v1p3beta1", + rest_numeric_enums = True, service_yaml = "vision_v1p3beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -300,6 +307,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=vision", ], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Vision API allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.", ruby_cloud_title = "Cloud Vision V1p3beta1", deps = [ @@ -345,6 +353,7 @@ csharp_gapic_library( srcs = [":vision_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":vision_csharp_grpc", ":vision_csharp_proto", diff --git a/google/cloud/vision/v1p4beta1/BUILD.bazel b/google/cloud/vision/v1p4beta1/BUILD.bazel index 2d89f7612..dd8d0dadd 100644 --- a/google/cloud/vision/v1p4beta1/BUILD.bazel +++ b/google/cloud/vision/v1p4beta1/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":vision_java_grpc", ], @@ -134,13 +135,14 @@ go_gapic_library( srcs = [":vision_proto_with_info"], grpc_service_config = "vision_grpc_service_config.json", importpath = "cloud.google.com/go/vision/apiv1p4beta1;vision", + rest_numeric_enums = True, service_yaml = "vision_v1p4beta1.yaml", transport = "grpc+rest", deps = [ ":vision_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -175,6 +177,7 @@ py_gapic_library( name = "vision_py_gapic", srcs = [":vision_proto"], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -222,7 +225,9 @@ php_gapic_library( srcs = [":vision_proto_with_info"], gapic_yaml = "vision_gapic.yaml", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vision_v1p4beta1.yaml", + transport = "grpc+rest", deps = [ ":vision_php_grpc", ":vision_php_proto", @@ -256,7 +261,9 @@ nodejs_gapic_library( grpc_service_config = "vision_grpc_service_config.json", main_service = "vision", package = "google.cloud.vision.v1p4beta1", + rest_numeric_enums = True, service_yaml = "vision_v1p4beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=vision", ], grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Vision API allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.", ruby_cloud_title = "Cloud Vision V1p4beta1", deps = [ @@ -346,6 +354,7 @@ csharp_gapic_library( srcs = [":vision_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vision_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":vision_csharp_grpc", ":vision_csharp_proto", diff --git a/google/cloud/visionai/v1/BUILD.bazel b/google/cloud/visionai/v1/BUILD.bazel new file mode 100644 index 000000000..9a93baea8 --- /dev/null +++ b/google/cloud/visionai/v1/BUILD.bazel @@ -0,0 +1,428 @@ +# 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 = "visionai_proto", + srcs = [ + "annotations.proto", + "common.proto", + "lva.proto", + "lva_resources.proto", + "lva_service.proto", + "platform.proto", + "streaming_resources.proto", + "streaming_service.proto", + "streams_resources.proto", + "streams_service.proto", + "warehouse.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:datetime_proto", + "@com_google_protobuf//:any_proto", + "@com_google_protobuf//:duration_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 = "visionai_proto_with_info", + deps = [ + ":visionai_proto", + "//google/cloud/location:location_proto", + "//google/cloud:common_resources_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 = "visionai_java_proto", + deps = [":visionai_proto"], +) + +java_grpc_library( + name = "visionai_java_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_java_proto"], +) + +java_gapic_library( + name = "visionai_java_gapic", + srcs = [":visionai_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + test_deps = [ + ":visionai_java_grpc", + "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":visionai_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", + ], +) + +java_gapic_test( + name = "visionai_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.visionai.v1.AppPlatformClientHttpJsonTest", + "com.google.cloud.visionai.v1.AppPlatformClientTest", + "com.google.cloud.visionai.v1.LiveVideoAnalyticsClientHttpJsonTest", + "com.google.cloud.visionai.v1.LiveVideoAnalyticsClientTest", + "com.google.cloud.visionai.v1.StreamingServiceClientHttpJsonTest", + "com.google.cloud.visionai.v1.StreamingServiceClientTest", + "com.google.cloud.visionai.v1.StreamsServiceClientHttpJsonTest", + "com.google.cloud.visionai.v1.StreamsServiceClientTest", + "com.google.cloud.visionai.v1.WarehouseClientHttpJsonTest", + "com.google.cloud.visionai.v1.WarehouseClientTest", + ], + runtime_deps = [":visionai_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-visionai-v1-java", + transport = "grpc+rest", + deps = [ + ":visionai_java_gapic", + ":visionai_java_grpc", + ":visionai_java_proto", + ":visionai_proto", + ], + include_samples = True, +) + +############################################################################## +# Go +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", +) + +go_proto_library( + name = "visionai_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/visionai/v1", + protos = [":visionai_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", + "//google/rpc:status_go_proto", + "//google/type:datetime_go_proto", + ], +) + +go_gapic_library( + name = "visionai_go_gapic", + srcs = [":visionai_proto_with_info"], + grpc_service_config = "visionai_grpc_service_config.json", + importpath = "cloud.google.com/go/visionai/apiv1;visionai", + metadata = True, + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + transport = "grpc+rest", + deps = [ + ":visionai_go_proto", + "//google/cloud/location:location_go_proto", + "//google/iam/v1:iam_go_proto", + "//google/longrunning:longrunning_go_proto", + "@com_google_cloud_go_longrunning//autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@io_bazel_rules_go//proto/wkt:any_go_proto", + "@io_bazel_rules_go//proto/wkt:duration_go_proto", + "@io_bazel_rules_go//proto/wkt:struct_go_proto", + ], +) + +go_test( + name = "visionai_go_gapic_test", + srcs = [":visionai_go_gapic_srcjar_test"], + embed = [":visionai_go_gapic"], + importpath = "cloud.google.com/go/visionai/apiv1", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-visionai-v1-go", + deps = [ + ":visionai_go_gapic", + ":visionai_go_gapic_srcjar-test.srcjar", + ":visionai_go_gapic_srcjar-metadata.srcjar", + ":visionai_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "visionai_py_gapic", + srcs = [":visionai_proto"], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + transport = "grpc+rest", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], +) + +py_test( + name = "visionai_py_gapic_test", + srcs = [ + "visionai_py_gapic_pytest.py", + "visionai_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":visionai_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "visionai-v1-py", + deps = [ + ":visionai_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 = "visionai_php_proto", + deps = [":visionai_proto"], +) + +php_grpc_library( + name = "visionai_php_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_php_proto"], +) + +php_gapic_library( + name = "visionai_php_gapic", + srcs = [":visionai_proto_with_info"], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + transport = "grpc+rest", + deps = [ + ":visionai_php_grpc", + ":visionai_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-visionai-v1-php", + deps = [ + ":visionai_php_gapic", + ":visionai_php_grpc", + ":visionai_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "visionai_nodejs_gapic", + package_name = "@google-cloud/visionai", + src = ":visionai_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "visionai_grpc_service_config.json", + package = "google.cloud.visionai.v1", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "visionai-v1-nodejs", + deps = [ + ":visionai_nodejs_gapic", + ":visionai_proto", + ], +) + +############################################################################## +# Ruby +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "ruby_gapic_assembly_pkg", + "ruby_cloud_gapic_library", + "ruby_grpc_library", + "ruby_proto_library", +) + +ruby_proto_library( + name = "visionai_ruby_proto", + deps = [":visionai_proto"], +) + +ruby_grpc_library( + name = "visionai_ruby_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "visionai_ruby_gapic", + srcs = [":visionai_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-visionai-v1", + ], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + deps = [ + ":visionai_ruby_grpc", + ":visionai_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-visionai-v1-ruby", + deps = [ + ":visionai_ruby_gapic", + ":visionai_ruby_grpc", + ":visionai_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 = "visionai_csharp_proto", + deps = [":visionai_proto"], +) + +csharp_grpc_library( + name = "visionai_csharp_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_csharp_proto"], +) + +csharp_gapic_library( + name = "visionai_csharp_gapic", + srcs = [":visionai_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1.yaml", + deps = [ + ":visionai_csharp_grpc", + ":visionai_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-visionai-v1-csharp", + deps = [ + ":visionai_csharp_gapic", + ":visionai_csharp_grpc", + ":visionai_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "visionai_cc_proto", + deps = [":visionai_proto"], +) + +cc_grpc_library( + name = "visionai_cc_grpc", + srcs = [":visionai_proto"], + grpc_only = True, + generate_mocks = True, + deps = [":visionai_cc_proto"], +) diff --git a/google/cloud/visionai/v1/annotations.proto b/google/cloud/visionai/v1/annotations.proto new file mode 100644 index 000000000..02c0869ed --- /dev/null +++ b/google/cloud/visionai/v1/annotations.proto @@ -0,0 +1,659 @@ +// 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.visionai.v1; + +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "AnnotationsProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Enum describing all possible types of a stream annotation. +enum StreamAnnotationType { + // Type UNSPECIFIED. + STREAM_ANNOTATION_TYPE_UNSPECIFIED = 0; + + // active_zone annotation defines a polygon on top of the content from an + // image/video based stream, following processing will only focus on the + // content inside the active zone. + STREAM_ANNOTATION_TYPE_ACTIVE_ZONE = 1; + + // crossing_line annotation defines a polyline on top of the content from an + // image/video based Vision AI stream, events happening across the line will + // be captured. For example, the counts of people who goes acroos the line + // in Occupancy Analytic Processor. + STREAM_ANNOTATION_TYPE_CROSSING_LINE = 2; +} + +// Output format for Personal Protective Equipment Detection Operator. +message PersonalProtectiveEquipmentDetectionOutput { + // The entity info for annotations from person detection prediction result. + message PersonEntity { + // Entity id. + int64 person_entity_id = 1; + } + + // The entity info for annotations from PPE detection prediction result. + message PPEEntity { + // Label id. + int64 ppe_label_id = 1; + + // Human readable string of the label (Examples: helmet, glove, mask). + string ppe_label_string = 2; + + // Human readable string of the super category label (Examples: head_cover, + // hands_cover, face_cover). + string ppe_supercategory_label_string = 3; + + // Entity id. + int64 ppe_entity_id = 4; + } + + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // PersonIdentified box contains the location and the entity info of the + // person. + message PersonIdentifiedBox { + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // Person entity info. + PersonEntity person_entity = 4; + } + + // PPEIdentified box contains the location and the entity info of the PPE. + message PPEIdentifiedBox { + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // PPE entity info. + PPEEntity ppe_entity = 4; + } + + // Detected Person contains the detected person and their associated + // ppes and their protecting information. + message DetectedPerson { + // The id of detected person. + int64 person_id = 1; + + // The info of detected person identified box. + PersonIdentifiedBox detected_person_identified_box = 2; + + // The info of detected person associated ppe identified boxes. + repeated PPEIdentifiedBox detected_ppe_identified_boxes = 3; + + // Coverage score for each body part. + // Coverage score for face. + optional float face_coverage_score = 4; + + // Coverage score for eyes. + optional float eyes_coverage_score = 5; + + // Coverage score for head. + optional float head_coverage_score = 6; + + // Coverage score for hands. + optional float hands_coverage_score = 7; + + // Coverage score for body. + optional float body_coverage_score = 8; + + // Coverage score for feet. + optional float feet_coverage_score = 9; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of DetectedPersons. + repeated DetectedPerson detected_persons = 2; +} + +// Prediction output format for Generic Object Detection. +message ObjectDetectionPredictionResult { + // The entity info for annotations from object detection prediction result. + message Entity { + // Label id. + int64 label_id = 1; + + // Human readable string of the label. + string label_string = 2; + } + + // Identified box contains location and the entity of the object. + message IdentifiedBox { + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // Entity of this box. + Entity entity = 4; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of identified boxes. + repeated IdentifiedBox identified_boxes = 2; +} + +// Prediction output format for Image Object Detection. +message ImageObjectDetectionPredictionResult { + // The resource IDs of the AnnotationSpecs that had been identified, ordered + // by the confidence score descendingly. It is the id segment instead of full + // resource name. + repeated int64 ids = 1; + + // The display names of the AnnotationSpecs that had been identified, order + // matches the IDs. + repeated string display_names = 2; + + // The Model's confidences in correctness of the predicted IDs, higher value + // means higher confidence. Order matches the Ids. + repeated float confidences = 3; + + // Bounding boxes, i.e. the rectangles over the image, that pinpoint + // the found AnnotationSpecs. Given in order that matches the IDs. Each + // bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and + // `yMax`, which represent the extremal coordinates of the box. They are + // relative to the image size, and the point 0,0 is in the top left + // of the image. + repeated google.protobuf.ListValue bboxes = 4; +} + +// Prediction output format for Image and Text Classification. +message ClassificationPredictionResult { + // The resource IDs of the AnnotationSpecs that had been identified. + repeated int64 ids = 1; + + // The display names of the AnnotationSpecs that had been identified, order + // matches the IDs. + repeated string display_names = 2; + + // The Model's confidences in correctness of the predicted IDs, higher value + // means higher confidence. Order matches the Ids. + repeated float confidences = 3; +} + +// Prediction output format for Image Segmentation. +message ImageSegmentationPredictionResult { + // A PNG image where each pixel in the mask represents the category in which + // the pixel in the original image was predicted to belong to. The size of + // this image will be the same as the original image. The mapping between the + // AnntoationSpec and the color can be found in model's metadata. The model + // will choose the most likely category and if none of the categories reach + // the confidence threshold, the pixel will be marked as background. + string category_mask = 1; + + // A one channel image which is encoded as an 8bit lossless PNG. The size of + // the image will be the same as the original image. For a specific pixel, + // darker color means less confidence in correctness of the cateogry in the + // categoryMask for the corresponding pixel. Black means no confidence and + // white means complete confidence. + string confidence_mask = 2; +} + +// Prediction output format for Video Action Recognition. +message VideoActionRecognitionPredictionResult { + // Each IdentifiedAction is one particular identification of an action + // specified with the AnnotationSpec id, display_name and the associated + // confidence score. + message IdentifiedAction { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 3; + } + + // The beginning, inclusive, of the video's time segment in which the + // actions have been identified. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the actions have + // been identified. Particularly, if the end is the same as the start, it + // means the identification happens on a specific video frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the actions identified in the time range. + repeated IdentifiedAction actions = 3; +} + +// Prediction output format for Video Object Tracking. +message VideoObjectTrackingPredictionResult { + // Boundingbox for detected object. I.e. the rectangle over the video frame + // pinpointing the found AnnotationSpec. The coordinates are relative to the + // frame size, and the point 0,0 is in the top left of the frame. + message BoundingBox { + // The leftmost coordinate of the bounding box. + float x_min = 1; + + // The rightmost coordinate of the bounding box. + float x_max = 2; + + // The topmost coordinate of the bounding box. + float y_min = 3; + + // The bottommost coordinate of the bounding box. + float y_max = 4; + } + + // Each DetectedObject is one particular identification of an object + // specified with the AnnotationSpec id and display_name, the bounding box, + // the associated confidence score and the corresponding track_id. + message DetectedObject { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // Boundingbox. + BoundingBox bounding_box = 3; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 4; + + // The same object may be identified on muitiple frames which are typical + // adjacent. The set of frames where a particular object has been detected + // form a track. This track_id can be used to trace down all frames for an + // detected object. + int64 track_id = 5; + } + + // The beginning, inclusive, of the video's time segment in which the + // current identifications happens. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the current + // identifications happen. Particularly, if the end is the same as the start, + // it means the identifications happen on a specific video frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the objects detected in the specified time range. + repeated DetectedObject objects = 3; +} + +// Prediction output format for Video Classification. +message VideoClassificationPredictionResult { + // Each IdentifiedClassification is one particular identification of an + // classification specified with the AnnotationSpec id and display_name, + // and the associated confidence score. + message IdentifiedClassification { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 3; + } + + // The beginning, inclusive, of the video's time segment in which the + // classifications have been identified. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the + // classifications have been identified. Particularly, if the end is the same + // as the start, it means the identification happens on a specific video + // frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the classifications identified in the time range. + repeated IdentifiedClassification classifications = 3; +} + +// The prediction result proto for occupancy counting. +message OccupancyCountingPredictionResult { + // The entity info for annotations from occupancy counting operator. + message Entity { + // Label id. + int64 label_id = 1; + + // Human readable string of the label. + string label_string = 2; + } + + // Identified box contains location and the entity of the object. + message IdentifiedBox { + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float score = 3; + + // Entity of this box. + Entity entity = 4; + + // An unique id to identify a track. It should be consistent across frames. + // It only exists if tracking is enabled. + int64 track_id = 5; + } + + // The statistics info for annotations from occupancy counting operator. + message Stats { + // The object info and instant count for annotations from occupancy counting + // operator. + message ObjectCount { + // Entity of this object. + Entity entity = 1; + + // Count of the object. + int32 count = 2; + } + + // The object info and accumulated count for annotations from occupancy + // counting operator. + message AccumulatedObjectCount { + // The start time of the accumulated count. + google.protobuf.Timestamp start_time = 1; + + // The object count for the accumulated count. + ObjectCount object_count = 2; + } + + // Message for Crossing line count. + message CrossingLineCount { + // Line annotation from the user. + StreamAnnotation annotation = 1; + + // The direction that follows the right hand rule. + repeated ObjectCount positive_direction_counts = 2; + + // The direction that is opposite to the right hand rule. + repeated ObjectCount negative_direction_counts = 3; + + // The accumulated positive count. + repeated AccumulatedObjectCount accumulated_positive_direction_counts = 4; + + // The accumulated negative count. + repeated AccumulatedObjectCount accumulated_negative_direction_counts = 5; + } + + // Message for the active zone count. + message ActiveZoneCount { + // Active zone annotation from the user. + StreamAnnotation annotation = 1; + + // Counts in the zone. + repeated ObjectCount counts = 2; + } + + // Counts of the full frame. + repeated ObjectCount full_frame_count = 1; + + // Crossing line counts. + repeated CrossingLineCount crossing_line_counts = 2; + + // Active zone counts. + repeated ActiveZoneCount active_zone_counts = 3; + } + + // The track info for annotations from occupancy counting operator. + message TrackInfo { + // An unique id to identify a track. It should be consistent across frames. + string track_id = 1; + + // Start timestamp of this track. + google.protobuf.Timestamp start_time = 2; + } + + // The dwell time info for annotations from occupancy counting operator. + message DwellTimeInfo { + // An unique id to identify a track. It should be consistent across frames. + string track_id = 1; + + // The unique id for the zone in which the object is dwelling/waiting. + string zone_id = 2; + + // The beginning time when a dwelling object has been identified in a zone. + google.protobuf.Timestamp dwell_start_time = 3; + + // The end time when a dwelling object has exited in a zone. + google.protobuf.Timestamp dwell_end_time = 4; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of identified boxes. + repeated IdentifiedBox identified_boxes = 2; + + // Detection statistics. + Stats stats = 3; + + // Track related information. All the tracks that are live at this timestamp. + // It only exists if tracking is enabled. + repeated TrackInfo track_info = 4; + + // Dwell time related information. All the tracks that are live in a given + // zone with a start and end dwell time timestamp + repeated DwellTimeInfo dwell_time_info = 5; +} + +// message about annotations about Vision AI stream resource. +message StreamAnnotation { + oneof annotation_payload { + // Annotation for type ACTIVE_ZONE + NormalizedPolygon active_zone = 5; + + // Annotation for type CROSSING_LINE + NormalizedPolyline crossing_line = 6; + } + + // ID of the annotation. It must be unique when used in the certain context. + // For example, all the annotations to one input streams of a Vision AI + // application. + string id = 1; + + // User-friendly name for the annotation. + string display_name = 2; + + // The Vision AI stream resource name. + string source_stream = 3; + + // The actual type of Annotation. + StreamAnnotationType type = 4; +} + +// A wrapper of repeated StreamAnnotation. +message StreamAnnotations { + // Multiple annotations. + repeated StreamAnnotation stream_annotations = 1; +} + +// Normalized Polygon. +message NormalizedPolygon { + // The bounding polygon normalized vertices. Top left corner of the image + // will be [0, 0]. + repeated NormalizedVertex normalized_vertices = 1; +} + +// Normalized Pplyline, which represents a curve consisting of connected +// straight-line segments. +message NormalizedPolyline { + // A sequence of vertices connected by straight lines. + repeated NormalizedVertex normalized_vertices = 1; +} + +// A vertex represents a 2D point in the image. +// NOTE: the normalized vertex coordinates are relative to the original image +// and range from 0 to 1. +message NormalizedVertex { + // X coordinate. + float x = 1; + + // Y coordinate. + float y = 2; +} + +// Message of essential metadata of App Platform. +// This message is usually attached to a certain processor output annotation for +// customer to identify the source of the data. +message AppPlatformMetadata { + // The application resource name. + string application = 1; + + // The instance resource id. Instance is the nested resource of application + // under collection 'instances'. + string instance_id = 2; + + // The node name of the application graph. + string node = 3; + + // The referred processor resource name of the application node. + string processor = 4; +} + +// For any cloud function based customer processing logic, customer's cloud +// function is expected to receive AppPlatformCloudFunctionRequest as request +// and send back AppPlatformCloudFunctionResponse as response. +// Message of request from AppPlatform to Cloud Function. +message AppPlatformCloudFunctionRequest { + // A general annotation message that uses struct format to represent different + // concrete annotation protobufs. + message StructedInputAnnotation { + // The ingestion time of the current annotation. + int64 ingestion_time_micros = 1; + + // The struct format of the actual annotation. + google.protobuf.Struct annotation = 2; + } + + // The metadata of the AppPlatform for customer to identify the source of the + // payload. + AppPlatformMetadata app_platform_metadata = 1; + + // The actual annotations to be processed by the customized Cloud Function. + repeated StructedInputAnnotation annotations = 2; +} + +// Message of the response from customer's Cloud Function to AppPlatform. +message AppPlatformCloudFunctionResponse { + // A general annotation message that uses struct format to represent different + // concrete annotation protobufs. + message StructedOutputAnnotation { + // The struct format of the actual annotation. + google.protobuf.Struct annotation = 1; + } + + // The modified annotations that is returned back to AppPlatform. + // If the annotations fields are empty, then those annotations will be dropped + // by AppPlatform. + repeated StructedOutputAnnotation annotations = 2; + + // If set to true, AppPlatform will use original annotations instead of + // dropping them, even if it is empty in the annotations filed. + bool annotation_passthrough = 3; + + // The event notifications that is returned back to AppPlatform. Typically it + // will then be configured to be consumed/forwared to a operator that handles + // events, such as Pub/Sub operator. + repeated AppPlatformEventBody events = 4; +} + +// Message of content of appPlatform event +message AppPlatformEventBody { + // Human readable string of the event like "There are more than 6 people in + // the scene". or "Shelf is empty!". + string event_message = 1; + + // For the case of Pub/Sub, it will be stored in the message attributes. + // ​​pubsub.proto + google.protobuf.Struct payload = 2; + + // User defined Event Id, used to classify event, within a delivery interval, + // events from the same application instance with the same id will be + // de-duplicated & only first one will be sent out. Empty event_id will be + // treated as "". + string event_id = 3; +} diff --git a/google/cloud/visionai/v1/common.proto b/google/cloud/visionai/v1/common.proto new file mode 100644 index 000000000..6a99ba45a --- /dev/null +++ b/google/cloud/visionai/v1/common.proto @@ -0,0 +1,114 @@ +// 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.visionai.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "CommonProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Message describing the Cluster object. +message Cluster { + option (google.api.resource) = { + type: "visionai.googleapis.com/Cluster" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}" + }; + + // The current state of the cluster. + enum State { + // Not set. + STATE_UNSPECIFIED = 0; + + // The PROVISIONING state indicates the cluster is being created. + PROVISIONING = 1; + + // The RUNNING state indicates the cluster has been created and is fully + // usable. + RUNNING = 2; + + // The STOPPING state indicates the cluster is being deleted. + STOPPING = 3; + + // The ERROR state indicates the cluster is unusable. It will be + // automatically deleted. + ERROR = 4; + } + + // Output only. Name of the resource. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Output only. The DNS name of the data plane service + string dataplane_service_endpoint = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The current state of the cluster. + State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The private service connection service target name. + string psc_target = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// 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]; + + // 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]; +} + +// The Google Cloud Storage location for the input content. +message GcsSource { + // Required. References to a Google Cloud Storage paths. + repeated string uris = 1 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/visionai/v1/lva.proto b/google/cloud/visionai/v1/lva.proto new file mode 100644 index 000000000..7c78cb7de --- /dev/null +++ b/google/cloud/visionai/v1/lva.proto @@ -0,0 +1,115 @@ +// 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.visionai.v1; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Represents an actual value of an operator attribute. +message AttributeValue { + // Attribute value. + oneof value { + // int. + int64 i = 1; + + // float. + float f = 2; + + // bool. + bool b = 3; + + // string. + bytes s = 4; + } +} + +// Defines an Analyzer. +// +// An analyzer processes data from its input streams using the logic defined in +// the Operator that it represents. Of course, it produces data for the output +// streams declared in the Operator. +message AnalyzerDefinition { + // The inputs to this analyzer. + // + // We accept input name references of the following form: + // : + // + // Example: + // + // Suppose you had an operator named "SomeOp" that has 2 output + // arguments, the first of which is named "foo" and the second of which is + // named "bar", and an operator named "MyOp" that accepts 2 inputs. + // + // Also suppose that there is an analyzer named "some-analyzer" that is + // running "SomeOp" and another analyzer named "my-analyzer" running "MyOp". + // + // To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" + // output as its first input and "some-analyzer"'s "bar" output as its + // second input, you can set this field to the following: + // input = ["some-analyzer:foo", "some-analyzer:bar"] + message StreamInput { + // The name of the stream input (as discussed above). + string input = 1; + } + + // Options available for debugging purposes only. + message DebugOptions { + // Environment variables. + map environment_variables = 1; + } + + // The name of this analyzer. + // + // Tentatively [a-z][a-z0-9]*(_[a-z0-9]+)*. + string analyzer = 1; + + // The name of the operator that this analyzer runs. + // + // Must match the name of a supported operator. + string operator = 2; + + // Input streams. + repeated StreamInput inputs = 3; + + // The attribute values that this analyzer applies to the operator. + // + // Supply a mapping between the attribute names and the actual value you wish + // to apply. If an attribute name is omitted, then it will take a + // preconfigured default value. + map attrs = 4; + + // Debug options. + DebugOptions debug_options = 5; +} + +// Defines a full analysis. +// +// This is a description of the overall live analytics pipeline. +// You may think of this as an edge list representation of a multigraph. +// +// This may be directly authored by a human in protobuf textformat, or it may be +// generated by a programming API (perhaps Python or JavaScript depending on +// context). +message AnalysisDefinition { + // Analyzer definitions. + repeated AnalyzerDefinition analyzers = 1; +} diff --git a/google/cloud/visionai/v1/lva_resources.proto b/google/cloud/visionai/v1/lva_resources.proto new file mode 100644 index 000000000..3a0ad3f93 --- /dev/null +++ b/google/cloud/visionai/v1/lva_resources.proto @@ -0,0 +1,65 @@ +// 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.visionai.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/visionai/v1/lva.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaResourcesProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Message describing the Analysis object. +message Analysis { + option (google.api.resource) = { + type: "visionai.googleapis.com/Analysis" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/analyses/{analysis}" + }; + + // The name of resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // The definition of the analysis. + AnalysisDefinition analysis_definition = 5; + + // Map from the input parameter in the definition to the real stream. + // E.g., suppose you had a stream source operator named "input-0" and you try + // to receive from the real stream "stream-0". You can add the following + // mapping: [input-0: stream-0]. + map input_streams_mapping = 6; + + // Map from the output parameter in the definition to the real stream. + // E.g., suppose you had a stream sink operator named "output-0" and you try + // to send to the real stream "stream-0". You can add the following + // mapping: [output-0: stream-0]. + map output_streams_mapping = 7; +} diff --git a/google/cloud/visionai/v1/lva_service.proto b/google/cloud/visionai/v1/lva_service.proto new file mode 100644 index 000000000..581f6e50d --- /dev/null +++ b/google/cloud/visionai/v1/lva_service.proto @@ -0,0 +1,227 @@ +// 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.visionai.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/visionai/v1/lva_resources.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/field_mask.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaServiceProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Service describing handlers for resources. The service enables clients to run +// Live Video Analytics (LVA) on the streaming inputs. +service LiveVideoAnalytics { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists Analyses in a given project and location. + rpc ListAnalyses(ListAnalysesRequest) returns (ListAnalysesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/clusters/*}/analyses" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Analysis. + rpc GetAnalysis(GetAnalysisRequest) returns (Analysis) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/clusters/*/analyses/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Analysis in a given project and location. + rpc CreateAnalysis(CreateAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/clusters/*}/analyses" + body: "analysis" + }; + option (google.api.method_signature) = "parent,analysis,analysis_id"; + option (google.longrunning.operation_info) = { + response_type: "Analysis" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Analysis. + rpc UpdateAnalysis(UpdateAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{analysis.name=projects/*/locations/*/clusters/*/analyses/*}" + body: "analysis" + }; + option (google.api.method_signature) = "analysis,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Analysis" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Analysis. + rpc DeleteAnalysis(DeleteAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/clusters/*/analyses/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } +} + +// Message for requesting list of Analyses +message ListAnalysesRequest { + // Required. Parent value for ListAnalysesRequest + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Analyses +message ListAnalysesResponse { + // The list of Analysis + repeated Analysis analyses = 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 an Analysis. +message GetAnalysisRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Analysis" + } + ]; +} + +// Message for creating an Analysis. +message CreateAnalysisRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string analysis_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Analysis analysis = 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]; +} + +// Message for updating an Analysis. +message UpdateAnalysisRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Analysis 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) = REQUIRED]; + + // Required. The resource being updated. + Analysis analysis = 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 deleting an Analysis. +message DeleteAnalysisRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Analysis" + } + ]; + + // 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]; +} diff --git a/google/cloud/visionai/v1/platform.proto b/google/cloud/visionai/v1/platform.proto new file mode 100644 index 000000000..2b3be510a --- /dev/null +++ b/google/cloud/visionai/v1/platform.proto @@ -0,0 +1,2222 @@ +// 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.visionai.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/visionai/v1/annotations.proto"; +import "google/cloud/visionai/v1/common.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "PlatformProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Service describing handlers for resources +service AppPlatform { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists Applications in a given project and location. + rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/applications" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Application. + rpc GetApplication(GetApplicationRequest) returns (Application) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/applications/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Application in a given project and location. + rpc CreateApplication(CreateApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/applications" + body: "application" + }; + option (google.api.method_signature) = "parent,application"; + option (google.longrunning.operation_info) = { + response_type: "Application" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Application. + rpc UpdateApplication(UpdateApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{application.name=projects/*/locations/*/applications/*}" + body: "application" + }; + option (google.api.method_signature) = "application,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Application" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Application. + rpc DeleteApplication(DeleteApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/applications/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Deploys a single Application. + rpc DeployApplication(DeployApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:deploy" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "DeployApplicationResponse" + metadata_type: "OperationMetadata" + }; + } + + // Undeploys a single Application. + rpc UndeployApplication(UndeployApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:undeploy" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "UndeployApplicationResponse" + metadata_type: "OperationMetadata" + }; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc AddApplicationStreamInput(AddApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:addStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "AddApplicationStreamInputResponse" + metadata_type: "OperationMetadata" + }; + } + + // Remove target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deleted. If the stream + // is not in the Application, the RPC will fail. + rpc RemoveApplicationStreamInput(RemoveApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:removeStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "RemoveApplicationStreamInputResponse" + metadata_type: "OperationMetadata" + }; + } + + // Update target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deployed. For + // CreateOrUpdate behavior, set allow_missing to true. + rpc UpdateApplicationStreamInput(UpdateApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:updateStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "UpdateApplicationStreamInputResponse" + 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/*/applications/*}/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/*/applications/*/instances/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc CreateApplicationInstances(CreateApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:createApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "CreateApplicationInstancesResponse" + metadata_type: "OperationMetadata" + }; + } + + // Remove target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deleted. If the stream + // is not in the Application, the RPC will fail. + rpc DeleteApplicationInstances(DeleteApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:deleteApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Instance" + metadata_type: "OperationMetadata" + }; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc UpdateApplicationInstances(UpdateApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/applications/*}:updateApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name, application_instances"; + option (google.longrunning.operation_info) = { + response_type: "UpdateApplicationInstancesResponse" + metadata_type: "OperationMetadata" + }; + } + + // Lists Drafts in a given project and location. + rpc ListDrafts(ListDraftsRequest) returns (ListDraftsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/applications/*}/drafts" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Draft. + rpc GetDraft(GetDraftRequest) returns (Draft) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/applications/*/drafts/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Draft in a given project and location. + rpc CreateDraft(CreateDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/applications/*}/drafts" + body: "draft" + }; + option (google.api.method_signature) = "parent,draft,draft_id"; + option (google.longrunning.operation_info) = { + response_type: "Draft" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Draft. + rpc UpdateDraft(UpdateDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{draft.name=projects/*/locations/*/applications/*/drafts/*}" + body: "draft" + }; + option (google.api.method_signature) = "draft,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Draft" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Draft. + rpc DeleteDraft(DeleteDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/applications/*/drafts/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists Processors in a given project and location. + rpc ListProcessors(ListProcessorsRequest) returns (ListProcessorsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/processors" + }; + option (google.api.method_signature) = "parent"; + } + + // ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt + // Processors. + rpc ListPrebuiltProcessors(ListPrebuiltProcessorsRequest) returns (ListPrebuiltProcessorsResponse) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/processors:prebuilt" + body: "*" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Processor. + rpc GetProcessor(GetProcessorRequest) returns (Processor) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/processors/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Processor in a given project and location. + rpc CreateProcessor(CreateProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/processors" + body: "processor" + }; + option (google.api.method_signature) = "parent,processor,processor_id"; + option (google.longrunning.operation_info) = { + response_type: "Processor" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Processor. + rpc UpdateProcessor(UpdateProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{processor.name=projects/*/locations/*/processors/*}" + body: "processor" + }; + option (google.api.method_signature) = "processor,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Processor" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Processor. + rpc DeleteProcessor(DeleteProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/processors/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } +} + +// All the supported model types in Vision AI App Platform. +enum ModelType { + // Processor Type UNSPECIFIED. + MODEL_TYPE_UNSPECIFIED = 0; + + // Model Type Image Classification. + IMAGE_CLASSIFICATION = 1; + + // Model Type Object Detection. + OBJECT_DETECTION = 2; + + // Model Type Video Classification. + VIDEO_CLASSIFICATION = 3; + + // Model Type Object Tracking. + VIDEO_OBJECT_TRACKING = 4; + + // Model Type Action Recognition. + VIDEO_ACTION_RECOGNITION = 5; + + // Model Type Occupancy Counting. + OCCUPANCY_COUNTING = 6; + + // Model Type Person Blur. + PERSON_BLUR = 7; + + // Model Type Vertex Custom. + VERTEX_CUSTOM = 8; +} + +// Represents a hardware accelerator type. +enum AcceleratorType { + // Unspecified accelerator type, which means no accelerator. + ACCELERATOR_TYPE_UNSPECIFIED = 0; + + // Nvidia Tesla K80 GPU. + NVIDIA_TESLA_K80 = 1; + + // Nvidia Tesla P100 GPU. + NVIDIA_TESLA_P100 = 2; + + // Nvidia Tesla V100 GPU. + NVIDIA_TESLA_V100 = 3; + + // Nvidia Tesla P4 GPU. + NVIDIA_TESLA_P4 = 4; + + // Nvidia Tesla T4 GPU. + NVIDIA_TESLA_T4 = 5; + + // Nvidia Tesla A100 GPU. + NVIDIA_TESLA_A100 = 8; + + // TPU v2. + TPU_V2 = 6; + + // TPU v3. + TPU_V3 = 7; +} + +// Message for DeleteApplicationInstance Response. +message DeleteApplicationInstancesResponse { + +} + +// Message for CreateApplicationInstance Response. +message CreateApplicationInstancesResponse { + +} + +// Message for UpdateApplicationInstances Response. +message UpdateApplicationInstancesResponse { + +} + +// Message for adding stream input to an Application. +message CreateApplicationInstancesRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // Required. The resources being created. + repeated ApplicationInstance application_instances = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for removing stream input from an Application. +message DeleteApplicationInstancesRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // Required. Id of the requesting object. + repeated string instance_ids = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.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 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// RPC Request Messages. +// Message for DeployApplication Response. +message DeployApplicationResponse { + +} + +// Message for UndeployApplication Response. +message UndeployApplicationResponse { + +} + +// Message for RemoveApplicationStreamInput Response. +message RemoveApplicationStreamInputResponse { + +} + +// Message for AddApplicationStreamInput Response. +message AddApplicationStreamInputResponse { + +} + +// Message for AddApplicationStreamInput Response. +message UpdateApplicationStreamInputResponse { + +} + +// Message for requesting list of Applications. +message ListApplicationsRequest { + // Required. Parent value for ListApplicationsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Application" + } + ]; + + // 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 Applications. +message ListApplicationsResponse { + // The list of Application. + repeated Application applications = 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 Application. +message GetApplicationRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; +} + +// Message for creating a Application. +message CreateApplicationRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Application" + } + ]; + + // Required. Id of the requesting object. + string application_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Application application = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating an Application. +message UpdateApplicationRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Application 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. + Application application = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 deleting an Application. +message DeleteApplicationRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 to true, any instances and drafts from this application will also be + // deleted. (Otherwise, the request will only work if the application has no + // instances and drafts.) + bool force = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Message for deploying an Application. +message DeployApplicationRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // If set, validate the request and preview the application graph, but do not + // actually deploy it. + bool validate_only = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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. Whether or not to enable monitoring for the application on deployment. + bool enable_monitoring = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Message for undeploying an Application. +message UndeployApplicationRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message about a single stream input config. +message ApplicationStreamInput { + StreamWithAnnotation stream_with_annotation = 1; +} + +// Message for adding stream input to an Application. +message AddApplicationStreamInputRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The stream inputs to add, the stream resource name is the key of each + // StreamInput, and it must be unique within each application. + repeated ApplicationStreamInput application_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 updating stream input to an Application. +message UpdateApplicationStreamInputRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The stream inputs to update, the stream resource name is the key of each + // StreamInput, and it must be unique within each application. + repeated ApplicationStreamInput application_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, UpdateApplicationStreamInput will insert stream input to + // application even if the target stream is not included in the application. + bool allow_missing = 4; +} + +// Message for removing stream input from an Application. +message RemoveApplicationStreamInputRequest { + // Message about target streamInput to remove. + message TargetStreamInput { + string stream = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + }]; + } + + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The target stream to remove. + repeated TargetStreamInput target_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 requesting list of Instances. +message ListInstancesRequest { + // Required. Parent value for ListInstancesRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Instance" + } + ]; + + // 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 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. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Instance" + } + ]; +} + +// Message for requesting list of Drafts. +message ListDraftsRequest { + // Required. Parent value for ListDraftsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Draft" + } + ]; + + // 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 Drafts. +message ListDraftsResponse { + // The list of Draft. + repeated Draft drafts = 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 Draft. +message GetDraftRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Draft" + } + ]; +} + +// Message for creating a Draft. +message CreateDraftRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Draft" + } + ]; + + // Required. Id of the requesting object. + string draft_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Draft draft = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating an Draft. +message UpdateDraftRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Draft 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. + Draft draft = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, UpdateDraftRequest will create one resource if the target resource + // doesn't exist, this time, the field_mask will be ignored. + bool allow_missing = 4; +} + +// Message for updating an ApplicationInstance. +message UpdateApplicationInstancesRequest { + message UpdateApplicationInstance { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Draft 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]; + + // Required. The id of the instance. + string instance_id = 3 [(google.api.field_behavior) = REQUIRED]; + } + + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + repeated UpdateApplicationInstance application_instances = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, Update Request will create one resource if the target resource + // doesn't exist, this time, the field_mask will be ignored. + bool allow_missing = 4; +} + +// Message for deleting an Draft. +message DeleteDraftRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Draft" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for requesting list of Processors. +message ListProcessorsRequest { + // Required. Parent value for ListProcessorsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; + + // 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 Processors. +message ListProcessorsResponse { + // The list of Processor. + repeated Processor processors = 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; +} + +// Request Message for listing Prebuilt Processors. +message ListPrebuiltProcessorsRequest { + // Required. Parent path. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; +} + +// Response Message for listing Prebuilt Processors. +message ListPrebuiltProcessorsResponse { + // The list of Processor. + repeated Processor processors = 1; +} + +// Message for getting a Processor. +message GetProcessorRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Processor" + } + ]; +} + +// Message for creating a Processor. +message CreateProcessorRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; + + // Required. Id of the requesting object. + string processor_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Processor processor = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating a Processor. +message UpdateProcessorRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Processor 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. + Processor processor = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 deleting a Processor. +message DeleteProcessorRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Processor" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message describing Application object +message Application { + option (google.api.resource) = { + type: "visionai.googleapis.com/Application" + pattern: "projects/{project}/locations/{location}/applications/{application}" + style: DECLARATIVE_FRIENDLY + }; + + // Message storing the runtime information of the application. + message ApplicationRuntimeInfo { + // Message about output resources from application. + message GlobalOutputResource { + // The full resource name of the outputted resources. + string output_resource = 1; + + // The name of graph node who produces the output resource name. + // For example: + // output_resource: + // /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema + // producer_node: occupancy-count + string producer_node = 2; + + // The key of the output resource, it has to be unique within the same + // producer node. One producer node can output several output resources, + // the key can be used to match corresponding output resources. + string key = 3; + } + + // Monitoring-related configuration for an application. + message MonitoringConfig { + // Whether this application has monitoring enabled. + bool enabled = 1; + } + + // Timestamp when the engine be deployed + google.protobuf.Timestamp deploy_time = 1; + + // Globally created resources like warehouse dataschemas. + repeated GlobalOutputResource global_output_resources = 3; + + // Monitoring-related configuration for this application. + MonitoringConfig monitoring_config = 4; + } + + // State of the Application + enum State { + // The default value. This value is used if the state is omitted. + STATE_UNSPECIFIED = 0; + + // State CREATED. + CREATED = 1; + + // State DEPLOYING. + DEPLOYING = 2; + + // State DEPLOYED. + DEPLOYED = 3; + + // State UNDEPLOYING. + UNDEPLOYING = 4; + + // State DELETED. + DELETED = 5; + + // State ERROR. + ERROR = 6; + + // State CREATING. + CREATING = 7; + + // State Updating. + UPDATING = 8; + + // State Deleting. + DELETING = 9; + + // State Fixing. + FIXING = 10; + } + + // name of resource + string name = 1; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 4; + + // Required. A user friendly display name for the solution. + string display_name = 5 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 6; + + // Application graph configuration. + ApplicationConfigs application_configs = 7; + + // Output only. Application graph runtime info. Only exists when application state equals + // to DEPLOYED. + ApplicationRuntimeInfo runtime_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the application. + State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Message storing the graph of the application. +message ApplicationConfigs { + // message storing the config for event delivery + message EventDeliveryConfig { + // The delivery channel for the event notification, only pub/sub topic is + // supported now. + // Example channel: + // [//pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic] + string channel = 1; + + // The expected delivery interval for the same event. The same event won't + // be notified multiple times during this internal event that it is + // happening multiple times during the period of time.The same event is + // identified by . + google.protobuf.Duration minimal_delivery_interval = 2; + } + + // A list of nodes in the application graph. + repeated Node nodes = 1; + + // Event-related configuration for this application. + EventDeliveryConfig event_delivery_config = 3; +} + +// Message describing node object. +message Node { + // Message describing one edge pointing into a node. + message InputEdge { + // The name of the parent node. + string parent_node = 1; + + // The connected output artifact of the parent node. + // It can be omitted if target processor only has 1 output artifact. + string parent_output_channel = 2; + + // The connected input channel of the current node's processor. + // It can be omitted if target processor only has 1 input channel. + string connected_input_channel = 3; + } + + oneof stream_output_config { + // By default, the output of the node will only be available to downstream + // nodes. To consume the direct output from the application node, the output + // must be sent to Vision AI Streams at first. + // + // By setting output_all_output_channels_to_stream to true, App Platform + // will automatically send all the outputs of the current node to Vision AI + // Stream resources (one stream per output channel). The output stream + // resource will be created by App Platform automatically during deployment + // and deleted after application un-deployment. + // Note that this config applies to all the Application Instances. + // + // The output stream can be override at instance level by + // configuring the `output_resources` section of Instance resource. + // `producer_node` should be current node, `output_resource_binding` should + // be the output channel name (or leave it blank if there is only 1 output + // channel of the processor) and `output_resource` should be the target + // output stream. + bool output_all_output_channels_to_stream = 6; + } + + // Required. A unique name for the node. + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // A user friendly display name for the node. + string display_name = 2; + + // Node config. + ProcessorConfig node_config = 3; + + // Processor name refer to the chosen processor resource. + string processor = 4; + + // Parent node. Input node should not have parent node. For V1 Alpha1/Beta + // only media warehouse node can have multiple parents, other types of nodes + // will only have one parent. + repeated InputEdge parents = 5; +} + +// Message describing Draft object +message Draft { + option (google.api.resource) = { + type: "visionai.googleapis.com/Draft" + pattern: "projects/{project}/locations/{location}/applications/{application}/drafts/{draft}" + style: DECLARATIVE_FRIENDLY + }; + + // name of resource + string name = 1; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 3; + + // Required. A user friendly display name for the solution. + string display_name = 4 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 5; + + // The draft application configs which haven't been updated to an application. + ApplicationConfigs draft_application_configs = 6; +} + +// Message describing Instance object +message Instance { + option (google.api.resource) = { + type: "visionai.googleapis.com/Instance" + pattern: "projects/{project}/locations/{location}/applications/{application}/instances/{instance}" + style: DECLARATIVE_FRIENDLY + }; + + // Message of input resource used in one application instance. + message InputResource { + // Required. Specify the input to the application instance. + oneof input_resource_information { + // The direct input resource name. + string input_resource = 1; + + // If the input resource is VisionAI Stream, the associated annotations + // can be specified using annotated_stream instead. + StreamWithAnnotation annotated_stream = 4 [deprecated = true]; + } + + // The name of graph node who receives the input resource. + // For example: + // input_resource: + // visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a + // consumer_node: stream-input + string consumer_node = 2; + + // The specific input resource binding which will consume the current Input + // Resource, can be ignored is there is only 1 input binding. + string input_resource_binding = 3; + + // Contains resource annotations. + ResourceAnnotations annotations = 5; + } + + // Message of output resource used in one application instance. + message OutputResource { + // The output resource name for the current application instance. + string output_resource = 1; + + // The name of graph node who produces the output resource name. + // For example: + // output_resource: + // /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting + // producer_node: occupancy-counting + string producer_node = 2; + + // The specific output resource binding which produces the current + // OutputResource. + string output_resource_binding = 4; + + // Output only. Whether the output resource is temporary which means the resource is + // generated during the deployment of the application. + // Temporary resource will be deleted during the undeployment of the + // application. + bool is_temporary = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the output resource is created automatically by the Vision AI App + // Platform. + bool autogen = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // State of the Instance + enum State { + // The default value. This value is used if the state is omitted. + STATE_UNSPECIFIED = 0; + + // State CREATING. + CREATING = 1; + + // State CREATED. + CREATED = 2; + + // State DEPLOYING. + DEPLOYING = 3; + + // State DEPLOYED. + DEPLOYED = 4; + + // State UNDEPLOYING. + UNDEPLOYING = 5; + + // State DELETED. + DELETED = 6; + + // State ERROR. + ERROR = 7; + + // State Updating + UPDATING = 8; + + // State Deleting. + DELETING = 9; + + // State Fixing. + FIXING = 10; + } + + // Output only. name of resource + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp + google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 3; + + // Required. A user friendly display name for the solution. + string display_name = 4 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 5; + + // The input resources for the current application instance. + // For example: + // input_resources: + // visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a + repeated InputResource input_resources = 6; + + // All the output resources associated to one application instance. + repeated OutputResource output_resources = 7; + + // State of the instance. + State state = 9; +} + +// Message for creating a Instance. +message ApplicationInstance { + // Required. Id of the requesting object. + string instance_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Instance instance = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Message describing Processor object. +// Next ID: 18 +message Processor { + option (google.api.resource) = { + type: "visionai.googleapis.com/Processor" + pattern: "projects/{project}/locations/{location}/processors/{processor}" + style: DECLARATIVE_FRIENDLY + }; + + // Type + enum ProcessorType { + // Processor Type UNSPECIFIED. + PROCESSOR_TYPE_UNSPECIFIED = 0; + + // Processor Type PRETRAINED. + // Pretrained processor is developed by Vision AI App Platform with + // state-of-the-art vision data processing functionality, like occupancy + // counting or person blur. Pretrained processor is usually publicly + // available. + PRETRAINED = 1; + + // Processor Type CUSTOM. + // Custom processors are specialized processors which are either uploaded by + // customers or imported from other GCP platform (for example Vertex AI). + // Custom processor is only visible to the creator. + CUSTOM = 2; + + // Processor Type CONNECTOR. + // Connector processors are special processors which perform I/O for the + // application, they do not processing the data but either deliver the data + // to other processors or receive data from other processors. + CONNECTOR = 3; + } + + enum ProcessorState { + // Unspecified Processor state. + PROCESSOR_STATE_UNSPECIFIED = 0; + + // Processor is being created (not ready for use). + CREATING = 1; + + // Processor is and ready for use. + ACTIVE = 2; + + // Processor is being deleted (not ready for use). + DELETING = 3; + + // Processor deleted or creation failed . + FAILED = 4; + } + + // name of resource. + string name = 1; + + // Output only. [Output only] Create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Required. A user friendly display name for the processor. + string display_name = 5 [(google.api.field_behavior) = REQUIRED]; + + // Illustrative sentences for describing the functionality of the processor. + string description = 10; + + // Output only. Processor Type. + ProcessorType processor_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Model Type. + ModelType model_type = 13; + + // Source info for customer created processor. + CustomProcessorSourceInfo custom_processor_source_info = 7; + + // Output only. State of the Processor. + ProcessorState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] The input / output specifications of a processor, each type + // of processor has fixed input / output specs which cannot be altered by + // customer. + ProcessorIOSpec processor_io_spec = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The corresponding configuration can be used in the Application to customize + // the behavior of the processor. + string configuration_typeurl = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + repeated StreamAnnotationType supported_annotation_types = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Indicates if the processor supports post processing. + bool supports_post_processing = 17; +} + +// Message describing the input / output specifications of a processor. +message ProcessorIOSpec { + // Message for input channel specification. + message GraphInputChannelSpec { + // The name of the current input channel. + string name = 1; + + // The data types of the current input channel. + // When this field has more than 1 value, it means this input channel can be + // connected to either of these different data types. + DataType data_type = 2; + + // If specified, only those detailed data types can be connected to the + // processor. For example, jpeg stream for MEDIA, or PredictionResult proto + // for PROTO type. If unspecified, then any proto is accepted. + repeated string accepted_data_type_uris = 5; + + // Whether the current input channel is required by the processor. + // For example, for a processor with required video input and optional audio + // input, if video input is missing, the application will be rejected while + // the audio input can be missing as long as the video input exists. + bool required = 3; + + // How many input edges can be connected to this input channel. 0 means + // unlimited. + int64 max_connection_allowed = 4; + } + + // Message for output channel specification. + message GraphOutputChannelSpec { + // The name of the current output channel. + string name = 1; + + // The data type of the current output channel. + DataType data_type = 2; + + string data_type_uri = 3; + } + + // Message for instance resource channel specification. + // External resources are virtual nodes which are not expressed in the + // application graph. Each processor expresses its out-graph spec, so customer + // is able to override the external source or destinations to the + message InstanceResourceInputBindingSpec { + oneof resource_type { + // The configuration proto that includes the Googleapis resources. I.e. + // type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation + string config_type_uri = 2; + + // The direct type url of Googleapis resource. i.e. + // type.googleapis.com/google.cloud.vision.v1.Asset + string resource_type_uri = 3; + } + + // Name of the input binding, unique within the processor. + string name = 1; + } + + message InstanceResourceOutputBindingSpec { + // Name of the output binding, unique within the processor. + string name = 1; + + // The resource type uri of the acceptable output resource. + string resource_type_uri = 2; + + // Whether the output resource needs to be explicitly set in the instance. + // If it is false, the processor will automatically generate it if required. + bool explicit = 3; + } + + // High level data types supported by the processor. + enum DataType { + // The default value of DataType. + DATA_TYPE_UNSPECIFIED = 0; + + // Video data type like H264. + VIDEO = 1; + + // Protobuf data type, usually used for general data blob. + PROTO = 2; + } + + // For processors with input_channel_specs, the processor must be explicitly + // connected to another processor. + repeated GraphInputChannelSpec graph_input_channel_specs = 3; + + // The output artifact specifications for the current processor. + repeated GraphOutputChannelSpec graph_output_channel_specs = 4; + + // The input resource that needs to be fed from the application instance. + repeated InstanceResourceInputBindingSpec instance_resource_input_binding_specs = 5; + + // The output resource that the processor will generate per instance. + // Other than the explicitly listed output bindings here, all the processors' + // GraphOutputChannels can be binded to stream resource. The bind name then is + // the same as the GraphOutputChannel's name. + repeated InstanceResourceOutputBindingSpec instance_resource_output_binding_specs = 6; +} + +// Describes the source info for a custom processor. +message CustomProcessorSourceInfo { + // 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). + message ModelSchema { + // Cloud Storage location to a YAML file that defines the format of a single + // instance used in prediction and explanation requests. + GcsSource instances_schema = 1; + + // Cloud Storage location to a YAML file that defines the prediction and + // explanation parameters. + GcsSource parameters_schema = 2; + + // Cloud Storage location to a YAML file that defines the format of a single + // prediction or explanation. + GcsSource predictions_schema = 3; + } + + // Source type of the imported custom processor. + enum SourceType { + // Source type unspecified. + SOURCE_TYPE_UNSPECIFIED = 0; + + // Custom processors coming from Vertex AutoML product. + VERTEX_AUTOML = 1; + + // Custom processors coming from general custom models from Vertex. + VERTEX_CUSTOM = 2; + } + + // The path where App Platform loads the artifacts for the custom processor. + oneof artifact_path { + // The resource name original model hosted in the vertex AI platform. + string vertex_model = 2; + } + + // The original product which holds the custom processor's functionality. + SourceType source_type = 1; + + // Output only. Additional info related to the imported custom processor. + // Data is filled in by app platform during the processor creation. + map additional_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Model schema files which specifies the signature of the model. + // For VERTEX_CUSTOM models, instances schema is required. + // If instances schema is not specified during the processor creation, + // VisionAI Platform will try to get it from Vertex, if it doesn't exist, the + // creation will fail. + ModelSchema model_schema = 5; +} + +// Next ID: 24 +message ProcessorConfig { + oneof processor_config { + // Configs of stream input processor. + VideoStreamInputConfig video_stream_input_config = 9; + + // Config of AI-enabled input devices. + AIEnabledDevicesInputConfig ai_enabled_devices_input_config = 20; + + // Configs of media warehouse processor. + MediaWarehouseConfig media_warehouse_config = 10; + + // Configs of person blur processor. + PersonBlurConfig person_blur_config = 11; + + // Configs of occupancy count processor. + OccupancyCountConfig occupancy_count_config = 12; + + // Configs of Person Vehicle Detection processor. + PersonVehicleDetectionConfig person_vehicle_detection_config = 15; + + // Configs of Vertex AutoML vision processor. + VertexAutoMLVisionConfig vertex_automl_vision_config = 13; + + // Configs of Vertex AutoML video processor. + VertexAutoMLVideoConfig vertex_automl_video_config = 14; + + // Configs of Vertex Custom processor. + VertexCustomConfig vertex_custom_config = 17; + + // Configs of General Object Detection processor. + GeneralObjectDetectionConfig general_object_detection_config = 18; + + // Configs of BigQuery processor. + BigQueryConfig big_query_config = 19; + + // Configs of personal_protective_equipment_detection_config + PersonalProtectiveEquipmentDetectionConfig personal_protective_equipment_detection_config = 22; + } +} + +// Message describing Vision AI stream with application specific annotations. +// All the StreamAnnotation object inside this message MUST have unique id. +message StreamWithAnnotation { + // Message describing annotations specific to application node. + message NodeAnnotation { + // The node name of the application graph. + string node = 1; + + // The node specific stream annotations. + repeated StreamAnnotation annotations = 2; + } + + // Vision AI Stream resource name. + string stream = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + }]; + + // Annotations that will be applied to the whole application. + repeated StreamAnnotation application_annotations = 2; + + // Annotations that will be applied to the specific node of the application. + // If the same type of the annotations is applied to both application and + // node, the node annotation will be added in addition to the global + // application one. + // For example, if there is one active zone annotation for the whole + // application and one active zone annotation for the Occupancy Analytic + // processor, then the Occupancy Analytic processor will have two active zones + // defined. + repeated NodeAnnotation node_annotations = 3; +} + +// Message describing annotations specific to application node. +// This message is a duplication of StreamWithAnnotation.NodeAnnotation. +message ApplicationNodeAnnotation { + // The node name of the application graph. + string node = 1; + + // The node specific stream annotations. + repeated StreamAnnotation annotations = 2; +} + +// Message describing general annotation for resources. +message ResourceAnnotations { + // Annotations that will be applied to the whole application. + repeated StreamAnnotation application_annotations = 1; + + // Annotations that will be applied to the specific node of the application. + // If the same type of the annotations is applied to both application and + // node, the node annotation will be added in addition to the global + // application one. + // For example, if there is one active zone annotation for the whole + // application and one active zone annotation for the Occupancy Analytic + // processor, then the Occupancy Analytic processor will have two active zones + // defined. + repeated ApplicationNodeAnnotation node_annotations = 2; +} + +// Message describing Video Stream Input Config. +// This message should only be used as a placeholder for builtin:stream-input +// processor, actual stream binding should be specified using corresponding +// API. +message VideoStreamInputConfig { + repeated string streams = 1 [deprecated = true]; + + repeated StreamWithAnnotation streams_with_annotation = 2 [deprecated = true]; +} + +// Message describing AI-enabled Devices Input Config. +message AIEnabledDevicesInputConfig { + +} + +// Message describing MediaWarehouseConfig. +message MediaWarehouseConfig { + // Resource name of the Media Warehouse corpus. + // Format: + // projects/${project_id}/locations/${location_id}/corpora/${corpus_id} + string corpus = 1; + + // Deprecated. + string region = 2 [deprecated = true]; + + // The duration for which all media assets, associated metadata, and search + // documents can exist. + google.protobuf.Duration ttl = 3; +} + +// Message describing FaceBlurConfig. +message PersonBlurConfig { + // Type of Person Blur + enum PersonBlurType { + // PersonBlur Type UNSPECIFIED. + PERSON_BLUR_TYPE_UNSPECIFIED = 0; + + // FaceBlur Type full occlusion. + FULL_OCCULUSION = 1; + + // FaceBlur Type blur filter. + BLUR_FILTER = 2; + } + + // Person blur type. + PersonBlurType person_blur_type = 1; + + // Whether only blur faces other than the whole object in the processor. + bool faces_only = 2; +} + +// Message describing OccupancyCountConfig. +message OccupancyCountConfig { + // Whether to count the appearances of people, output counts have 'people' as + // the key. + bool enable_people_counting = 1; + + // Whether to count the appearances of vehicles, output counts will have + // 'vehicle' as the key. + bool enable_vehicle_counting = 2; + + // Whether to track each invidual object's loitering time inside the scene or + // specific zone. + bool enable_dwelling_time_tracking = 3; +} + +// Message describing PersonVehicleDetectionConfig. +message PersonVehicleDetectionConfig { + // At least one of enable_people_counting and enable_vehicle_counting fields + // must be set to true. + // Whether to count the appearances of people, output counts have 'people' as + // the key. + bool enable_people_counting = 1; + + // Whether to count the appearances of vehicles, output counts will have + // 'vehicle' as the key. + bool enable_vehicle_counting = 2; +} + +// Message describing PersonalProtectiveEquipmentDetectionConfig. +message PersonalProtectiveEquipmentDetectionConfig { + // Whether to enable face coverage detection. + bool enable_face_coverage_detection = 1; + + // Whether to enable head coverage detection. + bool enable_head_coverage_detection = 2; + + // Whether to enable hands coverage detection. + bool enable_hands_coverage_detection = 3; +} + +// Message of configurations for General Object Detection processor. +message GeneralObjectDetectionConfig { + +} + +// Message of configurations for BigQuery processor. +message BigQueryConfig { + // BigQuery table resource for Vision AI Platform to ingest annotations to. + string table = 1; + + // Data Schema + // By default, Vision AI Application will try to write annotations to the + // target BigQuery table using the following schema: + // + // ingestion_time: TIMESTAMP, the ingestion time of the original data. + // + // application: STRING, name of the application which produces the annotation. + // + // instance: STRING, Id of the instance which produces the annotation. + // + // node: STRING, name of the application graph node which produces the + // annotation. + // + // annotation: STRING or JSON, the actual annotation protobuf will be + // converted to json string with bytes field as 64 encoded string. It can be + // written to both String or Json type column. + // + // To forward annotation data to an existing BigQuery table, customer needs to + // make sure the compatibility of the schema. + // The map maps application node name to its corresponding cloud function + // endpoint to transform the annotations directly to the + // google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or + // proto_rows should be set). If configured, annotations produced by + // corresponding application node will sent to the Cloud Function at first + // before be forwarded to BigQuery. + // + // If the default table schema doesn't fit, customer is able to transform the + // annotation output from Vision AI Application to arbitrary BigQuery table + // schema with CloudFunction. + // * The cloud function will receive AppPlatformCloudFunctionRequest where + // the annotations field will be the json format of Vision AI annotation. + // * The cloud function should return AppPlatformCloudFunctionResponse with + // AppendRowsRequest stored in the annotations field. + // * To drop the annotation, simply clear the annotations field in the + // returned AppPlatformCloudFunctionResponse. + map cloud_function_mapping = 2; + + // If true, App Platform will create the BigQuery DataSet and the + // BigQuery Table with default schema if the specified table doesn't exist. + // This doesn't work if any cloud function customized schema is specified + // since the system doesn't know your desired schema. + // JSON column will be used in the default table created by App Platform. + bool create_default_table_if_not_exists = 3; +} + +// Message of configurations of Vertex AutoML Vision Processors. +message VertexAutoMLVisionConfig { + // Only entities with higher score than the threshold will be returned. + // Value 0.0 means to return all the detected entities. + float confidence_threshold = 1; + + // At most this many predictions will be returned per output frame. + // Value 0 means to return all the detected entities. + int32 max_predictions = 2; +} + +// Message describing VertexAutoMLVideoConfig. +message VertexAutoMLVideoConfig { + // Only entities with higher score than the threshold will be returned. + // Value 0.0 means returns all the detected entities. + float confidence_threshold = 1; + + // Labels specified in this field won't be returned. + repeated string blocked_labels = 2; + + // At most this many predictions will be returned per output frame. + // Value 0 means to return all the detected entities. + int32 max_predictions = 3; + + // Only Bounding Box whose size is larger than this limit will be returned. + // Object Tracking only. + // Value 0.0 means to return all the detected entities. + float bounding_box_size_limit = 4; +} + +// Message describing VertexCustomConfig. +message VertexCustomConfig { + // The max prediction frame per second. This attribute sets how fast the + // operator sends prediction requests to Vertex AI endpoint. Default value is + // 0, which means there is no max prediction fps limit. The operator sends + // prediction requests at input fps. + int32 max_prediction_fps = 1; + + // A description of resources that are dedicated to the DeployedModel, and + // that need a higher degree of manual configuration. + DedicatedResources dedicated_resources = 2; + + // If not empty, the prediction result will be sent to the specified cloud + // function for post processing. + // * The cloud function will receive AppPlatformCloudFunctionRequest where + // the annotations field will be the json format of proto PredictResponse. + // * The cloud function should return AppPlatformCloudFunctionResponse with + // PredictResponse stored in the annotations field. + // * To drop the prediction output, simply clear the payload field in the + // returned AppPlatformCloudFunctionResponse. + string post_processing_cloud_function = 3; + + // If true, the prediction request received by custom model will also contain + // metadata with the following schema: + // 'appPlatformMetadata': { + // 'ingestionTime': DOUBLE; (UNIX timestamp) + // 'application': STRING; + // 'instanceId': STRING; + // 'node': STRING; + // 'processor': STRING; + // } + bool attach_application_metadata = 4; +} + +// Specification of a single machine. +message MachineSpec { + // Immutable. The type of the machine. + // + // See the [list of machine types supported for + // prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) + // + // See the [list of machine types supported for custom + // training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). + // + // For [DeployedModel][] this field is optional, and the default + // value is `n1-standard-2`. For [BatchPredictionJob][] or as part of + // [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 + // [accelerator_count][google.cloud.visionai.v1.MachineSpec.accelerator_count]. + AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + + // The number of accelerators to attach to the machine. + int32 accelerator_count = 3; +} + +// The metric specification that defines the target resource utilization +// (CPU utilization, accelerator's duty cycle, and so on) for calculating the +// desired replica count. +message AutoscalingMetricSpec { + // Required. The resource metric name. + // Supported metrics: + // + // * For Online Prediction: + // * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` + // * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + string metric_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The target resource utilization in percentage (1% - 100%) for the given + // metric; once the real usage deviates from the target by a certain + // percentage, the machine replicas change. The default value is 60 + // (representing 60%) if not provided. + int32 target = 2; +} + +// 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. + 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. + // + // If traffic against the DeployedModel increases, it may dynamically be + // deployed onto more replicas, and as traffic decreases, some of these extra + // replicas may be freed. + int32 min_replica_count = 2 [ + (google.api.field_behavior) = REQUIRED, + (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.visionai.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 * + // number of cores in the selected machine type) and (max_replica_count * + // number of GPUs per replica in the selected machine type). + int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. The metric specifications that overrides a resource + // utilization metric (CPU utilization, accelerator's duty cycle, and so on) + // target value (default to 60 if not set). At most one entry is allowed per + // metric. + // + // If [machine_spec.accelerator_count][google.cloud.visionai.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.visionai.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.visionai.v1.AutoscalingMetricSpec.metric_name] + // to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and + // [autoscaling_metric_specs.target][google.cloud.visionai.v1.AutoscalingMetricSpec.target] to `80`. + repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE]; +} diff --git a/google/cloud/visionai/v1/streaming_resources.proto b/google/cloud/visionai/v1/streaming_resources.proto new file mode 100644 index 000000000..5885eead9 --- /dev/null +++ b/google/cloud/visionai/v1/streaming_resources.proto @@ -0,0 +1,173 @@ +// 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.visionai.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamingResourcesProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// The descriptor for a gstreamer buffer payload. +message GstreamerBufferDescriptor { + // The caps string of the payload. + string caps_string = 1; + + // Whether the buffer is a key frame. + bool is_key_frame = 2; + + // PTS of the frame. + google.protobuf.Timestamp pts_time = 3; + + // DTS of the frame. + google.protobuf.Timestamp dts_time = 4; + + // Duration of the frame. + google.protobuf.Duration duration = 5; +} + +// The descriptor for a raw image. +message RawImageDescriptor { + // Raw image format. Its possible values are: "srgb". + string format = 1; + + // The height of the image. + int32 height = 2; + + // The width of the image. + int32 width = 3; +} + +// The message that represents the data type of a packet. +message PacketType { + // The message that fully specifies the type of the packet. + message TypeDescriptor { + // Detailed information about the type. + // + // It is non-empty only for specific type class codecs. Needed only when the + // type string alone is not enough to disambiguate the specific type. + oneof type_details { + // GstreamerBufferDescriptor is the descriptor for gstreamer buffer type. + GstreamerBufferDescriptor gstreamer_buffer_descriptor = 2; + + // RawImageDescriptor is the descriptor for the raw image type. + RawImageDescriptor raw_image_descriptor = 3; + } + + // The type of the packet. Its possible values is codec dependent. + // + // The fully qualified type name is always the concatenation of the + // value in `type_class` together with the value in `type`, separated by a + // '/'. + // + // Note that specific codecs can define their own type hierarchy, and so the + // type string here can in fact be separated by multiple '/'s of its own. + // + // Please see the open source SDK for specific codec documentation. + string type = 1; + } + + // The type class of the packet. Its possible values are: + // "gst", "protobuf", and "string". + string type_class = 1; + + // The type descriptor. + TypeDescriptor type_descriptor = 2; +} + +// The message that represents server metadata. +message ServerMetadata { + // The offset position for the packet in its stream. + int64 offset = 1; + + // The timestamp at which the stream server receives this packet. This is + // based on the local clock of on the server side. It is guaranteed to be + // monotonically increasing for the packets within each session; however + // this timestamp is not comparable across packets sent to the same stream + // different sessions. Session here refers to one individual gRPC streaming + // request to the stream server. + google.protobuf.Timestamp ingest_time = 2; +} + +// The message that represents series metadata. +message SeriesMetadata { + // Series name. It's in the format of + // "projects/{project}/locations/{location}/clusters/{cluster}/series/{stream}". + string series = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + }]; +} + +// The message that represents packet header. +message PacketHeader { + // Input only. The capture time of the packet. + google.protobuf.Timestamp capture_time = 1 [(google.api.field_behavior) = INPUT_ONLY]; + + // Input only. Immutable. The type of the payload. + PacketType type = 2 [ + (google.api.field_behavior) = INPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Input only. This field is for users to attach user managed metadata. + google.protobuf.Struct metadata = 3 [(google.api.field_behavior) = INPUT_ONLY]; + + // Output only. Metadata that the server appends to each packet before sending + // it to receivers. You don't need to set a value for this field when sending + // packets. + ServerMetadata server_metadata = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Input only. Immutable. Metadata that the server needs to know where to + // write the packets to. It's only required for the first packet. + SeriesMetadata series_metadata = 5 [ + (google.api.field_behavior) = INPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Immutable. Packet flag set. SDK will set the flag automatically. + int32 flags = 6 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Header string for tracing across services. It should be set when the packet + // is first arrived in the stream server. + // + // The input format is a lowercase hex string: + // - version_id: 1 byte, currently must be zero - hex encoded (2 characters) + // - trace_id: 16 bytes (opaque blob) - hex encoded (32 characters) + // - span_id: 8 bytes (opaque blob) - hex encoded (16 characters) + // - trace_options: 1 byte (LSB means tracing enabled) - hex encoded (2 + // characters) + // Example: "00-404142434445464748494a4b4c4d4e4f-6162636465666768-01" + // v trace_id span_id options + string trace_context = 7 [(google.api.field_behavior) = IMMUTABLE]; +} + +// The quanta of datum that the series accepts. +message Packet { + // The packet header. + PacketHeader header = 1; + + // The payload of the packet. + bytes payload = 2; +} diff --git a/google/cloud/visionai/v1/streaming_service.proto b/google/cloud/visionai/v1/streaming_service.proto new file mode 100644 index 000000000..cbaba4306 --- /dev/null +++ b/google/cloud/visionai/v1/streaming_service.proto @@ -0,0 +1,411 @@ +// 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.visionai.v1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/cloud/visionai/v1/streaming_resources.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamingServiceProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Streaming service for receiving and sending packets. +service StreamingService { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Send packets to the series. + rpc SendPackets(stream SendPacketsRequest) returns (stream SendPacketsResponse) { + } + + // Receive packets from the series. + rpc ReceivePackets(stream ReceivePacketsRequest) returns (stream ReceivePacketsResponse) { + } + + // Receive events given the stream name. + rpc ReceiveEvents(stream ReceiveEventsRequest) returns (stream ReceiveEventsResponse) { + } + + // AcquireLease acquires a lease. + rpc AcquireLease(AcquireLeaseRequest) returns (Lease) { + option (google.api.http) = { + post: "/v1/{series=projects/*/locations/*/clusters/*/series/*}:acquireLease" + body: "*" + }; + } + + // RenewLease renews a lease. + rpc RenewLease(RenewLeaseRequest) returns (Lease) { + option (google.api.http) = { + post: "/v1/{series=projects/*/locations/*/clusters/*/series/*}:renewLease" + body: "*" + }; + } + + // RleaseLease releases a lease. + rpc ReleaseLease(ReleaseLeaseRequest) returns (ReleaseLeaseResponse) { + option (google.api.http) = { + post: "/v1/{series=projects/*/locations/*/clusters/*/series/*}:releaseLease" + body: "*" + }; + } +} + +// The lease type. +enum LeaseType { + // Lease type unspecified. + LEASE_TYPE_UNSPECIFIED = 0; + + // Lease for stream reader. + LEASE_TYPE_READER = 1; + + // Lease for stream writer. + LEASE_TYPE_WRITER = 2; +} + +// Request message for ReceiveEvents. +message ReceiveEventsRequest { + // SetupRequest is the first message sent to the service to setup the RPC + // connection. + message SetupRequest { + // The cluster name. + string cluster = 1; + + // The stream name. The service will return the events for the given stream. + string stream = 2; + + // A name for the receiver to self-identify. + // + // This is used to keep track of a receiver's read progress. + string receiver = 3; + + // Controller mode configuration for receiving events from the server. + ControlledMode controlled_mode = 4; + + // The maximum duration of server silence before the client determines the + // server unreachable. + // + // The client must either receive an `Event` update or a heart beat message + // before this duration expires; otherwise, the client will automatically + // cancel the current connection and retry. + google.protobuf.Duration heartbeat_interval = 5; + + // The grace period after which a `writes_done_request` is issued, that a + // `WritesDone` is expected from the client. + // + // The server is free to cancel the RPC should this expire. + // + // A system default will be chosen if unset. + google.protobuf.Duration writes_done_grace_period = 6; + } + + oneof request { + // The setup request to setup the RPC connection. + SetupRequest setup_request = 1; + + // This request checkpoints the consumer's read progress. + CommitRequest commit_request = 2; + } +} + +// The event update message. +message EventUpdate { + // The name of the stream that the event is attached to. + string stream = 1; + + // The name of the event. + string event = 2; + + // The name of the series. + string series = 3; + + // The timestamp when the Event update happens. + google.protobuf.Timestamp update_time = 4; + + // The offset of the message that will be used to acknowledge of the message + // receiving. + int64 offset = 5; +} + +// Control message for a ReceiveEventsResponse. +message ReceiveEventsControlResponse { + // Possible control messages. + oneof control { + // A server heartbeat. + bool heartbeat = 1; + + // A request to the receiver to complete any final writes followed by a + // `WritesDone`; e.g. issue any final `CommitRequest`s. + // + // May be ignored if `WritesDone` has already been issued at any point + // prior to receiving this message. + // + // If `WritesDone` does not get issued, then the server will forcefully + // cancel the connection, and the receiver will likely receive an + // uninformative after `Read` returns `false` and `Finish` is called. + bool writes_done_request = 2; + } +} + +// Response message for the ReceiveEvents. +message ReceiveEventsResponse { + // Possible response types. + oneof response { + // The event update message. + EventUpdate event_update = 1; + + // A control message from the server. + ReceiveEventsControlResponse control = 2; + } +} + +// The lease message. +message Lease { + // The lease id. + string id = 1; + + // The series name. + string series = 2; + + // The owner name. + string owner = 3; + + // The lease expire time. + google.protobuf.Timestamp expire_time = 4; + + // The lease type. + LeaseType lease_type = 5; +} + +// Request message for acquiring a lease. +message AcquireLeaseRequest { + // The series name. + string series = 1; + + // The owner name. + string owner = 2; + + // The lease term. + google.protobuf.Duration term = 3; + + // The lease type. + LeaseType lease_type = 4; +} + +// Request message for renewing a lease. +message RenewLeaseRequest { + // Lease id. + string id = 1; + + // Series name. + string series = 2; + + // Lease owner. + string owner = 3; + + // Lease term. + google.protobuf.Duration term = 4; +} + +// Request message for releasing lease. +message ReleaseLeaseRequest { + // Lease id. + string id = 1; + + // Series name. + string series = 2; + + // Lease owner. + string owner = 3; +} + +// Response message for release lease. +message ReleaseLeaseResponse { + +} + +// RequestMetadata is the metadata message for the request. +message RequestMetadata { + // Stream name. + string stream = 1; + + // Evevt name. + string event = 2; + + // Series name. + string series = 3; + + // Lease id. + string lease_id = 4; + + // Owner name. + string owner = 5; + + // Lease term specifies how long the client wants the session to be maintained + // by the server after the client leaves. If the lease term is not set, the + // server will release the session immediately and the client cannot reconnect + // to the same session later. + google.protobuf.Duration lease_term = 6; +} + +// Request message for sending packets. +message SendPacketsRequest { + oneof request { + // Packets sent over the streaming rpc. + Packet packet = 1; + + // The first message of the streaming rpc including the request metadata. + RequestMetadata metadata = 2; + } +} + +// Response message for sending packets. +message SendPacketsResponse { + +} + +// Request message for receiving packets. +message ReceivePacketsRequest { + // The message specifying the initial settings for the ReceivePackets session. + message SetupRequest { + // The mode in which the consumer reads messages. + oneof consumer_mode { + // Options for configuring eager mode. + EagerMode eager_receive_mode = 3; + + // Options for configuring controlled mode. + ControlledMode controlled_receive_mode = 4; + } + + // The configurations that specify where packets are retrieved. + RequestMetadata metadata = 1; + + // A name for the receiver to self-identify. + // + // This is used to keep track of a receiver's read progress. + string receiver = 2; + + // The maximum duration of server silence before the client determines the + // server unreachable. + // + // The client must either receive a `Packet` or a heart beat message before + // this duration expires; otherwise, the client will automatically cancel + // the current connection and retry. + google.protobuf.Duration heartbeat_interval = 5; + + // The grace period after which a `writes_done_request` is issued, that a + // `WritesDone` is expected from the client. + // + // The server is free to cancel the RPC should this expire. + // + // A system default will be chosen if unset. + google.protobuf.Duration writes_done_grace_period = 6; + } + + // Possible request types from the client. + oneof request { + // The request to setup the initial state of session. + // + // The client must send and only send this as the first message. + SetupRequest setup_request = 6; + + // This request checkpoints the consumer's read progress. + CommitRequest commit_request = 7; + } +} + +// Control message for a ReceivePacketsResponse. +message ReceivePacketsControlResponse { + // Possible control messages. + oneof control { + // A server heartbeat. + bool heartbeat = 1; + + // A request to the receiver to complete any final writes followed by a + // `WritesDone`; e.g. issue any final `CommitRequest`s. + // + // May be ignored if `WritesDone` has already been issued at any point + // prior to receiving this message. + // + // If `WritesDone` does not get issued, then the server will forcefully + // cancel the connection, and the receiver will likely receive an + // uninformative after `Read` returns `false` and `Finish` is called. + bool writes_done_request = 2; + } +} + +// Response message from ReceivePackets. +message ReceivePacketsResponse { + // Possible response types. + oneof response { + // A genuine data payload originating from the sender. + Packet packet = 1; + + // A control message from the server. + ReceivePacketsControlResponse control = 3; + } +} + +// The options for receiver under the eager mode. +message EagerMode { + +} + +// The options for receiver under the controlled mode. +message ControlledMode { + // This is the offset from which to start receiveing. + oneof starting_offset { + // This can be set to the following logical starting points: + // + // "begin": This will read from the earliest available message. + // + // "most-recent": This will read from the latest available message. + // + // "end": This will read only future messages. + // + // "stored": This will resume reads one past the last committed offset. + // It is the only option that resumes progress; all others + // jump unilaterally. + string starting_logical_offset = 1; + } + + // This is the logical starting point to fallback upon should the + // specified starting offset be unavailable. + // + // This can be one of the following values: + // + // "begin": This will read from the earliest available message. + // + // "end": This will read only future messages. + string fallback_starting_offset = 2; +} + +// The message for explicitly committing the read progress. +// +// This may only be used when `ReceivePacketsControlledMode` is set in the +// initial setup request. +message CommitRequest { + // The offset to commit. + int64 offset = 1; +} diff --git a/google/cloud/visionai/v1/streams_resources.proto b/google/cloud/visionai/v1/streams_resources.proto new file mode 100644 index 000000000..4d168cab3 --- /dev/null +++ b/google/cloud/visionai/v1/streams_resources.proto @@ -0,0 +1,189 @@ +// 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.visionai.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamsResourcesProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Message describing the Stream object. The Stream and the Event resources are +// many to many; i.e., each Stream resource can associate to many Event +// resources and each Event resource can associate to many Stream resources. +message Stream { + option (google.api.resource) = { + type: "visionai.googleapis.com/Stream" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/streams/{stream}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // The display name for the stream resource. + string display_name = 6; + + // Whether to enable the HLS playback service on this stream. + bool enable_hls_playback = 7; + + // The name of the media warehouse asset for long term storage of stream data. + // Format: projects/${p_id}/locations/${l_id}/corpora/${c_id}/assets/${a_id} + // Remain empty if the media warehouse storage is not needed for the stream. + string media_warehouse_asset = 8; +} + +// Message describing the Event object. +message Event { + option (google.api.resource) = { + type: "visionai.googleapis.com/Event" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/events/{event}" + }; + + // Clock that will be used for joining streams. + enum Clock { + // Clock is not specified. + CLOCK_UNSPECIFIED = 0; + + // Use the timestamp when the data is captured. Clients need to sync the + // clock. + CAPTURE = 1; + + // Use the timestamp when the data is received. + INGEST = 2; + } + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // The clock used for joining streams. + Clock alignment_clock = 6; + + // Grace period for cleaning up the event. This is the time the controller + // waits for before deleting the event. During this period, if there is any + // active channel on the event. The deletion of the event after grace_period + // will be ignored. + google.protobuf.Duration grace_period = 7; +} + +// Message describing the Series object. +message Series { + option (google.api.resource) = { + type: "visionai.googleapis.com/Series" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/series/{series}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Required. Stream that is associated with this series. + string stream = 6 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // Required. Event that is associated with this series. + string event = 7 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} + +// Message describing the Channel object. +message Channel { + option (google.api.resource) = { + type: "visionai.googleapis.com/Channel" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/channels/{channel}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Required. Stream that is associated with this series. + string stream = 6 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // Required. Event that is associated with this series. + string event = 7 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} diff --git a/google/cloud/visionai/v1/streams_service.proto b/google/cloud/visionai/v1/streams_service.proto new file mode 100644 index 000000000..80fc9d81a --- /dev/null +++ b/google/cloud/visionai/v1/streams_service.proto @@ -0,0 +1,913 @@ +// 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.visionai.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/visionai/v1/common.proto"; +import "google/cloud/visionai/v1/streams_resources.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamsServiceProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Service describing handlers for resources. +// Vision API and Vision AI API are two independent APIs developed by the same +// team. Vision API is for people to annotate their image while Vision AI is an +// e2e solution for customer to build their own computer vision application. +service StreamsService { + option (google.api.default_host) = "visionai.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" + }; + } + + // Lists Streams in a given project and location. + rpc ListStreams(ListStreamsRequest) returns (ListStreamsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/clusters/*}/streams" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Stream. + rpc GetStream(GetStreamRequest) returns (Stream) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/clusters/*/streams/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Stream in a given project and location. + rpc CreateStream(CreateStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/clusters/*}/streams" + body: "stream" + }; + option (google.api.method_signature) = "parent,stream,stream_id"; + option (google.longrunning.operation_info) = { + response_type: "Stream" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Stream. + rpc UpdateStream(UpdateStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{stream.name=projects/*/locations/*/clusters/*/streams/*}" + body: "stream" + }; + option (google.api.method_signature) = "stream,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Stream" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Stream. + rpc DeleteStream(DeleteStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/clusters/*/streams/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Gets the thumbnail (image snapshot) of a single Stream. + rpc GetStreamThumbnail(GetStreamThumbnailRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{stream=projects/*/locations/*/clusters/*/streams/*}:getThumbnail" + body: "*" + }; + option (google.api.method_signature) = "stream,gcs_object_name"; + option (google.longrunning.operation_info) = { + response_type: "GetStreamThumbnailResponse" + metadata_type: "OperationMetadata" + }; + } + + // Generate the JWT auth token required to get the stream HLS contents. + rpc GenerateStreamHlsToken(GenerateStreamHlsTokenRequest) returns (GenerateStreamHlsTokenResponse) { + option (google.api.http) = { + post: "/v1/{stream=projects/*/locations/*/clusters/*/streams/*}:generateStreamHlsToken" + body: "*" + }; + option (google.api.method_signature) = "stream"; + } + + // Lists Events in a given project and location. + rpc ListEvents(ListEventsRequest) returns (ListEventsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/clusters/*}/events" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Event. + rpc GetEvent(GetEventRequest) returns (Event) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/clusters/*/events/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Event in a given project and location. + rpc CreateEvent(CreateEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/clusters/*}/events" + body: "event" + }; + option (google.api.method_signature) = "parent,event,event_id"; + option (google.longrunning.operation_info) = { + response_type: "Event" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Event. + rpc UpdateEvent(UpdateEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{event.name=projects/*/locations/*/clusters/*/events/*}" + body: "event" + }; + option (google.api.method_signature) = "event,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Event" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Event. + rpc DeleteEvent(DeleteEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/clusters/*/events/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists Series in a given project and location. + rpc ListSeries(ListSeriesRequest) returns (ListSeriesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/clusters/*}/series" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Series. + rpc GetSeries(GetSeriesRequest) returns (Series) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/clusters/*/series/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Series in a given project and location. + rpc CreateSeries(CreateSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/clusters/*}/series" + body: "series" + }; + option (google.api.method_signature) = "parent,series,series_id"; + option (google.longrunning.operation_info) = { + response_type: "Series" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Event. + rpc UpdateSeries(UpdateSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{series.name=projects/*/locations/*/clusters/*/series/*}" + body: "series" + }; + option (google.api.method_signature) = "series,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Series" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Series. + rpc DeleteSeries(DeleteSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/clusters/*/series/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Materialize a channel. + rpc MaterializeChannel(MaterializeChannelRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/clusters/*}/channels" + body: "channel" + }; + option (google.api.method_signature) = "parent,channel,channel_id"; + option (google.longrunning.operation_info) = { + response_type: "Channel" + metadata_type: "OperationMetadata" + }; + } +} + +// Message for requesting list of Clusters. +message ListClustersRequest { + // Required. Parent value for ListClustersRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // 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 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. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; +} + +// Message for creating a Cluster. +message CreateClusterRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.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]; +} + +// Message for updating a Cluster. +message UpdateClusterRequest { + // Required. 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) = REQUIRED]; + + // 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]; +} + +// Message for deleting a Cluster. +message DeleteClusterRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.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]; +} + +// Message for requesting list of Streams. +message ListStreamsRequest { + // Required. Parent value for ListStreamsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Streams. +message ListStreamsResponse { + // The list of Stream. + repeated Stream streams = 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 Stream. +message GetStreamRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; +} + +// Message for creating a Stream. +message CreateStreamRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string stream_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Stream stream = 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]; +} + +// Message for updating a Stream. +message UpdateStreamRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Stream 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) = REQUIRED]; + + // Required. The resource being updated. + Stream stream = 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 deleting a Stream. +message DeleteStreamRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // 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]; +} + +// Message for getting the thumbnail of a Stream. +message GetStreamThumbnailRequest { + // Required. The name of the stream for to get the thumbnail from. + string stream = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The name of the GCS object to store the thumbnail image. + string gcs_object_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The name of the event. If unspecified, the thumbnail will be retrieved from + // the latest event. + string event = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. An optional request ID to identify the requests. Specify a unique 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]; +} + +// Message for the response of GetStreamThumbnail. The empty response message +// indicates the thumbnail image has been uploaded to GCS successfully. +message GetStreamThumbnailResponse { + +} + +// Request message for getting the auth token to access the stream HLS contents. +message GenerateStreamHlsTokenRequest { + // Required. The name of the stream. + string stream = 1 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for GenerateStreamHlsToken. +message GenerateStreamHlsTokenResponse { + // The generated JWT token. + // + // The caller should insert this token to the authorization header of the HTTP + // requests to get the HLS playlist manifest and the video chunks. + // eg: curl -H "Authorization: Bearer $TOKEN" + // https://domain.com/test-stream.playback/master.m3u8 + string token = 1; + + // The expiration time of the token. + google.protobuf.Timestamp expiration_time = 2; +} + +// Message for requesting list of Events. +message ListEventsRequest { + // Required. Parent value for ListEventsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Events. +message ListEventsResponse { + // The list of Event. + repeated Event events = 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 Event. +message GetEventRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} + +// Message for creating a Event. +message CreateEventRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string event_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Event event = 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]; +} + +// Message for updating a Event. +message UpdateEventRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Event 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) = REQUIRED]; + + // Required. The resource being updated. + Event event = 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 deleting a Event. +message DeleteEventRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; + + // 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]; +} + +// Message for requesting list of Series. +message ListSeriesRequest { + // Required. Parent value for ListSeriesRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Series. +message ListSeriesResponse { + // The list of Series. + repeated Series series = 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 Series. +message GetSeriesRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + } + ]; +} + +// Message for creating a Series. +message CreateSeriesRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string series_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Series series = 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]; +} + +// Message for updating a Series. +message UpdateSeriesRequest { + // Required. Field mask is used to specify the fields to be overwritten in the Series + // 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) = REQUIRED]; + + // Required. The resource being updated + Series series = 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 deleting a Series. +message DeleteSeriesRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + } + ]; + + // 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]; +} + +// Message for materializing a channel. +message MaterializeChannelRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the channel. + string channel_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Channel channel = 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]; +} diff --git a/google/cloud/visionai/v1/visionai_grpc_service_config.json b/google/cloud/visionai/v1/visionai_grpc_service_config.json new file mode 100644 index 000000000..05b1df240 --- /dev/null +++ b/google/cloud/visionai/v1/visionai_grpc_service_config.json @@ -0,0 +1,206 @@ +{ + "methodConfig": [{ + "name": [{ + "service": "google.cloud.visionai.v1.Streams" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics" + }, + { + "service": "google.cloud.visionai.v1.EventWatcher" + } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Streams", + "method": "CreateCluster" + }], + "timeout": "600s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Streams", + "method": "CreateStream" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Streams", + "method": "CreateEvent" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Streams", + "method": "CreateSeries" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "CreateOperator" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "CreateVersion" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "CreateAnalysis" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Streams", + "method": "GetCluster" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "ListClusters" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "UpdateCluster" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "DeleteCluster" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "ListStreams" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "GetStream" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "UpdateStream" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "DeleteStream" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "ListEvents" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "GetEvent" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "UpdateEvent" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "DeleteEvent" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "ListSeries" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "GetSeries" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "UpdateSeries" + }, + { + "service": "google.cloud.visionai.v1.Streams", + "method": "DeleteSeries" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "ListOperators" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "GetOperator" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "UpdateOperator" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "DeleteOperator" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "ListAnalyses" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "GetAnalysis" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "UpdateAnalysis" + }, + { + "service": "google.cloud.visionai.v1.LiveVideoAnalytics", + "method": "DeleteAnalysis" + } + ], + "timeout": "60s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1.Warehouse", + "method": "CreateCorpus" + }, + { + "service": "google.cloud.visionai.v1.Warehouse", + "method": "CreateAsset" + }, + { + "service": "google.cloud.visionai.v1.Warehouse", + "method": "CreateDataSchema" + }, + { + "service": "google.cloud.visionai.v1.Warehouse", + "method": "CreateAnnotation" + }, + { + "service": "google.cloud.visionai.v1.Warehouse", + "method": "IngestAsset" + } + ], + "timeout": "120s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "120s", + "backoffMultiplier": 2.5, + "retryableStatusCodes": [ + "UNAVAILABLE", + "DEADLINE_EXCEEDED" + ] + } + } + ] +} diff --git a/google/cloud/visionai/v1/visionai_v1.yaml b/google/cloud/visionai/v1/visionai_v1.yaml new file mode 100644 index 000000000..d2d8b3e5a --- /dev/null +++ b/google/cloud/visionai/v1/visionai_v1.yaml @@ -0,0 +1,145 @@ +type: google.api.Service +config_version: 3 +name: visionai.googleapis.com +title: Vision AI API + +apis: +- name: google.cloud.location.Locations +- name: google.cloud.visionai.v1.AppPlatform +- name: google.cloud.visionai.v1.LiveVideoAnalytics +- name: google.cloud.visionai.v1.StreamingService +- name: google.cloud.visionai.v1.StreamsService +- name: google.cloud.visionai.v1.Warehouse +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations + +types: +- name: google.cloud.visionai.v1.AddApplicationStreamInputResponse +- name: google.cloud.visionai.v1.AppPlatformCloudFunctionRequest +- name: google.cloud.visionai.v1.AppPlatformCloudFunctionResponse +- name: google.cloud.visionai.v1.AppPlatformMetadata +- name: google.cloud.visionai.v1.ClassificationPredictionResult +- name: google.cloud.visionai.v1.CreateApplicationInstancesResponse +- name: google.cloud.visionai.v1.CreateCorpusMetadata +- name: google.cloud.visionai.v1.DeleteApplicationInstancesResponse +- name: google.cloud.visionai.v1.DeleteAssetMetadata +- name: google.cloud.visionai.v1.DeployApplicationResponse +- name: google.cloud.visionai.v1.GetStreamThumbnailResponse +- name: google.cloud.visionai.v1.ImageObjectDetectionPredictionResult +- name: google.cloud.visionai.v1.ImageSegmentationPredictionResult +- name: google.cloud.visionai.v1.ObjectDetectionPredictionResult +- name: google.cloud.visionai.v1.OccupancyCountingPredictionResult +- name: google.cloud.visionai.v1.OperationMetadata +- name: google.cloud.visionai.v1.PersonalProtectiveEquipmentDetectionOutput +- name: google.cloud.visionai.v1.RemoveApplicationStreamInputResponse +- name: google.cloud.visionai.v1.StreamAnnotations +- name: google.cloud.visionai.v1.UndeployApplicationResponse +- name: google.cloud.visionai.v1.UpdateApplicationInstancesResponse +- name: google.cloud.visionai.v1.UpdateApplicationStreamInputResponse +- name: google.cloud.visionai.v1.VideoActionRecognitionPredictionResult +- name: google.cloud.visionai.v1.VideoClassificationPredictionResult +- name: google.cloud.visionai.v1.VideoObjectTrackingPredictionResult + +documentation: + 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.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 + - selector: 'google.cloud.visionai.v1.AppPlatform.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1.LiveVideoAnalytics.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1.StreamsService.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1.Warehouse.*' + deadline: 60.0 + - selector: 'google.iam.v1.IAMPolicy.*' + deadline: 60.0 + - selector: 'google.longrunning.Operations.*' + deadline: 60.0 + +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/*}' + additional_bindings: + - get: '/v1/{name=projects/*/locations/*/warehouseOperations/*}' + - get: '/v1/{name=projects/*/locations/*/corpora/*/assets/*/operations/*}' + - selector: google.longrunning.Operations.ListOperations + get: '/v1/{name=projects/*/locations/*}/operations' + +authentication: + rules: + - 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.cloud.visionai.v1.AppPlatform.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1.LiveVideoAnalytics.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1.StreamingService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1.StreamsService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1.Warehouse.*' + 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 diff --git a/google/cloud/visionai/v1/warehouse.proto b/google/cloud/visionai/v1/warehouse.proto new file mode 100644 index 000000000..e49cd51f4 --- /dev/null +++ b/google/cloud/visionai/v1/warehouse.proto @@ -0,0 +1,1653 @@ +// 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.visionai.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/any.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/empty.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; +import "google/rpc/status.proto"; +import "google/type/datetime.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "WarehouseProto"; +option java_package = "com.google.cloud.visionai.v1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1"; +option ruby_package = "Google::Cloud::VisionAI::V1"; + +// Service that manages media content + metadata for streaming. +service Warehouse { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Creates an asset inside corpus. + rpc CreateAsset(CreateAssetRequest) returns (Asset) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/corpora/*}/assets" + body: "asset" + }; + option (google.api.method_signature) = "parent,asset,asset_id"; + } + + // Updates an asset inside corpus. + rpc UpdateAsset(UpdateAssetRequest) returns (Asset) { + option (google.api.http) = { + patch: "/v1/{asset.name=projects/*/locations/*/corpora/*/assets/*}" + body: "asset" + }; + option (google.api.method_signature) = "asset,update_mask"; + } + + // Reads an asset inside corpus. + rpc GetAsset(GetAssetRequest) returns (Asset) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/corpora/*/assets/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists an list of assets inside corpus. + rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/corpora/*}/assets" + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes asset inside corpus. + rpc DeleteAsset(DeleteAssetRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/corpora/*/assets/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "DeleteAssetMetadata" + }; + } + + // Creates a corpus inside a project. + rpc CreateCorpus(CreateCorpusRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/corpora" + body: "corpus" + }; + option (google.api.method_signature) = "parent,corpus"; + option (google.longrunning.operation_info) = { + response_type: "Corpus" + metadata_type: "CreateCorpusMetadata" + }; + } + + // Gets corpus details inside a project. + rpc GetCorpus(GetCorpusRequest) returns (Corpus) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/corpora/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Updates a corpus in a project. + rpc UpdateCorpus(UpdateCorpusRequest) returns (Corpus) { + option (google.api.http) = { + patch: "/v1/{corpus.name=projects/*/locations/*/corpora/*}" + body: "corpus" + }; + option (google.api.method_signature) = "corpus,update_mask"; + } + + // Lists all corpora in a project. + rpc ListCorpora(ListCorporaRequest) returns (ListCorporaResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/corpora" + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes a corpus only if its empty. + // Returns empty response. + rpc DeleteCorpus(DeleteCorpusRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/corpora/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates data schema inside corpus. + rpc CreateDataSchema(CreateDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" + body: "data_schema" + }; + option (google.api.method_signature) = "parent,data_schema"; + } + + // Updates data schema inside corpus. + rpc UpdateDataSchema(UpdateDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + patch: "/v1/{data_schema.name=projects/*/locations/*/corpora/*/dataSchemas/*}" + body: "data_schema" + }; + option (google.api.method_signature) = "data_schema,update_mask"; + } + + // Gets data schema inside corpus. + rpc GetDataSchema(GetDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Deletes data schema inside corpus. + rpc DeleteDataSchema(DeleteDataSchemaRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists a list of data schemas inside corpus. + rpc ListDataSchemas(ListDataSchemasRequest) returns (ListDataSchemasResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" + }; + option (google.api.method_signature) = "parent"; + } + + // Creates annotation inside asset. + rpc CreateAnnotation(CreateAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" + body: "annotation" + }; + option (google.api.method_signature) = "parent,annotation,annotation_id"; + } + + // Reads annotation inside asset. + rpc GetAnnotation(GetAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists a list of annotations inside asset. + rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" + }; + option (google.api.method_signature) = "parent"; + } + + // Updates annotation inside asset. + rpc UpdateAnnotation(UpdateAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + patch: "/v1/{annotation.name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + body: "annotation" + }; + option (google.api.method_signature) = "annotation,update_mask"; + } + + // Deletes annotation inside asset. + rpc DeleteAnnotation(DeleteAnnotationRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Ingests data for the asset. It is not allowed to ingest a data chunk which + // is already expired according to TTL. + // This method is only available via the gRPC API (not HTTP since + // bi-directional streaming is not supported via HTTP). + rpc IngestAsset(stream IngestAssetRequest) returns (stream IngestAssetResponse) { + } + + // Generates clips for downloading. The api takes in a time range, and + // generates a clip of the first content available after start_time and + // before end_time, which may overflow beyond these bounds. + // Returned clips are truncated if the total size of the clips are larger + // than 100MB. + rpc ClipAsset(ClipAssetRequest) returns (ClipAssetResponse) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/corpora/*/assets/*}:clip" + body: "*" + }; + } + + // Generates a uri for an HLS manifest. The api takes in a collection of time + // ranges, and generates a URI for an HLS manifest that covers all the + // requested time ranges. + rpc GenerateHlsUri(GenerateHlsUriRequest) returns (GenerateHlsUriResponse) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/corpora/*/assets/*}:generateHlsUri" + body: "*" + }; + } + + // Creates a search configuration inside a corpus. + // + // Please follow the rules below to create a valid CreateSearchConfigRequest. + // --- General Rules --- + // 1. Request.search_config_id must not be associated with an existing + // SearchConfig. + // 2. Request must contain at least one non-empty search_criteria_property or + // facet_property. + // 3. mapped_fields must not be empty, and must map to existing UGA keys. + // 4. All mapped_fields must be of the same type. + // 5. All mapped_fields must share the same granularity. + // 6. All mapped_fields must share the same semantic SearchConfig match + // options. + // For property-specific rules, please reference the comments for + // FacetProperty and SearchCriteriaProperty. + rpc CreateSearchConfig(CreateSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" + body: "search_config" + }; + option (google.api.method_signature) = "parent,search_config,search_config_id"; + } + + // Updates a search configuration inside a corpus. + // + // Please follow the rules below to create a valid UpdateSearchConfigRequest. + // --- General Rules --- + // 1. Request.search_configuration.name must already exist. + // 2. Request must contain at least one non-empty search_criteria_property or + // facet_property. + // 3. mapped_fields must not be empty, and must map to existing UGA keys. + // 4. All mapped_fields must be of the same type. + // 5. All mapped_fields must share the same granularity. + // 6. All mapped_fields must share the same semantic SearchConfig match + // options. + // For property-specific rules, please reference the comments for + // FacetProperty and SearchCriteriaProperty. + rpc UpdateSearchConfig(UpdateSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + patch: "/v1/{search_config.name=projects/*/locations/*/corpora/*/searchConfigs/*}" + body: "search_config" + }; + option (google.api.method_signature) = "search_config,update_mask"; + } + + // Gets a search configuration inside a corpus. + rpc GetSearchConfig(GetSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Deletes a search configuration inside a corpus. + // + // For a DeleteSearchConfigRequest to be valid, + // Request.search_configuration.name must already exist. + rpc DeleteSearchConfig(DeleteSearchConfigRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists all search configurations inside a corpus. + rpc ListSearchConfigs(ListSearchConfigsRequest) returns (ListSearchConfigsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" + }; + option (google.api.method_signature) = "parent"; + } + + // Search media asset. + rpc SearchAssets(SearchAssetsRequest) returns (SearchAssetsResponse) { + option (google.api.http) = { + post: "/v1/{corpus=projects/*/locations/*/corpora/*}:searchAssets" + body: "*" + }; + } +} + +// Different types for a facet bucket. +enum FacetBucketType { + // Unspecified type. + FACET_BUCKET_TYPE_UNSPECIFIED = 0; + + // Value type. + FACET_BUCKET_TYPE_VALUE = 1; + + // Datetime type. + FACET_BUCKET_TYPE_DATETIME = 2; + + // Fixed Range type. + FACET_BUCKET_TYPE_FIXED_RANGE = 3; + + // Custom Range type. + FACET_BUCKET_TYPE_CUSTOM_RANGE = 4; +} + +// Request message for CreateAssetRequest. +message CreateAssetRequest { + // Required. The parent resource where this asset will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // Required. The asset to create. + Asset asset = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The ID to use for the asset, which will become the final component of + // the asset's resource name if user choose to specify. Otherwise, asset id + // will be generated by system. + // + // This value should be up to 63 characters, and valid characters + // are /[a-z][0-9]-/. The first character must be a letter, the last could be + // a letter or a number. + optional string asset_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for GetAsset. +message GetAssetRequest { + // Required. The name of the asset to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; +} + +// Request message for ListAssets. +message ListAssetsRequest { + // Required. The parent, which owns this collection of assets. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Asset" + } + ]; + + // The maximum number of assets to return. The service may return fewer than + // this value. + // If unspecified, at most 50 assets 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 `ListAssets` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListAssets` must match + // the call that provided the page token. + string page_token = 3; +} + +// Response message for ListAssets. +message ListAssetsResponse { + // The assets from the specified corpus. + repeated Asset assets = 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; +} + +// Response message for UpdateAsset. +message UpdateAssetRequest { + // Required. The asset to update. + // + // The asset's `name` field is used to identify the asset to be updated. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + Asset asset = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for DeleteAsset. +message DeleteAssetRequest { + // Required. The name of the asset to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; +} + +// An asset is a resource in corpus. It represents a media object inside corpus, +// contains metadata and another resource annotation. Different feature could be +// applied to the asset to generate annotations. User could specified annotation +// related to the target asset. +message Asset { + option (google.api.resource) = { + type: "visionai.googleapis.com/Asset" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}" + }; + + // Resource name of the asset. + // Form: + // `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` + string name = 1; + + // The duration for which all media assets, associated metadata, and search + // documents can exist. If not set, then it will using the default ttl in the + // parent corpus resource. + google.protobuf.Duration ttl = 2; +} + +// Request message of CreateCorpus API. +message CreateCorpusRequest { + // Required. Form: `projects/{project_number}/locations/{location_id}` + string parent = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The corpus to be created. + Corpus corpus = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Metadata for CreateCorpus API. +message CreateCorpusMetadata { + +} + +// Corpus is a set of video contents for management. Within a corpus, videos +// share the same data schema. Search is also restricted within a single corpus. +message Corpus { + option (google.api.resource) = { + type: "visionai.googleapis.com/Corpus" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}" + }; + + // Resource name of the corpus. + // Form: + // `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` + string name = 1; + + // Required. The corpus name to shown in the UI. The name can be up to 32 characters + // long. + string display_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Description of the corpus. Can be up to 25000 characters long. + string description = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Required. The default TTL value for all assets under the corpus without a asset level + // user-defined TTL with a maximum of 10 years. This is required for all + // corpora. + google.protobuf.Duration default_ttl = 5 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for GetCorpus. +message GetCorpusRequest { + // Required. The resource name of the corpus to retrieve. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; +} + +// Request message for UpdateCorpus. +message UpdateCorpusRequest { + // Required. The corpus which replaces the resource on the server. + Corpus corpus = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for ListCorpora. +message ListCorporaRequest { + // Required. The resource name of the project from which to list corpora. + string parent = 1 [(google.api.field_behavior) = REQUIRED]; + + // Requested page size. API may return fewer results than requested. + // If negative, INVALID_ARGUMENT error will be returned. + // If unspecified or 0, API will pick a default size, which is 10. + // If the requested page size is larger than the maximum size, API will pick + // use the maximum size, which is 20. + int32 page_size = 2; + + // A token identifying a page of results for the server to return. + // Typically obtained via [ListCorpora.next_page_token][] of the previous + // [Warehouse.ListCorpora][google.cloud.visionai.v1.Warehouse.ListCorpora] call. + string page_token = 3; +} + +// Response message for ListCorpora. +message ListCorporaResponse { + // The corpora in the project. + repeated Corpus corpora = 1; + + // A token to retrieve next page of results. + // Pass to [ListCorporaRequest.page_token][google.cloud.visionai.v1.ListCorporaRequest.page_token] to obtain that page. + string next_page_token = 2; +} + +// Request message for DeleteCorpus. +message DeleteCorpusRequest { + // Required. The resource name of the corpus to delete. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; +} + +// Request message for CreateDataSchema. +message CreateDataSchemaRequest { + // Required. The parent resource where this data schema will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // Required. The data schema to create. + DataSchema data_schema = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Data schema indicates how the user specified annotation is interpreted in the +// system. +message DataSchema { + option (google.api.resource) = { + type: "visionai.googleapis.com/DataSchema" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}" + }; + + // Resource name of the data schema in the form of: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}` + // where {data_schema} part should be the same as the `key` field below. + string name = 1; + + // Required. The key of this data schema. This key should be matching the key of user + // specified annotation and unique inside corpus. This value can be up to + // 63 characters, and valid characters are /[a-z][0-9]-/. The first character + // must be a letter, the last could be a letter or a number. + string key = 2 [(google.api.field_behavior) = REQUIRED]; + + // The schema details mapping to the key. + DataSchemaDetails schema_details = 3; +} + +// Data schema details indicates the data type and the data struct corresponding +// to the key of user specified annotation. +message DataSchemaDetails { + // The configuration for `PROTO_ANY` data type. + message ProtoAnyConfig { + // The type URI of the proto message. + string type_uri = 1; + } + + // The search strategy for annotations value of the `key`. + message SearchStrategy { + // The types of search strategies to be applied on the annotation key. + enum SearchStrategyType { + // Annotatation values of the `key` above will not be searchable. + NO_SEARCH = 0; + + // When searching with `key`, the value must be exactly as the annotation + // value that has been ingested. + EXACT_SEARCH = 1; + + // When searching with `key`, Warehouse will perform broad search based on + // semantic of the annotation value. + SMART_SEARCH = 2; + } + + // The type of search strategy to be applied on the `key` above. + // The allowed `search_strategy_type` is different for different data types, + // which is documented in the DataSchemaDetails.DataType. Specifying + // unsupported `search_strategy_type` for data types will result in + // INVALID_ARGUMENT error. + SearchStrategyType search_strategy_type = 1; + } + + // Data type of the annotation. + enum DataType { + // Unspecified type. + DATA_TYPE_UNSPECIFIED = 0; + + // Integer type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by IntRangeArray. + INTEGER = 1; + + // Float type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by FloatRangeArray. + FLOAT = 2; + + // String type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH, + // - DataSchema.SearchStrategy.SMART_SEARCH. + STRING = 3; + + // Supported formats: + // %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) + // %Y-%m-%dT%H:%M:%E*S + // %Y-%m-%dT%H:%M%E*z + // %Y-%m-%dT%H:%M + // %Y-%m-%dT%H%E*z + // %Y-%m-%dT%H + // %Y-%m-%d%E*z + // %Y-%m-%d + // %Y-%m + // %Y + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by DateTimeRangeArray. + DATETIME = 5; + + // Geo coordinate type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by GeoLocationArray. + GEO_COORDINATE = 7; + + // Type to pass any proto as available in annotations.proto. Only use + // internally. + // Available proto types and its corresponding search behavior: + // - ImageObjectDetectionPredictionResult, allows SMART_SEARCH on + // display_names and NO_SEARCH. + // - ClassificationPredictionResult, allows SMART_SEARCH on display_names + // and NO_SEARCH. + // - ImageSegmentationPredictionResult, allows NO_SEARCH. + // - VideoActionRecognitionPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - VideoObjectTrackingPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - VideoClassificationPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - OccupancyCountingPredictionResult, allows EXACT_SEARCH on + // stats.full_frame_count.count and NO_SEARCH. + // - ObjectDetectionPredictionResult, allows SMART_SEARCH on + // identified_boxes.entity.label_string and NO_SEARCH. + PROTO_ANY = 8; + + // Boolean type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + BOOLEAN = 9; + } + + // The granularity of annotations under this DataSchema. + enum Granularity { + // Unspecified granularity. + GRANULARITY_UNSPECIFIED = 0; + + // Asset-level granularity (annotations must not contain partition info). + GRANULARITY_ASSET_LEVEL = 1; + + // Partition-level granularity (annotations must contain partition info). + GRANULARITY_PARTITION_LEVEL = 2; + } + + // Type of the annotation. + DataType type = 1; + + // Config for protobuf any type. + ProtoAnyConfig proto_any_config = 6; + + // The granularity associated with this DataSchema. + Granularity granularity = 5; + + // The search strategy to be applied on the `key` above. + SearchStrategy search_strategy = 7; +} + +// Request message for UpdateDataSchema. +message UpdateDataSchemaRequest { + // Required. The data schema's `name` field is used to identify the data schema to be + // updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema} + DataSchema data_schema = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for GetDataSchema. +message GetDataSchemaRequest { + // Required. The name of the data schema to retrieve. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/DataSchema" + } + ]; +} + +// Request message for DeleteDataSchema. +message DeleteDataSchemaRequest { + // Required. The name of the data schema to delete. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/DataSchema" + } + ]; +} + +// Request message for ListDataSchemas. +message ListDataSchemasRequest { + // Required. The parent, which owns this collection of data schemas. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/DataSchema" + } + ]; + + // The maximum number of data schemas to return. The service may return fewer + // than this value. If unspecified, at most 50 data schemas 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 `ListDataSchemas` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListDataSchemas` must + // match the call that provided the page token. + string page_token = 3; +} + +// Response message for ListDataSchemas. +message ListDataSchemasResponse { + // The data schemas from the specified corpus. + repeated DataSchema data_schemas = 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 CreateAnnotation. +message CreateAnnotationRequest { + // Required. The parent resource where this annotation will be created. + // Format: projects/*/locations/*/corpora/*/assets/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The annotation to create. + Annotation annotation = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The ID to use for the annotation, which will become the final component of + // the annotation's resource name if user choose to specify. Otherwise, + // annotation id will be generated by system. + // + // This value should be up to 63 characters, and valid characters + // are /[a-z][0-9]-/. The first character must be a letter, the last could be + // a letter or a number. + optional string annotation_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// An annotation is a resource in asset. It represents a key-value mapping of +// content in asset. +message Annotation { + option (google.api.resource) = { + type: "visionai.googleapis.com/Annotation" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}" + }; + + // Resource name of the annotation. + // Form: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` + string name = 1; + + // User provided annotation. + UserSpecifiedAnnotation user_specified_annotation = 2; +} + +// Annotation provided by users. +message UserSpecifiedAnnotation { + // Required. Key of the annotation. The key must be set with type by CreateDataSchema. + string key = 1 [(google.api.field_behavior) = REQUIRED]; + + // Value of the annotation. The value must be able to convert + // to the type according to the data schema. + AnnotationValue value = 2; + + // Partition information in time and space for the sub-asset level annotation. + Partition partition = 3; +} + +// Location Coordinate Representation +message GeoCoordinate { + // Latitude Coordinate. Degrees [-90 .. 90] + double latitude = 1; + + // Longitude Coordinate. Degrees [-180 .. 180] + double longitude = 2; +} + +// Value of annotation, including all types available in data schema. +message AnnotationValue { + oneof value { + // Value of int type annotation. + int64 int_value = 1; + + // Value of float type annotation. + float float_value = 2; + + // Value of string type annotation. + string str_value = 3; + + // Value of date time type annotation. + string datetime_value = 5; + + // Value of geo coordinate type annotation. + GeoCoordinate geo_coordinate = 7; + + // Value of any proto value. + google.protobuf.Any proto_any_value = 8; + + // Value of boolean type annotation. + bool bool_value = 9; + + // Value of customized struct annotation. + google.protobuf.Struct customized_struct_data_value = 10; + } +} + +// Request message for GetAnnotation API. +message ListAnnotationsRequest { + // The parent, which owns this collection of annotations. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string parent = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + }]; + + // The maximum number of annotations to return. The service may return fewer + // than this value. If unspecified, at most 50 annotations 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 `ListAnnotations` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListAnnotations` must + // match the call that provided the page token. + string page_token = 3; + + // The filter applied to the returned list. + // We only support filtering for the following fields: + // `partition.temporal_partition.start_time`, + // `partition.temporal_partition.end_time`, and `key`. + // Timestamps are specified in the RFC-3339 format, and only one restriction + // may be applied per field, joined by conjunctions. + // Format: + // "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND + // partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND + // key = "example_key"" + string filter = 4; +} + +// Request message for ListAnnotations API. +message ListAnnotationsResponse { + // The annotations from the specified asset. + repeated Annotation annotations = 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 GetAnnotation API. +message GetAnnotationRequest { + // Required. The name of the annotation to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Annotation" + } + ]; +} + +// Request message for UpdateAnnotation API. +message UpdateAnnotationRequest { + // Required. The annotation to update. + // The annotation's `name` field is used to identify the annotation to be + // updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + Annotation annotation = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for DeleteAnnotation API. +message DeleteAnnotationRequest { + // Required. The name of the annotation to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Annotation" + } + ]; +} + +// Request message for CreateSearchConfig. +message CreateSearchConfigRequest { + // Required. The parent resource where this search configuration will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/SearchConfig" + } + ]; + + // Required. The search config to create. + SearchConfig search_config = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. ID to use for the new search config. Will become the final component of the + // SearchConfig's resource name. This value should be up to 63 characters, and + // valid characters are /[a-z][0-9]-_/. The first character must be a letter, + // the last could be a letter or a number. + string search_config_id = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for UpdateSearchConfig. +message UpdateSearchConfigRequest { + // Required. The search configuration to update. + // + // The search configuration's `name` field is used to identify the resource to + // be updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + SearchConfig search_config = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. If left unset, all field paths will be + // updated/overwritten. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for GetSearchConfig. +message GetSearchConfigRequest { + // Required. The name of the search configuration to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/SearchConfig" + } + ]; +} + +// Request message for DeleteSearchConfig. +message DeleteSearchConfigRequest { + // Required. The name of the search configuration to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/SearchConfig" + } + ]; +} + +// Request message for ListSearchConfigs. +message ListSearchConfigsRequest { + // Required. The parent, which owns this collection of search configurations. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/SearchConfig" + } + ]; + + // The maximum number of search configurations to return. The service may + // return fewer than this value. If unspecified, a page size of 50 will be + // used. The maximum value is 1000; values above 1000 will be coerced to 1000. + int32 page_size = 2; + + // A page token, received from a previous `ListSearchConfigs` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListSearchConfigs` must match the call that provided the page + // token. + string page_token = 3; +} + +// Response message for ListSearchConfigs. +message ListSearchConfigsResponse { + // The search configurations from the specified corpus. + repeated SearchConfig search_configs = 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; +} + +// SearchConfig stores different properties that will affect search +// behaviors and search results. +message SearchConfig { + option (google.api.resource) = { + type: "visionai.googleapis.com/SearchConfig" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}" + }; + + // Resource name of the search configuration. + // For CustomSearchCriteria, search_config would be the search + // operator name. For Facets, search_config would be the facet + // dimension name. + // Form: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` + string name = 1; + + // Establishes a FacetDimension and associated specifications. + FacetProperty facet_property = 2; + + // Creates a mapping between a custom SearchCriteria and one or more UGA keys. + SearchCriteriaProperty search_criteria_property = 3; +} + +// Central configuration for a facet. +message FacetProperty { + // If bucket type is FIXED_RANGE, specify how values are bucketized. Use + // FixedRangeBucketSpec when you want to create multiple buckets with equal + // granularities. Using integer bucket value as an example, when + // bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet + // will be aggregated via the following buckets: + // [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). + // Notably, bucket_count <= 1 is an invalid spec. + message FixedRangeBucketSpec { + // Lower bound of the bucket. NOTE: Only integer type is currently supported + // for this field. + FacetValue bucket_start = 1; + + // Bucket granularity. NOTE: Only integer type is currently supported for + // this field. + FacetValue bucket_granularity = 2; + + // Total number of buckets. + int32 bucket_count = 3; + } + + // If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use + // integer bucket value as an example, when the endpoints are 0, 10, 100, and + // 1000, we will generate the following facets: + // [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). + // Notably: + // - endpoints must be listed in ascending order. Otherwise, the SearchConfig + // API will reject the facet config. + // - < 1 endpoints is an invalid spec. + message CustomRangeBucketSpec { + // Currently, only integer type is supported for this field. + repeated FacetValue endpoints = 1; + } + + // If bucket type is DATE, specify how date values are bucketized. + message DateTimeBucketSpec { + // Granularity enum for the datetime bucket. + enum Granularity { + // Unspecified granularity. + GRANULARITY_UNSPECIFIED = 0; + + // Granularity is year. + YEAR = 1; + + // Granularity is month. + MONTH = 2; + + // Granularity is day. + DAY = 3; + } + + // Granularity of date type facet. + Granularity granularity = 1; + } + + oneof range_facet_config { + // Fixed range facet bucket config. + FixedRangeBucketSpec fixed_range_bucket_spec = 5; + + // Custom range facet bucket config. + CustomRangeBucketSpec custom_range_bucket_spec = 6; + + // Datetime range facet bucket config. + DateTimeBucketSpec datetime_bucket_spec = 7; + } + + // Name of the facets, which are the dimensions users want to use to refine + // search results. `mapped_fields` will match UserSpecifiedDataSchema keys. + // + // For example, user can add a bunch of UGAs with the same key, such as + // player:adam, player:bob, player:charles. When multiple mapped_fields are + // specified, will merge their value together as final facet value. E.g. + // home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = + // [home_team, away_team], facet_value will be [a, b, c]. + // + // UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the + // mapped_field equals the parent SearchConfig.name, the parent must + // also contain a SearchCriteriaProperty that maps to the same fields. + // mapped_fields must not be empty. + repeated string mapped_fields = 1; + + // Display name of the facet. To be used by UI for facet rendering. + string display_name = 2; + + // Maximum number of unique bucket to return for one facet. Bucket number can + // be large for high-cardinality facet such as "player". We only return top-n + // most related ones to user. If it's <= 0, the server will decide the + // appropriate result_size. + int64 result_size = 3; + + // Facet bucket type e.g. value, range. + FacetBucketType bucket_type = 4; +} + +// Central configuration for custom search criteria. +message SearchCriteriaProperty { + // Each mapped_field corresponds to a UGA key. To understand how this property + // works, take the following example. In the SearchConfig table, the + // user adds this entry: + // search_config { + // name: "person" + // search_criteria_property { + // mapped_fields: "player" + // mapped_fields: "coach" + // } + // } + // + // Now, when a user issues a query like: + // criteria { + // field: "person" + // text_array { + // txt_values: "Tom Brady" + // txt_values: "Bill Belichick" + // } + // } + // + // MWH search will return search documents where (player=Tom Brady || + // coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick). + repeated string mapped_fields = 1; +} + +// Definition of a single value with generic type. +message FacetValue { + oneof value { + // String type value. + string string_value = 1; + + // Integer type value. + int64 integer_value = 2; + + // Datetime type value. + google.type.DateTime datetime_value = 3; + } +} + +// Holds the facet value, selections state, and metadata. +message FacetBucket { + // The range of values [start, end) for which faceting is applied. + message Range { + // Start of the range. Non-existence indicates some bound (e.g. -inf). + FacetValue start = 1; + + // End of the range. Non-existence indicates some bound (e.g. inf). + FacetValue end = 2; + } + + // Bucket associated with a facet. For example, bucket of facet “team” + // can be "49ers", "patriots", etc; bucket of facet "player" can be "tom + // brady", "drew brees", etc. + oneof bucket_value { + // Singular value. + FacetValue value = 2; + + // Range value. + Range range = 4; + } + + // Whether one facet bucket is selected. This field represents user's facet + // selection. It is set by frontend in SearchVideosRequest. + bool selected = 3; +} + +// A group of facet buckets to be passed back and forth between backend & +// frontend. +message FacetGroup { + // Unique id of the facet group. + string facet_id = 1; + + // Display name of the facet. To be used by UI for facet rendering. + string display_name = 2; + + // Buckets associated with the facet. E.g. for "Team" facet, the bucket + // can be 49ers, patriots, etc. + repeated FacetBucket buckets = 3; + + // Facet bucket type. + FacetBucketType bucket_type = 4; + + // If true, return query matched annotations for this facet group's selection. + // This option is only applicable for facets based on partition level + // annotations. It supports the following facet values: + // - INTEGER + // - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) + bool fetch_matched_annotations = 5; +} + +// Request message for IngestAsset API. +message IngestAssetRequest { + // Configuration for the data. + message Config { + // Type information for video data. + message VideoType { + // Container format of the video. + enum ContainerFormat { + // The default type, not supposed to be used. + CONTAINER_FORMAT_UNSPECIFIED = 0; + + // Mp4 container format. + CONTAINER_FORMAT_MP4 = 1; + } + + // Container format of the video data. + ContainerFormat container_format = 1; + } + + oneof data_type { + // Type information for video data. + VideoType video_type = 2; + } + + // Required. The resource name of the asset that the ingested data belongs to. + string asset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + } + + // Contains the data and the corresponding time range this data is for. + message TimeIndexedData { + // Data to be ingested. + bytes data = 1; + + // Time range of the data. + Partition.TemporalPartition temporal_partition = 2; + } + + oneof streaming_request { + // Provides information for the data and the asset resource name that the + // data belongs to. The first `IngestAssetRequest` message must only contain + // a `Config` message. + Config config = 1; + + // Data to be ingested. + TimeIndexedData time_indexed_data = 2; + } +} + +// Response message for IngestAsset API. +message IngestAssetResponse { + // Time range of the data that has been successfully ingested. + Partition.TemporalPartition successfully_ingested_partition = 1; +} + +// Request message for ClipAsset API. +message ClipAssetRequest { + // Required. The resource name of the asset to request clips for. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The time range to request clips for. + Partition.TemporalPartition temporal_partition = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for ClipAsset API. +message ClipAssetResponse { + // Signed uri with corresponding time range. + message TimeIndexedUri { + // Time range of the video that the uri is for. + Partition.TemporalPartition temporal_partition = 1; + + // Signed uri to download the video clip. + string uri = 2; + } + + // A list of signed uris to download the video clips that cover the requested + // time range ordered by time. + repeated TimeIndexedUri time_indexed_uris = 1; +} + +// Request message for GenerateHlsUri API. +message GenerateHlsUriRequest { + // Required. The resource name of the asset to request clips for. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The time range to request clips for. + repeated Partition.TemporalPartition temporal_partitions = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for GenerateHlsUri API. +message GenerateHlsUriResponse { + // A signed uri to download the HLS manifest corresponding to the requested + // times. + string uri = 1; + + // A list of temporal partitions of the content returned in the order they + // appear in the stream. + repeated Partition.TemporalPartition temporal_partitions = 2; +} + +// Request message for SearchAssets. +message SearchAssetsRequest { + // Required. The parent corpus to search. + // Form: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}' + string corpus = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // The number of results to be returned in this page. If it's 0, the server + // will decide the appropriate page_size. + int32 page_size = 2; + + // The continuation token to fetch the next page. If empty, it means it is + // fetching the first page. + string page_token = 3; + + // Time ranges that matching video content must fall within. If no ranges are + // provided, there will be no time restriction. This field is treated just + // like the criteria below, but defined separately for convenience as it is + // used frequently. Note that if the end_time is in the future, it will be + // clamped to the time the request was received. + DateTimeRangeArray content_time_ranges = 5; + + // Criteria applied to search results. + repeated Criteria criteria = 4; + + // Stores most recent facet selection state. Only facet groups with user's + // selection will be presented here. Selection state is either selected or + // unselected. Only selected facet buckets will be used as search criteria. + repeated FacetGroup facet_selections = 6; + + // A list of annotation keys to specify the annotations to be retrieved and + // returned with each search result. + // Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search + // strategy must not be NO_SEARCH. + repeated string result_annotation_keys = 8; +} + +// The metadata for DeleteAsset API that embeds in +// [metadata][google.longrunning.Operation.metadata] field. +message DeleteAssetMetadata { + +} + +// Stores the criteria-annotation matching results for each search result item. +message AnnotationMatchingResult { + // The criteria used for matching. It can be an input search criteria or a + // criteria converted from a facet selection. + Criteria criteria = 1; + + // Matched annotations for the criteria. + repeated Annotation matched_annotations = 2; + + // Status of the match result. Possible values: + // FAILED_PRECONDITION - the criteria is not eligible for match. + // OK - matching is performed. + google.rpc.Status status = 3; +} + +// Search result contains asset name and corresponding time ranges. +message SearchResultItem { + // The resource name of the asset. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string asset = 1; + + // The matched asset segments. + // Deprecated: please use singular `segment` field. + repeated Partition.TemporalPartition segments = 2 [deprecated = true]; + + // The matched asset segment. + Partition.TemporalPartition segment = 5; + + // Search result annotations specified by result_annotation_keys in search + // request. + repeated Annotation requested_annotations = 3; + + // Criteria or facet-selection based annotation matching results associated to + // this search result item. Only contains results for criteria or + // facet_selections with fetch_matched_annotations=true. + repeated AnnotationMatchingResult annotation_matching_results = 4; +} + +// Response message for SearchAssets. +message SearchAssetsResponse { + // Returned search results. + repeated SearchResultItem search_result_items = 1; + + // The next-page continuation token. + string next_page_token = 2; + + // Facet search results of a given query, which contains user's + // already-selected facet values and updated facet search results. + repeated FacetGroup facet_results = 3; +} + +// Integer range type. +message IntRange { + // Start of the int range. + optional int64 start = 1; + + // End of the int range. + optional int64 end = 2; +} + +// Float range type. +message FloatRange { + // Start of the float range. + optional float start = 1; + + // End of the float range. + optional float end = 2; +} + +// A list of string-type values. +message StringArray { + // String type values. + repeated string txt_values = 1; +} + +// A list of integer range values. +message IntRangeArray { + // Int range values. + repeated IntRange int_ranges = 1; +} + +// A list of float range values. +message FloatRangeArray { + // Float range values. + repeated FloatRange float_ranges = 1; +} + +// Datetime range type. +message DateTimeRange { + // Start date time. + google.type.DateTime start = 1; + + // End data time. + google.type.DateTime end = 2; +} + +// A list of datetime range values. +message DateTimeRangeArray { + // Date time ranges. + repeated DateTimeRange date_time_ranges = 1; +} + +// Representation of a circle area. +message CircleArea { + // Latitude of circle area's center. Degrees [-90 .. 90] + double latitude = 1; + + // Longitude of circle area's center. Degrees [-180 .. 180] + double longitude = 2; + + // Radius of the circle area in meters. + double radius_meter = 3; +} + +// A list of locations. +message GeoLocationArray { + // A list of circle areas. + repeated CircleArea circle_areas = 1; +} + +message BoolValue { + bool value = 1; +} + +// Filter criteria applied to current search results. +message Criteria { + oneof value { + // The text values associated with the field. + StringArray text_array = 2; + + // The integer ranges associated with the field. + IntRangeArray int_range_array = 3; + + // The float ranges associated with the field. + FloatRangeArray float_range_array = 4; + + // The datetime ranges associated with the field. + DateTimeRangeArray date_time_range_array = 5; + + // Geo Location array. + GeoLocationArray geo_location_array = 6; + + // A Boolean value. + BoolValue bool_value = 7; + } + + // The UGA field or ML field to apply filtering criteria. + string field = 1; + + // If true, return query matched annotations for this criteria. + // This option is only applicable for partition level annotations and supports + // the following data types: + // - INTEGER + // - FLOAT + // - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) + // - BOOLEAN + bool fetch_matched_annotations = 8; +} + +// Partition to specify the partition in time and space for sub-asset level +// annotation. +message Partition { + // Partition of asset in UTC Epoch time. + message TemporalPartition { + // Start time of the partition. + google.protobuf.Timestamp start_time = 1; + + // End time of the partition. + google.protobuf.Timestamp end_time = 2; + } + + // Partition of asset in space. + message SpatialPartition { + // The minimum x coordinate value. + optional int64 x_min = 1; + + // The minimum y coordinate value. + optional int64 y_min = 2; + + // The maximum x coordinate value. + optional int64 x_max = 3; + + // The maximum y coordinate value. + optional int64 y_max = 4; + } + + // Partition of asset in time. + TemporalPartition temporal_partition = 1; + + // Partition of asset in space. + SpatialPartition spatial_partition = 2; +} diff --git a/google/cloud/visionai/v1alpha1/BUILD.bazel b/google/cloud/visionai/v1alpha1/BUILD.bazel new file mode 100644 index 000000000..1155c6f21 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/BUILD.bazel @@ -0,0 +1,426 @@ +# 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 = "visionai_proto", + srcs = [ + "annotations.proto", + "common.proto", + "lva.proto", + "lva_resources.proto", + "lva_service.proto", + "platform.proto", + "streaming_resources.proto", + "streaming_service.proto", + "streams_resources.proto", + "streams_service.proto", + "warehouse.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:datetime_proto", + "@com_google_protobuf//:any_proto", + "@com_google_protobuf//:duration_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 = "visionai_proto_with_info", + deps = [ + ":visionai_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 = "visionai_java_proto", + deps = [":visionai_proto"], +) + +java_grpc_library( + name = "visionai_java_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_java_proto"], +) + +java_gapic_library( + name = "visionai_java_gapic", + srcs = [":visionai_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + test_deps = [ + ":visionai_java_grpc", + "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":visionai_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", + ], +) + +java_gapic_test( + name = "visionai_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.visionai.v1alpha1.AppPlatformClientHttpJsonTest", + "com.google.cloud.visionai.v1alpha1.AppPlatformClientTest", + "com.google.cloud.visionai.v1alpha1.LiveVideoAnalyticsClientHttpJsonTest", + "com.google.cloud.visionai.v1alpha1.LiveVideoAnalyticsClientTest", + "com.google.cloud.visionai.v1alpha1.StreamingServiceClientHttpJsonTest", + "com.google.cloud.visionai.v1alpha1.StreamingServiceClientTest", + "com.google.cloud.visionai.v1alpha1.StreamsServiceClientHttpJsonTest", + "com.google.cloud.visionai.v1alpha1.StreamsServiceClientTest", + "com.google.cloud.visionai.v1alpha1.WarehouseClientHttpJsonTest", + "com.google.cloud.visionai.v1alpha1.WarehouseClientTest", + ], + runtime_deps = [":visionai_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-visionai-v1alpha1-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":visionai_java_gapic", + ":visionai_java_grpc", + ":visionai_java_proto", + ":visionai_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 = "visionai_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1", + protos = [":visionai_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", + "//google/rpc:status_go_proto", + "//google/type:datetime_go_proto", + ], +) + +go_gapic_library( + name = "visionai_go_gapic", + srcs = [":visionai_proto_with_info"], + grpc_service_config = "visionai_grpc_service_config.json", + importpath = "cloud.google.com/go/visionai/apiv1alpha1;visionai", + metadata = True, + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + transport = "grpc+rest", + deps = [ + ":visionai_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:any_go_proto", + "@io_bazel_rules_go//proto/wkt:duration_go_proto", + "@io_bazel_rules_go//proto/wkt:struct_go_proto", + ], +) + +go_test( + name = "visionai_go_gapic_test", + srcs = [":visionai_go_gapic_srcjar_test"], + embed = [":visionai_go_gapic"], + importpath = "cloud.google.com/go/visionai/apiv1alpha1", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-visionai-v1alpha1-go", + deps = [ + ":visionai_go_gapic", + ":visionai_go_gapic_srcjar-metadata.srcjar", + ":visionai_go_gapic_srcjar-test.srcjar", + ":visionai_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "visionai_py_gapic", + srcs = [":visionai_proto"], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + transport = "grpc+rest", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], +) + +py_test( + name = "visionai_py_gapic_test", + srcs = [ + "visionai_py_gapic_pytest.py", + "visionai_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":visionai_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "visionai-v1alpha1-py", + deps = [ + ":visionai_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 = "visionai_php_proto", + deps = [":visionai_proto"], +) + +php_grpc_library( + name = "visionai_php_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_php_proto"], +) + +php_gapic_library( + name = "visionai_php_gapic", + srcs = [":visionai_proto_with_info"], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + transport = "grpc+rest", + deps = [ + ":visionai_php_grpc", + ":visionai_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-visionai-v1alpha1-php", + deps = [ + ":visionai_php_gapic", + ":visionai_php_grpc", + ":visionai_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "visionai_nodejs_gapic", + package_name = "@google-cloud/visionai", + src = ":visionai_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "visionai_grpc_service_config.json", + package = "google.cloud.visionai.v1alpha1", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + transport = "grpc+rest", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "visionai-v1alpha1-nodejs", + deps = [ + ":visionai_nodejs_gapic", + ":visionai_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 = "visionai_ruby_proto", + deps = [":visionai_proto"], +) + +ruby_grpc_library( + name = "visionai_ruby_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "visionai_ruby_gapic", + srcs = [":visionai_proto_with_info"], + extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-visionai-v1alpha1"], + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + deps = [ + ":visionai_ruby_grpc", + ":visionai_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-visionai-v1alpha1-ruby", + deps = [ + ":visionai_ruby_gapic", + ":visionai_ruby_grpc", + ":visionai_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 = "visionai_csharp_proto", + deps = [":visionai_proto"], +) + +csharp_grpc_library( + name = "visionai_csharp_grpc", + srcs = [":visionai_proto"], + deps = [":visionai_csharp_proto"], +) + +csharp_gapic_library( + name = "visionai_csharp_gapic", + srcs = [":visionai_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "visionai_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "visionai_v1alpha1.yaml", + deps = [ + ":visionai_csharp_grpc", + ":visionai_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-visionai-v1alpha1-csharp", + deps = [ + ":visionai_csharp_gapic", + ":visionai_csharp_grpc", + ":visionai_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "visionai_cc_proto", + deps = [":visionai_proto"], +) + +cc_grpc_library( + name = "visionai_cc_grpc", + srcs = [":visionai_proto"], + grpc_only = True, + generate_mocks = True, + deps = [":visionai_cc_proto"], +) diff --git a/google/cloud/visionai/v1alpha1/annotations.proto b/google/cloud/visionai/v1alpha1/annotations.proto new file mode 100644 index 000000000..55c1fdcd9 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/annotations.proto @@ -0,0 +1,659 @@ +// 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.visionai.v1alpha1; + +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "AnnotationsProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Enum describing all possible types of a stream annotation. +enum StreamAnnotationType { + // Type UNSPECIFIED. + STREAM_ANNOTATION_TYPE_UNSPECIFIED = 0; + + // active_zone annotation defines a polygon on top of the content from an + // image/video based stream, following processing will only focus on the + // content inside the active zone. + STREAM_ANNOTATION_TYPE_ACTIVE_ZONE = 1; + + // crossing_line annotation defines a polyline on top of the content from an + // image/video based Vision AI stream, events happening across the line will + // be captured. For example, the counts of people who goes acroos the line + // in Occupancy Analytic Processor. + STREAM_ANNOTATION_TYPE_CROSSING_LINE = 2; +} + +// Output format for Personal Protective Equipment Detection Operator. +message PersonalProtectiveEquipmentDetectionOutput { + // The entity info for annotations from person detection prediction result. + message PersonEntity { + // Entity id. + int64 person_entity_id = 1; + } + + // The entity info for annotations from PPE detection prediction result. + message PPEEntity { + // Label id. + int64 ppe_label_id = 1; + + // Human readable string of the label (Examples: helmet, glove, mask). + string ppe_label_string = 2; + + // Human readable string of the super category label (Examples: head_cover, + // hands_cover, face_cover). + string ppe_supercategory_label_string = 3; + + // Entity id. + int64 ppe_entity_id = 4; + } + + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // PersonIdentified box contains the location and the entity info of the + // person. + message PersonIdentifiedBox { + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // Person entity info. + PersonEntity person_entity = 4; + } + + // PPEIdentified box contains the location and the entity info of the PPE. + message PPEIdentifiedBox { + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // PPE entity info. + PPEEntity ppe_entity = 4; + } + + // Detected Person contains the detected person and their associated + // ppes and their protecting information. + message DetectedPerson { + // The id of detected person. + int64 person_id = 1; + + // The info of detected person identified box. + PersonIdentifiedBox detected_person_identified_box = 2; + + // The info of detected person associated ppe identified boxes. + repeated PPEIdentifiedBox detected_ppe_identified_boxes = 3; + + // Coverage score for each body part. + // Coverage score for face. + optional float face_coverage_score = 4; + + // Coverage score for eyes. + optional float eyes_coverage_score = 5; + + // Coverage score for head. + optional float head_coverage_score = 6; + + // Coverage score for hands. + optional float hands_coverage_score = 7; + + // Coverage score for body. + optional float body_coverage_score = 8; + + // Coverage score for feet. + optional float feet_coverage_score = 9; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of DetectedPersons. + repeated DetectedPerson detected_persons = 2; +} + +// Prediction output format for Generic Object Detection. +message ObjectDetectionPredictionResult { + // The entity info for annotations from object detection prediction result. + message Entity { + // Label id. + int64 label_id = 1; + + // Human readable string of the label. + string label_string = 2; + } + + // Identified box contains location and the entity of the object. + message IdentifiedBox { + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float confidence_score = 3; + + // Entity of this box. + Entity entity = 4; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of identified boxes. + repeated IdentifiedBox identified_boxes = 2; +} + +// Prediction output format for Image Object Detection. +message ImageObjectDetectionPredictionResult { + // The resource IDs of the AnnotationSpecs that had been identified, ordered + // by the confidence score descendingly. It is the id segment instead of full + // resource name. + repeated int64 ids = 1; + + // The display names of the AnnotationSpecs that had been identified, order + // matches the IDs. + repeated string display_names = 2; + + // The Model's confidences in correctness of the predicted IDs, higher value + // means higher confidence. Order matches the Ids. + repeated float confidences = 3; + + // Bounding boxes, i.e. the rectangles over the image, that pinpoint + // the found AnnotationSpecs. Given in order that matches the IDs. Each + // bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and + // `yMax`, which represent the extremal coordinates of the box. They are + // relative to the image size, and the point 0,0 is in the top left + // of the image. + repeated google.protobuf.ListValue bboxes = 4; +} + +// Prediction output format for Image and Text Classification. +message ClassificationPredictionResult { + // The resource IDs of the AnnotationSpecs that had been identified. + repeated int64 ids = 1; + + // The display names of the AnnotationSpecs that had been identified, order + // matches the IDs. + repeated string display_names = 2; + + // The Model's confidences in correctness of the predicted IDs, higher value + // means higher confidence. Order matches the Ids. + repeated float confidences = 3; +} + +// Prediction output format for Image Segmentation. +message ImageSegmentationPredictionResult { + // A PNG image where each pixel in the mask represents the category in which + // the pixel in the original image was predicted to belong to. The size of + // this image will be the same as the original image. The mapping between the + // AnntoationSpec and the color can be found in model's metadata. The model + // will choose the most likely category and if none of the categories reach + // the confidence threshold, the pixel will be marked as background. + string category_mask = 1; + + // A one channel image which is encoded as an 8bit lossless PNG. The size of + // the image will be the same as the original image. For a specific pixel, + // darker color means less confidence in correctness of the cateogry in the + // categoryMask for the corresponding pixel. Black means no confidence and + // white means complete confidence. + string confidence_mask = 2; +} + +// Prediction output format for Video Action Recognition. +message VideoActionRecognitionPredictionResult { + // Each IdentifiedAction is one particular identification of an action + // specified with the AnnotationSpec id, display_name and the associated + // confidence score. + message IdentifiedAction { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 3; + } + + // The beginning, inclusive, of the video's time segment in which the + // actions have been identified. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the actions have + // been identified. Particularly, if the end is the same as the start, it + // means the identification happens on a specific video frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the actions identified in the time range. + repeated IdentifiedAction actions = 3; +} + +// Prediction output format for Video Object Tracking. +message VideoObjectTrackingPredictionResult { + // Boundingbox for detected object. I.e. the rectangle over the video frame + // pinpointing the found AnnotationSpec. The coordinates are relative to the + // frame size, and the point 0,0 is in the top left of the frame. + message BoundingBox { + // The leftmost coordinate of the bounding box. + float x_min = 1; + + // The rightmost coordinate of the bounding box. + float x_max = 2; + + // The topmost coordinate of the bounding box. + float y_min = 3; + + // The bottommost coordinate of the bounding box. + float y_max = 4; + } + + // Each DetectedObject is one particular identification of an object + // specified with the AnnotationSpec id and display_name, the bounding box, + // the associated confidence score and the corresponding track_id. + message DetectedObject { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // Boundingbox. + BoundingBox bounding_box = 3; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 4; + + // The same object may be identified on muitiple frames which are typical + // adjacent. The set of frames where a particular object has been detected + // form a track. This track_id can be used to trace down all frames for an + // detected object. + int64 track_id = 5; + } + + // The beginning, inclusive, of the video's time segment in which the + // current identifications happens. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the current + // identifications happen. Particularly, if the end is the same as the start, + // it means the identifications happen on a specific video frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the objects detected in the specified time range. + repeated DetectedObject objects = 3; +} + +// Prediction output format for Video Classification. +message VideoClassificationPredictionResult { + // Each IdentifiedClassification is one particular identification of an + // classification specified with the AnnotationSpec id and display_name, + // and the associated confidence score. + message IdentifiedClassification { + // The resource ID of the AnnotationSpec that had been identified. + string id = 1; + + // The display name of the AnnotationSpec that had been identified. + string display_name = 2; + + // The Model's confidence in correction of this identification, higher + // value means higher confidence. + float confidence = 3; + } + + // The beginning, inclusive, of the video's time segment in which the + // classifications have been identified. + google.protobuf.Timestamp segment_start_time = 1; + + // The end, inclusive, of the video's time segment in which the + // classifications have been identified. Particularly, if the end is the same + // as the start, it means the identification happens on a specific video + // frame. + google.protobuf.Timestamp segment_end_time = 2; + + // All of the classifications identified in the time range. + repeated IdentifiedClassification classifications = 3; +} + +// The prediction result proto for occupancy counting. +message OccupancyCountingPredictionResult { + // The entity info for annotations from occupancy counting operator. + message Entity { + // Label id. + int64 label_id = 1; + + // Human readable string of the label. + string label_string = 2; + } + + // Identified box contains location and the entity of the object. + message IdentifiedBox { + // Bounding Box in the normalized coordinates. + message NormalizedBoundingBox { + // Min in x coordinate. + float xmin = 1; + + // Min in y coordinate. + float ymin = 2; + + // Width of the bounding box. + float width = 3; + + // Height of the bounding box. + float height = 4; + } + + // An unique id for this box. + int64 box_id = 1; + + // Bounding Box in the normalized coordinates. + NormalizedBoundingBox normalized_bounding_box = 2; + + // Confidence score associated with this box. + float score = 3; + + // Entity of this box. + Entity entity = 4; + + // An unique id to identify a track. It should be consistent across frames. + // It only exists if tracking is enabled. + int64 track_id = 5; + } + + // The statistics info for annotations from occupancy counting operator. + message Stats { + // The object info and instant count for annotations from occupancy counting + // operator. + message ObjectCount { + // Entity of this object. + Entity entity = 1; + + // Count of the object. + int32 count = 2; + } + + // The object info and accumulated count for annotations from occupancy + // counting operator. + message AccumulatedObjectCount { + // The start time of the accumulated count. + google.protobuf.Timestamp start_time = 1; + + // The object count for the accumulated count. + ObjectCount object_count = 2; + } + + // Message for Crossing line count. + message CrossingLineCount { + // Line annotation from the user. + StreamAnnotation annotation = 1; + + // The direction that follows the right hand rule. + repeated ObjectCount positive_direction_counts = 2; + + // The direction that is opposite to the right hand rule. + repeated ObjectCount negative_direction_counts = 3; + + // The accumulated positive count. + repeated AccumulatedObjectCount accumulated_positive_direction_counts = 4; + + // The accumulated negative count. + repeated AccumulatedObjectCount accumulated_negative_direction_counts = 5; + } + + // Message for the active zone count. + message ActiveZoneCount { + // Active zone annotation from the user. + StreamAnnotation annotation = 1; + + // Counts in the zone. + repeated ObjectCount counts = 2; + } + + // Counts of the full frame. + repeated ObjectCount full_frame_count = 1; + + // Crossing line counts. + repeated CrossingLineCount crossing_line_counts = 2; + + // Active zone counts. + repeated ActiveZoneCount active_zone_counts = 3; + } + + // The track info for annotations from occupancy counting operator. + message TrackInfo { + // An unique id to identify a track. It should be consistent across frames. + string track_id = 1; + + // Start timestamp of this track. + google.protobuf.Timestamp start_time = 2; + } + + // The dwell time info for annotations from occupancy counting operator. + message DwellTimeInfo { + // An unique id to identify a track. It should be consistent across frames. + string track_id = 1; + + // The unique id for the zone in which the object is dwelling/waiting. + string zone_id = 2; + + // The beginning time when a dwelling object has been identified in a zone. + google.protobuf.Timestamp dwell_start_time = 3; + + // The end time when a dwelling object has exited in a zone. + google.protobuf.Timestamp dwell_end_time = 4; + } + + // Current timestamp. + google.protobuf.Timestamp current_time = 1; + + // A list of identified boxes. + repeated IdentifiedBox identified_boxes = 2; + + // Detection statistics. + Stats stats = 3; + + // Track related information. All the tracks that are live at this timestamp. + // It only exists if tracking is enabled. + repeated TrackInfo track_info = 4; + + // Dwell time related information. All the tracks that are live in a given + // zone with a start and end dwell time timestamp + repeated DwellTimeInfo dwell_time_info = 5; +} + +// message about annotations about Vision AI stream resource. +message StreamAnnotation { + oneof annotation_payload { + // Annotation for type ACTIVE_ZONE + NormalizedPolygon active_zone = 5; + + // Annotation for type CROSSING_LINE + NormalizedPolyline crossing_line = 6; + } + + // ID of the annotation. It must be unique when used in the certain context. + // For example, all the annotations to one input streams of a Vision AI + // application. + string id = 1; + + // User-friendly name for the annotation. + string display_name = 2; + + // The Vision AI stream resource name. + string source_stream = 3; + + // The actual type of Annotation. + StreamAnnotationType type = 4; +} + +// A wrapper of repeated StreamAnnotation. +message StreamAnnotations { + // Multiple annotations. + repeated StreamAnnotation stream_annotations = 1; +} + +// Normalized Polygon. +message NormalizedPolygon { + // The bounding polygon normalized vertices. Top left corner of the image + // will be [0, 0]. + repeated NormalizedVertex normalized_vertices = 1; +} + +// Normalized Pplyline, which represents a curve consisting of connected +// straight-line segments. +message NormalizedPolyline { + // A sequence of vertices connected by straight lines. + repeated NormalizedVertex normalized_vertices = 1; +} + +// A vertex represents a 2D point in the image. +// NOTE: the normalized vertex coordinates are relative to the original image +// and range from 0 to 1. +message NormalizedVertex { + // X coordinate. + float x = 1; + + // Y coordinate. + float y = 2; +} + +// Message of essential metadata of App Platform. +// This message is usually attached to a certain processor output annotation for +// customer to identify the source of the data. +message AppPlatformMetadata { + // The application resource name. + string application = 1; + + // The instance resource id. Instance is the nested resource of application + // under collection 'instances'. + string instance_id = 2; + + // The node name of the application graph. + string node = 3; + + // The referred processor resource name of the application node. + string processor = 4; +} + +// For any cloud function based customer processing logic, customer's cloud +// function is expected to receive AppPlatformCloudFunctionRequest as request +// and send back AppPlatformCloudFunctionResponse as response. +// Message of request from AppPlatform to Cloud Function. +message AppPlatformCloudFunctionRequest { + // A general annotation message that uses struct format to represent different + // concrete annotation protobufs. + message StructedInputAnnotation { + // The ingestion time of the current annotation. + int64 ingestion_time_micros = 1; + + // The struct format of the actual annotation. + google.protobuf.Struct annotation = 2; + } + + // The metadata of the AppPlatform for customer to identify the source of the + // payload. + AppPlatformMetadata app_platform_metadata = 1; + + // The actual annotations to be processed by the customized Cloud Function. + repeated StructedInputAnnotation annotations = 2; +} + +// Message of the response from customer's Cloud Function to AppPlatform. +message AppPlatformCloudFunctionResponse { + // A general annotation message that uses struct format to represent different + // concrete annotation protobufs. + message StructedOutputAnnotation { + // The struct format of the actual annotation. + google.protobuf.Struct annotation = 1; + } + + // The modified annotations that is returned back to AppPlatform. + // If the annotations fields are empty, then those annotations will be dropped + // by AppPlatform. + repeated StructedOutputAnnotation annotations = 2; + + // If set to true, AppPlatform will use original annotations instead of + // dropping them, even if it is empty in the annotations filed. + bool annotation_passthrough = 3; + + // The event notifications that is returned back to AppPlatform. Typically it + // will then be configured to be consumed/forwared to a operator that handles + // events, such as Pub/Sub operator. + repeated AppPlatformEventBody events = 4; +} + +// Message of content of appPlatform event +message AppPlatformEventBody { + // Human readable string of the event like "There are more than 6 people in + // the scene". or "Shelf is empty!". + string event_message = 1; + + // For the case of Pub/Sub, it will be stored in the message attributes. + // ​​pubsub.proto + google.protobuf.Struct payload = 2; + + // User defined Event Id, used to classify event, within a delivery interval, + // events from the same application instance with the same id will be + // de-duplicated & only first one will be sent out. Empty event_id will be + // treated as "". + string event_id = 3; +} diff --git a/google/cloud/visionai/v1alpha1/common.proto b/google/cloud/visionai/v1alpha1/common.proto new file mode 100644 index 000000000..ff8dd102b --- /dev/null +++ b/google/cloud/visionai/v1alpha1/common.proto @@ -0,0 +1,114 @@ +// 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.visionai.v1alpha1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "CommonProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Message describing the Cluster object. +message Cluster { + option (google.api.resource) = { + type: "visionai.googleapis.com/Cluster" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}" + }; + + // The current state of the cluster. + enum State { + // Not set. + STATE_UNSPECIFIED = 0; + + // The PROVISIONING state indicates the cluster is being created. + PROVISIONING = 1; + + // The RUNNING state indicates the cluster has been created and is fully + // usable. + RUNNING = 2; + + // The STOPPING state indicates the cluster is being deleted. + STOPPING = 3; + + // The ERROR state indicates the cluster is unusable. It will be + // automatically deleted. + ERROR = 4; + } + + // Output only. Name of the resource. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Output only. The DNS name of the data plane service + string dataplane_service_endpoint = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The current state of the cluster. + State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The private service connection service target name. + string psc_target = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// 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]; + + // 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]; +} + +// The Google Cloud Storage location for the input content. +message GcsSource { + // Required. References to a Google Cloud Storage paths. + repeated string uris = 1 [(google.api.field_behavior) = REQUIRED]; +} diff --git a/google/cloud/visionai/v1alpha1/lva.proto b/google/cloud/visionai/v1alpha1/lva.proto new file mode 100644 index 000000000..939639a80 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/lva.proto @@ -0,0 +1,115 @@ +// 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.visionai.v1alpha1; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Represents an actual value of an operator attribute. +message AttributeValue { + // Attribute value. + oneof value { + // int. + int64 i = 1; + + // float. + float f = 2; + + // bool. + bool b = 3; + + // string. + bytes s = 4; + } +} + +// Defines an Analyzer. +// +// An analyzer processes data from its input streams using the logic defined in +// the Operator that it represents. Of course, it produces data for the output +// streams declared in the Operator. +message AnalyzerDefinition { + // The inputs to this analyzer. + // + // We accept input name references of the following form: + // : + // + // Example: + // + // Suppose you had an operator named "SomeOp" that has 2 output + // arguments, the first of which is named "foo" and the second of which is + // named "bar", and an operator named "MyOp" that accepts 2 inputs. + // + // Also suppose that there is an analyzer named "some-analyzer" that is + // running "SomeOp" and another analyzer named "my-analyzer" running "MyOp". + // + // To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" + // output as its first input and "some-analyzer"'s "bar" output as its + // second input, you can set this field to the following: + // input = ["some-analyzer:foo", "some-analyzer:bar"] + message StreamInput { + // The name of the stream input (as discussed above). + string input = 1; + } + + // Options available for debugging purposes only. + message DebugOptions { + // Environment variables. + map environment_variables = 1; + } + + // The name of this analyzer. + // + // Tentatively [a-z][a-z0-9]*(_[a-z0-9]+)*. + string analyzer = 1; + + // The name of the operator that this analyzer runs. + // + // Must match the name of a supported operator. + string operator = 2; + + // Input streams. + repeated StreamInput inputs = 3; + + // The attribute values that this analyzer applies to the operator. + // + // Supply a mapping between the attribute names and the actual value you wish + // to apply. If an attribute name is omitted, then it will take a + // preconfigured default value. + map attrs = 4; + + // Debug options. + DebugOptions debug_options = 5; +} + +// Defines a full analysis. +// +// This is a description of the overall live analytics pipeline. +// You may think of this as an edge list representation of a multigraph. +// +// This may be directly authored by a human in protobuf textformat, or it may be +// generated by a programming API (perhaps Python or JavaScript depending on +// context). +message AnalysisDefinition { + // Analyzer definitions. + repeated AnalyzerDefinition analyzers = 1; +} diff --git a/google/cloud/visionai/v1alpha1/lva_resources.proto b/google/cloud/visionai/v1alpha1/lva_resources.proto new file mode 100644 index 000000000..b4b1192a6 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/lva_resources.proto @@ -0,0 +1,65 @@ +// 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.visionai.v1alpha1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/visionai/v1alpha1/lva.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaResourcesProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Message describing the Analysis object. +message Analysis { + option (google.api.resource) = { + type: "visionai.googleapis.com/Analysis" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/analyses/{analysis}" + }; + + // The name of resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // The definition of the analysis. + AnalysisDefinition analysis_definition = 5; + + // Map from the input parameter in the definition to the real stream. + // E.g., suppose you had a stream source operator named "input-0" and you try + // to receive from the real stream "stream-0". You can add the following + // mapping: [input-0: stream-0]. + map input_streams_mapping = 6; + + // Map from the output parameter in the definition to the real stream. + // E.g., suppose you had a stream sink operator named "output-0" and you try + // to send to the real stream "stream-0". You can add the following + // mapping: [output-0: stream-0]. + map output_streams_mapping = 7; +} diff --git a/google/cloud/visionai/v1alpha1/lva_service.proto b/google/cloud/visionai/v1alpha1/lva_service.proto new file mode 100644 index 000000000..d82a18e77 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/lva_service.proto @@ -0,0 +1,227 @@ +// 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.visionai.v1alpha1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/visionai/v1alpha1/lva_resources.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/field_mask.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "LvaServiceProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Service describing handlers for resources. The service enables clients to run +// Live Video Analytics (LVA) on the streaming inputs. +service LiveVideoAnalytics { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists Analyses in a given project and location. + rpc ListAnalyses(ListAnalysesRequest) returns (ListAnalysesResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/analyses" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Analysis. + rpc GetAnalysis(GetAnalysisRequest) returns (Analysis) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/clusters/*/analyses/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Analysis in a given project and location. + rpc CreateAnalysis(CreateAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/analyses" + body: "analysis" + }; + option (google.api.method_signature) = "parent,analysis,analysis_id"; + option (google.longrunning.operation_info) = { + response_type: "Analysis" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Analysis. + rpc UpdateAnalysis(UpdateAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{analysis.name=projects/*/locations/*/clusters/*/analyses/*}" + body: "analysis" + }; + option (google.api.method_signature) = "analysis,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Analysis" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Analysis. + rpc DeleteAnalysis(DeleteAnalysisRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/clusters/*/analyses/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } +} + +// Message for requesting list of Analyses +message ListAnalysesRequest { + // Required. Parent value for ListAnalysesRequest + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Analyses +message ListAnalysesResponse { + // The list of Analysis + repeated Analysis analyses = 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 an Analysis. +message GetAnalysisRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Analysis" + } + ]; +} + +// Message for creating an Analysis. +message CreateAnalysisRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string analysis_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Analysis analysis = 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]; +} + +// Message for updating an Analysis. +message UpdateAnalysisRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Analysis 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) = REQUIRED]; + + // Required. The resource being updated. + Analysis analysis = 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 deleting an Analysis. +message DeleteAnalysisRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Analysis" + } + ]; + + // 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]; +} diff --git a/google/cloud/visionai/v1alpha1/platform.proto b/google/cloud/visionai/v1alpha1/platform.proto new file mode 100644 index 000000000..0fb4907f3 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/platform.proto @@ -0,0 +1,2222 @@ +// 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.visionai.v1alpha1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/visionai/v1alpha1/annotations.proto"; +import "google/cloud/visionai/v1alpha1/common.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "PlatformProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Service describing handlers for resources +service AppPlatform { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists Applications in a given project and location. + rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*}/applications" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Application. + rpc GetApplication(GetApplicationRequest) returns (Application) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/applications/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Application in a given project and location. + rpc CreateApplication(CreateApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*}/applications" + body: "application" + }; + option (google.api.method_signature) = "parent,application"; + option (google.longrunning.operation_info) = { + response_type: "Application" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Application. + rpc UpdateApplication(UpdateApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{application.name=projects/*/locations/*/applications/*}" + body: "application" + }; + option (google.api.method_signature) = "application,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Application" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Application. + rpc DeleteApplication(DeleteApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/applications/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Deploys a single Application. + rpc DeployApplication(DeployApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:deploy" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "DeployApplicationResponse" + metadata_type: "OperationMetadata" + }; + } + + // Undeploys a single Application. + rpc UndeployApplication(UndeployApplicationRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:undeploy" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "UndeployApplicationResponse" + metadata_type: "OperationMetadata" + }; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc AddApplicationStreamInput(AddApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:addStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "AddApplicationStreamInputResponse" + metadata_type: "OperationMetadata" + }; + } + + // Remove target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deleted. If the stream + // is not in the Application, the RPC will fail. + rpc RemoveApplicationStreamInput(RemoveApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:removeStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "RemoveApplicationStreamInputResponse" + metadata_type: "OperationMetadata" + }; + } + + // Update target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deployed. For + // CreateOrUpdate behavior, set allow_missing to true. + rpc UpdateApplicationStreamInput(UpdateApplicationStreamInputRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:updateStreamInput" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "UpdateApplicationStreamInputResponse" + metadata_type: "OperationMetadata" + }; + } + + // Lists Instances in a given project and location. + rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/applications/*}/instances" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Instance. + rpc GetInstance(GetInstanceRequest) returns (Instance) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/applications/*/instances/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc CreateApplicationInstances(CreateApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:createApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "CreateApplicationInstancesResponse" + metadata_type: "OperationMetadata" + }; + } + + // Remove target stream input to the Application, if the Application is + // deployed, the corresponding instance based will be deleted. If the stream + // is not in the Application, the RPC will fail. + rpc DeleteApplicationInstances(DeleteApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:deleteApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "Instance" + metadata_type: "OperationMetadata" + }; + } + + // Adds target stream input to the Application. + // If the Application is deployed, the corresponding new Application instance + // will be created. If the stream has already been in the Application, the RPC + // will fail. + rpc UpdateApplicationInstances(UpdateApplicationInstancesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/applications/*}:updateApplicationInstances" + body: "*" + }; + option (google.api.method_signature) = "name, application_instances"; + option (google.longrunning.operation_info) = { + response_type: "UpdateApplicationInstancesResponse" + metadata_type: "OperationMetadata" + }; + } + + // Lists Drafts in a given project and location. + rpc ListDrafts(ListDraftsRequest) returns (ListDraftsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/applications/*}/drafts" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Draft. + rpc GetDraft(GetDraftRequest) returns (Draft) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/applications/*/drafts/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Draft in a given project and location. + rpc CreateDraft(CreateDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/applications/*}/drafts" + body: "draft" + }; + option (google.api.method_signature) = "parent,draft,draft_id"; + option (google.longrunning.operation_info) = { + response_type: "Draft" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Draft. + rpc UpdateDraft(UpdateDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{draft.name=projects/*/locations/*/applications/*/drafts/*}" + body: "draft" + }; + option (google.api.method_signature) = "draft,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Draft" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Draft. + rpc DeleteDraft(DeleteDraftRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/applications/*/drafts/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists Processors in a given project and location. + rpc ListProcessors(ListProcessorsRequest) returns (ListProcessorsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*}/processors" + }; + option (google.api.method_signature) = "parent"; + } + + // ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt + // Processors. + rpc ListPrebuiltProcessors(ListPrebuiltProcessorsRequest) returns (ListPrebuiltProcessorsResponse) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*}/processors:prebuilt" + body: "*" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Processor. + rpc GetProcessor(GetProcessorRequest) returns (Processor) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/processors/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Processor in a given project and location. + rpc CreateProcessor(CreateProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*}/processors" + body: "processor" + }; + option (google.api.method_signature) = "parent,processor,processor_id"; + option (google.longrunning.operation_info) = { + response_type: "Processor" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Processor. + rpc UpdateProcessor(UpdateProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{processor.name=projects/*/locations/*/processors/*}" + body: "processor" + }; + option (google.api.method_signature) = "processor,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Processor" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Processor. + rpc DeleteProcessor(DeleteProcessorRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/processors/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } +} + +// All the supported model types in Vision AI App Platform. +enum ModelType { + // Processor Type UNSPECIFIED. + MODEL_TYPE_UNSPECIFIED = 0; + + // Model Type Image Classification. + IMAGE_CLASSIFICATION = 1; + + // Model Type Object Detection. + OBJECT_DETECTION = 2; + + // Model Type Video Classification. + VIDEO_CLASSIFICATION = 3; + + // Model Type Object Tracking. + VIDEO_OBJECT_TRACKING = 4; + + // Model Type Action Recognition. + VIDEO_ACTION_RECOGNITION = 5; + + // Model Type Occupancy Counting. + OCCUPANCY_COUNTING = 6; + + // Model Type Person Blur. + PERSON_BLUR = 7; + + // Model Type Vertex Custom. + VERTEX_CUSTOM = 8; +} + +// Represents a hardware accelerator type. +enum AcceleratorType { + // Unspecified accelerator type, which means no accelerator. + ACCELERATOR_TYPE_UNSPECIFIED = 0; + + // Nvidia Tesla K80 GPU. + NVIDIA_TESLA_K80 = 1; + + // Nvidia Tesla P100 GPU. + NVIDIA_TESLA_P100 = 2; + + // Nvidia Tesla V100 GPU. + NVIDIA_TESLA_V100 = 3; + + // Nvidia Tesla P4 GPU. + NVIDIA_TESLA_P4 = 4; + + // Nvidia Tesla T4 GPU. + NVIDIA_TESLA_T4 = 5; + + // Nvidia Tesla A100 GPU. + NVIDIA_TESLA_A100 = 8; + + // TPU v2. + TPU_V2 = 6; + + // TPU v3. + TPU_V3 = 7; +} + +// Message for DeleteApplicationInstance Response. +message DeleteApplicationInstancesResponse { + +} + +// Message for CreateApplicationInstance Response. +message CreateApplicationInstancesResponse { + +} + +// Message for UpdateApplicationInstances Response. +message UpdateApplicationInstancesResponse { + +} + +// Message for adding stream input to an Application. +message CreateApplicationInstancesRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // Required. The resources being created. + repeated ApplicationInstance application_instances = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for removing stream input from an Application. +message DeleteApplicationInstancesRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // Required. Id of the requesting object. + repeated string instance_ids = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.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 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// RPC Request Messages. +// Message for DeployApplication Response. +message DeployApplicationResponse { + +} + +// Message for UndeployApplication Response. +message UndeployApplicationResponse { + +} + +// Message for RemoveApplicationStreamInput Response. +message RemoveApplicationStreamInputResponse { + +} + +// Message for AddApplicationStreamInput Response. +message AddApplicationStreamInputResponse { + +} + +// Message for AddApplicationStreamInput Response. +message UpdateApplicationStreamInputResponse { + +} + +// Message for requesting list of Applications. +message ListApplicationsRequest { + // Required. Parent value for ListApplicationsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Application" + } + ]; + + // 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 Applications. +message ListApplicationsResponse { + // The list of Application. + repeated Application applications = 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 Application. +message GetApplicationRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; +} + +// Message for creating a Application. +message CreateApplicationRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Application" + } + ]; + + // Required. Id of the requesting object. + string application_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Application application = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating an Application. +message UpdateApplicationRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Application 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. + Application application = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 deleting an Application. +message DeleteApplicationRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 to true, any instances and drafts from this application will also be + // deleted. (Otherwise, the request will only work if the application has no + // instances and drafts.) + bool force = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Message for deploying an Application. +message DeployApplicationRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // If set, validate the request and preview the application graph, but do not + // actually deploy it. + bool validate_only = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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. Whether or not to enable monitoring for the application on deployment. + bool enable_monitoring = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Message for undeploying an Application. +message UndeployApplicationRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message about a single stream input config. +message ApplicationStreamInput { + StreamWithAnnotation stream_with_annotation = 1; +} + +// Message for adding stream input to an Application. +message AddApplicationStreamInputRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The stream inputs to add, the stream resource name is the key of each + // StreamInput, and it must be unique within each application. + repeated ApplicationStreamInput application_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 updating stream input to an Application. +message UpdateApplicationStreamInputRequest { + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The stream inputs to update, the stream resource name is the key of each + // StreamInput, and it must be unique within each application. + repeated ApplicationStreamInput application_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, UpdateApplicationStreamInput will insert stream input to + // application even if the target stream is not included in the application. + bool allow_missing = 4; +} + +// Message for removing stream input from an Application. +message RemoveApplicationStreamInputRequest { + // Message about target streamInput to remove. + message TargetStreamInput { + string stream = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + }]; + } + + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + // The target stream to remove. + repeated TargetStreamInput target_stream_inputs = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 requesting list of Instances. +message ListInstancesRequest { + // Required. Parent value for ListInstancesRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Instance" + } + ]; + + // 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 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. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Instance" + } + ]; +} + +// Message for requesting list of Drafts. +message ListDraftsRequest { + // Required. Parent value for ListDraftsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Draft" + } + ]; + + // 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 Drafts. +message ListDraftsResponse { + // The list of Draft. + repeated Draft drafts = 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 Draft. +message GetDraftRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Draft" + } + ]; +} + +// Message for creating a Draft. +message CreateDraftRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Draft" + } + ]; + + // Required. Id of the requesting object. + string draft_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Draft draft = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating an Draft. +message UpdateDraftRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Draft 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. + Draft draft = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, UpdateDraftRequest will create one resource if the target resource + // doesn't exist, this time, the field_mask will be ignored. + bool allow_missing = 4; +} + +// Message for updating an ApplicationInstance. +message UpdateApplicationInstancesRequest { + message UpdateApplicationInstance { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Draft 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]; + + // Required. The id of the instance. + string instance_id = 3 [(google.api.field_behavior) = REQUIRED]; + } + + // Required. the name of the application to retrieve. + // Format: + // "projects/{project}/locations/{location}/applications/{application}" + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Application" + } + ]; + + repeated UpdateApplicationInstance application_instances = 2; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; + + // If true, Update Request will create one resource if the target resource + // doesn't exist, this time, the field_mask will be ignored. + bool allow_missing = 4; +} + +// Message for deleting an Draft. +message DeleteDraftRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Draft" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for requesting list of Processors. +message ListProcessorsRequest { + // Required. Parent value for ListProcessorsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; + + // 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 Processors. +message ListProcessorsResponse { + // The list of Processor. + repeated Processor processors = 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; +} + +// Request Message for listing Prebuilt Processors. +message ListPrebuiltProcessorsRequest { + // Required. Parent path. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; +} + +// Response Message for listing Prebuilt Processors. +message ListPrebuiltProcessorsResponse { + // The list of Processor. + repeated Processor processors = 1; +} + +// Message for getting a Processor. +message GetProcessorRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Processor" + } + ]; +} + +// Message for creating a Processor. +message CreateProcessorRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Processor" + } + ]; + + // Required. Id of the requesting object. + string processor_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Processor processor = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message for updating a Processor. +message UpdateProcessorRequest { + // Optional. Field mask is used to specify the fields to be overwritten in the + // Processor 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. + Processor processor = 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 t + // he request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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 deleting a Processor. +message DeleteProcessorRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Processor" + } + ]; + + // 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 + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Message describing Application object +message Application { + option (google.api.resource) = { + type: "visionai.googleapis.com/Application" + pattern: "projects/{project}/locations/{location}/applications/{application}" + style: DECLARATIVE_FRIENDLY + }; + + // Message storing the runtime information of the application. + message ApplicationRuntimeInfo { + // Message about output resources from application. + message GlobalOutputResource { + // The full resource name of the outputted resources. + string output_resource = 1; + + // The name of graph node who produces the output resource name. + // For example: + // output_resource: + // /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema + // producer_node: occupancy-count + string producer_node = 2; + + // The key of the output resource, it has to be unique within the same + // producer node. One producer node can output several output resources, + // the key can be used to match corresponding output resources. + string key = 3; + } + + // Monitoring-related configuration for an application. + message MonitoringConfig { + // Whether this application has monitoring enabled. + bool enabled = 1; + } + + // Timestamp when the engine be deployed + google.protobuf.Timestamp deploy_time = 1; + + // Globally created resources like warehouse dataschemas. + repeated GlobalOutputResource global_output_resources = 3; + + // Monitoring-related configuration for this application. + MonitoringConfig monitoring_config = 4; + } + + // State of the Application + enum State { + // The default value. This value is used if the state is omitted. + STATE_UNSPECIFIED = 0; + + // State CREATED. + CREATED = 1; + + // State DEPLOYING. + DEPLOYING = 2; + + // State DEPLOYED. + DEPLOYED = 3; + + // State UNDEPLOYING. + UNDEPLOYING = 4; + + // State DELETED. + DELETED = 5; + + // State ERROR. + ERROR = 6; + + // State CREATING. + CREATING = 7; + + // State Updating. + UPDATING = 8; + + // State Deleting. + DELETING = 9; + + // State Fixing. + FIXING = 10; + } + + // name of resource + string name = 1; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 4; + + // Required. A user friendly display name for the solution. + string display_name = 5 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 6; + + // Application graph configuration. + ApplicationConfigs application_configs = 7; + + // Output only. Application graph runtime info. Only exists when application state equals + // to DEPLOYED. + ApplicationRuntimeInfo runtime_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the application. + State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Message storing the graph of the application. +message ApplicationConfigs { + // message storing the config for event delivery + message EventDeliveryConfig { + // The delivery channel for the event notification, only pub/sub topic is + // supported now. + // Example channel: + // [//pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic] + string channel = 1; + + // The expected delivery interval for the same event. The same event won't + // be notified multiple times during this internal event that it is + // happening multiple times during the period of time.The same event is + // identified by . + google.protobuf.Duration minimal_delivery_interval = 2; + } + + // A list of nodes in the application graph. + repeated Node nodes = 1; + + // Event-related configuration for this application. + EventDeliveryConfig event_delivery_config = 3; +} + +// Message describing node object. +message Node { + // Message describing one edge pointing into a node. + message InputEdge { + // The name of the parent node. + string parent_node = 1; + + // The connected output artifact of the parent node. + // It can be omitted if target processor only has 1 output artifact. + string parent_output_channel = 2; + + // The connected input channel of the current node's processor. + // It can be omitted if target processor only has 1 input channel. + string connected_input_channel = 3; + } + + oneof stream_output_config { + // By default, the output of the node will only be available to downstream + // nodes. To consume the direct output from the application node, the output + // must be sent to Vision AI Streams at first. + // + // By setting output_all_output_channels_to_stream to true, App Platform + // will automatically send all the outputs of the current node to Vision AI + // Stream resources (one stream per output channel). The output stream + // resource will be created by App Platform automatically during deployment + // and deleted after application un-deployment. + // Note that this config applies to all the Application Instances. + // + // The output stream can be override at instance level by + // configuring the `output_resources` section of Instance resource. + // `producer_node` should be current node, `output_resource_binding` should + // be the output channel name (or leave it blank if there is only 1 output + // channel of the processor) and `output_resource` should be the target + // output stream. + bool output_all_output_channels_to_stream = 6; + } + + // Required. A unique name for the node. + string name = 1 [(google.api.field_behavior) = REQUIRED]; + + // A user friendly display name for the node. + string display_name = 2; + + // Node config. + ProcessorConfig node_config = 3; + + // Processor name refer to the chosen processor resource. + string processor = 4; + + // Parent node. Input node should not have parent node. For V1 Alpha1/Beta + // only media warehouse node can have multiple parents, other types of nodes + // will only have one parent. + repeated InputEdge parents = 5; +} + +// Message describing Draft object +message Draft { + option (google.api.resource) = { + type: "visionai.googleapis.com/Draft" + pattern: "projects/{project}/locations/{location}/applications/{application}/drafts/{draft}" + style: DECLARATIVE_FRIENDLY + }; + + // name of resource + string name = 1; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 3; + + // Required. A user friendly display name for the solution. + string display_name = 4 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 5; + + // The draft application configs which haven't been updated to an application. + ApplicationConfigs draft_application_configs = 6; +} + +// Message describing Instance object +message Instance { + option (google.api.resource) = { + type: "visionai.googleapis.com/Instance" + pattern: "projects/{project}/locations/{location}/applications/{application}/instances/{instance}" + style: DECLARATIVE_FRIENDLY + }; + + // Message of input resource used in one application instance. + message InputResource { + // Required. Specify the input to the application instance. + oneof input_resource_information { + // The direct input resource name. + string input_resource = 1; + + // If the input resource is VisionAI Stream, the associated annotations + // can be specified using annotated_stream instead. + StreamWithAnnotation annotated_stream = 4 [deprecated = true]; + } + + // The name of graph node who receives the input resource. + // For example: + // input_resource: + // visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a + // consumer_node: stream-input + string consumer_node = 2; + + // The specific input resource binding which will consume the current Input + // Resource, can be ignored is there is only 1 input binding. + string input_resource_binding = 3; + + // Contains resource annotations. + ResourceAnnotations annotations = 5; + } + + // Message of output resource used in one application instance. + message OutputResource { + // The output resource name for the current application instance. + string output_resource = 1; + + // The name of graph node who produces the output resource name. + // For example: + // output_resource: + // /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting + // producer_node: occupancy-counting + string producer_node = 2; + + // The specific output resource binding which produces the current + // OutputResource. + string output_resource_binding = 4; + + // Output only. Whether the output resource is temporary which means the resource is + // generated during the deployment of the application. + // Temporary resource will be deleted during the undeployment of the + // application. + bool is_temporary = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Whether the output resource is created automatically by the Vision AI App + // Platform. + bool autogen = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // State of the Instance + enum State { + // The default value. This value is used if the state is omitted. + STATE_UNSPECIFIED = 0; + + // State CREATING. + CREATING = 1; + + // State CREATED. + CREATED = 2; + + // State DEPLOYING. + DEPLOYING = 3; + + // State DEPLOYED. + DEPLOYED = 4; + + // State UNDEPLOYING. + UNDEPLOYING = 5; + + // State DELETED. + DELETED = 6; + + // State ERROR. + ERROR = 7; + + // State Updating + UPDATING = 8; + + // State Deleting. + DELETING = 9; + + // State Fixing. + FIXING = 10; + } + + // Output only. name of resource + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Create timestamp + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp + google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs + map labels = 3; + + // Required. A user friendly display name for the solution. + string display_name = 4 [(google.api.field_behavior) = REQUIRED]; + + // A description for this application. + string description = 5; + + // The input resources for the current application instance. + // For example: + // input_resources: + // visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a + repeated InputResource input_resources = 6; + + // All the output resources associated to one application instance. + repeated OutputResource output_resources = 7; + + // State of the instance. + State state = 9; +} + +// Message for creating a Instance. +message ApplicationInstance { + // Required. Id of the requesting object. + string instance_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Instance instance = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Message describing Processor object. +// Next ID: 18 +message Processor { + option (google.api.resource) = { + type: "visionai.googleapis.com/Processor" + pattern: "projects/{project}/locations/{location}/processors/{processor}" + style: DECLARATIVE_FRIENDLY + }; + + // Type + enum ProcessorType { + // Processor Type UNSPECIFIED. + PROCESSOR_TYPE_UNSPECIFIED = 0; + + // Processor Type PRETRAINED. + // Pretrained processor is developed by Vision AI App Platform with + // state-of-the-art vision data processing functionality, like occupancy + // counting or person blur. Pretrained processor is usually publicly + // available. + PRETRAINED = 1; + + // Processor Type CUSTOM. + // Custom processors are specialized processors which are either uploaded by + // customers or imported from other GCP platform (for example Vertex AI). + // Custom processor is only visible to the creator. + CUSTOM = 2; + + // Processor Type CONNECTOR. + // Connector processors are special processors which perform I/O for the + // application, they do not processing the data but either deliver the data + // to other processors or receive data from other processors. + CONNECTOR = 3; + } + + enum ProcessorState { + // Unspecified Processor state. + PROCESSOR_STATE_UNSPECIFIED = 0; + + // Processor is being created (not ready for use). + CREATING = 1; + + // Processor is and ready for use. + ACTIVE = 2; + + // Processor is being deleted (not ready for use). + DELETING = 3; + + // Processor deleted or creation failed . + FAILED = 4; + } + + // name of resource. + string name = 1; + + // Output only. [Output only] Create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] Update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Required. A user friendly display name for the processor. + string display_name = 5 [(google.api.field_behavior) = REQUIRED]; + + // Illustrative sentences for describing the functionality of the processor. + string description = 10; + + // Output only. Processor Type. + ProcessorType processor_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Model Type. + ModelType model_type = 13; + + // Source info for customer created processor. + CustomProcessorSourceInfo custom_processor_source_info = 7; + + // Output only. State of the Processor. + ProcessorState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. [Output only] The input / output specifications of a processor, each type + // of processor has fixed input / output specs which cannot be altered by + // customer. + ProcessorIOSpec processor_io_spec = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The corresponding configuration can be used in the Application to customize + // the behavior of the processor. + string configuration_typeurl = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + repeated StreamAnnotationType supported_annotation_types = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Indicates if the processor supports post processing. + bool supports_post_processing = 17; +} + +// Message describing the input / output specifications of a processor. +message ProcessorIOSpec { + // Message for input channel specification. + message GraphInputChannelSpec { + // The name of the current input channel. + string name = 1; + + // The data types of the current input channel. + // When this field has more than 1 value, it means this input channel can be + // connected to either of these different data types. + DataType data_type = 2; + + // If specified, only those detailed data types can be connected to the + // processor. For example, jpeg stream for MEDIA, or PredictionResult proto + // for PROTO type. If unspecified, then any proto is accepted. + repeated string accepted_data_type_uris = 5; + + // Whether the current input channel is required by the processor. + // For example, for a processor with required video input and optional audio + // input, if video input is missing, the application will be rejected while + // the audio input can be missing as long as the video input exists. + bool required = 3; + + // How many input edges can be connected to this input channel. 0 means + // unlimited. + int64 max_connection_allowed = 4; + } + + // Message for output channel specification. + message GraphOutputChannelSpec { + // The name of the current output channel. + string name = 1; + + // The data type of the current output channel. + DataType data_type = 2; + + string data_type_uri = 3; + } + + // Message for instance resource channel specification. + // External resources are virtual nodes which are not expressed in the + // application graph. Each processor expresses its out-graph spec, so customer + // is able to override the external source or destinations to the + message InstanceResourceInputBindingSpec { + oneof resource_type { + // The configuration proto that includes the Googleapis resources. I.e. + // type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation + string config_type_uri = 2; + + // The direct type url of Googleapis resource. i.e. + // type.googleapis.com/google.cloud.vision.v1.Asset + string resource_type_uri = 3; + } + + // Name of the input binding, unique within the processor. + string name = 1; + } + + message InstanceResourceOutputBindingSpec { + // Name of the output binding, unique within the processor. + string name = 1; + + // The resource type uri of the acceptable output resource. + string resource_type_uri = 2; + + // Whether the output resource needs to be explicitly set in the instance. + // If it is false, the processor will automatically generate it if required. + bool explicit = 3; + } + + // High level data types supported by the processor. + enum DataType { + // The default value of DataType. + DATA_TYPE_UNSPECIFIED = 0; + + // Video data type like H264. + VIDEO = 1; + + // Protobuf data type, usually used for general data blob. + PROTO = 2; + } + + // For processors with input_channel_specs, the processor must be explicitly + // connected to another processor. + repeated GraphInputChannelSpec graph_input_channel_specs = 3; + + // The output artifact specifications for the current processor. + repeated GraphOutputChannelSpec graph_output_channel_specs = 4; + + // The input resource that needs to be fed from the application instance. + repeated InstanceResourceInputBindingSpec instance_resource_input_binding_specs = 5; + + // The output resource that the processor will generate per instance. + // Other than the explicitly listed output bindings here, all the processors' + // GraphOutputChannels can be binded to stream resource. The bind name then is + // the same as the GraphOutputChannel's name. + repeated InstanceResourceOutputBindingSpec instance_resource_output_binding_specs = 6; +} + +// Describes the source info for a custom processor. +message CustomProcessorSourceInfo { + // 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). + message ModelSchema { + // Cloud Storage location to a YAML file that defines the format of a single + // instance used in prediction and explanation requests. + GcsSource instances_schema = 1; + + // Cloud Storage location to a YAML file that defines the prediction and + // explanation parameters. + GcsSource parameters_schema = 2; + + // Cloud Storage location to a YAML file that defines the format of a single + // prediction or explanation. + GcsSource predictions_schema = 3; + } + + // Source type of the imported custom processor. + enum SourceType { + // Source type unspecified. + SOURCE_TYPE_UNSPECIFIED = 0; + + // Custom processors coming from Vertex AutoML product. + VERTEX_AUTOML = 1; + + // Custom processors coming from general custom models from Vertex. + VERTEX_CUSTOM = 2; + } + + // The path where App Platform loads the artifacts for the custom processor. + oneof artifact_path { + // The resource name original model hosted in the vertex AI platform. + string vertex_model = 2; + } + + // The original product which holds the custom processor's functionality. + SourceType source_type = 1; + + // Output only. Additional info related to the imported custom processor. + // Data is filled in by app platform during the processor creation. + map additional_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Model schema files which specifies the signature of the model. + // For VERTEX_CUSTOM models, instances schema is required. + // If instances schema is not specified during the processor creation, + // VisionAI Platform will try to get it from Vertex, if it doesn't exist, the + // creation will fail. + ModelSchema model_schema = 5; +} + +// Next ID: 24 +message ProcessorConfig { + oneof processor_config { + // Configs of stream input processor. + VideoStreamInputConfig video_stream_input_config = 9; + + // Config of AI-enabled input devices. + AIEnabledDevicesInputConfig ai_enabled_devices_input_config = 20; + + // Configs of media warehouse processor. + MediaWarehouseConfig media_warehouse_config = 10; + + // Configs of person blur processor. + PersonBlurConfig person_blur_config = 11; + + // Configs of occupancy count processor. + OccupancyCountConfig occupancy_count_config = 12; + + // Configs of Person Vehicle Detection processor. + PersonVehicleDetectionConfig person_vehicle_detection_config = 15; + + // Configs of Vertex AutoML vision processor. + VertexAutoMLVisionConfig vertex_automl_vision_config = 13; + + // Configs of Vertex AutoML video processor. + VertexAutoMLVideoConfig vertex_automl_video_config = 14; + + // Configs of Vertex Custom processor. + VertexCustomConfig vertex_custom_config = 17; + + // Configs of General Object Detection processor. + GeneralObjectDetectionConfig general_object_detection_config = 18; + + // Configs of BigQuery processor. + BigQueryConfig big_query_config = 19; + + // Configs of personal_protective_equipment_detection_config + PersonalProtectiveEquipmentDetectionConfig personal_protective_equipment_detection_config = 22; + } +} + +// Message describing Vision AI stream with application specific annotations. +// All the StreamAnnotation object inside this message MUST have unique id. +message StreamWithAnnotation { + // Message describing annotations specific to application node. + message NodeAnnotation { + // The node name of the application graph. + string node = 1; + + // The node specific stream annotations. + repeated StreamAnnotation annotations = 2; + } + + // Vision AI Stream resource name. + string stream = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + }]; + + // Annotations that will be applied to the whole application. + repeated StreamAnnotation application_annotations = 2; + + // Annotations that will be applied to the specific node of the application. + // If the same type of the annotations is applied to both application and + // node, the node annotation will be added in addition to the global + // application one. + // For example, if there is one active zone annotation for the whole + // application and one active zone annotation for the Occupancy Analytic + // processor, then the Occupancy Analytic processor will have two active zones + // defined. + repeated NodeAnnotation node_annotations = 3; +} + +// Message describing annotations specific to application node. +// This message is a duplication of StreamWithAnnotation.NodeAnnotation. +message ApplicationNodeAnnotation { + // The node name of the application graph. + string node = 1; + + // The node specific stream annotations. + repeated StreamAnnotation annotations = 2; +} + +// Message describing general annotation for resources. +message ResourceAnnotations { + // Annotations that will be applied to the whole application. + repeated StreamAnnotation application_annotations = 1; + + // Annotations that will be applied to the specific node of the application. + // If the same type of the annotations is applied to both application and + // node, the node annotation will be added in addition to the global + // application one. + // For example, if there is one active zone annotation for the whole + // application and one active zone annotation for the Occupancy Analytic + // processor, then the Occupancy Analytic processor will have two active zones + // defined. + repeated ApplicationNodeAnnotation node_annotations = 2; +} + +// Message describing Video Stream Input Config. +// This message should only be used as a placeholder for builtin:stream-input +// processor, actual stream binding should be specified using corresponding +// API. +message VideoStreamInputConfig { + repeated string streams = 1 [deprecated = true]; + + repeated StreamWithAnnotation streams_with_annotation = 2 [deprecated = true]; +} + +// Message describing AI-enabled Devices Input Config. +message AIEnabledDevicesInputConfig { + +} + +// Message describing MediaWarehouseConfig. +message MediaWarehouseConfig { + // Resource name of the Media Warehouse corpus. + // Format: + // projects/${project_id}/locations/${location_id}/corpora/${corpus_id} + string corpus = 1; + + // Deprecated. + string region = 2 [deprecated = true]; + + // The duration for which all media assets, associated metadata, and search + // documents can exist. + google.protobuf.Duration ttl = 3; +} + +// Message describing FaceBlurConfig. +message PersonBlurConfig { + // Type of Person Blur + enum PersonBlurType { + // PersonBlur Type UNSPECIFIED. + PERSON_BLUR_TYPE_UNSPECIFIED = 0; + + // FaceBlur Type full occlusion. + FULL_OCCULUSION = 1; + + // FaceBlur Type blur filter. + BLUR_FILTER = 2; + } + + // Person blur type. + PersonBlurType person_blur_type = 1; + + // Whether only blur faces other than the whole object in the processor. + bool faces_only = 2; +} + +// Message describing OccupancyCountConfig. +message OccupancyCountConfig { + // Whether to count the appearances of people, output counts have 'people' as + // the key. + bool enable_people_counting = 1; + + // Whether to count the appearances of vehicles, output counts will have + // 'vehicle' as the key. + bool enable_vehicle_counting = 2; + + // Whether to track each invidual object's loitering time inside the scene or + // specific zone. + bool enable_dwelling_time_tracking = 3; +} + +// Message describing PersonVehicleDetectionConfig. +message PersonVehicleDetectionConfig { + // At least one of enable_people_counting and enable_vehicle_counting fields + // must be set to true. + // Whether to count the appearances of people, output counts have 'people' as + // the key. + bool enable_people_counting = 1; + + // Whether to count the appearances of vehicles, output counts will have + // 'vehicle' as the key. + bool enable_vehicle_counting = 2; +} + +// Message describing PersonalProtectiveEquipmentDetectionConfig. +message PersonalProtectiveEquipmentDetectionConfig { + // Whether to enable face coverage detection. + bool enable_face_coverage_detection = 1; + + // Whether to enable head coverage detection. + bool enable_head_coverage_detection = 2; + + // Whether to enable hands coverage detection. + bool enable_hands_coverage_detection = 3; +} + +// Message of configurations for General Object Detection processor. +message GeneralObjectDetectionConfig { + +} + +// Message of configurations for BigQuery processor. +message BigQueryConfig { + // BigQuery table resource for Vision AI Platform to ingest annotations to. + string table = 1; + + // Data Schema + // By default, Vision AI Application will try to write annotations to the + // target BigQuery table using the following schema: + // + // ingestion_time: TIMESTAMP, the ingestion time of the original data. + // + // application: STRING, name of the application which produces the annotation. + // + // instance: STRING, Id of the instance which produces the annotation. + // + // node: STRING, name of the application graph node which produces the + // annotation. + // + // annotation: STRING or JSON, the actual annotation protobuf will be + // converted to json string with bytes field as 64 encoded string. It can be + // written to both String or Json type column. + // + // To forward annotation data to an existing BigQuery table, customer needs to + // make sure the compatibility of the schema. + // The map maps application node name to its corresponding cloud function + // endpoint to transform the annotations directly to the + // google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or + // proto_rows should be set). If configured, annotations produced by + // corresponding application node will sent to the Cloud Function at first + // before be forwarded to BigQuery. + // + // If the default table schema doesn't fit, customer is able to transform the + // annotation output from Vision AI Application to arbitrary BigQuery table + // schema with CloudFunction. + // * The cloud function will receive AppPlatformCloudFunctionRequest where + // the annotations field will be the json format of Vision AI annotation. + // * The cloud function should return AppPlatformCloudFunctionResponse with + // AppendRowsRequest stored in the annotations field. + // * To drop the annotation, simply clear the annotations field in the + // returned AppPlatformCloudFunctionResponse. + map cloud_function_mapping = 2; + + // If true, App Platform will create the BigQuery DataSet and the + // BigQuery Table with default schema if the specified table doesn't exist. + // This doesn't work if any cloud function customized schema is specified + // since the system doesn't know your desired schema. + // JSON column will be used in the default table created by App Platform. + bool create_default_table_if_not_exists = 3; +} + +// Message of configurations of Vertex AutoML Vision Processors. +message VertexAutoMLVisionConfig { + // Only entities with higher score than the threshold will be returned. + // Value 0.0 means to return all the detected entities. + float confidence_threshold = 1; + + // At most this many predictions will be returned per output frame. + // Value 0 means to return all the detected entities. + int32 max_predictions = 2; +} + +// Message describing VertexAutoMLVideoConfig. +message VertexAutoMLVideoConfig { + // Only entities with higher score than the threshold will be returned. + // Value 0.0 means returns all the detected entities. + float confidence_threshold = 1; + + // Labels specified in this field won't be returned. + repeated string blocked_labels = 2; + + // At most this many predictions will be returned per output frame. + // Value 0 means to return all the detected entities. + int32 max_predictions = 3; + + // Only Bounding Box whose size is larger than this limit will be returned. + // Object Tracking only. + // Value 0.0 means to return all the detected entities. + float bounding_box_size_limit = 4; +} + +// Message describing VertexCustomConfig. +message VertexCustomConfig { + // The max prediction frame per second. This attribute sets how fast the + // operator sends prediction requests to Vertex AI endpoint. Default value is + // 0, which means there is no max prediction fps limit. The operator sends + // prediction requests at input fps. + int32 max_prediction_fps = 1; + + // A description of resources that are dedicated to the DeployedModel, and + // that need a higher degree of manual configuration. + DedicatedResources dedicated_resources = 2; + + // If not empty, the prediction result will be sent to the specified cloud + // function for post processing. + // * The cloud function will receive AppPlatformCloudFunctionRequest where + // the annotations field will be the json format of proto PredictResponse. + // * The cloud function should return AppPlatformCloudFunctionResponse with + // PredictResponse stored in the annotations field. + // * To drop the prediction output, simply clear the payload field in the + // returned AppPlatformCloudFunctionResponse. + string post_processing_cloud_function = 3; + + // If true, the prediction request received by custom model will also contain + // metadata with the following schema: + // 'appPlatformMetadata': { + // 'ingestionTime': DOUBLE; (UNIX timestamp) + // 'application': STRING; + // 'instanceId': STRING; + // 'node': STRING; + // 'processor': STRING; + // } + bool attach_application_metadata = 4; +} + +// Specification of a single machine. +message MachineSpec { + // Immutable. The type of the machine. + // + // See the [list of machine types supported for + // prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) + // + // See the [list of machine types supported for custom + // training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). + // + // For [DeployedModel][] this field is optional, and the default + // value is `n1-standard-2`. For [BatchPredictionJob][] or as part of + // [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 + // [accelerator_count][google.cloud.visionai.v1alpha1.MachineSpec.accelerator_count]. + AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + + // The number of accelerators to attach to the machine. + int32 accelerator_count = 3; +} + +// The metric specification that defines the target resource utilization +// (CPU utilization, accelerator's duty cycle, and so on) for calculating the +// desired replica count. +message AutoscalingMetricSpec { + // Required. The resource metric name. + // Supported metrics: + // + // * For Online Prediction: + // * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` + // * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + string metric_name = 1 [(google.api.field_behavior) = REQUIRED]; + + // The target resource utilization in percentage (1% - 100%) for the given + // metric; once the real usage deviates from the target by a certain + // percentage, the machine replicas change. The default value is 60 + // (representing 60%) if not provided. + int32 target = 2; +} + +// 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. + 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. + // + // If traffic against the DeployedModel increases, it may dynamically be + // deployed onto more replicas, and as traffic decreases, some of these extra + // replicas may be freed. + int32 min_replica_count = 2 [ + (google.api.field_behavior) = REQUIRED, + (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.visionai.v1alpha1.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 * + // number of cores in the selected machine type) and (max_replica_count * + // number of GPUs per replica in the selected machine type). + int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. The metric specifications that overrides a resource + // utilization metric (CPU utilization, accelerator's duty cycle, and so on) + // target value (default to 60 if not set). At most one entry is allowed per + // metric. + // + // If [machine_spec.accelerator_count][google.cloud.visionai.v1alpha1.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.visionai.v1alpha1.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.visionai.v1alpha1.AutoscalingMetricSpec.metric_name] + // to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and + // [autoscaling_metric_specs.target][google.cloud.visionai.v1alpha1.AutoscalingMetricSpec.target] to `80`. + repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE]; +} diff --git a/google/cloud/visionai/v1alpha1/streaming_resources.proto b/google/cloud/visionai/v1alpha1/streaming_resources.proto new file mode 100644 index 000000000..002e5aec4 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/streaming_resources.proto @@ -0,0 +1,173 @@ +// 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.visionai.v1alpha1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamingResourcesProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// The descriptor for a gstreamer buffer payload. +message GstreamerBufferDescriptor { + // The caps string of the payload. + string caps_string = 1; + + // Whether the buffer is a key frame. + bool is_key_frame = 2; + + // PTS of the frame. + google.protobuf.Timestamp pts_time = 3; + + // DTS of the frame. + google.protobuf.Timestamp dts_time = 4; + + // Duration of the frame. + google.protobuf.Duration duration = 5; +} + +// The descriptor for a raw image. +message RawImageDescriptor { + // Raw image format. Its possible values are: "srgb". + string format = 1; + + // The height of the image. + int32 height = 2; + + // The width of the image. + int32 width = 3; +} + +// The message that represents the data type of a packet. +message PacketType { + // The message that fully specifies the type of the packet. + message TypeDescriptor { + // Detailed information about the type. + // + // It is non-empty only for specific type class codecs. Needed only when the + // type string alone is not enough to disambiguate the specific type. + oneof type_details { + // GstreamerBufferDescriptor is the descriptor for gstreamer buffer type. + GstreamerBufferDescriptor gstreamer_buffer_descriptor = 2; + + // RawImageDescriptor is the descriptor for the raw image type. + RawImageDescriptor raw_image_descriptor = 3; + } + + // The type of the packet. Its possible values is codec dependent. + // + // The fully qualified type name is always the concatenation of the + // value in `type_class` together with the value in `type`, separated by a + // '/'. + // + // Note that specific codecs can define their own type hierarchy, and so the + // type string here can in fact be separated by multiple '/'s of its own. + // + // Please see the open source SDK for specific codec documentation. + string type = 1; + } + + // The type class of the packet. Its possible values are: + // "gst", "protobuf", and "string". + string type_class = 1; + + // The type descriptor. + TypeDescriptor type_descriptor = 2; +} + +// The message that represents server metadata. +message ServerMetadata { + // The offset position for the packet in its stream. + int64 offset = 1; + + // The timestamp at which the stream server receives this packet. This is + // based on the local clock of on the server side. It is guaranteed to be + // monotonically increasing for the packets within each session; however + // this timestamp is not comparable across packets sent to the same stream + // different sessions. Session here refers to one individual gRPC streaming + // request to the stream server. + google.protobuf.Timestamp ingest_time = 2; +} + +// The message that represents series metadata. +message SeriesMetadata { + // Series name. It's in the format of + // "projects/{project}/locations/{location}/clusters/{cluster}/series/{stream}". + string series = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + }]; +} + +// The message that represents packet header. +message PacketHeader { + // Input only. The capture time of the packet. + google.protobuf.Timestamp capture_time = 1 [(google.api.field_behavior) = INPUT_ONLY]; + + // Input only. Immutable. The type of the payload. + PacketType type = 2 [ + (google.api.field_behavior) = INPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Input only. This field is for users to attach user managed metadata. + google.protobuf.Struct metadata = 3 [(google.api.field_behavior) = INPUT_ONLY]; + + // Output only. Metadata that the server appends to each packet before sending + // it to receivers. You don't need to set a value for this field when sending + // packets. + ServerMetadata server_metadata = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Input only. Immutable. Metadata that the server needs to know where to + // write the packets to. It's only required for the first packet. + SeriesMetadata series_metadata = 5 [ + (google.api.field_behavior) = INPUT_ONLY, + (google.api.field_behavior) = IMMUTABLE + ]; + + // Immutable. Packet flag set. SDK will set the flag automatically. + int32 flags = 6 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. Header string for tracing across services. It should be set when the packet + // is first arrived in the stream server. + // + // The input format is a lowercase hex string: + // - version_id: 1 byte, currently must be zero - hex encoded (2 characters) + // - trace_id: 16 bytes (opaque blob) - hex encoded (32 characters) + // - span_id: 8 bytes (opaque blob) - hex encoded (16 characters) + // - trace_options: 1 byte (LSB means tracing enabled) - hex encoded (2 + // characters) + // Example: "00-404142434445464748494a4b4c4d4e4f-6162636465666768-01" + // v trace_id span_id options + string trace_context = 7 [(google.api.field_behavior) = IMMUTABLE]; +} + +// The quanta of datum that the series accepts. +message Packet { + // The packet header. + PacketHeader header = 1; + + // The payload of the packet. + bytes payload = 2; +} diff --git a/google/cloud/visionai/v1alpha1/streaming_service.proto b/google/cloud/visionai/v1alpha1/streaming_service.proto new file mode 100644 index 000000000..ff5d7c2e0 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/streaming_service.proto @@ -0,0 +1,411 @@ +// 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.visionai.v1alpha1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/cloud/visionai/v1alpha1/streaming_resources.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamingServiceProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Streaming service for receiving and sending packets. +service StreamingService { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Send packets to the series. + rpc SendPackets(stream SendPacketsRequest) returns (stream SendPacketsResponse) { + } + + // Receive packets from the series. + rpc ReceivePackets(stream ReceivePacketsRequest) returns (stream ReceivePacketsResponse) { + } + + // Receive events given the stream name. + rpc ReceiveEvents(stream ReceiveEventsRequest) returns (stream ReceiveEventsResponse) { + } + + // AcquireLease acquires a lease. + rpc AcquireLease(AcquireLeaseRequest) returns (Lease) { + option (google.api.http) = { + post: "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:acquireLease" + body: "*" + }; + } + + // RenewLease renews a lease. + rpc RenewLease(RenewLeaseRequest) returns (Lease) { + option (google.api.http) = { + post: "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:renewLease" + body: "*" + }; + } + + // RleaseLease releases a lease. + rpc ReleaseLease(ReleaseLeaseRequest) returns (ReleaseLeaseResponse) { + option (google.api.http) = { + post: "/v1alpha1/{series=projects/*/locations/*/clusters/*/series/*}:releaseLease" + body: "*" + }; + } +} + +// The lease type. +enum LeaseType { + // Lease type unspecified. + LEASE_TYPE_UNSPECIFIED = 0; + + // Lease for stream reader. + LEASE_TYPE_READER = 1; + + // Lease for stream writer. + LEASE_TYPE_WRITER = 2; +} + +// Request message for ReceiveEvents. +message ReceiveEventsRequest { + // SetupRequest is the first message sent to the service to setup the RPC + // connection. + message SetupRequest { + // The cluster name. + string cluster = 1; + + // The stream name. The service will return the events for the given stream. + string stream = 2; + + // A name for the receiver to self-identify. + // + // This is used to keep track of a receiver's read progress. + string receiver = 3; + + // Controller mode configuration for receiving events from the server. + ControlledMode controlled_mode = 4; + + // The maximum duration of server silence before the client determines the + // server unreachable. + // + // The client must either receive an `Event` update or a heart beat message + // before this duration expires; otherwise, the client will automatically + // cancel the current connection and retry. + google.protobuf.Duration heartbeat_interval = 5; + + // The grace period after which a `writes_done_request` is issued, that a + // `WritesDone` is expected from the client. + // + // The server is free to cancel the RPC should this expire. + // + // A system default will be chosen if unset. + google.protobuf.Duration writes_done_grace_period = 6; + } + + oneof request { + // The setup request to setup the RPC connection. + SetupRequest setup_request = 1; + + // This request checkpoints the consumer's read progress. + CommitRequest commit_request = 2; + } +} + +// The event update message. +message EventUpdate { + // The name of the stream that the event is attached to. + string stream = 1; + + // The name of the event. + string event = 2; + + // The name of the series. + string series = 3; + + // The timestamp when the Event update happens. + google.protobuf.Timestamp update_time = 4; + + // The offset of the message that will be used to acknowledge of the message + // receiving. + int64 offset = 5; +} + +// Control message for a ReceiveEventsResponse. +message ReceiveEventsControlResponse { + // Possible control messages. + oneof control { + // A server heartbeat. + bool heartbeat = 1; + + // A request to the receiver to complete any final writes followed by a + // `WritesDone`; e.g. issue any final `CommitRequest`s. + // + // May be ignored if `WritesDone` has already been issued at any point + // prior to receiving this message. + // + // If `WritesDone` does not get issued, then the server will forcefully + // cancel the connection, and the receiver will likely receive an + // uninformative after `Read` returns `false` and `Finish` is called. + bool writes_done_request = 2; + } +} + +// Response message for the ReceiveEvents. +message ReceiveEventsResponse { + // Possible response types. + oneof response { + // The event update message. + EventUpdate event_update = 1; + + // A control message from the server. + ReceiveEventsControlResponse control = 2; + } +} + +// The lease message. +message Lease { + // The lease id. + string id = 1; + + // The series name. + string series = 2; + + // The owner name. + string owner = 3; + + // The lease expire time. + google.protobuf.Timestamp expire_time = 4; + + // The lease type. + LeaseType lease_type = 5; +} + +// Request message for acquiring a lease. +message AcquireLeaseRequest { + // The series name. + string series = 1; + + // The owner name. + string owner = 2; + + // The lease term. + google.protobuf.Duration term = 3; + + // The lease type. + LeaseType lease_type = 4; +} + +// Request message for renewing a lease. +message RenewLeaseRequest { + // Lease id. + string id = 1; + + // Series name. + string series = 2; + + // Lease owner. + string owner = 3; + + // Lease term. + google.protobuf.Duration term = 4; +} + +// Request message for releasing lease. +message ReleaseLeaseRequest { + // Lease id. + string id = 1; + + // Series name. + string series = 2; + + // Lease owner. + string owner = 3; +} + +// Response message for release lease. +message ReleaseLeaseResponse { + +} + +// RequestMetadata is the metadata message for the request. +message RequestMetadata { + // Stream name. + string stream = 1; + + // Evevt name. + string event = 2; + + // Series name. + string series = 3; + + // Lease id. + string lease_id = 4; + + // Owner name. + string owner = 5; + + // Lease term specifies how long the client wants the session to be maintained + // by the server after the client leaves. If the lease term is not set, the + // server will release the session immediately and the client cannot reconnect + // to the same session later. + google.protobuf.Duration lease_term = 6; +} + +// Request message for sending packets. +message SendPacketsRequest { + oneof request { + // Packets sent over the streaming rpc. + Packet packet = 1; + + // The first message of the streaming rpc including the request metadata. + RequestMetadata metadata = 2; + } +} + +// Response message for sending packets. +message SendPacketsResponse { + +} + +// Request message for receiving packets. +message ReceivePacketsRequest { + // The message specifying the initial settings for the ReceivePackets session. + message SetupRequest { + // The mode in which the consumer reads messages. + oneof consumer_mode { + // Options for configuring eager mode. + EagerMode eager_receive_mode = 3; + + // Options for configuring controlled mode. + ControlledMode controlled_receive_mode = 4; + } + + // The configurations that specify where packets are retrieved. + RequestMetadata metadata = 1; + + // A name for the receiver to self-identify. + // + // This is used to keep track of a receiver's read progress. + string receiver = 2; + + // The maximum duration of server silence before the client determines the + // server unreachable. + // + // The client must either receive a `Packet` or a heart beat message before + // this duration expires; otherwise, the client will automatically cancel + // the current connection and retry. + google.protobuf.Duration heartbeat_interval = 5; + + // The grace period after which a `writes_done_request` is issued, that a + // `WritesDone` is expected from the client. + // + // The server is free to cancel the RPC should this expire. + // + // A system default will be chosen if unset. + google.protobuf.Duration writes_done_grace_period = 6; + } + + // Possible request types from the client. + oneof request { + // The request to setup the initial state of session. + // + // The client must send and only send this as the first message. + SetupRequest setup_request = 6; + + // This request checkpoints the consumer's read progress. + CommitRequest commit_request = 7; + } +} + +// Control message for a ReceivePacketsResponse. +message ReceivePacketsControlResponse { + // Possible control messages. + oneof control { + // A server heartbeat. + bool heartbeat = 1; + + // A request to the receiver to complete any final writes followed by a + // `WritesDone`; e.g. issue any final `CommitRequest`s. + // + // May be ignored if `WritesDone` has already been issued at any point + // prior to receiving this message. + // + // If `WritesDone` does not get issued, then the server will forcefully + // cancel the connection, and the receiver will likely receive an + // uninformative after `Read` returns `false` and `Finish` is called. + bool writes_done_request = 2; + } +} + +// Response message from ReceivePackets. +message ReceivePacketsResponse { + // Possible response types. + oneof response { + // A genuine data payload originating from the sender. + Packet packet = 1; + + // A control message from the server. + ReceivePacketsControlResponse control = 3; + } +} + +// The options for receiver under the eager mode. +message EagerMode { + +} + +// The options for receiver under the controlled mode. +message ControlledMode { + // This is the offset from which to start receiveing. + oneof starting_offset { + // This can be set to the following logical starting points: + // + // "begin": This will read from the earliest available message. + // + // "most-recent": This will read from the latest available message. + // + // "end": This will read only future messages. + // + // "stored": This will resume reads one past the last committed offset. + // It is the only option that resumes progress; all others + // jump unilaterally. + string starting_logical_offset = 1; + } + + // This is the logical starting point to fallback upon should the + // specified starting offset be unavailable. + // + // This can be one of the following values: + // + // "begin": This will read from the earliest available message. + // + // "end": This will read only future messages. + string fallback_starting_offset = 2; +} + +// The message for explicitly committing the read progress. +// +// This may only be used when `ReceivePacketsControlledMode` is set in the +// initial setup request. +message CommitRequest { + // The offset to commit. + int64 offset = 1; +} diff --git a/google/cloud/visionai/v1alpha1/streams_resources.proto b/google/cloud/visionai/v1alpha1/streams_resources.proto new file mode 100644 index 000000000..35d693e14 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/streams_resources.proto @@ -0,0 +1,189 @@ +// 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.visionai.v1alpha1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamsResourcesProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Message describing the Stream object. The Stream and the Event resources are +// many to many; i.e., each Stream resource can associate to many Event +// resources and each Event resource can associate to many Stream resources. +message Stream { + option (google.api.resource) = { + type: "visionai.googleapis.com/Stream" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/streams/{stream}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // The display name for the stream resource. + string display_name = 6; + + // Whether to enable the HLS playback service on this stream. + bool enable_hls_playback = 7; + + // The name of the media warehouse asset for long term storage of stream data. + // Format: projects/${p_id}/locations/${l_id}/corpora/${c_id}/assets/${a_id} + // Remain empty if the media warehouse storage is not needed for the stream. + string media_warehouse_asset = 8; +} + +// Message describing the Event object. +message Event { + option (google.api.resource) = { + type: "visionai.googleapis.com/Event" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/events/{event}" + }; + + // Clock that will be used for joining streams. + enum Clock { + // Clock is not specified. + CLOCK_UNSPECIFIED = 0; + + // Use the timestamp when the data is captured. Clients need to sync the + // clock. + CAPTURE = 1; + + // Use the timestamp when the data is received. + INGEST = 2; + } + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // The clock used for joining streams. + Clock alignment_clock = 6; + + // Grace period for cleaning up the event. This is the time the controller + // waits for before deleting the event. During this period, if there is any + // active channel on the event. The deletion of the event after grace_period + // will be ignored. + google.protobuf.Duration grace_period = 7; +} + +// Message describing the Series object. +message Series { + option (google.api.resource) = { + type: "visionai.googleapis.com/Series" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/series/{series}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Required. Stream that is associated with this series. + string stream = 6 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // Required. Event that is associated with this series. + string event = 7 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} + +// Message describing the Channel object. +message Channel { + option (google.api.resource) = { + type: "visionai.googleapis.com/Channel" + pattern: "projects/{project}/locations/{location}/clusters/{cluster}/channels/{channel}" + }; + + // Name of the resource. + string name = 1; + + // Output only. The create timestamp. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The update timestamp. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Labels as key value pairs. + map labels = 4; + + // Annotations to allow clients to store small amounts of arbitrary data. + map annotations = 5; + + // Required. Stream that is associated with this series. + string stream = 6 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // Required. Event that is associated with this series. + string event = 7 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} diff --git a/google/cloud/visionai/v1alpha1/streams_service.proto b/google/cloud/visionai/v1alpha1/streams_service.proto new file mode 100644 index 000000000..8b3c415fe --- /dev/null +++ b/google/cloud/visionai/v1alpha1/streams_service.proto @@ -0,0 +1,872 @@ +// 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.visionai.v1alpha1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/visionai/v1alpha1/common.proto"; +import "google/cloud/visionai/v1alpha1/streams_resources.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "StreamsServiceProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Service describing handlers for resources. +// Vision API and Vision AI API are two independent APIs developed by the same +// team. Vision API is for people to annotate their image while Vision AI is an +// e2e solution for customer to build their own computer vision application. +service StreamsService { + option (google.api.default_host) = "visionai.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: "/v1alpha1/{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: "/v1alpha1/{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: "/v1alpha1/{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: "/v1alpha1/{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: "/v1alpha1/{name=projects/*/locations/*/clusters/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists Streams in a given project and location. + rpc ListStreams(ListStreamsRequest) returns (ListStreamsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/streams" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Stream. + rpc GetStream(GetStreamRequest) returns (Stream) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/clusters/*/streams/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Stream in a given project and location. + rpc CreateStream(CreateStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/streams" + body: "stream" + }; + option (google.api.method_signature) = "parent,stream,stream_id"; + option (google.longrunning.operation_info) = { + response_type: "Stream" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Stream. + rpc UpdateStream(UpdateStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{stream.name=projects/*/locations/*/clusters/*/streams/*}" + body: "stream" + }; + option (google.api.method_signature) = "stream,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Stream" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Stream. + rpc DeleteStream(DeleteStreamRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/clusters/*/streams/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Generate the JWT auth token required to get the stream HLS contents. + rpc GenerateStreamHlsToken(GenerateStreamHlsTokenRequest) returns (GenerateStreamHlsTokenResponse) { + option (google.api.http) = { + post: "/v1alpha1/{stream=projects/*/locations/*/clusters/*/streams/*}:generateStreamHlsToken" + body: "*" + }; + option (google.api.method_signature) = "stream"; + } + + // Lists Events in a given project and location. + rpc ListEvents(ListEventsRequest) returns (ListEventsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/events" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Event. + rpc GetEvent(GetEventRequest) returns (Event) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/clusters/*/events/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Event in a given project and location. + rpc CreateEvent(CreateEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/events" + body: "event" + }; + option (google.api.method_signature) = "parent,event,event_id"; + option (google.longrunning.operation_info) = { + response_type: "Event" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Event. + rpc UpdateEvent(UpdateEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{event.name=projects/*/locations/*/clusters/*/events/*}" + body: "event" + }; + option (google.api.method_signature) = "event,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Event" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Event. + rpc DeleteEvent(DeleteEventRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/clusters/*/events/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists Series in a given project and location. + rpc ListSeries(ListSeriesRequest) returns (ListSeriesResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/series" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single Series. + rpc GetSeries(GetSeriesRequest) returns (Series) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/clusters/*/series/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new Series in a given project and location. + rpc CreateSeries(CreateSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/series" + body: "series" + }; + option (google.api.method_signature) = "parent,series,series_id"; + option (google.longrunning.operation_info) = { + response_type: "Series" + metadata_type: "OperationMetadata" + }; + } + + // Updates the parameters of a single Event. + rpc UpdateSeries(UpdateSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1alpha1/{series.name=projects/*/locations/*/clusters/*/series/*}" + body: "series" + }; + option (google.api.method_signature) = "series,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Series" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a single Series. + rpc DeleteSeries(DeleteSeriesRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/clusters/*/series/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Materialize a channel. + rpc MaterializeChannel(MaterializeChannelRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/clusters/*}/channels" + body: "channel" + }; + option (google.api.method_signature) = "parent,channel,channel_id"; + option (google.longrunning.operation_info) = { + response_type: "Channel" + metadata_type: "OperationMetadata" + }; + } +} + +// Message for requesting list of Clusters. +message ListClustersRequest { + // Required. Parent value for ListClustersRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // 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 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. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; +} + +// Message for creating a Cluster. +message CreateClusterRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.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]; +} + +// Message for updating a Cluster. +message UpdateClusterRequest { + // Required. 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) = REQUIRED]; + + // 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]; +} + +// Message for deleting a Cluster. +message DeleteClusterRequest { + // Required. Name of the resource + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.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]; +} + +// Message for requesting list of Streams. +message ListStreamsRequest { + // Required. Parent value for ListStreamsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Streams. +message ListStreamsResponse { + // The list of Stream. + repeated Stream streams = 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 Stream. +message GetStreamRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; +} + +// Message for creating a Stream. +message CreateStreamRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string stream_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Stream stream = 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]; +} + +// Message for updating a Stream. +message UpdateStreamRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Stream 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) = REQUIRED]; + + // Required. The resource being updated. + Stream stream = 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 deleting a Stream. +message DeleteStreamRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Stream" + } + ]; + + // 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]; +} + +// Message for the response of GetStreamThumbnail. The empty response message +// indicates the thumbnail image has been uploaded to GCS successfully. +message GetStreamThumbnailResponse { + +} + +// Request message for getting the auth token to access the stream HLS contents. +message GenerateStreamHlsTokenRequest { + // Required. The name of the stream. + string stream = 1 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for GenerateStreamHlsToken. +message GenerateStreamHlsTokenResponse { + // The generated JWT token. + // + // The caller should insert this token to the authorization header of the HTTP + // requests to get the HLS playlist manifest and the video chunks. + // eg: curl -H "Authorization: Bearer $TOKEN" + // https://domain.com/test-stream.playback/master.m3u8 + string token = 1; + + // The expiration time of the token. + google.protobuf.Timestamp expiration_time = 2; +} + +// Message for requesting list of Events. +message ListEventsRequest { + // Required. Parent value for ListEventsRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Events. +message ListEventsResponse { + // The list of Event. + repeated Event events = 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 Event. +message GetEventRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; +} + +// Message for creating a Event. +message CreateEventRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string event_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Event event = 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]; +} + +// Message for updating a Event. +message UpdateEventRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // Event 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) = REQUIRED]; + + // Required. The resource being updated. + Event event = 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 deleting a Event. +message DeleteEventRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Event" + } + ]; + + // 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]; +} + +// Message for requesting list of Series. +message ListSeriesRequest { + // Required. Parent value for ListSeriesRequest. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // 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 Series. +message ListSeriesResponse { + // The list of Series. + repeated Series series = 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 Series. +message GetSeriesRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + } + ]; +} + +// Message for creating a Series. +message CreateSeriesRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the requesting object. + string series_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Series series = 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]; +} + +// Message for updating a Series. +message UpdateSeriesRequest { + // Required. Field mask is used to specify the fields to be overwritten in the Series + // 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) = REQUIRED]; + + // Required. The resource being updated + Series series = 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 deleting a Series. +message DeleteSeriesRequest { + // Required. Name of the resource. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Series" + } + ]; + + // 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]; +} + +// Message for materializing a channel. +message MaterializeChannelRequest { + // Required. Value for parent. + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Cluster" + } + ]; + + // Required. Id of the channel. + string channel_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The resource being created. + Channel channel = 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]; +} diff --git a/google/cloud/visionai/v1alpha1/visionai_grpc_service_config.json b/google/cloud/visionai/v1alpha1/visionai_grpc_service_config.json new file mode 100644 index 000000000..539b67f4d --- /dev/null +++ b/google/cloud/visionai/v1alpha1/visionai_grpc_service_config.json @@ -0,0 +1,203 @@ +{ + "methodConfig": [{ + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics" + } + ], + "timeout": "60s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "CreateCluster" + }], + "timeout": "600s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "CreateStream" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "CreateEvent" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "CreateSeries" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "CreateOperator" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "CreateVersion" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "CreateAnalysis" + }], + "timeout": "300s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "GetCluster" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "ListClusters" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "UpdateCluster" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "DeleteCluster" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "ListStreams" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "GetStream" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "UpdateStream" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "DeleteStream" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "ListEvents" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "GetEvent" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "UpdateEvent" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "DeleteEvent" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "ListSeries" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "GetSeries" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "UpdateSeries" + }, + { + "service": "google.cloud.visionai.v1alpha1.Streams", + "method": "DeleteSeries" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "ListOperators" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "GetOperator" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "UpdateOperator" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "DeleteOperator" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "ListAnalyses" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "GetAnalysis" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "UpdateAnalysis" + }, + { + "service": "google.cloud.visionai.v1alpha1.LiveVideoAnalytics", + "method": "DeleteAnalysis" + } + ], + "timeout": "60s" + }, + { + "name": [{ + "service": "google.cloud.visionai.v1alpha1.Warehouse", + "method": "CreateCorpus" + }, + { + "service": "google.cloud.visionai.v1alpha1.Warehouse", + "method": "CreateAsset" + }, + { + "service": "google.cloud.visionai.v1alpha1.Warehouse", + "method": "CreateDataSchema" + }, + { + "service": "google.cloud.visionai.v1alpha1.Warehouse", + "method": "CreateAnnotation" + }, + { + "service": "google.cloud.visionai.v1alpha1.Warehouse", + "method": "IngestAsset" + } + ], + "timeout": "120s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "120s", + "backoffMultiplier": 2.5, + "retryableStatusCodes": [ + "UNAVAILABLE", + "DEADLINE_EXCEEDED" + ] + } + } + ] +} diff --git a/google/cloud/visionai/v1alpha1/visionai_v1alpha1.yaml b/google/cloud/visionai/v1alpha1/visionai_v1alpha1.yaml new file mode 100644 index 000000000..307d77319 --- /dev/null +++ b/google/cloud/visionai/v1alpha1/visionai_v1alpha1.yaml @@ -0,0 +1,190 @@ +type: google.api.Service +config_version: 3 +name: visionai.googleapis.com +title: Vision AI API + +apis: +- name: google.cloud.location.Locations +- name: google.cloud.visionai.v1alpha1.AppPlatform +- name: google.cloud.visionai.v1alpha1.LiveVideoAnalytics +- name: google.cloud.visionai.v1alpha1.StreamingService +- name: google.cloud.visionai.v1alpha1.StreamsService +- name: google.cloud.visionai.v1alpha1.Warehouse +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations + +types: +- name: google.cloud.visionai.v1alpha1.AddApplicationStreamInputResponse +- name: google.cloud.visionai.v1alpha1.AppPlatformCloudFunctionRequest +- name: google.cloud.visionai.v1alpha1.AppPlatformCloudFunctionResponse +- name: google.cloud.visionai.v1alpha1.AppPlatformMetadata +- name: google.cloud.visionai.v1alpha1.ClassificationPredictionResult +- name: google.cloud.visionai.v1alpha1.CreateApplicationInstancesResponse +- name: google.cloud.visionai.v1alpha1.CreateCorpusMetadata +- name: google.cloud.visionai.v1alpha1.DeleteApplicationInstancesResponse +- name: google.cloud.visionai.v1alpha1.DeleteAssetMetadata +- name: google.cloud.visionai.v1alpha1.DeployApplicationResponse +- name: google.cloud.visionai.v1alpha1.GetStreamThumbnailResponse +- name: google.cloud.visionai.v1alpha1.ImageObjectDetectionPredictionResult +- name: google.cloud.visionai.v1alpha1.ImageSegmentationPredictionResult +- name: google.cloud.visionai.v1alpha1.ObjectDetectionPredictionResult +- name: google.cloud.visionai.v1alpha1.OccupancyCountingPredictionResult +- name: google.cloud.visionai.v1alpha1.OperationMetadata +- name: google.cloud.visionai.v1alpha1.PersonalProtectiveEquipmentDetectionOutput +- name: google.cloud.visionai.v1alpha1.RemoveApplicationStreamInputResponse +- name: google.cloud.visionai.v1alpha1.StreamAnnotations +- name: google.cloud.visionai.v1alpha1.UndeployApplicationResponse +- name: google.cloud.visionai.v1alpha1.UpdateApplicationInstancesResponse +- name: google.cloud.visionai.v1alpha1.UpdateApplicationStreamInputResponse +- name: google.cloud.visionai.v1alpha1.VideoActionRecognitionPredictionResult +- name: google.cloud.visionai.v1alpha1.VideoClassificationPredictionResult +- name: google.cloud.visionai.v1alpha1.VideoObjectTrackingPredictionResult + +documentation: + 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.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 + - selector: 'google.cloud.visionai.v1alpha1.AppPlatform.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1alpha1.LiveVideoAnalytics.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1alpha1.StreamsService.*' + deadline: 60.0 + - selector: 'google.cloud.visionai.v1alpha1.Warehouse.*' + 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: '/v1alpha1/{name=projects/*/locations/*}' + - selector: google.cloud.location.Locations.ListLocations + get: '/v1alpha1/{name=projects/*}/locations' + - selector: google.iam.v1.IAMPolicy.GetIamPolicy + get: '/v1alpha1/{resource=projects/*/locations/*/clusters/*}:getIamPolicy' + additional_bindings: + - get: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/streams/*}:getIamPolicy' + - get: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/events/*}:getIamPolicy' + - get: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/series/*}:getIamPolicy' + - get: '/v1alpha1/{resource=projects/*/locations/*/operators/*}:getIamPolicy' + - get: '/v1alpha1/{resource=projects/*/locations/*/operators/*/versions/*}:getIamPolicy' + - get: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/analyses/*}:getIamPolicy' + - selector: google.iam.v1.IAMPolicy.SetIamPolicy + post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*}:setIamPolicy' + body: '*' + additional_bindings: + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/streams/*}:setIamPolicy' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/events/*}:setIamPolicy' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/series/*}:setIamPolicy' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/operators/*}:setIamPolicy' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/operators/*/versions/*}:setIamPolicy' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/analyses/*}:setIamPolicy' + body: '*' + - selector: google.iam.v1.IAMPolicy.TestIamPermissions + post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*}:testIamPermissions' + body: '*' + additional_bindings: + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/streams/*}:testIamPermissions' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/events/*}:testIamPermissions' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/series/*}:testIamPermissions' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/operators/*}:testIamPermissions' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/operators/*/versions/*}:testIamPermissions' + body: '*' + - post: '/v1alpha1/{resource=projects/*/locations/*/clusters/*/analyses/*}:testIamPermissions' + body: '*' + - selector: google.longrunning.Operations.CancelOperation + post: '/v1alpha1/{name=projects/*/locations/*/operations/*}:cancel' + body: '*' + - selector: google.longrunning.Operations.DeleteOperation + delete: '/v1alpha1/{name=projects/*/locations/*/operations/*}' + - selector: google.longrunning.Operations.GetOperation + get: '/v1alpha1/{name=projects/*/locations/*/operations/*}' + additional_bindings: + - get: '/v1alpha1/{name=projects/*/locations/*/warehouseOperations/*}' + - get: '/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*/operations/*}' + - selector: google.longrunning.Operations.ListOperations + get: '/v1alpha1/{name=projects/*/locations/*}/operations' + +authentication: + rules: + - 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.cloud.visionai.v1alpha1.AppPlatform.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1alpha1.LiveVideoAnalytics.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1alpha1.StreamingService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1alpha1.StreamsService.*' + oauth: + canonical_scopes: |- + https://www.googleapis.com/auth/cloud-platform + - selector: 'google.cloud.visionai.v1alpha1.Warehouse.*' + 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 diff --git a/google/cloud/visionai/v1alpha1/warehouse.proto b/google/cloud/visionai/v1alpha1/warehouse.proto new file mode 100644 index 000000000..62ff9729e --- /dev/null +++ b/google/cloud/visionai/v1alpha1/warehouse.proto @@ -0,0 +1,1653 @@ +// 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.visionai.v1alpha1; + +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/any.proto"; +import "google/protobuf/duration.proto"; +import "google/protobuf/empty.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/struct.proto"; +import "google/protobuf/timestamp.proto"; +import "google/rpc/status.proto"; +import "google/type/datetime.proto"; + +option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai"; +option java_multiple_files = true; +option java_outer_classname = "WarehouseProto"; +option java_package = "com.google.cloud.visionai.v1alpha1"; +option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1"; +option ruby_package = "Google::Cloud::VisionAI::V1alpha1"; + +// Service that manages media content + metadata for streaming. +service Warehouse { + option (google.api.default_host) = "visionai.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Creates an asset inside corpus. + rpc CreateAsset(CreateAssetRequest) returns (Asset) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/assets" + body: "asset" + }; + option (google.api.method_signature) = "parent,asset,asset_id"; + } + + // Updates an asset inside corpus. + rpc UpdateAsset(UpdateAssetRequest) returns (Asset) { + option (google.api.http) = { + patch: "/v1alpha1/{asset.name=projects/*/locations/*/corpora/*/assets/*}" + body: "asset" + }; + option (google.api.method_signature) = "asset,update_mask"; + } + + // Reads an asset inside corpus. + rpc GetAsset(GetAssetRequest) returns (Asset) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists an list of assets inside corpus. + rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/assets" + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes asset inside corpus. + rpc DeleteAsset(DeleteAssetRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "DeleteAssetMetadata" + }; + } + + // Creates a corpus inside a project. + rpc CreateCorpus(CreateCorpusRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*}/corpora" + body: "corpus" + }; + option (google.api.method_signature) = "parent,corpus"; + option (google.longrunning.operation_info) = { + response_type: "Corpus" + metadata_type: "CreateCorpusMetadata" + }; + } + + // Gets corpus details inside a project. + rpc GetCorpus(GetCorpusRequest) returns (Corpus) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/corpora/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Updates a corpus in a project. + rpc UpdateCorpus(UpdateCorpusRequest) returns (Corpus) { + option (google.api.http) = { + patch: "/v1alpha1/{corpus.name=projects/*/locations/*/corpora/*}" + body: "corpus" + }; + option (google.api.method_signature) = "corpus,update_mask"; + } + + // Lists all corpora in a project. + rpc ListCorpora(ListCorporaRequest) returns (ListCorporaResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*}/corpora" + }; + option (google.api.method_signature) = "parent"; + } + + // Deletes a corpus only if its empty. + // Returns empty response. + rpc DeleteCorpus(DeleteCorpusRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/corpora/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates data schema inside corpus. + rpc CreateDataSchema(CreateDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" + body: "data_schema" + }; + option (google.api.method_signature) = "parent,data_schema"; + } + + // Updates data schema inside corpus. + rpc UpdateDataSchema(UpdateDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + patch: "/v1alpha1/{data_schema.name=projects/*/locations/*/corpora/*/dataSchemas/*}" + body: "data_schema" + }; + option (google.api.method_signature) = "data_schema,update_mask"; + } + + // Gets data schema inside corpus. + rpc GetDataSchema(GetDataSchemaRequest) returns (DataSchema) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Deletes data schema inside corpus. + rpc DeleteDataSchema(DeleteDataSchemaRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/corpora/*/dataSchemas/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists a list of data schemas inside corpus. + rpc ListDataSchemas(ListDataSchemasRequest) returns (ListDataSchemasResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/dataSchemas" + }; + option (google.api.method_signature) = "parent"; + } + + // Creates annotation inside asset. + rpc CreateAnnotation(CreateAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" + body: "annotation" + }; + option (google.api.method_signature) = "parent,annotation,annotation_id"; + } + + // Reads annotation inside asset. + rpc GetAnnotation(GetAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists a list of annotations inside asset. + rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations" + }; + option (google.api.method_signature) = "parent"; + } + + // Updates annotation inside asset. + rpc UpdateAnnotation(UpdateAnnotationRequest) returns (Annotation) { + option (google.api.http) = { + patch: "/v1alpha1/{annotation.name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + body: "annotation" + }; + option (google.api.method_signature) = "annotation,update_mask"; + } + + // Deletes annotation inside asset. + rpc DeleteAnnotation(DeleteAnnotationRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*/annotations/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Ingests data for the asset. It is not allowed to ingest a data chunk which + // is already expired according to TTL. + // This method is only available via the gRPC API (not HTTP since + // bi-directional streaming is not supported via HTTP). + rpc IngestAsset(stream IngestAssetRequest) returns (stream IngestAssetResponse) { + } + + // Generates clips for downloading. The api takes in a time range, and + // generates a clip of the first content available after start_time and + // before end_time, which may overflow beyond these bounds. + // Returned clips are truncated if the total size of the clips are larger + // than 100MB. + rpc ClipAsset(ClipAssetRequest) returns (ClipAssetResponse) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}:clip" + body: "*" + }; + } + + // Generates a uri for an HLS manifest. The api takes in a collection of time + // ranges, and generates a URI for an HLS manifest that covers all the + // requested time ranges. + rpc GenerateHlsUri(GenerateHlsUriRequest) returns (GenerateHlsUriResponse) { + option (google.api.http) = { + post: "/v1alpha1/{name=projects/*/locations/*/corpora/*/assets/*}:generateHlsUri" + body: "*" + }; + } + + // Creates a search configuration inside a corpus. + // + // Please follow the rules below to create a valid CreateSearchConfigRequest. + // --- General Rules --- + // 1. Request.search_config_id must not be associated with an existing + // SearchConfig. + // 2. Request must contain at least one non-empty search_criteria_property or + // facet_property. + // 3. mapped_fields must not be empty, and must map to existing UGA keys. + // 4. All mapped_fields must be of the same type. + // 5. All mapped_fields must share the same granularity. + // 6. All mapped_fields must share the same semantic SearchConfig match + // options. + // For property-specific rules, please reference the comments for + // FacetProperty and SearchCriteriaProperty. + rpc CreateSearchConfig(CreateSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + post: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" + body: "search_config" + }; + option (google.api.method_signature) = "parent,search_config,search_config_id"; + } + + // Updates a search configuration inside a corpus. + // + // Please follow the rules below to create a valid UpdateSearchConfigRequest. + // --- General Rules --- + // 1. Request.search_configuration.name must already exist. + // 2. Request must contain at least one non-empty search_criteria_property or + // facet_property. + // 3. mapped_fields must not be empty, and must map to existing UGA keys. + // 4. All mapped_fields must be of the same type. + // 5. All mapped_fields must share the same granularity. + // 6. All mapped_fields must share the same semantic SearchConfig match + // options. + // For property-specific rules, please reference the comments for + // FacetProperty and SearchCriteriaProperty. + rpc UpdateSearchConfig(UpdateSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + patch: "/v1alpha1/{search_config.name=projects/*/locations/*/corpora/*/searchConfigs/*}" + body: "search_config" + }; + option (google.api.method_signature) = "search_config,update_mask"; + } + + // Gets a search configuration inside a corpus. + rpc GetSearchConfig(GetSearchConfigRequest) returns (SearchConfig) { + option (google.api.http) = { + get: "/v1alpha1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Deletes a search configuration inside a corpus. + // + // For a DeleteSearchConfigRequest to be valid, + // Request.search_configuration.name must already exist. + rpc DeleteSearchConfig(DeleteSearchConfigRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete: "/v1alpha1/{name=projects/*/locations/*/corpora/*/searchConfigs/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists all search configurations inside a corpus. + rpc ListSearchConfigs(ListSearchConfigsRequest) returns (ListSearchConfigsResponse) { + option (google.api.http) = { + get: "/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs" + }; + option (google.api.method_signature) = "parent"; + } + + // Search media asset. + rpc SearchAssets(SearchAssetsRequest) returns (SearchAssetsResponse) { + option (google.api.http) = { + post: "/v1alpha1/{corpus=projects/*/locations/*/corpora/*}:searchAssets" + body: "*" + }; + } +} + +// Different types for a facet bucket. +enum FacetBucketType { + // Unspecified type. + FACET_BUCKET_TYPE_UNSPECIFIED = 0; + + // Value type. + FACET_BUCKET_TYPE_VALUE = 1; + + // Datetime type. + FACET_BUCKET_TYPE_DATETIME = 2; + + // Fixed Range type. + FACET_BUCKET_TYPE_FIXED_RANGE = 3; + + // Custom Range type. + FACET_BUCKET_TYPE_CUSTOM_RANGE = 4; +} + +// Request message for CreateAssetRequest. +message CreateAssetRequest { + // Required. The parent resource where this asset will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // Required. The asset to create. + Asset asset = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The ID to use for the asset, which will become the final component of + // the asset's resource name if user choose to specify. Otherwise, asset id + // will be generated by system. + // + // This value should be up to 63 characters, and valid characters + // are /[a-z][0-9]-/. The first character must be a letter, the last could be + // a letter or a number. + optional string asset_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for GetAsset. +message GetAssetRequest { + // Required. The name of the asset to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; +} + +// Request message for ListAssets. +message ListAssetsRequest { + // Required. The parent, which owns this collection of assets. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/Asset" + } + ]; + + // The maximum number of assets to return. The service may return fewer than + // this value. + // If unspecified, at most 50 assets 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 `ListAssets` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListAssets` must match + // the call that provided the page token. + string page_token = 3; +} + +// Response message for ListAssets. +message ListAssetsResponse { + // The assets from the specified corpus. + repeated Asset assets = 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; +} + +// Response message for UpdateAsset. +message UpdateAssetRequest { + // Required. The asset to update. + // + // The asset's `name` field is used to identify the asset to be updated. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + Asset asset = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for DeleteAsset. +message DeleteAssetRequest { + // Required. The name of the asset to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; +} + +// An asset is a resource in corpus. It represents a media object inside corpus, +// contains metadata and another resource annotation. Different feature could be +// applied to the asset to generate annotations. User could specified annotation +// related to the target asset. +message Asset { + option (google.api.resource) = { + type: "visionai.googleapis.com/Asset" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}" + }; + + // Resource name of the asset. + // Form: + // `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` + string name = 1; + + // The duration for which all media assets, associated metadata, and search + // documents can exist. If not set, then it will using the default ttl in the + // parent corpus resource. + google.protobuf.Duration ttl = 2; +} + +// Request message of CreateCorpus API. +message CreateCorpusRequest { + // Required. Form: `projects/{project_number}/locations/{location_id}` + string parent = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The corpus to be created. + Corpus corpus = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Metadata for CreateCorpus API. +message CreateCorpusMetadata { + +} + +// Corpus is a set of video contents for management. Within a corpus, videos +// share the same data schema. Search is also restricted within a single corpus. +message Corpus { + option (google.api.resource) = { + type: "visionai.googleapis.com/Corpus" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}" + }; + + // Resource name of the corpus. + // Form: + // `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` + string name = 1; + + // Required. The corpus name to shown in the UI. The name can be up to 32 characters + // long. + string display_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Description of the corpus. Can be up to 25000 characters long. + string description = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Required. The default TTL value for all assets under the corpus without a asset level + // user-defined TTL with a maximum of 10 years. This is required for all + // corpora. + google.protobuf.Duration default_ttl = 5 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for GetCorpus. +message GetCorpusRequest { + // Required. The resource name of the corpus to retrieve. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; +} + +// Request message for UpdateCorpus. +message UpdateCorpusRequest { + // Required. The corpus which replaces the resource on the server. + Corpus corpus = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for ListCorpora. +message ListCorporaRequest { + // Required. The resource name of the project from which to list corpora. + string parent = 1 [(google.api.field_behavior) = REQUIRED]; + + // Requested page size. API may return fewer results than requested. + // If negative, INVALID_ARGUMENT error will be returned. + // If unspecified or 0, API will pick a default size, which is 10. + // If the requested page size is larger than the maximum size, API will pick + // use the maximum size, which is 20. + int32 page_size = 2; + + // A token identifying a page of results for the server to return. + // Typically obtained via [ListCorpora.next_page_token][] of the previous + // [Warehouse.ListCorpora][google.cloud.visionai.v1alpha1.Warehouse.ListCorpora] call. + string page_token = 3; +} + +// Response message for ListCorpora. +message ListCorporaResponse { + // The corpora in the project. + repeated Corpus corpora = 1; + + // A token to retrieve next page of results. + // Pass to [ListCorporaRequest.page_token][google.cloud.visionai.v1alpha1.ListCorporaRequest.page_token] to obtain that page. + string next_page_token = 2; +} + +// Request message for DeleteCorpus. +message DeleteCorpusRequest { + // Required. The resource name of the corpus to delete. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; +} + +// Request message for CreateDataSchema. +message CreateDataSchemaRequest { + // Required. The parent resource where this data schema will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // Required. The data schema to create. + DataSchema data_schema = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Data schema indicates how the user specified annotation is interpreted in the +// system. +message DataSchema { + option (google.api.resource) = { + type: "visionai.googleapis.com/DataSchema" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}" + }; + + // Resource name of the data schema in the form of: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}` + // where {data_schema} part should be the same as the `key` field below. + string name = 1; + + // Required. The key of this data schema. This key should be matching the key of user + // specified annotation and unique inside corpus. This value can be up to + // 63 characters, and valid characters are /[a-z][0-9]-/. The first character + // must be a letter, the last could be a letter or a number. + string key = 2 [(google.api.field_behavior) = REQUIRED]; + + // The schema details mapping to the key. + DataSchemaDetails schema_details = 3; +} + +// Data schema details indicates the data type and the data struct corresponding +// to the key of user specified annotation. +message DataSchemaDetails { + // The configuration for `PROTO_ANY` data type. + message ProtoAnyConfig { + // The type URI of the proto message. + string type_uri = 1; + } + + // The search strategy for annotations value of the `key`. + message SearchStrategy { + // The types of search strategies to be applied on the annotation key. + enum SearchStrategyType { + // Annotatation values of the `key` above will not be searchable. + NO_SEARCH = 0; + + // When searching with `key`, the value must be exactly as the annotation + // value that has been ingested. + EXACT_SEARCH = 1; + + // When searching with `key`, Warehouse will perform broad search based on + // semantic of the annotation value. + SMART_SEARCH = 2; + } + + // The type of search strategy to be applied on the `key` above. + // The allowed `search_strategy_type` is different for different data types, + // which is documented in the DataSchemaDetails.DataType. Specifying + // unsupported `search_strategy_type` for data types will result in + // INVALID_ARGUMENT error. + SearchStrategyType search_strategy_type = 1; + } + + // Data type of the annotation. + enum DataType { + // Unspecified type. + DATA_TYPE_UNSPECIFIED = 0; + + // Integer type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by IntRangeArray. + INTEGER = 1; + + // Float type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by FloatRangeArray. + FLOAT = 2; + + // String type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH, + // - DataSchema.SearchStrategy.SMART_SEARCH. + STRING = 3; + + // Supported formats: + // %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) + // %Y-%m-%dT%H:%M:%E*S + // %Y-%m-%dT%H:%M%E*z + // %Y-%m-%dT%H:%M + // %Y-%m-%dT%H%E*z + // %Y-%m-%dT%H + // %Y-%m-%d%E*z + // %Y-%m-%d + // %Y-%m + // %Y + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by DateTimeRangeArray. + DATETIME = 5; + + // Geo coordinate type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + // Supports query by GeoLocationArray. + GEO_COORDINATE = 7; + + // Type to pass any proto as available in annotations.proto. Only use + // internally. + // Available proto types and its corresponding search behavior: + // - ImageObjectDetectionPredictionResult, allows SMART_SEARCH on + // display_names and NO_SEARCH. + // - ClassificationPredictionResult, allows SMART_SEARCH on display_names + // and NO_SEARCH. + // - ImageSegmentationPredictionResult, allows NO_SEARCH. + // - VideoActionRecognitionPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - VideoObjectTrackingPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - VideoClassificationPredictionResult, allows SMART_SEARCH on + // display_name and NO_SEARCH. + // - OccupancyCountingPredictionResult, allows EXACT_SEARCH on + // stats.full_frame_count.count and NO_SEARCH. + // - ObjectDetectionPredictionResult, allows SMART_SEARCH on + // identified_boxes.entity.label_string and NO_SEARCH. + PROTO_ANY = 8; + + // Boolean type. + // Allowed search strategies: + // - DataSchema.SearchStrategy.NO_SEARCH, + // - DataSchema.SearchStrategy.EXACT_SEARCH. + BOOLEAN = 9; + } + + // The granularity of annotations under this DataSchema. + enum Granularity { + // Unspecified granularity. + GRANULARITY_UNSPECIFIED = 0; + + // Asset-level granularity (annotations must not contain partition info). + GRANULARITY_ASSET_LEVEL = 1; + + // Partition-level granularity (annotations must contain partition info). + GRANULARITY_PARTITION_LEVEL = 2; + } + + // Type of the annotation. + DataType type = 1; + + // Config for protobuf any type. + ProtoAnyConfig proto_any_config = 6; + + // The granularity associated with this DataSchema. + Granularity granularity = 5; + + // The search strategy to be applied on the `key` above. + SearchStrategy search_strategy = 7; +} + +// Request message for UpdateDataSchema. +message UpdateDataSchemaRequest { + // Required. The data schema's `name` field is used to identify the data schema to be + // updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema} + DataSchema data_schema = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for GetDataSchema. +message GetDataSchemaRequest { + // Required. The name of the data schema to retrieve. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/DataSchema" + } + ]; +} + +// Request message for DeleteDataSchema. +message DeleteDataSchemaRequest { + // Required. The name of the data schema to delete. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/DataSchema" + } + ]; +} + +// Request message for ListDataSchemas. +message ListDataSchemasRequest { + // Required. The parent, which owns this collection of data schemas. + // Format: + // projects/{project_number}/locations/{location_id}/corpora/{corpus_id} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/DataSchema" + } + ]; + + // The maximum number of data schemas to return. The service may return fewer + // than this value. If unspecified, at most 50 data schemas 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 `ListDataSchemas` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListDataSchemas` must + // match the call that provided the page token. + string page_token = 3; +} + +// Response message for ListDataSchemas. +message ListDataSchemasResponse { + // The data schemas from the specified corpus. + repeated DataSchema data_schemas = 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 CreateAnnotation. +message CreateAnnotationRequest { + // Required. The parent resource where this annotation will be created. + // Format: projects/*/locations/*/corpora/*/assets/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The annotation to create. + Annotation annotation = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The ID to use for the annotation, which will become the final component of + // the annotation's resource name if user choose to specify. Otherwise, + // annotation id will be generated by system. + // + // This value should be up to 63 characters, and valid characters + // are /[a-z][0-9]-/. The first character must be a letter, the last could be + // a letter or a number. + optional string annotation_id = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// An annotation is a resource in asset. It represents a key-value mapping of +// content in asset. +message Annotation { + option (google.api.resource) = { + type: "visionai.googleapis.com/Annotation" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}" + }; + + // Resource name of the annotation. + // Form: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` + string name = 1; + + // User provided annotation. + UserSpecifiedAnnotation user_specified_annotation = 2; +} + +// Annotation provided by users. +message UserSpecifiedAnnotation { + // Required. Key of the annotation. The key must be set with type by CreateDataSchema. + string key = 1 [(google.api.field_behavior) = REQUIRED]; + + // Value of the annotation. The value must be able to convert + // to the type according to the data schema. + AnnotationValue value = 2; + + // Partition information in time and space for the sub-asset level annotation. + Partition partition = 3; +} + +// Location Coordinate Representation +message GeoCoordinate { + // Latitude Coordinate. Degrees [-90 .. 90] + double latitude = 1; + + // Longitude Coordinate. Degrees [-180 .. 180] + double longitude = 2; +} + +// Value of annotation, including all types available in data schema. +message AnnotationValue { + oneof value { + // Value of int type annotation. + int64 int_value = 1; + + // Value of float type annotation. + float float_value = 2; + + // Value of string type annotation. + string str_value = 3; + + // Value of date time type annotation. + string datetime_value = 5; + + // Value of geo coordinate type annotation. + GeoCoordinate geo_coordinate = 7; + + // Value of any proto value. + google.protobuf.Any proto_any_value = 8; + + // Value of boolean type annotation. + bool bool_value = 9; + + // Value of customized struct annotation. + google.protobuf.Struct customized_struct_data_value = 10; + } +} + +// Request message for GetAnnotation API. +message ListAnnotationsRequest { + // The parent, which owns this collection of annotations. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} + string parent = 1 [(google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + }]; + + // The maximum number of annotations to return. The service may return fewer + // than this value. If unspecified, at most 50 annotations 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 `ListAnnotations` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListAnnotations` must + // match the call that provided the page token. + string page_token = 3; + + // The filter applied to the returned list. + // We only support filtering for the following fields: + // `partition.temporal_partition.start_time`, + // `partition.temporal_partition.end_time`, and `key`. + // Timestamps are specified in the RFC-3339 format, and only one restriction + // may be applied per field, joined by conjunctions. + // Format: + // "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND + // partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND + // key = "example_key"" + string filter = 4; +} + +// Request message for ListAnnotations API. +message ListAnnotationsResponse { + // The annotations from the specified asset. + repeated Annotation annotations = 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 GetAnnotation API. +message GetAnnotationRequest { + // Required. The name of the annotation to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Annotation" + } + ]; +} + +// Request message for UpdateAnnotation API. +message UpdateAnnotationRequest { + // Required. The annotation to update. + // The annotation's `name` field is used to identify the annotation to be + // updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + Annotation annotation = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for DeleteAnnotation API. +message DeleteAnnotationRequest { + // Required. The name of the annotation to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Annotation" + } + ]; +} + +// Request message for CreateSearchConfig. +message CreateSearchConfigRequest { + // Required. The parent resource where this search configuration will be created. + // Format: projects/*/locations/*/corpora/* + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/SearchConfig" + } + ]; + + // Required. The search config to create. + SearchConfig search_config = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. ID to use for the new search config. Will become the final component of the + // SearchConfig's resource name. This value should be up to 63 characters, and + // valid characters are /[a-z][0-9]-_/. The first character must be a letter, + // the last could be a letter or a number. + string search_config_id = 3 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for UpdateSearchConfig. +message UpdateSearchConfigRequest { + // Required. The search configuration to update. + // + // The search configuration's `name` field is used to identify the resource to + // be updated. Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + SearchConfig search_config = 1 [(google.api.field_behavior) = REQUIRED]; + + // The list of fields to be updated. If left unset, all field paths will be + // updated/overwritten. + google.protobuf.FieldMask update_mask = 2; +} + +// Request message for GetSearchConfig. +message GetSearchConfigRequest { + // Required. The name of the search configuration to retrieve. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/SearchConfig" + } + ]; +} + +// Request message for DeleteSearchConfig. +message DeleteSearchConfigRequest { + // Required. The name of the search configuration to delete. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config} + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/SearchConfig" + } + ]; +} + +// Request message for ListSearchConfigs. +message ListSearchConfigsRequest { + // Required. The parent, which owns this collection of search configurations. + // Format: + // projects/{project_number}/locations/{location}/corpora/{corpus} + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "visionai.googleapis.com/SearchConfig" + } + ]; + + // The maximum number of search configurations to return. The service may + // return fewer than this value. If unspecified, a page size of 50 will be + // used. The maximum value is 1000; values above 1000 will be coerced to 1000. + int32 page_size = 2; + + // A page token, received from a previous `ListSearchConfigs` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListSearchConfigs` must match the call that provided the page + // token. + string page_token = 3; +} + +// Response message for ListSearchConfigs. +message ListSearchConfigsResponse { + // The search configurations from the specified corpus. + repeated SearchConfig search_configs = 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; +} + +// SearchConfig stores different properties that will affect search +// behaviors and search results. +message SearchConfig { + option (google.api.resource) = { + type: "visionai.googleapis.com/SearchConfig" + pattern: "projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}" + }; + + // Resource name of the search configuration. + // For CustomSearchCriteria, search_config would be the search + // operator name. For Facets, search_config would be the facet + // dimension name. + // Form: + // `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` + string name = 1; + + // Establishes a FacetDimension and associated specifications. + FacetProperty facet_property = 2; + + // Creates a mapping between a custom SearchCriteria and one or more UGA keys. + SearchCriteriaProperty search_criteria_property = 3; +} + +// Central configuration for a facet. +message FacetProperty { + // If bucket type is FIXED_RANGE, specify how values are bucketized. Use + // FixedRangeBucketSpec when you want to create multiple buckets with equal + // granularities. Using integer bucket value as an example, when + // bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet + // will be aggregated via the following buckets: + // [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). + // Notably, bucket_count <= 1 is an invalid spec. + message FixedRangeBucketSpec { + // Lower bound of the bucket. NOTE: Only integer type is currently supported + // for this field. + FacetValue bucket_start = 1; + + // Bucket granularity. NOTE: Only integer type is currently supported for + // this field. + FacetValue bucket_granularity = 2; + + // Total number of buckets. + int32 bucket_count = 3; + } + + // If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use + // integer bucket value as an example, when the endpoints are 0, 10, 100, and + // 1000, we will generate the following facets: + // [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). + // Notably: + // - endpoints must be listed in ascending order. Otherwise, the SearchConfig + // API will reject the facet config. + // - < 1 endpoints is an invalid spec. + message CustomRangeBucketSpec { + // Currently, only integer type is supported for this field. + repeated FacetValue endpoints = 1; + } + + // If bucket type is DATE, specify how date values are bucketized. + message DateTimeBucketSpec { + // Granularity enum for the datetime bucket. + enum Granularity { + // Unspecified granularity. + GRANULARITY_UNSPECIFIED = 0; + + // Granularity is year. + YEAR = 1; + + // Granularity is month. + MONTH = 2; + + // Granularity is day. + DAY = 3; + } + + // Granularity of date type facet. + Granularity granularity = 1; + } + + oneof range_facet_config { + // Fixed range facet bucket config. + FixedRangeBucketSpec fixed_range_bucket_spec = 5; + + // Custom range facet bucket config. + CustomRangeBucketSpec custom_range_bucket_spec = 6; + + // Datetime range facet bucket config. + DateTimeBucketSpec datetime_bucket_spec = 7; + } + + // Name of the facets, which are the dimensions users want to use to refine + // search results. `mapped_fields` will match UserSpecifiedDataSchema keys. + // + // For example, user can add a bunch of UGAs with the same key, such as + // player:adam, player:bob, player:charles. When multiple mapped_fields are + // specified, will merge their value together as final facet value. E.g. + // home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = + // [home_team, away_team], facet_value will be [a, b, c]. + // + // UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the + // mapped_field equals the parent SearchConfig.name, the parent must + // also contain a SearchCriteriaProperty that maps to the same fields. + // mapped_fields must not be empty. + repeated string mapped_fields = 1; + + // Display name of the facet. To be used by UI for facet rendering. + string display_name = 2; + + // Maximum number of unique bucket to return for one facet. Bucket number can + // be large for high-cardinality facet such as "player". We only return top-n + // most related ones to user. If it's <= 0, the server will decide the + // appropriate result_size. + int64 result_size = 3; + + // Facet bucket type e.g. value, range. + FacetBucketType bucket_type = 4; +} + +// Central configuration for custom search criteria. +message SearchCriteriaProperty { + // Each mapped_field corresponds to a UGA key. To understand how this property + // works, take the following example. In the SearchConfig table, the + // user adds this entry: + // search_config { + // name: "person" + // search_criteria_property { + // mapped_fields: "player" + // mapped_fields: "coach" + // } + // } + // + // Now, when a user issues a query like: + // criteria { + // field: "person" + // text_array { + // txt_values: "Tom Brady" + // txt_values: "Bill Belichick" + // } + // } + // + // MWH search will return search documents where (player=Tom Brady || + // coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick). + repeated string mapped_fields = 1; +} + +// Definition of a single value with generic type. +message FacetValue { + oneof value { + // String type value. + string string_value = 1; + + // Integer type value. + int64 integer_value = 2; + + // Datetime type value. + google.type.DateTime datetime_value = 3; + } +} + +// Holds the facet value, selections state, and metadata. +message FacetBucket { + // The range of values [start, end) for which faceting is applied. + message Range { + // Start of the range. Non-existence indicates some bound (e.g. -inf). + FacetValue start = 1; + + // End of the range. Non-existence indicates some bound (e.g. inf). + FacetValue end = 2; + } + + // Bucket associated with a facet. For example, bucket of facet “team” + // can be "49ers", "patriots", etc; bucket of facet "player" can be "tom + // brady", "drew brees", etc. + oneof bucket_value { + // Singular value. + FacetValue value = 2; + + // Range value. + Range range = 4; + } + + // Whether one facet bucket is selected. This field represents user's facet + // selection. It is set by frontend in SearchVideosRequest. + bool selected = 3; +} + +// A group of facet buckets to be passed back and forth between backend & +// frontend. +message FacetGroup { + // Unique id of the facet group. + string facet_id = 1; + + // Display name of the facet. To be used by UI for facet rendering. + string display_name = 2; + + // Buckets associated with the facet. E.g. for "Team" facet, the bucket + // can be 49ers, patriots, etc. + repeated FacetBucket buckets = 3; + + // Facet bucket type. + FacetBucketType bucket_type = 4; + + // If true, return query matched annotations for this facet group's selection. + // This option is only applicable for facets based on partition level + // annotations. It supports the following facet values: + // - INTEGER + // - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) + bool fetch_matched_annotations = 5; +} + +// Request message for IngestAsset API. +message IngestAssetRequest { + // Configuration for the data. + message Config { + // Type information for video data. + message VideoType { + // Container format of the video. + enum ContainerFormat { + // The default type, not supposed to be used. + CONTAINER_FORMAT_UNSPECIFIED = 0; + + // Mp4 container format. + CONTAINER_FORMAT_MP4 = 1; + } + + // Container format of the video data. + ContainerFormat container_format = 1; + } + + oneof data_type { + // Type information for video data. + VideoType video_type = 2; + } + + // Required. The resource name of the asset that the ingested data belongs to. + string asset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + } + + // Contains the data and the corresponding time range this data is for. + message TimeIndexedData { + // Data to be ingested. + bytes data = 1; + + // Time range of the data. + Partition.TemporalPartition temporal_partition = 2; + } + + oneof streaming_request { + // Provides information for the data and the asset resource name that the + // data belongs to. The first `IngestAssetRequest` message must only contain + // a `Config` message. + Config config = 1; + + // Data to be ingested. + TimeIndexedData time_indexed_data = 2; + } +} + +// Response message for IngestAsset API. +message IngestAssetResponse { + // Time range of the data that has been successfully ingested. + Partition.TemporalPartition successfully_ingested_partition = 1; +} + +// Request message for ClipAsset API. +message ClipAssetRequest { + // Required. The resource name of the asset to request clips for. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The time range to request clips for. + Partition.TemporalPartition temporal_partition = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for ClipAsset API. +message ClipAssetResponse { + // Signed uri with corresponding time range. + message TimeIndexedUri { + // Time range of the video that the uri is for. + Partition.TemporalPartition temporal_partition = 1; + + // Signed uri to download the video clip. + string uri = 2; + } + + // A list of signed uris to download the video clips that cover the requested + // time range ordered by time. + repeated TimeIndexedUri time_indexed_uris = 1; +} + +// Request message for GenerateHlsUri API. +message GenerateHlsUriRequest { + // Required. The resource name of the asset to request clips for. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Asset" + } + ]; + + // Required. The time range to request clips for. + repeated Partition.TemporalPartition temporal_partitions = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for GenerateHlsUri API. +message GenerateHlsUriResponse { + // A signed uri to download the HLS manifest corresponding to the requested + // times. + string uri = 1; + + // A list of temporal partitions of the content returned in the order they + // appear in the stream. + repeated Partition.TemporalPartition temporal_partitions = 2; +} + +// Request message for SearchAssets. +message SearchAssetsRequest { + // Required. The parent corpus to search. + // Form: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}' + string corpus = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "visionai.googleapis.com/Corpus" + } + ]; + + // The number of results to be returned in this page. If it's 0, the server + // will decide the appropriate page_size. + int32 page_size = 2; + + // The continuation token to fetch the next page. If empty, it means it is + // fetching the first page. + string page_token = 3; + + // Time ranges that matching video content must fall within. If no ranges are + // provided, there will be no time restriction. This field is treated just + // like the criteria below, but defined separately for convenience as it is + // used frequently. Note that if the end_time is in the future, it will be + // clamped to the time the request was received. + DateTimeRangeArray content_time_ranges = 5; + + // Criteria applied to search results. + repeated Criteria criteria = 4; + + // Stores most recent facet selection state. Only facet groups with user's + // selection will be presented here. Selection state is either selected or + // unselected. Only selected facet buckets will be used as search criteria. + repeated FacetGroup facet_selections = 6; + + // A list of annotation keys to specify the annotations to be retrieved and + // returned with each search result. + // Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search + // strategy must not be NO_SEARCH. + repeated string result_annotation_keys = 8; +} + +// The metadata for DeleteAsset API that embeds in +// [metadata][google.longrunning.Operation.metadata] field. +message DeleteAssetMetadata { + +} + +// Stores the criteria-annotation matching results for each search result item. +message AnnotationMatchingResult { + // The criteria used for matching. It can be an input search criteria or a + // criteria converted from a facet selection. + Criteria criteria = 1; + + // Matched annotations for the criteria. + repeated Annotation matched_annotations = 2; + + // Status of the match result. Possible values: + // FAILED_PRECONDITION - the criteria is not eligible for match. + // OK - matching is performed. + google.rpc.Status status = 3; +} + +// Search result contains asset name and corresponding time ranges. +message SearchResultItem { + // The resource name of the asset. + // Form: + // 'projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}' + string asset = 1; + + // The matched asset segments. + // Deprecated: please use singular `segment` field. + repeated Partition.TemporalPartition segments = 2 [deprecated = true]; + + // The matched asset segment. + Partition.TemporalPartition segment = 5; + + // Search result annotations specified by result_annotation_keys in search + // request. + repeated Annotation requested_annotations = 3; + + // Criteria or facet-selection based annotation matching results associated to + // this search result item. Only contains results for criteria or + // facet_selections with fetch_matched_annotations=true. + repeated AnnotationMatchingResult annotation_matching_results = 4; +} + +// Response message for SearchAssets. +message SearchAssetsResponse { + // Returned search results. + repeated SearchResultItem search_result_items = 1; + + // The next-page continuation token. + string next_page_token = 2; + + // Facet search results of a given query, which contains user's + // already-selected facet values and updated facet search results. + repeated FacetGroup facet_results = 3; +} + +// Integer range type. +message IntRange { + // Start of the int range. + optional int64 start = 1; + + // End of the int range. + optional int64 end = 2; +} + +// Float range type. +message FloatRange { + // Start of the float range. + optional float start = 1; + + // End of the float range. + optional float end = 2; +} + +// A list of string-type values. +message StringArray { + // String type values. + repeated string txt_values = 1; +} + +// A list of integer range values. +message IntRangeArray { + // Int range values. + repeated IntRange int_ranges = 1; +} + +// A list of float range values. +message FloatRangeArray { + // Float range values. + repeated FloatRange float_ranges = 1; +} + +// Datetime range type. +message DateTimeRange { + // Start date time. + google.type.DateTime start = 1; + + // End data time. + google.type.DateTime end = 2; +} + +// A list of datetime range values. +message DateTimeRangeArray { + // Date time ranges. + repeated DateTimeRange date_time_ranges = 1; +} + +// Representation of a circle area. +message CircleArea { + // Latitude of circle area's center. Degrees [-90 .. 90] + double latitude = 1; + + // Longitude of circle area's center. Degrees [-180 .. 180] + double longitude = 2; + + // Radius of the circle area in meters. + double radius_meter = 3; +} + +// A list of locations. +message GeoLocationArray { + // A list of circle areas. + repeated CircleArea circle_areas = 1; +} + +message BoolValue { + bool value = 1; +} + +// Filter criteria applied to current search results. +message Criteria { + oneof value { + // The text values associated with the field. + StringArray text_array = 2; + + // The integer ranges associated with the field. + IntRangeArray int_range_array = 3; + + // The float ranges associated with the field. + FloatRangeArray float_range_array = 4; + + // The datetime ranges associated with the field. + DateTimeRangeArray date_time_range_array = 5; + + // Geo Location array. + GeoLocationArray geo_location_array = 6; + + // A Boolean value. + BoolValue bool_value = 7; + } + + // The UGA field or ML field to apply filtering criteria. + string field = 1; + + // If true, return query matched annotations for this criteria. + // This option is only applicable for partition level annotations and supports + // the following data types: + // - INTEGER + // - FLOAT + // - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) + // - BOOLEAN + bool fetch_matched_annotations = 8; +} + +// Partition to specify the partition in time and space for sub-asset level +// annotation. +message Partition { + // Partition of asset in UTC Epoch time. + message TemporalPartition { + // Start time of the partition. + google.protobuf.Timestamp start_time = 1; + + // End time of the partition. + google.protobuf.Timestamp end_time = 2; + } + + // Partition of asset in space. + message SpatialPartition { + // The minimum x coordinate value. + optional int64 x_min = 1; + + // The minimum y coordinate value. + optional int64 y_min = 2; + + // The maximum x coordinate value. + optional int64 x_max = 3; + + // The maximum y coordinate value. + optional int64 y_max = 4; + } + + // Partition of asset in time. + TemporalPartition temporal_partition = 1; + + // Partition of asset in space. + SpatialPartition spatial_partition = 2; +} diff --git a/google/cloud/vmmigration/v1/BUILD.bazel b/google/cloud/vmmigration/v1/BUILD.bazel index 104f2fa9e..2976bb752 100644 --- a/google/cloud/vmmigration/v1/BUILD.bazel +++ b/google/cloud/vmmigration/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":vmmigration_proto_with_info"], gapic_yaml = None, grpc_service_config = "vmmigration_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vmmigration_v1.yaml", test_deps = [ ":vmmigration_java_grpc", @@ -136,13 +137,14 @@ go_gapic_library( grpc_service_config = "vmmigration_v1_grpc_service_config.json", importpath = "cloud.google.com/go/vmmigration/apiv1;vmmigration", metadata = True, + rest_numeric_enums = True, service_yaml = "vmmigration_v1.yaml", transport = "grpc+rest", deps = [ ":vmmigration_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -182,6 +184,7 @@ py_gapic_library( opt_args = [ "warehouse-package-name=google-cloud-vm-migration", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -229,7 +232,9 @@ php_gapic_library( name = "vmmigration_php_gapic", srcs = [":vmmigration_proto_with_info"], grpc_service_config = "vmmigration_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vmmigration_v1.yaml", + transport = "grpc+rest", deps = [ ":vmmigration_php_grpc", ":vmmigration_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "vmmigration_v1_grpc_service_config.json", package = "google.cloud.vmmigration.v1", + rest_numeric_enums = True, service_yaml = "vmmigration_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-namespace-override=VmMigration=VMMigration", ], grpc_service_config = "vmmigration_v1_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Migrate for Compute Engine enables you to migrate (Lift and Shift) your virtual machines (VMs), with minor automatic modifications, from your source environment to Google Compute Engine.", ruby_cloud_title = "Migrate for Compute Engine V1", deps = [ @@ -352,6 +360,7 @@ csharp_gapic_library( srcs = [":vmmigration_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vmmigration_v1_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vmmigration_v1.yaml", deps = [ ":vmmigration_csharp_grpc", diff --git a/google/cloud/vmwareengine/BUILD.bazel b/google/cloud/vmwareengine/BUILD.bazel new file mode 100644 index 000000000..ce0ead344 --- /dev/null +++ b/google/cloud/vmwareengine/BUILD.bazel @@ -0,0 +1,39 @@ +# This build file includes a target for the Ruby wrapper library for +# google-cloud-vmware_engine. + +# 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 VMware Engine. +# 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 = "vmwareengine_ruby_wrapper", + srcs = ["//google/cloud/vmwareengine/v1:vmwareengine_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-gem-name=google-cloud-vmware_engine", + "ruby-cloud-wrapper-of=v1:0.0", + "ruby-cloud-product-url=https://cloud.google.com/vmware-engine/", + "ruby-cloud-api-id=vmwareengine.googleapis.com", + "ruby-cloud-api-shortname=vmwareengine", + ], + ruby_cloud_description = "Google Cloud VMware Engine is a fully managed service that lets you run the VMware platform in Google Cloud. VMware Engine provides you with VMware operational continuity so you can benefit from a cloud consumption model and lower your total cost of ownership. VMware Engine also offers on-demand provisioning, pay-as-you-grow, and capacity optimization.", + ruby_cloud_title = "Google Cloud VMware Engine", +) + +# Open Source package. +ruby_gapic_assembly_pkg( + name = "google-cloud-vmwareengine-ruby", + deps = [ + ":vmwareengine_ruby_wrapper", + ], +) diff --git a/google/cloud/vmwareengine/v1/BUILD.bazel b/google/cloud/vmwareengine/v1/BUILD.bazel new file mode 100644 index 000000000..4827fa0b1 --- /dev/null +++ b/google/cloud/vmwareengine/v1/BUILD.bazel @@ -0,0 +1,401 @@ +# 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 = "vmwareengine_proto", + srcs = [ + "vmwareengine.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//:field_mask_proto", + "@com_google_protobuf//:timestamp_proto", + ], +) + +proto_library_with_info( + name = "vmwareengine_proto_with_info", + deps = [ + ":vmwareengine_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 = "vmwareengine_java_proto", + deps = [":vmwareengine_proto"], +) + +java_grpc_library( + name = "vmwareengine_java_grpc", + srcs = [":vmwareengine_proto"], + deps = [":vmwareengine_java_proto"], +) + +java_gapic_library( + name = "vmwareengine_java_gapic", + srcs = [":vmwareengine_proto_with_info"], + gapic_yaml = None, + grpc_service_config = "vmwareengine_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + test_deps = [ + ":vmwareengine_java_grpc", + "//google/cloud/location:location_java_grpc", + "//google/iam/v1:iam_java_grpc", + ], + transport = "grpc+rest", + deps = [ + ":vmwareengine_java_proto", + "//google/api:api_java_proto", + "//google/cloud/location:location_java_proto", + "//google/iam/v1:iam_java_proto", + ], +) + +java_gapic_test( + name = "vmwareengine_java_gapic_test_suite", + test_classes = [ + "com.google.cloud.vmwareengine.v1.VmwareEngineClientHttpJsonTest", + "com.google.cloud.vmwareengine.v1.VmwareEngineClientTest", + ], + runtime_deps = [":vmwareengine_java_gapic_test"], +) + +# Open Source Packages +java_gapic_assembly_gradle_pkg( + name = "google-cloud-vmwareengine-v1-java", + include_samples = True, + transport = "grpc+rest", + deps = [ + ":vmwareengine_java_gapic", + ":vmwareengine_java_grpc", + ":vmwareengine_java_proto", + ":vmwareengine_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 = "vmwareengine_go_proto", + compilers = ["@io_bazel_rules_go//proto:go_grpc"], + importpath = "google.golang.org/genproto/googleapis/cloud/vmwareengine/v1", + protos = [":vmwareengine_proto"], + deps = [ + "//google/api:annotations_go_proto", + "//google/longrunning:longrunning_go_proto", + ], +) + +go_gapic_library( + name = "vmwareengine_go_gapic", + srcs = [":vmwareengine_proto_with_info"], + grpc_service_config = "vmwareengine_grpc_service_config.json", + importpath = "cloud.google.com/go/vmwareengine/apiv1;vmwareengine", + metadata = True, + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + transport = "grpc+rest", + deps = [ + ":vmwareengine_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", + ], +) + +go_test( + name = "vmwareengine_go_gapic_test", + srcs = [":vmwareengine_go_gapic_srcjar_test"], + embed = [":vmwareengine_go_gapic"], + importpath = "cloud.google.com/go/vmwareengine/apiv1", +) + +# Open Source Packages +go_gapic_assembly_pkg( + name = "gapi-cloud-vmwareengine-v1-go", + deps = [ + ":vmwareengine_go_gapic", + ":vmwareengine_go_gapic_srcjar-metadata.srcjar", + ":vmwareengine_go_gapic_srcjar-test.srcjar", + ":vmwareengine_go_proto", + ], +) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", +) + +py_gapic_library( + name = "vmwareengine_py_gapic", + srcs = [":vmwareengine_proto"], + grpc_service_config = "vmwareengine_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + transport = "grpc+rest", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], +) + +py_test( + name = "vmwareengine_py_gapic_test", + srcs = [ + "vmwareengine_py_gapic_pytest.py", + "vmwareengine_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [":vmwareengine_py_gapic"], +) + +# Open Source Packages +py_gapic_assembly_pkg( + name = "vmwareengine-v1-py", + deps = [ + ":vmwareengine_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 = "vmwareengine_php_proto", + deps = [":vmwareengine_proto"], +) + +php_grpc_library( + name = "vmwareengine_php_grpc", + srcs = [":vmwareengine_proto"], + deps = [":vmwareengine_php_proto"], +) + +php_gapic_library( + name = "vmwareengine_php_gapic", + srcs = [":vmwareengine_proto_with_info"], + grpc_service_config = "vmwareengine_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + deps = [ + ":vmwareengine_php_grpc", + ":vmwareengine_php_proto", + ], +) + +# Open Source Packages +php_gapic_assembly_pkg( + name = "google-cloud-vmwareengine-v1-php", + deps = [ + ":vmwareengine_php_gapic", + ":vmwareengine_php_grpc", + ":vmwareengine_php_proto", + ], +) + +############################################################################## +# Node.js +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", +) + +nodejs_gapic_library( + name = "vmwareengine_nodejs_gapic", + package_name = "@google-cloud/vmwareengine", + src = ":vmwareengine_proto_with_info", + extra_protoc_parameters = ["metadata"], + grpc_service_config = "vmwareengine_grpc_service_config.json", + package = "google.cloud.vmwareengine.v1", + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + deps = [], +) + +nodejs_gapic_assembly_pkg( + name = "vmwareengine-v1-nodejs", + deps = [ + ":vmwareengine_nodejs_gapic", + ":vmwareengine_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 = "vmwareengine_ruby_proto", + deps = [":vmwareengine_proto"], +) + +ruby_grpc_library( + name = "vmwareengine_ruby_grpc", + srcs = [":vmwareengine_proto"], + deps = [":vmwareengine_ruby_proto"], +) + +ruby_cloud_gapic_library( + name = "vmwareengine_ruby_gapic", + srcs = [":vmwareengine_proto_with_info"], + extra_protoc_parameters = [ + "ruby-cloud-api-id=vmwareengine.googleapis.com", + "ruby-cloud-api-shortname=vmwareengine", + "ruby-cloud-gem-name=google-cloud-vmware_engine-v1", + "ruby-cloud-product-url=https://cloud.google.com/vmware-engine/", + ], + grpc_service_config = "vmwareengine_grpc_service_config.json", + rest_numeric_enums = True, + ruby_cloud_description = "Google Cloud VMware Engine is a fully managed service that lets you run the VMware platform in Google Cloud. VMware Engine provides you with VMware operational continuity so you can benefit from a cloud consumption model and lower your total cost of ownership. VMware Engine also offers on-demand provisioning, pay-as-you-grow, and capacity optimization.", + ruby_cloud_title = "Google Cloud VMware Engine V1", + service_yaml = "vmwareengine_v1.yaml", + deps = [ + ":vmwareengine_ruby_grpc", + ":vmwareengine_ruby_proto", + ], +) + +# Open Source Packages +ruby_gapic_assembly_pkg( + name = "google-cloud-vmwareengine-v1-ruby", + deps = [ + ":vmwareengine_ruby_gapic", + ":vmwareengine_ruby_grpc", + ":vmwareengine_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 = "vmwareengine_csharp_proto", + deps = [":vmwareengine_proto"], +) + +csharp_grpc_library( + name = "vmwareengine_csharp_grpc", + srcs = [":vmwareengine_proto"], + deps = [":vmwareengine_csharp_proto"], +) + +csharp_gapic_library( + name = "vmwareengine_csharp_gapic", + srcs = [":vmwareengine_proto_with_info"], + common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + grpc_service_config = "vmwareengine_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "vmwareengine_v1.yaml", + deps = [ + ":vmwareengine_csharp_grpc", + ":vmwareengine_csharp_proto", + ], +) + +# Open Source Packages +csharp_gapic_assembly_pkg( + name = "google-cloud-vmwareengine-v1-csharp", + deps = [ + ":vmwareengine_csharp_gapic", + ":vmwareengine_csharp_grpc", + ":vmwareengine_csharp_proto", + ], +) + +############################################################################## +# C++ +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "vmwareengine_cc_proto", + deps = [":vmwareengine_proto"], +) + +cc_grpc_library( + name = "vmwareengine_cc_grpc", + srcs = [":vmwareengine_proto"], + grpc_only = True, + deps = [":vmwareengine_cc_proto"], +) diff --git a/google/cloud/vmwareengine/v1/vmwareengine.proto b/google/cloud/vmwareengine/v1/vmwareengine.proto new file mode 100644 index 000000000..695006cf2 --- /dev/null +++ b/google/cloud/vmwareengine/v1/vmwareengine.proto @@ -0,0 +1,2194 @@ +// 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.vmwareengine.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/field_mask.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.VmwareEngine.V1"; +option go_package = "google.golang.org/genproto/googleapis/cloud/vmwareengine/v1;vmwareengine"; +option java_multiple_files = true; +option java_outer_classname = "VmwareengineProto"; +option java_package = "com.google.cloud.vmwareengine.v1"; +option php_namespace = "Google\\Cloud\\VmwareEngine\\V1"; +option ruby_package = "Google::Cloud::VmwareEngine::V1"; +option (google.api.resource_definition) = { + type: "compute.googleapis.com/Network" + pattern: "projects/{project}/global/networks/{network}" +}; + +// VMwareEngine manages VMware's private clusters in the Cloud. +service VmwareEngine { + option (google.api.default_host) = "vmwareengine.googleapis.com"; + option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + + // Lists `PrivateCloud` resources in a given project and location. + rpc ListPrivateClouds(ListPrivateCloudsRequest) returns (ListPrivateCloudsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/privateClouds" + }; + option (google.api.method_signature) = "parent"; + } + + // Retrieves a `PrivateCloud` resource by its resource name. + rpc GetPrivateCloud(GetPrivateCloudRequest) returns (PrivateCloud) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/privateClouds/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new `PrivateCloud` resource in a given project and location. + // Private clouds can only be created in zones, regional private clouds are + // not supported. + // + // Creating a private cloud also creates a [management + // cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) + // for that private cloud. + rpc CreatePrivateCloud(CreatePrivateCloudRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/privateClouds" + body: "private_cloud" + }; + option (google.api.method_signature) = "parent,private_cloud,private_cloud_id"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Modifies a `PrivateCloud` resource. Only the following fields can be + // updated: `description`. + // Only fields specified in `updateMask` are applied. + // + // During operation processing, the resource is temporarily in the `ACTIVE` + // state before the operation fully completes. For that period of time, you + // can't update the resource. Use the operation status to determine when the + // processing fully completes. + rpc UpdatePrivateCloud(UpdatePrivateCloudRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{private_cloud.name=projects/*/locations/*/privateClouds/*}" + body: "private_cloud" + }; + option (google.api.method_signature) = "private_cloud,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Schedules a `PrivateCloud` resource for deletion. + // + // A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` + // set to `DELETED` and `expireTime` set to the time when deletion is final + // and can no longer be reversed. The delete operation is marked as done + // as soon as the `PrivateCloud` is successfully scheduled for deletion + // (this also applies when `delayHours` is set to zero), and the operation is + // not kept in pending state until `PrivateCloud` is purged. + // `PrivateCloud` can be restored using `UndeletePrivateCloud` method before + // the `expireTime` elapses. When `expireTime` is reached, deletion is final + // and all private cloud resources are irreversibly removed and billing stops. + // During the final removal process, `PrivateCloud.state` is set to `PURGING`. + // `PrivateCloud` can be polled using standard `GET` method for the whole + // period of deletion and purging. It will not be returned only + // when it is completely purged. + rpc DeletePrivateCloud(DeletePrivateCloudRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/privateClouds/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Restores a private cloud that was previously scheduled for deletion by + // `DeletePrivateCloud`. A `PrivateCloud` resource scheduled for deletion has + // `PrivateCloud.state` set to `DELETED` and `PrivateCloud.expireTime` set to + // the time when deletion can no longer be reversed. + rpc UndeletePrivateCloud(UndeletePrivateCloudRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/privateClouds/*}:undelete" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Lists `Cluster` resources in a given private cloud. + rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters" + }; + option (google.api.method_signature) = "parent"; + } + + // Retrieves a `Cluster` resource by its resource name. + rpc GetCluster(GetClusterRequest) returns (Cluster) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Creates a new cluster in a given private cloud. + // Creating a new cluster provides additional nodes for + // use in the parent private cloud and requires sufficient [node + // quota](https://cloud.google.com/vmware-engine/quotas). + rpc CreateCluster(CreateClusterRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters" + body: "cluster" + }; + option (google.api.method_signature) = "parent,cluster,cluster_id"; + option (google.longrunning.operation_info) = { + response_type: "Cluster" + metadata_type: "OperationMetadata" + }; + } + + // Modifies a `Cluster` resource. Only the following fields can be updated: + // `node_type_configs.*.node_count`. Only fields specified in `updateMask` are + // applied. + // + // During operation processing, the resource is temporarily in the `ACTIVE` + // state before the operation fully completes. For that period of time, you + // can't update the resource. Use the operation status to determine when the + // processing fully completes. + rpc UpdateCluster(UpdateClusterRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{cluster.name=projects/*/locations/*/privateClouds/*/clusters/*}" + body: "cluster" + }; + option (google.api.method_signature) = "cluster,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "Cluster" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a `Cluster` resource. To avoid unintended data loss, migrate or + // gracefully shut down any workloads running on the cluster before deletion. + // You cannot delete the management cluster of a private cloud using this + // method. + rpc DeleteCluster(DeleteClusterRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Lists subnets in a given private cloud. + rpc ListSubnets(ListSubnetsRequest) returns (ListSubnetsResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/privateClouds/*}/subnets" + }; + option (google.api.method_signature) = "parent"; + } + + // Lists node types + rpc ListNodeTypes(ListNodeTypesRequest) returns (ListNodeTypesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/nodeTypes" + }; + option (google.api.method_signature) = "parent"; + } + + // Gets details of a single `NodeType`. + rpc GetNodeType(GetNodeTypeRequest) returns (NodeType) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/nodeTypes/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Gets details of credentials for NSX appliance. + rpc ShowNsxCredentials(ShowNsxCredentialsRequest) returns (Credentials) { + option (google.api.http) = { + get: "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:showNsxCredentials" + }; + option (google.api.method_signature) = "private_cloud"; + } + + // Gets details of credentials for Vcenter appliance. + rpc ShowVcenterCredentials(ShowVcenterCredentialsRequest) returns (Credentials) { + option (google.api.http) = { + get: "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:showVcenterCredentials" + }; + option (google.api.method_signature) = "private_cloud"; + } + + // Resets credentials of the NSX appliance. + rpc ResetNsxCredentials(ResetNsxCredentialsRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:resetNsxCredentials" + body: "*" + }; + option (google.api.method_signature) = "private_cloud"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Resets credentials of the Vcenter appliance. + rpc ResetVcenterCredentials(ResetVcenterCredentialsRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{private_cloud=projects/*/locations/*/privateClouds/*}:resetVcenterCredentials" + body: "*" + }; + option (google.api.method_signature) = "private_cloud"; + option (google.longrunning.operation_info) = { + response_type: "PrivateCloud" + metadata_type: "OperationMetadata" + }; + } + + // Creates a new HCX activation key in a given private cloud. + rpc CreateHcxActivationKey(CreateHcxActivationKeyRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys" + body: "hcx_activation_key" + }; + option (google.api.method_signature) = "parent,hcx_activation_key,hcx_activation_key_id"; + option (google.longrunning.operation_info) = { + response_type: "HcxActivationKey" + metadata_type: "OperationMetadata" + }; + } + + // Lists `HcxActivationKey` resources in a given private cloud. + rpc ListHcxActivationKeys(ListHcxActivationKeysRequest) returns (ListHcxActivationKeysResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys" + }; + option (google.api.method_signature) = "parent"; + } + + // Retrieves a `HcxActivationKey` resource by its resource name. + rpc GetHcxActivationKey(GetHcxActivationKeyRequest) returns (HcxActivationKey) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Retrieves a `NetworkPolicy` resource by its resource name. + rpc GetNetworkPolicy(GetNetworkPolicyRequest) returns (NetworkPolicy) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/networkPolicies/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists `NetworkPolicy` resources in a specified project and location. + rpc ListNetworkPolicies(ListNetworkPoliciesRequest) returns (ListNetworkPoliciesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/networkPolicies" + }; + option (google.api.method_signature) = "parent"; + } + + // Creates a new network policy in a given VMware Engine network of a + // project and location (region). A new network policy cannot be created if + // another network policy already exists in the same scope. + rpc CreateNetworkPolicy(CreateNetworkPolicyRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/networkPolicies" + body: "network_policy" + }; + option (google.api.method_signature) = "parent,network_policy,network_policy_id"; + option (google.longrunning.operation_info) = { + response_type: "NetworkPolicy" + metadata_type: "OperationMetadata" + }; + } + + // Modifies a `NetworkPolicy` resource. Only the following fields can be + // updated: `internet_access`, `external_ip`, `edge_services_cidr`. + // Only fields specified in `updateMask` are applied. When updating a network + // policy, the external IP network service can only be disabled if there are + // no external IP addresses present in the scope of the policy. Also, a + // `NetworkService` cannot be updated when `NetworkService.state` is set + // to `RECONCILING`. + // + // During operation processing, the resource is temporarily in the `ACTIVE` + // state before the operation fully completes. For that period of time, you + // can't update the resource. Use the operation status to determine when the + // processing fully completes. + rpc UpdateNetworkPolicy(UpdateNetworkPolicyRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{network_policy.name=projects/*/locations/*/networkPolicies/*}" + body: "network_policy" + }; + option (google.api.method_signature) = "network_policy,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "NetworkPolicy" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a `NetworkPolicy` resource. A network policy cannot be deleted + // when `NetworkService.state` is set to `RECONCILING` for either its external + // IP or internet access service. + rpc DeleteNetworkPolicy(DeleteNetworkPolicyRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/networkPolicies/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Creates a new VMware Engine network that can be used by a private cloud. + rpc CreateVmwareEngineNetwork(CreateVmwareEngineNetworkRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/vmwareEngineNetworks" + body: "vmware_engine_network" + }; + option (google.api.method_signature) = "parent,vmware_engine_network,vmware_engine_network_id"; + option (google.longrunning.operation_info) = { + response_type: "VmwareEngineNetwork" + metadata_type: "OperationMetadata" + }; + } + + // Modifies a VMware Engine network resource. Only the following fields can be + // updated: `description`. Only fields specified in `updateMask` are + // applied. + rpc UpdateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + patch: "/v1/{vmware_engine_network.name=projects/*/locations/*/vmwareEngineNetworks/*}" + body: "vmware_engine_network" + }; + option (google.api.method_signature) = "vmware_engine_network,update_mask"; + option (google.longrunning.operation_info) = { + response_type: "VmwareEngineNetwork" + metadata_type: "OperationMetadata" + }; + } + + // Deletes a `VmwareEngineNetwork` resource. You can only delete a VMware + // Engine network after all resources that refer to it are deleted. For + // example, a private cloud, a network peering, and a network policy can all + // refer to the same VMware Engine network. + rpc DeleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest) returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "OperationMetadata" + }; + } + + // Retrieves a `VmwareEngineNetwork` resource by its resource name. The + // resource contains details of the VMware Engine network, such as its VMware + // Engine network type, peered networks in a service project, and state + // (for example, `CREATING`, `ACTIVE`, `DELETING`). + rpc GetVmwareEngineNetwork(GetVmwareEngineNetworkRequest) returns (VmwareEngineNetwork) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists `VmwareEngineNetwork` resources in a given project and location. + rpc ListVmwareEngineNetworks(ListVmwareEngineNetworksRequest) returns (ListVmwareEngineNetworksResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/vmwareEngineNetworks" + }; + option (google.api.method_signature) = "parent"; + } +} + +// Network configuration in the consumer project +// with which the peering has to be done. +message NetworkConfig { + // Required. Management CIDR used by VMware management appliances. + string management_cidr = 4 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The relative resource name of the VMware Engine network attached + // to the private cloud. Specify the name in the following form: + // `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` + // where `{project}` can either be a project number or a project ID. + string vmware_engine_network = 5 [ + (google.api.field_behavior) = OPTIONAL, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; + + // Output only. The canonical name of the VMware Engine network in the form: + // `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` + string vmware_engine_network_canonical = 6 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; + + // Output only. The IP address layout version of the management IP address + // range. Possible versions include: + // * `managementIpAddressLayoutVersion=1`: Indicates the legacy IP address + // layout used by some existing private clouds. This is no longer supported + // for new private clouds as it does not support all features. + // * `managementIpAddressLayoutVersion=2`: Indicates the latest IP address + // layout used by all newly created private clouds. This version supports all + // current features. + int32 management_ip_address_layout_version = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Information about the type and number of nodes associated with the cluster. +message NodeTypeConfig { + // Required. The number of nodes of this type in the cluster + int32 node_count = 1 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Customized number of cores available to each node of the type. + // This number must always be one of `nodeType.availableCustomCoreCounts`. + // If zero is provided max value from `nodeType.availableCustomCoreCounts` + // will be used. + int32 custom_core_count = 2 [(google.api.field_behavior) = OPTIONAL]; +} + +// Represents a private cloud resource. Private clouds are zonal resources. +message PrivateCloud { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + pattern: "projects/{project}/locations/{location}/privateClouds/{private_cloud}" + }; + + // Enum State defines possible states of private clouds. + enum State { + // The default value. This value should never be used. + STATE_UNSPECIFIED = 0; + + // The private cloud is ready. + ACTIVE = 1; + + // The private cloud is being created. + CREATING = 2; + + // The private cloud is being updated. + UPDATING = 3; + + // The private cloud is in failed state. + FAILED = 5; + + // The private cloud is scheduled for deletion. The deletion process can be + // cancelled by using the corresponding undelete method. + DELETED = 6; + + // The private cloud is irreversibly deleted and is being removed from the + // system. + PURGING = 7; + } + + // Management cluster configuration. + message ManagementCluster { + // Required. The user-provided identifier of the new `Cluster`. + // The identifier must meet the following requirements: + // + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC + // 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + string cluster_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The map of cluster node types in this cluster, where the key is canonical + // identifier of the node type (corresponds to the `NodeType`). + map node_type_configs = 7 [(google.api.field_behavior) = REQUIRED]; + } + + // Output only. The resource name of this private cloud. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Creation time of this resource. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Last update time of this resource. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the resource was scheduled for deletion. + google.protobuf.Timestamp delete_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the resource will be irreversibly deleted. + google.protobuf.Timestamp expire_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the resource. New values may be added to this enum + // when appropriate. + State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. Network configuration of the private cloud. + NetworkConfig network_config = 9 [(google.api.field_behavior) = REQUIRED]; + + // Input only. The management cluster for this private cloud. + // This field is required during creation of the private cloud to provide + // details for the default cluster. + // + // The following fields can't be changed after private cloud creation: + // `ManagementCluster.clusterId`, `ManagementCluster.nodeTypeId`. + ManagementCluster management_cluster = 10 [(google.api.field_behavior) = INPUT_ONLY]; + + // User-provided description for this private cloud. + string description = 11; + + // Output only. HCX appliance. + Hcx hcx = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. NSX appliance. + Nsx nsx = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Vcenter appliance. + Vcenter vcenter = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. System-generated unique identifier for the resource. + string uid = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request message for [VmwareEngine.ListPrivateClouds][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateClouds] +message ListPrivateCloudsRequest { + // Required. The resource name of the private cloud to be queried for + // clusters. Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The maximum number of private clouds to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListPrivateClouds` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListPrivateClouds` must + // match the call that provided the page token. + string page_token = 3; + + // A filter expression that matches resources returned in the response. + // The expression must specify the field name, a comparison operator, and the + // value that you want to use for filtering. The value must be a string, a + // number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or + // `<`. + // + // For example, if you are filtering a list of private clouds, you can exclude + // the ones named `example-pc` by specifying `name != "example-pc"`. + // + // You can also filter nested fields. For example, you could specify + // `networkConfig.managementCidr = "192.168.0.0/24"` to include private clouds + // only if they have a matching address in their network configuration. + // + // To filter on multiple expressions, provide each separate expression within + // parentheses. For example: + // ``` + // (name = "example-pc") + // (createTime > "2021-04-12T08:15:10.40Z") + // ``` + // + // By default, each expression is an `AND` expression. However, you can + // include `AND` and `OR` expressions explicitly. For example: + // ``` + // (name = "private-cloud-1") AND + // (createTime > "2021-04-12T08:15:10.40Z") OR + // (name = "private-cloud-2") + // ``` + string filter = 4; + + // Sorts list results by a certain order. By default, returned results are + // ordered by `name` in ascending order. You can also sort results in + // descending order based on the `name` value using `orderBy="name desc"`. + // Currently, only ordering by `name` is supported. + string order_by = 5; +} + +// Response message for [VmwareEngine.ListPrivateClouds][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateClouds] +message ListPrivateCloudsResponse { + // A list of private clouds. + repeated PrivateCloud private_clouds = 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; + + // Locations that could not be reached when making an aggregated query using + // wildcards. + repeated string unreachable = 3; +} + +// Request message for [VmwareEngine.GetPrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.GetPrivateCloud] +message GetPrivateCloudRequest { + // Required. The resource name of the private cloud to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; +} + +// Request message for [VmwareEngine.CreatePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.CreatePrivateCloud] +message CreatePrivateCloudRequest { + // Required. The resource name of the location to create the new + // private cloud in. Resource names are schemeless URIs that follow the + // conventions in https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Required. The user-provided identifier of the private cloud to be created. + // This identifier must be unique among each `PrivateCloud` within the parent + // and becomes the final token in the name URI. + // The identifier must meet the following requirements: + // + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) + // (section 3.5) + string private_cloud_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The initial description of the new private cloud. + PrivateCloud private_cloud = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. 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. True if you want the request to be validated and not executed; false + // otherwise. + bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for [VmwareEngine.UpdatePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UpdatePrivateCloud] +message UpdatePrivateCloudRequest { + // Required. Private cloud description. + PrivateCloud private_cloud = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Field mask is used to specify the fields to be overwritten in the + // `PrivateCloud` resource by the update. The fields specified in `updateMask` + // 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 = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. 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]; +} + +// Request message for [VmwareEngine.DeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.DeletePrivateCloud] +message DeletePrivateCloudRequest { + // Required. The resource name of the private cloud to delete. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Optional. 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 to true, cascade delete is enabled and all children of this private + // cloud resource are also deleted. When this flag is set to false, the + // private cloud will not be deleted if there are any children other than the + // management cluster. The management cluster is always deleted. + bool force = 3 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Time delay of the deletion specified in hours. The default value + // is `3`. Specifying a non-zero value for this field changes the value of + // `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned + // deletion time. Deletion can be cancelled before `expire_time` elapses using + // [VmwareEngine.UndeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud]. Specifying a value of `0` for + // this field instead begins the deletion process and ceases billing + // immediately. During the final deletion process, the value of + // `PrivateCloud.state` becomes `PURGING`. + optional int32 delay_hours = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for [VmwareEngine.UndeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud] +message UndeletePrivateCloudRequest { + // Required. The resource name of the private cloud scheduled for deletion. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Optional. 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]; +} + +// A cluster in a private cloud. +message Cluster { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/Cluster" + pattern: "projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}" + }; + + // Enum State defines possible states of private cloud clusters. + enum State { + // The default value. This value should never be used. + STATE_UNSPECIFIED = 0; + + // The Cluster is operational and can be used by the user. + ACTIVE = 1; + + // The Cluster is being deployed. + CREATING = 2; + + // Adding or removing of a node to the cluster, any other cluster specific + // updates. + UPDATING = 3; + + // The Cluster is being deleted. + DELETING = 4; + + // The Cluster is undergoing maintenance, for example: a failed node is + // getting replaced. + REPAIRING = 5; + } + + // Output only. The resource name of this cluster. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/clusters/my-cluster` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Creation time of this resource. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Last update time of this resource. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the resource. + State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. True if the cluster is a management cluster; false otherwise. + // There can only be one management cluster in a private cloud + // and it has to be the first one. + bool management = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. System-generated unique identifier for the resource. + string uid = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. The map of cluster node types in this cluster, where the key is canonical + // identifier of the node type (corresponds to the `NodeType`). + map node_type_configs = 16 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for [VmwareEngine.ListClusters][google.cloud.vmwareengine.v1.VmwareEngine.ListClusters] +message ListClustersRequest { + // Required. The resource name of the private cloud to query for clusters. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // The maximum number of clusters to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListClusters` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to `ListClusters` + // must match the call that provided the page token. + string page_token = 3; + + // + // To filter on multiple expressions, provide each separate expression within + // parentheses. For example: + // ``` + // (name = "example-cluster") + // (nodeCount = "3") + // ``` + // + // By default, each expression is an `AND` expression. However, you can + // include `AND` and `OR` expressions explicitly. For example: + // ``` + // (name = "example-cluster-1") AND + // (createTime > "2021-04-12T08:15:10.40Z") OR + // (name = "example-cluster-2") + // ``` + string filter = 4; + + // Sorts list results by a certain order. By default, returned results are + // ordered by `name` in ascending order. You can also sort results in + // descending order based on the `name` value using `orderBy="name desc"`. + // Currently, only ordering by `name` is supported. + string order_by = 5; +} + +// Response message for [VmwareEngine.ListClusters][google.cloud.vmwareengine.v1.VmwareEngine.ListClusters] +message ListClustersResponse { + // A list of private cloud clusters. + repeated Cluster clusters = 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; + + // Locations that could not be reached when making an aggregated query using + // wildcards. + repeated string unreachable = 3; +} + +// Request message for [VmwareEngine.GetCluster][google.cloud.vmwareengine.v1.VmwareEngine.GetCluster] +message GetClusterRequest { + // Required. The cluster resource name to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/clusters/my-cluster` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/Cluster" + } + ]; +} + +// Request message for [VmwareEngine.CreateCluster][google.cloud.vmwareengine.v1.VmwareEngine.CreateCluster] +message CreateClusterRequest { + // Required. The resource name of the private cloud to create a new cluster + // in. Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Required. The user-provided identifier of the new `Cluster`. + // This identifier must be unique among clusters within the parent and becomes + // the final token in the name URI. + // The identifier must meet the following requirements: + // + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) + // (section 3.5) + string cluster_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The initial description of the new cluster. + Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. 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. True if you want the request to be validated and not executed; false + // otherwise. + bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for [VmwareEngine.UpdateCluster][google.cloud.vmwareengine.v1.VmwareEngine.UpdateCluster] +message UpdateClusterRequest { + // Required. Field mask is used to specify the fields to be overwritten in the + // `Cluster` resource by the update. The fields specified in the `updateMask` + // 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) = REQUIRED]; + + // Required. The description of the cluster. + Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. 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. True if you want the request to be validated and not executed; false + // otherwise. + bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for [VmwareEngine.DeleteCluster][google.cloud.vmwareengine.v1.VmwareEngine.DeleteCluster] +message DeleteClusterRequest { + // Required. The resource name of the cluster to delete. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/clusters/my-cluster` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/Cluster" + } + ]; + + // Optional. 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]; +} + +// Subnet in a private cloud. Either `management` subnets (such as vMotion) that +// are read-only, or `userDefined`, which can also be updated. +message Subnet { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/Subnet" + pattern: "projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}" + }; + + // Defines possible states of subnets. + enum State { + // The default value. This value should never be used. + STATE_UNSPECIFIED = 0; + + // The subnet is ready. + ACTIVE = 1; + + // The subnet is being created. + CREATING = 2; + + // The subnet is being updated. + UPDATING = 3; + + // The subnet is being deleted. + DELETING = 4; + } + + // Output only. The resource name of this subnet. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/subnets/my-subnet` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // The IP address range of the subnet in CIDR format '10.0.0.0/24'. + string ip_cidr_range = 7; + + // The IP address of the gateway of this subnet. + // Must fall within the IP prefix defined above. + string gateway_ip = 8; + + // Output only. The type of the subnet. For example "management" or "userDefined". + string type = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The state of the resource. + State state = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request message for [VmwareEngine.ListSubnets][google.cloud.vmwareengine.v1.VmwareEngine.ListSubnets] +message ListSubnetsRequest { + // Required. The resource name of the private cloud to be queried for + // subnets. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // The maximum number of subnets to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListSubnetsRequest` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListSubnetsRequest` must match the call that provided the page token. + string page_token = 3; +} + +// Response message for [VmwareEngine.ListSubnets][google.cloud.vmwareengine.v1.VmwareEngine.ListSubnets] +message ListSubnetsResponse { + // A list of subnets. + repeated Subnet subnets = 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; +} + +// 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]; + + // 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. True if the user has requested cancellation + // of the operation; false otherwise. + // 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]; +} + +// Describes node type. +message NodeType { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/NodeType" + pattern: "projects/{project}/locations/{location}/nodeTypes/{node_type}" + }; + + // Output only. The resource name of this node type. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-proj/locations/us-west1-a/nodeTypes/standard-72` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The canonical identifier of the node type + // (corresponds to the `NodeType`). For example: standard-72. + string node_type_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The friendly name for this node type. + // For example: ve1-standard-72 + string display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The total number of virtual CPUs in a single node. + int32 virtual_cpu_count = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The total number of CPU cores in a single node. + int32 total_core_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The amount of physical memory available, defined in GB. + int32 memory_gb = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The amount of storage available, defined in GB. + int32 disk_size_gb = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. List of possible values of custom core count. + repeated int32 available_custom_core_counts = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request message for [VmwareEngine.ListNodeTypes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodeTypes] +message ListNodeTypesRequest { + // Required. The resource name of the location to be queried for node types. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The maximum number of node types to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListNodeTypes` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListNodeTypes` must match the call that provided the page token. + string page_token = 3; + + // A filter expression that matches resources returned in the response. + // The expression must specify the field name, a comparison + // operator, and the value that you want to use for filtering. The value + // must be a string, a number, or a boolean. The comparison operator + // must be `=`, `!=`, `>`, or `<`. + // + // For example, if you are filtering a list of node types, you can + // exclude the ones named `standard-72` by specifying + // `name != "standard-72"`. + // + // To filter on multiple expressions, provide each separate expression within + // parentheses. For example: + // ``` + // (name = "standard-72") + // (virtual_cpu_count > 2) + // ``` + // + // By default, each expression is an `AND` expression. However, you + // can include `AND` and `OR` expressions explicitly. + // For example: + // ``` + // (name = "standard-96") AND + // (virtual_cpu_count > 2) OR + // (name = "standard-72") + // ``` + string filter = 4; +} + +// Response message for [VmwareEngine.ListNodeTypes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodeTypes] +message ListNodeTypesResponse { + // A list of Node Types. + repeated NodeType node_types = 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; + + // Locations that could not be reached when making an aggregated query using + // wildcards. + repeated string unreachable = 3; +} + +// Request message for [VmwareEngine.GetNodeType][google.cloud.vmwareengine.v1.VmwareEngine.GetNodeType] +message GetNodeTypeRequest { + // Required. The resource name of the node type to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-proj/locations/us-west1-a/nodeTypes/standard-72` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/NodeType" + } + ]; +} + +// Credentials for a private cloud. +message Credentials { + // Initial username. + string username = 1; + + // Initial password. + string password = 2; +} + +// Request message for [VmwareEngine.ShowNsxCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ShowNsxCredentials] +message ShowNsxCredentialsRequest { + // Required. The resource name of the private cloud + // to be queried for credentials. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string private_cloud = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; +} + +// Request message for [VmwareEngine.ShowVcenterCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ShowVcenterCredentials] +message ShowVcenterCredentialsRequest { + // Required. The resource name of the private cloud + // to be queried for credentials. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string private_cloud = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; +} + +// Request message for [VmwareEngine.ResetNsxCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ResetNsxCredentials] +message ResetNsxCredentialsRequest { + // Required. The resource name of the private cloud + // to reset credentials for. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string private_cloud = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request message for [VmwareEngine.ResetVcenterCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ResetVcenterCredentials] +message ResetVcenterCredentialsRequest { + // Required. The resource name of the private cloud + // to reset credentials for. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + string private_cloud = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Response message for [VmwareEngine.ListHcxActivationKeys][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys] +message ListHcxActivationKeysResponse { + // List of HCX activation keys. + repeated HcxActivationKey hcx_activation_keys = 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; + + // Locations that could not be reached when making an aggregated query using + // wildcards. + repeated string unreachable = 3; +} + +// HCX activation key. A default key is created during +// private cloud provisioning, but this behavior is subject to change +// and you should always verify active keys. +// Use [VmwareEngine.ListHcxActivationKeys][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys] to retrieve existing keys +// and [VmwareEngine.CreateHcxActivationKey][google.cloud.vmwareengine.v1.VmwareEngine.CreateHcxActivationKey] to create new ones. +message HcxActivationKey { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/HcxActivationKey" + pattern: "projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}" + }; + + // State of HCX activation key + enum State { + // Unspecified state. + STATE_UNSPECIFIED = 0; + + // State of a newly generated activation key. + AVAILABLE = 1; + + // State of key when it has been used to activate HCX appliance. + CONSUMED = 2; + + // State of key when it is being created. + CREATING = 3; + } + + // Output only. The resource name of this HcxActivationKey. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1/privateClouds/my-cloud/hcxActivationKeys/my-key` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Creation time of HCX activation key. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of HCX activation key. + State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. HCX activation key. + string activation_key = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. System-generated unique identifier for the resource. + string uid = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// Request message for [VmwareEngine.ListHcxActivationKeys][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys] +message ListHcxActivationKeysRequest { + // Required. The resource name of the private cloud + // to be queried for HCX activation keys. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1/privateClouds/my-cloud` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // The maximum number of HCX activation keys to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListHcxActivationKeys` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListHcxActivationKeys` must match the call that provided the page + // token. + string page_token = 3; +} + +// Request message for [VmwareEngine.GetHcxActivationKeys][] +message GetHcxActivationKeyRequest { + // Required. The resource name of the HCX activation key to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-west1/privateClouds/my-cloud/hcxActivationKeys/my-key` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/HcxActivationKey" + } + ]; +} + +// Request message for [VmwareEngine.CreateHcxActivationKey][google.cloud.vmwareengine.v1.VmwareEngine.CreateHcxActivationKey] +message CreateHcxActivationKeyRequest { + // Required. The resource name of the private cloud to create the key for. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1/privateClouds/my-cloud` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/PrivateCloud" + } + ]; + + // Required. The initial description of a new HCX activation key. When + // creating a new key, this field must be an empty object. + HcxActivationKey hcx_activation_key = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The user-provided identifier of the `HcxActivationKey` to be + // created. This identifier must be unique among `HcxActivationKey` resources + // within the parent and becomes the final token in the name URI. + // The identifier must meet the following requirements: + // + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) + // (section 3.5) + string hcx_activation_key_id = 3 [(google.api.field_behavior) = REQUIRED]; + + // A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request ID, + // the server can check if original operation with the same request ID was + // received, and if so, will ignore the second request. This prevents clients + // from accidentally creating 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; +} + +// Details about a HCX Cloud Manager appliance. +message Hcx { + // State of the appliance + enum State { + // Unspecified appliance state. This is the default value. + STATE_UNSPECIFIED = 0; + + // The appliance is operational and can be used. + ACTIVE = 1; + + // The appliance is being deployed. + CREATING = 2; + } + + // Internal IP address of the appliance. + string internal_ip = 2; + + // Version of the appliance. + string version = 4; + + // Output only. The state of the appliance. + State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Fully qualified domain name of the appliance. + string fqdn = 6; +} + +// Details about a NSX Manager appliance. +message Nsx { + // State of the appliance + enum State { + // Unspecified appliance state. This is the default value. + STATE_UNSPECIFIED = 0; + + // The appliance is operational and can be used. + ACTIVE = 1; + + // The appliance is being deployed. + CREATING = 2; + } + + // Internal IP address of the appliance. + string internal_ip = 2; + + // Version of the appliance. + string version = 4; + + // Output only. The state of the appliance. + State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Fully qualified domain name of the appliance. + string fqdn = 6; +} + +// Details about a vCenter Server management appliance. +message Vcenter { + // State of the appliance + enum State { + // Unspecified appliance state. This is the default value. + STATE_UNSPECIFIED = 0; + + // The appliance is operational and can be used. + ACTIVE = 1; + + // The appliance is being deployed. + CREATING = 2; + } + + // Internal IP address of the appliance. + string internal_ip = 2; + + // Version of the appliance. + string version = 4; + + // Output only. The state of the appliance. + State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Fully qualified domain name of the appliance. + string fqdn = 6; +} + +// Represents a network policy resource. Network policies are regional +// resources. You can use a network policy to enable or disable internet access +// and external IP access. Network policies are associated with a VMware Engine +// network, which might span across regions. For a given region, a network +// policy applies to all private clouds in the VMware Engine network associated +// with the policy. +message NetworkPolicy { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/NetworkPolicy" + pattern: "projects/{project}/locations/{location}/networkPolicies/{network_policy}" + }; + + // Represents a network service that is managed by a `NetworkPolicy` resource. + // A network service provides a way to control an aspect of external access to + // VMware workloads. For example, whether the VMware workloads in the + // private clouds governed by a network policy can access or be accessed from + // the internet. + message NetworkService { + // Enum State defines possible states of a network policy controlled + // service. + enum State { + // Unspecified service state. This is the default value. + STATE_UNSPECIFIED = 0; + + // Service is not provisioned. + UNPROVISIONED = 1; + + // Service is in the process of being provisioned/deprovisioned. + RECONCILING = 2; + + // Service is active. + ACTIVE = 3; + } + + // True if the service is enabled; false otherwise. + bool enabled = 1; + + // Output only. State of the service. New values may be added to this enum + // when appropriate. + State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + } + + // Output only. The resource name of this network policy. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Creation time of this resource. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Last update time of this resource. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Network service that allows VMware workloads to access the internet. + NetworkService internet_access = 6; + + // Network service that allows External IP addresses to be assigned to VMware + // workloads. This service can only be enabled when `internet_access` is also + // enabled. + NetworkService external_ip = 7; + + // Required. IP address range in CIDR notation used to create internet access + // and external IP access. An RFC 1918 CIDR block, with a "/26" prefix, is + // required. The range cannot overlap with any prefixes either in the consumer + // VPC network or in use by the private clouds attached to that VPC network. + string edge_services_cidr = 9 [(google.api.field_behavior) = REQUIRED]; + + // Output only. System-generated unique identifier for the resource. + string uid = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Optional. The relative resource name of the VMware Engine network. + // Specify the name in the following form: + // `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` + // where `{project}` can either be a project number or a project ID. + string vmware_engine_network = 12 [ + (google.api.field_behavior) = OPTIONAL, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; + + // Optional. User-provided description for this network policy. + string description = 13 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. The canonical name of the VMware Engine network in the form: + // `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` + string vmware_engine_network_canonical = 14 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; +} + +// Request message for [VmwareEngine.ListNetworkPolicies][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPolicies] +message ListNetworkPoliciesRequest { + // Required. The resource name of the location (region) to query for + // network policies. Resource names are schemeless URIs that follow the + // conventions in https://cloud.google.com/apis/design/resource_names. For + // example: `projects/my-project/locations/us-central1` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "vmwareengine.googleapis.com/NetworkPolicy" + } + ]; + + // The maximum number of network policies to return in one page. + // The service may return fewer than this value. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListNetworkPolicies` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListNetworkPolicies` must match the call that provided the page + // token. + string page_token = 3; + + // A filter expression that matches resources returned in the response. + // The expression must specify the field name, a comparison + // operator, and the value that you want to use for filtering. The value + // must be a string, a number, or a boolean. The comparison operator + // must be `=`, `!=`, `>`, or `<`. + // + // For example, if you are filtering a list of network policies, you can + // exclude the ones named `example-policy` by specifying + // `name != "example-policy"`. + // + // To filter on multiple expressions, provide each separate expression within + // parentheses. For example: + // ``` + // (name = "example-policy") + // (createTime > "2021-04-12T08:15:10.40Z") + // ``` + // + // By default, each expression is an `AND` expression. However, you + // can include `AND` and `OR` expressions explicitly. + // For example: + // ``` + // (name = "example-policy-1") AND + // (createTime > "2021-04-12T08:15:10.40Z") OR + // (name = "example-policy-2") + // ``` + string filter = 4; + + // Sorts list results by a certain order. By default, returned results + // are ordered by `name` in ascending order. + // You can also sort results in descending order based on the `name` value + // using `orderBy="name desc"`. + // Currently, only ordering by `name` is supported. + string order_by = 5; +} + +// Response message for [VmwareEngine.ListNetworkPolicies][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPolicies] +message ListNetworkPoliciesResponse { + // A list of network policies. + repeated NetworkPolicy network_policies = 1; + + // A token, which can be send as `page_token` to retrieve the next page. + // If this field is omitted, there are no subsequent pages. + string next_page_token = 2; + + // Locations that could not be reached when making an aggregated query using + // wildcards. + repeated string unreachable = 3; +} + +// Request message for [VmwareEngine.GetNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.GetNetworkPolicy] +message GetNetworkPolicyRequest { + // Required. The resource name of the network policy to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/NetworkPolicy" + } + ]; +} + +// Request message for [VmwareEngine.UpdateNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.UpdateNetworkPolicy] +message UpdateNetworkPolicyRequest { + // Required. Network policy description. + NetworkPolicy network_policy = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Field mask is used to specify the fields to be overwritten in the + // `NetworkPolicy` 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 = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request message for [VmwareEngine.CreateNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.CreateNetworkPolicy] +message CreateNetworkPolicyRequest { + // Required. The resource name of the location (region) + // to create the new network policy in. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "vmwareengine.googleapis.com/NetworkPolicy" + } + ]; + + // Required. The user-provided identifier of the network policy to be created. + // This identifier must be unique within parent + // `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes + // the final token in the name URI. + // The identifier must meet the following requirements: + // + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) + // (section 3.5) + string network_policy_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The network policy configuration to use in the request. + NetworkPolicy network_policy = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request message for [VmwareEngine.DeleteNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.DeleteNetworkPolicy] +message DeleteNetworkPolicyRequest { + // Required. The resource name of the network policy to delete. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/NetworkPolicy" + } + ]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// VMware Engine network resource that provides connectivity for VMware Engine +// private clouds. +message VmwareEngineNetwork { + option (google.api.resource) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + pattern: "projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}" + }; + + // Represents a VMware Engine VPC network that is managed by a + // VMware Engine network resource. + message VpcNetwork { + // Enum Type defines possible types of a VMware Engine network controlled + // service. + enum Type { + // The default value. This value should never be used. + TYPE_UNSPECIFIED = 0; + + // VPC network that will be peered with a consumer VPC network or the + // intranet VPC of another VMware Engine network. Access a private cloud + // through Compute Engine VMs on a peered VPC network or an on-premises + // resource connected to a peered consumer VPC network. + INTRANET = 1; + + // VPC network used for internet access to and from a private cloud. + INTERNET = 2; + + // VPC network used for access to Google Cloud services like + // Cloud Storage. + GOOGLE_CLOUD = 3; + } + + // Output only. Type of VPC network (INTRANET, INTERNET, or + // GOOGLE_CLOUD) + Type type = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The relative resource name of the service VPC network this + // VMware Engine network is attached to. For example: + // `projects/123123/global/networks/my-network` + string network = 2 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.resource_reference) = { + type: "compute.googleapis.com/Network" + } + ]; + } + + // Enum State defines possible states of VMware Engine network. + enum State { + // The default value. This value is used if the state is omitted. + STATE_UNSPECIFIED = 0; + + // The VMware Engine network is being created. + CREATING = 1; + + // The VMware Engine network is ready. + ACTIVE = 2; + + // The VMware Engine network is being updated. + UPDATING = 3; + + // The VMware Engine network is being deleted. + DELETING = 4; + } + + // Enum Type defines possible types of VMware Engine network. + enum Type { + // The default value. This value should never be used. + TYPE_UNSPECIFIED = 0; + + // Network type used by private clouds created in projects without a network + // of type `STANDARD`. This network type is no longer used for new VMware + // Engine private cloud deployments. + LEGACY = 1; + } + + // Output only. The resource name of the VMware Engine network. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Creation time of this resource. + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Last update time of this resource. + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // User-provided description for this VMware Engine network. + string description = 5; + + // Output only. VMware Engine service VPC networks that provide connectivity + // from a private cloud to customer projects, the internet, and other Google + // Cloud services. + repeated VpcNetwork vpc_networks = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. State of the VMware Engine network. + State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. VMware Engine network type. + Type type = 8 [(google.api.field_behavior) = REQUIRED]; + + // Output only. System-generated unique identifier for the resource. + string uid = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Checksum that may be sent on update and delete requests to ensure that the + // user-provided value is up to date before the server processes a request. + // The server computes checksums based on the value of other fields in the + // request. + string etag = 10; +} + +// Request message for [VmwareEngine.CreateVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.CreateVmwareEngineNetwork] +message CreateVmwareEngineNetworkRequest { + // Required. The resource name of the location to create the new VMware Engine + // network in. A VMware Engine network of type + // `LEGACY` is a regional resource, and a VMware + // Engine network of type `STANDARD` is a global resource. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. For example: + // `projects/my-project/locations/global` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + child_type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; + + // Required. The user-provided identifier of the new VMware Engine network. + // This identifier must be unique among VMware Engine network resources + // within the parent and becomes the final token in the name URI. The + // identifier must meet the following requirements: + // + // * For networks of type LEGACY, adheres to the format: + // `{region-id}-default`. Replace `{region-id}` with the region where you want + // to create the VMware Engine network. For example, "us-west1-default". + // * Only contains 1-63 alphanumeric characters and hyphens + // * Begins with an alphabetical character + // * Ends with a non-hyphen character + // * Not formatted as a UUID + // * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) + // (section 3.5) + string vmware_engine_network_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The initial description of the new VMware Engine network. + VmwareEngineNetwork vmware_engine_network = 3 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request message for [VmwareEngine.UpdateVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.UpdateVmwareEngineNetwork] +message UpdateVmwareEngineNetworkRequest { + // Required. VMware Engine network description. + VmwareEngineNetwork vmware_engine_network = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Field mask is used to specify the fields to be overwritten in the + // VMware Engine network 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. Only the + // following fields can be updated: `description`. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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]; +} + +// Request message for [VmwareEngine.DeleteVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.DeleteVmwareEngineNetwork] +message DeleteVmwareEngineNetworkRequest { + // Required. The resource name of the VMware Engine network to be deleted. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; + + // Optional. A request ID to identify requests. Specify a unique 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 guarantees that a + // request doesn't result in creation of duplicate commitments for at least 60 + // minutes. + // + // For example, consider a situation where you make an initial request and the + // request times out. If you make the request again with the same request + // ID, the server can check if original operation with the same request ID + // was received, and if so, will ignore the second request. This prevents + // clients from accidentally creating 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. Checksum used to ensure that the user-provided value is up to date before + // the server processes the request. The server compares provided checksum + // with the current checksum of the resource. If the user-provided value is + // out of date, this request returns an `ABORTED` error. + string etag = 3 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for [VmwareEngine.GetVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.GetVmwareEngineNetwork] +message GetVmwareEngineNetworkRequest { + // Required. The resource name of the VMware Engine network to retrieve. + // Resource names are schemeless URIs that follow the conventions in + // https://cloud.google.com/apis/design/resource_names. + // For example: + // `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "vmwareengine.googleapis.com/VmwareEngineNetwork" + } + ]; +} + +// Request message for [VmwareEngine.ListVmwareEngineNetworks][google.cloud.vmwareengine.v1.VmwareEngine.ListVmwareEngineNetworks] +message ListVmwareEngineNetworksRequest { + // Required. The resource name of the location to query for + // VMware Engine networks. Resource names are schemeless URIs that follow the + // conventions in https://cloud.google.com/apis/design/resource_names. For + // example: `projects/my-project/locations/global` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // The maximum number of results to return in one page. + // The maximum value is coerced to 1000. + // The default value of this field is 500. + int32 page_size = 2; + + // A page token, received from a previous `ListVmwareEngineNetworks` call. + // Provide this to retrieve the subsequent page. + // + // When paginating, all other parameters provided to + // `ListVmwareEngineNetworks` must match the call that provided the page + // token. + string page_token = 3; + + // A filter expression that matches resources returned in the response. + // The expression must specify the field name, a comparison + // operator, and the value that you want to use for filtering. The value + // must be a string, a number, or a boolean. The comparison operator + // must be `=`, `!=`, `>`, or `<`. + // + // For example, if you are filtering a list of network peerings, you can + // exclude the ones named `example-network` by specifying + // `name != "example-network"`. + // + // To filter on multiple expressions, provide each separate expression within + // parentheses. For example: + // ``` + // (name = "example-network") + // (createTime > "2021-04-12T08:15:10.40Z") + // ``` + // + // By default, each expression is an `AND` expression. However, you + // can include `AND` and `OR` expressions explicitly. + // For example: + // ``` + // (name = "example-network-1") AND + // (createTime > "2021-04-12T08:15:10.40Z") OR + // (name = "example-network-2") + // ``` + string filter = 4; + + // Sorts list results by a certain order. By default, returned results + // are ordered by `name` in ascending order. + // You can also sort results in descending order based on the `name` value + // using `orderBy="name desc"`. + // Currently, only ordering by `name` is supported. + string order_by = 5; +} + +// Response message for [VmwareEngine.ListVmwareEngineNetworks][google.cloud.vmwareengine.v1.VmwareEngine.ListVmwareEngineNetworks] +message ListVmwareEngineNetworksResponse { + // A list of VMware Engine networks. + repeated VmwareEngineNetwork vmware_engine_networks = 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; + + // Unreachable resources. + repeated string unreachable = 3; +} diff --git a/google/cloud/vmwareengine/v1/vmwareengine_grpc_service_config.json b/google/cloud/vmwareengine/v1/vmwareengine_grpc_service_config.json new file mode 100644 index 000000000..96b3063b9 --- /dev/null +++ b/google/cloud/vmwareengine/v1/vmwareengine_grpc_service_config.json @@ -0,0 +1,82 @@ +{ + "methodConfig": [ + { + "name": [ + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListPrivateClouds" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetPrivateCloud" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListClusters" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetCluster" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListSubnets" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListNodeTypes" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetNodeType" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListHcxActivationKeys" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetHcxActivationKey" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListNetworkPolicies" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetNetworkPolicy" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ShowNsxCredentials" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ShowVcenterCredentials" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "GetVmwareEngineNetwork" + }, + { + "service": "google.cloud.vmwareengine.v1.VmwareEngine", + "method": "ListVmwareEngineNetworks" + } + ], + "timeout": "120s", + "retryPolicy": { + "maxAttempts": 5, + "initialBackoff": "1s", + "maxBackoff": "10s", + "backoffMultiplier": 1.3, + "retryableStatusCodes": ["UNAVAILABLE"] + } + }, + { + "name": [ + {"service": "google.cloud.vmwareengine.v1.VmwareEngine"} + ], + "timeout": "120s" + } + ] +} diff --git a/google/cloud/vmwareengine/v1/vmwareengine_v1.yaml b/google/cloud/vmwareengine/v1/vmwareengine_v1.yaml new file mode 100644 index 000000000..9f856f3d4 --- /dev/null +++ b/google/cloud/vmwareengine/v1/vmwareengine_v1.yaml @@ -0,0 +1,117 @@ +type: google.api.Service +config_version: 3 +name: vmwareengine.googleapis.com +title: VMware Engine API + +apis: +- name: google.cloud.location.Locations +- name: google.cloud.vmwareengine.v1.VmwareEngine +- name: google.iam.v1.IAMPolicy +- name: google.longrunning.Operations + +types: +- name: google.cloud.vmwareengine.v1.OperationMetadata + +documentation: + summary: |- + The Google VMware Engine API lets you programmatically manage VMware + environments. + 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.location.Locations.GetLocation + deadline: 60.0 + - selector: google.cloud.location.Locations.ListLocations + deadline: 60.0 + - selector: 'google.cloud.vmwareengine.v1.VmwareEngine.*' + 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.iam.v1.IAMPolicy.GetIamPolicy + get: '/v1/{resource=projects/*/locations/*/privateClouds/*}:getIamPolicy' + additional_bindings: + - get: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:getIamPolicy' + - get: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:getIamPolicy' + - selector: google.iam.v1.IAMPolicy.SetIamPolicy + post: '/v1/{resource=projects/*/locations/*/privateClouds/*}:setIamPolicy' + body: '*' + additional_bindings: + - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:setIamPolicy' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:setIamPolicy' + body: '*' + - selector: google.iam.v1.IAMPolicy.TestIamPermissions + post: '/v1/{resource=projects/*/locations/*/privateClouds/*}:testIamPermissions' + body: '*' + additional_bindings: + - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:testIamPermissions' + body: '*' + - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:testIamPermissions' + 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.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.cloud.vmwareengine.v1.VmwareEngine.*' + 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 diff --git a/google/cloud/vpcaccess/v1/BUILD.bazel b/google/cloud/vpcaccess/v1/BUILD.bazel index 3349cda41..e6ba998aa 100644 --- a/google/cloud/vpcaccess/v1/BUILD.bazel +++ b/google/cloud/vpcaccess/v1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":vpcaccess_proto_with_info"], gapic_yaml = None, grpc_service_config = "vpcaccess_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", test_deps = [ ":vpcaccess_java_grpc", @@ -133,14 +134,15 @@ go_gapic_library( grpc_service_config = "vpcaccess_grpc_service_config.json", importpath = "cloud.google.com/go/vpcaccess/apiv1;vpcaccess", metadata = True, + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", transport = "grpc+rest", deps = [ ":vpcaccess_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -177,6 +179,7 @@ py_gapic_library( srcs = [":vpcaccess_proto"], grpc_service_config = "vpcaccess_grpc_service_config.json", opt_args = ["warehouse-package-name=google-cloud-vpc-access"], + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", transport = "grpc", deps = [ @@ -227,7 +230,9 @@ php_gapic_library( name = "vpcaccess_php_gapic", srcs = [":vpcaccess_proto_with_info"], grpc_service_config = "vpcaccess_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", + transport = "grpc+rest", deps = [ ":vpcaccess_php_grpc", ":vpcaccess_php_proto", @@ -260,7 +265,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "vpcaccess_grpc_service_config.json", package = "google.cloud.vpcaccess.v1", + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -305,6 +312,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/vpc/docs/serverless-vpc-access", ], grpc_service_config = "vpcaccess_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Serverless VPC Access enables you to connect from a serverless environment on Google Cloud (Cloud Run, Cloud Functions, or the App Engine standard environment) directly to your VPC network. This connection makes it possible for your serverless environment to access Compute Engine VM instances, Memorystore instances, and any other resources with an internal IP address.", ruby_cloud_title = "Serverless VPC Access V1", service_yaml = "vpcaccess_v1.yaml", @@ -351,6 +359,7 @@ csharp_gapic_library( srcs = [":vpcaccess_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "vpcaccess_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "vpcaccess_v1.yaml", deps = [ ":vpcaccess_csharp_grpc", diff --git a/google/cloud/webrisk/v1/BUILD.bazel b/google/cloud/webrisk/v1/BUILD.bazel index 51c18fcb3..8431ccb4a 100644 --- a/google/cloud/webrisk/v1/BUILD.bazel +++ b/google/cloud/webrisk/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"]) @@ -59,12 +68,15 @@ java_gapic_library( srcs = [":webrisk_proto_with_info"], gapic_yaml = "webrisk_gapic.yaml", grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1.yaml", test_deps = [ ":webrisk_java_grpc", ], transport = "grpc+rest", deps = [ ":webrisk_java_proto", + "//google/api:api_java_proto", ], ) @@ -116,6 +128,8 @@ go_gapic_library( srcs = [":webrisk_proto_with_info"], grpc_service_config = "webrisk_grpc_service_config.json", importpath = "cloud.google.com/go/webrisk/apiv1;webrisk", + metadata = True, + rest_numeric_enums = True, service_yaml = "webrisk_v1.yaml", transport = "grpc+rest", deps = [ @@ -135,6 +149,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-webrisk-v1-go", deps = [ ":webrisk_go_gapic", + ":webrisk_go_gapic_srcjar-metadata.srcjar", ":webrisk_go_gapic_srcjar-test.srcjar", ":webrisk_go_proto", ], @@ -143,7 +158,6 @@ go_gapic_assembly_pkg( ############################################################################## # Python ############################################################################## - load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", @@ -155,7 +169,11 @@ py_gapic_library( name = "webrisk_py_gapic", srcs = [":webrisk_proto"], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -168,6 +186,7 @@ py_test( deps = [":webrisk_py_gapic"], ) +# Open Source Packages py_gapic_assembly_pkg( name = "webrisk-v1-py", deps = [ @@ -201,6 +220,9 @@ php_gapic_library( name = "webrisk_php_gapic", srcs = [":webrisk_proto_with_info"], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1.yaml", + transport = "grpc+rest", deps = [ ":webrisk_php_grpc", ":webrisk_php_proto", @@ -233,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "webrisk_grpc_service_config.json", package = "google.cloud.webrisk.v1", + rest_numeric_enums = True, service_yaml = "webrisk_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -271,15 +295,17 @@ ruby_cloud_gapic_library( name = "webrisk_ruby_gapic", srcs = [":webrisk_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-web_risk-v1", - "ruby-cloud-env-prefix=WEBRISK", - "ruby-cloud-product-url=https://cloud.google.com/web-risk", "ruby-cloud-api-id=webrisk.googleapis.com", "ruby-cloud-api-shortname=webrisk", + "ruby-cloud-env-prefix=WEBRISK", + "ruby-cloud-gem-name=google-cloud-web_risk-v1", + "ruby-cloud-product-url=https://cloud.google.com/web-risk", ], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Web Risk is an enterprise security product that lets your client applications check URLs against Google's constantly updated lists of unsafe web resources.", ruby_cloud_title = "Web Risk V1", + service_yaml = "webrisk_v1.yaml", deps = [ ":webrisk_ruby_grpc", ":webrisk_ruby_proto", @@ -323,6 +349,7 @@ csharp_gapic_library( srcs = [":webrisk_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "webrisk_v1.yaml", deps = [ ":webrisk_csharp_grpc", diff --git a/google/cloud/webrisk/v1/webrisk.proto b/google/cloud/webrisk/v1/webrisk.proto index 71b6b44f7..186a301fb 100644 --- a/google/cloud/webrisk/v1/webrisk.proto +++ b/google/cloud/webrisk/v1/webrisk.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. @@ -79,7 +79,8 @@ service WebRiskService { // content, the site will be added to the [Google's Social Engineering // lists](https://support.google.com/webmasters/answer/6350487/) in order to // protect users that could get exposed to this threat in the future. Only - // projects with CREATE_SUBMISSION_USERS visibility can use this method. + // allowlisted projects can use this method during Early Access. Please reach + // out to Sales or your customer engineer to obtain access. rpc CreateSubmission(CreateSubmissionRequest) returns (Submission) { option (google.api.http) = { post: "/v1/{parent=projects/*}/submissions" @@ -107,7 +108,9 @@ message ComputeThreatListDiffRequest { repeated CompressionType supported_compressions = 3; } - // Required. The threat list to update. Only a single ThreatType should be specified. + // Required. The threat list to update. Only a single ThreatType should be specified + // per request. If you want to handle multiple ThreatTypes, you must make one + // request per ThreatType. ThreatType threat_type = 1 [(google.api.field_behavior) = REQUIRED]; // The current version token of the client for the requested list (the @@ -122,13 +125,6 @@ message ComputeThreatListDiffRequest { } message ComputeThreatListDiffResponse { - // The expected state of a client's local database. - message Checksum { - // The SHA256 hash of the client state; that is, of the sorted list of all - // hashes present in the database. - bytes sha256 = 1; - } - // The type of response sent to the client. enum ResponseType { // Unknown. @@ -143,6 +139,13 @@ message ComputeThreatListDiffResponse { RESET = 2; } + // The expected state of a client's local database. + message Checksum { + // The SHA256 hash of the client state; that is, of the sorted list of all + // hashes present in the database. + bytes sha256 = 1; + } + // The type of response. This may indicate that an action must be taken by the // client when the response is received. ResponseType response_type = 4; @@ -192,7 +195,7 @@ message SearchUrisResponse { google.protobuf.Timestamp expire_time = 2; } - // The threat list matches. This may be empty if the URI is on no list. + // The threat list matches. This might be empty if the URI is on no list. ThreatUri threat = 1; } @@ -200,6 +203,8 @@ message SearchUrisResponse { message SearchHashesRequest { // A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 // hash. For JSON requests, this field is base64-encoded. + // Note that if this parameter is provided by a URI, it must be encoded using + // the web safe base64 variant (RFC 4648). bytes hash_prefix = 1; // Required. The ThreatLists to search in. Multiple ThreatLists may be specified. @@ -231,35 +236,10 @@ message SearchHashesResponse { google.protobuf.Timestamp negative_expire_time = 2; } -// Contains the set of entries to add to a local database. -// May contain a combination of compressed and raw data in a single response. -message ThreatEntryAdditions { - // The raw SHA256-formatted entries. - // Repeated to allow returning sets of hashes with different prefix sizes. - repeated RawHashes raw_hashes = 1; - - // The encoded 4-byte prefixes of SHA256-formatted entries, using a - // Golomb-Rice encoding. The hashes are converted to uint32, sorted in - // ascending order, then delta encoded and stored as encoded_data. - RiceDeltaEncoding rice_hashes = 2; -} - -// Contains the set of entries to remove from a local database. -message ThreatEntryRemovals { - // The raw removal indices for a local list. - RawIndices raw_indices = 1; - - // The encoded local, lexicographically-sorted list indices, using a - // Golomb-Rice encoding. Used for sending compressed removal indices. The - // removal indices (uint32) are sorted in ascending order, then delta encoded - // and stored as encoded_data. - RiceDeltaEncoding rice_indices = 2; -} - -// The type of threat. This maps dirrectly to the threat list a threat may +// The type of threat. This maps directly to the threat list a threat may // belong to. enum ThreatType { - // Unknown. + // No entries should match this threat type. This threat type is unused. THREAT_TYPE_UNSPECIFIED = 0; // Malware targeting any platform. @@ -270,6 +250,10 @@ enum ThreatType { // Unwanted software targeting any platform. UNWANTED_SOFTWARE = 3; + + // A list of extended coverage social engineering URIs targeting any + // platform. + SOCIAL_ENGINEERING_EXTENDED_COVERAGE = 4; } // The ways in which threat entry sets can be compressed. @@ -284,6 +268,31 @@ enum CompressionType { RICE = 2; } +// Contains the set of entries to add to a local database. +// May contain a combination of compressed and raw data in a single response. +message ThreatEntryAdditions { + // The raw SHA256-formatted entries. + // Repeated to allow returning sets of hashes with different prefix sizes. + repeated RawHashes raw_hashes = 1; + + // The encoded 4-byte prefixes of SHA256-formatted entries, using a + // Golomb-Rice encoding. The hashes are converted to uint32, sorted in + // ascending order, then delta encoded and stored as encoded_data. + RiceDeltaEncoding rice_hashes = 2; +} + +// Contains the set of entries to remove from a local database. +message ThreatEntryRemovals { + // The raw removal indices for a local list. + RawIndices raw_indices = 1; + + // The encoded local, lexicographically-sorted list indices, using a + // Golomb-Rice encoding. Used for sending compressed removal indices. The + // removal indices (uint32) are sorted in ascending order, then delta encoded + // and stored as encoded_data. + RiceDeltaEncoding rice_indices = 2; +} + // A set of raw indices to remove from a local list. message RawIndices { // The indices to remove from a lexicographically-sorted local list. @@ -331,9 +340,9 @@ message RiceDeltaEncoding { bytes encoded_data = 4; } -// Wraps a URI that might be displaying phishing content. +// Wraps a URI that might be displaying malicious content. message Submission { - // Required. The URI that is being reported for phishing content to be analyzed. + // Required. The URI that is being reported for malicious content to be analyzed. string uri = 1 [(google.api.field_behavior) = REQUIRED]; } diff --git a/google/cloud/webrisk/v1/webrisk_grpc_service_config.json b/google/cloud/webrisk/v1/webrisk_grpc_service_config.json index f72ca40a6..2d36cd02e 100755 --- a/google/cloud/webrisk/v1/webrisk_grpc_service_config.json +++ b/google/cloud/webrisk/v1/webrisk_grpc_service_config.json @@ -33,7 +33,7 @@ "method": "CreateSubmission" } ], - "timeout": "60s" + "timeout": "600s" } ] } diff --git a/google/cloud/webrisk/v1beta1/BUILD.bazel b/google/cloud/webrisk/v1beta1/BUILD.bazel index 3e6167590..4f5fba42f 100644 --- a/google/cloud/webrisk/v1beta1/BUILD.bazel +++ b/google/cloud/webrisk/v1beta1/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"]) @@ -58,12 +67,15 @@ java_gapic_library( srcs = [":webrisk_proto_with_info"], gapic_yaml = "webrisk_gapic.yaml", grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1beta1.yaml", test_deps = [ ":webrisk_java_grpc", ], transport = "grpc+rest", deps = [ ":webrisk_java_proto", + "//google/api:api_java_proto", ], ) @@ -115,6 +127,8 @@ go_gapic_library( srcs = [":webrisk_proto_with_info"], grpc_service_config = "webrisk_grpc_service_config.json", importpath = "cloud.google.com/go/webrisk/apiv1beta1;webrisk", + metadata = True, + rest_numeric_enums = True, service_yaml = "webrisk_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -134,6 +148,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-webrisk-v1beta1-go", deps = [ ":webrisk_go_gapic", + ":webrisk_go_gapic_srcjar-metadata.srcjar", ":webrisk_go_gapic_srcjar-test.srcjar", ":webrisk_go_proto", ], @@ -142,7 +157,6 @@ go_gapic_assembly_pkg( ############################################################################## # Python ############################################################################## - load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", @@ -154,7 +168,11 @@ py_gapic_library( name = "webrisk_py_gapic", srcs = [":webrisk_proto"], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1beta1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -167,6 +185,7 @@ py_test( deps = [":webrisk_py_gapic"], ) +# Open Source Packages py_gapic_assembly_pkg( name = "webrisk-v1beta1-py", deps = [ @@ -200,6 +219,9 @@ php_gapic_library( name = "webrisk_php_gapic", srcs = [":webrisk_proto_with_info"], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "webrisk_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":webrisk_php_grpc", ":webrisk_php_proto", @@ -232,7 +254,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "webrisk_grpc_service_config.json", package = "google.cloud.webrisk.v1beta1", + rest_numeric_enums = True, service_yaml = "webrisk_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -270,16 +294,18 @@ ruby_cloud_gapic_library( name = "webrisk_ruby_gapic", srcs = [":webrisk_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-web_risk-v1beta1", - "ruby-cloud-env-prefix=WEBRISK", - "ruby-cloud-service-override=WebRiskServiceV1Beta1=WebRiskService", - "ruby-cloud-product-url=https://cloud.google.com/web-risk", "ruby-cloud-api-id=webrisk.googleapis.com", "ruby-cloud-api-shortname=webrisk", + "ruby-cloud-env-prefix=WEBRISK", + "ruby-cloud-gem-name=google-cloud-web_risk-v1beta1", + "ruby-cloud-product-url=https://cloud.google.com/web-risk", + "ruby-cloud-service-override=WebRiskServiceV1Beta1=WebRiskService", ], grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Web Risk is an enterprise security product that lets your client applications check URLs against Google's constantly updated lists of unsafe web resources.", ruby_cloud_title = "Web Risk V1beta1", + service_yaml = "webrisk_v1beta1.yaml", deps = [ ":webrisk_ruby_grpc", ":webrisk_ruby_proto", @@ -323,6 +349,7 @@ csharp_gapic_library( srcs = [":webrisk_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "webrisk_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "webrisk_v1beta1.yaml", deps = [ ":webrisk_csharp_grpc", @@ -343,4 +370,20 @@ csharp_gapic_assembly_pkg( ############################################################################## # C++ ############################################################################## -# Put your C++ rules here +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", +) + +cc_proto_library( + name = "webrisk_cc_proto", + deps = [":webrisk_proto"], +) + +cc_grpc_library( + name = "webrisk_cc_grpc", + srcs = [":webrisk_proto"], + grpc_only = True, + deps = [":webrisk_cc_proto"], +) diff --git a/google/cloud/websecurityscanner/v1/BUILD.bazel b/google/cloud/websecurityscanner/v1/BUILD.bazel index 68284cc19..4968bbf6e 100644 --- a/google/cloud/websecurityscanner/v1/BUILD.bazel +++ b/google/cloud/websecurityscanner/v1/BUILD.bazel @@ -80,6 +80,7 @@ java_gapic_library( srcs = [":websecurityscanner_proto_with_info"], gapic_yaml = None, grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", test_deps = [ ":websecurityscanner_java_grpc", @@ -140,6 +141,7 @@ go_gapic_library( grpc_service_config = "websecurityscanner_grpc_service_config.json", importpath = "cloud.google.com/go/websecurityscanner/apiv1;websecurityscanner", metadata = True, + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", transport = "grpc+rest", deps = [ @@ -179,6 +181,7 @@ py_gapic_library( name = "websecurityscanner_py_gapic", srcs = [":websecurityscanner_proto"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", transport = "grpc", deps = [ @@ -229,7 +232,9 @@ php_gapic_library( name = "websecurityscanner_php_gapic", srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", + transport = "grpc+rest", deps = [ ":websecurityscanner_php_grpc", ":websecurityscanner_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "websecurityscanner_grpc_service_config.json", package = "google.cloud.websecurityscanner.v1", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -307,6 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", ], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Web Security Scanner scans your Compute and App Engine apps for common web vulnerabilities.", ruby_cloud_title = "Web Security Scanner V1", service_yaml = "websecurityscanner_v1.yaml", @@ -353,6 +361,7 @@ csharp_gapic_library( srcs = [":websecurityscanner_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1.yaml", deps = [ ":websecurityscanner_csharp_grpc", diff --git a/google/cloud/websecurityscanner/v1alpha/BUILD.bazel b/google/cloud/websecurityscanner/v1alpha/BUILD.bazel index 1d385ff19..8ab1f38b8 100644 --- a/google/cloud/websecurityscanner/v1alpha/BUILD.bazel +++ b/google/cloud/websecurityscanner/v1alpha/BUILD.bazel @@ -66,6 +66,7 @@ java_gapic_library( name = "websecurityscanner_java_gapic", srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":websecurityscanner_java_grpc", ], @@ -123,6 +124,7 @@ go_gapic_library( srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", importpath = "cloud.google.com/go/cloud/websecurityscanner/apiv1alpha;websecurityscanner", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -161,6 +163,7 @@ py_gapic_library( name = "websecurityscanner_py_gapic", srcs = [":websecurityscanner_proto"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -207,6 +210,8 @@ php_gapic_library( name = "websecurityscanner_php_gapic", srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":websecurityscanner_php_grpc", ":websecurityscanner_php_proto", @@ -239,7 +244,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "websecurityscanner_grpc_service_config.json", package = "google.cloud.websecurityscanner.v1alpha", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -277,6 +284,7 @@ ruby_cloud_gapic_library( name = "websecurityscanner_ruby_gapic", srcs = [":websecurityscanner_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-websecurityscanner-v1alpha"], + rest_numeric_enums = True, deps = [ ":websecurityscanner_ruby_grpc", ":websecurityscanner_ruby_proto", @@ -320,6 +328,7 @@ csharp_gapic_library( srcs = [":websecurityscanner_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1alpha.yaml", deps = [ ":websecurityscanner_csharp_grpc", diff --git a/google/cloud/websecurityscanner/v1beta/BUILD.bazel b/google/cloud/websecurityscanner/v1beta/BUILD.bazel index cbbaf83da..357750fbe 100644 --- a/google/cloud/websecurityscanner/v1beta/BUILD.bazel +++ b/google/cloud/websecurityscanner/v1beta/BUILD.bazel @@ -69,6 +69,7 @@ java_gapic_library( name = "websecurityscanner_java_gapic", srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":websecurityscanner_java_grpc", ], @@ -126,6 +127,7 @@ go_gapic_library( srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", importpath = "cloud.google.com/go/websecurityscanner/apiv1beta;websecurityscanner", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -164,6 +166,7 @@ py_gapic_library( name = "websecurityscanner_py_gapic", srcs = [":websecurityscanner_proto"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -210,6 +213,8 @@ php_gapic_library( name = "websecurityscanner_php_gapic", srcs = [":websecurityscanner_proto_with_info"], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":websecurityscanner_php_grpc", ":websecurityscanner_php_proto", @@ -242,7 +247,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "websecurityscanner_grpc_service_config.json", package = "google.cloud.websecurityscanner.v1beta", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -287,6 +294,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=websecurityscanner", ], grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Web Security Scanner scans your Compute and App Engine apps for common web vulnerabilities.", ruby_cloud_title = "Web Security Scanner V1beta", deps = [ @@ -332,6 +340,7 @@ csharp_gapic_library( srcs = [":websecurityscanner_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "websecurityscanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "websecurityscanner_v1beta.yaml", deps = [ ":websecurityscanner_csharp_grpc", diff --git a/google/cloud/workflows/executions/v1/BUILD.bazel b/google/cloud/workflows/executions/v1/BUILD.bazel index 146281fc3..9b58a6c43 100644 --- a/google/cloud/workflows/executions/v1/BUILD.bazel +++ b/google/cloud/workflows/executions/v1/BUILD.bazel @@ -68,6 +68,7 @@ java_gapic_library( srcs = [":executions_proto_with_info"], gapic_yaml = "executions_gapic.yaml", grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1.yaml", test_deps = [ ":executions_java_grpc", @@ -128,8 +129,9 @@ go_gapic_library( grpc_service_config = "executions_grpc_service_config.json", importpath = "cloud.google.com/go/workflows/executions/apiv1;executions", metadata = True, + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":executions_go_proto", ], @@ -167,6 +169,7 @@ py_gapic_library( name = "executions_py_gapic", srcs = [":executions_proto"], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -214,7 +217,9 @@ php_gapic_library( name = "executions_php_gapic", srcs = [":executions_proto_with_info"], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1.yaml", + transport = "grpc+rest", deps = [ ":executions_php_grpc", ":executions_php_proto", @@ -247,7 +252,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "executions_grpc_service_config.json", package = "google.cloud.workflows.executions.v1", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1.yaml", + transport = "grpc", deps = [], ) @@ -293,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-workflows", ], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..", ruby_cloud_title = "Workflows Executions V1", deps = [ @@ -338,6 +346,7 @@ csharp_gapic_library( srcs = [":executions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1.yaml", deps = [ ":executions_csharp_grpc", diff --git a/google/cloud/workflows/executions/v1beta/BUILD.bazel b/google/cloud/workflows/executions/v1beta/BUILD.bazel index 56a16b675..5ce21fbdb 100644 --- a/google/cloud/workflows/executions/v1beta/BUILD.bazel +++ b/google/cloud/workflows/executions/v1beta/BUILD.bazel @@ -58,6 +58,7 @@ java_gapic_library( name = "executions_java_gapic", srcs = [":executions_proto_with_info"], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":executions_java_grpc", ], @@ -115,6 +116,7 @@ go_gapic_library( srcs = [":executions_proto_with_info"], grpc_service_config = "executions_grpc_service_config.json", importpath = "cloud.google.com/go/workflows/executions/apiv1beta;executions", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1beta.yaml", transport = "grpc+rest", deps = [ @@ -153,6 +155,7 @@ py_gapic_library( name = "executions_py_gapic", srcs = [":executions_proto"], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -201,6 +204,8 @@ php_grpc_library( php_gapic_library( name = "executions_php_gapic", srcs = [":executions_proto_with_info"], + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":executions_php_grpc", ":executions_php_proto", @@ -233,7 +238,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], gapic_yaml = "executions_gapic.yaml", package = "google.cloud.workflows.executions.v1beta", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1beta.yaml", + transport = "grpc", deps = [], ) @@ -279,6 +286,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-workflows", ], grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, ruby_cloud_description = "Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..", ruby_cloud_title = "Workflows Executions V1beta", deps = [ @@ -324,6 +332,7 @@ csharp_gapic_library( srcs = [":executions_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "executions_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "workflowexecutions_v1beta.yaml", deps = [ ":executions_csharp_grpc", diff --git a/google/cloud/workflows/v1/BUILD.bazel b/google/cloud/workflows/v1/BUILD.bazel index 26f8ef87a..5ba3d6967 100644 --- a/google/cloud/workflows/v1/BUILD.bazel +++ b/google/cloud/workflows/v1/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":workflows_proto_with_info"], gapic_yaml = "workflows_gapic.yaml", grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "workflows_v1.yaml", test_deps = [ ":workflows_java_grpc", @@ -131,13 +132,14 @@ go_gapic_library( grpc_service_config = "workflows_grpc_service_config.json", importpath = "cloud.google.com/go/workflows/apiv1;workflows", metadata = True, + rest_numeric_enums = True, service_yaml = "workflows_v1.yaml", transport = "grpc+rest", deps = [ ":workflows_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -173,6 +175,7 @@ py_gapic_library( name = "workflows_py_gapic", srcs = [":workflows_proto"], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -220,7 +223,9 @@ php_gapic_library( name = "workflows_php_gapic", srcs = [":workflows_proto_with_info"], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "workflows_v1.yaml", + transport = "grpc+rest", deps = [ ":workflows_php_grpc", ":workflows_php_proto", @@ -253,7 +258,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "workflows_grpc_service_config.json", package = "google.cloud.workflows.v1", + rest_numeric_enums = True, service_yaml = "workflows_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -298,6 +305,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/workflows/", ], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..", ruby_cloud_title = "Workflows V1", deps = [ @@ -343,6 +351,7 @@ csharp_gapic_library( srcs = [":workflows_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "workflows_v1.yaml", deps = [ ":workflows_csharp_grpc", diff --git a/google/cloud/workflows/v1beta/BUILD.bazel b/google/cloud/workflows/v1beta/BUILD.bazel index 9391b2bf1..a861fdfa9 100644 --- a/google/cloud/workflows/v1beta/BUILD.bazel +++ b/google/cloud/workflows/v1beta/BUILD.bazel @@ -60,6 +60,7 @@ java_gapic_library( name = "workflows_java_gapic", srcs = [":workflows_proto_with_info"], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":workflows_java_grpc", ], @@ -118,13 +119,14 @@ go_gapic_library( srcs = [":workflows_proto_with_info"], grpc_service_config = "workflows_grpc_service_config.json", importpath = "cloud.google.com/go/workflows/apiv1beta;workflows", + rest_numeric_enums = True, service_yaml = "workflows_v1beta.yaml", transport = "grpc+rest", deps = [ ":workflows_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -159,6 +161,7 @@ py_gapic_library( name = "workflows_py_gapic", srcs = [":workflows_proto"], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -206,7 +209,9 @@ php_gapic_library( name = "workflows_php_gapic", srcs = [":workflows_proto_with_info"], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "workflows_v1beta.yaml", + transport = "grpc+rest", deps = [ ":workflows_php_grpc", ":workflows_php_proto", @@ -239,7 +244,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], gapic_yaml = "workflows_gapic.yaml", package = "google.cloud.workflows.v1beta", + rest_numeric_enums = True, service_yaml = "workflows_v1beta.yaml", + transport = "grpc+rest", deps = [], ) @@ -284,6 +291,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=workflows", ], grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..", ruby_cloud_title = "Workflows V1beta", deps = [ @@ -329,6 +337,7 @@ csharp_gapic_library( srcs = [":workflows_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "workflows_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "workflows_v1beta.yaml", deps = [ ":workflows_csharp_grpc", diff --git a/google/container/v1/BUILD.bazel b/google/container/v1/BUILD.bazel index ed2e76c84..7d573d960 100644 --- a/google/container/v1/BUILD.bazel +++ b/google/container/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "container_proto", @@ -45,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "container_java_proto", deps = [":container_proto"], @@ -73,10 +92,12 @@ java_gapic_library( srcs = [":container_proto_with_info"], gapic_yaml = "container_gapic.yaml", grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1.yaml", test_deps = [ ":container_java_grpc", ], + transport = "grpc", deps = [ ":container_java_proto", "//google/api:api_java_proto", @@ -94,6 +115,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-container-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":container_java_gapic", ":container_java_grpc", @@ -102,17 +125,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "container_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -131,7 +143,9 @@ go_gapic_library( grpc_service_config = "container_grpc_service_config.json", importpath = "cloud.google.com/go/container/apiv1;container", metadata = True, + rest_numeric_enums = True, service_yaml = "container_v1.yaml", + transport = "grpc", deps = [ ":container_go_proto", ], @@ -155,16 +169,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "container_py_gapic", srcs = [":container_proto"], @@ -173,6 +177,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-container", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -194,17 +199,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_php_proto", deps = [":container_proto"], @@ -220,7 +214,9 @@ php_gapic_library( name = "container_php_gapic", srcs = [":container_proto_with_info"], grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1.yaml", + transport = "grpc+rest", deps = [ ":container_php_grpc", ":container_php_proto", @@ -237,15 +233,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "container_nodejs_gapic", package_name = "@google-cloud/container", @@ -253,7 +240,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "container_grpc_service_config.json", package = "google.container.v1", + rest_numeric_enums = True, service_yaml = "container_v1.yaml", + transport = "grpc", deps = [], ) @@ -265,17 +254,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_ruby_proto", deps = [":container_proto"], @@ -298,6 +276,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/kubernetes-engine", ], grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Builds and manages container-based applications, powered by the open source Kubernetes technology.", ruby_cloud_title = "Kubernetes Engine V1", deps = [ @@ -316,17 +295,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_csharp_proto", deps = [":container_proto"], @@ -343,6 +311,7 @@ csharp_gapic_library( srcs = [":container_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1.yaml", deps = [ ":container_csharp_grpc", @@ -360,15 +329,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "container_cc_proto", deps = [":container_proto"], diff --git a/google/container/v1/cluster_service.proto b/google/container/v1/cluster_service.proto index 5b71bb8da..40b8ac7ea 100644 --- a/google/container/v1/cluster_service.proto +++ b/google/container/v1/cluster_service.proto @@ -493,6 +493,21 @@ service ClusterManager { // Parameters that can be configured on Linux nodes. message LinuxNodeConfig { + // Possible cgroup modes that can be used. + enum CgroupMode { + // CGROUP_MODE_UNSPECIFIED is when unspecified cgroup configuration is used. + // The default for the GKE node OS image will be used. + CGROUP_MODE_UNSPECIFIED = 0; + + // CGROUP_MODE_V1 specifies to use cgroupv1 for the cgroup configuration on + // the node image. + CGROUP_MODE_V1 = 1; + + // CGROUP_MODE_V2 specifies to use cgroupv2 for the cgroup configuration on + // the node image. + CGROUP_MODE_V2 = 2; + } + // The Linux kernel parameters to be applied to the nodes and all pods running // on the nodes. // @@ -510,6 +525,9 @@ message LinuxNodeConfig { // net.ipv4.tcp_wmem // net.ipv4.tcp_tw_reuse map sysctls = 1; + + // cgroup_mode specifies the cgroup mode to be used on the node. + CgroupMode cgroup_mode = 2; } // Node kubelet configs. @@ -741,6 +759,13 @@ message NodeConfig { // All the nodes in the node pool will be Confidential VM once enabled. ConfidentialNodes confidential_nodes = 35; + // Enable or disable NCCL fast socket for the node pool. + optional FastSocket fast_socket = 36; + + // The resource labels for the node pool to use to annotate any related + // Google Compute Engine resources. + map resource_labels = 37; + // Logging configuration. NodePoolLoggingConfig logging_config = 38; } @@ -811,6 +836,11 @@ message NodeNetworkConfig { // This field cannot be changed after the node pool has been created. string pod_ipv4_cidr_block = 6; + // Whether nodes have internal IP addresses only. + // If enable_private_nodes is not specified, then the value is derived from + // [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + optional bool enable_private_nodes = 9; + // Network bandwidth tier configuration. optional NetworkPerformanceConfig network_performance_config = 11; } @@ -934,6 +964,13 @@ message NodeLabels { map labels = 1; } +// Collection of [GCP +// labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). +message ResourceLabels { + // Map of node label keys and node label values. + map labels = 1; +} + // Collection of Compute Engine network tags that can be applied to a node's // underlying VM instance. message NetworkTags { @@ -1030,6 +1067,9 @@ message AddonsConfig { // Configuration for the GCP Filestore CSI driver. GcpFilestoreCsiDriverConfig gcp_filestore_csi_driver_config = 14; + + // Configuration for the Backup for GKE agent addon. + GkeBackupAgentConfig gke_backup_agent_config = 16; } // Configuration options for the HTTP (L7) load balancing controller addon, @@ -1104,6 +1144,10 @@ message PrivateClusterConfig { // Controls master global access settings. PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8; + + // Subnet to provision the master's private endpoint during cluster creation. + // Specified in projects/*/regions/*/subnetworks/* format. + string private_endpoint_subnetwork = 10; } // Configuration for returning group information from authenticators. @@ -1156,6 +1200,12 @@ message GcpFilestoreCsiDriverConfig { bool enabled = 1; } +// Configuration for the Backup for GKE Agent. +message GkeBackupAgentConfig { + // Whether the Backup for GKE agent is enabled for this cluster. + bool enabled = 1; +} + // Configuration options for the master authorized networks feature. Enabled // master authorized networks will disallow all external traffic to access // Kubernetes master through HTTPS except traffic from the given CIDR blocks, @@ -1176,6 +1226,9 @@ message MasterAuthorizedNetworksConfig { // cidr_blocks define up to 50 external networks that could access // Kubernetes master through HTTPS. repeated CidrBlock cidr_blocks = 2; + + // Whether master is accessbile via Google Compute Engine Public IP addresses. + optional bool gcp_public_cidrs_access_enabled = 3; } // Configuration for the legacy Attribute Based Access Control authorization @@ -1228,9 +1281,8 @@ message BinaryAuthorization { // anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. bool enabled = 1 [deprecated = true]; - // Mode of operation for binauthz policy evaluation. Currently the only - // options are equivalent to enable/disable. If unspecified, defaults to - // DISABLED. + // Mode of operation for binauthz policy evaluation. If unspecified, defaults + // to DISABLED. EvaluationMode evaluation_mode = 2; } @@ -1351,6 +1403,12 @@ message IPAllocationPolicy { // use_ip_aliases is true. If both use_ip_aliases and use_routes are false, // then the server picks the default IP allocation mode bool use_routes = 15; + + // The IP stack type of the cluster + StackType stack_type = 16; + + // The ipv6 access type (internal or external) when create_subnetwork is true + IPv6AccessType ipv6_access_type = 17; } // A Google Kubernetes Engine cluster. @@ -1566,6 +1624,9 @@ message Cluster { // pods. MeshCertificates mesh_certificates = 67; + // Configuration for the fine-grained cost management feature. + CostManagementConfig cost_management_config = 45; + // Notification configuration of the cluster. NotificationConfig notification_config = 49; @@ -1773,6 +1834,9 @@ message ClusterUpdate { // Configuration for Shielded Nodes. ShieldedNodes desired_shielded_nodes = 48; + // The desired configuration for the fine-grained cost management feature. + CostManagementConfig desired_cost_management_config = 49; + // DNSConfig contains clusterDNS config for this cluster. DNSConfig desired_dns_config = 53; @@ -1860,6 +1924,9 @@ message ClusterUpdate { // ExternalIPs field. ServiceExternalIPsConfig desired_service_external_ips_config = 60; + // Enable/Disable private endpoint for the cluster's master. + optional bool desired_enable_private_endpoint = 71; + // The Kubernetes version to change the master to. // // Users may specify either explicit versions offered by @@ -1879,8 +1946,16 @@ message ClusterUpdate { // in autopilot clusters and node auto-provisioning enabled clusters. NetworkTags desired_node_pool_auto_config_network_tags = 110; + // The desired config of Gateway API on this cluster. + GatewayAPIConfig desired_gateway_api_config = 114; + // The desired node pool logging configuration defaults for the cluster. NodePoolLoggingConfig desired_node_pool_logging_config = 116; + + // The desired stack type of the cluster. + // If a stack type is provided and does not match the current stack type of + // the cluster, update will attempt to change the stack type to the new type. + StackType desired_stack_type = 119; } // This operation resource represents operations that may have happened or are @@ -2216,8 +2291,15 @@ message UpdateNodePoolRequest { // Enable or disable gvnic on the node pool. VirtualNIC gvnic = 29; + // Enable or disable NCCL fast socket for the node pool. + FastSocket fast_socket = 31; + // Logging configuration. NodePoolLoggingConfig logging_config = 32; + + // The resource labels for the node pool to use to annotate any related + // Google Compute Engine resources. + ResourceLabels resource_labels = 33; } // SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. @@ -2741,7 +2823,7 @@ message BlueGreenSettings { message StandardRolloutPolicy { // Blue pool size to drain in a batch. oneof update_batch_size { - // Percentage of the bool pool nodes to drain in a batch. + // Percentage of the blue pool nodes to drain in a batch. // The range of this field should be (0.0, 1.0]. float batch_percentage = 1; @@ -2922,6 +3004,23 @@ message NodePool { ERROR = 6; } + // PlacementPolicy defines the placement policy used by the node pool. + message PlacementPolicy { + // Type defines the type of placement policy. + enum Type { + // TYPE_UNSPECIFIED specifies no requirements on nodes + // placement. + TYPE_UNSPECIFIED = 0; + + // COMPACT specifies node placement in the same availability domain to + // ensure low communication latency. + COMPACT = 1; + } + + // The type of placement. + Type type = 1; + } + // The name of the node pool. string name = 1; @@ -2991,6 +3090,9 @@ message NodePool { // Upgrade settings control disruption and speed of the upgrade. UpgradeSettings upgrade_settings = 107; + // Specifies the node placement policy. + PlacementPolicy placement_policy = 108; + // Output only. [Output only] Update info contains relevant information during a node // pool update. UpdateInfo update_info = 109 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -3716,6 +3818,32 @@ message NetworkConfig { // ServiceExternalIPsConfig specifies if services with externalIPs field are // blocked or not. ServiceExternalIPsConfig service_external_ips_config = 15; + + // GatewayAPIConfig contains the desired config of Gateway API on this + // cluster. + GatewayAPIConfig gateway_api_config = 16; +} + +// GatewayAPIConfig contains the desired config of Gateway API on this cluster. +message GatewayAPIConfig { + // Channel describes if/how Gateway API should be installed and implemented in + // a cluster. + enum Channel { + // Default value. + CHANNEL_UNSPECIFIED = 0; + + // Gateway API support is disabled + CHANNEL_DISABLED = 1; + + // Gateway API support is enabled, experimental CRDs are installed + CHANNEL_EXPERIMENTAL = 3; + + // Gateway API support is enabled, standard CRDs are installed + CHANNEL_STANDARD = 4; + } + + // The Gateway API release channel to use for Gateway API. + Channel channel = 1; } // Config to block services with externalIPs field. @@ -3838,6 +3966,12 @@ message ReleaseChannel { Channel channel = 1; } +// Configuration for fine-grained cost management feature. +message CostManagementConfig { + // Whether the feature is enabled or not. + bool enabled = 1; +} + // IntraNodeVisibilityConfig contains the desired config of the intra-node // visibility on this cluster. message IntraNodeVisibilityConfig { @@ -4092,6 +4226,12 @@ message VirtualNIC { bool enabled = 1; } +// Configuration of Fast Socket feature. +message FastSocket { + // Whether Fast Socket features are enabled in the node pool. + bool enabled = 1; +} + // PrivateIPv6GoogleAccess controls whether and how the pods can communicate // with Google Services through gRPC over IPv6. enum PrivateIPv6GoogleAccess { @@ -4283,6 +4423,15 @@ message LoggingComponentConfig { // workloads WORKLOADS = 2; + + // kube-apiserver + APISERVER = 3; + + // kube-scheduler + SCHEDULER = 4; + + // kube-controller-manager + CONTROLLER_MANAGER = 5; } // Select components to collect logs. An empty set would disable all logging. @@ -4383,3 +4532,27 @@ message ManagedPrometheusConfig { // Enable Managed Collection. bool enabled = 1; } + +// Possible values for IP stack type +enum StackType { + // Default value, will be defaulted as IPV4 only + STACK_TYPE_UNSPECIFIED = 0; + + // Cluster is IPV4 only + IPV4 = 1; + + // Cluster can use both IPv4 and IPv6 + IPV4_IPV6 = 2; +} + +// Possible values for IPv6 access type +enum IPv6AccessType { + // Default value, will be defaulted as type external. + IPV6_ACCESS_TYPE_UNSPECIFIED = 0; + + // Access type internal (all v6 addresses are internal IPs) + INTERNAL = 1; + + // Access type external (all v6 addresses are external IPs) + EXTERNAL = 2; +} diff --git a/google/container/v1/container_v1.yaml b/google/container/v1/container_v1.yaml index cd34ffbf8..7f7c7d4d1 100644 --- a/google/container/v1/container_v1.yaml +++ b/google/container/v1/container_v1.yaml @@ -34,3 +34,6 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/container/v1beta1/BUILD.bazel b/google/container/v1beta1/BUILD.bazel index 2d1eb26bc..29c8f5665 100644 --- a/google/container/v1beta1/BUILD.bazel +++ b/google/container/v1beta1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "container_proto", @@ -46,18 +77,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "container_java_proto", deps = [":container_proto"], @@ -74,10 +93,12 @@ java_gapic_library( srcs = [":container_proto_with_info"], gapic_yaml = "container_gapic.yaml", grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1beta1.yaml", test_deps = [ ":container_java_grpc", ], + transport = "grpc", deps = [ ":container_java_proto", "//google/api:api_java_proto", @@ -95,6 +116,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-container-v1beta1-java", + include_samples = True, + transport = "grpc", deps = [ ":container_java_gapic", ":container_java_grpc", @@ -103,17 +126,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "container_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -133,7 +145,9 @@ go_gapic_library( grpc_service_config = "container_grpc_service_config.json", importpath = "cloud.google.com/go/container/apiv1beta1;container", metadata = True, + rest_numeric_enums = True, service_yaml = "container_v1beta1.yaml", + transport = "grpc", deps = [ ":container_go_proto", ], @@ -157,16 +171,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "container_py_gapic", srcs = [":container_proto"], @@ -175,6 +179,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-container", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -196,17 +201,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_php_proto", deps = [":container_proto"], @@ -222,7 +216,9 @@ php_gapic_library( name = "container_php_gapic", srcs = [":container_proto_with_info"], grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1beta1.yaml", + transport = "grpc+rest", deps = [ ":container_php_grpc", ":container_php_proto", @@ -239,15 +235,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "container_nodejs_gapic", package_name = "@google-cloud/container", @@ -255,7 +242,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "container_grpc_service_config.json", package = "google.container.v1beta1", + rest_numeric_enums = True, service_yaml = "container_v1beta1.yaml", + transport = "grpc", deps = [], ) @@ -267,17 +256,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_ruby_proto", deps = [":container_proto"], @@ -300,6 +278,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/kubernetes-engine", ], grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Builds and manages container-based applications, powered by the open source Kubernetes technology.", ruby_cloud_title = "Kubernetes Engine V1beta1", deps = [ @@ -318,17 +297,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "container_csharp_proto", deps = [":container_proto"], @@ -345,6 +313,7 @@ csharp_gapic_library( srcs = [":container_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "container_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "container_v1beta1.yaml", deps = [ ":container_csharp_grpc", @@ -362,15 +331,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "container_cc_proto", deps = [":container_proto"], diff --git a/google/container/v1beta1/cluster_service.proto b/google/container/v1beta1/cluster_service.proto index 0c53fdee0..a5ce7f0d9 100644 --- a/google/container/v1beta1/cluster_service.proto +++ b/google/container/v1beta1/cluster_service.proto @@ -753,6 +753,13 @@ message NodeConfig { // All the nodes in the node pool will be Confidential VM once enabled. ConfidentialNodes confidential_nodes = 35; + // Enable or disable NCCL fast socket for the node pool. + optional FastSocket fast_socket = 36; + + // The resource labels for the node pool to use to annotate any related + // Google Compute Engine resources. + map resource_labels = 37; + // Logging configuration. NodePoolLoggingConfig logging_config = 38; } @@ -827,6 +834,11 @@ message NodeNetworkConfig { // This field cannot be changed after the node pool has been created. string pod_ipv4_cidr_block = 6; + // Whether nodes have internal IP addresses only. + // If enable_private_nodes is not specified, then the value is derived from + // [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + optional bool enable_private_nodes = 9; + // Network bandwidth tier configuration. optional NetworkPerformanceConfig network_performance_config = 11; } @@ -961,6 +973,13 @@ message NodeLabels { map labels = 1; } +// Collection of [GCP +// labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). +message ResourceLabels { + // Map of node label keys and node label values. + map labels = 1; +} + // Collection of Compute Engine network tags that can be applied to a node's // underlying VM instance. (See `tags` field in // [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). @@ -1172,6 +1191,10 @@ message PrivateClusterConfig { // Controls master global access settings. PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8; + + // Subnet to provision the master's private endpoint during cluster creation. + // Specified in projects/*/regions/*/subnetworks/* format. + string private_endpoint_subnetwork = 10; } // Configuration options for Istio addon. @@ -1233,6 +1256,9 @@ message MasterAuthorizedNetworksConfig { // cidr_blocks define up to 10 external networks that could access // Kubernetes master through HTTPS. repeated CidrBlock cidr_blocks = 2; + + // Whether master is accessbile via Google Compute Engine Public IP addresses. + optional bool gcp_public_cidrs_access_enabled = 3; } // Configuration for the legacy Attribute Based Access Control authorization @@ -1455,9 +1481,8 @@ message BinaryAuthorization { // anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. bool enabled = 1 [deprecated = true]; - // Mode of operation for binauthz policy evaluation. Currently the only - // options are equivalent to enable/disable. If unspecified, defaults to - // DISABLED. + // Mode of operation for binauthz policy evaluation. If unspecified, defaults + // to DISABLED. EvaluationMode evaluation_mode = 2; } @@ -1912,9 +1937,24 @@ message WorkloadConfig { // ProtectConfig defines the flags needed to enable/disable features for the // Protect API. message ProtectConfig { + // WorkloadVulnerabilityMode defines mode to perform vulnerability scanning. + enum WorkloadVulnerabilityMode { + // Default value not specified. + WORKLOAD_VULNERABILITY_MODE_UNSPECIFIED = 0; + + // Disables Workload Vulnerability Scanning feature on the cluster. + DISABLED = 1; + + // Applies basic vulnerability scanning settings for cluster workloads. + BASIC = 2; + } + // WorkloadConfig defines which actions are enabled for a cluster's workload // configurations. optional WorkloadConfig workload_config = 1; + + // Sets which mode to use for Protect workload vulnerability scanning feature. + optional WorkloadVulnerabilityMode workload_vulnerability_mode = 2; } // Subset of Nodepool message that has defaults. @@ -2124,6 +2164,9 @@ message ClusterUpdate { // The desired Identity Service component configuration. IdentityServiceConfig desired_identity_service_config = 66; + // Enable/Disable private endpoint for the cluster's master. + optional bool desired_enable_private_endpoint = 71; + // The desired network tags that apply to all auto-provisioned node pools // in autopilot clusters and node auto-provisioning enabled clusters. NetworkTags desired_node_pool_auto_config_network_tags = 110; @@ -2131,8 +2174,16 @@ message ClusterUpdate { // Enable/Disable Protect API features for the cluster. optional ProtectConfig desired_protect_config = 112; + // The desired config of Gateway API on this cluster. + GatewayAPIConfig desired_gateway_api_config = 114; + // The desired node pool logging configuration defaults for the cluster. NodePoolLoggingConfig desired_node_pool_logging_config = 116; + + // The desired stack type of the cluster. + // If a stack type is provided and does not match the current stack type of + // the cluster, update will attempt to change the stack type to the new type. + StackType desired_stack_type = 119; } // This operation resource represents operations that may have happened or are @@ -2504,8 +2555,15 @@ message UpdateNodePoolRequest { // Enable or disable gvnic on the node pool. VirtualNIC gvnic = 29; + // Enable or disable NCCL fast socket for the node pool. + FastSocket fast_socket = 31; + // Logging configuration. NodePoolLoggingConfig logging_config = 32; + + // The resource labels for the node pool to use to annotate any related + // Google Compute Engine resources. + ResourceLabels resource_labels = 33; } // SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. @@ -3219,7 +3277,7 @@ message BlueGreenSettings { message StandardRolloutPolicy { // Blue pool size to drain in a batch. oneof update_batch_size { - // Percentage of the bool pool nodes to drain in a batch. + // Percentage of the blue pool nodes to drain in a batch. // The range of this field should be (0.0, 1.0]. float batch_percentage = 1; @@ -4396,6 +4454,32 @@ message NetworkConfig { // ServiceExternalIPsConfig specifies if services with externalIPs field are // blocked or not. ServiceExternalIPsConfig service_external_ips_config = 15; + + // GatewayAPIConfig contains the desired config of Gateway API on this + // cluster. + GatewayAPIConfig gateway_api_config = 16; +} + +// GatewayAPIConfig contains the desired config of Gateway API on this cluster. +message GatewayAPIConfig { + // Channel describes if/how Gateway API should be installed and implemented in + // a cluster. + enum Channel { + // Default value. + CHANNEL_UNSPECIFIED = 0; + + // Gateway API support is disabled + CHANNEL_DISABLED = 1; + + // Gateway API support is enabled, experimental CRDs are installed + CHANNEL_EXPERIMENTAL = 3; + + // Gateway API support is enabled, standard CRDs are installed + CHANNEL_STANDARD = 4; + } + + // The Gateway API release channel to use for Gateway API. + Channel channel = 1; } // Config to block services with externalIPs field. @@ -4685,6 +4769,12 @@ message VirtualNIC { bool enabled = 1; } +// Configuration of Fast Socket feature. +message FastSocket { + // Whether Fast Socket features are enabled in the node pool. + bool enabled = 1; +} + // GetOpenIDConfigRequest gets the OIDC discovery document for the // cluster. See the OpenID Connect Discovery 1.0 specification for details. message GetOpenIDConfigRequest { @@ -5036,6 +5126,15 @@ message LoggingComponentConfig { // workloads WORKLOADS = 2; + + // kube-apiserver + APISERVER = 3; + + // kube-scheduler + SCHEDULER = 4; + + // kube-controller-manager + CONTROLLER_MANAGER = 5; } // Select components to collect logs. An empty set would disable all logging. @@ -5119,3 +5218,15 @@ enum DatapathProvider { // for more. ADVANCED_DATAPATH = 2; } + +// Possible values for IP stack type +enum StackType { + // By default, the clusters will be IPV4 only + STACK_TYPE_UNSPECIFIED = 0; + + // The value used if the cluster is a IPV4 only + IPV4 = 1; + + // The value used if the cluster is a dual stack cluster + IPV4_IPV6 = 2; +} diff --git a/google/container/v1beta1/container_v1beta1.yaml b/google/container/v1beta1/container_v1beta1.yaml index f2dcefecd..5a2d5f0dd 100644 --- a/google/container/v1beta1/container_v1beta1.yaml +++ b/google/container/v1beta1/container_v1beta1.yaml @@ -31,3 +31,6 @@ authentication: oauth: canonical_scopes: |- https://www.googleapis.com/auth/cloud-platform + +publishing: + organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED diff --git a/google/dataflow/v1beta3/BUILD.bazel b/google/dataflow/v1beta3/BUILD.bazel index 1600127cf..7fd47d38e 100644 --- a/google/dataflow/v1beta3/BUILD.bazel +++ b/google/dataflow/v1beta3/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "dataflow_proto", @@ -49,18 +80,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "dataflow_java_proto", deps = [":dataflow_proto"], @@ -77,6 +96,7 @@ java_gapic_library( srcs = [":dataflow_proto_with_info"], gapic_yaml = None, grpc_service_config = "dataflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataflow_v1beta3.yaml", test_deps = [ ":dataflow_java_grpc", @@ -110,6 +130,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-dataflow-v1beta3-java", + include_samples = True, transport = "grpc+rest", deps = [ ":dataflow_java_gapic", @@ -119,17 +140,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "dataflow_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -147,6 +157,7 @@ go_gapic_library( grpc_service_config = "dataflow_grpc_service_config.json", importpath = "cloud.google.com/go/dataflow/apiv1beta3;dataflow", metadata = True, + rest_numeric_enums = True, service_yaml = "dataflow_v1beta3.yaml", transport = "grpc+rest", deps = [ @@ -173,16 +184,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "dataflow_py_gapic", srcs = [":dataflow_proto"], @@ -192,6 +193,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-dataflow-client", ], + rest_numeric_enums = True, transport = "grpc+rest", ) @@ -213,17 +215,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dataflow_php_proto", deps = [":dataflow_proto"], @@ -239,7 +230,9 @@ php_gapic_library( name = "dataflow_php_gapic", srcs = [":dataflow_proto_with_info"], grpc_service_config = "dataflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataflow_v1beta3.yaml", + transport = "grpc+rest", deps = [ ":dataflow_php_grpc", ":dataflow_php_proto", @@ -256,15 +249,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "dataflow_nodejs_gapic", package_name = "@google-cloud/dataflow", @@ -272,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dataflow_grpc_service_config.json", package = "google.dataflow.v1beta3", + rest_numeric_enums = True, service_yaml = "dataflow_v1beta3.yaml", + transport = "grpc+rest", deps = [], ) @@ -284,17 +270,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dataflow_ruby_proto", deps = [":dataflow_proto"], @@ -318,6 +293,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=JobsV1Beta3=Jobs;MessagesV1Beta3=Messages;MetricsV1Beta3=Metrics;SnapshotsV1Beta3=Snapshots", ], grpc_service_config = "dataflow_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Dataflow is a managed service for executing a wide variety of data processing patterns.", ruby_cloud_title = "Dataflow V1beta3", deps = [ @@ -336,17 +312,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dataflow_csharp_proto", deps = [":dataflow_proto"], @@ -363,6 +328,7 @@ csharp_gapic_library( srcs = [":dataflow_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dataflow_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dataflow_v1beta3.yaml", deps = [ ":dataflow_csharp_grpc", @@ -380,15 +346,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "dataflow_cc_proto", deps = [":dataflow_proto"], diff --git a/google/datastore/admin/v1/BUILD.bazel b/google/datastore/admin/v1/BUILD.bazel index a1fad9e52..aff19a8d2 100644 --- a/google/datastore/admin/v1/BUILD.bazel +++ b/google/datastore/admin/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "admin_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "admin_java_proto", deps = [":admin_proto"], @@ -70,6 +89,7 @@ java_gapic_library( srcs = [":admin_proto_with_info"], gapic_yaml = "datastore_admin_gapic.yaml", grpc_service_config = "datastore_admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", test_deps = [ ":admin_java_grpc", @@ -93,6 +113,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-datastore-admin-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":admin_java_gapic", @@ -102,17 +123,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "admin_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -130,13 +140,14 @@ go_gapic_library( grpc_service_config = "datastore_admin_grpc_service_config.json", importpath = "cloud.google.com/go/datastore/admin/apiv1;admin", metadata = True, + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", transport = "grpc+rest", deps = [ ":admin_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -158,21 +169,12 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "admin_py_gapic", srcs = [":admin_proto"], grpc_service_config = "datastore_admin_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud, python-gapic-name=datastore-admin"], + rest_numeric_enums = True, transport = "grpc", ) @@ -194,17 +196,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_php_proto", deps = [":admin_proto"], @@ -220,7 +211,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "datastore_admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -237,15 +230,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "admin_nodejs_gapic", package_name = "@google-cloud/datastore-admin", @@ -253,7 +237,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datastore_admin_grpc_service_config.json", package = "google.datastore.admin.v1", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -265,17 +251,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_ruby_proto", deps = [":admin_proto"], @@ -299,6 +274,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-datastore", ], grpc_service_config = "datastore_admin_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Firestore in Datastore mode is a NoSQL document database built for automatic scaling, high performance, and ease of application development.", ruby_cloud_title = "Firestore in Datastore mode Admin V1", deps = [ @@ -317,17 +293,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "admin_csharp_proto", deps = [":admin_proto"], @@ -344,6 +309,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datastore_admin_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", deps = [ ":admin_csharp_grpc", @@ -361,15 +327,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "admin_cc_proto", deps = [":admin_proto"], diff --git a/google/datastore/v1/BUILD.bazel b/google/datastore/v1/BUILD.bazel index b36817d4a..d56e721cd 100644 --- a/google/datastore/v1/BUILD.bazel +++ b/google/datastore/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"]) @@ -12,6 +21,7 @@ load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") proto_library( name = "datastore_proto", srcs = [ + "aggregation_result.proto", "datastore.proto", "entity.proto", "query.proto", @@ -63,12 +73,15 @@ java_gapic_library( srcs = [":datastore_proto_with_info"], gapic_yaml = "datastore_gapic.yaml", grpc_service_config = "datastore_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "datastore_v1.yaml", test_deps = [ ":datastore_java_grpc", ], transport = "grpc+rest", deps = [ ":datastore_java_proto", + "//google/api:api_java_proto", ], ) @@ -84,6 +97,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-datastore-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":datastore_java_gapic", @@ -120,14 +134,16 @@ go_gapic_library( srcs = [":datastore_proto_with_info"], grpc_service_config = "datastore_grpc_service_config.json", importpath = "cloud.google.com/go/datastore/apiv1;datastore", + metadata = True, + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", transport = "grpc+rest", deps = [ ":datastore_go_proto", "//google/longrunning:longrunning_go_gapic", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -143,6 +159,7 @@ go_gapic_assembly_pkg( name = "gapi-cloud-datastore-v1-go", deps = [ ":datastore_go_gapic", + ":datastore_go_gapic_srcjar-metadata.srcjar", ":datastore_go_gapic_srcjar-test.srcjar", ":datastore_go_proto", ], @@ -163,7 +180,11 @@ py_gapic_library( srcs = [":datastore_proto"], grpc_service_config = "datastore_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud"], + rest_numeric_enums = True, + service_yaml = "datastore_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -176,6 +197,7 @@ py_test( deps = [":datastore_py_gapic"], ) +# Open Source Packages py_gapic_assembly_pkg( name = "datastore-v1-py", deps = [ @@ -208,7 +230,10 @@ php_grpc_library( php_gapic_library( name = "datastore_php_gapic", srcs = [":datastore_proto_with_info"], + grpc_service_config = "datastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", + transport = "grpc+rest", deps = [ ":datastore_php_grpc", ":datastore_php_proto", @@ -241,10 +266,12 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "datastore_grpc_service_config.json", main_service = "datastore", + mixins = "google.longrunning.Operations", package = "google.datastore.v1", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", + transport = "grpc+rest", deps = [], - mixins = "google.longrunning.Operations", ) nodejs_gapic_assembly_pkg( @@ -281,15 +308,17 @@ ruby_cloud_gapic_library( name = "datastore_ruby_gapic", srcs = [":datastore_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-datastore-v1", - "ruby-cloud-env-prefix=DATASTORE", - "ruby-cloud-product-url=https://cloud.google.com/datastore", "ruby-cloud-api-id=datastore.googleapis.com", "ruby-cloud-api-shortname=datastore", + "ruby-cloud-env-prefix=DATASTORE", + "ruby-cloud-gem-name=google-cloud-datastore-v1", + "ruby-cloud-product-url=https://cloud.google.com/datastore", ], grpc_service_config = "datastore_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Firestore in Datastore mode is a NoSQL document database built for automatic scaling, high performance, and ease of application development.", ruby_cloud_title = "Firestore in Datastore mode V1", + service_yaml = "datastore_v1.yaml", deps = [ ":datastore_ruby_grpc", ":datastore_ruby_proto", @@ -333,6 +362,7 @@ csharp_gapic_library( srcs = [":datastore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "datastore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "datastore_v1.yaml", deps = [ ":datastore_csharp_grpc", diff --git a/google/datastore/v1/aggregation_result.proto b/google/datastore/v1/aggregation_result.proto new file mode 100644 index 000000000..e9c1d4940 --- /dev/null +++ b/google/datastore/v1/aggregation_result.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.datastore.v1; + +import "google/datastore/v1/entity.proto"; +import "google/datastore/v1/query.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.Datastore.V1"; +option go_package = "google.golang.org/genproto/googleapis/datastore/v1;datastore"; +option java_multiple_files = true; +option java_outer_classname = "AggregationResultProto"; +option java_package = "com.google.datastore.v1"; +option php_namespace = "Google\\Cloud\\Datastore\\V1"; +option ruby_package = "Google::Cloud::Datastore::V1"; + +// The result of a single bucket from a Datastore aggregation query. +// +// The keys of `aggregate_properties` are the same for all results in an +// aggregation query, unlike entity queries which can have different fields +// present for each result. +message AggregationResult { + // The result of the aggregation functions, ex: `COUNT(*) AS total_entities`. + // + // The key is the [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] + // assigned to the aggregation function on input and the size of this map + // equals the number of aggregation functions in the query. + map aggregate_properties = 2; +} + +// A batch of aggregation results produced by an aggregation query. +message AggregationResultBatch { + // The aggregation results for this batch. + repeated AggregationResult aggregation_results = 1; + + // The state of the query after the current batch. + // Only COUNT(*) aggregations are supported in the initial launch. Therefore, + // expected result type is limited to `NO_MORE_RESULTS`. + QueryResultBatch.MoreResultsType more_results = 2; + + // Read timestamp this batch was returned from. + // + // In a single transaction, subsequent query result batches for the same query + // can have a greater timestamp. Each batch's read timestamp + // is valid for all preceding batches. + google.protobuf.Timestamp read_time = 3; +} diff --git a/google/datastore/v1/datastore.proto b/google/datastore/v1/datastore.proto index 4c8ac7626..e891e058f 100644 --- a/google/datastore/v1/datastore.proto +++ b/google/datastore/v1/datastore.proto @@ -19,6 +19,7 @@ package google.datastore.v1; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/datastore/v1/aggregation_result.proto"; import "google/datastore/v1/entity.proto"; import "google/datastore/v1/query.proto"; import "google/protobuf/timestamp.proto"; @@ -61,6 +62,14 @@ service Datastore { }; } + // Runs an aggregation query. + rpc RunAggregationQuery(RunAggregationQueryRequest) returns (RunAggregationQueryResponse) { + option (google.api.http) = { + post: "/v1/projects/{project_id}:runAggregationQuery" + body: "*" + }; + } + // Begins a new transaction. rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse) { option (google.api.http) = { @@ -189,6 +198,45 @@ message RunQueryResponse { Query query = 2; } +// The request for [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery]. +message RunAggregationQueryRequest { + // Required. The ID of the project against which to make the request. + string project_id = 8 [(google.api.field_behavior) = REQUIRED]; + + // The ID of the database against which to make the request. + // + // '(default)' is not allowed; please use empty string '' to refer the default + // database. + string database_id = 9; + + // Entities are partitioned into subsets, identified by a partition ID. + // Queries are scoped to a single partition. + // This partition ID is normalized with the standard default context + // partition ID. + PartitionId partition_id = 2; + + // The options for this query. + ReadOptions read_options = 1; + + // The type of query. + oneof query_type { + // The query to run. + AggregationQuery aggregation_query = 3; + + // The GQL query to run. This query must be an aggregation query. + GqlQuery gql_query = 7; + } +} + +// The response for [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery]. +message RunAggregationQueryResponse { + // A batch of aggregation results. Always present. + AggregationResultBatch batch = 1; + + // The parsed form of the `GqlQuery` from the request, if it was set. + AggregationQuery query = 2; +} + // The request for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction]. message BeginTransactionRequest { // Required. The ID of the project against which to make the request. diff --git a/google/datastore/v1/query.proto b/google/datastore/v1/query.proto index cbe44932d..b16806ef2 100644 --- a/google/datastore/v1/query.proto +++ b/google/datastore/v1/query.proto @@ -118,6 +118,93 @@ message Query { google.protobuf.Int32Value limit = 12; } +// Datastore query for running an aggregation over a [Query][google.datastore.v1.Query]. +message AggregationQuery { + // Defines a aggregation that produces a single result. + message Aggregation { + // Count of entities that match the query. + // + // The `COUNT(*)` aggregation function operates on the entire entity + // so it does not require a field reference. + message Count { + // Optional. Optional constraint on the maximum number of entities to count. + // + // This provides a way to set an upper bound on the number of entities + // to scan, limiting latency and cost. + // + // Unspecified is interpreted as no bound. + // + // If a zero value is provided, a count result of zero should always be + // expected. + // + // High-Level Example: + // + // ``` + // AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); + // ``` + // + // Requires: + // + // * Must be non-negative when present. + google.protobuf.Int64Value up_to = 1 [(google.api.field_behavior) = OPTIONAL]; + } + + // The type of aggregation to perform, required. + oneof operator { + // Count aggregator. + Count count = 1; + } + + // Optional. Optional name of the property to store the result of the aggregation. + // + // If not provided, Datastore will pick a default name following the format + // `property_`. For example: + // + // ``` + // AGGREGATE + // COUNT_UP_TO(1) AS count_up_to_1, + // COUNT_UP_TO(2), + // COUNT_UP_TO(3) AS count_up_to_3, + // COUNT_UP_TO(4) + // OVER ( + // ... + // ); + // ``` + // + // becomes: + // + // ``` + // AGGREGATE + // COUNT_UP_TO(1) AS count_up_to_1, + // COUNT_UP_TO(2) AS property_1, + // COUNT_UP_TO(3) AS count_up_to_3, + // COUNT_UP_TO(4) AS property_2 + // OVER ( + // ... + // ); + // ``` + // + // Requires: + // + // * Must be unique across all aggregation aliases. + // * Conform to [entity property name][google.datastore.v1.Entity.properties] limitations. + string alias = 7 [(google.api.field_behavior) = OPTIONAL]; + } + + // The base query to aggregate over. + oneof query_type { + // Nested query for aggregation + Query nested_query = 1; + } + + // Optional. Series of aggregations to apply over the results of the `nested_query`. + // + // Requires: + // + // * A minimum of one and maximum of five aggregations per query. + repeated Aggregation aggregations = 3 [(google.api.field_behavior) = OPTIONAL]; +} + // A representation of a kind. message KindExpression { // The name of the kind. diff --git a/google/devtools/artifactregistry/v1/BUILD.bazel b/google/devtools/artifactregistry/v1/BUILD.bazel index 4c5719574..ac68f3652 100644 --- a/google/devtools/artifactregistry/v1/BUILD.bazel +++ b/google/devtools/artifactregistry/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "artifactregistry_proto", @@ -56,18 +87,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "artifactregistry_java_proto", deps = [":artifactregistry_proto"], @@ -84,6 +103,7 @@ java_gapic_library( srcs = [":artifactregistry_proto_with_info"], gapic_yaml = None, grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1.yaml", test_deps = [ ":artifactregistry_java_grpc", @@ -109,6 +129,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-artifactregistry-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":artifactregistry_java_gapic", @@ -118,17 +139,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "artifactregistry_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -148,14 +158,15 @@ go_gapic_library( grpc_service_config = "artifactregistry_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/artifactregistry/apiv1;artifactregistry", metadata = True, + rest_numeric_enums = True, service_yaml = "artifactregistry_v1.yaml", transport = "grpc+rest", deps = [ ":artifactregistry_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", + "@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", ], ) @@ -178,16 +189,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "artifactregistry_py_gapic", srcs = [":artifactregistry_proto"], @@ -197,6 +198,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-artifact-registry", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -221,17 +223,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_php_proto", deps = [":artifactregistry_proto"], @@ -247,7 +238,9 @@ php_gapic_library( name = "artifactregistry_php_gapic", srcs = [":artifactregistry_proto_with_info"], grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1.yaml", + transport = "grpc+rest", deps = [ ":artifactregistry_php_grpc", ":artifactregistry_php_proto", @@ -264,15 +257,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "artifactregistry_nodejs_gapic", package_name = "@google-cloud/artifact-registry", @@ -280,7 +264,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "artifactregistry_grpc_service_config.json", package = "google.devtools.artifactregistry.v1", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -292,17 +278,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_ruby_proto", deps = [":artifactregistry_proto"], @@ -325,6 +300,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/artifact-registry/", ], grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Artifact Registry stores and manages build artifacts in a scalable and integrated service built on Google infrastructure.", ruby_cloud_title = "Artifact Registry V1", deps = [ @@ -343,17 +319,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_csharp_proto", deps = [":artifactregistry_proto"], @@ -370,6 +335,7 @@ csharp_gapic_library( srcs = [":artifactregistry_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1.yaml", deps = [ ":artifactregistry_csharp_grpc", @@ -387,15 +353,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "artifactregistry_cc_proto", deps = [":artifactregistry_proto"], diff --git a/google/devtools/artifactregistry/v1beta2/BUILD.bazel b/google/devtools/artifactregistry/v1beta2/BUILD.bazel index 60fb5c26b..e3e88a5e6 100644 --- a/google/devtools/artifactregistry/v1beta2/BUILD.bazel +++ b/google/devtools/artifactregistry/v1beta2/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "artifactregistry_proto", @@ -55,18 +84,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "artifactregistry_java_proto", deps = [":artifactregistry_proto"], @@ -82,6 +99,7 @@ java_gapic_library( name = "artifactregistry_java_gapic", srcs = [":artifactregistry_proto_with_info"], grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":artifactregistry_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -105,6 +123,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-artifactregistry-v1beta2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":artifactregistry_java_gapic", @@ -114,17 +133,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "artifactregistry_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -143,14 +151,15 @@ go_gapic_library( srcs = [":artifactregistry_proto_with_info"], grpc_service_config = "artifactregistry_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/artifactregistry/apiv1beta2;artifactregistry", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1beta2.yaml", transport = "grpc+rest", deps = [ ":artifactregistry_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -171,16 +180,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "artifactregistry_py_gapic", srcs = [":artifactregistry_proto"], @@ -190,6 +189,7 @@ py_gapic_library( "python-gapic-name=artifactregistry", "warehouse-package-name=google-cloud-artifact-registry", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -214,17 +214,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_php_proto", deps = [":artifactregistry_proto"], @@ -240,7 +229,9 @@ php_gapic_library( name = "artifactregistry_php_gapic", srcs = [":artifactregistry_proto_with_info"], grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1beta2.yaml", + transport = "grpc+rest", deps = [ ":artifactregistry_php_grpc", ":artifactregistry_php_proto", @@ -257,15 +248,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "artifactregistry_nodejs_gapic", package_name = "@google-cloud/artifact-registry", @@ -273,7 +255,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "artifactregistry_grpc_service_config.json", package = "google.devtools.artifactregistry.v1beta2", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1beta2.yaml", + transport = "grpc+rest", deps = [], ) @@ -285,17 +269,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_ruby_proto", deps = [":artifactregistry_proto"], @@ -318,6 +291,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=artifactregistry", ], grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Artifact Registry stores and manages build artifacts in a scalable and integrated service built on Google infrastructure.", ruby_cloud_title = "Artifact Registry V1beta2", deps = [ @@ -336,17 +310,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "artifactregistry_csharp_proto", deps = [":artifactregistry_proto"], @@ -363,6 +326,7 @@ csharp_gapic_library( srcs = [":artifactregistry_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "artifactregistry_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "artifactregistry_v1beta2.yaml", deps = [ ":artifactregistry_csharp_grpc", diff --git a/google/devtools/build/v1/BUILD.bazel b/google/devtools/build/v1/BUILD.bazel index 542ca78f2..702ed4175 100644 --- a/google/devtools/build/v1/BUILD.bazel +++ b/google/devtools/build/v1/BUILD.bazel @@ -9,14 +9,44 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "build_proto", @@ -45,18 +75,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "build_java_proto", deps = [":build_proto"], @@ -73,6 +91,7 @@ java_gapic_library( srcs = [":build_proto_with_info"], gapic_yaml = "buildeventservice_gapic.yaml", grpc_service_config = "buildeventservice_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":build_java_grpc", ], @@ -94,6 +113,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-build-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":build_java_gapic", @@ -103,17 +123,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "build_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -129,7 +138,9 @@ go_gapic_library( srcs = [":build_proto_with_info"], grpc_service_config = "buildeventservice_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/build/apiv1;build", + rest_numeric_enums = False, service_yaml = "buildeventservice_v1.yaml", + transport = "grpc", deps = [ ":build_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", @@ -153,19 +164,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "build_py_gapic", srcs = [":build_proto"], grpc_service_config = "buildeventservice_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -187,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "build_php_proto", deps = [":build_proto"], @@ -213,6 +205,8 @@ php_gapic_library( name = "build_php_gapic", srcs = [":build_proto_with_info"], grpc_service_config = "buildeventservice_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":build_php_grpc", ":build_php_proto", @@ -229,22 +223,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "build_nodejs_gapic", src = ":build_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "buildeventservice_grpc_service_config.json", package = "google.devtools.build.v1", + rest_numeric_enums = False, service_yaml = "buildeventservice_v1.yaml", + transport = "grpc", deps = [], ) @@ -256,17 +243,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "build_ruby_proto", deps = [":build_proto"], @@ -282,6 +258,7 @@ ruby_cloud_gapic_library( name = "build_ruby_gapic", srcs = [":build_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-build-v1"], + rest_numeric_enums = False, deps = [ ":build_ruby_grpc", ":build_ruby_proto", @@ -298,17 +275,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "build_csharp_proto", deps = [":build_proto"], @@ -325,6 +291,7 @@ csharp_gapic_library( srcs = [":build_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "buildeventservice_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "buildeventservice_v1.yaml", deps = [ ":build_csharp_grpc", @@ -342,15 +309,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "build_cc_proto", deps = [":build_proto"], diff --git a/google/devtools/build/v1/build_events.proto b/google/devtools/build/v1/build_events.proto index c3bde2129..93a045069 100644 --- a/google/devtools/build/v1/build_events.proto +++ b/google/devtools/build/v1/build_events.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. @@ -104,7 +104,8 @@ message BuildEvent { FinishType type = 1; } - // The timestamp of this event. + // This should be precisely the time when this event happened, and not when + // the event proto was created or sent. google.protobuf.Timestamp event_time = 1; // ////////////////////////////////////////////////////////////////////////// diff --git a/google/devtools/build/v1/build_status.proto b/google/devtools/build/v1/build_status.proto index ef9c441fe..94cee6899 100644 --- a/google/devtools/build/v1/build_status.proto +++ b/google/devtools/build/v1/build_status.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. @@ -16,8 +16,8 @@ syntax = "proto3"; package google.devtools.build.v1; -import "google/protobuf/wrappers.proto"; import "google/protobuf/any.proto"; +import "google/protobuf/wrappers.proto"; option cc_enable_arenas = true; option go_package = "google.golang.org/genproto/googleapis/devtools/build/v1;build"; @@ -69,6 +69,9 @@ message BuildStatus { // Might not be available in some cases, e.g., a build timeout. google.protobuf.Int32Value build_tool_exit_code = 4; + // Human-readable error message. Do not use for programmatic purposes. + string error_message = 5; + // Fine-grained diagnostic information to complement the status. google.protobuf.Any details = 2; } diff --git a/google/devtools/build/v1/publish_build_event.proto b/google/devtools/build/v1/publish_build_event.proto index 687f5da2e..42fb4487a 100644 --- a/google/devtools/build/v1/publish_build_event.proto +++ b/google/devtools/build/v1/publish_build_event.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. @@ -47,39 +47,41 @@ option php_namespace = "Google\\Cloud\\Build\\V1"; // more than one build tool stream for an invocation attempt of a build. service PublishBuildEvent { option (google.api.default_host) = "buildeventservice.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"; // Publish a build event stating the new state of a build (typically from the - // build queue). The BuildEnqueued event must be publishd before all other + // build queue). The BuildEnqueued event must be published before all other // events for the same build ID. // // The backend will persist the event and deliver it to registered frontend // jobs immediately without batching. // // The commit status of the request is reported by the RPC's util_status() - // function. The error code is the canoncial error code defined in + // function. The error code is the canonical error code defined in // //util/task/codes.proto. - rpc PublishLifecycleEvent(PublishLifecycleEventRequest) - returns (google.protobuf.Empty) { + rpc PublishLifecycleEvent(PublishLifecycleEventRequest) returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/projects/{project_id=*}/lifecycleEvents:publish" body: "*" - additional_bindings { post: "/v1/lifecycleEvents:publish" body: "*" } + additional_bindings { + post: "/v1/lifecycleEvents:publish" + body: "*" + } }; } // Publish build tool events belonging to the same stream to a backend job // using bidirectional streaming. - rpc PublishBuildToolEventStream(stream PublishBuildToolEventStreamRequest) - returns (stream PublishBuildToolEventStreamResponse) { + rpc PublishBuildToolEventStream(stream PublishBuildToolEventStreamRequest) returns (stream PublishBuildToolEventStreamResponse) { option (google.api.http) = { post: "/v1/projects/{project_id=*}/events:publish" body: "*" - additional_bindings { post: "/v1/events:publish" body: "*" } + additional_bindings { + post: "/v1/events:publish" + body: "*" + } }; - option (google.api.method_signature) = - "ordered_build_event,notification_keywords,project_id"; + option (google.api.method_signature) = "ordered_build_event,notification_keywords,project_id"; } } @@ -105,8 +107,8 @@ message PublishLifecycleEventRequest { // The interactivity of this build. ServiceLevel service_level = 1; - // Required. The lifecycle build event. If this is a build tool event, the RPC - // will fail with INVALID_REQUEST. + // Required. The lifecycle build event. If this is a build tool event, the RPC will fail + // with INVALID_REQUEST. OrderedBuildEvent build_event = 2 [(google.api.field_behavior) = REQUIRED]; // If the next event for this build or invocation (depending on the event @@ -165,8 +167,7 @@ message OrderedBuildEvent { message PublishBuildToolEventStreamRequest { // Required. The build event with position info. // New publishing clients should use this field rather than the 3 above. - OrderedBuildEvent ordered_build_event = 4 - [(google.api.field_behavior) = REQUIRED]; + OrderedBuildEvent ordered_build_event = 4 [(google.api.field_behavior) = REQUIRED]; // The keywords to be attached to the notification which notifies the start // of a new build event stream. BES only reads this field when sequence_number diff --git a/google/devtools/cloudbuild/v1/BUILD.bazel b/google/devtools/cloudbuild/v1/BUILD.bazel index af02d0f46..0f1fa7990 100644 --- a/google/devtools/cloudbuild/v1/BUILD.bazel +++ b/google/devtools/cloudbuild/v1/BUILD.bazel @@ -6,6 +6,8 @@ load("@rules_proto//proto:defs.bzl", "proto_library") load( "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", "csharp_gapic_assembly_pkg", "csharp_gapic_library", "csharp_grpc_library", @@ -21,6 +23,8 @@ load( "java_proto_library", "nodejs_gapic_assembly_pkg", "nodejs_gapic_library", + "php_grpc_library", + "php_proto_library", "proto_library_with_info", "py_gapic_assembly_pkg", "py_gapic_library", @@ -77,6 +81,7 @@ java_gapic_library( srcs = [":cloudbuild_proto_with_info"], gapic_yaml = "cloudbuild_gapic.yaml", grpc_service_config = "cloudbuild_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":cloudbuild_java_grpc", ], @@ -99,6 +104,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-cloudbuild-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":cloudbuild_java_gapic", @@ -125,14 +131,15 @@ go_gapic_library( srcs = [":cloudbuild_proto_with_info"], grpc_service_config = "cloudbuild_grpc_service_config.json", importpath = "cloud.google.com/go/cloudbuild/apiv1;cloudbuild", + rest_numeric_enums = True, service_yaml = "cloudbuild_v1.yaml", transport = "grpc+rest", deps = [ ":cloudbuild_go_proto", "//google/api:httpbody_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -165,6 +172,7 @@ py_gapic_library( "warehouse-package-name=google-cloud-build", "python-gapic-namespace=google.cloud.devtools", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -185,17 +193,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudbuild_php_proto", deps = [":cloudbuild_proto"], @@ -228,15 +225,6 @@ php_grpc_library( # ], #) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "cloudbuild_nodejs_gapic", package_name = "@google-cloud/cloudbuild", @@ -244,7 +232,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudbuild_grpc_service_config.json", package = "google.devtools.cloudbuild.v1", + rest_numeric_enums = True, service_yaml = "cloudbuild_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -282,6 +272,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudbuild", ], grpc_service_config = "cloudbuild_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Build is a service that executes your builds on Google Cloud Platform infrastructure. Cloud Build can import source code from Google Cloud Storage, Cloud Source Repositories, GitHub, or Bitbucket, execute a build to your specifications, and produce artifacts such as Docker containers or Java archives.", ruby_cloud_title = "Cloud Build V1", deps = [ @@ -320,6 +311,7 @@ csharp_gapic_library( srcs = [":cloudbuild_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudbuild_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudbuild_v1.yaml", deps = [ ":cloudbuild_csharp_grpc", @@ -337,15 +329,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "cloudbuild_cc_proto", deps = [":cloudbuild_proto"], diff --git a/google/devtools/cloudbuild/v1/cloudbuild.proto b/google/devtools/cloudbuild/v1/cloudbuild.proto index 3f980c7b1..c007e65b4 100644 --- a/google/devtools/cloudbuild/v1/cloudbuild.proto +++ b/google/devtools/cloudbuild/v1/cloudbuild.proto @@ -504,6 +504,30 @@ message BuiltImage { TimeSpan push_timing = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } +// Artifact uploaded using the PythonPackage directive. +message UploadedPythonPackage { + // URI of the uploaded artifact. + string uri = 1; + + // Hash types and values of the Python Artifact. + FileHashes file_hashes = 2; + + // Output only. Stores timing information for pushing the specified artifact. + TimeSpan push_timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + +// A Maven artifact uploaded using the MavenArtifact directive. +message UploadedMavenArtifact { + // URI of the uploaded artifact. + string uri = 1; + + // Hash types and values of the Maven Artifact. + FileHashes file_hashes = 2; + + // Output only. Stores timing information for pushing the specified artifact. + TimeSpan push_timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; +} + // A step in the build pipeline. message BuildStep { // Required. The name of the container image that will run this particular @@ -598,6 +622,21 @@ message BuildStep { // as the build progresses. Build.Status status = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Allow this build step to fail without failing the entire build. + // + // If false, the entire build will fail if this step fails. Otherwise, the + // build will succeed, but this step will still have a failure status. + // Error information will be reported in the failure_detail field. + bool allow_failure = 14; + + // Output only. Return code from running the step. + int32 exit_code = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Allow this build step to fail without failing the entire build if and + // only if the exit code is one of the specified codes. If allow_failure + // is also specified, this field will take precedence. + repeated int32 allow_exit_codes = 18; + // A shell script to be executed in the step. // // When script is provided, the user cannot specify the entrypoint or args. @@ -645,6 +684,12 @@ message Results { // Time to push all non-container artifacts. TimeSpan artifact_timing = 7; + + // Python artifacts uploaded to Artifact Registry at the end of the build. + repeated UploadedPythonPackage python_packages = 8; + + // Maven artifacts uploaded to Artifact Registry at the end of the build. + repeated UploadedMavenArtifact maven_artifacts = 9; } // An artifact that was uploaded during a build. This @@ -938,6 +983,54 @@ message Artifacts { TimeSpan timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } + // A Maven artifact to upload to Artifact Registry upon successful completion + // of all build steps. + message MavenArtifact { + // Artifact Registry repository, in the form + // "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" + // + // Artifact in the workspace specified by path will be uploaded to + // Artifact Registry with this location as a prefix. + string repository = 1; + + // Path to an artifact in the build's workspace to be uploaded to + // Artifact Registry. + // This can be either an absolute path, + // e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar + // or a relative path from /workspace, + // e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + string path = 2; + + // Maven `artifactId` value used when uploading the artifact to Artifact + // Registry. + string artifact_id = 3; + + // Maven `groupId` value used when uploading the artifact to Artifact + // Registry. + string group_id = 4; + + // Maven `version` value used when uploading the artifact to Artifact + // Registry. + string version = 5; + } + + // Python package to upload to Artifact Registry upon successful completion + // of all build steps. A package can encapsulate multiple objects to be + // uploaded to a single repository. + message PythonPackage { + // Artifact Registry repository, in the form + // "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" + // + // Files in the workspace matching any path pattern will be uploaded to + // Artifact Registry with this location as a prefix. + string repository = 1; + + // Path globs used to match files in the build's workspace. For Python/ + // Twine, this is usually `dist/*`, and sometimes additionally an `.asc` + // file. + repeated string paths = 2; + } + // A list of images to be pushed upon the successful completion of all build // steps. // @@ -961,6 +1054,24 @@ message Artifacts { // // If any objects fail to be pushed, the build is marked FAILURE. ArtifactObjects objects = 2; + + // A list of Maven artifacts to be uploaded to Artifact Registry upon + // successful completion of all build steps. + // + // Artifacts in the workspace matching specified paths globs will be uploaded + // to the specified Artifact Registry repository using the builder service + // account's credentials. + // + // If any artifacts fail to be pushed, the build is marked FAILURE. + repeated MavenArtifact maven_artifacts = 3; + + // A list of Python packages to be uploaded to Artifact Registry upon + // successful completion of all build steps. + // + // The build service account credentials will be used to perform the upload. + // + // If any objects fail to be pushed, the build is marked FAILURE. + repeated PythonPackage python_packages = 5; } // Start and end times for a build execution phase. diff --git a/google/devtools/clouddebugger/v2/BUILD.bazel b/google/devtools/clouddebugger/v2/BUILD.bazel index a7697cddf..436cc996e 100644 --- a/google/devtools/clouddebugger/v2/BUILD.bazel +++ b/google/devtools/clouddebugger/v2/BUILD.bazel @@ -1,13 +1,43 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "clouddebugger_proto", @@ -35,18 +65,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "clouddebugger_java_proto", deps = [":clouddebugger_proto"], @@ -63,6 +81,7 @@ java_gapic_library( srcs = [":clouddebugger_proto_with_info"], gapic_yaml = "clouddebugger_gapic.yaml", grpc_service_config = "clouddebugger_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":clouddebugger_java_grpc", ], @@ -86,6 +105,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-clouddebugger-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":clouddebugger_java_gapic", @@ -95,17 +115,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "clouddebugger_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -122,6 +131,7 @@ go_gapic_library( srcs = [":clouddebugger_proto_with_info"], grpc_service_config = "clouddebugger_grpc_service_config.json", importpath = "cloud.google.com/go/debugger/apiv2;clouddebugger", + rest_numeric_enums = True, service_yaml = "clouddebugger_v2.yaml", transport = "grpc+rest", deps = [ @@ -146,15 +156,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "clouddebugger_py_gapic", srcs = [":clouddebugger_proto"], @@ -164,6 +165,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=debugger", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -187,17 +189,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouddebugger_php_proto", deps = [":clouddebugger_proto"], @@ -213,6 +204,8 @@ php_gapic_library( name = "clouddebugger_php_gapic", srcs = [":clouddebugger_proto_with_info"], grpc_service_config = "clouddebugger_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":clouddebugger_php_grpc", ":clouddebugger_php_proto", @@ -233,22 +226,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "clouddebugger_nodejs_gapic", src = ":clouddebugger_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "clouddebugger_grpc_service_config.json", package = "google.devtools.clouddebugger.v2", + rest_numeric_enums = True, service_yaml = "clouddebugger_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -261,17 +247,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouddebugger_ruby_proto", deps = [":clouddebugger_proto"], @@ -295,6 +270,7 @@ ruby_cloud_gapic_library( "ruby-cloud-service-override=Controller2=Controller;Debugger2=Debugger", ], grpc_service_config = "clouddebugger_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Debugger API allows applications to interact with the Google Cloud Debugger backends. It provides two interfaces: the Debugger interface and the Controller interface. The Controller interface allows you to implement an agent that sends state data -- for example, the value of program variables and the call stack -- to Cloud Debugger when the application is running. The Debugger interface allows you to implement a Cloud Debugger client that allows users to set and delete the breakpoints at which the state data is collected, as well as read the data that is captured.", ruby_cloud_title = "Cloud Debugger V2", deps = [ @@ -317,17 +293,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouddebugger_csharp_proto", deps = [":clouddebugger_proto"], @@ -344,6 +309,7 @@ csharp_gapic_library( srcs = [":clouddebugger_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "clouddebugger_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "clouddebugger_v2.yaml", deps = [ ":clouddebugger_csharp_grpc", @@ -363,15 +329,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "clouddebugger_cc_proto", deps = [":clouddebugger_proto"], diff --git a/google/devtools/clouderrorreporting/v1beta1/BUILD.bazel b/google/devtools/clouderrorreporting/v1beta1/BUILD.bazel index 91517c337..8a26703bd 100644 --- a/google/devtools/clouderrorreporting/v1beta1/BUILD.bazel +++ b/google/devtools/clouderrorreporting/v1beta1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "clouderrorreporting_proto", @@ -44,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "clouderrorreporting_java_proto", deps = [":clouderrorreporting_proto"], @@ -71,6 +88,7 @@ java_gapic_library( name = "clouderrorreporting_java_gapic", srcs = [":clouderrorreporting_proto_with_info"], grpc_service_config = "errorreporting_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":clouderrorreporting_java_grpc", ], @@ -96,6 +114,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-clouderrorreporting-v1beta1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":clouderrorreporting_java_gapic", @@ -105,17 +124,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "clouderrorreporting_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -132,6 +140,7 @@ go_gapic_library( srcs = [":clouderrorreporting_proto_with_info"], grpc_service_config = "errorreporting_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/clouderrorreporting/apiv1beta1;clouderrorreporting", + rest_numeric_enums = True, service_yaml = "clouderrorreporting_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -157,16 +166,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "clouderrorreporting_py_gapic", srcs = [":clouderrorreporting_proto"], @@ -174,7 +173,9 @@ py_gapic_library( opt_args = [ "python-gapic-name=errorreporting", "python-gapic-namespace=google.cloud", + "warehouse-package-name=google-cloud-error-reporting", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -196,17 +197,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouderrorreporting_php_proto", deps = [":clouderrorreporting_proto"], @@ -222,6 +212,8 @@ php_gapic_library( name = "clouderrorreporting_php_gapic", srcs = [":clouderrorreporting_proto_with_info"], grpc_service_config = "errorreporting_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":clouderrorreporting_php_grpc", ":clouderrorreporting_php_proto", @@ -238,15 +230,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "clouderrorreporting_nodejs_gapic", package_name = "@google-cloud/clouderrorreporting", @@ -254,7 +237,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "errorreporting_grpc_service_config.json", package = "google.devtools.clouderrorreporting.v1beta1", + rest_numeric_enums = True, service_yaml = "clouderrorreporting_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -266,17 +251,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouderrorreporting_ruby_proto", deps = [":clouderrorreporting_proto"], @@ -299,6 +273,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=clouderrorreporting", ], grpc_service_config = "errorreporting_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Error Reporting API provides a simple endpoint to report errors from your running service, and read access to error groups and their associated errors.", ruby_cloud_title = "Error Reporting V1beta1", deps = [ @@ -317,17 +292,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "clouderrorreporting_csharp_proto", deps = [":clouderrorreporting_proto"], @@ -344,6 +308,7 @@ csharp_gapic_library( srcs = [":clouderrorreporting_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "errorreporting_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "clouderrorreporting_v1beta1.yaml", deps = [ ":clouderrorreporting_csharp_grpc", diff --git a/google/devtools/cloudprofiler/v2/BUILD.bazel b/google/devtools/cloudprofiler/v2/BUILD.bazel index 9cffd879e..261d026d7 100644 --- a/google/devtools/cloudprofiler/v2/BUILD.bazel +++ b/google/devtools/cloudprofiler/v2/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "cloudprofiler_proto", @@ -39,18 +70,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "cloudprofiler_java_proto", deps = [":cloudprofiler_proto"], @@ -66,6 +85,7 @@ java_gapic_library( name = "cloudprofiler_java_gapic", srcs = [":cloudprofiler_proto_with_info"], grpc_service_config = "cloudprofiler_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":cloudprofiler_java_grpc", ], @@ -87,6 +107,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-cloudprofiler-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":cloudprofiler_java_gapic", @@ -96,17 +117,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "cloudprofiler_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -122,6 +132,7 @@ go_gapic_library( srcs = [":cloudprofiler_proto_with_info"], grpc_service_config = "cloudprofiler_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/cloudprofiler/apiv2;cloudprofiler", + rest_numeric_enums = True, service_yaml = "cloudprofiler_v2.yaml", transport = "grpc+rest", deps = [ @@ -147,20 +158,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "cloudprofiler_py_gapic", srcs = [":cloudprofiler_proto"], grpc_service_config = "cloudprofiler_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -182,17 +184,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudprofiler_php_proto", deps = [":cloudprofiler_proto"], @@ -208,6 +199,8 @@ php_gapic_library( name = "cloudprofiler_php_gapic", srcs = [":cloudprofiler_proto_with_info"], grpc_service_config = "cloudprofiler_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":cloudprofiler_php_grpc", ":cloudprofiler_php_proto", @@ -224,15 +217,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "cloudprofiler_nodejs_gapic", package_name = "@google-cloud/cloudprofiler", @@ -240,7 +224,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudprofiler_grpc_service_config.json", package = "google.devtools.cloudprofiler.v2", + rest_numeric_enums = True, service_yaml = "cloudprofiler_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -252,17 +238,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudprofiler_ruby_proto", deps = [":cloudprofiler_proto"], @@ -285,6 +260,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudprofiler", ], grpc_service_config = "cloudprofiler_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Profiler is a statistical, low-overhead profiler that continuously gathers CPU usage and memory-allocation information from your production applications. It attributes that information to the application's source code, helping you identify the parts of the application consuming the most resources, and otherwise illuminating the performance characteristics of the code.", ruby_cloud_title = "Cloud Profiler V2", deps = [ @@ -303,17 +279,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudprofiler_csharp_proto", deps = [":cloudprofiler_proto"], @@ -330,6 +295,7 @@ csharp_gapic_library( srcs = [":cloudprofiler_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudprofiler_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudprofiler_v2.yaml", deps = [ ":cloudprofiler_csharp_grpc", @@ -347,15 +313,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "cloudprofiler_cc_proto", deps = [":cloudprofiler_proto"], diff --git a/google/devtools/cloudtrace/v1/BUILD.bazel b/google/devtools/cloudtrace/v1/BUILD.bazel index d4905e05a..b49105263 100644 --- a/google/devtools/cloudtrace/v1/BUILD.bazel +++ b/google/devtools/cloudtrace/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "cloudtrace_proto", @@ -41,18 +72,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "cloudtrace_java_proto", deps = [":cloudtrace_proto"], @@ -69,6 +88,7 @@ java_gapic_library( srcs = [":cloudtrace_proto_with_info"], gapic_yaml = "cloudtrace_gapic.yaml", grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":cloudtrace_java_grpc", ], @@ -90,6 +110,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-cloudtrace-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":cloudtrace_java_gapic", @@ -99,17 +120,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "cloudtrace_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -125,6 +135,7 @@ go_gapic_library( srcs = [":cloudtrace_proto_with_info"], grpc_service_config = "cloudtrace_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/cloudtrace/apiv1;cloudtrace", + rest_numeric_enums = True, service_yaml = "cloudtrace_v1.yaml", transport = "grpc+rest", deps = [ @@ -149,16 +160,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "cloudtrace_py_gapic", srcs = [":cloudtrace_proto"], @@ -167,6 +168,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=trace", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -188,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_php_proto", deps = [":cloudtrace_proto"], @@ -214,6 +205,8 @@ php_gapic_library( name = "cloudtrace_php_gapic", srcs = [":cloudtrace_proto_with_info"], grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":cloudtrace_php_grpc", ":cloudtrace_php_proto", @@ -230,22 +223,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "cloudtrace_nodejs_gapic", src = ":cloudtrace_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudtrace_grpc_service_config.json", package = "google.devtools.cloudtrace.v1", + rest_numeric_enums = True, service_yaml = "cloudtrace_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -257,17 +243,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_ruby_proto", deps = [":cloudtrace_proto"], @@ -290,6 +265,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudtrace", ], grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Trace API lets you send and retrieve latency data to and from Cloud Trace. This API provides low-level interfaces for interacting directly with the feature. For some languages, you can use OpenCensus, a set of open source tracing and stats instrumentation libraries that work with multiple backends.", ruby_cloud_title = "Cloud Trace V1", deps = [ @@ -308,17 +284,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_csharp_proto", deps = [":cloudtrace_proto"], @@ -335,6 +300,7 @@ csharp_gapic_library( srcs = [":cloudtrace_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudtrace_v1.yaml", deps = [ ":cloudtrace_csharp_grpc", @@ -352,15 +318,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "cloudtrace_cc_proto", deps = [":cloudtrace_proto"], diff --git a/google/devtools/cloudtrace/v2/BUILD.bazel b/google/devtools/cloudtrace/v2/BUILD.bazel index d5db754c3..1731fc58a 100644 --- a/google/devtools/cloudtrace/v2/BUILD.bazel +++ b/google/devtools/cloudtrace/v2/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "cloudtrace_proto", @@ -45,18 +76,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "cloudtrace_java_proto", deps = [":cloudtrace_proto"], @@ -73,6 +92,7 @@ java_gapic_library( srcs = [":cloudtrace_proto_with_info"], gapic_yaml = "cloudtrace_gapic.yaml", grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":cloudtrace_java_grpc", ], @@ -94,6 +114,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-cloudtrace-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":cloudtrace_java_gapic", @@ -103,17 +124,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "cloudtrace_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -130,6 +140,7 @@ go_gapic_library( srcs = [":cloudtrace_proto_with_info"], grpc_service_config = "cloudtrace_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/cloudtrace/apiv2;cloudtrace", + rest_numeric_enums = True, service_yaml = "cloudtrace_v2.yaml", transport = "grpc+rest", deps = [ @@ -154,16 +165,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "cloudtrace_py_gapic", srcs = [":cloudtrace_proto"], @@ -172,6 +173,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=trace", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -193,17 +195,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_php_proto", deps = [":cloudtrace_proto"], @@ -219,6 +210,8 @@ php_gapic_library( name = "cloudtrace_php_gapic", srcs = [":cloudtrace_proto_with_info"], grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":cloudtrace_php_grpc", ":cloudtrace_php_proto", @@ -235,22 +228,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "cloudtrace_nodejs_gapic", src = ":cloudtrace_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "cloudtrace_grpc_service_config.json", package = "google.devtools.cloudtrace.v2", + rest_numeric_enums = True, service_yaml = "cloudtrace_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -262,17 +248,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_ruby_proto", deps = [":cloudtrace_proto"], @@ -295,6 +270,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=cloudtrace", ], grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Trace API lets you send and retrieve latency data to and from Cloud Trace. This API provides low-level interfaces for interacting directly with the feature. For some languages, you can use OpenCensus, a set of open source tracing and stats instrumentation libraries that work with multiple backends.", ruby_cloud_title = "Cloud Trace V2", deps = [ @@ -313,17 +289,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "cloudtrace_csharp_proto", deps = [":cloudtrace_proto"], @@ -340,6 +305,7 @@ csharp_gapic_library( srcs = [":cloudtrace_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "cloudtrace_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "cloudtrace_v2.yaml", deps = [ ":cloudtrace_csharp_grpc", @@ -357,15 +323,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "cloudtrace_cc_proto", deps = [":cloudtrace_proto"], diff --git a/google/devtools/containeranalysis/v1/BUILD.bazel b/google/devtools/containeranalysis/v1/BUILD.bazel index 1b9e2776f..d8f33ef46 100644 --- a/google/devtools/containeranalysis/v1/BUILD.bazel +++ b/google/devtools/containeranalysis/v1/BUILD.bazel @@ -9,14 +9,42 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "containeranalysis_proto", @@ -55,18 +83,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "containeranalysis_java_proto", deps = [":containeranalysis_proto"], @@ -83,6 +99,7 @@ java_gapic_library( srcs = [":containeranalysis_proto_with_info"], gapic_yaml = "containeranalysis_gapic.yaml", grpc_service_config = "containeranalysis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1.yaml", test_deps = [ ":containeranalysis_java_grpc", @@ -109,6 +126,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-containeranalysis-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":containeranalysis_java_gapic", @@ -118,17 +136,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "containeranalysis_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -173,21 +180,15 @@ go_proto_library( # ], # ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "containeranalysis_py_gapic", srcs = [":containeranalysis_proto"], grpc_service_config = "containeranalysis_grpc_service_config.json", - opt_args = ["python-gapic-namespace=google.cloud.devtools"], + opt_args = [ + "python-gapic-namespace=google.cloud.devtools", + "warehouse-package-name=google-cloud-containeranalysis", + ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -214,17 +215,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "containeranalysis_php_proto", deps = [":containeranalysis_proto"], @@ -240,7 +230,9 @@ php_gapic_library( name = "containeranalysis_php_gapic", srcs = [":containeranalysis_proto_with_info"], grpc_service_config = "containeranalysis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1.yaml", + transport = "grpc+rest", deps = [ ":containeranalysis_php_grpc", ":containeranalysis_php_proto", @@ -257,15 +249,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "containeranalysis_nodejs_gapic", package_name = "@google-cloud/containeranalysis", @@ -275,7 +258,9 @@ nodejs_gapic_library( grpc_service_config = "containeranalysis_grpc_service_config.json", main_service = "containeranalysis", package = "google.devtools.containeranalysis.v1", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -289,17 +274,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "containeranalysis_ruby_proto", deps = [":containeranalysis_proto"], @@ -323,6 +297,7 @@ ruby_cloud_gapic_library( "ruby-cloud-extra-dependencies=grafeas-v1=>= 0.4|< 2.a", ], grpc_service_config = "containeranalysis_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Container Analysis API is an implementation of Grafeas. It stores, and enables querying and retrieval of, critical metadata about all of your software artifacts.", ruby_cloud_title = "Container Analysis V1", deps = [ @@ -341,17 +316,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "containeranalysis_csharp_proto", deps = [":containeranalysis_proto"], @@ -368,6 +332,7 @@ csharp_gapic_library( srcs = [":containeranalysis_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "containeranalysis_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1.yaml", deps = [ ":containeranalysis_csharp_grpc", @@ -385,15 +350,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "containeranalysis_cc_proto", deps = [":containeranalysis_proto"], diff --git a/google/devtools/containeranalysis/v1beta1/BUILD.bazel b/google/devtools/containeranalysis/v1beta1/BUILD.bazel index 3435eaf89..ca7f226f6 100644 --- a/google/devtools/containeranalysis/v1beta1/BUILD.bazel +++ b/google/devtools/containeranalysis/v1beta1/BUILD.bazel @@ -103,6 +103,7 @@ java_gapic_library( srcs = [":containeranalysis_proto_with_info"], gapic_yaml = "containeranalysis_gapic.yaml", grpc_service_config = "containeranalysis_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":containeranalysis_java_grpc", ] + _JAVA_GRPC_SUBPACKAGE_DEPS, @@ -163,6 +164,7 @@ go_gapic_library( srcs = [":containeranalysis_proto_with_info"], grpc_service_config = "containeranalysis_grpc_service_config.json", importpath = "cloud.google.com/go/containeranalysis/apiv1beta1;containeranalysis", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -227,7 +229,9 @@ nodejs_gapic_library( grpc_service_config = "containeranalysis_grpc_service_config.json", main_service = "containeranalysis", package = "google.devtools.containeranalysis.v1beta1", + rest_numeric_enums = True, service_yaml = "containeranalysis_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) diff --git a/google/devtools/remoteworkers/v1test2/BUILD.bazel b/google/devtools/remoteworkers/v1test2/BUILD.bazel index 1a8c7a235..3625bcc76 100644 --- a/google/devtools/remoteworkers/v1test2/BUILD.bazel +++ b/google/devtools/remoteworkers/v1test2/BUILD.bazel @@ -9,14 +9,42 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "remoteworkers_proto", @@ -46,18 +74,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "remoteworkers_java_proto", deps = [":remoteworkers_proto"], @@ -74,6 +90,7 @@ java_gapic_library( srcs = [":remoteworkers_proto_with_info"], gapic_yaml = "remoteworkers_gapic.yaml", grpc_service_config = "remoteworkers_grpc_service_config.json", + rest_numeric_enums = False, test_deps = [ ":remoteworkers_java_grpc", ], @@ -95,6 +112,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-remoteworkers-v1test2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":remoteworkers_java_gapic", @@ -104,17 +122,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "remoteworkers_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -131,8 +138,9 @@ go_gapic_library( srcs = [":remoteworkers_proto_with_info"], grpc_service_config = "remoteworkers_grpc_service_config.json", importpath = "cloud.google.com/go/devtools/remoteworkers/apiv1test2;remoteworkers", + rest_numeric_enums = False, service_yaml = "remoteworkers_v1beta2.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":remoteworkers_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", @@ -156,19 +164,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "remoteworkers_py_gapic", srcs = [":remoteworkers_proto"], grpc_service_config = "remoteworkers_grpc_service_config.json", + rest_numeric_enums = False, transport = "grpc", ) @@ -190,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "remoteworkers_php_proto", deps = [":remoteworkers_proto"], @@ -216,6 +205,8 @@ php_gapic_library( name = "remoteworkers_php_gapic", srcs = [":remoteworkers_proto_with_info"], grpc_service_config = "remoteworkers_grpc_service_config.json", + rest_numeric_enums = False, + transport = "grpc+rest", deps = [ ":remoteworkers_php_grpc", ":remoteworkers_php_proto", @@ -232,22 +223,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "remoteworkers_nodejs_gapic", src = ":remoteworkers_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "remoteworkers_grpc_service_config.json", package = "google.devtools.remoteworkers.v1test2", + rest_numeric_enums = False, service_yaml = "remoteworkers_v1beta2.yaml", + transport = "grpc", deps = [], ) @@ -259,17 +243,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "remoteworkers_ruby_proto", deps = [":remoteworkers_proto"], @@ -285,6 +258,7 @@ ruby_cloud_gapic_library( name = "remoteworkers_ruby_gapic", srcs = [":remoteworkers_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-remoteworkers-v1test2"], + rest_numeric_enums = False, deps = [ ":remoteworkers_ruby_grpc", ":remoteworkers_ruby_proto", @@ -301,17 +275,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "remoteworkers_csharp_proto", deps = [":remoteworkers_proto"], @@ -328,6 +291,7 @@ csharp_gapic_library( srcs = [":remoteworkers_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "remoteworkers_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "remoteworkers_v1beta2.yaml", deps = [ ":remoteworkers_csharp_grpc", diff --git a/google/devtools/source/v1/BUILD.bazel b/google/devtools/source/v1/BUILD.bazel index bf47cabbb..b689b4117 100644 --- a/google/devtools/source/v1/BUILD.bazel +++ b/google/devtools/source/v1/BUILD.bazel @@ -1,12 +1,29 @@ # 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("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_grpc_library", + "java_proto_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "source_proto", @@ -25,16 +42,6 @@ proto_library_with_info( ], ) -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_grpc_library", - "java_proto_library", -) - java_proto_library( name = "source_java_proto", deps = [":source_proto"], @@ -51,6 +58,7 @@ java_grpc_library( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-devtools-source-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":source_java_grpc", @@ -59,14 +67,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_proto_library", -) - go_proto_library( name = "source_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -77,15 +77,6 @@ go_proto_library( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "source_py_gapic", srcs = [":source_proto"], @@ -94,6 +85,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=source_context", ], + rest_numeric_enums = False, transport = "grpc", ) @@ -105,15 +97,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_grpc_library", - "php_proto_library", -) - php_proto_library( name = "source_php_proto", deps = [":source_proto"], @@ -125,24 +108,6 @@ php_grpc_library( deps = [":source_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 = "source_ruby_proto", deps = [":source_proto"], @@ -154,15 +119,6 @@ ruby_grpc_library( deps = [":source_ruby_proto"], ) -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_grpc_library", - "csharp_proto_library", -) - csharp_proto_library( name = "source_csharp_proto", deps = [":source_proto"], @@ -174,15 +130,6 @@ csharp_grpc_library( deps = [":source_csharp_proto"], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "source_cc_proto", deps = [":source_proto"], diff --git a/google/devtools/testing/v1/BUILD.bazel b/google/devtools/testing/v1/BUILD.bazel index 533fd2969..17a423dc5 100644 --- a/google/devtools/testing/v1/BUILD.bazel +++ b/google/devtools/testing/v1/BUILD.bazel @@ -9,14 +9,36 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "testing_proto", @@ -43,18 +65,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "testing_java_proto", deps = [":testing_proto"], @@ -70,6 +80,7 @@ java_gapic_library( name = "testing_java_gapic", srcs = [":testing_proto_with_info"], grpc_service_config = "testing_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":testing_java_grpc", ], @@ -95,6 +106,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-devtools-testing-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":testing_java_gapic", @@ -162,19 +174,11 @@ java_gapic_assembly_gradle_pkg( # ], # ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "testing_py_gapic", srcs = [":testing_proto"], grpc_service_config = "testing_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -197,17 +201,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "testing_php_proto", deps = [":testing_proto"], @@ -223,7 +216,9 @@ php_gapic_library( name = "testing_php_gapic", srcs = [":testing_proto_with_info"], grpc_service_config = "testing_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "testing_v1.yaml", + transport = "grpc+rest", deps = [ ":testing_php_grpc", ":testing_php_proto", @@ -240,15 +235,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "testing_nodejs_gapic", package_name = "@google-cloud/testing", @@ -256,7 +242,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "testing_grpc_service_config.json", package = "google.devtools.testing.v1", + rest_numeric_enums = True, service_yaml = "testing_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -268,17 +256,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "testing_ruby_proto", deps = [":testing_proto"], @@ -297,6 +274,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-devtools-testing-v1", ], grpc_service_config = "testing_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":testing_ruby_grpc", ":testing_ruby_proto", @@ -360,15 +338,6 @@ ruby_gapic_assembly_pkg( # ], # ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "testing_cc_proto", deps = [":testing_proto"], diff --git a/google/example/library/v1/BUILD.bazel b/google/example/library/v1/BUILD.bazel index d7dea8c6a..1680bff8d 100644 --- a/google/example/library/v1/BUILD.bazel +++ b/google/example/library/v1/BUILD.bazel @@ -15,6 +15,8 @@ load("@rules_proto//proto:defs.bzl", "proto_library") load( "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", "csharp_gapic_assembly_pkg", "csharp_gapic_library", "csharp_grpc_library", @@ -86,6 +88,7 @@ java_gapic_library( srcs = [":library_proto_with_info"], gapic_yaml = "library_example_gapic.yaml", grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":library_java_grpc", ], @@ -107,6 +110,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-example-library-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":library_java_gapic", @@ -132,6 +136,7 @@ go_gapic_library( grpc_service_config = "library_grpc_service_config.json", importpath = "google.golang.org/google/example/library/v1;library", metadata = True, + rest_numeric_enums = True, service_yaml = "//google/example/library:library_example_v1.yaml", transport = "grpc+rest", deps = [ @@ -161,6 +166,7 @@ py_gapic_library( name = "library_py_gapic", srcs = [":library_proto"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -197,7 +203,9 @@ php_gapic_library( name = "library_php_gapic", srcs = [":library_proto_with_info"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/example/library:library_example_v1.yaml", + transport = "grpc+rest", deps = [ ":library_php_grpc", ":library_php_proto", @@ -221,7 +229,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "library_grpc_service_config.json", package = "google.cloud.example.library.v1", + rest_numeric_enums = True, service_yaml = "//google/example/library:library_example_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -256,6 +266,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=library", ], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "This is a Google example service representing a simple digital library. It manages a collection of shelf resources, and each shelf owns a collection of book resources.", ruby_cloud_title = "Example Library V1", deps = [ @@ -290,6 +301,7 @@ csharp_gapic_library( srcs = [":library_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//google/example/library:library_example_v1.yaml", deps = [ ":library_csharp_grpc", @@ -307,15 +319,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "library_cc_proto", deps = [":library_proto"], diff --git a/google/firestore/admin/v1/BUILD.bazel b/google/firestore/admin/v1/BUILD.bazel index db614ac62..4c872d34f 100644 --- a/google/firestore/admin/v1/BUILD.bazel +++ b/google/firestore/admin/v1/BUILD.bazel @@ -77,7 +77,7 @@ java_gapic_library( srcs = [":admin_proto_with_info"], gapic_yaml = "firestore_gapic.yaml", grpc_service_config = "firestore_admin_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", test_deps = [ ":admin_java_grpc", @@ -141,15 +141,15 @@ go_gapic_library( grpc_service_config = "firestore_admin_grpc_service_config.json", importpath = "cloud.google.com/go/firestore/admin/apiv1;admin", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", transport = "grpc+rest", deps = [ ":admin_go_proto", "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -189,7 +189,7 @@ py_gapic_library( "python-gapic-name=firestore_admin", "python-gapic-namespace=google.cloud", ], - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", transport = "grpc", deps = [ @@ -240,8 +240,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "firestore_admin_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -274,8 +275,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "firestore_admin_grpc_service_config.json", package = "google.firestore.admin.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -321,7 +323,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-firestore", ], grpc_service_config = "firestore_admin_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.", ruby_cloud_title = "Cloud Firestore Admin V1", service_yaml = "firestore_v1.yaml", @@ -368,7 +370,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "firestore_admin_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", deps = [ ":admin_csharp_grpc", diff --git a/google/firestore/bundle/BUILD.bazel b/google/firestore/bundle/BUILD.bazel index 3a3b7ea74..429344acd 100644 --- a/google/firestore/bundle/BUILD.bazel +++ b/google/firestore/bundle/BUILD.bazel @@ -68,6 +68,7 @@ py_gapic_library( name = "firestore_bundle_py_gapic", srcs = [":firestore_bundle_proto"], opt_args = ["python-gapic-namespace=google.cloud"], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/firestore/v1/BUILD.bazel b/google/firestore/v1/BUILD.bazel index 2b29939cc..528690513 100644 --- a/google/firestore/v1/BUILD.bazel +++ b/google/firestore/v1/BUILD.bazel @@ -78,7 +78,7 @@ java_gapic_library( srcs = [":firestore_proto_with_info"], gapic_yaml = "firestore_gapic.yaml", grpc_service_config = "firestore_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", test_deps = [ ":firestore_java_grpc", @@ -143,7 +143,7 @@ go_gapic_library( grpc_service_config = "firestore_grpc_service_config.json", importpath = "cloud.google.com/go/firestore/apiv1;firestore", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", transport = "grpc+rest", deps = [ @@ -151,8 +151,8 @@ go_gapic_library( "//google/cloud/location:location_go_proto", "//google/longrunning:longrunning_go_gapic", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -189,7 +189,7 @@ py_gapic_library( srcs = [":firestore_proto"], grpc_service_config = "firestore_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud"], - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", transport = "grpc", deps = [ @@ -240,8 +240,9 @@ php_gapic_library( name = "firestore_php_gapic", srcs = [":firestore_proto_with_info"], grpc_service_config = "firestore_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", + transport = "grpc+rest", deps = [ ":firestore_php_grpc", ":firestore_php_proto", @@ -274,8 +275,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "firestore_grpc_service_config.json", package = "google.firestore.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -320,7 +322,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/firestore", ], grpc_service_config = "firestore_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.", ruby_cloud_title = "Cloud Firestore V1", service_yaml = "firestore_v1.yaml", @@ -367,7 +369,7 @@ csharp_gapic_library( srcs = [":firestore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "firestore_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "firestore_v1.yaml", deps = [ ":firestore_csharp_grpc", diff --git a/google/firestore/v1beta1/BUILD.bazel b/google/firestore/v1beta1/BUILD.bazel index 185960b07..7da250b11 100644 --- a/google/firestore/v1beta1/BUILD.bazel +++ b/google/firestore/v1beta1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "firestore_proto", @@ -48,18 +77,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "firestore_java_proto", deps = [":firestore_proto"], @@ -76,6 +93,7 @@ java_gapic_library( srcs = [":firestore_proto_with_info"], gapic_yaml = "firestore_gapic.yaml", grpc_service_config = "firestore_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":firestore_java_grpc", ], @@ -97,6 +115,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-firestore-v1beta1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":firestore_java_gapic", @@ -106,17 +125,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "firestore_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -134,6 +142,7 @@ go_gapic_library( srcs = [":firestore_proto_with_info"], grpc_service_config = "firestore_grpc_service_config.json", importpath = "cloud.google.com/go/firestore/apiv1beta1;firestore", + rest_numeric_enums = True, service_yaml = "firestore_v1beta1.yaml", transport = "grpc+rest", deps = [ @@ -158,20 +167,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "firestore_py_gapic", srcs = [":firestore_proto"], grpc_service_config = "firestore_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -193,17 +193,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "firestore_php_proto", deps = [":firestore_proto"], @@ -218,6 +207,8 @@ php_grpc_library( php_gapic_library( name = "firestore_php_gapic", srcs = [":firestore_proto_with_info"], + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":firestore_php_grpc", ":firestore_php_proto", @@ -234,22 +225,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "firestore_nodejs_gapic", src = ":firestore_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "firestore_grpc_service_config.json", package = "google.firestore.v1beta1", + rest_numeric_enums = True, service_yaml = "firestore_v1beta1.yaml", + transport = "grpc+rest", deps = [], ) @@ -261,17 +245,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "firestore_ruby_proto", deps = [":firestore_proto"], @@ -287,6 +260,7 @@ ruby_cloud_gapic_library( name = "firestore_ruby_gapic", srcs = [":firestore_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-firestore-v1beta1"], + rest_numeric_enums = True, deps = [ ":firestore_ruby_grpc", ":firestore_ruby_proto", @@ -303,17 +277,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "firestore_csharp_proto", deps = [":firestore_proto"], @@ -330,6 +293,7 @@ csharp_gapic_library( srcs = [":firestore_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "firestore_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "firestore_v1beta1.yaml", deps = [ ":firestore_csharp_grpc", diff --git a/google/geo/type/BUILD.bazel b/google/geo/type/BUILD.bazel index 1892c969d..0895efd4c 100644 --- a/google/geo/type/BUILD.bazel +++ b/google/geo/type/BUILD.bazel @@ -5,8 +5,6 @@ load( "go_proto_library", "java_gapic_assembly_gradle_pkg", "java_proto_library", - "py_gapic_library", - "py_proto_library", ) package(default_visibility = ["//visibility:public"]) @@ -55,11 +53,33 @@ go_proto_library( ############################################################################## # Python ############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_proto_library", +) + +py_gapic_library( + name = "viewport_py_gapic", + srcs = [":viewport_proto"], + rest_numeric_enums = False, + transport = "grpc", +) + py_proto_library( name = "viewport_py_proto", deps = [":viewport_proto"], ) +# Open Source Packages +py_gapic_assembly_pkg( + name = "viewport-py", + deps = [ + ":viewport_py_gapic", + ], +) + ############################################################################## # C++ ############################################################################## diff --git a/google/home/enterprise/sdm/v1/BUILD.bazel b/google/home/enterprise/sdm/v1/BUILD.bazel index 8eba9dcaa..9294467c6 100644 --- a/google/home/enterprise/sdm/v1/BUILD.bazel +++ b/google/home/enterprise/sdm/v1/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "sdm_proto", @@ -42,18 +71,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "sdm_java_proto", deps = [":sdm_proto"], @@ -69,6 +86,7 @@ java_gapic_library( name = "sdm_java_gapic", srcs = [":sdm_proto_with_info"], grpc_service_config = "smart_device_management_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":sdm_java_grpc", ], @@ -90,6 +108,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-enterprise-sdm-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":sdm_java_gapic", @@ -99,17 +118,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "sdm_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -125,6 +133,7 @@ go_gapic_library( srcs = [":sdm_proto_with_info"], grpc_service_config = "smart_device_management_grpc_service_config.json", importpath = "google.golang.org/google/home/enterprise/sdm/v1;sdm", + rest_numeric_enums = True, service_yaml = "smartdevicemanagement_v1.yaml", transport = "grpc+rest", deps = [ @@ -149,20 +158,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "sdm_py_gapic", srcs = [":sdm_proto"], grpc_service_config = "smart_device_management_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -184,17 +184,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "sdm_php_proto", deps = [":sdm_proto"], @@ -210,6 +199,8 @@ php_gapic_library( name = "sdm_php_gapic", srcs = [":sdm_proto_with_info"], grpc_service_config = "smart_device_management_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":sdm_php_grpc", ":sdm_php_proto", @@ -226,22 +217,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "sdm_nodejs_gapic", src = ":sdm_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "smart_device_management_grpc_service_config.json", package = "google.home.enterprise.sdm.v1", + rest_numeric_enums = True, service_yaml = "smartdevicemanagement_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -253,17 +237,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "sdm_ruby_proto", deps = [":sdm_proto"], @@ -280,6 +253,7 @@ ruby_cloud_gapic_library( srcs = [":sdm_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-sdm-v1"], grpc_service_config = "smart_device_management_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":sdm_ruby_grpc", ":sdm_ruby_proto", @@ -296,17 +270,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "sdm_csharp_proto", deps = [":sdm_proto"], @@ -323,6 +286,7 @@ csharp_gapic_library( srcs = [":sdm_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "smart_device_management_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "smartdevicemanagement_v1.yaml", deps = [ ":sdm_csharp_grpc", diff --git a/google/home/graph/v1/BUILD.bazel b/google/home/graph/v1/BUILD.bazel index c51210e77..faa542909 100644 --- a/google/home/graph/v1/BUILD.bazel +++ b/google/home/graph/v1/BUILD.bazel @@ -1,13 +1,41 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "graph_proto", @@ -33,18 +61,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "graph_java_proto", deps = [":graph_proto"], @@ -60,6 +76,7 @@ java_gapic_library( name = "graph_java_gapic", srcs = [":graph_proto_with_info"], grpc_service_config = "homegraph_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":graph_java_grpc", ], @@ -81,6 +98,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-home-graph-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":graph_java_gapic", @@ -90,17 +108,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "graph_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -116,6 +123,7 @@ go_gapic_library( srcs = [":graph_proto_with_info"], grpc_service_config = "homegraph_grpc_service_config.json", importpath = "google.golang.org/api/homegraph/v1;graph", + rest_numeric_enums = True, service_yaml = "homegraph_v1.yaml", transport = "grpc+rest", deps = [ @@ -140,19 +148,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "graph_py_gapic", srcs = [":graph_proto"], grpc_service_config = "homegraph_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -174,17 +174,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "graph_php_proto", deps = [":graph_proto"], @@ -199,6 +188,8 @@ php_grpc_library( php_gapic_library( name = "graph_php_gapic", srcs = [":graph_proto_with_info"], + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":graph_php_grpc", ":graph_php_proto", @@ -215,22 +206,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "graph_nodejs_gapic", src = ":graph_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "homegraph_grpc_service_config.json", package = "google.home.graph.v1", + rest_numeric_enums = True, service_yaml = "homegraph_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -242,17 +226,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "graph_ruby_proto", deps = [":graph_proto"], @@ -268,6 +241,7 @@ ruby_cloud_gapic_library( name = "graph_ruby_gapic", srcs = [":graph_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-graph-v1"], + rest_numeric_enums = True, deps = [ ":graph_ruby_grpc", ":graph_ruby_proto", @@ -284,17 +258,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "graph_csharp_proto", deps = [":graph_proto"], @@ -311,6 +274,7 @@ csharp_gapic_library( srcs = [":graph_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "homegraph_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "homegraph_v1.yaml", deps = [ ":graph_csharp_grpc", diff --git a/google/iam/admin/v1/BUILD.bazel b/google/iam/admin/v1/BUILD.bazel index be39c779a..f9be7a07f 100644 --- a/google/iam/admin/v1/BUILD.bazel +++ b/google/iam/admin/v1/BUILD.bazel @@ -75,7 +75,7 @@ java_gapic_library( # This was manually replaced - build_gen shouldn't have removed it. gapic_yaml = "iam_gapic.yaml", grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", test_deps = [ ":admin_java_grpc", @@ -142,7 +142,7 @@ go_gapic_library( grpc_service_config = "iam_grpc_service_config.json", importpath = "cloud.google.com/go/iam/admin/apiv1;admin", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", transport = "grpc", deps = [ @@ -183,6 +183,7 @@ py_gapic_library( name = "admin_py_gapic", srcs = [":admin_proto"], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -233,8 +234,9 @@ php_gapic_library( name = "admin_php_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", + transport = "grpc+rest", deps = [ ":admin_php_grpc", ":admin_php_proto", @@ -267,8 +269,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iam_grpc_service_config.json", package = "google.iam.admin.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", + transport = "grpc", deps = [], ) @@ -307,7 +310,7 @@ ruby_cloud_gapic_library( srcs = [":admin_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-iam-admin-v1"], grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", deps = [ ":admin_ruby_grpc", @@ -352,7 +355,7 @@ csharp_gapic_library( srcs = [":admin_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam.yaml", deps = [ ":admin_csharp_grpc", diff --git a/google/iam/credentials/v1/BUILD.bazel b/google/iam/credentials/v1/BUILD.bazel index e23a4893b..8d756b7c1 100644 --- a/google/iam/credentials/v1/BUILD.bazel +++ b/google/iam/credentials/v1/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "credentials_proto", @@ -33,18 +64,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "credentials_java_proto", deps = [":credentials_proto"], @@ -60,6 +79,7 @@ java_gapic_library( name = "credentials_java_gapic", srcs = [":credentials_proto_with_info"], grpc_service_config = "iamcredentials_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":credentials_java_grpc", ], @@ -81,6 +101,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-iam-credentials-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":credentials_java_gapic", @@ -90,17 +111,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "credentials_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -116,6 +126,7 @@ go_gapic_library( srcs = [":credentials_proto_with_info"], grpc_service_config = "iamcredentials_grpc_service_config.json", importpath = "cloud.google.com/go/iam/credentials/apiv1;credentials", + rest_numeric_enums = True, service_yaml = "iamcredentials_v1.yaml", transport = "grpc+rest", deps = [ @@ -141,16 +152,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "credentials_py_gapic", srcs = [":credentials_proto"], @@ -160,6 +161,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=iam_credentials", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -180,17 +182,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "credentials_php_proto", deps = [":credentials_proto"], @@ -206,6 +197,8 @@ php_gapic_library( name = "credentials_php_gapic", srcs = [":credentials_proto_with_info"], grpc_service_config = "iamcredentials_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":credentials_php_grpc", ":credentials_php_proto", @@ -222,15 +215,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "credentials_nodejs_gapic", package_name = "@google-cloud/iam-credentials", @@ -238,7 +222,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iamcredentials_grpc_service_config.json", package = "google.iam.credentials.v1", + rest_numeric_enums = True, service_yaml = "iamcredentials_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -250,17 +236,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "credentials_ruby_proto", deps = [":credentials_proto"], @@ -283,6 +258,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=iamcredentials", ], grpc_service_config = "iamcredentials_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Service Account Credentials API creates short-lived credentials for Identity and Access Management (IAM) service accounts. You can also use this API to sign JSON Web Tokens (JWTs), as well as blobs of binary data that contain other types of tokens.", ruby_cloud_title = "IAM Service Account Credentials V1", deps = [ @@ -301,17 +277,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "credentials_csharp_proto", deps = [":credentials_proto"], @@ -328,6 +293,7 @@ csharp_gapic_library( srcs = [":credentials_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iamcredentials_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iamcredentials_v1.yaml", deps = [ ":credentials_csharp_grpc", @@ -345,15 +311,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "credentials_cc_proto", deps = [":credentials_proto"], diff --git a/google/iam/v1/BUILD.bazel b/google/iam/v1/BUILD.bazel index d4b4647da..a2adcf6bf 100644 --- a/google/iam/v1/BUILD.bazel +++ b/google/iam/v1/BUILD.bazel @@ -1,12 +1,31 @@ load("@rules_proto//proto:defs.bzl", "proto_library") -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - ############################################################################## # Common ############################################################################## -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_grpc_library", + "java_proto_library", + "proto_library_with_info", + "py_proto_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "iam_policy_proto", @@ -48,16 +67,6 @@ proto_library_with_info( ], ) -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_grpc_library", - "java_proto_library", -) - java_proto_library( name = "iam_java_proto", deps = [ @@ -78,6 +87,7 @@ java_grpc_library( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-iam-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ "iam_java_grpc", @@ -85,15 +95,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_proto_library", -) - go_proto_library( name = "iam_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -116,15 +117,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "iam_policy_cc_proto", deps = [":iam_policy_proto"], @@ -147,14 +139,6 @@ cc_grpc_library( deps = [":iam_policy_cc_proto"], ) -############################################################################## -# Python -# ############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_proto_library", -) - py_proto_library( name = "iam_policy_py_proto", deps = [":iam_policy_proto"], @@ -170,17 +154,6 @@ py_proto_library( deps = [":options_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 = "iam_ruby_proto", deps = [ @@ -203,6 +176,7 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-iam-v1", ], + rest_numeric_enums = False, ruby_cloud_description = "An add-on interface used by some Google API clients to provide IAM Policy calls.", ruby_cloud_title = "IAM", deps = [ @@ -221,17 +195,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "iam_csharp_proto", deps = [ @@ -252,6 +215,7 @@ csharp_gapic_library( name = "iam_csharp_gapic", srcs = [":iam_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", + rest_numeric_enums = False, deps = [ ":iam_csharp_grpc", ":iam_csharp_proto", diff --git a/google/iam/v1/logging/BUILD.bazel b/google/iam/v1/logging/BUILD.bazel index 774f1aaf8..5a079bec9 100644 --- a/google/iam/v1/logging/BUILD.bazel +++ b/google/iam/v1/logging/BUILD.bazel @@ -78,6 +78,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=iam_logging", ], + rest_numeric_enums = False, transport = "grpc", ) diff --git a/google/iam/v1beta/BUILD.bazel b/google/iam/v1beta/BUILD.bazel index cba3c5b08..4d4059b19 100644 --- a/google/iam/v1beta/BUILD.bazel +++ b/google/iam/v1beta/BUILD.bazel @@ -9,14 +9,43 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "iam_proto", @@ -41,18 +70,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "iam_java_proto", deps = [":iam_proto"], @@ -69,9 +86,11 @@ java_gapic_library( srcs = [":iam_proto_with_info"], gapic_yaml = "iam_gapic.yaml", grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":iam_java_grpc", ], + transport = "grpc", deps = [ ":iam_java_proto", ], @@ -88,6 +107,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-iam-v1beta-java", + include_samples = True, + transport = "grpc", deps = [ ":iam_java_gapic", ":iam_java_grpc", @@ -96,17 +117,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "iam_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -123,13 +133,14 @@ go_gapic_library( srcs = [":iam_proto_with_info"], grpc_service_config = "iam_grpc_service_config.json", importpath = "cloud.google.com/go/iam/apiv1beta;iam", + rest_numeric_enums = True, service_yaml = "iam_v1beta.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -150,20 +161,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "iam_py_gapic", srcs = [":iam_proto"], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -185,17 +187,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "iam_php_proto", deps = [":iam_proto"], @@ -211,7 +202,9 @@ php_gapic_library( name = "iam_php_gapic", srcs = [":iam_proto_with_info"], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v1beta.yaml", + transport = "grpc+rest", deps = [ ":iam_php_grpc", ":iam_php_proto", @@ -228,22 +221,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "iam_nodejs_gapic", src = ":iam_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "iam_grpc_service_config.json", package = "google.iam.v1beta", + rest_numeric_enums = True, service_yaml = "iam_v1beta.yaml", + transport = "grpc", deps = [], ) @@ -255,17 +241,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "iam_ruby_proto", deps = [":iam_proto"], @@ -288,6 +263,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=iam", ], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Pre-release client for the WorkloadIdentityPools service.", ruby_cloud_title = "Google IAM V1beta", deps = [ @@ -306,17 +282,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "iam_csharp_proto", deps = [":iam_proto"], @@ -333,6 +298,7 @@ csharp_gapic_library( srcs = [":iam_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v1beta.yaml", deps = [ ":iam_csharp_grpc", diff --git a/google/iam/v2/BUILD.bazel b/google/iam/v2/BUILD.bazel index 53bf23a4c..2fd12326b 100644 --- a/google/iam/v2/BUILD.bazel +++ b/google/iam/v2/BUILD.bazel @@ -70,7 +70,7 @@ java_gapic_library( srcs = [":iam_proto_with_info"], gapic_yaml = None, grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", test_deps = [ ":iam_java_grpc", @@ -133,14 +133,14 @@ go_gapic_library( grpc_service_config = "iam_grpc_service_config.json", importpath = "cloud.google.com/go/iam/apiv2;iam", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", transport = "grpc+rest", deps = [ ":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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -181,7 +181,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-iam", ], - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", transport = "grpc", deps = [ @@ -232,8 +232,9 @@ php_gapic_library( name = "iam_php_gapic", srcs = [":iam_proto_with_info"], grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", + transport = "grpc+rest", deps = [ ":iam_php_grpc", ":iam_php_proto", @@ -266,8 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iam_grpc_service_config.json", package = "google.iam.v2", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -312,7 +314,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-iam-client", ], grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, ruby_cloud_description = "Manages identity and access control policies for Google Cloud Platform resources.", ruby_cloud_title = "IAM V2", service_yaml = "iam_v2.yaml", @@ -359,7 +361,7 @@ csharp_gapic_library( srcs = [":iam_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iam_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "iam_v2.yaml", deps = [ ":iam_csharp_grpc", diff --git a/google/iam/v2beta/BUILD.bazel b/google/iam/v2beta/BUILD.bazel index b614c4e61..23bee4877 100644 --- a/google/iam/v2beta/BUILD.bazel +++ b/google/iam/v2beta/BUILD.bazel @@ -70,6 +70,7 @@ java_gapic_library( srcs = [":iam_proto_with_info"], gapic_yaml = None, grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", test_deps = [ ":iam_java_grpc", @@ -132,13 +133,14 @@ go_gapic_library( grpc_service_config = "iam_grpc_service_config.json", importpath = "cloud.google.com/go/iam/apiv2beta;iam", metadata = True, + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", - transport = "grpc+rest", + transport = "grpc", deps = [ ":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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -179,6 +181,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-iam", ], + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", transport = "grpc", deps = [ @@ -229,7 +232,9 @@ php_gapic_library( name = "iam_php_gapic", srcs = [":iam_proto_with_info"], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", + transport = "grpc+rest", deps = [ ":iam_php_grpc", ":iam_php_proto", @@ -262,7 +267,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "iam_grpc_service_config.json", package = "google.iam.v2beta", + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", + transport = "grpc", deps = [], ) @@ -301,6 +308,7 @@ ruby_cloud_gapic_library( srcs = [":iam_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-iam-v2beta"], grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", deps = [ ":iam_ruby_grpc", @@ -345,6 +353,7 @@ csharp_gapic_library( srcs = [":iam_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "iam_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "iam_v2beta.yaml", deps = [ ":iam_csharp_grpc", diff --git a/google/identity/accesscontextmanager/v1/BUILD.bazel b/google/identity/accesscontextmanager/v1/BUILD.bazel index ed6c4a7c7..cdceb4e92 100644 --- a/google/identity/accesscontextmanager/v1/BUILD.bazel +++ b/google/identity/accesscontextmanager/v1/BUILD.bazel @@ -32,6 +32,8 @@ proto_library( "//google/api:client_proto", "//google/api:field_behavior_proto", "//google/api:resource_proto", + "//google/iam/v1:iam_policy_proto", + "//google/iam/v1:policy_proto", "//google/identity/accesscontextmanager/type:type_proto", "//google/longrunning:operations_proto", "//google/type:expr_proto", @@ -109,13 +111,19 @@ java_grpc_library( java_gapic_library( name = "accesscontextmanager_java_gapic", srcs = [":accesscontextmanager_proto_with_info"], + gapic_yaml = None, grpc_service_config = "accesscontextmanager_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "accesscontextmanager_v1.yaml", test_deps = [ ":accesscontextmanager_java_grpc", + "//google/iam/v1:iam_java_grpc", ], transport = "grpc+rest", deps = [ ":accesscontextmanager_java_proto", + "//google/api:api_java_proto", + "//google/iam/v1:iam_java_proto", ], ) @@ -131,6 +139,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-accesscontextmanager-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":accesscontextmanager_java_gapic", @@ -158,6 +167,7 @@ go_proto_library( protos = [":accesscontextmanager_proto"], deps = [ "//google/api:annotations_go_proto", + "//google/iam/v1:iam_go_proto", "//google/identity/accesscontextmanager/type:type_go_proto", "//google/longrunning:longrunning_go_proto", "//google/type:expr_go_proto", @@ -170,13 +180,15 @@ go_gapic_library( grpc_service_config = "accesscontextmanager_grpc_service_config.json", importpath = "cloud.google.com/go/identity/accesscontextmanager/apiv1;accesscontextmanager", metadata = True, + rest_numeric_enums = True, service_yaml = "accesscontextmanager_v1.yaml", transport = "grpc+rest", deps = [ ":accesscontextmanager_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -206,6 +218,7 @@ load( "py_gapic_assembly_pkg", "py_gapic_library", "py_proto_library", + "py_test", ) py_proto_library( @@ -227,7 +240,12 @@ py_gapic_library( name = "accesscontextmanager_py_gapic", srcs = [":accesscontextmanager_proto"], grpc_service_config = "accesscontextmanager_grpc_service_config.json", + rest_numeric_enums = True, + service_yaml = "accesscontextmanager_v1.yaml", transport = "grpc", + deps = [ + "//google/iam/v1:iam_policy_py_proto", + ], ) # Uncomment once https://github.com/googleapis/gapic-generator-python/issues/1376 is fixed @@ -275,7 +293,9 @@ php_gapic_library( name = "accesscontextmanager_php_gapic", srcs = [":accesscontextmanager_proto_with_info"], grpc_service_config = "accesscontextmanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "accesscontextmanager_v1.yaml", + transport = "grpc+rest", deps = [ ":accesscontextmanager_php_grpc", ":accesscontextmanager_php_proto", @@ -308,7 +328,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "accesscontextmanager_grpc_service_config.json", package = "google.identity.accesscontextmanager.v1", + rest_numeric_enums = True, service_yaml = "accesscontextmanager_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -350,14 +372,16 @@ ruby_cloud_gapic_library( name = "accesscontextmanager_ruby_gapic", srcs = [":accesscontextmanager_proto_with_info"], extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-identity-access_context_manager-v1", - "ruby-cloud-product-url=https://cloud.google.com/access-context-manager/", "ruby-cloud-api-id=accesscontextmanager.googleapis.com", "ruby-cloud-api-shortname=accesscontextmanager", + "ruby-cloud-gem-name=google-identity-access_context_manager-v1", + "ruby-cloud-product-url=https://cloud.google.com/access-context-manager/", ], grpc_service_config = "accesscontextmanager_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Access Context Manager allows enterprises to configure access levels which map to a policy defined on request attributes.", ruby_cloud_title = "Access Context Manager V1", + service_yaml = "accesscontextmanager_v1.yaml", deps = [ ":accesscontextmanager_ruby_grpc", ":accesscontextmanager_ruby_proto", @@ -401,6 +425,7 @@ csharp_gapic_library( srcs = [":accesscontextmanager_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "accesscontextmanager_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "accesscontextmanager_v1.yaml", deps = [ ":accesscontextmanager_csharp_grpc", diff --git a/google/identity/accesscontextmanager/v1/access_context_manager.proto b/google/identity/accesscontextmanager/v1/access_context_manager.proto index 84a645018..3a71d81f3 100644 --- a/google/identity/accesscontextmanager/v1/access_context_manager.proto +++ b/google/identity/accesscontextmanager/v1/access_context_manager.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,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/iam/v1/iam_policy.proto"; +import "google/iam/v1/policy.proto"; import "google/identity/accesscontextmanager/v1/access_level.proto"; import "google/identity/accesscontextmanager/v1/access_policy.proto"; import "google/identity/accesscontextmanager/v1/gcp_user_access_binding.proto"; @@ -36,32 +38,32 @@ option objc_class_prefix = "GACM"; option php_namespace = "Google\\Identity\\AccessContextManager\\V1"; option ruby_package = "Google::Identity::AccessContextManager::V1"; -// API for setting [Access Levels] -// [google.identity.accesscontextmanager.v1.AccessLevel] and [Service -// Perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] -// for Google Cloud Projects. Each organization has one [AccessPolicy] -// [google.identity.accesscontextmanager.v1.AccessPolicy] containing the -// [Access Levels] [google.identity.accesscontextmanager.v1.AccessLevel] -// and [Service Perimeters] +// API for setting [access levels] +// [google.identity.accesscontextmanager.v1.AccessLevel] and [service +// perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] +// for Google Cloud projects. Each organization has one [access policy] +// [google.identity.accesscontextmanager.v1.AccessPolicy] that contains the +// [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] +// and [service perimeters] // [google.identity.accesscontextmanager.v1.ServicePerimeter]. This -// [AccessPolicy] [google.identity.accesscontextmanager.v1.AccessPolicy] is +// [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is // applicable to all resources in the organization. // AccessPolicies service AccessContextManager { option (google.api.default_host) = "accesscontextmanager.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - // List all [AccessPolicies] - // [google.identity.accesscontextmanager.v1.AccessPolicy] under a - // container. + // Lists all [access policies] + // [google.identity.accesscontextmanager.v1.AccessPolicy] in an + // organization. rpc ListAccessPolicies(ListAccessPoliciesRequest) returns (ListAccessPoliciesResponse) { option (google.api.http) = { get: "/v1/accessPolicies" }; } - // Get an [AccessPolicy] - // [google.identity.accesscontextmanager.v1.AccessPolicy] by name. + // Returns an [access policy] + // [google.identity.accesscontextmanager.v1.AccessPolicy] based on the name. rpc GetAccessPolicy(GetAccessPolicyRequest) returns (AccessPolicy) { option (google.api.http) = { get: "/v1/{name=accessPolicies/*}" @@ -69,10 +71,10 @@ service AccessContextManager { option (google.api.method_signature) = "name"; } - // Create an `AccessPolicy`. Fails if this organization already has a - // `AccessPolicy`. The longrunning Operation will have a successful status - // once the `AccessPolicy` has propagated to long-lasting storage. - // Syntactic and basic semantic errors will be returned in `metadata` as a + // Creates an access policy. This method fails if the organization already has + // an access policy. The long-running operation has a successful status + // after the access policy propagates to long-lasting storage. + // Syntactic and basic semantic errors are returned in `metadata` as a // BadRequest proto. rpc CreateAccessPolicy(AccessPolicy) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -85,13 +87,12 @@ service AccessContextManager { }; } - // Update an [AccessPolicy] + // Updates an [access policy] // [google.identity.accesscontextmanager.v1.AccessPolicy]. The - // longrunning Operation from this RPC will have a successful status once the - // changes to the [AccessPolicy] - // [google.identity.accesscontextmanager.v1.AccessPolicy] have propagated - // to long-lasting storage. Syntactic and basic semantic errors will be - // returned in `metadata` as a BadRequest proto. + // long-running operation from this RPC has a successful status after the + // changes to the [access policy] + // [google.identity.accesscontextmanager.v1.AccessPolicy] propagate + // to long-lasting storage. rpc UpdateAccessPolicy(UpdateAccessPolicyRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{policy.name=accessPolicies/*}" @@ -104,11 +105,11 @@ service AccessContextManager { }; } - // Delete an [AccessPolicy] - // [google.identity.accesscontextmanager.v1.AccessPolicy] by resource - // name. The longrunning Operation will have a successful status once the - // [AccessPolicy] [google.identity.accesscontextmanager.v1.AccessPolicy] - // has been removed from long-lasting storage. + // Deletes an [access policy] + // [google.identity.accesscontextmanager.v1.AccessPolicy] based on the + // resource name. The long-running operation has a successful status after the + // [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] + // is removed from long-lasting storage. rpc DeleteAccessPolicy(DeleteAccessPolicyRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=accessPolicies/*}" @@ -120,7 +121,7 @@ service AccessContextManager { }; } - // List all [Access Levels] + // Lists all [access levels] // [google.identity.accesscontextmanager.v1.AccessLevel] for an access // policy. rpc ListAccessLevels(ListAccessLevelsRequest) returns (ListAccessLevelsResponse) { @@ -130,8 +131,8 @@ service AccessContextManager { option (google.api.method_signature) = "parent"; } - // Get an [Access Level] - // [google.identity.accesscontextmanager.v1.AccessLevel] by resource + // Gets an [access level] + // [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource // name. rpc GetAccessLevel(GetAccessLevelRequest) returns (AccessLevel) { option (google.api.http) = { @@ -140,13 +141,13 @@ service AccessContextManager { option (google.api.method_signature) = "name"; } - // Create an [Access Level] - // [google.identity.accesscontextmanager.v1.AccessLevel]. The longrunning - // operation from this RPC will have a successful status once the [Access - // Level] [google.identity.accesscontextmanager.v1.AccessLevel] has - // propagated to long-lasting storage. [Access Levels] - // [google.identity.accesscontextmanager.v1.AccessLevel] containing - // errors will result in an error response for the first error encountered. + // Creates an [access level] + // [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running + // operation from this RPC has a successful status after the [access + // level] [google.identity.accesscontextmanager.v1.AccessLevel] + // propagates to long-lasting storage. If [access levels] + // [google.identity.accesscontextmanager.v1.AccessLevel] contain + // errors, an error response is returned for the first error encountered. rpc CreateAccessLevel(CreateAccessLevelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accessPolicies/*}/accessLevels" @@ -159,14 +160,14 @@ service AccessContextManager { }; } - // Update an [Access Level] - // [google.identity.accesscontextmanager.v1.AccessLevel]. The longrunning - // operation from this RPC will have a successful status once the changes to - // the [Access Level] - // [google.identity.accesscontextmanager.v1.AccessLevel] have propagated - // to long-lasting storage. [Access Levels] - // [google.identity.accesscontextmanager.v1.AccessLevel] containing - // errors will result in an error response for the first error encountered. + // Updates an [access level] + // [google.identity.accesscontextmanager.v1.AccessLevel]. The long-running + // operation from this RPC has a successful status after the changes to + // the [access level] + // [google.identity.accesscontextmanager.v1.AccessLevel] propagate + // to long-lasting storage. If [access levels] + // [google.identity.accesscontextmanager.v1.AccessLevel] contain + // errors, an error response is returned for the first error encountered. rpc UpdateAccessLevel(UpdateAccessLevelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{access_level.name=accessPolicies/*/accessLevels/*}" @@ -179,10 +180,10 @@ service AccessContextManager { }; } - // Delete an [Access Level] - // [google.identity.accesscontextmanager.v1.AccessLevel] by resource - // name. The longrunning operation from this RPC will have a successful status - // once the [Access Level] + // Deletes an [access level] + // [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource + // name. The long-running operation from this RPC has a successful status + // after the [access level] // [google.identity.accesscontextmanager.v1.AccessLevel] has been removed // from long-lasting storage. rpc DeleteAccessLevel(DeleteAccessLevelRequest) returns (google.longrunning.Operation) { @@ -196,22 +197,22 @@ service AccessContextManager { }; } - // Replace all existing [Access Levels] - // [google.identity.accesscontextmanager.v1.AccessLevel] in an [Access - // Policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with - // the [Access Levels] + // Replaces all existing [access levels] + // [google.identity.accesscontextmanager.v1.AccessLevel] in an [access + // policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with + // the [access levels] // [google.identity.accesscontextmanager.v1.AccessLevel] provided. This - // is done atomically. The longrunning operation from this RPC will have a - // successful status once all replacements have propagated to long-lasting - // storage. Replacements containing errors will result in an error response - // for the first error encountered. Replacement will be cancelled on error, - // existing [Access Levels] - // [google.identity.accesscontextmanager.v1.AccessLevel] will not be - // affected. Operation.response field will contain - // ReplaceAccessLevelsResponse. Removing [Access Levels] + // is done atomically. The long-running operation from this RPC has a + // successful status after all replacements propagate to long-lasting + // storage. If the replacement contains errors, an error response is returned + // for the first error encountered. Upon error, the replacement is cancelled, + // and existing [access levels] + // [google.identity.accesscontextmanager.v1.AccessLevel] are not + // affected. The Operation.response field contains + // ReplaceAccessLevelsResponse. Removing [access levels] // [google.identity.accesscontextmanager.v1.AccessLevel] contained in existing - // [Service Perimeters] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] will result in + // [service perimeters] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] result in an // error. rpc ReplaceAccessLevels(ReplaceAccessLevelsRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -224,7 +225,7 @@ service AccessContextManager { }; } - // List all [Service Perimeters] + // Lists all [service perimeters] // [google.identity.accesscontextmanager.v1.ServicePerimeter] for an // access policy. rpc ListServicePerimeters(ListServicePerimetersRequest) returns (ListServicePerimetersResponse) { @@ -234,9 +235,9 @@ service AccessContextManager { option (google.api.method_signature) = "parent"; } - // Get a [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] by resource - // name. + // Gets a [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the + // resource name. rpc GetServicePerimeter(GetServicePerimeterRequest) returns (ServicePerimeter) { option (google.api.http) = { get: "/v1/{name=accessPolicies/*/servicePerimeters/*}" @@ -244,14 +245,14 @@ service AccessContextManager { option (google.api.method_signature) = "name"; } - // Create a [Service Perimeter] + // Creates a [service perimeter] // [google.identity.accesscontextmanager.v1.ServicePerimeter]. The - // longrunning operation from this RPC will have a successful status once the - // [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] has - // propagated to long-lasting storage. [Service Perimeters] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] containing - // errors will result in an error response for the first error encountered. + // long-running operation from this RPC has a successful status after the + // [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] + // propagates to long-lasting storage. If a [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] contains + // errors, an error response is returned for the first error encountered. rpc CreateServicePerimeter(CreateServicePerimeterRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accessPolicies/*}/servicePerimeters" @@ -264,14 +265,14 @@ service AccessContextManager { }; } - // Update a [Service Perimeter] + // Updates a [service perimeter] // [google.identity.accesscontextmanager.v1.ServicePerimeter]. The - // longrunning operation from this RPC will have a successful status once the - // changes to the [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] have - // propagated to long-lasting storage. [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] containing - // errors will result in an error response for the first error encountered. + // long-running operation from this RPC has a successful status after the + // [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] + // propagates to long-lasting storage. If a [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] contains + // errors, an error response is returned for the first error encountered. rpc UpdateServicePerimeter(UpdateServicePerimeterRequest) returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{service_perimeter.name=accessPolicies/*/servicePerimeters/*}" @@ -284,12 +285,12 @@ service AccessContextManager { }; } - // Delete a [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] by resource - // name. The longrunning operation from this RPC will have a successful status - // once the [Service Perimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] has been - // removed from long-lasting storage. + // Deletes a [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the + // resource name. The long-running operation from this RPC has a successful + // status after the [service perimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from + // long-lasting storage. rpc DeleteServicePerimeter(DeleteServicePerimeterRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=accessPolicies/*/servicePerimeters/*}" @@ -301,18 +302,18 @@ service AccessContextManager { }; } - // Replace all existing [Service Perimeters] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] in an - // [Access Policy] [google.identity.accesscontextmanager.v1.AccessPolicy] - // with the [Service Perimeters] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] provided. - // This is done atomically. The longrunning operation from this - // RPC will have a successful status once all replacements have propagated to - // long-lasting storage. Replacements containing errors will result in an - // error response for the first error encountered. Replacement will be - // cancelled on error, existing [Service Perimeters] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] will not be - // affected. Operation.response field will contain + // Replace all existing [service perimeters] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access + // policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the + // [service perimeters] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] provided. This + // is done atomically. The long-running operation from this RPC has a + // successful status after all replacements propagate to long-lasting storage. + // Replacements containing errors result in an error response for the first + // error encountered. Upon an error, replacement are cancelled and existing + // [service perimeters] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] are not + // affected. The Operation.response field contains // ReplaceServicePerimetersResponse. rpc ReplaceServicePerimeters(ReplaceServicePerimetersRequest) returns (google.longrunning.Operation) { option (google.api.http) = { @@ -325,21 +326,21 @@ service AccessContextManager { }; } - // Commit the dry-run spec for all the [Service Perimeters] + // Commits the dry-run specification for all the [service perimeters] // [google.identity.accesscontextmanager.v1.ServicePerimeter] in an - // [Access Policy][google.identity.accesscontextmanager.v1.AccessPolicy]. - // A commit operation on a Service Perimeter involves copying its `spec` field - // to that Service Perimeter's `status` field. Only [Service Perimeters] + // [access policy][google.identity.accesscontextmanager.v1.AccessPolicy]. + // A commit operation on a service perimeter involves copying its `spec` field + // to the `status` field of the service perimeter. Only [service perimeters] // [google.identity.accesscontextmanager.v1.ServicePerimeter] with // `use_explicit_dry_run_spec` field set to true are affected by a commit - // operation. The longrunning operation from this RPC will have a successful - // status once the dry-run specs for all the [Service Perimeters] + // operation. The long-running operation from this RPC has a successful + // status after the dry-run specifications for all the [service perimeters] // [google.identity.accesscontextmanager.v1.ServicePerimeter] have been - // committed. If a commit fails, it will cause the longrunning operation to - // return an error response and the entire commit operation will be cancelled. - // When successful, Operation.response field will contain - // CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will - // be cleared after a successful commit operation. + // committed. If a commit fails, it causes the long-running operation to + // return an error response and the entire commit operation is cancelled. + // When successful, the Operation.response field contains + // CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are + // cleared after a successful commit operation. rpc CommitServicePerimeters(CommitServicePerimetersRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=accessPolicies/*}/servicePerimeters:commit" @@ -375,7 +376,7 @@ service AccessContextManager { // [google.identity.accesscontextmanager.v1.GcpUserAccessBinding]. If the // client specifies a [name] // [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], - // the server will ignore it. Fails if a resource already exists with the same + // the server ignores it. Fails if a resource already exists with the same // [group_key] // [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. // Completion of this long-running operation does not necessarily signify that @@ -425,6 +426,49 @@ service AccessContextManager { metadata_type: "GcpUserAccessBindingOperationMetadata" }; } + + // Sets the IAM policy for the specified Access Context Manager + // [access policy][google.identity.accesscontextmanager.v1.AccessPolicy]. + // This method replaces the existing IAM policy on the access policy. The IAM + // policy controls the set of users who can perform specific operations on the + // Access Context Manager [access + // policy][google.identity.accesscontextmanager.v1.AccessPolicy]. + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + option (google.api.http) = { + post: "/v1/{resource=accessPolicies/*}:setIamPolicy" + body: "*" + }; + } + + // Gets the IAM policy for the specified Access Context Manager + // [access policy][google.identity.accesscontextmanager.v1.AccessPolicy]. + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + option (google.api.http) = { + post: "/v1/{resource=accessPolicies/*}:getIamPolicy" + body: "*" + }; + } + + // Returns the IAM permissions that the caller has on the specified Access + // Context Manager resource. The resource can be an + // [AccessPolicy][google.identity.accesscontextmanager.v1.AccessPolicy], + // [AccessLevel][google.identity.accesscontextmanager.v1.AccessLevel], or + // [ServicePerimeter][google.identity.accesscontextmanager.v1.ServicePerimeter + // ]. This method does not support other resources. + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + option (google.api.http) = { + post: "/v1/{resource=accessPolicies/*}:testIamPermissions" + body: "*" + additional_bindings { + post: "/v1/{resource=accessPolicies/*/accessLevels/*}:testIamPermissions" + body: "*" + } + additional_bindings { + post: "/v1/{resource=accessPolicies/*/servicePerimeters/*}:testIamPermissions" + body: "*" + } + }; + } } // A request to list all `AccessPolicies` for a container. @@ -807,7 +851,7 @@ message CommitServicePerimetersRequest { ]; // Optional. The etag for the version of the [Access Policy] - // [google.identity.accesscontextmanager.v1alpha.AccessPolicy] that this + // [google.identity.accesscontextmanager.v1.AccessPolicy] that this // commit operation is to be performed on. If, at the time of commit, the // etag for the Access Policy stored in Access Context Manager is different // from the specified etag, then the commit operation will not be performed @@ -826,6 +870,20 @@ message CommitServicePerimetersResponse { repeated ServicePerimeter service_perimeters = 1; } +// The format used in an `AccessLevel`. +enum LevelFormat { + // The format was not specified. + LEVEL_FORMAT_UNSPECIFIED = 0; + + // Uses the format the resource was defined in. BasicLevels are returned as + // BasicLevels, CustomLevels are returned as CustomLevels. + AS_DEFINED = 1; + + // Use Cloud Common Expression Language when returning the resource. Both + // BasicLevels and CustomLevels are returned as CustomLevels. + CEL = 2; +} + // Request of [ListGcpUserAccessBindings] // [google.identity.accesscontextmanager.v1.AccessContextManager.ListGcpUserAccessBindings]. message ListGcpUserAccessBindingsRequest { @@ -848,20 +906,6 @@ message ListGcpUserAccessBindingsRequest { string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The format used in an `AccessLevel`. -enum LevelFormat { - // The format was not specified. - LEVEL_FORMAT_UNSPECIFIED = 0; - - // Uses the format the resource was defined in. BasicLevels are returned as - // BasicLevels, CustomLevels are returned as CustomLevels. - AS_DEFINED = 1; - - // Use Cloud Common Expression Language when returning the resource. Both - // BasicLevels and CustomLevels are returned as CustomLevels. - CEL = 2; -} - // Response of [ListGcpUserAccessBindings] // [google.identity.accesscontextmanager.v1.AccessContextManager.ListGcpUserAccessBindings]. message ListGcpUserAccessBindingsResponse { diff --git a/google/identity/accesscontextmanager/v1/access_level.proto b/google/identity/accesscontextmanager/v1/access_level.proto index c4eece0a5..b7b9c75c6 100644 --- a/google/identity/accesscontextmanager/v1/access_level.proto +++ b/google/identity/accesscontextmanager/v1/access_level.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. diff --git a/google/identity/accesscontextmanager/v1/access_policy.proto b/google/identity/accesscontextmanager/v1/access_policy.proto index 59f2d9119..747464784 100644 --- a/google/identity/accesscontextmanager/v1/access_policy.proto +++ b/google/identity/accesscontextmanager/v1/access_policy.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. @@ -51,6 +51,22 @@ message AccessPolicy { // Required. Human readable title. Does not affect behavior. string title = 3; + // The scopes of a policy define which resources an ACM policy can restrict, + // and where ACM resources can be referenced. + // For example, a policy with scopes=["folders/123"] has the following + // behavior: + // - vpcsc perimeters can only restrict projects within folders/123 + // - access levels can only be referenced by resources within folders/123. + // If empty, there are no limitations on which resources can be restricted by + // an ACM policy, and there are no limitations on where ACM resources can be + // referenced. + // Only one policy can include a given scope (attempting to create a second + // policy which includes "folders/123" will result in an error). + // Currently, scopes cannot be modified after a policy is created. + // Currently, policies can only have a single scope. + // Format: list of `folders/{folder_number}` or `projects/{project_number}` + repeated string scopes = 7; + // Output only. Time the `AccessPolicy` was created in UTC. google.protobuf.Timestamp create_time = 4; diff --git a/google/identity/accesscontextmanager/v1/accesscontextmanager_v1.yaml b/google/identity/accesscontextmanager/v1/accesscontextmanager_v1.yaml index 4d2aa1782..b403f0a60 100644 --- a/google/identity/accesscontextmanager/v1/accesscontextmanager_v1.yaml +++ b/google/identity/accesscontextmanager/v1/accesscontextmanager_v1.yaml @@ -5,6 +5,7 @@ title: Access Context Manager API apis: - name: google.identity.accesscontextmanager.v1.AccessContextManager +- name: google.longrunning.Operations types: - name: google.identity.accesscontextmanager.v1.AccessContextManagerOperationMetadata diff --git a/google/identity/accesscontextmanager/v1/gcp_user_access_binding.proto b/google/identity/accesscontextmanager/v1/gcp_user_access_binding.proto index 28e06a68a..5dbded9cc 100644 --- a/google/identity/accesscontextmanager/v1/gcp_user_access_binding.proto +++ b/google/identity/accesscontextmanager/v1/gcp_user_access_binding.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. diff --git a/google/identity/accesscontextmanager/v1/service_perimeter.proto b/google/identity/accesscontextmanager/v1/service_perimeter.proto index 3a676d22e..c0851cbe1 100644 --- a/google/identity/accesscontextmanager/v1/service_perimeter.proto +++ b/google/identity/accesscontextmanager/v1/service_perimeter.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. @@ -135,6 +135,26 @@ message ServicePerimeterConfig { repeated string allowed_services = 2; } + // Specifies the types of identities that are allowed access in either + // [IngressFrom] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressFrom] + // or [EgressFrom] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom] + // rules. + enum IdentityType { + // No blanket identity group specified. + IDENTITY_TYPE_UNSPECIFIED = 0; + + // Authorize access from all identities outside the perimeter. + ANY_IDENTITY = 1; + + // Authorize access from all human users outside the perimeter. + ANY_USER_ACCOUNT = 2; + + // Authorize access from all service accounts outside the perimeter. + ANY_SERVICE_ACCOUNT = 3; + } + // An allowed method or permission of a service specified in [ApiOperation] // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation]. message MethodSelector { @@ -213,41 +233,6 @@ message ServicePerimeterConfig { } } - // Defines the conditions under which an [EgressPolicy] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] - // matches a request. Conditions are based on information about the - // [ApiOperation] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] - // intended to be performed on the `resources` specified. Note that if the - // destination of the request is also protected by a [ServicePerimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter], then that - // [ServicePerimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] must have - // an [IngressPolicy] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] - // which allows access in order for this request to succeed. The request must - // match `operations` AND `resources` fields in order to be allowed egress out - // of the perimeter. - message EgressTo { - // A list of resources, currently only projects in the form - // `projects/`, that are allowed to be accessed by sources - // defined in the corresponding [EgressFrom] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. - // A request matches if it contains a resource in this list. If `*` is - // specified for `resources`, then this [EgressTo] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] - // rule will authorize access to all resources outside the perimeter. - repeated string resources = 1; - - // A list of [ApiOperations] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] - // allowed to be performed by the sources specified in the corresponding - // [EgressFrom] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. - // A request matches if it uses an operation/service in this list. - repeated ApiOperation operations = 2; - } - // Defines the conditions under which an [IngressPolicy] // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] // matches a request. Conditions are based on information about the source of @@ -334,6 +319,72 @@ message ServicePerimeterConfig { IngressTo ingress_to = 2; } + // Defines the conditions under which an [EgressPolicy] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] + // matches a request. Conditions based on information about the source of the + // request. Note that if the destination of the request is also protected by a + // [ServicePerimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter], then that + // [ServicePerimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] must have + // an [IngressPolicy] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] + // which allows access in order for this request to succeed. + message EgressFrom { + // A list of identities that are allowed access through this [EgressPolicy]. + // Should be in the format of email address. The email address should + // represent individual user or service account only. + repeated string identities = 1; + + // Specifies the type of identities that are allowed access to outside the + // perimeter. If left unspecified, then members of `identities` field will + // be allowed access. + IdentityType identity_type = 2; + } + + // Defines the conditions under which an [EgressPolicy] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] + // matches a request. Conditions are based on information about the + // [ApiOperation] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] + // intended to be performed on the `resources` specified. Note that if the + // destination of the request is also protected by a [ServicePerimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter], then that + // [ServicePerimeter] + // [google.identity.accesscontextmanager.v1.ServicePerimeter] must have + // an [IngressPolicy] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] + // which allows access in order for this request to succeed. The request must + // match `operations` AND `resources` fields in order to be allowed egress out + // of the perimeter. + message EgressTo { + // A list of resources, currently only projects in the form + // `projects/`, that are allowed to be accessed by sources + // defined in the corresponding [EgressFrom] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. + // A request matches if it contains a resource in this list. If `*` is + // specified for `resources`, then this [EgressTo] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressTo] + // rule will authorize access to all resources outside the perimeter. + repeated string resources = 1; + + // A list of [ApiOperations] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.ApiOperation] + // allowed to be performed by the sources specified in the corresponding + // [EgressFrom] + // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom]. + // A request matches if it uses an operation/service in this list. + repeated ApiOperation operations = 2; + + // A list of external resources that are allowed to be accessed. Only AWS + // and Azure resources are supported. For Amazon S3, the supported format is + // s3://BUCKET_NAME. For Azure Storage, the supported format is + // azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches + // if it contains an external resource in this list (Example: + // s3://bucket/path). Currently '*' is not allowed. + repeated string external_resources = 3; + } + // Policy for egress from perimeter. // // [EgressPolicies] @@ -376,49 +427,6 @@ message ServicePerimeterConfig { EgressTo egress_to = 2; } - // Defines the conditions under which an [EgressPolicy] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressPolicy] - // matches a request. Conditions based on information about the source of the - // request. Note that if the destination of the request is also protected by a - // [ServicePerimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter], then that - // [ServicePerimeter] - // [google.identity.accesscontextmanager.v1.ServicePerimeter] must have - // an [IngressPolicy] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressPolicy] - // which allows access in order for this request to succeed. - message EgressFrom { - // A list of identities that are allowed access through this [EgressPolicy]. - // Should be in the format of email address. The email address should - // represent individual user or service account only. - repeated string identities = 1; - - // Specifies the type of identities that are allowed access to outside the - // perimeter. If left unspecified, then members of `identities` field will - // be allowed access. - IdentityType identity_type = 2; - } - - // Specifies the types of identities that are allowed access in either - // [IngressFrom] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.IngressFrom] - // or [EgressFrom] - // [google.identity.accesscontextmanager.v1.ServicePerimeterConfig.EgressFrom] - // rules. - enum IdentityType { - // No blanket identity group specified. - IDENTITY_TYPE_UNSPECIFIED = 0; - - // Authorize access from all identities outside the perimeter. - ANY_IDENTITY = 1; - - // Authorize access from all human users outside the perimeter. - ANY_USER_ACCOUNT = 2; - - // Authorize access from all service accounts outside the perimeter. - ANY_SERVICE_ACCOUNT = 3; - } - // A list of Google Cloud resources that are inside of the service perimeter. // Currently only projects are allowed. Format: `projects/{project_number}` repeated string resources = 1; diff --git a/google/logging/v2/BUILD.bazel b/google/logging/v2/BUILD.bazel index 34772c6bf..a86ebc3c5 100644 --- a/google/logging/v2/BUILD.bazel +++ b/google/logging/v2/BUILD.bazel @@ -9,14 +9,44 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "logging_proto", @@ -54,18 +84,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "logging_java_proto", deps = [":logging_proto"], @@ -82,10 +100,12 @@ java_gapic_library( srcs = [":logging_proto_with_info"], gapic_yaml = "logging_gapic.yaml", grpc_service_config = "logging_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "logging_v2.yaml", test_deps = [ ":logging_java_grpc", ], + transport = "grpc", deps = [ ":logging_java_proto", "//google/api:api_java_proto", @@ -105,6 +125,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-logging-v2-java", + include_samples = True, + transport = "grpc", deps = [ ":logging_java_gapic", ":logging_java_grpc", @@ -113,17 +135,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "logging_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -146,14 +157,16 @@ go_gapic_library( grpc_service_config = "logging_grpc_service_config.json", importpath = "cloud.google.com/go/logging/apiv2;logging", metadata = True, + rest_numeric_enums = True, service_yaml = "logging_v2.yaml", + transport = "grpc", deps = [ ":logging_go_proto", "//google/api:metric_go_proto", "//google/api:monitoredres_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", "@io_bazel_rules_go//proto/wkt:any_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", "@io_bazel_rules_go//proto/wkt:struct_go_proto", @@ -178,15 +191,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "logging_py_gapic", srcs = [":logging_proto"], @@ -195,6 +199,7 @@ py_gapic_library( "python-gapic-name=logging", "python-gapic-namespace=google.cloud", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -217,17 +222,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "logging_php_proto", deps = [":logging_proto"], @@ -244,6 +238,8 @@ php_gapic_library( srcs = [":logging_proto_with_info"], gapic_yaml = "logging_gapic.yaml", grpc_service_config = "logging_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":logging_php_grpc", ":logging_php_proto", @@ -260,15 +256,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "logging_nodejs_gapic", package_name = "@google-cloud/logging", @@ -278,7 +265,9 @@ nodejs_gapic_library( grpc_service_config = "logging_grpc_service_config.json", main_service = "logging", package = "google.logging.v2", + rest_numeric_enums = True, service_yaml = "logging_v2.yaml", + transport = "grpc", deps = [], ) @@ -290,17 +279,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "logging_ruby_proto", deps = [":logging_proto"], @@ -325,6 +303,7 @@ ruby_cloud_gapic_library( "ruby-cloud-yard-strict=false", ], grpc_service_config = "logging_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Cloud Logging API lets you programmatically read and write log entries, set up exclusions, create logs-based metrics, and manage export sinks.", ruby_cloud_title = "Cloud Logging V2", deps = [ @@ -343,17 +322,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "logging_csharp_proto", deps = [":logging_proto"], @@ -370,6 +338,7 @@ csharp_gapic_library( srcs = [":logging_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "logging_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "logging_v2.yaml", deps = [ ":logging_csharp_grpc", @@ -387,15 +356,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "logging_cc_proto", deps = [":logging_proto"], diff --git a/google/longrunning/BUILD.bazel b/google/longrunning/BUILD.bazel index c1366e74b..e52d116e8 100644 --- a/google/longrunning/BUILD.bazel +++ b/google/longrunning/BUILD.bazel @@ -88,6 +88,7 @@ go_gapic_library( srcs = [":longrunning_proto_with_info"], grpc_service_config = "longrunning_grpc_service_config.json", importpath = "cloud.google.com/go/longrunning/autogen;longrunning", + rest_numeric_enums = False, service_yaml = "//google/longrunning:longrunning.yaml", transport = "grpc+rest", deps = [":longrunning_go_proto"], @@ -150,6 +151,7 @@ csharp_gapic_library( srcs = [":longrunning_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "longrunning_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "//google/longrunning:longrunning.yaml", deps = [ ":longrunning_csharp_grpc", @@ -193,7 +195,9 @@ php_gapic_library( name = "longrunning_php_gapic", srcs = [":longrunning_proto_with_info"], grpc_service_config = "longrunning_grpc_service_config.json", + rest_numeric_enums = False, service_yaml = "//google/longrunning:longrunning.yaml", + transport = "grpc+rest", deps = [ ":longrunning_php_grpc", ":longrunning_php_proto", @@ -209,3 +213,38 @@ php_gapic_assembly_pkg( ":longrunning_php_proto", ], ) + +############################################################################## +# Python +############################################################################## +load( + "@com_google_googleapis_imports//:imports.bzl", + "moved_proto_library", + "py_grpc_library", + "py_proto_library", +) + +moved_proto_library( + name = "longrunning_moved_proto", + srcs = [":operations_proto"], + deps = [ + "//google/api:annotations_proto", + "//google/api:client_proto", + "//google/rpc:status_proto", + "@com_google_protobuf//:any_proto", + "@com_google_protobuf//:descriptor_proto", + "@com_google_protobuf//:duration_proto", + "@com_google_protobuf//:empty_proto", + ], +) + +py_proto_library( + name = "longrunning_py_proto", + deps = [":longrunning_moved_proto"], +) + +py_grpc_library( + name = "longrunning_py_grpc", + srcs = [":longrunning_moved_proto"], + deps = [":longrunning_py_proto"], +) diff --git a/google/maps/addressvalidation/v1/BUILD.bazel b/google/maps/addressvalidation/v1/BUILD.bazel index cab92c450..dc1d48f1c 100644 --- a/google/maps/addressvalidation/v1/BUILD.bazel +++ b/google/maps/addressvalidation/v1/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":addressvalidation_proto_with_info"], gapic_yaml = None, grpc_service_config = "addressvalidation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "addressvalidation_v1.yaml", test_deps = [ ":addressvalidation_java_grpc", @@ -176,9 +177,23 @@ py_gapic_library( name = "addressvalidation_py_gapic", srcs = [":addressvalidation_proto"], grpc_service_config = "addressvalidation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "addressvalidation_v1.yaml", transport = "grpc", deps = [ + "//google/geo/type:viewport_py_proto", + ], +) + +py_test( + name = "addressvalidation_py_gapic_test", + srcs = [ + "addressvalidation_py_gapic_pytest.py", + "addressvalidation_py_gapic_test.py", + ], + legacy_create_init = False, + deps = [ + ":addressvalidation_py_gapic", ], ) @@ -216,7 +231,9 @@ php_gapic_library( name = "addressvalidation_php_gapic", srcs = [":addressvalidation_proto_with_info"], grpc_service_config = "addressvalidation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "addressvalidation_v1.yaml", + transport = "grpc+rest", deps = [ ":addressvalidation_php_grpc", ":addressvalidation_php_proto", @@ -244,12 +261,14 @@ load( nodejs_gapic_library( name = "addressvalidation_nodejs_gapic", - package_name = "@google-cloud/addressvalidation", + package_name = "@googlemaps/addressvalidation", src = ":addressvalidation_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "addressvalidation_grpc_service_config.json", package = "google.maps.addressvalidation.v1", + rest_numeric_enums = True, service_yaml = "addressvalidation_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -258,6 +277,7 @@ nodejs_gapic_assembly_pkg( deps = [ ":addressvalidation_nodejs_gapic", ":addressvalidation_proto", + "//google/geo/type:viewport_proto", ], ) @@ -293,6 +313,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://developers.google.com/maps/documentation/address-validation/", ], grpc_service_config = "addressvalidation_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Address Validation is an API that accepts an address, identifies its components, validates them, normalizes the address for mailing and finds the best known location for it. It can help understand if an address refers to a real place. If the address does not refer to a real place, it can identify possibly wrong components, enabling users to correct them.", ruby_cloud_title = "Address Validation V1", service_yaml = "addressvalidation_v1.yaml", @@ -339,6 +360,7 @@ csharp_gapic_library( srcs = [":addressvalidation_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "addressvalidation_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "addressvalidation_v1.yaml", deps = [ ":addressvalidation_csharp_grpc", diff --git a/google/maps/addressvalidation/v1/address.proto b/google/maps/addressvalidation/v1/address.proto index afbe31975..ee0bbeb72 100644 --- a/google/maps/addressvalidation/v1/address.proto +++ b/google/maps/addressvalidation/v1/address.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.maps.addressvalidation.v1; +import "google/api/field_behavior.proto"; import "google/type/postal_address.proto"; option cc_enable_arenas = true; @@ -28,7 +29,6 @@ option objc_class_prefix = "GMPAVV1"; option php_namespace = "Google\\Maps\\AddressValidation\\V1"; option ruby_package = "Google::Maps::AddressValidation::V1"; - // Details of the address parsed from the input. message Address { // The corrected address, formatted as a single-line address following the @@ -38,18 +38,21 @@ message Address { // The validated address represented as a postal address. google.type.PostalAddress postal_address = 3; - // The individual address components of the formatted and corrected address, + // Unordered list. The individual address components of the formatted and corrected address, // along with validation information. This provides information on the // validation status of the individual components. - repeated AddressComponent address_components = 4; + // + // Address components are not ordered in a particular way. Do not make any + // assumptions on the ordering of the address components in the list. + repeated AddressComponent address_components = 4 [(google.api.field_behavior) = UNORDERED_LIST]; // The types of components that were expected to be present in a correctly // formatted mailing address but were not found in the input AND could // not be inferred. Components of this type are not present in // `formatted_address`, `postal_address`, or `address_components`. An - // example might be `[‘street_number’, ‘route’]` for an input like - // “Boulder, Colorado, 80301, USA.” The list of possible types can be found - // [here](https://developers.google.com/maps/documentation/geocoding/overview#Types). + // example might be `['street_number', 'route']` for an input like + // "Boulder, Colorado, 80301, USA". The list of possible types can be found + // [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). repeated string missing_component_types = 5; // The types of the components that are present in the `address_components` @@ -61,8 +64,8 @@ message Address { // [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED] // or the // [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred] - // flag is not set to `true`.The list of possible types can be found - // [here](https://developers.google.com/maps/documentation/geocoding/overview#Types). + // flag is not set to `true`. The list of possible types can be found + // [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). repeated string unconfirmed_component_types = 6; // Any tokens in the input that could not be resolved. This might be an diff --git a/google/maps/addressvalidation/v1/address_validation_service.proto b/google/maps/addressvalidation/v1/address_validation_service.proto index 46a8699a6..ee873b8ae 100644 --- a/google/maps/addressvalidation/v1/address_validation_service.proto +++ b/google/maps/addressvalidation/v1/address_validation_service.proto @@ -35,13 +35,13 @@ option objc_class_prefix = "GMPAVV1"; option php_namespace = "Google\\Maps\\AddressValidation\\V1"; option ruby_package = "Google::Maps::AddressValidation::V1"; - // The service for validating addresses. service AddressValidation { option (google.api.default_host) = "addressvalidation.googleapis.com"; // Validates an address. - rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse) { + rpc ValidateAddress(ValidateAddressRequest) + returns (ValidateAddressResponse) { option (google.api.http) = { post: "/v1:validateAddress" body: "*" @@ -53,7 +53,8 @@ service AddressValidation { // same address, and should be called once the transaction is concluded. This // should only be sent once for the sequence of `ValidateAddress` requests // needed to validate an address fully. - rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse) { + rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) + returns (ProvideValidationFeedbackResponse) { option (google.api.http) = { post: "/v1:provideValidationFeedback" body: "*" @@ -66,22 +67,23 @@ message ValidateAddressRequest { // Required. The address being validated. Unformatted addresses should be // submitted via [`address_lines`][google.type.PostalAddress.address_lines]. // - // The total length of the fields in this input must not exceed 300 + // The total length of the fields in this input must not exceed 280 // characters. // // Supported regions can be found in the // [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported). // - // The [language_code][google.type.PostalAddress.language_code] value for the - // given address is not yet used. The validated address result will be - // populated based on the preferred language for the given address, as - // identified by the system. + // The [language_code][google.type.PostalAddress.language_code] value in the + // input address is reserved for future uses and is ignored today. The + // validated address result will be populated based on the preferred language + // for the given address, as identified by the system. // // The Address Validation API ignores the values in // [recipients][google.type.PostalAddress.recipients] and // [organization][google.type.PostalAddress.organization]. Any values in those // fields will be discarded and not returned. Please do not set them. - google.type.PostalAddress address = 1 [(google.api.field_behavior) = REQUIRED]; + google.type.PostalAddress address = 1 + [(google.api.field_behavior) = REQUIRED]; // This field must be empty for the first address validation request. If // more requests are necessary to fully validate a single address (for @@ -104,9 +106,6 @@ message ValidateAddressRequest { // at least two [google.type.PostalAddress.address_lines] where the first line // contains the street number and name and the second line contains the city, // state, and zip code. - // - // Warning: though this option will enable the USPS CASS compatible mode, the - // Address Validation API is not yet officially CASS certified. bool enable_usps_cass = 3; } @@ -153,7 +152,8 @@ message ProvideValidationFeedbackRequest { // `INVALID_ARGUMENT` error will be returned. ValidationConclusion conclusion = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID of the response that this feedback is for. This should be the + // Required. The ID of the response that this feedback is for. This should be + // the // [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] // from the first response in a series of address validation attempts. string response_id = 2 [(google.api.field_behavior) = REQUIRED]; @@ -162,9 +162,7 @@ message ProvideValidationFeedbackRequest { // The response for validation feedback. // // The response is empty if the feedback is sent successfully. -message ProvideValidationFeedbackResponse { - -} +message ProvideValidationFeedbackResponse {} // The result of validating an address. message ValidationResult { @@ -180,8 +178,8 @@ message ValidationResult { // Other information relevant to deliverability. AddressMetadata metadata = 4; - // Extra deliverability flags provided by USPS. Only provided for US - // addresses. + // Extra deliverability flags provided by USPS. Only provided in region `US` + // and `PR`. UspsData usps_data = 5; } @@ -206,7 +204,7 @@ message Verdict { PREMISE = 2; // A geocode that should be very close to the building-level location of - // the address. Only used for geocodes and not for addresses. + // the address. PREMISE_PROXIMITY = 3; // The address or geocode indicates a block. Only used in regions which diff --git a/google/maps/addressvalidation/v1/addressvalidation_v1.yaml b/google/maps/addressvalidation/v1/addressvalidation_v1.yaml index b053120b3..b94c04546 100644 --- a/google/maps/addressvalidation/v1/addressvalidation_v1.yaml +++ b/google/maps/addressvalidation/v1/addressvalidation_v1.yaml @@ -12,4 +12,7 @@ documentation: addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address. - overview: The Address Validation API allows developers to ... + overview: |- + The Address Validation API allows developers to validate an address and + its components, standardize the address for mailing, and determine the + best known geocode for it. diff --git a/google/maps/addressvalidation/v1/geocode.proto b/google/maps/addressvalidation/v1/geocode.proto index ab5abed35..a2be0f9fb 100644 --- a/google/maps/addressvalidation/v1/geocode.proto +++ b/google/maps/addressvalidation/v1/geocode.proto @@ -29,7 +29,6 @@ option objc_class_prefix = "GMPAVV1"; option php_namespace = "Google\\Maps\\AddressValidation\\V1"; option ruby_package = "Google::Maps::AddressValidation::V1"; - // Contains information about the place the input was geocoded to. message Geocode { // The geocoded location of the input. @@ -62,10 +61,8 @@ message Geocode { string place_id = 6; // The type(s) of place that the input geocoded to. For example, - // `['locality', 'political']`. The full list of types - // can be - // found - // [here](https://developers.google.com/maps/documentation/geocoding/overview#Types). + // `['locality', 'political']`. The full list of types can be found + // [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). repeated string place_types = 7; } diff --git a/google/maps/addressvalidation/v1/metadata.proto b/google/maps/addressvalidation/v1/metadata.proto index 665e0c0e9..b016342ba 100644 --- a/google/maps/addressvalidation/v1/metadata.proto +++ b/google/maps/addressvalidation/v1/metadata.proto @@ -26,12 +26,8 @@ option objc_class_prefix = "GMPAVV1"; option php_namespace = "Google\\Maps\\AddressValidation\\V1"; option ruby_package = "Google::Maps::AddressValidation::V1"; -// The metadata for the address +// The metadata for the address. message AddressMetadata { - // Indicates that this address is a high-rise building. - // If unset, indicates that the value is unknown. - optional bool highrise = 1; - // Indicates that this is the address of a business. // If unset, indicates that the value is unknown. optional bool business = 2; @@ -40,10 +36,6 @@ message AddressMetadata { // If unset, indicates that the value is unknown. optional bool po_box = 3; - // Indicates that the address is of a multi_family building. - // If unset, indicates that the value is unknown. - optional bool multi_family = 4; - // Indicates that this is the address of a residence. // If unset, indicates that the value is unknown. optional bool residential = 6; diff --git a/google/maps/addressvalidation/v1/usps_data.proto b/google/maps/addressvalidation/v1/usps_data.proto index 862a3be4c..e0da74019 100644 --- a/google/maps/addressvalidation/v1/usps_data.proto +++ b/google/maps/addressvalidation/v1/usps_data.proto @@ -26,7 +26,6 @@ option objc_class_prefix = "GMPAVV1"; option php_namespace = "Google\\Maps\\AddressValidation\\V1"; option ruby_package = "Google::Maps::AddressValidation::V1"; - // USPS representation of a US address. message UspsAddress { // First address line. @@ -125,6 +124,19 @@ message UspsData { // * `N`: The address is active string dpv_no_stat = 8; + // The carrier route code. + // A four character code consisting of a one letter prefix and a three digit + // route designator. + // + // Prefixes: + // + // * `C`: Carrier route (or city route) + // * `R`: Rural route + // * `H`: Highway Contract Route + // * `B`: Post Office Box Section + // * `G`: General delivery unit + string carrier_route = 9; + // Carrier route rate sort indicator. string carrier_route_indicator = 10; @@ -194,9 +206,13 @@ message UspsData { // exists. bool default_address = 26; - // Error message for USPS data retrieval. If this field is populated, other - // USPS data response fields - with the possible exception of - // carrier_route - are not populated. Otherwise, fields with data are - // populated. + // Error message for USPS data retrieval. This is populated when USPS + // processing is suspended because of the detection of artificially created + // addresses. + // + // The USPS data fields might not be populated when this error is present. string error_message = 27; + + // Indicator that the request has been CASS processed. + bool cass_processed = 28; } diff --git a/google/maps/fleetengine/delivery/v1/BUILD.bazel b/google/maps/fleetengine/delivery/v1/BUILD.bazel index 469e18330..762cfe9c7 100644 --- a/google/maps/fleetengine/delivery/v1/BUILD.bazel +++ b/google/maps/fleetengine/delivery/v1/BUILD.bazel @@ -9,14 +9,42 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "delivery_proto", @@ -50,18 +78,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "delivery_java_proto", deps = [":delivery_proto"], @@ -78,6 +94,7 @@ java_gapic_library( srcs = [":delivery_proto_with_info"], gapic_yaml = None, grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", test_deps = [ ":delivery_java_grpc", @@ -102,6 +119,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-maps-fleetengine-delivery-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":delivery_java_gapic", @@ -111,17 +129,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "delivery_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -140,6 +147,7 @@ go_gapic_library( grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", importpath = "google.golang.org/maps/fleetengine/delivery/v1;delivery", metadata = True, + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", transport = "grpc+rest", deps = [ @@ -166,19 +174,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "delivery_py_gapic", srcs = [":delivery_proto"], grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/geo/type:viewport_py_proto", @@ -204,17 +204,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "delivery_php_proto", deps = [":delivery_proto"], @@ -230,7 +219,9 @@ php_gapic_library( name = "delivery_php_gapic", srcs = [":delivery_proto_with_info"], grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", + transport = "grpc+rest", deps = [ ":delivery_php_grpc", ":delivery_php_proto", @@ -247,15 +238,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "delivery_nodejs_gapic", package_name = "@googlemaps/fleetengine-delivery", @@ -263,7 +245,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", package = "maps.fleetengine.delivery.v1", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", + transport = "grpc+rest", deps = [], ) @@ -276,17 +260,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "delivery_ruby_proto", deps = [":delivery_proto"], @@ -305,6 +278,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-maps-fleetengine-delivery-v1", ], grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":delivery_ruby_grpc", ":delivery_ruby_proto", @@ -321,17 +295,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "delivery_csharp_proto", deps = [":delivery_proto"], @@ -348,6 +311,7 @@ csharp_gapic_library( srcs = [":delivery_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "//google/maps/fleetengine/v1:fleetengine_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":delivery_csharp_grpc", ":delivery_csharp_proto", diff --git a/google/maps/fleetengine/delivery/v1/delivery_api.proto b/google/maps/fleetengine/delivery/v1/delivery_api.proto index 8b2b402b8..6fe021d81 100644 --- a/google/maps/fleetengine/delivery/v1/delivery_api.proto +++ b/google/maps/fleetengine/delivery/v1/delivery_api.proto @@ -281,6 +281,11 @@ message ListDeliveryVehiclesRequest { // boolean values, the values must be explicitly quoted to be treated as // strings (for example, `attributes. = "10"` or // `attributes. = "true"`). + // + // The maximum number of restrictions allowed in a filter query is 50. A + // restriction is a part of the query of the form + // `attribute. `, for example `attributes.foo = bar` + // is 1 restriction. string filter = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. A filter that limits the search area to a rectangle defined by the diff --git a/google/maps/fleetengine/v1/BUILD.bazel b/google/maps/fleetengine/v1/BUILD.bazel index fb29fc424..17c8bb0a3 100644 --- a/google/maps/fleetengine/v1/BUILD.bazel +++ b/google/maps/fleetengine/v1/BUILD.bazel @@ -9,14 +9,42 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "fleetengine_proto", @@ -52,18 +80,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "fleetengine_java_proto", deps = [":fleetengine_proto"], @@ -80,10 +96,12 @@ java_gapic_library( srcs = [":fleetengine_proto_with_info"], gapic_yaml = None, grpc_service_config = "fleetengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", test_deps = [ ":fleetengine_java_grpc", ], + transport = "grpc", deps = [ ":fleetengine_java_proto", "//google/api:api_java_proto", @@ -102,6 +120,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-maps-fleetengine-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":fleetengine_java_gapic", ":fleetengine_java_grpc", @@ -110,17 +130,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "fleetengine_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -138,7 +147,9 @@ go_gapic_library( grpc_service_config = "fleetengine_grpc_service_config.json", importpath = "google.golang.org/maps/fleetengine/v1;fleetengine", metadata = True, + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", + transport = "grpc", deps = [ ":fleetengine_go_proto", "@io_bazel_rules_go//proto/wkt:duration_go_proto", @@ -163,19 +174,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "fleetengine_py_gapic", srcs = [":fleetengine_proto"], grpc_service_config = "fleetengine_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -198,17 +201,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "fleetengine_php_proto", deps = [":fleetengine_proto"], @@ -224,7 +216,9 @@ php_gapic_library( name = "fleetengine_php_gapic", srcs = [":fleetengine_proto_with_info"], grpc_service_config = "fleetengine_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", + transport = "grpc+rest", deps = [ ":fleetengine_php_grpc", ":fleetengine_php_proto", @@ -241,15 +235,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "fleetengine_nodejs_gapic", package_name = "@googlemaps/fleetengine", @@ -257,7 +242,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "fleetengine_grpc_service_config.json", package = "maps.fleetengine.v1", + rest_numeric_enums = True, service_yaml = "fleetengine.yaml", + transport = "grpc", deps = [], ) @@ -270,17 +257,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "fleetengine_ruby_proto", deps = [":fleetengine_proto"], @@ -297,6 +273,7 @@ ruby_cloud_gapic_library( srcs = [":fleetengine_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-maps-fleetengine-v1"], grpc_service_config = "fleetengine_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":fleetengine_ruby_grpc", ":fleetengine_ruby_proto", @@ -313,17 +290,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "fleetengine_csharp_proto", deps = [":fleetengine_proto"], @@ -340,6 +306,7 @@ csharp_gapic_library( srcs = [":fleetengine_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "fleetengine_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":fleetengine_csharp_grpc", ":fleetengine_csharp_proto", diff --git a/google/maps/fleetengine/v1/trip_api.proto b/google/maps/fleetengine/v1/trip_api.proto index 8031d951a..90a468444 100644 --- a/google/maps/fleetengine/v1/trip_api.proto +++ b/google/maps/fleetengine/v1/trip_api.proto @@ -341,20 +341,19 @@ message SearchTripsRequest { // * `eta_to_first_waypoint` string vehicle_id = 4; - // If set to true, only Trips that influence the drivers route - // are included in the response. + // If set to true, the response includes Trips that influence a driver's + // route. bool active_trips_only = 5; - // If not set, the server will decide the number of - // results to return. + // If not set, the server decides the number of results to return. int32 page_size = 6; - // Set this to a value previously returned in the - // SearchTripsResponse to continue from previous results. + // Set this to a value previously returned in the `SearchTripsResponse` to + // continue from previous results. string page_token = 7; - // If specified, returns the trips that have not been updated after - // the time `(current - minimum_staleness)`. + // If specified, returns the trips that have not been updated after the time + // `(current - minimum_staleness)`. google.protobuf.Duration minimum_staleness = 8; } diff --git a/google/maps/fleetengine/v1/trips.proto b/google/maps/fleetengine/v1/trips.proto index 46ba96b47..d1ea894c4 100644 --- a/google/maps/fleetengine/v1/trips.proto +++ b/google/maps/fleetengine/v1/trips.proto @@ -56,17 +56,20 @@ message Trip { // Input only. The actual location when and where customer was picked up. // This field is for provider to provide feedback on actual pickup // information. - StopLocation actual_pickup_point = 22 [(google.api.field_behavior) = INPUT_ONLY]; + StopLocation actual_pickup_point = 22 + [(google.api.field_behavior) = INPUT_ONLY]; // Input only. The actual time and location of the driver arrival at // the pickup point. // This field is for provider to provide feedback on actual arrival // information at the pickup point. - StopLocation actual_pickup_arrival_point = 32 [(google.api.field_behavior) = INPUT_ONLY]; + StopLocation actual_pickup_arrival_point = 32 + [(google.api.field_behavior) = INPUT_ONLY]; - // Output only. Either the estimated future time when the rider(s) will be picked up, or - // the actual time when they were picked up. - google.protobuf.Timestamp pickup_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Either the estimated future time when the rider(s) will be + // picked up, or the actual time when they were picked up. + google.protobuf.Timestamp pickup_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Intermediate stops in order that the trip requests (in addition // to pickup and dropoff). Initially this will not be supported for shared @@ -76,7 +79,7 @@ message Trip { // Indicates the last time the `intermediate_destinations` was modified. // Your server should cache this value and pass it in `UpdateTripRequest` // when update `intermediate_destination_index` to ensure the - // Trip.intermediate_destinations is not changed. + // `intermediate_destinations` is not changed. google.protobuf.Timestamp intermediate_destinations_version = 25; // When `TripStatus` is `ENROUTE_TO_INTERMEDIATE_DESTINATION`, a number @@ -91,29 +94,34 @@ message Trip { // an intermediate destination. // This field is for provider to provide feedback on actual arrival // information at intermediate destinations. - repeated StopLocation actual_intermediate_destination_arrival_points = 33 [(google.api.field_behavior) = INPUT_ONLY]; + repeated StopLocation actual_intermediate_destination_arrival_points = 33 + [(google.api.field_behavior) = INPUT_ONLY]; - // Input only. The actual time and location when and where the customer was picked up from - // an intermediate destination. - // This field is for provider to provide feedback on actual pickup - // information at intermediate destinations. - repeated StopLocation actual_intermediate_destinations = 34 [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. The actual time and location when and where the customer was + // picked up from an intermediate destination. This field is for provider to + // provide feedback on actual pickup information at intermediate destinations. + repeated StopLocation actual_intermediate_destinations = 34 + [(google.api.field_behavior) = INPUT_ONLY]; // Location where customer indicates they will be dropped off. TerminalLocation dropoff_point = 7; - // Input only. The actual time and location when and where customer was dropped off. - // This field is for provider to provide feedback on actual dropoff - // information. - StopLocation actual_dropoff_point = 23 [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. The actual time and location when and where customer was + // dropped off. This field is for provider to provide feedback on actual + // dropoff information. + StopLocation actual_dropoff_point = 23 + [(google.api.field_behavior) = INPUT_ONLY]; - // Output only. Either the estimated future time when the rider(s) will be dropped off at - // the final destination, or the actual time when they were dropped off. - google.protobuf.Timestamp dropoff_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Either the estimated future time when the rider(s) will be + // dropped off at the final destination, or the actual time when they were + // dropped off. + google.protobuf.Timestamp dropoff_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The full path from the current location to the dropoff point, inclusive. - // This path could include waypoints from other trips. - repeated TripWaypoint remaining_waypoints = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The full path from the current location to the dropoff point, + // inclusive. This path could include waypoints from other trips. + repeated TripWaypoint remaining_waypoints = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; // This field supports manual ordering of the waypoints for the trip. It // contains all of the remaining waypoints for the assigned vehicle, as well @@ -123,9 +131,11 @@ message Trip { // calls, NOT on GetTrip calls. repeated TripWaypoint vehicle_waypoints = 20; - // Output only. Anticipated route for this trip to the first entry in remaining_waypoints. - // Note that the first waypoint may belong to a different trip. - repeated google.type.LatLng route = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Anticipated route for this trip to the first entry in + // remaining_waypoints. Note that the first waypoint may belong to a different + // trip. + repeated google.type.LatLng route = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. An encoded path to the next waypoint. // @@ -137,59 +147,73 @@ message Trip { // // Note: This field is intended only for use by the Driver SDK and Consumer // SDK. - google.protobuf.Timestamp current_route_segment_version = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp current_route_segment_version = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Indicates the traffic conditions along the `current_route_segment` when - // they're available. + // Output only. Indicates the traffic conditions along the + // `current_route_segment` when they're available. // // Note: This field is intended only for use by the Driver SDK and Consumer // SDK. - ConsumableTrafficPolyline current_route_segment_traffic = 28 [(google.api.field_behavior) = OUTPUT_ONLY]; + ConsumableTrafficPolyline current_route_segment_traffic = 28 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Indicates the last time the `current_route_segment_traffic` was modified. + // Output only. Indicates the last time the `current_route_segment_traffic` + // was modified. // // Note: This field is intended only for use by the Driver SDK and Consumer // SDK. - google.protobuf.Timestamp current_route_segment_traffic_version = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp current_route_segment_traffic_version = 30 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The waypoint where `current_route_segment` ends. - TripWaypoint current_route_segment_end_point = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; + TripWaypoint current_route_segment_end_point = 24 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The remaining driving distance in the `current_route_segment` field. The - // value is unspecified if the trip is not assigned to a vehicle, or the trip - // is completed or cancelled. - google.protobuf.Int32Value remaining_distance_meters = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The remaining driving distance in the `current_route_segment` + // field. The value is unspecified if the trip is not assigned to a vehicle, + // or the trip is completed or cancelled. + google.protobuf.Int32Value remaining_distance_meters = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The ETA to the next waypoint (the first entry in the `remaining_waypoints` - // field). The value is unspecified if the trip is not assigned to a vehicle, - // or the trip is inactive (completed or cancelled). - google.protobuf.Timestamp eta_to_first_waypoint = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The duration from when the Trip data is returned to the time in - // `Trip.eta_to_first_waypoint`. The value is unspecified if the trip is not + // Output only. The ETA to the next waypoint (the first entry in the + // `remaining_waypoints` field). The value is unspecified if the trip is not // assigned to a vehicle, or the trip is inactive (completed or cancelled). - google.protobuf.Duration remaining_time_to_first_waypoint = 27 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Indicates the last time that `remaining_waypoints` was changed (a - // waypoint was added, removed, or changed). - google.protobuf.Timestamp remaining_waypoints_version = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Indicates the last time the `remaining_waypoints.path_to_waypoint` and + google.protobuf.Timestamp eta_to_first_waypoint = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The duration from when the Trip data is returned to the time + // in `Trip.eta_to_first_waypoint`. The value is unspecified if the trip is + // not assigned to a vehicle, or the trip is inactive (completed or + // cancelled). + google.protobuf.Duration remaining_time_to_first_waypoint = 27 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Indicates the last time that `remaining_waypoints` was changed + // (a waypoint was added, removed, or changed). + google.protobuf.Timestamp remaining_waypoints_version = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Indicates the last time the + // `remaining_waypoints.path_to_waypoint` and // `remaining_waypoints.traffic_to_waypoint` were modified. Your client app // should cache this value and pass it in `GetTripRequest` to ensure the // paths and traffic for `remaining_waypoints` are only returned if updated. - google.protobuf.Timestamp remaining_waypoints_route_version = 29 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp remaining_waypoints_route_version = 29 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. Indicates the number of passengers on this trip and does not include the - // driver. A vehicle must have available capacity to be returned + // Immutable. Indicates the number of passengers on this trip and does not + // include the driver. A vehicle must have available capacity to be returned // in SearchVehicles. int32 number_of_passengers = 10 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. Indicates the last reported location of the vehicle along the route. - VehicleLocation last_location = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Indicates the last reported location of the vehicle along the + // route. + VehicleLocation last_location = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Indicates whether the vehicle's `last_location` can be snapped to - // the current_route_segment. False if `last_location` or + // Output only. Indicates whether the vehicle's `last_location` can be snapped + // to the current_route_segment. False if `last_location` or // `current_route_segment` doesn't exist. // It is computed by Fleet Engine. Any update from clients will be ignored. bool last_location_snappable = 26 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -208,10 +232,8 @@ message StopLocation { google.protobuf.Timestamp timestamp = 2; // Input only. Deprecated. Use the timestamp field. - google.protobuf.Timestamp stop_time = 3 [ - deprecated = true, - (google.api.field_behavior) = INPUT_ONLY - ]; + google.protobuf.Timestamp stop_time = 3 + [deprecated = true, (google.api.field_behavior) = INPUT_ONLY]; } // The status of a trip indicating its progression. diff --git a/google/maps/fleetengine/v1/vehicle_api.proto b/google/maps/fleetengine/v1/vehicle_api.proto index 4dfbb3a41..af377d019 100644 --- a/google/maps/fleetengine/v1/vehicle_api.proto +++ b/google/maps/fleetengine/v1/vehicle_api.proto @@ -126,7 +126,8 @@ service VehicleService { // Deprecated: Use the `UpdateVehicle` method instead. // UpdateVehicleLocation updates the location of the vehicle. - rpc UpdateVehicleLocation(UpdateVehicleLocationRequest) returns (VehicleLocation) { + rpc UpdateVehicleLocation(UpdateVehicleLocationRequest) + returns (VehicleLocation) { option deprecated = true; option (google.api.http) = { put: "/v1/{name=providers/*/vehicles/*}:updateLocation" @@ -145,7 +146,8 @@ service VehicleService { // attributes will NOT be altered. Note: this is different in `UpdateVehicle`, // where the whole `attributes` field will be replaced by the one in // `UpdateVehicleRequest`, attributes not in the request would be removed. - rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse) { + rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) + returns (UpdateVehicleAttributesResponse) { option (google.api.http) = { post: "/v1/{name=providers/*/vehicles/*}:updateAttributes" body: "*" @@ -191,7 +193,8 @@ service VehicleService { // This method does not support the `SearchVehicleRequest.order_by` field. // Vehicle matches in the response will be in order of distance from the // pickup point. Only the `vehicle` and `trip_type` fields will be populated. - rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse) { + rpc SearchFuzzedVehicles(SearchVehiclesRequest) + returns (SearchVehiclesResponse) { option (google.api.http) = { post: "/v1/{parent=providers/*}/vehicles:searchFuzzed" body: "*" @@ -227,8 +230,8 @@ message CreateVehicleRequest { // ',', or '#'. string vehicle_id = 4 [(google.api.field_behavior) = REQUIRED]; - // Required. The Vehicle entity to create. When creating a Vehicle, the following - // fields are required: + // Required. The Vehicle entity to create. When creating a Vehicle, the + // following fields are required: // // * `vehicleState` // * `supportedTripTypes` @@ -319,7 +322,8 @@ message UpdateVehicleRequest { // Required. A field mask indicating which fields of the `Vehicle` to update. // At least one field name must be provided. - google.protobuf.FieldMask update_mask = 5 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 5 + [(google.api.field_behavior) = REQUIRED]; } // `UpdateVehicleLocation` request message. @@ -336,8 +340,8 @@ message UpdateVehicleLocationRequest { // this call is a member. string name = 3 [(google.api.field_behavior) = REQUIRED]; - // Required. The vehicle's most recent location. The `location` and `update_time` - // subfields are required. + // Required. The vehicle's most recent location. The `location` and + // `update_time` subfields are required. VehicleLocation current_location = 4 [(google.api.field_behavior) = REQUIRED]; // Set the vehicle's state to either `ONLINE` or `OFFLINE`. @@ -356,16 +360,18 @@ message UpdateVehicleAttributesRequest { // this call is a member. string name = 3 [(google.api.field_behavior) = REQUIRED]; - // Required. The vehicle attributes to update. Unmentioned attributes will not be - // altered or removed. - repeated VehicleAttribute attributes = 4 [(google.api.field_behavior) = REQUIRED]; + // Required. The vehicle attributes to update. Unmentioned attributes will not + // be altered or removed. + repeated VehicleAttribute attributes = 4 + [(google.api.field_behavior) = REQUIRED]; } // `UpdateVehicleAttributes` response message. message UpdateVehicleAttributesResponse { - // Required. The updated full list of vehicle attributes, including new, - // altered and untouched attributes. - repeated VehicleAttribute attributes = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The updated full list of vehicle attributes, including new, altered, and + // untouched attributes. + repeated VehicleAttribute attributes = 1 + [(google.api.field_behavior) = REQUIRED]; } // `SearchVehicles` request message. @@ -435,9 +441,9 @@ message SearchVehiclesRequest { // must be between 1 and 50 (inclusive). int32 count = 7 [(google.api.field_behavior) = REQUIRED]; - // Required. Specifies the number of passengers being considered for a trip. The - // value must be greater than or equal to one. The driver is not considered in - // the capacity value. + // Required. Specifies the number of passengers being considered for a trip. + // The value must be greater than or equal to one. The driver is not + // considered in the capacity value. int32 minimum_capacity = 8 [(google.api.field_behavior) = REQUIRED]; // Required. Represents the type of proposed trip. Eligible vehicles are those @@ -455,7 +461,8 @@ message SearchVehiclesRequest { // Required. Restricts the search to vehicles with one of the specified types. // At least one vehicle type must be specified. - repeated Vehicle.VehicleType vehicle_types = 14 [(google.api.field_behavior) = REQUIRED]; + repeated Vehicle.VehicleType vehicle_types = 14 + [(google.api.field_behavior) = REQUIRED]; // Callers can form complex logical operations using any combination of the // `required_attributes`, `required_one_of_attributes`, and @@ -476,9 +483,9 @@ message SearchVehiclesRequest { // ``` // // Restricts the search to only those vehicles with the specified attributes. - // This field is a conjunction/AND operation. Your app can specify up to 100 - // attributes; however, the combined key:value string length cannot exceed - // 1024 characters. + // This field is a conjunction/AND operation. A max of 50 required_attributes + // is allowed. This matches the maximum number of attributes allowed on a + // vehicle. repeated VehicleAttribute required_attributes = 12; // Restricts the search to only those vehicles with at least one of @@ -560,10 +567,10 @@ message ListVehiclesRequest { // Default value: 100. int32 page_size = 3; - // The `next_page_token` value returned from a previous call to - // `ListVehicles`. Functionality is undefined if the filter criteria of this - // request don't match the criteria in the request that produced this - // `page_token`. + // The value of the `next_page_token` provided by a previous call to + // `ListVehicles` so that you can paginate through groups of vehicles. The + // value is undefined if the filter criteria of the request is not the same as + // the filter criteria for the previous call to `ListVehicles`. string page_token = 4; // Specifies the required minimum capacity of the vehicle. All vehicles @@ -571,18 +578,19 @@ message ListVehiclesRequest { // value. If set, must be greater or equal to 0. google.protobuf.Int32Value minimum_capacity = 6; - // Restrict the response to vehicles that support at least - // one of the specified trip types. + // Restricts the response to vehicles that support at least one of the + // specified trip types. repeated TripType trip_types = 7; - // Restrict the response to vehicles that have updated - // their locations within the specified duration back from now. - // If present, must be a valid positive duration. + // Restricts the response to vehicles that have updated their locations within + // the specified duration at the time of the call. If present, must be a valid + // positive duration. google.protobuf.Duration maximum_staleness = 8; - // Required. Restrict the response to vehicles with one of the specified type + // Required. Restricts the response to vehicles with one of the specified type // categories. - repeated Vehicle.VehicleType.Category vehicle_type_categories = 9 [(google.api.field_behavior) = REQUIRED]; + repeated Vehicle.VehicleType.Category vehicle_type_categories = 9 + [(google.api.field_behavior) = REQUIRED]; // Callers can form complex logical operations using any combination of the // `required_attributes`, `required_one_of_attributes`, and @@ -602,19 +610,18 @@ message ListVehiclesRequest { // ...) // ``` // - // Restrict the response to vehicles with the specified attributes. This field - // is a conjunction/AND operation. Your app can specify up to 100 attributes; - // however, the combined key:value string length cannot exceed 1024 - // characters. + // Restricts the response to vehicles with the specified attributes. This + // field is a conjunction/AND operation. Your app can specify up to 100 + // attributes; however, the combined key:value string length cannot exceed + // 1024 characters. repeated string required_attributes = 10; - // Restrict the response to vehicles with at least one - // of the specified attributes in each `VehicleAttributeList`. - // Within each list, a vehicle must match at least one of the attributes. - // This field is an inclusive disjunction/OR operation in each - // `VehicleAttributeList` and a conjunction/AND operation across the - // collection of `VehicleAttributeList`. Format: - // key1:value1|key2:value2|key3:value3... + // Restricts the response to vehicles with at least one of the specified + // attributes in each `VehicleAttributeList`. Within each list, a vehicle must + // match at least one of the attributes. This field is an inclusive + // disjunction/OR operation in each `VehicleAttributeList` and a + // conjunction/AND operation across the collection of `VehicleAttributeList`. + // Format: key1:value1|key2:value2|key3:value3... repeated string required_one_of_attributes = 13; // `required_one_of_attribute_sets` provides additional functionality. @@ -633,15 +640,15 @@ message ListVehiclesRequest { // ...) // ``` // - // Restrict the response to vehicles that match all the attributes in a + // Restricts the response to vehicles that match all the attributes in a // `VehicleAttributeList`. Within each list, a vehicle must match all of the // attributes. This field is a conjunction/AND operation in each // `VehicleAttributeList` and inclusive disjunction/OR operation across the - // collection of `VehicleAttributeList`. Format: - // key1:value1|key2:value2|key3:value3... + // collection of `VehicleAttributeList`. Each repeated string should be of the + // format "key1:value1|key2:value2|key3:value3". repeated string required_one_of_attribute_sets = 15; - // Restrict the response to vehicles that have this vehicle state. + // Restricts the response to vehicles that have this vehicle state. VehicleState vehicle_state = 11; // Only return the vehicles with current trip(s). @@ -659,7 +666,8 @@ message ListVehiclesResponse { // more vehicles that meet the request criteria. string next_page_token = 2; - // Required. Total number of vehicles matching the request criteria across all pages. + // Required. Total number of vehicles matching the request criteria across all + // pages. int64 total_size = 3 [(google.api.field_behavior) = REQUIRED]; } @@ -717,9 +725,10 @@ message VehicleMatch { // empty value indicates an error in calculating the distance. google.protobuf.Int32Value vehicle_pickup_distance_meters = 3; - // Required. The straight-line distance between the vehicle and the pickup point - // specified in the request. - google.protobuf.Int32Value vehicle_pickup_straight_line_distance_meters = 11 [(google.api.field_behavior) = REQUIRED]; + // Required. The straight-line distance between the vehicle and the pickup + // point specified in the request. + google.protobuf.Int32Value vehicle_pickup_straight_line_distance_meters = 11 + [(google.api.field_behavior) = REQUIRED]; // The complete vehicle's driving ETA to the drop off point specified in the // request. The ETA includes stopping at any waypoints before the @@ -743,8 +752,8 @@ message VehicleMatch { TripType trip_type = 6 [(google.api.field_behavior) = REQUIRED]; // The ordered list of waypoints used to calculate the ETA. The list - // includes vehicle location, the pickup/drop off points of active - // trips for the vehicle, and the pickup/drop off points provided in the + // includes vehicle location, the pickup points of active + // trips for the vehicle, and the pickup points provided in the // request. An empty list indicates a failure in calculating ETA for the // vehicle. repeated Waypoint vehicle_trips_waypoints = 7; diff --git a/google/maps/mapsplatformdatasets/v1alpha/BUILD.bazel b/google/maps/mapsplatformdatasets/v1alpha/BUILD.bazel index e53bfd058..f7a3957b2 100644 --- a/google/maps/mapsplatformdatasets/v1alpha/BUILD.bazel +++ b/google/maps/mapsplatformdatasets/v1alpha/BUILD.bazel @@ -73,6 +73,7 @@ java_gapic_library( srcs = [":mapsplatformdatasets_proto_with_info"], gapic_yaml = None, grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", test_deps = [ ":mapsplatformdatasets_java_grpc", @@ -133,6 +134,7 @@ go_gapic_library( grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", importpath = "cloud.google.com/go/maps/mapsplatformdatasets/apiv1alpha;mapsplatformdatasets", metadata = True, + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -172,6 +174,7 @@ py_gapic_library( name = "mapsplatformdatasets_py_gapic", srcs = [":mapsplatformdatasets_proto"], grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", transport = "grpc", deps = [ @@ -222,7 +225,9 @@ php_gapic_library( name = "mapsplatformdatasets_php_gapic", srcs = [":mapsplatformdatasets_proto_with_info"], grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":mapsplatformdatasets_php_grpc", ":mapsplatformdatasets_php_proto", @@ -255,7 +260,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", package = "google.maps.mapsplatformdatasets.v1alpha", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -294,6 +301,7 @@ ruby_cloud_gapic_library( srcs = [":mapsplatformdatasets_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-maps-mapsplatformdatasets-v1alpha"], grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", deps = [ ":mapsplatformdatasets_ruby_grpc", @@ -338,6 +346,7 @@ csharp_gapic_library( srcs = [":mapsplatformdatasets_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "mapsplatformdatasets_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "mapsplatformdatasets_v1alpha.yaml", deps = [ ":mapsplatformdatasets_csharp_grpc", diff --git a/google/maps/playablelocations/v3/BUILD.bazel b/google/maps/playablelocations/v3/BUILD.bazel index 1e463dc77..a44993352 100644 --- a/google/maps/playablelocations/v3/BUILD.bazel +++ b/google/maps/playablelocations/v3/BUILD.bazel @@ -1,13 +1,39 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "playablelocations_proto", @@ -35,18 +61,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "playablelocations_java_proto", deps = [ @@ -66,6 +80,7 @@ java_gapic_library( name = "playablelocations_java_gapic", srcs = [":playablelocations_proto_with_info"], grpc_service_config = "playablelocations_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":playablelocations_java_grpc", ], @@ -87,6 +102,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-maps-playablelocations-v3-java", + include_samples = True, transport = "grpc+rest", deps = [ ":playablelocations_java_gapic", @@ -96,17 +112,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "playablelocations_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -125,6 +130,7 @@ go_gapic_library( srcs = [":playablelocations_proto_with_info"], grpc_service_config = "playablelocations_grpc_service_config.json", importpath = "google.golang.org/google/maps/playablelocations/v3;playablelocations", + rest_numeric_enums = True, service_yaml = "playablelocations_v3.yaml", transport = "grpc+rest", deps = [ @@ -150,17 +156,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "playablelocations_php_proto", deps = [":playablelocations_proto"], @@ -175,6 +170,8 @@ php_grpc_library( php_gapic_library( name = "playablelocations_php_gapic", srcs = [":playablelocations_proto_with_info"], + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":playablelocations_php_grpc", ":playablelocations_php_proto", @@ -191,22 +188,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "playablelocations_nodejs_gapic", src = ":playablelocations_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "playablelocations_grpc_service_config.json", package = "google.maps.playablelocations.v3", + rest_numeric_enums = True, service_yaml = "playablelocations_v3.yaml", + transport = "grpc+rest", deps = [], ) @@ -218,17 +208,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "playablelocations_ruby_proto", deps = [":playablelocations_proto"], @@ -244,6 +223,7 @@ ruby_cloud_gapic_library( name = "playablelocations_ruby_gapic", srcs = [":playablelocations_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-playablelocations-v3"], + rest_numeric_enums = True, deps = [ ":playablelocations_ruby_grpc", ":playablelocations_ruby_proto", @@ -260,17 +240,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "playablelocations_csharp_proto", deps = [":playablelocations_proto"], @@ -287,6 +256,7 @@ csharp_gapic_library( srcs = [":playablelocations_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "playablelocations_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":playablelocations_csharp_grpc", ":playablelocations_csharp_proto", diff --git a/google/maps/regionlookup/v1alpha/BUILD.bazel b/google/maps/regionlookup/v1alpha/BUILD.bazel index 8b470e1df..7c1402ad1 100644 --- a/google/maps/regionlookup/v1alpha/BUILD.bazel +++ b/google/maps/regionlookup/v1alpha/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "regionlookup_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "regionlookup_java_proto", deps = [":regionlookup_proto"], @@ -70,6 +89,7 @@ java_gapic_library( srcs = [":regionlookup_proto_with_info"], gapic_yaml = None, grpc_service_config = "regionlookup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", test_deps = [ ":regionlookup_java_grpc", @@ -93,6 +113,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-maps-regionlookup-v1alpha-java", + include_samples = True, transport = "grpc+rest", deps = [ ":regionlookup_java_gapic", @@ -102,17 +123,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "regionlookup_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -130,6 +140,7 @@ go_gapic_library( grpc_service_config = "regionlookup_grpc_service_config.json", importpath = "google.golang.org/google/maps/regionlookup/v1alpha;regionlookup", metadata = True, + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", transport = "grpc+rest", deps = [ @@ -155,20 +166,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "regionlookup_py_gapic", srcs = [":regionlookup_proto"], grpc_service_config = "regionlookup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", transport = "grpc", ) @@ -191,17 +193,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "regionlookup_php_proto", deps = [":regionlookup_proto"], @@ -217,7 +208,9 @@ php_gapic_library( name = "regionlookup_php_gapic", srcs = [":regionlookup_proto_with_info"], grpc_service_config = "regionlookup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", + transport = "grpc+rest", deps = [ ":regionlookup_php_grpc", ":regionlookup_php_proto", @@ -234,15 +227,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "regionlookup_nodejs_gapic", package_name = "@google-cloud/regionlookup", @@ -250,7 +234,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "regionlookup_grpc_service_config.json", package = "google.maps.regionlookup.v1alpha", + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", + transport = "grpc+rest", deps = [], ) @@ -262,17 +248,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "regionlookup_ruby_proto", deps = [":regionlookup_proto"], @@ -291,6 +266,7 @@ ruby_cloud_gapic_library( "ruby-cloud-gem-name=google-cloud-maps-regionlookup-v1alpha", ], grpc_service_config = "regionlookup_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":regionlookup_ruby_grpc", ":regionlookup_ruby_proto", @@ -307,17 +283,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "regionlookup_csharp_proto", deps = [":regionlookup_proto"], @@ -334,6 +299,7 @@ csharp_gapic_library( srcs = [":regionlookup_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "regionlookup_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "regionlookup_v1alpha.yaml", deps = [ ":regionlookup_csharp_grpc", @@ -351,15 +317,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "regionlookup_cc_proto", deps = [":regionlookup_proto"], diff --git a/google/maps/roads/v1op/BUILD.bazel b/google/maps/roads/v1op/BUILD.bazel index 2fc9e3339..67001621e 100644 --- a/google/maps/roads/v1op/BUILD.bazel +++ b/google/maps/roads/v1op/BUILD.bazel @@ -1,15 +1,45 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_gapic_library", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) load("//google/maps:postprocessing.bzl", "maps_assembly_pkg") +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) + proto_library( name = "roads_proto", srcs = [ @@ -32,18 +62,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "roads_java_proto", deps = [":roads_proto"], @@ -59,6 +77,7 @@ java_gapic_library( name = "roads_java_gapic", srcs = [":roads_proto_with_info"], grpc_service_config = "roads_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":roads_java_grpc", ], @@ -80,6 +99,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-maps-roads-v1op-java", + include_samples = True, transport = "grpc+rest", deps = [ ":roads_java_gapic", @@ -95,17 +115,6 @@ maps_assembly_pkg( language = "java", ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "roads_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -122,6 +131,7 @@ go_gapic_library( srcs = [":roads_proto_with_info"], grpc_service_config = "roads_grpc_service_config.json", importpath = "developers.google.com/maps/go/roads/v1op;roads", + rest_numeric_enums = True, service_yaml = "roads_v1op.yaml", transport = "grpc+rest", deps = [ @@ -146,20 +156,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "roads_py_gapic", srcs = [":roads_proto"], grpc_service_config = "roads_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -187,17 +188,6 @@ maps_assembly_pkg( language = "py", ) -############################################################################## -# 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 = "roads_php_proto", deps = [":roads_proto"], @@ -229,22 +219,15 @@ php_grpc_library( # ], # ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "roads_nodejs_gapic", src = ":roads_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "roads_grpc_service_config.json", package = "google.maps.roads.v1op", + rest_numeric_enums = True, service_yaml = "roads_v1op.yaml", + transport = "grpc+rest", deps = [], ) @@ -256,17 +239,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "roads_ruby_proto", deps = [":roads_proto"], @@ -282,6 +254,7 @@ ruby_cloud_gapic_library( name = "roads_ruby_gapic", srcs = [":roads_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-roads-v1op"], + rest_numeric_enums = True, deps = [ ":roads_ruby_grpc", ":roads_ruby_proto", @@ -298,17 +271,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "roads_csharp_proto", deps = [":roads_proto"], @@ -325,6 +287,7 @@ csharp_gapic_library( srcs = [":roads_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "roads_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":roads_csharp_grpc", ":roads_csharp_proto", @@ -341,16 +304,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_gapic_library", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "roads_cc_proto", deps = [":roads_proto"], diff --git a/google/maps/routes/v1/BUILD.bazel b/google/maps/routes/v1/BUILD.bazel index a46ceb2a2..56ea8c230 100644 --- a/google/maps/routes/v1/BUILD.bazel +++ b/google/maps/routes/v1/BUILD.bazel @@ -1,14 +1,30 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") -load("//google/maps:postprocessing.bzl", "maps_assembly_pkg") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_proto_library", + "java_gapic_assembly_gradle_pkg", + "java_grpc_library", + "java_proto_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_library", + "py_test", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "routes_proto", @@ -51,16 +67,6 @@ proto_library_with_info( ], ) -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_grpc_library", - "java_proto_library", -) - java_proto_library( name = "routes_java_proto", deps = [":routes_proto"], @@ -74,6 +80,7 @@ java_grpc_library( java_gapic_assembly_gradle_pkg( name = "google-maps-routes-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ "//google/maps/routes/v1:routes_java_grpc", @@ -82,15 +89,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_proto_library", - "go_test", -) - go_proto_library( name = "routes_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -105,19 +103,11 @@ go_proto_library( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "routes_py_gapic", srcs = [":routes_proto"], grpc_service_config = "routes_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/geo/type:viewport_py_proto", @@ -134,15 +124,6 @@ py_test( deps = [":routes_py_gapic"], ) -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_grpc_library", - "php_proto_library", -) - php_proto_library( name = "routes_php_proto", deps = [":routes_proto"], @@ -154,24 +135,6 @@ php_grpc_library( deps = [":routes_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 = "routes_ruby_proto", deps = [":routes_proto"], @@ -183,15 +146,6 @@ ruby_grpc_library( deps = [":routes_ruby_proto"], ) -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_grpc_library", - "csharp_proto_library", -) - csharp_proto_library( name = "routes_csharp_proto", deps = [":routes_proto"], @@ -203,15 +157,6 @@ csharp_grpc_library( deps = [":routes_csharp_proto"], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "routes_cc_proto", deps = [":routes_proto"], diff --git a/google/maps/routespreferred/v1/BUILD.bazel b/google/maps/routespreferred/v1/BUILD.bazel index 44a195e24..c0a0dedfb 100644 --- a/google/maps/routespreferred/v1/BUILD.bazel +++ b/google/maps/routespreferred/v1/BUILD.bazel @@ -1,14 +1,22 @@ # 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"]) +load("//google/maps:postprocessing.bzl", "maps_assembly_pkg") ############################################################################## -# Common +# Java ############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") -load("//google/maps:postprocessing.bzl", "maps_assembly_pkg") +load( + "@com_google_googleapis_imports//:imports.bzl", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) alias( name = "routes_proto", @@ -20,23 +28,12 @@ alias( actual = "//google/maps/routes/v1:routes_proto_with_info", ) -############################################################################## -# 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_gapic_library( name = "routespreferred_java_gapic", srcs = [":routes_proto_with_info"], gapic_yaml = "routespreferred_gapic.yaml", grpc_service_config = "//google/maps/routes/v1:routes_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ "//google/maps/routes/v1:routes_java_grpc", ], @@ -58,6 +55,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-maps-routespreferred-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":routespreferred_java_gapic", @@ -71,22 +69,12 @@ maps_assembly_pkg( language = "java", ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_gapic_library( name = "routespreferred_go_gapic", srcs = [":routes_proto_with_info"], grpc_service_config = "", importpath = "developers.google.com/maps/go/routespreferred/v1;routes", + rest_numeric_enums = True, service_yaml = "routespreferred_v1.yaml", transport = "grpc+rest", deps = [ diff --git a/google/maps/routing/v2/BUILD.bazel b/google/maps/routing/v2/BUILD.bazel index 429a08a46..23fa1119b 100644 --- a/google/maps/routing/v2/BUILD.bazel +++ b/google/maps/routing/v2/BUILD.bazel @@ -27,6 +27,7 @@ proto_library( "navigation_instruction.proto", "polyline.proto", "route.proto", + "route_label.proto", "route_modifiers.proto", "route_travel_mode.proto", "routes_service.proto", @@ -90,6 +91,7 @@ java_gapic_library( srcs = [":routing_proto_with_info"], gapic_yaml = None, grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", test_deps = [ ":routing_java_grpc", @@ -154,6 +156,7 @@ go_gapic_library( grpc_service_config = "library_grpc_service_config.json", importpath = "google.golang.org/google/maps/routing/v2;routing", metadata = True, + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", transport = "grpc+rest", deps = [ @@ -194,6 +197,7 @@ py_gapic_library( name = "routing_py_gapic", srcs = [":routing_proto"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", transport = "grpc", deps = [ @@ -245,7 +249,9 @@ php_gapic_library( name = "routing_php_gapic", srcs = [":routing_proto_with_info"], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", + transport = "grpc+rest", deps = [ ":routing_php_grpc", ":routing_php_proto", @@ -278,7 +284,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "library_grpc_service_config.json", package = "google.maps.routing.v2", + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -323,6 +331,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://developers.google.com/maps/documentation/", ], grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Routing includes the process of calculating a path along the road network, complete with an Estimated Time of Arrival (ETA).", ruby_cloud_title = "Routes V2", service_yaml = "routes_v2.yaml", @@ -369,6 +378,7 @@ csharp_gapic_library( srcs = [":routing_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "library_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "routes_v2.yaml", deps = [ ":routing_csharp_grpc", diff --git a/google/maps/routing/v2/route.proto b/google/maps/routing/v2/route.proto index 8f4304f08..7ce7c294f 100644 --- a/google/maps/routing/v2/route.proto +++ b/google/maps/routing/v2/route.proto @@ -20,6 +20,7 @@ import "google/geo/type/viewport.proto"; import "google/maps/routing/v2/location.proto"; import "google/maps/routing/v2/navigation_instruction.proto"; import "google/maps/routing/v2/polyline.proto"; +import "google/maps/routing/v2/route_label.proto"; import "google/maps/routing/v2/speed_reading_interval.proto"; import "google/maps/routing/v2/toll_info.proto"; import "google/protobuf/duration.proto"; @@ -37,6 +38,10 @@ option ruby_package = "Google::Maps::Routing::V2"; // Encapsulates a route, which consists of a series of connected road segments // that join beginning, ending, and intermediate waypoints. message Route { + // Labels for the `Route` that are useful to identify specific properties + // of the route to compare against others. + repeated RouteLabel route_labels = 13; + // A collection of legs (path segments between waypoints) that make-up the // route. Each leg corresponds to the trip between two non-`via` Waypoints. // For example, a route with no intermediate waypoints has only one leg. A @@ -75,6 +80,17 @@ message Route { // Additional information about the route. RouteTravelAdvisory travel_advisory = 9; + + // Web-safe base64 encoded route token that can be passed to NavigationSDK, + // which allows the Navigation SDK to reconstruct the route during navigation, + // and in the event of rerouting honor the original intention when Routes + // ComputeRoutes is called. Customers should treat this token as an + // opaque blob. + // NOTE: `Route.route_token` is only available for requests that have set + // `ComputeRoutesRequest.routing_preference` to `TRAFFIC_AWARE` or + // `TRAFFIC_AWARE_OPTIMAL`. `Route.route_token` is also not supported for + // requests that have Via waypoints. + string route_token = 12; } // Encapsulates the additional information that the user should be informed @@ -98,6 +114,9 @@ message RouteTravelAdvisory { // polyline: A ---- B ---- C ---- D ---- E ---- F ---- G // speed_reading_intervals: [A,C), [C,D), [D,G). repeated SpeedReadingInterval speed_reading_intervals = 3; + + // The fuel consumption prediction in microliters. + int64 fuel_consumption_microliters = 5; } // Encapsulates the additional information that the user should be informed diff --git a/google/maps/routing/v2/route_label.proto b/google/maps/routing/v2/route_label.proto new file mode 100644 index 000000000..f0c9188a5 --- /dev/null +++ b/google/maps/routing/v2/route_label.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.maps.routing.v2; + +option cc_enable_arenas = true; +option csharp_namespace = "Google.Maps.Routing.V2"; +option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing"; +option java_multiple_files = true; +option java_outer_classname = "RouteLabelProto"; +option java_package = "com.google.maps.routing.v2"; +option objc_class_prefix = "GMRV2"; +option php_namespace = "Google\\Maps\\Routing\\V2"; +option ruby_package = "Google::Maps::Routing::V2"; + +// Labels for the `Route` that are useful to identify specific properties +// of the route to compare against others. +enum RouteLabel { + // Default - not used. + ROUTE_LABEL_UNSPECIFIED = 0; + + // The default "best" route returned for the route computation. + DEFAULT_ROUTE = 1; + + // An alternative to the default "best" route. Routes like this will be + // returned when `ComputeRoutesRequest.compute_alternative_routes` is + // specified. + DEFAULT_ROUTE_ALTERNATE = 2; + + // Fuel efficient route. Routes labeled with this value are determined to be + // optimized for Eco parameters such as fuel consumption. + FUEL_EFFICIENT = 3; +} diff --git a/google/maps/routing/v2/route_travel_mode.proto b/google/maps/routing/v2/route_travel_mode.proto index adc091e16..2eb9e5c29 100644 --- a/google/maps/routing/v2/route_travel_mode.proto +++ b/google/maps/routing/v2/route_travel_mode.proto @@ -27,6 +27,10 @@ option php_namespace = "Google\\Maps\\Routing\\V2"; option ruby_package = "Google::Maps::Routing::V2"; // A set of values used to specify the mode of travel. +// NOTE: WALK, BICYCLE, and TWO_WHEELER routes are in beta and might sometimes +// be missing clear sidewalks, pedestrian paths, or bicycling paths. +// You must display this warning to the user for all walking, bicycling, and +// two-wheel routes that you display in your app. enum RouteTravelMode { // No travel mode specified. Defaults to `DRIVE`. TRAVEL_MODE_UNSPECIFIED = 0; diff --git a/google/maps/routing/v2/routes_service.proto b/google/maps/routing/v2/routes_service.proto index e252a87b6..d2d241c05 100644 --- a/google/maps/routing/v2/routes_service.proto +++ b/google/maps/routing/v2/routes_service.proto @@ -122,7 +122,8 @@ service Routes { // be automatically included in the response. // * Selecting only the fields that you need results in a smaller response // size, and thus higher network throughput. - rpc ComputeRouteMatrix(ComputeRouteMatrixRequest) returns (stream RouteMatrixElement) { + rpc ComputeRouteMatrix(ComputeRouteMatrixRequest) + returns (stream RouteMatrixElement) { option (google.api.http) = { post: "/distanceMatrix/v2:computeRouteMatrix" body: "*" @@ -132,6 +133,16 @@ service Routes { // ComputeRoutes request message. message ComputeRoutesRequest { + // A supported reference route on the ComputeRoutesRequest. + enum ReferenceRoute { + // Not used. Requests containing this value fail. + REFERENCE_ROUTE_UNSPECIFIED = 0; + + // Fuel efficient route. Routes labeled with this value are determined to be + // optimized for parameters such as fuel consumption. + FUEL_EFFICIENT = 1; + } + // Required. Origin waypoint. Waypoint origin = 1 [(google.api.field_behavior) = REQUIRED]; @@ -149,24 +160,26 @@ message ComputeRoutesRequest { // Optional. Specifies how to compute the route. The server // attempts to use the selected routing preference to compute the route. If // the routing preference results in an error or an extra long latency, then - // an error is returned. In the future, we might implement a fallback - // mechanism to use a different option when the preferred option does not give - // a valid result. You can specify this option only when the `travel_mode` is - // `DRIVE` or `TWO_WHEELER`, otherwise the request fails. - RoutingPreference routing_preference = 5 [(google.api.field_behavior) = OPTIONAL]; + // an error is returned. You can specify this option only when the + // `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails. + RoutingPreference routing_preference = 5 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Specifies your preference for the quality of the polyline. PolylineQuality polyline_quality = 6 [(google.api.field_behavior) = OPTIONAL]; // Optional. Specifies the preferred encoding for the polyline. - PolylineEncoding polyline_encoding = 12 [(google.api.field_behavior) = OPTIONAL]; + PolylineEncoding polyline_encoding = 12 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The departure time. If you don't set this value, then this value // defaults to the time that you made the request. If you set this value to a // time that has already occurred, then the request fails. - google.protobuf.Timestamp departure_time = 7 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp departure_time = 7 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. Specifies whether to calculate alternate routes in addition to the route. + // Optional. Specifies whether to calculate alternate routes in addition to + // the route. bool compute_alternative_routes = 8 [(google.api.field_behavior) = OPTIONAL]; // Optional. A set of conditions to satisfy that affect the way routes are @@ -187,6 +200,14 @@ message ComputeRoutesRequest { // affected by this value. If you don't provide this value, then the display // units are inferred from the location of the request. Units units = 11 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Specifies what reference routes to calculate as part of the + // request in addition to the default route. A reference route is a route with + // a different route calculation objective than the default route. For example + // an FUEL_EFFICIENT reference route calculation takes into account various + // parameters that would generate an optimal fuel efficient route. + repeated ReferenceRoute requested_reference_routes = 14 + [(google.api.field_behavior) = OPTIONAL]; } // ComputeRoutes the response message. @@ -207,8 +228,8 @@ message ComputeRoutesResponse { // ComputeRouteMatrix request message message ComputeRouteMatrixRequest { - // Required. Array of origins, which determines the rows of the response matrix. - // Several size restrictions apply to the cardinality of origins and + // Required. Array of origins, which determines the rows of the response + // matrix. Several size restrictions apply to the cardinality of origins and // destinations: // // * The number of elements (origins × destinations) must be no greater than @@ -217,27 +238,30 @@ message ComputeRouteMatrixRequest { // 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`. // * The number of waypoints (origins + destinations) specified as `place_id` // must be no greater than 50. - repeated RouteMatrixOrigin origins = 1 [(google.api.field_behavior) = REQUIRED]; + repeated RouteMatrixOrigin origins = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. Array of destinations, which determines the columns of the response matrix. - repeated RouteMatrixDestination destinations = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. Array of destinations, which determines the columns of the + // response matrix. + repeated RouteMatrixDestination destinations = 2 + [(google.api.field_behavior) = REQUIRED]; // Optional. Specifies the mode of transportation. RouteTravelMode travel_mode = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Specifies how to compute the route. The server attempts to use the selected - // routing preference to compute the route. If the routing preference results - // in an error or an extra long latency, an error is returned. In the future, - // we might implement a fallback mechanism to use a different option when the - // preferred option does not give a valid result. You can specify this option - // only when the `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the - // request fails. - RoutingPreference routing_preference = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The departure time. If you don't set this value, this defaults to the time - // that you made the request. If you set this value to a time that has already - // occurred, the request fails. - google.protobuf.Timestamp departure_time = 5 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Specifies how to compute the route. The server attempts to use + // the selected routing preference to compute the route. If the routing + // preference results in an error or an extra long latency, an error is + // returned. You can specify this option only when the `travel_mode` is + // `DRIVE` or `TWO_WHEELER`, otherwise the request fails. + RoutingPreference routing_preference = 4 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The departure time. If you don't set this value, this defaults to + // the time that you made the request. If you set this value to a time that + // has already occurred, the request fails. + google.protobuf.Timestamp departure_time = 5 + [(google.api.field_behavior) = OPTIONAL]; } // A single origin for ComputeRouteMatrixRequest diff --git a/google/maps/routing/v2/vehicle_emission_type.proto b/google/maps/routing/v2/vehicle_emission_type.proto index d372986e6..b5889bbb0 100644 --- a/google/maps/routing/v2/vehicle_emission_type.proto +++ b/google/maps/routing/v2/vehicle_emission_type.proto @@ -40,4 +40,7 @@ enum VehicleEmissionType { // Hybrid fuel (such as gasoline + electric) vehicle. HYBRID = 3; + + // Diesel fueled vehicle. + DIESEL = 4; } diff --git a/google/monitoring/dashboard/v1/BUILD.bazel b/google/monitoring/dashboard/v1/BUILD.bazel index 4017523c4..420ec6473 100644 --- a/google/monitoring/dashboard/v1/BUILD.bazel +++ b/google/monitoring/dashboard/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "dashboard_proto", @@ -57,18 +88,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "dashboard_java_proto", deps = [":dashboard_proto"], @@ -85,6 +104,7 @@ java_gapic_library( srcs = [":dashboard_proto_with_info"], gapic_yaml = "monitoring_gapic.yaml", grpc_service_config = "dashboards_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", test_deps = [ ":dashboard_java_grpc", @@ -108,6 +128,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-monitoring-dashboard-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":dashboard_java_gapic", @@ -117,17 +138,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "dashboard_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -144,6 +154,7 @@ go_gapic_library( grpc_service_config = "dashboards_grpc_service_config.json", importpath = "cloud.google.com/go/monitoring/dashboard/apiv1;dashboard", metadata = True, + rest_numeric_enums = True, service_yaml = "monitoring.yaml", transport = "grpc+rest", deps = [ @@ -170,21 +181,20 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "dashboard_py_gapic", srcs = [":dashboard_proto"], grpc_service_config = "dashboards_grpc_service_config.json", + opt_args = [ + "warehouse-package-name=google-cloud-monitoring-dashboards", + "python-gapic-namespace=google.cloud", + "python-gapic-name=monitoring_dashboard", + ], + rest_numeric_enums = True, + service_yaml = "monitoring.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -205,17 +215,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dashboard_php_proto", deps = [":dashboard_proto"], @@ -231,7 +230,9 @@ php_gapic_library( name = "dashboard_php_gapic", srcs = [":dashboard_proto_with_info"], grpc_service_config = "dashboards_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc+rest", deps = [ ":dashboard_php_grpc", ":dashboard_php_proto", @@ -248,15 +249,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "dashboard_nodejs_gapic", package_name = "@google-cloud/monitoring-dashboards", @@ -264,7 +256,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dashboards_grpc_service_config.json", package = "google.monitoring.dashboard.v1", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc+rest", deps = [], ) @@ -276,17 +270,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dashboard_ruby_proto", deps = [":dashboard_proto"], @@ -310,8 +293,10 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-monitoring", ], grpc_service_config = "dashboards_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation. The Dashboards API manages arrangements of display widgets.", ruby_cloud_title = "Cloud Monitoring Dashboards V1", + service_yaml = "monitoring.yaml", deps = [ ":dashboard_ruby_grpc", ":dashboard_ruby_proto", @@ -328,17 +313,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dashboard_csharp_proto", deps = [":dashboard_proto"], @@ -355,6 +329,7 @@ csharp_gapic_library( srcs = [":dashboard_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dashboards_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", deps = [ ":dashboard_csharp_grpc", @@ -372,15 +347,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "dashboard_cc_proto", deps = [":dashboard_proto"], diff --git a/google/monitoring/dashboard/v1/metrics.proto b/google/monitoring/dashboard/v1/metrics.proto index c5ae8f718..b28dbdcf9 100644 --- a/google/monitoring/dashboard/v1/metrics.proto +++ b/google/monitoring/dashboard/v1/metrics.proto @@ -38,8 +38,11 @@ message TimeSeriesQuery { // Parameters to fetch a ratio between two time series filters. TimeSeriesFilterRatio time_series_filter_ratio = 2; - // A query used to fetch time series. + // A query used to fetch time series with MQL. string time_series_query_language = 3; + + // A query used to fetch time series with PromQL. + string prometheus_query = 6; } // The unit of data contained in fetched time series. If non-empty, this diff --git a/google/monitoring/dashboard/v1/monitoring.yaml b/google/monitoring/dashboard/v1/monitoring.yaml index a0accbc90..4b19e4eb6 100644 --- a/google/monitoring/dashboard/v1/monitoring.yaml +++ b/google/monitoring/dashboard/v1/monitoring.yaml @@ -7,13 +7,7 @@ apis: - name: google.monitoring.dashboard.v1.DashboardsService documentation: - summary: |- - Manages your Cloud Monitoring data and configurations. Most projects must - be associated with a Workspace, with a few exceptions as noted on the - individual method pages. The table entries below are presented in - alphabetical order, not in order of common use. For explanations of the - concepts found in the table entries, read the [Cloud Monitoring - documentation](https://cloud.google.com/monitoring/docs). + summary: Manages your Cloud Monitoring data and configurations. authentication: rules: diff --git a/google/monitoring/dashboard/v1/scorecard.proto b/google/monitoring/dashboard/v1/scorecard.proto index 2cb2e4b2e..27b0b1565 100644 --- a/google/monitoring/dashboard/v1/scorecard.proto +++ b/google/monitoring/dashboard/v1/scorecard.proto @@ -50,7 +50,8 @@ message Scorecard { // timeseries. message SparkChartView { // Required. The type of sparkchart to show in this chartView. - SparkChartType spark_chart_type = 1 [(google.api.field_behavior) = REQUIRED]; + SparkChartType spark_chart_type = 1 + [(google.api.field_behavior) = REQUIRED]; // The lower bound on data point frequency in the chart implemented by // specifying the minimum alignment period to use in a time series query. @@ -62,7 +63,8 @@ message Scorecard { // Required. Fields for querying time series data from the // Stackdriver metrics API. - TimeSeriesQuery time_series_query = 1 [(google.api.field_behavior) = REQUIRED]; + TimeSeriesQuery time_series_query = 1 + [(google.api.field_behavior) = REQUIRED]; // Defines the optional additional chart shown on the scorecard. If // neither is included - then a default scorecard is shown. @@ -83,6 +85,8 @@ message Scorecard { // it in a danger state. (Danger trumps warning.) // // As an example, consider a scorecard with the following four thresholds: + // + // ``` // { // value: 90, // category: 'DANGER', @@ -103,6 +107,7 @@ message Scorecard { // category: 'WARNING', // trigger: 'BELOW', // } + // ``` // // Then: values less than or equal to 10 would put the scorecard in a DANGER // state, values greater than 10 but less than or equal to 20 a WARNING state, diff --git a/google/monitoring/dashboard/v1/table_display_options.proto b/google/monitoring/dashboard/v1/table_display_options.proto index b94b20b11..468005f2f 100644 --- a/google/monitoring/dashboard/v1/table_display_options.proto +++ b/google/monitoring/dashboard/v1/table_display_options.proto @@ -28,7 +28,10 @@ option ruby_package = "Google::Cloud::Monitoring::Dashboard::V1"; // Table display options that can be reused. message TableDisplayOptions { - // Optional. Columns to display in the table. Leave empty to display all available - // columns. Note: This field is for future features and is not currently used. - repeated string shown_columns = 1 [(google.api.field_behavior) = OPTIONAL]; + // Optional. This field is unused and has been replaced by + // TimeSeriesTable.column_settings + repeated string shown_columns = 1 [ + deprecated = true, + (google.api.field_behavior) = OPTIONAL + ]; } diff --git a/google/monitoring/metricsscope/v1/BUILD.bazel b/google/monitoring/metricsscope/v1/BUILD.bazel index d9d4dc9c3..46f580178 100644 --- a/google/monitoring/metricsscope/v1/BUILD.bazel +++ b/google/monitoring/metricsscope/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "metricsscope_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "metricsscope_java_proto", deps = [":metricsscope_proto"], @@ -70,10 +89,12 @@ java_gapic_library( srcs = [":metricsscope_proto_with_info"], gapic_yaml = "monitoring_gapic.yaml", grpc_service_config = "metricsscopes_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", test_deps = [ ":metricsscope_java_grpc", ], + transport = "grpc", deps = [ ":metricsscope_java_proto", "//google/api:api_java_proto", @@ -91,6 +112,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-monitoring-metricsscope-v1-java", + include_samples = True, + transport = "grpc", deps = [ ":metricsscope_java_gapic", ":metricsscope_java_grpc", @@ -99,17 +122,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "metricsscope_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -127,12 +139,14 @@ go_gapic_library( grpc_service_config = "metricsscopes_grpc_service_config.json", importpath = "cloud.google.com/go/monitoring/metricsscope/apiv1;metricsscope", metadata = True, + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc", deps = [ ":metricsscope_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -154,16 +168,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "metricsscope_py_gapic", srcs = [":metricsscope_proto"], @@ -171,8 +175,9 @@ py_gapic_library( opt_args = [ "python-gapic-name=monitoring_metrics_scope", "python-gapic-namespace=google.cloud", - "ware-house-package-name=google-cloud-monitoring-metrics-scopes", + "warehouse-package-name=google-cloud-monitoring-metrics-scopes", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -194,17 +199,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "metricsscope_php_proto", deps = [":metricsscope_proto"], @@ -220,7 +214,9 @@ php_gapic_library( name = "metricsscope_php_gapic", srcs = [":metricsscope_proto_with_info"], grpc_service_config = "metricsscopes_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc+rest", deps = [ ":metricsscope_php_grpc", ":metricsscope_php_proto", @@ -237,15 +233,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "metricsscope_nodejs_gapic", package_name = "@google-cloud/metricsscope", @@ -253,7 +240,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "metricsscopes_grpc_service_config.json", package = "google.monitoring.metricsscope.v1", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc", deps = [], ) @@ -265,17 +254,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "metricsscope_ruby_proto", deps = [":metricsscope_proto"], @@ -298,6 +276,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-monitoring", ], grpc_service_config = "metricsscopes_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation. The Metrics Scopes API manages the list of monitored projects and accounts.", ruby_cloud_title = "Cloud Monitoring Metrics Scopes V1", deps = [ @@ -316,17 +295,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "metricsscope_csharp_proto", deps = [":metricsscope_proto"], @@ -343,6 +311,7 @@ csharp_gapic_library( srcs = [":metricsscope_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "metricsscopes_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", deps = [ ":metricsscope_csharp_grpc", @@ -360,15 +329,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "metricsscope_cc_proto", deps = [":metricsscope_proto"], diff --git a/google/monitoring/v3/BUILD.bazel b/google/monitoring/v3/BUILD.bazel index 79737b732..1f7722966 100644 --- a/google/monitoring/v3/BUILD.bazel +++ b/google/monitoring/v3/BUILD.bazel @@ -9,14 +9,44 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "monitoring_proto", @@ -69,18 +99,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "monitoring_java_proto", deps = [":monitoring_proto"], @@ -97,10 +115,12 @@ java_gapic_library( srcs = [":monitoring_proto_with_info"], gapic_yaml = "monitoring_gapic.yaml", grpc_service_config = "monitoring_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", test_deps = [ ":monitoring_java_grpc", ], + transport = "grpc", deps = [ ":monitoring_java_proto", "//google/api:api_java_proto", @@ -124,6 +144,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-monitoring-v3-java", + include_samples = True, + transport = "grpc", deps = [ ":monitoring_java_gapic", ":monitoring_java_grpc", @@ -132,17 +154,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "monitoring_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -167,14 +178,16 @@ go_gapic_library( grpc_service_config = "monitoring_grpc_service_config.json", importpath = "cloud.google.com/go/monitoring/apiv3;monitoring", metadata = True, + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc", deps = [ ":monitoring_go_proto", "//google/api:metric_go_proto", "//google/api:monitoredres_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", "@io_bazel_rules_go//proto/wkt:struct_go_proto", ], @@ -198,20 +211,12 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "monitoring_py_gapic", srcs = [":monitoring_proto"], grpc_service_config = "monitoring_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud"], + rest_numeric_enums = True, transport = "grpc", ) @@ -234,17 +239,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "monitoring_php_proto", deps = [":monitoring_proto"], @@ -260,7 +254,9 @@ php_gapic_library( name = "monitoring_php_gapic", srcs = [":monitoring_proto_with_info"], grpc_service_config = "monitoring_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc+rest", deps = [ ":monitoring_php_grpc", ":monitoring_php_proto", @@ -277,15 +273,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "monitoring_nodejs_gapic", package_name = "@google-cloud/monitoring", @@ -294,7 +281,9 @@ nodejs_gapic_library( grpc_service_config = "monitoring_grpc_service_config.json", main_service = "monitoring", package = "google.monitoring.v3", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", + transport = "grpc", deps = [], ) @@ -306,17 +295,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "monitoring_ruby_proto", deps = [":monitoring_proto"], @@ -339,6 +317,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/monitoring", ], grpc_service_config = "monitoring_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation.", ruby_cloud_title = "Cloud Monitoring V3", deps = [ @@ -357,17 +336,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "monitoring_csharp_proto", deps = [":monitoring_proto"], @@ -384,6 +352,7 @@ csharp_gapic_library( srcs = [":monitoring_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "monitoring_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "monitoring.yaml", deps = [ ":monitoring_csharp_grpc", @@ -401,15 +370,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "monitoring_cc_proto", deps = [":monitoring_proto"], diff --git a/google/partner/aistreams/v1alpha1/BUILD.bazel b/google/partner/aistreams/v1alpha1/BUILD.bazel index 0f3e10c04..2eef11321 100644 --- a/google/partner/aistreams/v1alpha1/BUILD.bazel +++ b/google/partner/aistreams/v1alpha1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "aistreams_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "aistreams_java_proto", deps = [":aistreams_proto"], @@ -69,6 +88,7 @@ java_gapic_library( name = "aistreams_java_gapic", srcs = [":aistreams_proto_with_info"], grpc_service_config = "aistreams_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":aistreams_java_grpc", ], @@ -90,6 +110,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-partner-aistreams-v1alpha1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":aistreams_java_gapic", @@ -99,17 +120,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "aistreams_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -126,13 +136,14 @@ go_gapic_library( srcs = [":aistreams_proto_with_info"], grpc_service_config = "aistreams_grpc_service_config.json", importpath = "cloud.google.com/go/partner/aistreams/apiv1alpha1;aistreams", + rest_numeric_enums = True, service_yaml = "aistreams_v1alpha1.yaml", transport = "grpc+rest", deps = [ ":aistreams_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -153,20 +164,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "aistreams_py_gapic", srcs = [":aistreams_proto"], grpc_service_config = "aistreams_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", ) @@ -188,17 +190,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "aistreams_php_proto", deps = [":aistreams_proto"], @@ -214,7 +205,9 @@ php_gapic_library( name = "aistreams_php_gapic", srcs = [":aistreams_proto_with_info"], grpc_service_config = "aistreams_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "aistreams_v1alpha1.yaml", + transport = "grpc+rest", deps = [ ":aistreams_php_grpc", ":aistreams_php_proto", @@ -231,22 +224,15 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "aistreams_nodejs_gapic", src = ":aistreams_proto_with_info", extra_protoc_parameters = ["metadata"], grpc_service_config = "aistreams_grpc_service_config.json", package = "google.partner.aistreams.v1alpha1", + rest_numeric_enums = True, service_yaml = "aistreams_v1alpha1.yaml", + transport = "grpc+rest", deps = [], ) @@ -258,17 +244,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "aistreams_ruby_proto", deps = [":aistreams_proto"], @@ -285,6 +260,7 @@ ruby_cloud_gapic_library( srcs = [":aistreams_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-aistreams-v1alpha1"], grpc_service_config = "aistreams_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":aistreams_ruby_grpc", ":aistreams_ruby_proto", @@ -301,17 +277,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "aistreams_csharp_proto", deps = [":aistreams_proto"], @@ -328,6 +293,7 @@ csharp_gapic_library( srcs = [":aistreams_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "aistreams_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "aistreams_v1alpha1.yaml", deps = [ ":aistreams_csharp_grpc", @@ -345,16 +311,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -# Put your C++ rules here -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "aistreams_cc_proto", deps = [":aistreams_proto"], diff --git a/google/privacy/dlp/v2/BUILD.bazel b/google/privacy/dlp/v2/BUILD.bazel index 976df6629..eb89bb700 100644 --- a/google/privacy/dlp/v2/BUILD.bazel +++ b/google/privacy/dlp/v2/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "dlp_proto", @@ -39,18 +70,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "dlp_java_proto", deps = [":dlp_proto"], @@ -67,6 +86,7 @@ java_gapic_library( srcs = [":dlp_proto_with_info"], gapic_yaml = "dlp_gapic.yaml", grpc_service_config = "dlp_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":dlp_java_grpc", ], @@ -88,6 +108,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-privacy-dlp-v2-java", + include_samples = True, transport = "grpc+rest", deps = [ ":dlp_java_gapic", @@ -97,17 +118,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "dlp_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -127,6 +137,7 @@ go_gapic_library( srcs = [":dlp_proto_with_info"], grpc_service_config = "dlp_grpc_service_config.json", importpath = "cloud.google.com/go/dlp/apiv2;dlp", + rest_numeric_enums = True, service_yaml = "dlp_v2.yaml", transport = "grpc+rest", deps = [ @@ -152,21 +163,12 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "dlp_py_gapic", srcs = [":dlp_proto"], grpc_service_config = "dlp_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud"], + rest_numeric_enums = True, transport = "grpc", ) @@ -187,17 +189,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dlp_php_proto", deps = [":dlp_proto"], @@ -213,6 +204,8 @@ php_gapic_library( name = "dlp_php_gapic", srcs = [":dlp_proto_with_info"], grpc_service_config = "dlp_grpc_service_config.json", + rest_numeric_enums = True, + transport = "grpc+rest", deps = [ ":dlp_php_grpc", ":dlp_php_proto", @@ -229,15 +222,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "dlp_nodejs_gapic", package_name = "@google-cloud/dlp", @@ -245,7 +229,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "dlp_grpc_service_config.json", package = "google.privacy.dlp.v2", + rest_numeric_enums = True, service_yaml = "dlp_v2.yaml", + transport = "grpc+rest", deps = [], ) @@ -257,17 +243,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dlp_ruby_proto", deps = [":dlp_proto"], @@ -290,6 +265,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=dlp", ], grpc_service_config = "dlp_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", ruby_cloud_title = "Cloud Data Loss Prevention (DLP) V2", deps = [ @@ -308,17 +284,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "dlp_csharp_proto", deps = [":dlp_proto"], @@ -335,6 +300,7 @@ csharp_gapic_library( srcs = [":dlp_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "dlp_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "dlp_v2.yaml", deps = [ ":dlp_csharp_grpc", @@ -352,15 +318,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "dlp_cc_proto", deps = [":dlp_proto"], diff --git a/google/privacy/dlp/v2/dlp.proto b/google/privacy/dlp/v2/dlp.proto index 4dc3a3862..c11a1f1d4 100644 --- a/google/privacy/dlp/v2/dlp.proto +++ b/google/privacy/dlp/v2/dlp.proto @@ -673,6 +673,20 @@ message ExcludeInfoTypes { repeated InfoType info_types = 1; } +// The rule to exclude findings based on a hotword. For record inspection of +// tables, column names are considered hotwords. An example of this is to +// exclude a finding if a BigQuery column matches a specific pattern. +message ExcludeByHotword { + // Regular expression pattern defining what qualifies as a hotword. + CustomInfoType.Regex hotword_regex = 1; + + // Range of characters within which the entire hotword must reside. + // The total length of the window cannot exceed 1000 characters. + // The windowBefore property in proximity should be set to 1 if the hotword + // needs to be included in a column header. + CustomInfoType.DetectionRule.Proximity proximity = 2; +} + // The rule that specifies conditions when findings of infoTypes specified in // `InspectionRuleSet` are removed from results. message ExclusionRule { @@ -686,6 +700,10 @@ message ExclusionRule { // Set of infoTypes for which findings would affect this rule. ExcludeInfoTypes exclude_info_types = 3; + + // Drop if the hotword rule is contained in the proximate context. For + // tabular data, the context includes the column name. + ExcludeByHotword exclude_by_hotword = 5; } // How the rule is applied, see MatchingType documentation for details. @@ -862,7 +880,6 @@ message ByteContentItem { bytes data = 2; } -// Container structure for the content to inspect. message ContentItem { // Data of the item either in the byte array or UTF-8 string form, or table. oneof data_item { @@ -1289,6 +1306,13 @@ message DeidentifyContentRequest { InspectConfig inspect_config = 3; // The item to de-identify. Will be treated as text. + // + // This value must be of type + // [Table][google.privacy.dlp.v2.Table] if your + // [deidentify_config][google.privacy.dlp.v2.DeidentifyContentRequest.deidentify_config] + // is a + // [RecordTransformations][google.privacy.dlp.v2.RecordTransformations] + // object. ContentItem item = 4; // Template to use. Any configuration directly specified in @@ -1705,6 +1729,9 @@ message InfoTypeCategory { // The infoType is typically used in Google internally. INTERNAL = 40; + + // The infoType is typically used in New Zealand. + NEW_ZEALAND = 41; } // Enum of the current industries in the category. @@ -3716,8 +3743,9 @@ message Action { // Create a de-identified copy of the input data. Deidentify deidentify = 7; - // Enable email notification for project owners and editors on job's - // completion/failure. + // Sends an email when the job completes. The email goes to IAM project + // owners and technical [Essential + // Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). JobNotificationEmails job_notification_emails = 8; // Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5249,6 +5277,7 @@ message TableDataProfile { int64 table_size_bytes = 12; // Number of rows in the table when the profile was generated. + // This will not be populated for BigLake tables. int64 row_count = 13; // How the table is encrypted. @@ -5292,9 +5321,8 @@ message InfoTypeSummary { // The infoType. InfoType info_type = 1; - // Approximate percentage of non-null rows that contained data detected by - // this infotype. - int32 estimated_prevalence = 2; + // Not populated for predicted infotypes. + int32 estimated_prevalence = 2 [deprecated = true]; } // Infotype details for other infoTypes found within a column. diff --git a/google/privacy/dlp/v2/storage.proto b/google/privacy/dlp/v2/storage.proto index 7709f546b..f746e63d0 100644 --- a/google/privacy/dlp/v2/storage.proto +++ b/google/privacy/dlp/v2/storage.proto @@ -33,7 +33,7 @@ message InfoType { // creating a CustomInfoType, or one of the names listed // at https://cloud.google.com/dlp/docs/infotypes-reference when specifying // a built-in type. When sending Cloud DLP results to Data Catalog, infoType - // names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. + // names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. string name = 1; // Optional version name for this InfoType. diff --git a/google/pubsub/v1/BUILD.bazel b/google/pubsub/v1/BUILD.bazel index 1c37f6602..87db5c596 100644 --- a/google/pubsub/v1/BUILD.bazel +++ b/google/pubsub/v1/BUILD.bazel @@ -64,6 +64,7 @@ java_gapic_library( srcs = [":pubsub_proto_with_info"], gapic_yaml = "pubsub_gapic.yaml", grpc_service_config = "pubsub_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = ":pubsub_v1.yaml", test_deps = [ ":pubsub_java_grpc", @@ -90,6 +91,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-pubsub-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":pubsub_java_gapic", @@ -117,6 +119,7 @@ py_gapic_library( "warehouse-package-name=google-cloud-pubsub", "add-iam-methods", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -164,6 +167,7 @@ go_gapic_library( srcs = [":pubsub_proto_with_info"], grpc_service_config = "pubsub_grpc_service_config.json", importpath = "cloud.google.com/go/pubsub/apiv1;pubsub", + rest_numeric_enums = True, service_yaml = ":pubsub_v1.yaml", transport = "grpc+rest", deps = [ @@ -217,7 +221,9 @@ php_gapic_library( srcs = [":pubsub_proto_with_info"], gapic_yaml = "pubsub_gapic.yaml", grpc_service_config = "pubsub_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = ":pubsub_v1.yaml", + transport = "grpc+rest", deps = [ ":pubsub_php_grpc", ":pubsub_php_proto", @@ -252,7 +258,9 @@ nodejs_gapic_library( grpc_service_config = "pubsub_grpc_service_config.json", handwritten_layer = True, main_service = "pubsub", + rest_numeric_enums = True, service_yaml = ":pubsub_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -292,7 +300,6 @@ ruby_cloud_gapic_library( extra_protoc_parameters = [ "ruby-cloud-gem-name=google-cloud-pubsub-v1", "ruby-cloud-env-prefix=PUBSUB", - "ruby-cloud-common-services=google.iam.v1.IAMPolicy=google.pubsub.v1.Publisher", "ruby-cloud-path-override=pub_sub=pubsub", "ruby-cloud-namespace-override=Pubsub=PubSub", "ruby-cloud-product-url=https://cloud.google.com/pubsub", @@ -300,8 +307,10 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=pubsub", ], grpc_service_config = "pubsub_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Pub/Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications.", ruby_cloud_title = "Cloud Pub/Sub V1", + service_yaml = ":pubsub_v1.yaml", deps = [ ":pubsub_ruby_grpc", ":pubsub_ruby_proto", @@ -344,6 +353,7 @@ csharp_gapic_library( name = "pubsub_csharp_gapic", srcs = [":pubsub_proto_with_info"], grpc_service_config = "pubsub_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = ":pubsub_v1.yaml", deps = [ ":pubsub_csharp_grpc", diff --git a/google/rpc/code.proto b/google/rpc/code.proto index 98ae0ac18..7c810af40 100644 --- a/google/rpc/code.proto +++ b/google/rpc/code.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. @@ -30,7 +30,7 @@ option objc_class_prefix = "RPC"; // `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply. // Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`. enum Code { - // Not an error; returned on success + // Not an error; returned on success. // // HTTP Mapping: 200 OK OK = 0; @@ -69,7 +69,7 @@ enum Code { // Some requested entity (e.g., file or directory) was not found. // // Note to server developers: if a request is denied for an entire class - // of users, such as gradual feature rollout or undocumented whitelist, + // of users, such as gradual feature rollout or undocumented allowlist, // `NOT_FOUND` may be used. If a request is denied for some users within // a class of users, such as user-based access control, `PERMISSION_DENIED` // must be used. @@ -115,11 +115,11 @@ enum Code { // Service implementors can use the following guidelines to decide // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: // (a) Use `UNAVAILABLE` if the client can retry just the failing call. - // (b) Use `ABORTED` if the client should retry at a higher level - // (e.g., when a client-specified test-and-set fails, indicating the - // client should restart a read-modify-write sequence). + // (b) Use `ABORTED` if the client should retry at a higher level. For + // example, when a client-specified test-and-set fails, indicating the + // client should restart a read-modify-write sequence. // (c) Use `FAILED_PRECONDITION` if the client should not retry until - // the system state has been explicitly fixed. E.g., if an "rmdir" + // the system state has been explicitly fixed. For example, if an "rmdir" // fails because the directory is non-empty, `FAILED_PRECONDITION` // should be returned since the client should not retry unless // the files are deleted from the directory. diff --git a/google/rpc/context/attribute_context.proto b/google/rpc/context/attribute_context.proto index 30fe6f25a..ef9242e40 100644 --- a/google/rpc/context/attribute_context.proto +++ b/google/rpc/context/attribute_context.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. @@ -61,7 +61,7 @@ message AttributeContext { // The identity of this peer. Similar to `Request.auth.principal`, but // relative to the peer instead of the request. For example, the - // idenity associated with a load balancer that forwared the request. + // identity associated with a load balancer that forwarded the request. string principal = 7; // The CLDR country/region code associated with the above IP address. @@ -170,7 +170,7 @@ message AttributeContext { // lowercased, because HTTP header keys are case-insensitive. map headers = 3; - // The HTTP URL path. + // The HTTP URL path, excluding the query parameters. string path = 4; // The HTTP request `Host` header value. @@ -223,7 +223,7 @@ message AttributeContext { // the response. google.protobuf.Timestamp time = 4; - // The length of time it takes the backend service to fully respond to a + // The amount of time it takes the backend service to fully respond to a // request. Measured from when the destination service starts to send the // request to the backend until when the destination service receives the // complete response from the backend. @@ -256,7 +256,8 @@ message AttributeContext { // The type of the resource. The syntax is platform-specific because // different platforms define their resources differently. // - // For Google APIs, the type format must be "{service}/{kind}". + // For Google APIs, the type format must be "{service}/{kind}", such as + // "pubsub.googleapis.com/Topic". string type = 3; // The labels or tags on the resource, such as AWS resource tags and diff --git a/google/rpc/context/audit_context.proto b/google/rpc/context/audit_context.proto new file mode 100644 index 000000000..7b8b7051f --- /dev/null +++ b/google/rpc/context/audit_context.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.rpc.context; + +import "google/protobuf/struct.proto"; + +option cc_enable_arenas = true; +option go_package = "google.golang.org/genproto/googleapis/rpc/context;context"; +option java_multiple_files = true; +option java_outer_classname = "AuditContextProto"; +option java_package = "com.google.rpc.context"; + +// `AuditContext` provides information that is needed for audit logging. +message AuditContext { + // Serialized audit log. + bytes audit_log = 1; + + // An API request message that is scrubbed based on the method annotation. + // This field should only be filled if audit_log field is present. + // Service Control will use this to assemble a complete log for Cloud Audit + // Logs and Google internal audit logs. + google.protobuf.Struct scrubbed_request = 2; + + // An API response message that is scrubbed based on the method annotation. + // This field should only be filled if audit_log field is present. + // Service Control will use this to assemble a complete log for Cloud Audit + // Logs and Google internal audit logs. + google.protobuf.Struct scrubbed_response = 3; + + // Number of scrubbed response items. + int32 scrubbed_response_item_count = 4; + + // Audit resource name which is scrubbed. + string target_resource = 5; +} diff --git a/google/rpc/error_details.proto b/google/rpc/error_details.proto index c4d6c4b78..c489e8314 100644 --- a/google/rpc/error_details.proto +++ b/google/rpc/error_details.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. @@ -24,6 +24,57 @@ option java_outer_classname = "ErrorDetailsProto"; option java_package = "com.google.rpc"; option objc_class_prefix = "RPC"; +// 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" +// } +// } +message ErrorInfo { + // 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_]+[A-Z0-9]`, which represents + // UPPER_SNAKE_CASE. + string reason = 1; + + // 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". + string domain = 2; + + // 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. + map metadata = 3; +} + // Describes when the clients can retry a failed request. Clients could ignore // the recommendation here or retry when this information is missing from error // responses. @@ -85,56 +136,6 @@ message QuotaFailure { repeated Violation violations = 1; } -// 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" -// } -// } -message ErrorInfo { - // 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-Z0-9_]+/. - string reason = 1; - - // 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". - string domain = 2; - - // 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. - map metadata = 3; -} - // Describes what preconditions have failed. // // For example, if an RPC failed because it required the Terms of Service to be @@ -169,9 +170,43 @@ message PreconditionFailure { message BadRequest { // A message type used to describe a single bad request field. message FieldViolation { - // A path leading to a field in the request body. The value will be a + // A path that leads to a field in the request body. The value will be a // sequence of dot-separated identifiers that identify a protocol buffer - // field. E.g., "field_violations.field" would identify this field. + // field. + // + // Consider the following: + // + // message CreateContactRequest { + // message EmailAddress { + // enum Type { + // TYPE_UNSPECIFIED = 0; + // HOME = 1; + // WORK = 2; + // } + // + // optional string email = 1; + // repeated EmailType type = 2; + // } + // + // string full_name = 1; + // repeated EmailAddress email_addresses = 2; + // } + // + // In this example, in proto `field` could take one of the following values: + // + // * `full_name` for a violation in the `full_name` value + // * `email_addresses[1].email` for a violation in the `email` field of the + // first `email_addresses` message + // * `email_addresses[3].type[2]` for a violation in the second `type` + // value in the third `email_addresses` message. + // + // In JSON, the same values are represented as: + // + // * `fullName` for a violation in the `fullName` value + // * `emailAddresses[1].email` for a violation in the `email` field of the + // first `emailAddresses` message + // * `emailAddresses[3].type[2]` for a violation in the second `type` + // value in the third `emailAddresses` message. string field = 1; // A description of why the request element is bad. @@ -203,7 +238,8 @@ message ResourceInfo { // The name of the resource being accessed. For example, a shared calendar // name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current - // error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED]. + // error is + // [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED]. string resource_name = 2; // The owner of the resource (optional). @@ -240,7 +276,7 @@ message Help { // which can be attached to an RPC error. message LocalizedMessage { // The locale used following the specification defined at - // http://www.rfc-editor.org/rfc/bcp/bcp47.txt. + // https://www.rfc-editor.org/rfc/bcp/bcp47.txt. // Examples are: "en-US", "fr-CH", "es-MX" string locale = 1; diff --git a/google/rpc/http.proto b/google/rpc/http.proto new file mode 100644 index 000000000..299a71fd0 --- /dev/null +++ b/google/rpc/http.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.rpc; + +option go_package = "google.golang.org/genproto/googleapis/rpc/http;http"; +option java_multiple_files = true; +option java_outer_classname = "HttpProto"; +option java_package = "com.google.rpc"; +option objc_class_prefix = "RPC"; + +// Represents an HTTP request. +message HttpRequest { + // The HTTP request method. + string method = 1; + + // The HTTP request URI. + string uri = 2; + + // The HTTP request headers. The ordering of the headers is significant. + // Multiple headers with the same key may present for the request. + repeated HttpHeader headers = 3; + + // The HTTP request body. If the body is not expected, it should be empty. + bytes body = 4; +} + +// Represents an HTTP response. +message HttpResponse { + // The HTTP status code, such as 200 or 404. + int32 status = 1; + + // The HTTP reason phrase, such as "OK" or "Not Found". + string reason = 2; + + // The HTTP response headers. The ordering of the headers is significant. + // Multiple headers with the same key may present for the response. + repeated HttpHeader headers = 3; + + // The HTTP response body. If the body is not expected, it should be empty. + bytes body = 4; +} + +// Represents an HTTP header. +message HttpHeader { + // The HTTP header key. It is case insensitive. + string key = 1; + + // The HTTP header value. + string value = 2; +} diff --git a/google/rpc/status.proto b/google/rpc/status.proto index 3b1f7a932..923e16938 100644 --- a/google/rpc/status.proto +++ b/google/rpc/status.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. @@ -33,12 +33,14 @@ option objc_class_prefix = "RPC"; // You can find out more about this error model and how to work with it in the // [API Design Guide](https://cloud.google.com/apis/design/errors). message Status { - // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + // The status code, which should be an enum value of + // [google.rpc.Code][google.rpc.Code]. int32 code = 1; // A developer-facing error message, which should be in English. Any // user-facing error message should be localized and sent in the - // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. + // [google.rpc.Status.details][google.rpc.Status.details] field, or localized + // by the client. string message = 2; // A list of messages that carry the error details. There is a common set of diff --git a/google/spanner/admin/database/v1/BUILD.bazel b/google/spanner/admin/database/v1/BUILD.bazel index 031faeb75..42495c3fc 100644 --- a/google/spanner/admin/database/v1/BUILD.bazel +++ b/google/spanner/admin/database/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "database_proto", @@ -48,18 +79,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "database_java_proto", deps = [":database_proto"], @@ -76,6 +95,7 @@ java_gapic_library( srcs = [":database_proto_with_info"], gapic_yaml = "spanner_admin_database_gapic.yaml", grpc_service_config = "spanner_admin_database_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner.yaml", test_deps = [ ":database_java_grpc", @@ -100,6 +120,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-admin-database-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":database_java_gapic", @@ -109,17 +130,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "database_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -138,14 +148,15 @@ go_gapic_library( srcs = [":database_proto_with_info"], grpc_service_config = "spanner_admin_database_grpc_service_config.json", importpath = "cloud.google.com/go/spanner/admin/database/apiv1;database", + rest_numeric_enums = True, service_yaml = "spanner.yaml", transport = "grpc+rest", deps = [ ":database_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -166,16 +177,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "database_py_gapic", srcs = [":database_proto"], @@ -184,6 +185,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=spanner_admin_database", ], + rest_numeric_enums = True, service_yaml = "spanner.yaml", transport = "grpc", deps = [ @@ -208,17 +210,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "database_php_proto", deps = [":database_proto"], @@ -235,7 +226,9 @@ php_gapic_library( srcs = [":database_proto_with_info"], gapic_yaml = "spanner_admin_database_gapic.yaml", grpc_service_config = "spanner_admin_database_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner.yaml", + transport = "grpc+rest", deps = [ ":database_php_grpc", ":database_php_proto", @@ -252,15 +245,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "database_nodejs_gapic", package_name = "@google-cloud/spanner", @@ -271,7 +255,9 @@ nodejs_gapic_library( ], grpc_service_config = "spanner_admin_database_grpc_service_config.json", package = "google.spanner.admin.database.v1", + rest_numeric_enums = True, service_yaml = "spanner.yaml", + transport = "grpc+rest", deps = [], ) @@ -283,17 +269,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "database_ruby_proto", deps = [":database_proto"], @@ -317,6 +292,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-spanner", ], grpc_service_config = "spanner_admin_database_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", ruby_cloud_title = "Cloud Spanner Database Admin V1", service_yaml = "spanner.yaml", @@ -336,17 +312,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "database_csharp_proto", deps = [":database_proto"], @@ -363,6 +328,7 @@ csharp_gapic_library( srcs = [":database_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "spanner_admin_database_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner.yaml", deps = [ ":database_csharp_grpc", @@ -380,15 +346,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "database_cc_proto", deps = [":database_proto"], diff --git a/google/spanner/admin/instance/v1/BUILD.bazel b/google/spanner/admin/instance/v1/BUILD.bazel index 92c4a962d..2ccd49edd 100644 --- a/google/spanner/admin/instance/v1/BUILD.bazel +++ b/google/spanner/admin/instance/v1/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "instance_proto", @@ -37,18 +68,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "instance_java_proto", deps = [":instance_proto"], @@ -65,6 +84,7 @@ java_gapic_library( srcs = [":instance_proto_with_info"], gapic_yaml = "spanner_admin_instance_gapic.yaml", grpc_service_config = "spanner_admin_instance_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":instance_java_grpc", "//google/iam/v1:iam_java_grpc", @@ -88,6 +108,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-admin-instance-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":instance_java_gapic", @@ -97,17 +118,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "instance_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -125,14 +135,15 @@ go_gapic_library( srcs = [":instance_proto_with_info"], grpc_service_config = "spanner_admin_instance_grpc_service_config.json", importpath = "cloud.google.com/go/spanner/admin/instance/apiv1;instance", + rest_numeric_enums = True, service_yaml = "spanner_admin_instance.yaml", transport = "grpc+rest", deps = [ ":instance_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", + "@com_google_cloud_go_longrunning//:go_default_library", + "@com_google_cloud_go_longrunning//autogen:go_default_library", ], ) @@ -153,16 +164,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "instance_py_gapic", srcs = [":instance_proto"], @@ -171,6 +172,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "python-gapic-name=spanner_admin_instance", ], + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -194,17 +196,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "instance_php_proto", deps = [":instance_proto"], @@ -221,7 +212,9 @@ php_gapic_library( srcs = [":instance_proto_with_info"], gapic_yaml = "spanner_admin_instance_gapic.yaml", grpc_service_config = "spanner_admin_instance_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner_admin_instance.yaml", + transport = "grpc+rest", deps = [ ":instance_php_grpc", ":instance_php_proto", @@ -238,15 +231,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "instance_nodejs_gapic", package_name = "@google-cloud/spanner", @@ -257,7 +241,9 @@ nodejs_gapic_library( ], grpc_service_config = "spanner_admin_instance_grpc_service_config.json", package = "google.spanner.admin.instance.v1", + rest_numeric_enums = True, service_yaml = "spanner_admin_instance.yaml", + transport = "grpc+rest", deps = [], ) @@ -269,17 +255,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "instance_ruby_proto", deps = [":instance_proto"], @@ -303,6 +278,7 @@ ruby_cloud_gapic_library( "ruby-cloud-wrapper-gem-override=google-cloud-spanner", ], grpc_service_config = "spanner_admin_instance_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", ruby_cloud_title = "Cloud Spanner Instance Admin V1", deps = [ @@ -321,17 +297,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "instance_csharp_proto", deps = [":instance_proto"], @@ -348,6 +313,7 @@ csharp_gapic_library( srcs = [":instance_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "spanner_admin_instance_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner_admin_instance.yaml", deps = [ ":instance_csharp_grpc", @@ -365,15 +331,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "instance_cc_proto", deps = [":instance_proto"], diff --git a/google/spanner/v1/BUILD.bazel b/google/spanner/v1/BUILD.bazel index 610b859f1..7ae586afe 100644 --- a/google/spanner/v1/BUILD.bazel +++ b/google/spanner/v1/BUILD.bazel @@ -1,13 +1,44 @@ # 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") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "spanner_proto", @@ -42,18 +73,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "spanner_java_proto", deps = [":spanner_proto"], @@ -70,6 +89,7 @@ java_gapic_library( srcs = [":spanner_proto_with_info"], gapic_yaml = "spanner_gapic.yaml", grpc_service_config = "spanner_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":spanner_java_grpc", ], @@ -91,6 +111,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-spanner-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":spanner_java_gapic", @@ -100,17 +121,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "spanner_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -127,6 +137,7 @@ go_gapic_library( srcs = [":spanner_proto_with_info"], grpc_service_config = "spanner_grpc_service_config.json", importpath = "cloud.google.com/go/spanner/apiv1;spanner", + rest_numeric_enums = True, service_yaml = "spanner.yaml", transport = "grpc+rest", deps = [ @@ -152,21 +163,12 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "spanner_py_gapic", srcs = [":spanner_proto"], grpc_service_config = "spanner_grpc_service_config.json", opt_args = ["python-gapic-namespace=google.cloud"], + rest_numeric_enums = True, transport = "grpc", ) @@ -187,17 +189,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "spanner_php_proto", deps = [":spanner_proto"], @@ -213,7 +204,9 @@ php_gapic_library( name = "spanner_php_gapic", srcs = [":spanner_proto_with_info"], grpc_service_config = "spanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner.yaml", + transport = "grpc+rest", deps = [ ":spanner_php_grpc", ":spanner_php_proto", @@ -230,15 +223,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "spanner_nodejs_gapic", package_name = "@google-cloud/spanner", @@ -251,7 +235,9 @@ nodejs_gapic_library( handwritten_layer = True, main_service = "spanner", package = "google.spanner.v1", + rest_numeric_enums = True, service_yaml = "spanner.yaml", + transport = "grpc+rest", deps = [], ) @@ -263,17 +249,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "spanner_ruby_proto", deps = [":spanner_proto"], @@ -296,6 +271,7 @@ ruby_cloud_gapic_library( "ruby-cloud-api-shortname=spanner", ], grpc_service_config = "spanner_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", ruby_cloud_title = "Cloud Spanner V1", deps = [ @@ -314,17 +290,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "spanner_csharp_proto", deps = [":spanner_proto"], @@ -341,6 +306,7 @@ csharp_gapic_library( srcs = [":spanner_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "spanner_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "spanner.yaml", deps = [ ":spanner_csharp_grpc", @@ -358,15 +324,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "spanner_cc_proto", deps = [":spanner_proto"], diff --git a/google/spanner/v1/result_set.proto b/google/spanner/v1/result_set.proto index 714d8bea9..36df232bc 100644 --- a/google/spanner/v1/result_set.proto +++ b/google/spanner/v1/result_set.proto @@ -174,6 +174,18 @@ message ResultSetMetadata { // If the read or SQL query began a transaction as a side-effect, the // information about the new transaction is yielded here. Transaction transaction = 2; + + // A SQL query can be parameterized. In PLAN mode, these parameters can be + // undeclared. This indicates the field names and types for those undeclared + // parameters in the SQL query. For example, a SQL query like `"SELECT * FROM + // Users where UserId = @userId and UserName = @userName "` could return a + // `undeclared_parameters` value like: + // + // "fields": [ + // { "name": "UserId", "type": { "code": "INT64" } }, + // { "name": "UserName", "type": { "code": "STRING" } }, + // ] + StructType undeclared_parameters = 3; } // Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet]. diff --git a/google/spanner/v1/transaction.proto b/google/spanner/v1/transaction.proto index 3577f797c..49ab5cf52 100644 --- a/google/spanner/v1/transaction.proto +++ b/google/spanner/v1/transaction.proto @@ -56,7 +56,8 @@ option ruby_package = "Google::Cloud::Spanner::V1"; // // Queries on change streams must be performed with the snapshot read-only // transaction mode, specifying a strong read. Please see -// [TransactionOptions.ReadOnly.strong][google.spanner.v1.TransactionOptions.ReadOnly.strong] for more details. +// [TransactionOptions.ReadOnly.strong][google.spanner.v1.TransactionOptions.ReadOnly.strong] +// for more details. // // 3. Partitioned DML. This type of transaction is used to execute // a single Partitioned DML statement. Partitioned DML partitions @@ -192,7 +193,8 @@ option ruby_package = "Google::Cloud::Spanner::V1"; // Queries on change streams (see below for more details) must also specify // the strong read timestamp bound. // -// See [TransactionOptions.ReadOnly.strong][google.spanner.v1.TransactionOptions.ReadOnly.strong]. +// See +// [TransactionOptions.ReadOnly.strong][google.spanner.v1.TransactionOptions.ReadOnly.strong]. // // Exact staleness: // @@ -213,7 +215,9 @@ option ruby_package = "Google::Cloud::Spanner::V1"; // equivalent boundedly stale concurrency modes. On the other hand, // boundedly stale reads usually return fresher results. // -// See [TransactionOptions.ReadOnly.read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.read_timestamp] and +// See +// [TransactionOptions.ReadOnly.read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.read_timestamp] +// and // [TransactionOptions.ReadOnly.exact_staleness][google.spanner.v1.TransactionOptions.ReadOnly.exact_staleness]. // // Bounded staleness: @@ -243,7 +247,9 @@ option ruby_package = "Google::Cloud::Spanner::V1"; // which rows will be read, it can only be used with single-use // read-only transactions. // -// See [TransactionOptions.ReadOnly.max_staleness][google.spanner.v1.TransactionOptions.ReadOnly.max_staleness] and +// See +// [TransactionOptions.ReadOnly.max_staleness][google.spanner.v1.TransactionOptions.ReadOnly.max_staleness] +// and // [TransactionOptions.ReadOnly.min_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.min_read_timestamp]. // // Old read timestamps and garbage collection: @@ -349,14 +355,34 @@ message TransactionOptions { // Message type to initiate a read-write transaction. Currently this // transaction type has no options. message ReadWrite { + // `ReadLockMode` is used to set the read lock mode for read-write + // transactions. + enum ReadLockMode { + // Default value. + // + // If the value is not specified, the pessimistic read lock is used. + READ_LOCK_MODE_UNSPECIFIED = 0; - } + // Pessimistic lock mode. + // + // Read locks are acquired immediately on read. + PESSIMISTIC = 1; - // Message type to initiate a Partitioned DML transaction. - message PartitionedDml { + // Optimistic lock mode. + // + // Locks for reads within the transaction are not acquired on read. + // Instead the locks are acquired on a commit to validate that + // read/queried data has not changed since the transaction started. + OPTIMISTIC = 2; + } + // Read lock mode for the transaction. + ReadLockMode read_lock_mode = 1; } + // Message type to initiate a Partitioned DML transaction. + message PartitionedDml {} + // Message type to initiate a read-only transaction. message ReadOnly { // How to choose the timestamp for the read-only transaction. @@ -421,7 +447,8 @@ message TransactionOptions { } // If true, the Cloud Spanner-selected read timestamp is included in - // the [Transaction][google.spanner.v1.Transaction] message that describes the transaction. + // the [Transaction][google.spanner.v1.Transaction] message that describes + // the transaction. bool return_read_timestamp = 6; } @@ -475,7 +502,8 @@ message Transaction { // [Read][google.spanner.v1.Spanner.Read] or // [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] call runs. // -// See [TransactionOptions][google.spanner.v1.TransactionOptions] for more information about transactions. +// See [TransactionOptions][google.spanner.v1.TransactionOptions] for more +// information about transactions. message TransactionSelector { // If no fields are set, the default is a single use transaction // with strong concurrency. @@ -490,7 +518,8 @@ message TransactionSelector { // Begin a new transaction and execute this read or SQL query in // it. The transaction ID of the new transaction is returned in - // [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], which is a [Transaction][google.spanner.v1.Transaction]. + // [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], + // which is a [Transaction][google.spanner.v1.Transaction]. TransactionOptions begin = 3; } } diff --git a/google/storage/v2/BUILD.bazel b/google/storage/v2/BUILD.bazel index 633183745..465256886 100644 --- a/google/storage/v2/BUILD.bazel +++ b/google/storage/v2/BUILD.bazel @@ -9,14 +9,40 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "storage_proto", @@ -31,6 +57,7 @@ proto_library( "//google/iam/v1:iam_policy_proto", "//google/iam/v1:policy_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", @@ -45,18 +72,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "storage_java_proto", deps = [":storage_proto"], @@ -72,11 +87,12 @@ java_gapic_library( name = "storage_java_gapic", srcs = [":storage_proto_with_info"], grpc_service_config = "storage_grpc_service_config.json", + rest_numeric_enums = True, test_deps = [ ":storage_java_grpc", "//google/iam/v1:iam_java_grpc", ], - transport = "grpc+rest", + transport = "grpc", deps = [ ":storage_java_proto", "//google/iam/v1:iam_java_proto", @@ -86,7 +102,6 @@ java_gapic_library( java_gapic_test( name = "storage_java_gapic_test_suite", test_classes = [ - "com.google.storage.v2.StorageClientHttpJsonTest", "com.google.storage.v2.StorageClientTest", ], runtime_deps = [":storage_java_gapic_test"], @@ -95,7 +110,8 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-storage-v2-java", - transport = "grpc+rest", + include_samples = True, + transport = "grpc", deps = [ ":storage_java_gapic", ":storage_java_grpc", @@ -104,17 +120,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "storage_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -122,6 +127,7 @@ go_proto_library( protos = [":storage_proto"], deps = [ "//google/api:annotations_go_proto", + "//google/api:routing_go_proto", "//google/iam/v1:iam_go_proto", "//google/type:date_go_proto", ], @@ -133,10 +139,13 @@ go_gapic_library( grpc_service_config = "storage_grpc_service_config.json", importpath = "cloud.google.com/go/storage/apiv2;storage", metadata = True, + rest_numeric_enums = True, service_yaml = "storage_v2.yaml", + transport = "grpc", deps = [ ":storage_go_proto", "//google/iam/v1:iam_go_proto", + "@io_bazel_rules_go//proto/wkt:duration_go_proto", ], ) @@ -158,19 +167,11 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", -) - py_gapic_library( name = "storage_py_gapic", srcs = [":storage_proto"], grpc_service_config = "storage_grpc_service_config.json", + rest_numeric_enums = True, transport = "grpc", deps = [ "//google/iam/v1:iam_policy_py_proto", @@ -197,17 +198,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_php_proto", deps = [":storage_proto"], @@ -219,11 +209,14 @@ php_grpc_library( deps = [":storage_php_proto"], ) +# PHP always supports gRPC and REST, but there is no PHP GAPIC for this API. php_gapic_library( name = "storage_php_gapic", srcs = [":storage_proto_with_info"], grpc_service_config = "storage_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "storage_v2.yaml", + transport = "grpc+rest", deps = [ ":storage_php_grpc", ":storage_php_proto", @@ -240,15 +233,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "storage_nodejs_gapic", package_name = "@google-cloud/storage", @@ -256,7 +240,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "storage_grpc_service_config.json", package = "google.storage.v2", + rest_numeric_enums = True, service_yaml = "storage_v2.yaml", + transport = "grpc", deps = [], ) @@ -268,17 +254,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storage_ruby_proto", deps = [":storage_proto"], @@ -295,6 +270,7 @@ ruby_cloud_gapic_library( srcs = [":storage_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-storage-v2"], grpc_service_config = "storage_grpc_service_config.json", + rest_numeric_enums = True, deps = [ ":storage_ruby_grpc", ":storage_ruby_proto", @@ -358,16 +334,6 @@ ruby_gapic_assembly_pkg( # ], # ) -############################################################################## -# C++ -############################################################################## -# Manually added. Do not remove in regen. -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "storage_cc_proto", deps = [":storage_proto"], diff --git a/google/storage/v2/storage.proto b/google/storage/v2/storage.proto index f6b522a30..7dc2b5f02 100644 --- a/google/storage/v2/storage.proto +++ b/google/storage/v2/storage.proto @@ -22,6 +22,7 @@ import "google/api/resource.proto"; import "google/api/routing.proto"; import "google/iam/v1/iam_policy.proto"; import "google/iam/v1/policy.proto"; +import "google/protobuf/duration.proto"; import "google/protobuf/empty.proto"; import "google/protobuf/field_mask.proto"; import "google/protobuf/timestamp.proto"; @@ -69,10 +70,7 @@ service Storage { // Permanently deletes an empty bucket. rpc DeleteBucket(DeleteBucketRequest) returns (google.protobuf.Empty) { option (google.api.routing) = { - routing_parameters { - field: "name" - path_template: "{bucket=**}" - } + routing_parameters { field: "name" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "name"; } @@ -80,10 +78,7 @@ service Storage { // Returns metadata for the specified bucket. rpc GetBucket(GetBucketRequest) returns (Bucket) { option (google.api.routing) = { - routing_parameters { - field: "name" - path_template: "{bucket=**}" - } + routing_parameters { field: "name" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "name"; } @@ -91,10 +86,7 @@ service Storage { // Creates a new bucket. rpc CreateBucket(CreateBucketRequest) returns (Bucket) { option (google.api.routing) = { - routing_parameters { - field: "parent" - path_template: "{project=**}" - } + routing_parameters { field: "parent" path_template: "{project=**}" } }; option (google.api.method_signature) = "parent,bucket,bucket_id"; } @@ -102,32 +94,28 @@ service Storage { // Retrieves a list of buckets for a given project. rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse) { option (google.api.routing) = { - routing_parameters { - field: "parent" - path_template: "{project=**}" - } + routing_parameters { field: "parent" path_template: "{project=**}" } }; option (google.api.method_signature) = "parent"; } // Locks retention policy on a bucket. - rpc LockBucketRetentionPolicy(LockBucketRetentionPolicyRequest) returns (Bucket) { + rpc LockBucketRetentionPolicy(LockBucketRetentionPolicyRequest) + returns (Bucket) { option (google.api.routing) = { - routing_parameters { - field: "bucket" - path_template: "{bucket=**}" - } + routing_parameters { field: "bucket" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "bucket"; } // Gets the IAM policy for a specified bucket or object. - rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + // The `resource` field in the request should be + // projects/_/buckets/ for a bucket or + // projects/_/buckets//objects/ for an object. + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.routing) = { - routing_parameters { - field: "resource" - path_template: "{bucket=**}" - } + routing_parameters { field: "resource" path_template: "{bucket=**}" } routing_parameters { field: "resource" path_template: "{bucket=projects/*/buckets/*}/objects/**" @@ -137,12 +125,13 @@ service Storage { } // Updates an IAM policy for the specified bucket or object. - rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + // The `resource` field in the request should be + // projects/_/buckets/ for a bucket or + // projects/_/buckets//objects/ for an object. + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.routing) = { - routing_parameters { - field: "resource" - path_template: "{bucket=**}" - } + routing_parameters { field: "resource" path_template: "{bucket=**}" } routing_parameters { field: "resource" path_template: "{bucket=projects/*/buckets/*}/objects/**" @@ -153,12 +142,13 @@ service Storage { // Tests a set of permissions on the given bucket or object to see which, if // any, are held by the caller. - rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + // The `resource` field in the request should be + // projects/_/buckets/ for a bucket or + // projects/_/buckets//objects/ for an object. + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) + returns (google.iam.v1.TestIamPermissionsResponse) { option (google.api.routing) = { - routing_parameters { - field: "resource" - path_template: "{bucket=**}" - } + routing_parameters { field: "resource" path_template: "{bucket=**}" } routing_parameters { field: "resource" path_template: "{bucket=projects/*/buckets/*}/objects/**" @@ -170,16 +160,14 @@ service Storage { // Updates a bucket. Equivalent to JSON API's storage.buckets.patch method. rpc UpdateBucket(UpdateBucketRequest) returns (Bucket) { option (google.api.routing) = { - routing_parameters { - field: "bucket.name" - path_template: "{bucket=**}" - } + routing_parameters { field: "bucket.name" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "bucket,update_mask"; } // Permanently deletes a notification subscription. - rpc DeleteNotification(DeleteNotificationRequest) returns (google.protobuf.Empty) { + rpc DeleteNotification(DeleteNotificationRequest) + returns (google.protobuf.Empty) { option (google.api.routing) = { routing_parameters { field: "name" @@ -206,21 +194,16 @@ service Storage { // See https://cloud.google.com/storage/docs/pubsub-notifications. rpc CreateNotification(CreateNotificationRequest) returns (Notification) { option (google.api.routing) = { - routing_parameters { - field: "parent" - path_template: "{bucket=**}" - } + routing_parameters { field: "parent" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "parent,notification"; } // Retrieves a list of notification subscriptions for a given bucket. - rpc ListNotifications(ListNotificationsRequest) returns (ListNotificationsResponse) { + rpc ListNotifications(ListNotificationsRequest) + returns (ListNotificationsResponse) { option (google.api.routing) = { - routing_parameters { - field: "parent" - path_template: "{bucket=**}" - } + routing_parameters { field: "parent" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "parent"; } @@ -240,17 +223,15 @@ service Storage { // is not enabled for the bucket, or if the `generation` parameter is used. rpc DeleteObject(DeleteObjectRequest) returns (google.protobuf.Empty) { option (google.api.routing) = { - routing_parameters { - field: "bucket" - path_template: "{bucket=**}" - } + routing_parameters { field: "bucket" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "bucket,object"; option (google.api.method_signature) = "bucket,object,generation"; } // Cancels an in-progress resumable upload. - rpc CancelResumableWrite(CancelResumableWriteRequest) returns (CancelResumableWriteResponse) { + rpc CancelResumableWrite(CancelResumableWriteRequest) + returns (CancelResumableWriteResponse) { option (google.api.routing) = { routing_parameters { field: "upload_id" @@ -263,10 +244,7 @@ service Storage { // Retrieves an object's metadata. rpc GetObject(GetObjectRequest) returns (Object) { option (google.api.routing) = { - routing_parameters { - field: "bucket" - path_template: "{bucket=**}" - } + routing_parameters { field: "bucket" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "bucket,object"; option (google.api.method_signature) = "bucket,object,generation"; @@ -275,10 +253,7 @@ service Storage { // Reads an object's data. rpc ReadObject(ReadObjectRequest) returns (stream ReadObjectResponse) { option (google.api.routing) = { - routing_parameters { - field: "bucket" - path_template: "{bucket=**}" - } + routing_parameters { field: "bucket" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "bucket,object"; option (google.api.method_signature) = "bucket,object,generation"; @@ -288,10 +263,7 @@ service Storage { // Equivalent to JSON API's storage.objects.patch. rpc UpdateObject(UpdateObjectRequest) returns (Object) { option (google.api.routing) = { - routing_parameters { - field: "object.bucket" - path_template: "{bucket=**}" - } + routing_parameters { field: "object.bucket" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "object,update_mask"; } @@ -348,26 +320,12 @@ service Storage { // Attempting to resume an already finalized object will result in an OK // status, with a WriteObjectResponse containing the finalized object's // metadata. - rpc WriteObject(stream WriteObjectRequest) returns (WriteObjectResponse) { - option (google.api.routing) = { - routing_parameters { - field: "write_object_spec.resource.bucket" - path_template: "{bucket=**}" - } - routing_parameters { - field: "upload_id" - path_template: "{bucket=projects/*/buckets/*}/**" - } - }; - } + rpc WriteObject(stream WriteObjectRequest) returns (WriteObjectResponse) {} // Retrieves a list of objects matching the criteria. rpc ListObjects(ListObjectsRequest) returns (ListObjectsResponse) { option (google.api.routing) = { - routing_parameters { - field: "parent" - path_template: "{bucket=**}" - } + routing_parameters { field: "parent" path_template: "{bucket=**}" } }; option (google.api.method_signature) = "parent"; } @@ -376,9 +334,7 @@ service Storage { // metadata. rpc RewriteObject(RewriteObjectRequest) returns (RewriteResponse) { option (google.api.routing) = { - routing_parameters { - field: "source_bucket" - } + routing_parameters { field: "source_bucket" } routing_parameters { field: "destination_bucket" path_template: "{bucket=**}" @@ -389,7 +345,8 @@ service Storage { // Starts a resumable write. How long the write operation remains valid, and // what happens when the write operation becomes invalid, are // service-dependent. - rpc StartResumableWrite(StartResumableWriteRequest) returns (StartResumableWriteResponse) { + rpc StartResumableWrite(StartResumableWriteRequest) + returns (StartResumableWriteResponse) { option (google.api.routing) = { routing_parameters { field: "write_object_spec.resource.bucket" @@ -411,7 +368,8 @@ service Storage { // evicted. For any sequence of `QueryWriteStatus()` calls for a given // object name, the sequence of returned `persisted_size` values will be // non-decreasing. - rpc QueryWriteStatus(QueryWriteStatusRequest) returns (QueryWriteStatusResponse) { + rpc QueryWriteStatus(QueryWriteStatusRequest) + returns (QueryWriteStatusResponse) { option (google.api.routing) = { routing_parameters { field: "upload_id" @@ -424,9 +382,7 @@ service Storage { // Retrieves the name of a project's Google Cloud Storage service account. rpc GetServiceAccount(GetServiceAccountRequest) returns (ServiceAccount) { option (google.api.routing) = { - routing_parameters { - field: "project" - } + routing_parameters { field: "project" } }; option (google.api.method_signature) = "project"; } @@ -434,9 +390,7 @@ service Storage { // Creates a new HMAC key for the given service account. rpc CreateHmacKey(CreateHmacKeyRequest) returns (CreateHmacKeyResponse) { option (google.api.routing) = { - routing_parameters { - field: "project" - } + routing_parameters { field: "project" } }; option (google.api.method_signature) = "project,service_account_email"; } @@ -444,9 +398,7 @@ service Storage { // Deletes a given HMAC key. Key must be in an INACTIVE state. rpc DeleteHmacKey(DeleteHmacKeyRequest) returns (google.protobuf.Empty) { option (google.api.routing) = { - routing_parameters { - field: "project" - } + routing_parameters { field: "project" } }; option (google.api.method_signature) = "access_id,project"; } @@ -454,9 +406,7 @@ service Storage { // Gets an existing HMAC key metadata for the given id. rpc GetHmacKey(GetHmacKeyRequest) returns (HmacKeyMetadata) { option (google.api.routing) = { - routing_parameters { - field: "project" - } + routing_parameters { field: "project" } }; option (google.api.method_signature) = "access_id,project"; } @@ -464,9 +414,7 @@ service Storage { // Lists HMAC keys under a given project with the additional filters provided. rpc ListHmacKeys(ListHmacKeysRequest) returns (ListHmacKeysResponse) { option (google.api.routing) = { - routing_parameters { - field: "project" - } + routing_parameters { field: "project" } }; option (google.api.method_signature) = "project"; } @@ -488,9 +436,7 @@ message DeleteBucketRequest { // Required. Name of a bucket to delete. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; // If set, only deletes the bucket if its metageneration matches this value. @@ -506,9 +452,7 @@ message GetBucketRequest { // Required. Name of a bucket. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; // If set, and if the bucket's current metageneration does not match the @@ -541,9 +485,9 @@ message CreateBucketRequest { // result in an error. Bucket bucket = 2; - // Required. The ID to use for this bucket, which will become the final component of - // the bucket's resource name. For example, the value `foo` might result in - // a bucket with the name `projects/123456/buckets/foo`. + // Required. The ID to use for this bucket, which will become the final + // component of the bucket's resource name. For example, the value `foo` might + // result in a bucket with the name `projects/123456/buckets/foo`. string bucket_id = 3 [(google.api.field_behavior) = REQUIRED]; // Apply a predefined set of access controls to this bucket. @@ -602,13 +546,11 @@ message LockBucketRetentionPolicyRequest { // Required. Name of a bucket. string bucket = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; - // Required. Makes the operation conditional on whether bucket's current metageneration - // matches the given value. Must be positive. + // Required. Makes the operation conditional on whether bucket's current + // metageneration matches the given value. Must be positive. int64 if_metageneration_match = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -646,7 +588,8 @@ message UpdateBucketRequest { // Not specifying any fields is an error. // Not specifying a field while setting that field to a non-default value is // an error. - google.protobuf.FieldMask update_mask = 6 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 6 + [(google.api.field_behavior) = REQUIRED]; } // Request message for DeleteNotification. @@ -667,9 +610,7 @@ message GetNotificationRequest { // `projects/{project}/buckets/{bucket}/notificationConfigs/{notification}` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; } @@ -733,8 +674,8 @@ message ComposeObjectRequest { optional int64 if_generation_match = 1; } - // Required. The source object's name. All source objects must reside in the same - // bucket. + // Required. The source object's name. All source objects must reside in the + // same bucket. string name = 1 [(google.api.field_behavior) = REQUIRED]; // The generation of this object to use as the source. @@ -769,11 +710,15 @@ message ComposeObjectRequest { // that will be used to encrypt the object. Overrides the object // metadata's `kms_key_name` value, if any. string kms_key = 6 [(google.api.resource_reference) = { - type: "cloudkms.googleapis.com/CryptoKey" - }]; + type: "cloudkms.googleapis.com/CryptoKey" + }]; // A set of parameters common to Storage API requests concerning an object. CommonObjectRequestParams common_object_request_params = 7; + + // The checksums of the complete object. This will be validated against the + // combined checksums of the component objects. + ObjectChecksums object_checksums = 10; } // Message for deleting an object. @@ -782,7 +727,9 @@ message DeleteObjectRequest { // Required. Name of the bucket in which the object resides. string bucket = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The name of the object to delete (when not using a resumable write). + // Required. The name of the finalized object to delete. + // Note: If you want to delete an unfinalized resumable upload please use + // `CancelResumableWrite`. string object = 2 [(google.api.field_behavior) = REQUIRED]; // If present, permanently deletes a specific revision of this object (as @@ -815,16 +762,14 @@ message DeleteObjectRequest { // Message for canceling an in-progress resumable upload. // `upload_id` **must** be set. message CancelResumableWriteRequest { - // Required. The upload_id of the resumable upload to cancel. This should be copied - // from the `upload_id` field of `StartResumableWriteResponse`. + // Required. The upload_id of the resumable upload to cancel. This should be + // copied from the `upload_id` field of `StartResumableWriteResponse`. string upload_id = 1 [(google.api.field_behavior) = REQUIRED]; } // Empty response message for canceling an in-progress resumable upload, will be // extended as needed. -message CancelResumableWriteResponse { - -} +message CancelResumableWriteResponse {} // Request message for ReadObject. message ReadObjectRequest { @@ -1006,8 +951,8 @@ message WriteObjectRequest { WriteObjectSpec write_object_spec = 2; } - // Required. The offset from the beginning of the object at which the data should be - // written. + // Required. The offset from the beginning of the object at which the data + // should be written. // // In the first `WriteObjectRequest` of a `WriteObject()` action, it // indicates the initial offset for the `Write()` call. The value **must** be @@ -1108,23 +1053,23 @@ message ListObjectsRequest { // * may be used to mean "all fields". optional google.protobuf.FieldMask read_mask = 8; - // Filter results to objects whose names are lexicographically equal to or - // after lexicographic_start. If lexicographic_end is also set, the objects - // listed have names between lexicographic_start (inclusive) and + // Optional. Filter results to objects whose names are lexicographically equal + // to or after lexicographic_start. If lexicographic_end is also set, the + // objects listed have names between lexicographic_start (inclusive) and // lexicographic_end (exclusive). - string lexicographic_start = 10; + string lexicographic_start = 10 [(google.api.field_behavior) = OPTIONAL]; - // Filter results to objects whose names are lexicographically before - // lexicographic_end. If lexicographic_start is also set, the objects listed - // have names between lexicographic_start (inclusive) and lexicographic_end - // (exclusive). - string lexicographic_end = 11; + // Optional. Filter results to objects whose names are lexicographically + // before lexicographic_end. If lexicographic_start is also set, the objects + // listed have names between lexicographic_start (inclusive) and + // lexicographic_end (exclusive). + string lexicographic_end = 11 [(google.api.field_behavior) = OPTIONAL]; } // Request object for `QueryWriteStatus`. message QueryWriteStatusRequest { - // Required. The name of the resume token for the object whose write status is being - // requested. + // Required. The name of the resume token for the object whose write status is + // being requested. string upload_id = 1 [(google.api.field_behavior) = REQUIRED]; // A set of parameters common to Storage API requests concerning an object. @@ -1158,7 +1103,7 @@ message QueryWriteStatusResponse { message RewriteObjectRequest { // Required. Immutable. The name of the destination object. // See the - // [Naming Guidelines](https://cloud.google.com/storage/docs/naming-objects). + // [Naming Guidelines](https://cloud.google.com/storage/docs/objects#naming). // Example: `test.txt` // The `name` field by itself does not uniquely identify a Cloud Storage // object. A Cloud Storage object is uniquely identified by the tuple of @@ -1168,13 +1113,12 @@ message RewriteObjectRequest { (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The name of the bucket containing the destination object. + // Required. Immutable. The name of the bucket containing the destination + // object. string destination_bucket = 25 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; // The name of the Cloud KMS key that will be used to encrypt the destination @@ -1183,8 +1127,8 @@ message RewriteObjectRequest { // bucket's default encryption key, if any, or else the Google-managed // encryption key. string destination_kms_key = 27 [(google.api.resource_reference) = { - type: "cloudkms.googleapis.com/CryptoKey" - }]; + type: "cloudkms.googleapis.com/CryptoKey" + }]; // Properties of the destination, post-rewrite object. // The `name`, `bucket` and `kms_key` fields must not be populated (these @@ -1278,6 +1222,10 @@ message RewriteObjectRequest { // A set of parameters common to Storage API requests concerning an object. CommonObjectRequestParams common_object_request_params = 19; + + // The checksums of the complete object. This will be used to validate the + // destination object after rewriting. + ObjectChecksums object_checksums = 29; } // A rewrite response. @@ -1305,11 +1253,19 @@ message RewriteResponse { // Request message StartResumableWrite. message StartResumableWriteRequest { - // Required. The destination bucket, object, and metadata, as well as any preconditions. - WriteObjectSpec write_object_spec = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The destination bucket, object, and metadata, as well as any + // preconditions. + WriteObjectSpec write_object_spec = 1 + [(google.api.field_behavior) = REQUIRED]; // A set of parameters common to Storage API requests concerning an object. CommonObjectRequestParams common_object_request_params = 3; + + // The checksums of the complete object. This will be used to validate the + // uploaded object. For each upload, object_checksums can be provided with + // either StartResumableWriteRequest or the WriteObjectRequest with + // finish_write set to `true`. + ObjectChecksums object_checksums = 5; } // Response object for `StartResumableWrite`. @@ -1362,7 +1318,8 @@ message UpdateObjectRequest { // Not specifying any fields is an error. // Not specifying a field while setting that field to a non-default value is // an error. - google.protobuf.FieldMask update_mask = 7 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 7 + [(google.api.field_behavior) = REQUIRED]; // A set of parameters common to Storage API requests concerning an object. CommonObjectRequestParams common_object_request_params = 8; @@ -1382,9 +1339,9 @@ message GetServiceAccountRequest { // Request message for CreateHmacKey. message CreateHmacKeyRequest { - // Required. The project that the HMAC-owning service account lives in, in the format of - // "projects/". - // can be the project ID or project number. + // Required. The project that the HMAC-owning service account lives in, in the + // format of "projects/". can be the + // project ID or project number. string project = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -1586,8 +1543,6 @@ message ServiceConstants { // GetListObjectsSplitPoints RPC is valid. SPLIT_TOKEN_MAX_VALID_DAYS = 14; } - - } // A bucket. @@ -1634,8 +1589,8 @@ message Bucket { // The name of the Cloud KMS key that will be used to encrypt objects // inserted into this bucket, if no encryption method is specified. string default_kms_key = 1 [(google.api.resource_reference) = { - type: "cloudkms.googleapis.com/CryptoKey" - }]; + type: "cloudkms.googleapis.com/CryptoKey" + }]; } // Bucket restriction options. @@ -1647,8 +1602,9 @@ message Bucket { bool enabled = 1; // The deadline time for changing - // `iamConfig.uniformBucketLevelAccess.enabled` from `true` to `false`. - // Mutable until the specified deadline is reached, but not afterward. + // `iam_config.uniform_bucket_level_access.enabled` from `true` to + // `false`. Mutable until the specified deadline is reached, but not + // afterward. google.protobuf.Timestamp lock_time = 2; } @@ -1771,6 +1727,13 @@ message Bucket { // enforcement of retention periods less than a day is not guaranteed. Such // periods should only be used for testing purposes. optional int64 retention_period = 3; + + // The duration that objects need to be retained. Retention duration must be + // greater than zero and less than 100 years. Note that enforcement of + // retention periods less than a day is not guaranteed. Such periods should + // only be used for testing purposes. Any `nanos` value specified will be + // rounded down to the nearest second. + google.protobuf.Duration retention_duration = 4; } // Properties of a bucket related to versioning. @@ -1812,19 +1775,20 @@ message Bucket { // Enables Autoclass. bool enabled = 1; - // Output only. Latest instant at which the `enabled` field was set to true after being - // disabled/unconfigured or set to false after being enabled. If Autoclass - // is enabled when the bucket is created, the toggle_time is set to the - // bucket creation time. - google.protobuf.Timestamp toggle_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Latest instant at which the `enabled` field was set to true + // after being disabled/unconfigured or set to false after being enabled. If + // Autoclass is enabled when the bucket is created, the toggle_time is set + // to the bucket creation time. + google.protobuf.Timestamp toggle_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Immutable. The name of the bucket. string name = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. The user-chosen part of the bucket name. The `{bucket}` portion of the - // `name` field. For globally unique buckets, this is equal to the "bucket - // name" of other Cloud Storage APIs. Example: "pub". + // Output only. The user-chosen part of the bucket name. The `{bucket}` + // portion of the `name` field. For globally unique buckets, this is equal to + // the "bucket name" of other Cloud Storage APIs. Example: "pub". string bucket_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // The etag of the bucket. @@ -1847,14 +1811,16 @@ message Bucket { // [FieldViolation][google.rpc.BadRequest.FieldViolation]. int64 metageneration = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. The location of the bucket. Object data for objects in the bucket resides - // in physical storage within this region. Defaults to `US`. See the + // Immutable. The location of the bucket. Object data for objects in the + // bucket resides in physical storage within this region. Defaults to `US`. + // See the // [https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations"][developer's // guide] for the authoritative list. Attempting to update this field after // the bucket is created will result in an error. string location = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. The location type of the bucket (region, dual-region, multi-region, etc). + // Output only. The location type of the bucket (region, dual-region, + // multi-region, etc). string location_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // The bucket's default storage class, used whenever no storageClass is @@ -1874,12 +1840,12 @@ message Bucket { string rpo = 27; // Access controls on the bucket. - // If iamConfig.uniformBucketLevelAccess is enabled on this bucket, + // If iam_config.uniform_bucket_level_access is enabled on this bucket, // requests to set, read, or modify acl is an error. repeated BucketAccessControl acl = 8; // Default access controls to apply to new objects when no ACL is provided. - // If iamConfig.uniformBucketLevelAccess is enabled on this bucket, + // If iam_config.uniform_bucket_level_access is enabled on this bucket, // requests to set, read, or modify acl is an error. repeated ObjectAccessControl default_object_acl = 9; @@ -1891,7 +1857,8 @@ message Bucket { // Output only. The creation time of the bucket. // Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] // (CORS) config. @@ -1900,7 +1867,8 @@ message Bucket { // Output only. The modification time of the bucket. // Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp update_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The default value for event-based hold on newly created objects in this // bucket. Event-based hold is a way to retain objects indefinitely until an @@ -1933,7 +1901,8 @@ message Bucket { // and name prefix (if any) for the current bucket's logs. Logging logging = 18; - // Output only. The owner of the bucket. This is always the project team's owner group. + // Output only. The owner of the bucket. This is always the project team's + // owner group. Owner owner = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; // Encryption config for a bucket. @@ -1996,8 +1965,8 @@ message BucketAccessControl { // returned on response. string entity = 3; - // Output only. The alternative entity format, if exists. For project entities, - // `project-{team}-{projectid}` format will be returned on response. + // Output only. The alternative entity format, if exists. For project + // entities, `project-{team}-{projectid}` format will be returned on response. string entity_alt = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // The ID for the entity, if any. @@ -2057,9 +2026,9 @@ message HmacKeyMetadata { // Immutable. Globally unique id for keys. string access_id = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Identifies the project that owns the service account of the specified HMAC - // key, in the format "projects/". can - // be the project ID or project number. + // Immutable. Identifies the project that owns the service account of the + // specified HMAC key, in the format "projects/". + // can be the project ID or project number. string project = 3 [ (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { @@ -2075,10 +2044,12 @@ message HmacKeyMetadata { string state = 5; // Output only. The creation time of the HMAC key. - 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. The last modification time of the HMAC key metadata. - 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 etag of the HMAC key. string etag = 8; @@ -2097,7 +2068,8 @@ message Notification { // The `{project}` portion may be `_` for globally unique buckets. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The Pub/Sub topic to which this subscription publishes. Formatted as: + // Required. The Pub/Sub topic to which this subscription publishes. Formatted + // as: // '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' string topic = 2 [(google.api.field_behavior) = REQUIRED]; @@ -2135,9 +2107,9 @@ message CustomerEncryption { // An object. message Object { - // Immutable. The name of this object. Nearly any sequence of unicode characters is - // valid. See - // [Guidelines](https://cloud.google.com/storage/docs/naming-objects). + // Immutable. The name of this object. Nearly any sequence of unicode + // characters is valid. See + // [Guidelines](https://cloud.google.com/storage/docs/objects#naming). // Example: `test.txt` // The `name` field by itself does not uniquely identify a Cloud Storage // object. A Cloud Storage object is uniquely identified by the tuple of @@ -2147,9 +2119,7 @@ message Object { // Immutable. The name of the bucket containing this object. string bucket = 2 [ (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "storage.googleapis.com/Bucket" - } + (google.api.resource_reference) = { type: "storage.googleapis.com/Bucket" } ]; // The etag of the object. @@ -2158,17 +2128,16 @@ message Object { // object. string etag = 27; - // Immutable. The content generation of this object. Used for object versioning. - // Attempting to set or update this field will result in a + // Immutable. The content generation of this object. Used for object + // versioning. Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. int64 generation = 3 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. The version of the metadata for this generation of this object. Used for - // preconditions and for detecting changes in metadata. A metageneration - // number is only meaningful in the context of a particular generation of a - // particular object. - // Attempting to set or update this field will result in a - // [FieldViolation][google.rpc.BadRequest.FieldViolation]. + // Output only. The version of the metadata for this generation of this + // object. Used for preconditions and for detecting changes in metadata. A + // metageneration number is only meaningful in the context of a particular + // generation of a particular object. Attempting to set or update this field + // will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation]. int64 metageneration = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Storage class of the object. @@ -2195,7 +2164,7 @@ message Object { string cache_control = 9; // Access controls on the object. - // If iamConfig.uniformBucketLevelAccess is enabled on the parent + // If iam_config.uniform_bucket_level_access is enabled on the parent // bucket, requests to set, read, or modify acl is an error. repeated ObjectAccessControl acl = 10; @@ -2203,11 +2172,12 @@ message Object { // [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2]. string content_language = 11; - // Output only. The deletion time of the object. Will be returned if and only if this - // version of the object has been deleted. - // Attempting to set or update this field will result in a + // Output only. The deletion time of the object. Will be returned if and only + // if this version of the object has been deleted. Attempting to set or update + // this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp delete_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp delete_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Content-Type of the object data, matching // [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. @@ -2218,15 +2188,17 @@ message Object { // Output only. The creation time of the object. // Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp create_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Number of underlying components that make up this object. Components are - // accumulated by compose operations. - // Attempting to set or update this field will result in a + // Output only. Number of underlying components that make up this object. + // Components are accumulated by compose operations. Attempting to set or + // update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. int32 component_count = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Hashes for the data part of this object. + // Output only. Hashes for the data part of this object. This field is used + // for output only and will be silently ignored if provided in requests. ObjectChecksums checksums = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The modification time of the object metadata. @@ -2237,19 +2209,21 @@ message Object { // Object Lifecycle Configuration. // Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp update_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Cloud KMS Key used to encrypt this object, if the object is encrypted by // such a key. string kms_key = 18 [(google.api.resource_reference) = { - type: "cloudkms.googleapis.com/CryptoKey" - }]; + type: "cloudkms.googleapis.com/CryptoKey" + }]; - // Output only. The time at which the object's storage class was last changed. When the - // object is initially created, it will be set to time_created. + // Output only. The time at which the object's storage class was last changed. + // When the object is initially created, it will be set to time_created. // Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. - google.protobuf.Timestamp update_storage_class_time = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_storage_class_time = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Whether an object is under temporary hold. While this flag is set to true, // the object is protected against deletion and overwrites. A common use case @@ -2283,8 +2257,8 @@ message Object { // In a response, this field will always be set to true or false. optional bool event_based_hold = 23; - // Output only. The owner of the object. This will always be the uploader of the object. - // Attempting to set or update this field will result in a + // Output only. The owner of the object. This will always be the uploader of + // the object. Attempting to set or update this field will result in a // [FieldViolation][google.rpc.BadRequest.FieldViolation]. Owner owner = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -2324,8 +2298,8 @@ message ObjectAccessControl { // returned on response. string entity = 3; - // Output only. The alternative entity format, if exists. For project entities, - // `project-{team}-{projectid}` format will be returned on response. + // Output only. The alternative entity format, if exists. For project + // entities, `project-{team}-{projectid}` format will be returned on response. string entity_alt = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // The ID for the entity, if any. diff --git a/google/storagetransfer/v1/BUILD.bazel b/google/storagetransfer/v1/BUILD.bazel index 3becedcf0..3c28450fd 100644 --- a/google/storagetransfer/v1/BUILD.bazel +++ b/google/storagetransfer/v1/BUILD.bazel @@ -9,14 +9,45 @@ # * 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") +load( + "@com_google_googleapis_imports//:imports.bzl", + "cc_grpc_library", + "cc_proto_library", + "csharp_gapic_assembly_pkg", + "csharp_gapic_library", + "csharp_grpc_library", + "csharp_proto_library", + "go_gapic_assembly_pkg", + "go_gapic_library", + "go_proto_library", + "go_test", + "java_gapic_assembly_gradle_pkg", + "java_gapic_library", + "java_gapic_test", + "java_grpc_library", + "java_proto_library", + "nodejs_gapic_assembly_pkg", + "nodejs_gapic_library", + "php_gapic_assembly_pkg", + "php_gapic_library", + "php_grpc_library", + "php_proto_library", + "proto_library_with_info", + "py_gapic_assembly_pkg", + "py_gapic_library", + "py_test", + "ruby_cloud_gapic_library", + "ruby_gapic_assembly_pkg", + "ruby_grpc_library", + "ruby_proto_library", +) + +# This is an API workspace, having public visibility by default makes perfect sense. +package(default_visibility = ["//visibility:public"]) proto_library( name = "storagetransfer_proto", @@ -48,18 +79,6 @@ proto_library_with_info( ], ) -############################################################################## -# 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 = "storagetransfer_java_proto", deps = [":storagetransfer_proto"], @@ -76,6 +95,7 @@ java_gapic_library( srcs = [":storagetransfer_proto_with_info"], gapic_yaml = None, grpc_service_config = "storagetransfer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "storagetransfer_v1.yaml", test_deps = [ ":storagetransfer_java_grpc", @@ -99,6 +119,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-storagetransfer-v1-java", + include_samples = True, transport = "grpc+rest", deps = [ ":storagetransfer_java_gapic", @@ -108,17 +129,6 @@ java_gapic_assembly_gradle_pkg( ], ) -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - go_proto_library( name = "storagetransfer_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], @@ -139,13 +149,14 @@ go_gapic_library( grpc_service_config = "storagetransfer_grpc_service_config.json", importpath = "cloud.google.com/go/storagetransfer/apiv1;storagetransfer", metadata = True, + rest_numeric_enums = True, service_yaml = "storagetransfer_v1.yaml", transport = "grpc+rest", deps = [ ":storagetransfer_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -168,16 +179,6 @@ go_gapic_assembly_pkg( ], ) -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - py_gapic_library( name = "storagetransfer_py_gapic", srcs = [":storagetransfer_proto"], @@ -187,6 +188,7 @@ py_gapic_library( "python-gapic-namespace=google.cloud", "warehouse-package-name=google-cloud-storage-transfer", ], + rest_numeric_enums = True, transport = "grpc", ) @@ -208,17 +210,6 @@ py_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storagetransfer_php_proto", deps = [":storagetransfer_proto"], @@ -234,7 +225,9 @@ php_gapic_library( name = "storagetransfer_php_gapic", srcs = [":storagetransfer_proto_with_info"], grpc_service_config = "storagetransfer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "storagetransfer_v1.yaml", + transport = "grpc+rest", deps = [ ":storagetransfer_php_grpc", ":storagetransfer_php_proto", @@ -251,15 +244,6 @@ php_gapic_assembly_pkg( ], ) -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - nodejs_gapic_library( name = "storagetransfer_nodejs_gapic", package_name = "@google-cloud/storage-transfer", @@ -267,7 +251,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "storagetransfer_grpc_service_config.json", package = "google.storagetransfer.v1", + rest_numeric_enums = True, service_yaml = "storagetransfer_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -279,17 +265,6 @@ nodejs_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storagetransfer_ruby_proto", deps = [":storagetransfer_proto"], @@ -311,6 +286,7 @@ ruby_cloud_gapic_library( "ruby-cloud-product-url=https://cloud.google.com/storage-transfer-service/", ], grpc_service_config = "storagetransfer_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "Storage Transfer Service allows you to quickly import online data into Cloud Storage. You can also set up a repeating schedule for transferring data, as well as transfer data within Cloud Storage, from one bucket to another.", ruby_cloud_title = "Storage Transfer Service V1", deps = [ @@ -329,17 +305,6 @@ ruby_gapic_assembly_pkg( ], ) -############################################################################## -# 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 = "storagetransfer_csharp_proto", deps = [":storagetransfer_proto"], @@ -356,6 +321,7 @@ csharp_gapic_library( srcs = [":storagetransfer_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "storagetransfer_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "storagetransfer_v1.yaml", deps = [ ":storagetransfer_csharp_grpc", @@ -373,15 +339,6 @@ csharp_gapic_assembly_pkg( ], ) -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - cc_proto_library( name = "storagetransfer_cc_proto", deps = [":storagetransfer_proto"], diff --git a/google/streetview/publish/v1/BUILD.bazel b/google/streetview/publish/v1/BUILD.bazel index 553dc0d36..c020cc75e 100644 --- a/google/streetview/publish/v1/BUILD.bazel +++ b/google/streetview/publish/v1/BUILD.bazel @@ -75,7 +75,7 @@ java_gapic_library( srcs = [":publish_proto_with_info"], gapic_yaml = "streetview_publish_gapic.yaml", grpc_service_config = "streetview_publish_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", test_deps = [ ":publish_java_grpc", @@ -139,14 +139,14 @@ go_gapic_library( grpc_service_config = "streetview_publish_grpc_service_config.json", importpath = "google.golang.org/google/streetview/publish/v1;publish", metadata = True, - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", transport = "grpc+rest", deps = [ ":publish_go_proto", "//google/longrunning:longrunning_go_proto", - "@com_google_cloud_go//longrunning:go_default_library", - "@com_google_cloud_go//longrunning/autogen:go_default_library", + "@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", ], ) @@ -183,7 +183,7 @@ py_gapic_library( name = "publish_py_gapic", srcs = [":publish_proto"], grpc_service_config = "streetview_publish_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", transport = "grpc", deps = [ @@ -235,8 +235,9 @@ php_gapic_library( name = "publish_php_gapic", srcs = [":publish_proto_with_info"], grpc_service_config = "streetview_publish_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", + transport = "grpc+rest", deps = [ ":publish_php_grpc", ":publish_php_proto", @@ -269,8 +270,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "streetview_publish_grpc_service_config.json", package = "google.streetview.publish.v1", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", + transport = "grpc+rest", deps = [], ) @@ -309,7 +311,7 @@ ruby_cloud_gapic_library( srcs = [":publish_proto_with_info"], extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-publish-v1"], grpc_service_config = "streetview_publish_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", deps = [ ":publish_ruby_grpc", @@ -354,7 +356,7 @@ csharp_gapic_library( srcs = [":publish_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "streetview_publish_grpc_service_config.json", - rest_numeric_enums = False, + rest_numeric_enums = True, service_yaml = "streetviewpublish.yaml", deps = [ ":publish_csharp_grpc", diff --git a/grafeas/v1/BUILD.bazel b/grafeas/v1/BUILD.bazel index 400abffb7..3ba4f7d80 100644 --- a/grafeas/v1/BUILD.bazel +++ b/grafeas/v1/BUILD.bazel @@ -151,6 +151,7 @@ java_gapic_library( srcs = [":grafeas_proto_with_info"], gapic_yaml = None, grpc_service_config = "grafeas_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//grafeas:grafeas_v1.yaml", test_deps = [ ":grafeas_java_grpc", @@ -177,6 +178,7 @@ java_gapic_test( # Open Source Packages java_gapic_assembly_gradle_pkg( name = "google-cloud-grafeas-v1-java", + include_samples = True, transport = "grpc", deps = [ ":grafeas_java_gapic", @@ -206,9 +208,7 @@ go_proto_library( name = "grafeas_go_proto", compilers = ["@io_bazel_rules_go//proto:go_grpc"], importpath = "google.golang.org/genproto/googleapis/grafeas/v1", - protos = [ - ":grafeas_proto", - ], + protos = [":grafeas_proto"], deps = [ "//google/api:annotations_go_proto", "//google/rpc:status_go_proto", @@ -221,6 +221,7 @@ go_gapic_library( grpc_service_config = "grafeas_grpc_service_config.json", importpath = "cloud.google.com/go/grafeas/apiv1;grafeas", metadata = True, + rest_numeric_enums = True, service_yaml = "//grafeas:grafeas_v1.yaml", transport = "grpc", deps = [ @@ -308,8 +309,15 @@ py_gapic_library( name = "grafeas_py_gapic", srcs = [":grafeas_proto"], grpc_service_config = "grafeas_grpc_service_config.json", - opt_args = ["python-gapic-namespace=grafeas"], + opt_args = [ + "python-gapic-namespace=grafeas", + "warehouse-package-name=grafeas", + ], + rest_numeric_enums = True, + service_yaml = "//grafeas:grafeas_v1.yaml", transport = "grpc", + deps = [ + ], ) py_test( @@ -356,7 +364,9 @@ php_gapic_library( name = "grafeas_php_gapic", srcs = [":grafeas_proto_with_info"], grpc_service_config = "grafeas_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//grafeas:grafeas_v1.yaml", + transport = "grpc+rest", deps = [ ":grafeas_php_grpc", ":grafeas_php_proto", @@ -389,7 +399,9 @@ nodejs_gapic_library( extra_protoc_parameters = ["metadata"], grpc_service_config = "grafeas_grpc_service_config.json", package = "grafeas.v1", + rest_numeric_enums = True, service_yaml = "//grafeas:grafeas_v1.yaml", + transport = "grpc+rest", deps = [], ) @@ -432,8 +444,10 @@ ruby_cloud_gapic_library( "ruby-cloud-generic-endpoint=true", ], grpc_service_config = "grafeas_grpc_service_config.json", + rest_numeric_enums = True, ruby_cloud_description = "The Grafeas API stores, and enables querying and retrieval of, critical metadata about all of your software artifacts.", ruby_cloud_title = "Grafeas V1", + service_yaml = "//grafeas:grafeas_v1.yaml", deps = [ ":grafeas_ruby_grpc", ":grafeas_ruby_proto", @@ -477,6 +491,7 @@ csharp_gapic_library( srcs = [":grafeas_proto_with_info"], common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", grpc_service_config = "grafeas_grpc_service_config.json", + rest_numeric_enums = True, service_yaml = "//grafeas:grafeas_v1.yaml", deps = [ ":grafeas_csharp_grpc", diff --git a/grafeas/v1/cvss.proto b/grafeas/v1/cvss.proto index ab7e2b8d0..181ec052f 100644 --- a/grafeas/v1/cvss.proto +++ b/grafeas/v1/cvss.proto @@ -157,3 +157,10 @@ message CVSS { IMPACT_NONE = 3; } } + +// CVSS Version. +enum CVSSVersion { + CVSS_VERSION_UNSPECIFIED = 0; + CVSS_VERSION_2 = 1; + CVSS_VERSION_3 = 2; +} diff --git a/grafeas/v1/discovery.proto b/grafeas/v1/discovery.proto index 13939b25c..bfb94e4a3 100644 --- a/grafeas/v1/discovery.proto +++ b/grafeas/v1/discovery.proto @@ -53,6 +53,8 @@ message DiscoveryOccurrence { // Analysis status for a resource. Currently for initial analysis only (not // updated in continuous analysis). enum AnalysisStatus { + option allow_alias = true; + // Unknown. ANALYSIS_STATUS_UNSPECIFIED = 0; // Resource is known but no action has been taken yet. @@ -61,16 +63,30 @@ message DiscoveryOccurrence { SCANNING = 2; // Analysis has finished successfully. FINISHED_SUCCESS = 3; + // Analysis has completed. + COMPLETE = 3; // Analysis has finished unsuccessfully, the analysis itself is in a bad // state. FINISHED_FAILED = 4; - // The resource is known not to be supported + // The resource is known not to be supported. FINISHED_UNSUPPORTED = 5; } // The status of discovery for the resource. AnalysisStatus analysis_status = 2; + // Indicates which analysis completed successfully. Multiple types of + // analysis can be performed on a single resource. + message AnalysisCompleted { + repeated string analysis_type = 1; + } + + AnalysisCompleted analysis_completed = 7; + + // Indicates any errors encountered during analysis of a resource. There + // could be 0 or more of these errors. + repeated google.rpc.Status analysis_error = 8; + // When an error is encountered this will contain a LocalizedMessage under // details to show to the user. The LocalizedMessage is output only and // populated by the API. diff --git a/grafeas/v1/swagger/grafeas.swagger.json b/grafeas/v1/swagger/grafeas.swagger.json index c592e29e9..e8852c447 100644 --- a/grafeas/v1/swagger/grafeas.swagger.json +++ b/grafeas/v1/swagger/grafeas.swagger.json @@ -850,6 +850,18 @@ "default": "PLATFORM_UNSPECIFIED", "description": "Types of platforms.\n\n - PLATFORM_UNSPECIFIED: Unknown.\n - GKE: Google Container Engine.\n - FLEX: Google App Engine: Flexible Environment.\n - CUSTOM: Custom user-defined platform." }, + "DiscoveryOccurrenceAnalysisCompleted": { + "type": "object", + "properties": { + "analysisType": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Indicates which analysis completed successfully. Multiple types of\nanalysis can be performed on a single resource." + }, "DiscoveryOccurrenceAnalysisStatus": { "type": "string", "enum": [ @@ -857,11 +869,12 @@ "PENDING", "SCANNING", "FINISHED_SUCCESS", + "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], "default": "ANALYSIS_STATUS_UNSPECIFIED", - "description": "Analysis status for a resource. Currently for initial analysis only (not\nupdated in continuous analysis).\n\n - ANALYSIS_STATUS_UNSPECIFIED: Unknown.\n - PENDING: Resource is known but no action has been taken yet.\n - SCANNING: Resource is being analyzed.\n - FINISHED_SUCCESS: Analysis has finished successfully.\n - FINISHED_FAILED: Analysis has finished unsuccessfully, the analysis itself is in a bad\nstate.\n - FINISHED_UNSUPPORTED: The resource is known not to be supported" + "description": "Analysis status for a resource. Currently for initial analysis only (not\nupdated in continuous analysis).\n\n - ANALYSIS_STATUS_UNSPECIFIED: Unknown.\n - PENDING: Resource is known but no action has been taken yet.\n - SCANNING: Resource is being analyzed.\n - FINISHED_SUCCESS: Analysis has finished successfully.\n - COMPLETE: Analysis has completed.\n - FINISHED_FAILED: Analysis has finished unsuccessfully, the analysis itself is in a bad\nstate.\n - FINISHED_UNSUPPORTED: The resource is known not to be supported." }, "DiscoveryOccurrenceContinuousAnalysis": { "type": "string", @@ -1560,6 +1573,16 @@ ], "default": "USER_INTERACTION_UNSPECIFIED" }, + "v1CVSSVersion": { + "type": "string", + "enum": [ + "CVSS_VERSION_UNSPECIFIED", + "CVSS_VERSION_2", + "CVSS_VERSION_3" + ], + "default": "CVSS_VERSION_UNSPECIFIED", + "description": "CVSS Version." + }, "v1CVSSv3": { "type": "object", "properties": { @@ -1917,6 +1940,16 @@ "$ref": "#/definitions/DiscoveryOccurrenceAnalysisStatus", "description": "The status of discovery for the resource." }, + "analysisCompleted": { + "$ref": "#/definitions/DiscoveryOccurrenceAnalysisCompleted" + }, + "analysisError": { + "type": "array", + "items": { + "$ref": "#/definitions/rpcStatus" + }, + "description": "Indicates any errors encountered during analysis of a resource. There\ncould be 0 or more of these errors." + }, "analysisStatusError": { "$ref": "#/definitions/rpcStatus", "description": "When an error is encountered this will contain a LocalizedMessage under\ndetails to show to the user. The LocalizedMessage is output only and\npopulated by the API." @@ -3091,6 +3124,10 @@ "type": "string", "format": "date-time", "description": "The time this information was last changed at the source. This is an\nupstream timestamp from the underlying information source - e.g. Ubuntu\nsecurity tracker." + }, + "cvssVersion": { + "$ref": "#/definitions/v1CVSSVersion", + "description": "CVSS version used to populate cvss_score and severity." } }, "description": "A security vulnerability that can be found in resources." @@ -3150,6 +3187,11 @@ "type": "boolean", "description": "Output only. Whether at least one of the affected packages has a fix\navailable.", "readOnly": true + }, + "cvssVersion": { + "$ref": "#/definitions/v1CVSSVersion", + "description": "Output only. CVSS version used to populate cvss_score and severity.", + "readOnly": true } }, "description": "An occurrence of a severity vulnerability on a resource." diff --git a/grafeas/v1/vulnerability.proto b/grafeas/v1/vulnerability.proto index 70ab550af..cea4558b1 100644 --- a/grafeas/v1/vulnerability.proto +++ b/grafeas/v1/vulnerability.proto @@ -148,6 +148,11 @@ message VulnerabilityNote { // upstream timestamp from the underlying information source - e.g. Ubuntu // security tracker. google.protobuf.Timestamp source_update_time = 6; + + // CVSS version used to populate cvss_score and severity. + grafeas.v1.CVSSVersion cvss_version = 7; + + // Next free ID is 8. } // An occurrence of a severity vulnerability on a resource. @@ -238,4 +243,9 @@ message VulnerabilityOccurrence { // Output only. Whether at least one of the affected packages has a fix // available. bool fix_available = 9; + + // Output only. CVSS version used to populate cvss_score and severity. + grafeas.v1.CVSSVersion cvss_version = 11; + + // Next free ID is 12. }